Class 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.
Implements
Inherited Members
Namespace: Google.Apis.AdExchangeBuyerII.v2beta1.Data
Assembly: Google.Apis.AdExchangeBuyerII.v2beta1.dll
Syntax
public class Deal : IDirectResponseSchema
Properties
AvailableEndTime
object representation of AvailableEndTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use AvailableEndTimeDateTimeOffset instead.")]
public virtual object AvailableEndTime { get; set; }
Property Value
Type | Description |
---|---|
object |
AvailableEndTimeDateTimeOffset
DateTimeOffset representation of AvailableEndTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? AvailableEndTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
AvailableEndTimeRaw
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.
Declaration
[JsonProperty("availableEndTime")]
public virtual string AvailableEndTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
string |
AvailableStartTime
object representation of AvailableStartTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use AvailableStartTimeDateTimeOffset instead.")]
public virtual object AvailableStartTime { get; set; }
Property Value
Type | Description |
---|---|
object |
AvailableStartTimeDateTimeOffset
DateTimeOffset representation of AvailableStartTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? AvailableStartTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
AvailableStartTimeRaw
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 (for example, in milliseconds) will be truncated towards the start of time in seconds.
Declaration
[JsonProperty("availableStartTime")]
public virtual string AvailableStartTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
string |
BuyerPrivateData
Buyer private data (hidden from seller).
Declaration
[JsonProperty("buyerPrivateData")]
public virtual PrivateData BuyerPrivateData { get; set; }
Property Value
Type | Description |
---|---|
PrivateData |
CreateProductId
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.
Declaration
[JsonProperty("createProductId")]
public virtual string CreateProductId { get; set; }
Property Value
Type | Description |
---|---|
string |
CreateProductRevision
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.
Declaration
[JsonProperty("createProductRevision")]
public virtual long? CreateProductRevision { get; set; }
Property Value
Type | Description |
---|---|
long? |
CreateTime
object representation of CreateTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type | Description |
---|---|
object |
CreateTimeDateTimeOffset
DateTimeOffset representation of CreateTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
CreateTimeRaw
Output only. The time of the deal creation.
Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
string |
CreativePreApprovalPolicy
Output only. Specifies the creative pre-approval policy.
Declaration
[JsonProperty("creativePreApprovalPolicy")]
public virtual string CreativePreApprovalPolicy { get; set; }
Property Value
Type | Description |
---|---|
string |
CreativeRestrictions
Output only. Restricitions about the creatives associated with the deal (for example, size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager.
Declaration
[JsonProperty("creativeRestrictions")]
public virtual CreativeRestrictions CreativeRestrictions { get; set; }
Property Value
Type | Description |
---|---|
CreativeRestrictions |
CreativeSafeFrameCompatibility
Output only. Specifies whether the creative is safeFrame compatible.
Declaration
[JsonProperty("creativeSafeFrameCompatibility")]
public virtual string CreativeSafeFrameCompatibility { get; set; }
Property Value
Type | Description |
---|---|
string |
DealId
Output only. A unique deal ID for the deal (server-assigned).
Declaration
[JsonProperty("dealId")]
public virtual string DealId { get; set; }
Property Value
Type | Description |
---|---|
string |
DealServingMetadata
Output only. Metadata about the serving status of this deal.
Declaration
[JsonProperty("dealServingMetadata")]
public virtual DealServingMetadata DealServingMetadata { get; set; }
Property Value
Type | Description |
---|---|
DealServingMetadata |
DealTerms
The negotiable terms of the deal.
Declaration
[JsonProperty("dealTerms")]
public virtual DealTerms DealTerms { get; set; }
Property Value
Type | Description |
---|---|
DealTerms |
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.
Declaration
[JsonProperty("deliveryControl")]
public virtual DeliveryControl DeliveryControl { get; set; }
Property Value
Type | Description |
---|---|
DeliveryControl |
Description
Description for the deal terms.
Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type | Description |
---|---|
string |
DisplayName
The name of the deal.
Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
ExternalDealId
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.
Declaration
[JsonProperty("externalDealId")]
public virtual string ExternalDealId { get; set; }
Property Value
Type | Description |
---|---|
string |
IsSetupComplete
Output only. True, if the buyside inventory setup is complete for this deal.
Declaration
[JsonProperty("isSetupComplete")]
public virtual bool? IsSetupComplete { get; set; }
Property Value
Type | Description |
---|---|
bool? |
ProgrammaticCreativeSource
Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by buyer.
Declaration
[JsonProperty("programmaticCreativeSource")]
public virtual string ProgrammaticCreativeSource { get; set; }
Property Value
Type | Description |
---|---|
string |
ProposalId
Output only. ID of the proposal that this deal is part of.
Declaration
[JsonProperty("proposalId")]
public virtual string ProposalId { get; set; }
Property Value
Type | Description |
---|---|
string |
SellerContacts
Output only. Seller contact information for the deal.
Declaration
[JsonProperty("sellerContacts")]
public virtual IList<ContactInformation> SellerContacts { get; set; }
Property Value
Type | Description |
---|---|
IList<ContactInformation> |
SyndicationProduct
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.
Declaration
[JsonProperty("syndicationProduct")]
public virtual string SyndicationProduct { get; set; }
Property Value
Type | Description |
---|---|
string |
Targeting
Output only. Specifies the subset of inventory targeted by the deal.
Declaration
[JsonProperty("targeting")]
public virtual MarketplaceTargeting Targeting { get; set; }
Property Value
Type | Description |
---|---|
MarketplaceTargeting |
TargetingCriterion
The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together.
Declaration
[JsonProperty("targetingCriterion")]
public virtual IList<TargetingCriteria> TargetingCriterion { get; set; }
Property Value
Type | Description |
---|---|
IList<TargetingCriteria> |
UpdateTime
object representation of UpdateTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type | Description |
---|---|
object |
UpdateTimeDateTimeOffset
DateTimeOffset representation of UpdateTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
UpdateTimeRaw
Output only. The time when the deal was last updated.
Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
string |
WebPropertyCode
The web property code for the seller copied over from the product.
Declaration
[JsonProperty("webPropertyCode")]
public virtual string WebPropertyCode { get; set; }
Property Value
Type | Description |
---|---|
string |