google_api_ad_exchange_buyer v0.5.0 GoogleApi.AdExchangeBuyer.V2beta1.Model.Deal View Source
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
- availableEndTime (DateTime.t): 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. Defaults to:
null
. - availableStartTime (DateTime.t): 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. Defaults to:
null
. - buyerPrivateData (PrivateData): Buyer private data (hidden from seller). Defaults to:
null
. - createProductId (String.t): 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. Defaults to:
null
. - createProductRevision (String.t): 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. Defaults to:
null
. - createTime (DateTime.t): The time of the deal creation. @OutputOnly Defaults to:
null
. creativePreApprovalPolicy (String.t): Specifies the creative pre-approval policy. @OutputOnly Defaults to:
null
.- Enum - one of [CREATIVE_PRE_APPROVAL_POLICY_UNSPECIFIED, SELLER_PRE_APPROVAL_REQUIRED, SELLER_PRE_APPROVAL_NOT_REQUIRED]
- creativeRestrictions (CreativeRestrictions): Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. @OutputOnly Defaults to:
null
. creativeSafeFrameCompatibility (String.t): Specifies whether the creative is safeFrame compatible. @OutputOnly Defaults to:
null
.- Enum - one of [CREATIVE_SAFE_FRAME_COMPATIBILITY_UNSPECIFIED, COMPATIBLE, INCOMPATIBLE]
- dealId (String.t): A unique deal ID for the deal (server-assigned). @OutputOnly Defaults to:
null
. - dealServingMetadata (DealServingMetadata): Metadata about the serving status of this deal. @OutputOnly Defaults to:
null
. - dealTerms (DealTerms): The negotiable terms of the deal. Defaults to:
null
. - deliveryControl (DeliveryControl): The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. Defaults to:
null
. - description (String.t): Description for the deal terms. Defaults to:
null
. - displayName (String.t): The name of the deal. Defaults to:
null
. - externalDealId (String.t): 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. @OutputOnly Defaults to:
null
. - isSetupComplete (boolean()): True, if the buyside inventory setup is complete for this deal. @OutputOnly Defaults to:
null
. programmaticCreativeSource (String.t): Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by buyer. @OutputOnly Defaults to:
null
.- Enum - one of [PROGRAMMATIC_CREATIVE_SOURCE_UNSPECIFIED, ADVERTISER, PUBLISHER]
- proposalId (String.t): ID of the proposal that this deal is part of. @OutputOnly Defaults to:
null
. - sellerContacts ([ContactInformation]): Seller contact information for the deal. @OutputOnly Defaults to:
null
. syndicationProduct (String.t): 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. Defaults to:
null
.- Enum - one of [SYNDICATION_PRODUCT_UNSPECIFIED, CONTENT, MOBILE, VIDEO, GAMES]
- targeting (MarketplaceTargeting): Specifies the subset of inventory targeted by the deal. @OutputOnly Defaults to:
null
. - targetingCriterion ([TargetingCriteria]): The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. Defaults to:
null
. - updateTime (DateTime.t): The time when the deal was last updated. @OutputOnly Defaults to:
null
. - webPropertyCode (String.t): The web property code for the seller copied over from the product. Defaults to:
null
.
Link to this section Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Link to this section Types
t()
View Source
t() :: %GoogleApi.AdExchangeBuyer.V2beta1.Model.Deal{
availableEndTime: DateTime.t(),
availableStartTime: DateTime.t(),
buyerPrivateData: GoogleApi.AdExchangeBuyer.V2beta1.Model.PrivateData.t(),
createProductId: any(),
createProductRevision: any(),
createTime: DateTime.t(),
creativePreApprovalPolicy: any(),
creativeRestrictions:
GoogleApi.AdExchangeBuyer.V2beta1.Model.CreativeRestrictions.t(),
creativeSafeFrameCompatibility: any(),
dealId: any(),
dealServingMetadata:
GoogleApi.AdExchangeBuyer.V2beta1.Model.DealServingMetadata.t(),
dealTerms: GoogleApi.AdExchangeBuyer.V2beta1.Model.DealTerms.t(),
deliveryControl: GoogleApi.AdExchangeBuyer.V2beta1.Model.DeliveryControl.t(),
description: any(),
displayName: any(),
externalDealId: any(),
isSetupComplete: any(),
programmaticCreativeSource: any(),
proposalId: any(),
sellerContacts: [
GoogleApi.AdExchangeBuyer.V2beta1.Model.ContactInformation.t()
],
syndicationProduct: any(),
targeting: GoogleApi.AdExchangeBuyer.V2beta1.Model.MarketplaceTargeting.t(),
targetingCriterion: [
GoogleApi.AdExchangeBuyer.V2beta1.Model.TargetingCriteria.t()
],
updateTime: DateTime.t(),
webPropertyCode: any()
}
t() :: %GoogleApi.AdExchangeBuyer.V2beta1.Model.Deal{ availableEndTime: DateTime.t(), availableStartTime: DateTime.t(), buyerPrivateData: GoogleApi.AdExchangeBuyer.V2beta1.Model.PrivateData.t(), createProductId: any(), createProductRevision: any(), createTime: DateTime.t(), creativePreApprovalPolicy: any(), creativeRestrictions: GoogleApi.AdExchangeBuyer.V2beta1.Model.CreativeRestrictions.t(), creativeSafeFrameCompatibility: any(), dealId: any(), dealServingMetadata: GoogleApi.AdExchangeBuyer.V2beta1.Model.DealServingMetadata.t(), dealTerms: GoogleApi.AdExchangeBuyer.V2beta1.Model.DealTerms.t(), deliveryControl: GoogleApi.AdExchangeBuyer.V2beta1.Model.DeliveryControl.t(), description: any(), displayName: any(), externalDealId: any(), isSetupComplete: any(), programmaticCreativeSource: any(), proposalId: any(), sellerContacts: [ GoogleApi.AdExchangeBuyer.V2beta1.Model.ContactInformation.t() ], syndicationProduct: any(), targeting: GoogleApi.AdExchangeBuyer.V2beta1.Model.MarketplaceTargeting.t(), targetingCriterion: [ GoogleApi.AdExchangeBuyer.V2beta1.Model.TargetingCriteria.t() ], updateTime: DateTime.t(), webPropertyCode: any() }
Link to this section Functions
decode(value, options) View Source
Unwrap a decoded JSON object into its complex fields.