com.google.api.services.dfareporting.model

Class AdBlockingConfiguration

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.dfareporting.model.AdBlockingConfiguration

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

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

Campaign ad blocking settings.

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 DCM/DFA Reporting And Trafficking 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

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

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

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
AdBlockingConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
AdBlockingConfiguration	clone()
java.lang.String	getClickThroughUrl() Click-through URL used by brand-neutral ads.
java.lang.Long	getCreativeBundleId() ID of a creative bundle to use for this campaign.
java.lang.Boolean	getEnabled() Whether this campaign has enabled ad blocking.
java.lang.Boolean	getOverrideClickThroughUrl() Whether the brand-neutral ad's click-through URL comes from the campaign's creative bundle or the override URL.
AdBlockingConfiguration	set(java.lang.String fieldName, java.lang.Object value)
AdBlockingConfiguration	setClickThroughUrl(java.lang.String clickThroughUrl) Click-through URL used by brand-neutral ads.
AdBlockingConfiguration	setCreativeBundleId(java.lang.Long creativeBundleId) ID of a creative bundle to use for this campaign.
AdBlockingConfiguration	setEnabled(java.lang.Boolean enabled) Whether this campaign has enabled ad blocking.
AdBlockingConfiguration	setOverrideClickThroughUrl(java.lang.Boolean overrideClickThroughUrl) Whether the brand-neutral ad's click-through URL comes from the campaign's creative bundle or the override URL.

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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AdBlockingConfiguration

public AdBlockingConfiguration()

Method Detail

getClickThroughUrl

public java.lang.String getClickThroughUrl()

Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true.

Returns:

value or null for none

setClickThroughUrl

public AdBlockingConfiguration setClickThroughUrl(java.lang.String clickThroughUrl)

Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true.

Parameters:

clickThroughUrl - clickThroughUrl or null for none

getCreativeBundleId

public java.lang.Long getCreativeBundleId()

ID of a creative bundle to use for this campaign. If set, brand-neutral ads will select creatives from this bundle. Otherwise, a default transparent pixel will be used.

Returns:

value or null for none

setCreativeBundleId

public AdBlockingConfiguration setCreativeBundleId(java.lang.Long creativeBundleId)

ID of a creative bundle to use for this campaign. If set, brand-neutral ads will select creatives from this bundle. Otherwise, a default transparent pixel will be used.

Parameters:

creativeBundleId - creativeBundleId or null for none

getEnabled

public java.lang.Boolean getEnabled()

Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings.

Returns:

value or null for none

setEnabled

public AdBlockingConfiguration setEnabled(java.lang.Boolean enabled)

Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings.

Parameters:

enabled - enabled or null for none

getOverrideClickThroughUrl

public java.lang.Boolean getOverrideClickThroughUrl()

Whether the brand-neutral ad's click-through URL comes from the campaign's creative bundle or the override URL. Must be set to true if ad blocking is enabled and no creative bundle is configured.

Returns:

value or null for none

setOverrideClickThroughUrl

public AdBlockingConfiguration setOverrideClickThroughUrl(java.lang.Boolean overrideClickThroughUrl)

Whether the brand-neutral ad's click-through URL comes from the campaign's creative bundle or the override URL. Must be set to true if ad blocking is enabled and no creative bundle is configured.

Parameters:

overrideClickThroughUrl - overrideClickThroughUrl or null for none

set

public AdBlockingConfiguration set(java.lang.String fieldName,
                          java.lang.Object value)

Overrides:

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

clone

public AdBlockingConfiguration clone()

Overrides:

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