Class: Google::Apis::DisplayvideoV4::InsertionOrder

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



9050
9051
9052
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 9050

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) 


8954
8955
8956
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 8954

def advertiser_id
  @advertiser_id
end

#bid_strategy ⇒ Google::Apis::DisplayvideoV4::BiddingStrategy

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

Returns:



8959
8960
8961
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 8959

def bid_strategy
  @bid_strategy
end

#budget ⇒ Google::Apis::DisplayvideoV4::InsertionOrderBudget

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

Returns:



8964
8965
8966
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 8964

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) 


8970
8971
8972
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 8970

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) 


8976
8977
8978
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 8976

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) 


8987
8988
8989
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 8987

def entity_status
  @entity_status
end

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



8993
8994
8995
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 8993

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) 


8998
8999
9000
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 8998

def insertion_order_id
  @insertion_order_id
end

#insertion_order_type ⇒ String

Optional. 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) 


9004
9005
9006
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 9004

def insertion_order_type
  @insertion_order_type
end

#integration_details ⇒ Google::Apis::DisplayvideoV4::IntegrationDetails

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

Returns:



9009
9010
9011
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 9009

def integration_details
  @integration_details
end

#kpi ⇒ Google::Apis::DisplayvideoV4::Kpi

Settings that control the key performance indicator, or KPI, of an insertion order. Corresponds to the JSON property kpi

Returns:



9015
9016
9017
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 9015

def kpi
  @kpi
end

#name ⇒ String

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

Returns:

  • (String) 


9020
9021
9022
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 9020

def name
  @name
end

#optimization_objective ⇒ String

Optional. Required. The optimization objective of the insertion order. Corresponds to the JSON property optimizationObjective

Returns:

  • (String) 


9025
9026
9027
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 9025

def optimization_objective
  @optimization_objective
end

#pacing ⇒ Google::Apis::DisplayvideoV4::Pacing

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

Returns:



9030
9031
9032
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 9030

def pacing
  @pacing
end

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

Optional. 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:



9037
9038
9039
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 9037

def partner_costs
  @partner_costs
end

#reservation_type ⇒ String

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

Returns:

  • (String) 


9042
9043
9044
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 9042

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) 


9048
9049
9050
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 9048

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 9055

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)
  @kpi = args[:kpi] if args.key?(:kpi)
  @name = args[:name] if args.key?(:name)
  @optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
  @pacing = args[:pacing] if args.key?(:pacing)
  @partner_costs = args[:partner_costs] if args.key?(:partner_costs)
  @reservation_type = args[:reservation_type] if args.key?(:reservation_type)
  @update_time = args[:update_time] if args.key?(:update_time)
end