Class: Google::Apis::Adexchangebuyer2V2beta1::Product

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

Overview

A product is a segment of inventory that a seller wishes to sell. It is associated with certain terms and targeting information which helps the buyer know more about the inventory.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Product

Returns a new instance of Product.



3246
3247
3248
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3246

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

Instance Attribute Details

#available_end_time ⇒ String

The proposed end time for the deal. The field will be truncated to the order of seconds during serving. Corresponds to the JSON property availableEndTime

Returns:

  • (String) 


3161
3162
3163
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3161

def available_end_time
  @available_end_time
end

#available_start_time ⇒ String

Inventory availability dates. The start time will be truncated to seconds during serving. Thus, a field specified as 3:23:34.456 (HH:mm:ss.SSS) will be truncated to 3:23:34 when serving. Corresponds to the JSON property availableStartTime

Returns:

  • (String) 


3168
3169
3170
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3168

def available_start_time
  @available_start_time
end

#create_time ⇒ String

Creation time. Corresponds to the JSON property createTime

Returns:

  • (String) 


3173
3174
3175
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3173

def create_time
  @create_time
end

#creator_contacts ⇒ Array<Google::Apis::Adexchangebuyer2V2beta1::ContactInformation>

Optional contact information for the creator of this product. Corresponds to the JSON property creatorContacts

Returns:



3178
3179
3180
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3178

def creator_contacts
  @creator_contacts
end

#display_name ⇒ String

The display name for this product as set by the seller. Corresponds to the JSON property displayName

Returns:

  • (String) 


3183
3184
3185
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3183

def display_name
  @display_name
end

#has_creator_signed_off ⇒ Boolean Also known as: has_creator_signed_off?

If the creator has already signed off on the product, then the buyer can finalize the deal by accepting the product as is. When copying to a proposal, if any of the terms are changed, then auto_finalize is automatically set to false. Corresponds to the JSON property hasCreatorSignedOff

Returns:

  • (Boolean) 


3191
3192
3193
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3191

def has_creator_signed_off
  @has_creator_signed_off
end

#product_id ⇒ String

The unique ID for the product. Corresponds to the JSON property productId

Returns:

  • (String) 


3197
3198
3199
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3197

def product_id
  @product_id
end

#product_revision ⇒ Fixnum

The revision number of the product (auto-assigned by Marketplace). Corresponds to the JSON property productRevision

Returns:

  • (Fixnum) 


3202
3203
3204
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3202

def product_revision
  @product_revision
end

#publisher_profile_id ⇒ String

An ID which can be used by the Publisher Profile API to get more information about the seller that created this product. Corresponds to the JSON property publisherProfileId

Returns:

  • (String) 


3208
3209
3210
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3208

def publisher_profile_id
  @publisher_profile_id
end

#seller ⇒ Google::Apis::Adexchangebuyer2V2beta1::Seller

Represents a seller of inventory. Each seller is identified by a unique Ad Manager account ID. Corresponds to the JSON property seller

Returns:



3214
3215
3216
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3214

def seller
  @seller
end

#syndication_product ⇒ String

The syndication product associated with the deal. Corresponds to the JSON property syndicationProduct

Returns:

  • (String) 


3219
3220
3221
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3219

def syndication_product
  @syndication_product
end

#targeting_criterion ⇒ Array<Google::Apis::Adexchangebuyer2V2beta1::TargetingCriteria>

Targeting that is shared between the buyer and the seller. Each targeting criterion has a specified key and for each key there is a list of inclusion value or exclusion values. Corresponds to the JSON property targetingCriterion

Returns:



3226
3227
3228
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3226

def targeting_criterion
  @targeting_criterion
end

#terms ⇒ Google::Apis::Adexchangebuyer2V2beta1::DealTerms

The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (e.g., fixed price, auction) and expected impressions from the publisher. Corresponds to the JSON property terms

Returns:



3233
3234
3235
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3233

def terms
  @terms
end

#update_time ⇒ String

Time of last update. Corresponds to the JSON property updateTime

Returns:

  • (String) 


3238
3239
3240
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3238

def update_time
  @update_time
end

#web_property_code ⇒ String

The web-property code for the seller. This needs to be copied as is when adding a new deal to a proposal. Corresponds to the JSON property webPropertyCode

Returns:

  • (String) 


3244
3245
3246
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3244

def web_property_code
  @web_property_code
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3251

def update!(**args)
  @available_end_time = args[:available_end_time] if args.key?(:available_end_time)
  @available_start_time = args[:available_start_time] if args.key?(:available_start_time)
  @create_time = args[:create_time] if args.key?(:create_time)
  @creator_contacts = args[:creator_contacts] if args.key?(:creator_contacts)
  @display_name = args[:display_name] if args.key?(:display_name)
  @has_creator_signed_off = args[:has_creator_signed_off] if args.key?(:has_creator_signed_off)
  @product_id = args[:product_id] if args.key?(:product_id)
  @product_revision = args[:product_revision] if args.key?(:product_revision)
  @publisher_profile_id = args[:publisher_profile_id] if args.key?(:publisher_profile_id)
  @seller = args[:seller] if args.key?(:seller)
  @syndication_product = args[:syndication_product] if args.key?(:syndication_product)
  @targeting_criterion = args[:targeting_criterion] if args.key?(:targeting_criterion)
  @terms = args[:terms] if args.key?(:terms)
  @update_time = args[:update_time] if args.key?(:update_time)
  @web_property_code = args[:web_property_code] if args.key?(:web_property_code)
end