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.



5955
5956
5957
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5955

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) 


5859
5860
5861
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5859

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:



5864
5865
5866
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5864

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) 


5870
5871
5872
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5870

def billable_outcome
  @billable_outcome
end

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

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

Returns:



5875
5876
5877
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5875

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) 


5881
5882
5883
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5881

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) 


5887
5888
5889
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5887

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) 


5898
5899
5900
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5898

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:



5904
5905
5906
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5904

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) 


5909
5910
5911
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5909

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) 


5915
5916
5917
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5915

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:



5920
5921
5922
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5920

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) 


5925
5926
5927
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5925

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:



5930
5931
5932
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5930

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:



5937
5938
5939
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5937

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:



5942
5943
5944
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5942

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) 


5947
5948
5949
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5947

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) 


5953
5954
5955
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5953

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5960

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