Class: Google::Apis::DisplayvideoV1::PerformanceGoal

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

Settings that control the performance goal of a campaign or insertion order.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PerformanceGoal

Returns a new instance of PerformanceGoal.



7213
7214
7215
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 7213

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

Instance Attribute Details

#performance_goal_amount_micros ⇒ Fixnum

The goal amount, in micros of the advertiser's currency. Applicable when performance_goal_type is one of: * PERFORMANCE_GOAL_TYPE_CPM * PERFORMANCE_GOAL_TYPE_CPC * PERFORMANCE_GOAL_TYPE_CPA * PERFORMANCE_GOAL_TYPE_CPIAVC For example 1500000 represents 1.5 standard units of the currency. Corresponds to the JSON property performanceGoalAmountMicros

Returns:

  • (Fixnum) 


7191
7192
7193
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 7191

def performance_goal_amount_micros
  @performance_goal_amount_micros
end

#performance_goal_percentage_micros ⇒ Fixnum

The decimal representation of the goal percentage in micros. Applicable when performance_goal_type is one of: * PERFORMANCE_GOAL_TYPE_CTR * PERFORMANCE_GOAL_TYPE_VIEWABILITY For example, 70000 represents 7% (decimal 0. 07). Corresponds to the JSON property performanceGoalPercentageMicros

Returns:

  • (Fixnum) 


7199
7200
7201
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 7199

def performance_goal_percentage_micros
  @performance_goal_percentage_micros
end

#performance_goal_string ⇒ String

A key performance indicator (KPI) string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when performance_goal_type is set to PERFORMANCE_GOAL_TYPE_OTHER. Corresponds to the JSON property performanceGoalString

Returns:

  • (String) 


7206
7207
7208
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 7206

def performance_goal_string
  @performance_goal_string
end

#performance_goal_type ⇒ String

Required. The type of the performance goal. Corresponds to the JSON property performanceGoalType

Returns:

  • (String) 


7211
7212
7213
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 7211

def performance_goal_type
  @performance_goal_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7218
7219
7220
7221
7222
7223
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 7218

def update!(**args)
  @performance_goal_amount_micros = args[:performance_goal_amount_micros] if args.key?(:performance_goal_amount_micros)
  @performance_goal_percentage_micros = args[:performance_goal_percentage_micros] if args.key?(:performance_goal_percentage_micros)
  @performance_goal_string = args[:performance_goal_string] if args.key?(:performance_goal_string)
  @performance_goal_type = args[:performance_goal_type] if args.key?(:performance_goal_type)
end