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

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

Overview

Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. 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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Product

Returns a new instance of Product.



3297
3298
3299
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3297

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

Instance Attribute Details

#available_end_timeString

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)


3212
3213
3214
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3212

def available_end_time
  @available_end_time
end

#available_start_timeString

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)


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

def available_start_time
  @available_start_time
end

#create_timeString

Creation time. Corresponds to the JSON property createTime

Returns:

  • (String)


3224
3225
3226
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3224

def create_time
  @create_time
end

#creator_contactsArray<Google::Apis::Adexchangebuyer2V2beta1::ContactInformation>

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



3229
3230
3231
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3229

def creator_contacts
  @creator_contacts
end

#display_nameString

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

Returns:

  • (String)


3234
3235
3236
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3234

def display_name
  @display_name
end

#has_creator_signed_offBoolean 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)


3242
3243
3244
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3242

def has_creator_signed_off
  @has_creator_signed_off
end

#product_idString

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

Returns:

  • (String)


3248
3249
3250
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3248

def product_id
  @product_id
end

#product_revisionFixnum

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

Returns:

  • (Fixnum)


3253
3254
3255
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3253

def product_revision
  @product_revision
end

#publisher_profile_idString

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)


3259
3260
3261
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3259

def publisher_profile_id
  @publisher_profile_id
end

#sellerGoogle::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



3265
3266
3267
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3265

def seller
  @seller
end

#syndication_productString

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

Returns:

  • (String)


3270
3271
3272
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3270

def syndication_product
  @syndication_product
end

#targeting_criterionArray<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



3277
3278
3279
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3277

def targeting_criterion
  @targeting_criterion
end

#termsGoogle::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



3284
3285
3286
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3284

def terms
  @terms
end

#update_timeString

Time of last update. Corresponds to the JSON property updateTime

Returns:

  • (String)


3289
3290
3291
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3289

def update_time
  @update_time
end

#web_property_codeString

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)


3295
3296
3297
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3295

def web_property_code
  @web_property_code
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 3302

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