com.google.api.services.displayvideo.v4.model

Class PerformanceGoalBidStrategy

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.v4.model.PerformanceGoalBidStrategy

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

A strategy that automatically adjusts the bid to meet or beat a specified performance goal.

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

Method Summary

Modifier and Type	Method and Description
PerformanceGoalBidStrategy	clone()
Long	getCustomBiddingAlgorithmId() The ID of the Custom Bidding Algorithm used by this strategy.
Long	getMaxAverageCpmBidAmountMicros() The maximum average CPM that may be bid, in micros of the advertiser's currency.
Long	getPerformanceGoalAmountMicros() Required.
String	getPerformanceGoalType() Required.
PerformanceGoalBidStrategy	set(String fieldName, Object value)
PerformanceGoalBidStrategy	setCustomBiddingAlgorithmId(Long customBiddingAlgorithmId) The ID of the Custom Bidding Algorithm used by this strategy.
PerformanceGoalBidStrategy	setMaxAverageCpmBidAmountMicros(Long maxAverageCpmBidAmountMicros) The maximum average CPM that may be bid, in micros of the advertiser's currency.
PerformanceGoalBidStrategy	setPerformanceGoalAmountMicros(Long performanceGoalAmountMicros) Required.
PerformanceGoalBidStrategy	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

PerformanceGoalBidStrategy

public PerformanceGoalBidStrategy()

Method Detail

getCustomBiddingAlgorithmId

public Long getCustomBiddingAlgorithmId()

The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.

Returns:

value or null for none

setCustomBiddingAlgorithmId

public PerformanceGoalBidStrategy setCustomBiddingAlgorithmId(Long customBiddingAlgorithmId)

The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.

Parameters:

customBiddingAlgorithmId - customBiddingAlgorithmId or null for none

getMaxAverageCpmBidAmountMicros

public Long getMaxAverageCpmBidAmountMicros()

The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency.

Returns:

value or null for none

setMaxAverageCpmBidAmountMicros

public PerformanceGoalBidStrategy setMaxAverageCpmBidAmountMicros(Long maxAverageCpmBidAmountMicros)

The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency.

Parameters:

maxAverageCpmBidAmountMicros - maxAverageCpmBidAmountMicros or null for none

getPerformanceGoalAmountMicros

public Long getPerformanceGoalAmountMicros()

Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.

Returns:

value or null for none

setPerformanceGoalAmountMicros

public PerformanceGoalBidStrategy setPerformanceGoalAmountMicros(Long performanceGoalAmountMicros)

Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.

Parameters:

performanceGoalAmountMicros - performanceGoalAmountMicros or null for none

getPerformanceGoalType

public String getPerformanceGoalType()

Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.

Returns:

value or null for none

setPerformanceGoalType

public PerformanceGoalBidStrategy setPerformanceGoalType(String performanceGoalType)

Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.

Parameters:

performanceGoalType - performanceGoalType or null for none

set

public PerformanceGoalBidStrategy set(String fieldName,
                                      Object value)

Overrides:

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

clone

public PerformanceGoalBidStrategy clone()

Overrides:

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