com.google.api.services.displayvideo.v2.model

Class PerformanceGoal

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.v2.model.PerformanceGoal

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Settings that control the performance goal of a campaign.

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
PerformanceGoal()

Method Summary

Modifier and Type	Method and Description
PerformanceGoal	clone()
Long	getPerformanceGoalAmountMicros() The goal amount, in micros of the advertiser's currency.
Long	getPerformanceGoalPercentageMicros() The decimal representation of the goal percentage in micros.
String	getPerformanceGoalString() A key performance indicator (KPI) string, which can be empty.
String	getPerformanceGoalType() Required.
PerformanceGoal	set(String fieldName, Object value)
PerformanceGoal	setPerformanceGoalAmountMicros(Long performanceGoalAmountMicros) The goal amount, in micros of the advertiser's currency.
PerformanceGoal	setPerformanceGoalPercentageMicros(Long performanceGoalPercentageMicros) The decimal representation of the goal percentage in micros.
PerformanceGoal	setPerformanceGoalString(String performanceGoalString) A key performance indicator (KPI) string, which can be empty.
PerformanceGoal	setPerformanceGoalType(String performanceGoalType) 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

PerformanceGoal

public PerformanceGoal()

Method Detail

getPerformanceGoalAmountMicros

public Long getPerformanceGoalAmountMicros()

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` * `PERFORMANCE_GOAL_TYPE_VCPM` For example 1500000 represents 1.5 standard units of the currency.

Returns:

value or null for none

setPerformanceGoalAmountMicros

public PerformanceGoal setPerformanceGoalAmountMicros(Long performanceGoalAmountMicros)

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` * `PERFORMANCE_GOAL_TYPE_VCPM` For example 1500000 represents 1.5 standard units of the currency.

Parameters:

performanceGoalAmountMicros - performanceGoalAmountMicros or null for none

getPerformanceGoalPercentageMicros

public Long getPerformanceGoalPercentageMicros()

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` * `PERFORMANCE_GOAL_TYPE_CLICK_CVR` * `PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR` * `PERFORMANCE_GOAL_TYPE_VTR` * `PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE` * `PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE` For example, 70000 represents 7% (decimal 0.07).

Returns:

value or null for none

setPerformanceGoalPercentageMicros

public PerformanceGoal setPerformanceGoalPercentageMicros(Long performanceGoalPercentageMicros)

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` * `PERFORMANCE_GOAL_TYPE_CLICK_CVR` * `PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR` * `PERFORMANCE_GOAL_TYPE_VTR` * `PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE` * `PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE` For example, 70000 represents 7% (decimal 0.07).

Parameters:

performanceGoalPercentageMicros - performanceGoalPercentageMicros or null for none

getPerformanceGoalString

public String getPerformanceGoalString()

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

Returns:

value or null for none

setPerformanceGoalString

public PerformanceGoal setPerformanceGoalString(String performanceGoalString)

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

Parameters:

performanceGoalString - performanceGoalString or null for none

getPerformanceGoalType

public String getPerformanceGoalType()

Required. The type of the performance goal.

Returns:

value or null for none

setPerformanceGoalType

public PerformanceGoal setPerformanceGoalType(String performanceGoalType)

Required. The type of the performance goal.

Parameters:

performanceGoalType - performanceGoalType or null for none

set

public PerformanceGoal set(String fieldName,
                           Object value)

Overrides:

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

clone

public PerformanceGoal clone()

Overrides:

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