Class Deal
A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals.
Implements
Inherited Members
Namespace: Google.Apis.AuthorizedBuyersMarketplace.v1alpha.Data
Assembly: Google.Apis.AuthorizedBuyersMarketplace.v1alpha.dll
Syntax
public class Deal : IDirectResponseSchema
Properties
BilledBuyer
Output only. When the client field is populated, this field refers to the buyer who creates and manages the
client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is
the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format
: buyers/{buyerAccountId}
Declaration
[JsonProperty("billedBuyer")]
public virtual string BilledBuyer { get; set; }
Property Value
Type | Description |
---|---|
string |
Buyer
Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: buyers/{buyerAccountId}
Declaration
[JsonProperty("buyer")]
public virtual string Buyer { get; set; }
Property Value
Type | Description |
---|---|
string |
Client
Output only. Refers to a Client. Format: buyers/{buyerAccountId}/clients/{clientAccountid}
Declaration
[JsonProperty("client")]
public virtual string Client { get; set; }
Property Value
Type | Description |
---|---|
string |
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 |
CreativeRequirements
Output only. Metadata about the creatives of this deal.
Declaration
[JsonProperty("creativeRequirements")]
public virtual CreativeRequirements CreativeRequirements { get; set; }
Property Value
Type | Description |
---|---|
CreativeRequirements |
DealType
Output only. Type of deal.
Declaration
[JsonProperty("dealType")]
public virtual string DealType { get; set; }
Property Value
Type | Description |
---|---|
string |
DeliveryControl
Output only. Specifies the pacing set by the publisher.
Declaration
[JsonProperty("deliveryControl")]
public virtual DeliveryControl DeliveryControl { get; set; }
Property Value
Type | Description |
---|---|
DeliveryControl |
Description
Output only. Free text description for the deal terms.
Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type | Description |
---|---|
string |
DisplayName
Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier 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 |
EligibleSeatIds
Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
Declaration
[JsonProperty("eligibleSeatIds")]
public virtual IList<string> EligibleSeatIds { get; set; }
Property Value
Type | Description |
---|---|
IList<string> |
EstimatedGrossSpend
Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
Declaration
[JsonProperty("estimatedGrossSpend")]
public virtual Money EstimatedGrossSpend { get; set; }
Property Value
Type | Description |
---|---|
Money |
FlightEndTime
object representation of FlightEndTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use FlightEndTimeDateTimeOffset instead.")]
public virtual object FlightEndTime { get; set; }
Property Value
Type | Description |
---|---|
object |
FlightEndTimeDateTimeOffset
DateTimeOffset representation of FlightEndTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? FlightEndTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
FlightEndTimeRaw
Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
Declaration
[JsonProperty("flightEndTime")]
public virtual string FlightEndTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
string |
FlightStartTime
object representation of FlightStartTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use FlightStartTimeDateTimeOffset instead.")]
public virtual object FlightStartTime { get; set; }
Property Value
Type | Description |
---|---|
object |
FlightStartTimeDateTimeOffset
DateTimeOffset representation of FlightStartTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? FlightStartTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
FlightStartTimeRaw
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("flightStartTime")]
public virtual string FlightStartTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
string |
MediaPlanner
Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
Declaration
[JsonProperty("mediaPlanner")]
public virtual MediaPlanner MediaPlanner { get; set; }
Property Value
Type | Description |
---|---|
MediaPlanner |
Name
Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type | Description |
---|---|
string |
PreferredDealTerms
The terms for preferred deals.
Declaration
[JsonProperty("preferredDealTerms")]
public virtual PreferredDealTerms PreferredDealTerms { get; set; }
Property Value
Type | Description |
---|---|
PreferredDealTerms |
PrivateAuctionTerms
The terms for private auction deals.
Declaration
[JsonProperty("privateAuctionTerms")]
public virtual PrivateAuctionTerms PrivateAuctionTerms { get; set; }
Property Value
Type | Description |
---|---|
PrivateAuctionTerms |
ProgrammaticGuaranteedTerms
The terms for programmatic guaranteed deals.
Declaration
[JsonProperty("programmaticGuaranteedTerms")]
public virtual ProgrammaticGuaranteedTerms ProgrammaticGuaranteedTerms { get; set; }
Property Value
Type | Description |
---|---|
ProgrammaticGuaranteedTerms |
ProposalRevision
Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
Declaration
[JsonProperty("proposalRevision")]
public virtual long? ProposalRevision { get; set; }
Property Value
Type | Description |
---|---|
long? |
PublisherProfile
Immutable. Reference to the seller on the deal. Format:
buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}
Declaration
[JsonProperty("publisherProfile")]
public virtual string PublisherProfile { get; set; }
Property Value
Type | Description |
---|---|
string |
SellerTimeZone
Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
Declaration
[JsonProperty("sellerTimeZone")]
public virtual TimeZone SellerTimeZone { get; set; }
Property Value
Type | Description |
---|---|
TimeZone |
Targeting
Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
Declaration
[JsonProperty("targeting")]
public virtual MarketplaceTargeting Targeting { get; set; }
Property Value
Type | Description |
---|---|
MarketplaceTargeting |
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 |