Class: Google::Apis::DisplayvideoV1::InsertionOrder

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/displayvideo_v1/classes.rb,
lib/google/apis/displayvideo_v1/representations.rb,
lib/google/apis/displayvideo_v1/representations.rb

Overview

A single insertion order.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ InsertionOrder

Returns a new instance of InsertionOrder.



5272
5273
5274
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5272

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#advertiser_id ⇒ Fixnum

Output only. The unique ID of the advertiser the insertion order belongs to. Corresponds to the JSON property advertiserId

Returns:

  • (Fixnum) 


5187
5188
5189
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5187

def advertiser_id
  @advertiser_id
end

#bid_strategy ⇒ Google::Apis::DisplayvideoV1::BiddingStrategy

Settings that control the bid strategy. Bid strategy determines the bid price. Corresponds to the JSON property bidStrategy

Returns:



5192
5193
5194
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5192

def bid_strategy
  @bid_strategy
end

#budget ⇒ Google::Apis::DisplayvideoV1::InsertionOrderBudget

Settings that control how insertion order budget is allocated. Corresponds to the JSON property budget

Returns:



5197
5198
5199
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5197

def budget
  @budget
end

#campaign_id ⇒ Fixnum

Required. Immutable. The unique ID of the campaign that the insertion order belongs to. Corresponds to the JSON property campaignId

Returns:

  • (Fixnum) 


5203
5204
5205
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5203

def campaign_id
  @campaign_id
end

#display_name ⇒ String

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

Returns:

  • (String) 


5209
5210
5211
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5209

def display_name
  @display_name
end

#entity_status ⇒ String

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

Returns:

  • (String) 


5220
5221
5222
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5220

def entity_status
  @entity_status
end

#frequency_cap ⇒ Google::Apis::DisplayvideoV1::FrequencyCap

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

Returns:



5226
5227
5228
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5226

def frequency_cap
  @frequency_cap
end

#insertion_order_id ⇒ Fixnum

Output only. The unique ID of the insertion order. Assigned by the system. Corresponds to the JSON property insertionOrderId

Returns:

  • (Fixnum) 


5231
5232
5233
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5231

def insertion_order_id
  @insertion_order_id
end

#insertion_order_type ⇒ String

The type of insertion order. If this field is unspecified in creation, the value defaults to RTB. Corresponds to the JSON property insertionOrderType

Returns:

  • (String) 


5237
5238
5239
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5237

def insertion_order_type
  @insertion_order_type
end

#integration_details ⇒ Google::Apis::DisplayvideoV1::IntegrationDetails

Integration details of an entry. Corresponds to the JSON property integrationDetails

Returns:



5242
5243
5244
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5242

def integration_details
  @integration_details
end

#name ⇒ String

Output only. The resource name of the insertion order. Corresponds to the JSON property name

Returns:

  • (String) 


5247
5248
5249
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5247

def name
  @name
end

#pacing ⇒ Google::Apis::DisplayvideoV1::Pacing

Settings that control the rate at which a budget is spent. Corresponds to the JSON property pacing

Returns:



5252
5253
5254
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5252

def pacing
  @pacing
end

#partner_costs ⇒ Array<Google::Apis::DisplayvideoV1::PartnerCost>

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

Returns:



5259
5260
5261
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5259

def partner_costs
  @partner_costs
end

#performance_goal ⇒ Google::Apis::DisplayvideoV1::PerformanceGoal

Settings that control the performance goal of a campaign or insertion order. Corresponds to the JSON property performanceGoal

Returns:



5264
5265
5266
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5264

def performance_goal
  @performance_goal
end

#update_time ⇒ String

Output only. The timestamp when the insertion order was last updated. Assigned by the system. Corresponds to the JSON property updateTime

Returns:

  • (String) 


5270
5271
5272
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5270

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5277

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