class Google::Apis::DisplayvideoV1::InsertionOrder

A single insertion order.

Attributes

advertiser_id[RW]

Output only. The unique ID of the advertiser the insertion order belongs to. Corresponds to the JSON property `advertiserId` @return [Fixnum]

bid_strategy[RW]

Settings that control the bid strategy. Bid strategy determines the bid price. Corresponds to the JSON property `bidStrategy` @return [Google::Apis::DisplayvideoV1::BiddingStrategy]

budget[RW]

Settings that control how insertion order budget is allocated. Corresponds to the JSON property `budget` @return [Google::Apis::DisplayvideoV1::InsertionOrderBudget]

campaign_id[RW]

Required. Immutable. The unique ID of the campaign that the insertion order belongs to. Corresponds to the JSON property `campaignId` @return [Fixnum]

display_name[RW]

Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes. Corresponds to the JSON property `displayName` @return [String]

entity_status[RW]

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. Corresponds to the JSON property `entityStatus` @return [String]

frequency_cap[RW]

Settings that control the number of times a user may be shown with the same ad during a given time period. Corresponds to the JSON property `frequencyCap` @return [Google::Apis::DisplayvideoV1::FrequencyCap]

insertion_order_id[RW]

Output only. The unique ID of the insertion order. Assigned by the system. Corresponds to the JSON property `insertionOrderId` @return [Fixnum]

insertion_order_type[RW]

The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`. Corresponds to the JSON property `insertionOrderType` @return [String]

integration_details[RW]

Integration details of an entry. Corresponds to the JSON property `integrationDetails` @return [Google::Apis::DisplayvideoV1::IntegrationDetails]

name[RW]

Output only. The resource name of the insertion order. Corresponds to the JSON property `name` @return [String]

pacing[RW]

Settings that control the rate at which a budget is spent. Corresponds to the JSON property `pacing` @return [Google::Apis::DisplayvideoV1::Pacing]

partner_costs[RW]

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. Corresponds to the JSON property `partnerCosts` @return [Array<Google::Apis::DisplayvideoV1::PartnerCost>]

performance_goal[RW]

Settings that control the performance goal of a campaign or insertion order. Corresponds to the JSON property `performanceGoal` @return [Google::Apis::DisplayvideoV1::PerformanceGoal]

update_time[RW]

Output only. The timestamp when the insertion order was last updated. Assigned by the system. Corresponds to the JSON property `updateTime` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/displayvideo_v1/classes.rb, line 5120
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/displayvideo_v1/classes.rb, line 5125
def update!(**args)
  @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id)
  @bid_strategy = args[:bid_strategy] if args.key?(:bid_strategy)
  @budget = args[:budget] if args.key?(:budget)
  @campaign_id = args[:campaign_id] if args.key?(:campaign_id)
  @display_name = args[:display_name] if args.key?(:display_name)
  @entity_status = args[:entity_status] if args.key?(:entity_status)
  @frequency_cap = args[:frequency_cap] if args.key?(:frequency_cap)
  @insertion_order_id = args[:insertion_order_id] if args.key?(:insertion_order_id)
  @insertion_order_type = args[:insertion_order_type] if args.key?(:insertion_order_type)
  @integration_details = args[:integration_details] if args.key?(:integration_details)
  @name = args[:name] if args.key?(:name)
  @pacing = args[:pacing] if args.key?(:pacing)
  @partner_costs = args[:partner_costs] if args.key?(:partner_costs)
  @performance_goal = args[:performance_goal] if args.key?(:performance_goal)
  @update_time = args[:update_time] if args.key?(:update_time)
end