class Google::Apis::Adexchangebuyer2V2beta1::Deal

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.

Attributes

available_end_time[RW]

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` @return [String]

available_start_time[RW]

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` @return [String]

buyer_private_data[RW]

Buyers are allowed to store certain types of private data in a proposal/deal. Corresponds to the JSON property `buyerPrivateData` @return [Google::Apis::Adexchangebuyer2V2beta1::PrivateData]

create_product_id[RW]

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` @return [String]

create_product_revision[RW]

Optional. Revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced since 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` @return [Fixnum]

create_time[RW]

Output only. The time of the deal creation. Corresponds to the JSON property `createTime` @return [String]

creative_pre_approval_policy[RW]

Output only. Specifies the creative pre-approval policy. Corresponds to the JSON property `creativePreApprovalPolicy` @return [String]

creative_restrictions[RW]

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` @return [Google::Apis::Adexchangebuyer2V2beta1::CreativeRestrictions]

creative_safe_frame_compatibility[RW]

Output only. Specifies whether the creative is safeFrame compatible. Corresponds to the JSON property `creativeSafeFrameCompatibility` @return [String]

deal_id[RW]

Output only. A unique deal ID for the deal (server-assigned). Corresponds to the JSON property `dealId` @return [String]

deal_serving_metadata[RW]

Message captures metadata about the serving status of a deal. Corresponds to the JSON property `dealServingMetadata` @return [Google::Apis::Adexchangebuyer2V2beta1::DealServingMetadata]

deal_terms[RW]

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` @return [Google::Apis::Adexchangebuyer2V2beta1::DealTerms]

delivery_control[RW]

Message contains details about how the deals will be paced. Corresponds to the JSON property `deliveryControl` @return [Google::Apis::Adexchangebuyer2V2beta1::DeliveryControl]

description[RW]

Description for the deal terms. Corresponds to the JSON property `description` @return [String]

display_name[RW]

The name of the deal. Corresponds to the JSON property `displayName` @return [String]

external_deal_id[RW]

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` @return [String]

is_setup_complete[RW]

Output only. True, if the buyside inventory setup is complete for this deal. Corresponds to the JSON property `isSetupComplete` @return [Boolean]

is_setup_complete?[RW]

Output only. True, if the buyside inventory setup is complete for this deal. Corresponds to the JSON property `isSetupComplete` @return [Boolean]

programmatic_creative_source[RW]

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` @return [String]

proposal_id[RW]

Output only. ID of the proposal that this deal is part of. Corresponds to the JSON property `proposalId` @return [String]

seller_contacts[RW]

Output only. Seller contact information for the deal. Corresponds to the JSON property `sellerContacts` @return [Array<Google::Apis::Adexchangebuyer2V2beta1::ContactInformation>]

syndication_product[RW]

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` @return [String]

targeting[RW]

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` @return [Google::Apis::Adexchangebuyer2V2beta1::MarketplaceTargeting]

targeting_criterion[RW]

The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. Corresponds to the JSON property `targetingCriterion` @return [Array<Google::Apis::Adexchangebuyer2V2beta1::TargetingCriteria>]

update_time[RW]

Output only. The time when the deal was last updated. Corresponds to the JSON property `updateTime` @return [String]

web_property_code[RW]

The web property code for the seller copied over from the product. Corresponds to the JSON property `webPropertyCode` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/adexchangebuyer2_v2beta1/classes.rb, line 1308
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/adexchangebuyer2_v2beta1/classes.rb, line 1313
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