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

Class TargetingExpansionConfig

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item.

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

Method Summary

Modifier and Type	Method and Description
TargetingExpansionConfig	clone()
String	getAudienceExpansionLevel() Output only.
Boolean	getAudienceExpansionSeedListExcluded() Output only.
Boolean	getEnableOptimizedTargeting() Required.
Boolean	getExcludeDemographicExpansion() Optional.
TargetingExpansionConfig	set(String fieldName, Object value)
TargetingExpansionConfig	setAudienceExpansionLevel(String audienceExpansionLevel) Output only.
TargetingExpansionConfig	setAudienceExpansionSeedListExcluded(Boolean audienceExpansionSeedListExcluded) Output only.
TargetingExpansionConfig	setEnableOptimizedTargeting(Boolean enableOptimizedTargeting) Required.
TargetingExpansionConfig	setExcludeDemographicExpansion(Boolean excludeDemographicExpansion) Optional.

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

TargetingExpansionConfig

public TargetingExpansionConfig()

Method Detail

getAudienceExpansionLevel

public String getAudienceExpansionLevel()

Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.

Returns:

value or null for none

setAudienceExpansionLevel

public TargetingExpansionConfig setAudienceExpansionLevel(String audienceExpansionLevel)

Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.

Parameters:

audienceExpansionLevel - audienceExpansionLevel or null for none

getAudienceExpansionSeedListExcluded

public Boolean getAudienceExpansionSeedListExcluded()

Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.

Returns:

value or null for none

setAudienceExpansionSeedListExcluded

public TargetingExpansionConfig setAudienceExpansionSeedListExcluded(Boolean audienceExpansionSeedListExcluded)

Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.

Parameters:

audienceExpansionSeedListExcluded - audienceExpansionSeedListExcluded or null for none

getEnableOptimizedTargeting

public Boolean getEnableOptimizedTargeting()

Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`.

Returns:

value or null for none

setEnableOptimizedTargeting

public TargetingExpansionConfig setEnableOptimizedTargeting(Boolean enableOptimizedTargeting)

Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`.

Parameters:

enableOptimizedTargeting - enableOptimizedTargeting or null for none

getExcludeDemographicExpansion

public Boolean getExcludeDemographicExpansion()

Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users.

Returns:

value or null for none

setExcludeDemographicExpansion

public TargetingExpansionConfig setExcludeDemographicExpansion(Boolean excludeDemographicExpansion)

Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users.

Parameters:

excludeDemographicExpansion - excludeDemographicExpansion or null for none

set

public TargetingExpansionConfig set(String fieldName,
                                    Object value)

Overrides:

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

clone

public TargetingExpansionConfig clone()

Overrides:

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