Class: Google::Apis::DisplayvideoV2::InsertionOrder

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/displayvideo_v2/classes.rb,
lib/google/apis/displayvideo_v2/representations.rb,
lib/google/apis/displayvideo_v2/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.



6449
6450
6451
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6449

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) 


6353
6354
6355
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6353

def advertiser_id
  @advertiser_id
end

#bid_strategy ⇒ Google::Apis::DisplayvideoV2::BiddingStrategy

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

Returns:



6358
6359
6360
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6358

def bid_strategy
  @bid_strategy
end

#billable_outcome ⇒ String

Immutable. The billable outcome of the insertion order. Outcome based buying is deprecated. BILLABLE_OUTCOME_PAY_PER_IMPRESSION is the only valid value. Corresponds to the JSON property billableOutcome

Returns:

  • (String) 


6364
6365
6366
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6364

def billable_outcome
  @billable_outcome
end

#budget ⇒ Google::Apis::DisplayvideoV2::InsertionOrderBudget

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

Returns:



6369
6370
6371
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6369

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) 


6375
6376
6377
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6375

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) 


6381
6382
6383
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6381

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) 


6392
6393
6394
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6392

def entity_status
  @entity_status
end

#frequency_cap ⇒ Google::Apis::DisplayvideoV2::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:



6398
6399
6400
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6398

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) 


6403
6404
6405
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6403

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) 


6409
6410
6411
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6409

def insertion_order_type
  @insertion_order_type
end

#integration_details ⇒ Google::Apis::DisplayvideoV2::IntegrationDetails

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

Returns:



6414
6415
6416
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6414

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) 


6419
6420
6421
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6419

def name
  @name
end

#pacing ⇒ Google::Apis::DisplayvideoV2::Pacing

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

Returns:



6424
6425
6426
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6424

def pacing
  @pacing
end

#partner_costs ⇒ Array<Google::Apis::DisplayvideoV2::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:



6431
6432
6433
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6431

def partner_costs
  @partner_costs
end

#performance_goal ⇒ Google::Apis::DisplayvideoV2::PerformanceGoal

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

Returns:



6436
6437
6438
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6436

def performance_goal
  @performance_goal
end

#reservation_type ⇒ String

Output only. The reservation type of the insertion order. Corresponds to the JSON property reservationType

Returns:

  • (String) 


6441
6442
6443
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6441

def reservation_type
  @reservation_type
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) 


6447
6448
6449
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6447

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6454

def update!(**args)
  @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id)
  @bid_strategy = args[:bid_strategy] if args.key?(:bid_strategy)
  @billable_outcome = args[:billable_outcome] if args.key?(:billable_outcome)
  @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)
  @reservation_type = args[:reservation_type] if args.key?(:reservation_type)
  @update_time = args[:update_time] if args.key?(:update_time)
end