Class: Google::Apis::Adexchangebuyer2V2beta1::Deal

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

A deal represents a segment of inventory for displaying ads on. A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving.

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) ⇒ Deal

Returns a new instance of Deal.



1352
1353
1354
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1352

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

Instance Attribute Details

#available_end_timeString

Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not required for Private Auction deals or Preferred Deals. Corresponds to the JSON property availableEndTime

Returns:

  • (String)


1203
1204
1205
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1203

def available_end_time
  @available_end_time
end

#available_start_timeString

Optional proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds. Corresponds to the JSON property availableStartTime

Returns:

  • (String)


1212
1213
1214
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1212

def available_start_time
  @available_start_time
end

#buyer_private_dataGoogle::Apis::Adexchangebuyer2V2beta1::PrivateData

Buyers are allowed to store certain types of private data in a proposal/deal. Corresponds to the JSON property buyerPrivateData



1217
1218
1219
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1217

def buyer_private_data
  @buyer_private_data
end

#create_product_idString

The product ID from which this deal was created. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. Corresponds to the JSON property createProductId

Returns:

  • (String)


1224
1225
1226
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1224

def create_product_id
  @create_product_id
end

#create_product_revisionFixnum

Optional revision number of the product that the deal was created from. If present on create, and the server product_revision has advanced sinced the passed-in create_product_revision, an ABORTED error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. Corresponds to the JSON property createProductRevision

Returns:

  • (Fixnum)


1234
1235
1236
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1234

def create_product_revision
  @create_product_revision
end

#create_timeString

Output only. The time of the deal creation. Corresponds to the JSON property createTime

Returns:

  • (String)


1239
1240
1241
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1239

def create_time
  @create_time
end

#creative_pre_approval_policyString

Output only. Specifies the creative pre-approval policy. Corresponds to the JSON property creativePreApprovalPolicy

Returns:

  • (String)


1244
1245
1246
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1244

def creative_pre_approval_policy
  @creative_pre_approval_policy
end

#creative_restrictionsGoogle::Apis::Adexchangebuyer2V2beta1::CreativeRestrictions

Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. Corresponds to the JSON property creativeRestrictions



1251
1252
1253
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1251

def creative_restrictions
  @creative_restrictions
end

#creative_safe_frame_compatibilityString

Output only. Specifies whether the creative is safeFrame compatible. Corresponds to the JSON property creativeSafeFrameCompatibility

Returns:

  • (String)


1256
1257
1258
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1256

def creative_safe_frame_compatibility
  @creative_safe_frame_compatibility
end

#deal_idString

Output only. A unique deal ID for the deal (server-assigned). Corresponds to the JSON property dealId

Returns:

  • (String)


1261
1262
1263
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1261

def deal_id
  @deal_id
end

#deal_serving_metadataGoogle::Apis::Adexchangebuyer2V2beta1::DealServingMetadata

Message captures metadata about the serving status of a deal. Corresponds to the JSON property dealServingMetadata



1266
1267
1268
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1266

def 
  @deal_serving_metadata
end

#deal_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 dealTerms



1273
1274
1275
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1273

def deal_terms
  @deal_terms
end

#delivery_controlGoogle::Apis::Adexchangebuyer2V2beta1::DeliveryControl

Message contains details about how the deals will be paced. Corresponds to the JSON property deliveryControl



1278
1279
1280
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1278

def delivery_control
  @delivery_control
end

#descriptionString

Description for the deal terms. Corresponds to the JSON property description

Returns:

  • (String)


1283
1284
1285
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1283

def description
  @description
end

#display_nameString

The name of the deal. Corresponds to the JSON property displayName

Returns:

  • (String)


1288
1289
1290
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1288

def display_name
  @display_name
end

#external_deal_idString

Output only. The external deal ID assigned to this deal once the deal is finalized. This is the deal ID that shows up in serving/reporting etc. Corresponds to the JSON property externalDealId

Returns:

  • (String)


