Class: Google::Apis::AdexchangebuyerV1_3::DirectDeal

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/adexchangebuyer_v1_3/classes.rb,
generated/google/apis/adexchangebuyer_v1_3/representations.rb,
generated/google/apis/adexchangebuyer_v1_3/representations.rb

Overview

The configuration data for an Ad Exchange direct deal.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ DirectDeal

Returns a new instance of DirectDeal.


886
887
888
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 886

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#account_idFixnum

The account id of the buyer this deal is for. Corresponds to the JSON property accountId

Returns:

  • (Fixnum)

803
804
805
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 803

def 
  @account_id
end

#advertiserString

The name of the advertiser this deal is for. Corresponds to the JSON property advertiser

Returns:

  • (String)

808
809
810
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 808

def advertiser
  @advertiser
end

#allows_alcoholBoolean Also known as: allows_alcohol?

Whether the publisher for this deal is eligible for alcohol ads. Corresponds to the JSON property allowsAlcohol

Returns:

  • (Boolean)

813
814
815
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 813

def allows_alcohol
  @allows_alcohol
end

#buyer_account_idFixnum

The account id that this deal was negotiated for. It is either the buyer or the client that this deal was negotiated on behalf of. Corresponds to the JSON property buyerAccountId

Returns:

  • (Fixnum)

820
821
822
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 820

def 
  @buyer_account_id
end

#currency_codeString

The currency code that applies to the fixed_cpm value. If not set then assumed to be USD. Corresponds to the JSON property currencyCode

Returns:

  • (String)

826
827
828
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 826

def currency_code
  @currency_code
end

#deal_tierString

The deal type such as programmatic reservation or fixed price and so on. Corresponds to the JSON property dealTier

Returns:

  • (String)

831
832
833
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 831

def deal_tier
  @deal_tier
end

#end_timeFixnum

End time for when this deal stops being active. If not set then this deal is valid until manually disabled by the publisher. In seconds since the epoch. Corresponds to the JSON property endTime

Returns:

  • (Fixnum)

837
838
839
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 837

def end_time
  @end_time
end

#fixed_cpmFixnum

The fixed price for this direct deal. In cpm micros of currency according to currency_code. If set, then this deal is eligible for the fixed price tier of buying (highest priority, pay exactly the configured fixed price). Corresponds to the JSON property fixedCpm

Returns:

  • (Fixnum)

844
845
846
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 844

def fixed_cpm
  @fixed_cpm
end

#idFixnum

Deal id. Corresponds to the JSON property id

Returns:

  • (Fixnum)

849
850
851
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 849

def id
  @id
end

#kindString

Resource type. Corresponds to the JSON property kind

Returns:

  • (String)

854
855
856
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 854

def kind
  @kind
end

#nameString

Deal name. Corresponds to the JSON property name

Returns:

  • (String)

859
860
861
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 859

def name
  @name
end

#private_exchange_min_cpmFixnum

The minimum price for this direct deal. In cpm micros of currency according to currency_code. If set, then this deal is eligible for the private exchange tier of buying (below fixed price priority, run as a second price auction). Corresponds to the JSON property privateExchangeMinCpm

Returns:

  • (Fixnum)

866
867
868
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 866

def private_exchange_min_cpm
  @private_exchange_min_cpm
end

#publisher_blocks_overridenBoolean Also known as: publisher_blocks_overriden?

If true, the publisher has opted to have their blocks ignored when a creative is bid with for this deal. Corresponds to the JSON property publisherBlocksOverriden

Returns:

  • (Boolean)

872
873
874
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 872

def publisher_blocks_overriden
  @publisher_blocks_overriden
end

#seller_networkString

The name of the publisher offering this direct deal. Corresponds to the JSON property sellerNetwork

Returns:

  • (String)

878
879
880
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 878

def seller_network
  @seller_network
end

#start_timeFixnum

Start time for when this deal becomes active. If not set then this deal is active immediately upon creation. In seconds since the epoch. Corresponds to the JSON property startTime

Returns:

  • (Fixnum)

884
885
886
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 884

def start_time
  @start_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 891

def update!(**args)
  @account_id = args[:account_id] if args.key?(:account_id)
  @advertiser = args[:advertiser] if args.key?(:advertiser)
  @allows_alcohol = args[:allows_alcohol] if args.key?(:allows_alcohol)
  @buyer_account_id = args[:buyer_account_id] if args.key?(:buyer_account_id)
  @currency_code = args[:currency_code] if args.key?(:currency_code)
  @deal_tier = args[:deal_tier] if args.key?(:deal_tier)
  @end_time = args[:end_time] if args.key?(:end_time)
  @fixed_cpm = args[:fixed_cpm] if args.key?(:fixed_cpm)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @private_exchange_min_cpm = args[:private_exchange_min_cpm] if args.key?(:private_exchange_min_cpm)
  @publisher_blocks_overriden = args[:publisher_blocks_overriden] if args.key?(:publisher_blocks_overriden)
  @seller_network = args[:seller_network] if args.key?(:seller_network)
  @start_time = args[:start_time] if args.key?(:start_time)
end