GoogleApi.DisplayVideo.V1.Model.InsertionOrder (google_api_display_video v0.39.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.
  • billableOutcome (type: String.t, default: nil) - Immutable. The billable outcome of the insertion order. Outcome based buying is deprecated. BILLABLE_OUTCOME_PAY_PER_IMPRESSION is the only valid value.
  • 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, 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.
  • 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.
  • insertionOrderType (type: String.t, default: nil) - The type of insertion order. If this field is unspecified in creation, the value defaults to RTB.
  • 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.
  • reservationType (type: String.t, default: nil) - Output only. The reservation type 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.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.DisplayVideo.V1.Model.InsertionOrder{
  advertiserId: String.t() | nil,
  bidStrategy: GoogleApi.DisplayVideo.V1.Model.BiddingStrategy.t() | nil,
  billableOutcome: String.t() | nil,
  budget: GoogleApi.DisplayVideo.V1.Model.InsertionOrderBudget.t() | nil,
  campaignId: String.t() | nil,
  displayName: String.t() | nil,
  entityStatus: String.t() | nil,
  frequencyCap: GoogleApi.DisplayVideo.V1.Model.FrequencyCap.t() | nil,
  insertionOrderId: String.t() | nil,
  insertionOrderType: String.t() | nil,
  integrationDetails:
    GoogleApi.DisplayVideo.V1.Model.IntegrationDetails.t() | nil,
  name: String.t() | nil,
  pacing: GoogleApi.DisplayVideo.V1.Model.Pacing.t() | nil,
  partnerCosts: [GoogleApi.DisplayVideo.V1.Model.PartnerCost.t()] | nil,
  performanceGoal: GoogleApi.DisplayVideo.V1.Model.PerformanceGoal.t() | nil,
  reservationType: String.t() | nil,
  updateTime: DateTime.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.