Class: Google::Apis::DisplayvideoV3::InsertionOrder

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



7146
7147
7148
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7146

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) 


7048
7049
7050
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7048

def advertiser_id
  @advertiser_id
end

#bid_strategy ⇒ Google::Apis::DisplayvideoV3::BiddingStrategy

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

Returns:



7053
7054
7055
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7053

def bid_strategy
  @bid_strategy
end

#budget ⇒ Google::Apis::DisplayvideoV3::InsertionOrderBudget

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

Returns:



7058
7059
7060
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7058

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) 


7064
7065
7066
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7064

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) 


7070
7071
7072
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7070

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) 


7081
7082
7083
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7081

def entity_status
  @entity_status
end

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



7087
7088
7089
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7087

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) 


7092
7093
7094
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7092

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) 


7098
7099
7100
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7098

def insertion_order_type
  @insertion_order_type
end

#integration_details ⇒ Google::Apis::DisplayvideoV3::IntegrationDetails

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

Returns:



7103
7104
7105
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7103

def integration_details
  @integration_details
end

#kpi ⇒ Google::Apis::DisplayvideoV3::Kpi

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

Returns:



7109
7110
7111
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7109

def kpi
  @kpi
end

#name ⇒ String

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

Returns:

  • (String) 


7114
7115
7116
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7114

def name
  @name
end

#optimization_objective ⇒ String

Optional. The optimization objective of the insertion order. This field is only available to allowlisted customers. If a customer is not allowlisted, this field will be null and attempts to set it will return an error. Corresponds to the JSON property optimizationObjective

Returns:

  • (String) 


7121
7122
7123
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7121

def optimization_objective
  @optimization_objective
end

#pacing ⇒ Google::Apis::DisplayvideoV3::Pacing

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

Returns:



7126
7127
7128
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7126

def pacing
  @pacing
end

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



7133
7134
7135
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7133

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) 


7138
7139
7140
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7138

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) 


7144
7145
7146
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7144

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7151

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