com.google.api.services.displayvideo.v3.model

Class Kpi

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.displayvideo.v3.model.Kpi

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Kpi
extends com.google.api.client.json.GenericJson

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

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Display & Video 360 API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Kpi()

Method Summary

Modifier and Type	Method and Description
Kpi	clone()
Long	getKpiAlgorithmId() Optional.
Long	getKpiAmountMicros() The goal amount, in micros of the advertiser's currency.
Long	getKpiPercentageMicros() The decimal representation of the goal percentage in micros.
String	getKpiString() A KPI string, which can be empty.
String	getKpiType() Required.
Kpi	set(String fieldName, Object value)
Kpi	setKpiAlgorithmId(Long kpiAlgorithmId) Optional.
Kpi	setKpiAmountMicros(Long kpiAmountMicros) The goal amount, in micros of the advertiser's currency.
Kpi	setKpiPercentageMicros(Long kpiPercentageMicros) The decimal representation of the goal percentage in micros.
Kpi	setKpiString(String kpiString) A KPI string, which can be empty.
Kpi	setKpiType(String kpiType) Required.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Kpi

public Kpi()

Method Detail

getKpiAlgorithmId

public Long getKpiAlgorithmId()

Optional. Custom Bidding Algorithm ID associated with KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST. This field is ignored if the proper KPI is not selected.

Returns:

value or null for none

setKpiAlgorithmId

public Kpi setKpiAlgorithmId(Long kpiAlgorithmId)

Optional. Custom Bidding Algorithm ID associated with KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST. This field is ignored if the proper KPI is not selected.

Parameters:

kpiAlgorithmId - kpiAlgorithmId or null for none

getKpiAmountMicros

public Long getKpiAmountMicros()

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.

Returns:

value or null for none

setKpiAmountMicros

public Kpi setKpiAmountMicros(Long kpiAmountMicros)

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.

Parameters:

kpiAmountMicros - kpiAmountMicros or null for none

getKpiPercentageMicros

public Long getKpiPercentageMicros()

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

Returns:

value or null for none

setKpiPercentageMicros

public Kpi setKpiPercentageMicros(Long kpiPercentageMicros)

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

Parameters:

kpiPercentageMicros - kpiPercentageMicros or null for none

getKpiString

public String getKpiString()

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`.

Returns:

value or null for none

setKpiString

public Kpi setKpiString(String kpiString)

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`.

Parameters:

kpiString - kpiString or null for none

getKpiType

public String getKpiType()

Required. The type of KPI.

Returns:

value or null for none

setKpiType

public Kpi setKpiType(String kpiType)

Required. The type of KPI.

Parameters:

kpiType - kpiType or null for none

set

public Kpi set(String fieldName,
               Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Kpi clone()

Overrides:

clone in class com.google.api.client.json.GenericJson