GoogleApi.DisplayVideo.V1.Model.InsertionOrder (google_api_display_video v0.17.0) View Source
A single insertion order.
Attributes
-
advertiserId
(type:String.t
, default:nil
) - Output only. The unique ID of the advertiser the insertion order belongs to. -
bidStrategy
(type:GoogleApi.DisplayVideo.V1.Model.BiddingStrategy.t
, default:nil
) - The bidding strategy of the insertion order. By default, fixed_bid is set. -
budget
(type:GoogleApi.DisplayVideo.V1.Model.InsertionOrderBudget.t
, default:nil
) - Required. The budget allocation settings of the insertion order. -
campaignId
(type:String.t
, default:nil
) - Required. Immutable. The unique ID of the campaign that the insertion order belongs to. -
displayName
(type:String.t
, default:nil
) - Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes. -
entityStatus
(type:String.t
, default:nil
) - Required. Controls whether or not the insertion order can spend its budget and bid on inventory. For CreateInsertionOrder method, onlyENTITY_STATUS_DRAFT
is allowed. To activate an insertion order, use UpdateInsertionOrder method and update the status toENTITY_STATUS_ACTIVE
after creation. An insertion order cannot be changed back toENTITY_STATUS_DRAFT
status from any other status. * An insertion order cannot be set toENTITY_STATUS_ACTIVE
if its parent campaign is not active. -
frequencyCap
(type:GoogleApi.DisplayVideo.V1.Model.FrequencyCap.t
, default:nil
) - Required. The frequency capping setting of the insertion order. -
insertionOrderId
(type:String.t
, default:nil
) - Output only. The unique ID of the insertion order. Assigned by the system. -
integrationDetails
(type:GoogleApi.DisplayVideo.V1.Model.IntegrationDetails.t
, default:nil
) - Additional integration details of the insertion order. -
name
(type:String.t
, default:nil
) - Output only. The resource name of the insertion order. -
pacing
(type:GoogleApi.DisplayVideo.V1.Model.Pacing.t
, default:nil
) - Required. The budget spending speed setting of the insertion order. -
partnerCosts
(type:list(GoogleApi.DisplayVideo.V1.Model.PartnerCost.t)
, default:nil
) - 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. -
performanceGoal
(type:GoogleApi.DisplayVideo.V1.Model.PerformanceGoal.t
, default:nil
) - Required. Performance goal of the insertion order. -
updateTime
(type:DateTime.t
, default:nil
) - Output only. The timestamp when the insertion order was last updated. Assigned by the system.
Link to this section Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Link to this section Types
Specs
t() :: %GoogleApi.DisplayVideo.V1.Model.InsertionOrder{ advertiserId: String.t(), bidStrategy: GoogleApi.DisplayVideo.V1.Model.BiddingStrategy.t(), budget: GoogleApi.DisplayVideo.V1.Model.InsertionOrderBudget.t(), campaignId: String.t(), displayName: String.t(), entityStatus: String.t(), frequencyCap: GoogleApi.DisplayVideo.V1.Model.FrequencyCap.t(), insertionOrderId: String.t(), integrationDetails: GoogleApi.DisplayVideo.V1.Model.IntegrationDetails.t(), name: String.t(), pacing: GoogleApi.DisplayVideo.V1.Model.Pacing.t(), partnerCosts: [GoogleApi.DisplayVideo.V1.Model.PartnerCost.t()], performanceGoal: GoogleApi.DisplayVideo.V1.Model.PerformanceGoal.t(), updateTime: DateTime.t() }
Link to this section Functions
Specs
Unwrap a decoded JSON object into its complex fields.