1294
1295
1296
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1294

def external_deal_id
  @external_deal_id
end

#is_setup_completeBoolean Also known as: is_setup_complete?

Output only. True, if the buyside inventory setup is complete for this deal. Corresponds to the JSON property isSetupComplete

Returns:

  • (Boolean)


1300
1301
1302
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1300

def is_setup_complete
  @is_setup_complete
end

#programmatic_creative_sourceString

Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by buyer. Corresponds to the JSON property programmaticCreativeSource

Returns:

  • (String)


1308
1309
1310
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1308

def programmatic_creative_source
  @programmatic_creative_source
end

#proposal_idString

Output only. ID of the proposal that this deal is part of. Corresponds to the JSON property proposalId

Returns:

  • (String)


1313
1314
1315
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1313

def proposal_id
  @proposal_id
end

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

Output only. Seller contact information for the deal. Corresponds to the JSON property sellerContacts



1318
1319
1320
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1318

def seller_contacts
  @seller_contacts
end

#syndication_productString

The syndication product associated with the deal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. Corresponds to the JSON property syndicationProduct

Returns:

  • (String)


1325
1326
1327
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1325

def syndication_product
  @syndication_product
end

#targetingGoogle::Apis::Adexchangebuyer2V2beta1::MarketplaceTargeting

Targeting represents different criteria that can be used by advertisers to target ad inventory. For example, they can choose to target ad requests only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. Corresponds to the JSON property targeting



1334
1335
1336
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1334

def targeting
  @targeting
end

#targeting_criterionArray<Google::Apis::Adexchangebuyer2V2beta1::TargetingCriteria>

The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. Corresponds to the JSON property targetingCriterion



1340
1341
1342
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1340

def targeting_criterion
  @targeting_criterion
end

#update_timeString

Output only. The time when the deal was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String)


1345
1346
1347
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1345

def update_time
  @update_time
end

#web_property_codeString

The web property code for the seller copied over from the product. Corresponds to the JSON property webPropertyCode

Returns:

  • (String)


1350
1351
1352
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1350

def web_property_code
  @web_property_code
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1357

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)
  @buyer_private_data = args[:buyer_private_data] if args.key?(:buyer_private_data)
  @create_product_id = args[:create_product_id] if args.key?(:create_product_id)
  @create_product_revision = args[:create_product_revision] if args.key?(:create_product_revision)
  @create_time = args[:create_time] if args.key?(:create_time)
  @creative_pre_approval_policy = args[:creative_pre_approval_policy] if args.key?(:creative_pre_approval_policy)
  @creative_restrictions = args[:creative_restrictions] if args.key?(:creative_restrictions)
  @creative_safe_frame_compatibility = args[:creative_safe_frame_compatibility] if args.key?(:creative_safe_frame_compatibility)
  @deal_id = args[:deal_id] if args.key?(:deal_id)
  @deal_serving_metadata = args[:deal_serving_metadata] if args.key?(:deal_serving_metadata)
  @deal_terms = args[:deal_terms] if args.key?(:deal_terms)
  @delivery_control = args[:delivery_control] if args.key?(:delivery_control)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @external_deal_id = args[:external_deal_id] if args.key?(:external_deal_id)
  @is_setup_complete = args[:is_setup_complete] if args.key?(:is_setup_complete)
  @programmatic_creative_source = args[:programmatic_creative_source] if args.key?(:programmatic_creative_source)
  @proposal_id = args[:proposal_id] if args.key?(:proposal_id)
  @seller_contacts = args[:seller_contacts] if args.key?(:seller_contacts)
  @syndication_product = args[:syndication_product] if args.key?(:syndication_product)
  @targeting = args[:targeting] if args.key?(:targeting)
  @targeting_criterion = args[:targeting_criterion] if args.key?(:targeting_criterion)
  @update_time = args[:update_time] if args.key?(:update_time)
  @web_property_code = args[:web_property_code] if args.key?(:web_property_code)
end