Class: Google::Apis::DisplayvideoV3::Kpi

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

Settings that control the key performance indicator, or KPI, of an insertion order.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Kpi

Returns a new instance of Kpi.



8116
8117
8118
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 8116

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

Instance Attribute Details

#kpi_algorithm_id ⇒ Fixnum

Optional. Custom Bidding Algorithm ID associated with KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST. This field is ignored if the proper KPI is not selected. Corresponds to the JSON property kpiAlgorithmId

Returns:

  • (Fixnum) 


8086
8087
8088
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 8086

def kpi_algorithm_id
  @kpi_algorithm_id
end

#kpi_amount_micros ⇒ Fixnum

The goal amount, in micros of the advertiser's currency. Applicable when kpi_type is one of: * KPI_TYPE_CPM * KPI_TYPE_CPC * KPI_TYPE_CPA * KPI_TYPE_CPIAVC * KPI_TYPE_VCPM For example: 1500000 represents 1.5 standard units of the currency. Corresponds to the JSON property kpiAmountMicros

Returns:

  • (Fixnum) 


8094
8095
8096
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 8094

def kpi_amount_micros
  @kpi_amount_micros
end

#kpi_percentage_micros ⇒ Fixnum

The decimal representation of the goal percentage in micros. Applicable when kpi_type is one of: * KPI_TYPE_CTR * KPI_TYPE_VIEWABILITY * KPI_TYPE_CLICK_CVR * KPI_TYPE_IMPRESSION_CVR * KPI_TYPE_VTR * KPI_TYPE_AUDIO_COMPLETION_RATE * KPI_TYPE_VIDEO_COMPLETION_RATE For example: 70000 represents 7% (decimal 0.07). Corresponds to the JSON property kpiPercentageMicros

Returns:

  • (Fixnum) 


8103
8104
8105
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 8103

def kpi_percentage_micros
  @kpi_percentage_micros
end

#kpi_string ⇒ String

A KPI string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when kpi_type is KPI_TYPE_OTHER. Corresponds to the JSON property kpiString

Returns:

  • (String) 


8109
8110
8111
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 8109

def kpi_string
  @kpi_string
end

#kpi_type ⇒ String

Required. The type of KPI. Corresponds to the JSON property kpiType

Returns:

  • (String) 


8114
8115
8116
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 8114

def kpi_type
  @kpi_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8121
8122
8123
8124
8125
8126
8127
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 8121

def update!(**args)
  @kpi_algorithm_id = args[:kpi_algorithm_id] if args.key?(:kpi_algorithm_id)
  @kpi_amount_micros = args[:kpi_amount_micros] if args.key?(:kpi_amount_micros)
  @kpi_percentage_micros = args[:kpi_percentage_micros] if args.key?(:kpi_percentage_micros)
  @kpi_string = args[:kpi_string] if args.key?(:kpi_string)
  @kpi_type = args[:kpi_type] if args.key?(:kpi_type)
end