Class InsertionOrder
A single insertion order.
Implements
Inherited Members
Namespace: Google.Apis.DisplayVideo.v3.Data
Assembly: Google.Apis.DisplayVideo.v3.dll
Syntax
public class InsertionOrder : IDirectResponseSchema
Properties
AdvertiserId
Output only. The unique ID of the advertiser the insertion order belongs to.
Declaration
[JsonProperty("advertiserId")]
public virtual long? AdvertiserId { get; set; }
Property Value
Type | Description |
---|---|
long? |
BidStrategy
The bidding strategy of the insertion order. By default, fixed_bid is set.
Declaration
[JsonProperty("bidStrategy")]
public virtual BiddingStrategy BidStrategy { get; set; }
Property Value
Type | Description |
---|---|
BiddingStrategy |
Budget
Required. The budget allocation settings of the insertion order.
Declaration
[JsonProperty("budget")]
public virtual InsertionOrderBudget Budget { get; set; }
Property Value
Type | Description |
---|---|
InsertionOrderBudget |
CampaignId
Required. Immutable. The unique ID of the campaign that the insertion order belongs to.
Declaration
[JsonProperty("campaignId")]
public virtual long? CampaignId { get; set; }
Property Value
Type | Description |
---|---|
long? |
DisplayName
Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes.
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 |
EntityStatus
Required. Controls whether or not the insertion order can spend its budget and bid on inventory. * For
CreateInsertionOrder method, only ENTITY_STATUS_DRAFT
is allowed. To activate an insertion order, use
UpdateInsertionOrder method and update the status to ENTITY_STATUS_ACTIVE
after creation. * An insertion
order cannot be changed back to ENTITY_STATUS_DRAFT
status from any other status. * An insertion order
cannot be set to ENTITY_STATUS_ACTIVE
if its parent campaign is not active.
Declaration
[JsonProperty("entityStatus")]
public virtual string EntityStatus { get; set; }
Property Value
Type | Description |
---|---|
string |
FrequencyCap
Required. The frequency capping setting of the insertion order.
Declaration
[JsonProperty("frequencyCap")]
public virtual FrequencyCap FrequencyCap { get; set; }
Property Value
Type | Description |
---|---|
FrequencyCap |
InsertionOrderId
Output only. The unique ID of the insertion order. Assigned by the system.
Declaration
[JsonProperty("insertionOrderId")]
public virtual long? InsertionOrderId { get; set; }
Property Value
Type | Description |
---|---|
long? |
InsertionOrderType
The type of insertion order. If this field is unspecified in creation, the value defaults to RTB
.
Declaration
[JsonProperty("insertionOrderType")]
public virtual string InsertionOrderType { get; set; }
Property Value
Type | Description |
---|---|
string |
IntegrationDetails
Additional integration details of the insertion order.
Declaration
[JsonProperty("integrationDetails")]
public virtual IntegrationDetails IntegrationDetails { get; set; }
Property Value
Type | Description |
---|---|
IntegrationDetails |
Kpi
Required. The key performance indicator (KPI) of the insertion order. This is represented as referred to as the "Goal" in the Display & Video 360 interface.
Declaration
[JsonProperty("kpi")]
public virtual Kpi Kpi { get; set; }
Property Value
Type | Description |
---|---|
Kpi |
Name
Output only. The resource name of the insertion order.
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type | Description |
---|---|
string |
OptimizationObjective
Optional. The optimization objective of the insertion order. This field is only available to allowlisted customers. If a customer is not allowlisted, this field will be null and attempts to set it will return an error.
Declaration
[JsonProperty("optimizationObjective")]
public virtual string OptimizationObjective { get; set; }
Property Value
Type | Description |
---|---|
string |
Pacing
Required. The budget spending speed setting of the insertion order. pacing_type PACING_TYPE_ASAP
is not
compatible with pacing_period PACING_PERIOD_FLIGHT
.
Declaration
[JsonProperty("pacing")]
public virtual Pacing Pacing { get; set; }
Property Value
Type | Description |
---|---|
Pacing |
PartnerCosts
The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings.
Declaration
[JsonProperty("partnerCosts")]
public virtual IList<PartnerCost> PartnerCosts { get; set; }
Property Value
Type | Description |
---|---|
IList<PartnerCost> |
ReservationType
Output only. The reservation type of the insertion order.
Declaration
[JsonProperty("reservationType")]
public virtual string ReservationType { get; set; }
Property Value
Type | Description |
---|---|
string |
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 timestamp when the insertion order was last updated. Assigned by the system.
Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
string |