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



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

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

Instance Attribute Details

#available_end_time ⇒ String

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) 


1156
1157
1158
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1156

def available_end_time
  @available_end_time
end

#available_start_time ⇒ String

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) 


1165
1166
1167
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1165

def available_start_time
  @available_start_time
end

#buyer_private_data ⇒ Google::Apis::Adexchangebuyer2V2beta1::PrivateData

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

Returns:



1170
1171
1172
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1170

def buyer_private_data
  @buyer_private_data
end

#create_product_id ⇒ String

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) 


1177
1178
1179
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1177

def create_product_id
  @create_product_id
end

#create_product_revision ⇒ Fixnum

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) 


1187
1188
1189
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1187

def create_product_revision
  @create_product_revision
end

#create_time ⇒ String

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

Returns:

  • (String) 


1193
1194
1195
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1193

def create_time
  @create_time
end

#creative_pre_approval_policy ⇒ String

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

Returns:

  • (String) 


1199
1200
1201
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1199

def creative_pre_approval_policy
  @creative_pre_approval_policy
end

#creative_restrictions ⇒ Google::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

Returns:



1206
1207
1208
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1206

def creative_restrictions
  @creative_restrictions
end

#creative_safe_frame_compatibility ⇒ String

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

Returns:

  • (String) 


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

def creative_safe_frame_compatibility
  @creative_safe_frame_compatibility
end

#deal_id ⇒ String

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

Returns:

  • (String) 


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

def deal_id
  @deal_id
end

#deal_serving_metadata ⇒ Google::Apis::Adexchangebuyer2V2beta1::DealServingMetadata

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

Returns:



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

def deal_serving_metadata
  @deal_serving_metadata
end

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

Returns:



1230
1231
1232
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1230

def deal_terms
  @deal_terms
end

#delivery_control ⇒ Google::Apis::Adexchangebuyer2V2beta1::DeliveryControl

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

Returns:



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

def delivery_control
  @delivery_control
end

#description ⇒ String

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

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

def display_name
  @display_name
end

#external_deal_id ⇒ String

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) 


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

def external_deal_id
  @external_deal_id
end

#is_setup_complete ⇒ Boolean Also known as: is_setup_complete?

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

Returns:

  • (Boolean) 


1258
1259
1260
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1258

def is_setup_complete
  @is_setup_complete
end

#programmatic_creative_source ⇒ String

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) 


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

def programmatic_creative_source
  @programmatic_creative_source
end

#proposal_id ⇒ String

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

Returns:

  • (String) 


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

def proposal_id
  @proposal_id
end

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

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

Returns:



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

def seller_contacts
  @seller_contacts
end

#syndication_product ⇒ String

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) 


1286
1287
1288
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1286

def syndication_product
  @syndication_product
end

#targeting ⇒ Google::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

Returns:



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

def targeting
  @targeting
end

#targeting_criterion ⇒ Array<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

Returns:



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

def targeting_criterion
  @targeting_criterion
end

#update_time ⇒ String

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

Returns:

  • (String) 


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

def update_time
  @update_time
end

#web_property_code ⇒ String

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

Returns:

  • (String) 


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

def web_property_code
  @web_property_code
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1319

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