com.google.api.services.dfareporting.model

Class Advertiser

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.dfareporting.model.Advertiser

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Contains properties of a Campaign Manager advertiser.

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 Campaign Manager 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
Advertiser()

Method Summary

Modifier and Type	Method and Description
Advertiser	clone()
Long	getAccountId() Account ID of this advertiser.This is a read-only field that can be left blank.
Long	getAdvertiserGroupId() ID of the advertiser group this advertiser belongs to.
String	getClickThroughUrlSuffix() Suffix added to click-through URL of ad creative associations under this advertiser.
Long	getDefaultClickThroughEventTagId() ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
String	getDefaultEmail() Default email address used in sender field for tag emails.
String	getEuPoliticalAdsDeclaration() Optional.
Long	getFloodlightConfigurationId() Floodlight configuration ID of this advertiser.
DimensionValue	getFloodlightConfigurationIdDimensionValue() Dimension value for the ID of the floodlight configuration.
Long	getId() ID of this advertiser.
DimensionValue	getIdDimensionValue() Dimension value for the ID of this advertiser.
String	getKind() Identifies what kind of resource this is.
MeasurementPartnerAdvertiserLink	getMeasurementPartnerLink() Measurement partner advertiser link for tag wrapping.
String	getName() Name of this advertiser.
Long	getOriginalFloodlightConfigurationId() Original floodlight configuration before any sharing occurred.
String	getStatus() Status of this advertiser.
Long	getSubaccountId() Subaccount ID of this advertiser.This is a read-only field that can be left blank.
Boolean	getSuspended() Suspension status of this advertiser.
Advertiser	set(String fieldName, Object value)
Advertiser	setAccountId(Long accountId) Account ID of this advertiser.This is a read-only field that can be left blank.
Advertiser	setAdvertiserGroupId(Long advertiserGroupId) ID of the advertiser group this advertiser belongs to.
Advertiser	setClickThroughUrlSuffix(String clickThroughUrlSuffix) Suffix added to click-through URL of ad creative associations under this advertiser.
Advertiser	setDefaultClickThroughEventTagId(Long defaultClickThroughEventTagId) ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
Advertiser	setDefaultEmail(String defaultEmail) Default email address used in sender field for tag emails.
Advertiser	setEuPoliticalAdsDeclaration(String euPoliticalAdsDeclaration) Optional.
Advertiser	setFloodlightConfigurationId(Long floodlightConfigurationId) Floodlight configuration ID of this advertiser.
Advertiser	setFloodlightConfigurationIdDimensionValue(DimensionValue floodlightConfigurationIdDimensionValue) Dimension value for the ID of the floodlight configuration.
Advertiser	setId(Long id) ID of this advertiser.
Advertiser	setIdDimensionValue(DimensionValue idDimensionValue) Dimension value for the ID of this advertiser.
Advertiser	setKind(String kind) Identifies what kind of resource this is.
Advertiser	setMeasurementPartnerLink(MeasurementPartnerAdvertiserLink measurementPartnerLink) Measurement partner advertiser link for tag wrapping.
Advertiser	setName(String name) Name of this advertiser.
Advertiser	setOriginalFloodlightConfigurationId(Long originalFloodlightConfigurationId) Original floodlight configuration before any sharing occurred.
Advertiser	setStatus(String status) Status of this advertiser.
Advertiser	setSubaccountId(Long subaccountId) Subaccount ID of this advertiser.This is a read-only field that can be left blank.
Advertiser	setSuspended(Boolean suspended) Suspension status of this advertiser.

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

Advertiser

public Advertiser()

Method Detail

getAccountId

public Long getAccountId()

Account ID of this advertiser.This is a read-only field that can be left blank.

Returns:

value or null for none

setAccountId

public Advertiser setAccountId(Long accountId)

Account ID of this advertiser.This is a read-only field that can be left blank.

Parameters:

accountId - accountId or null for none

getAdvertiserGroupId

public Long getAdvertiserGroupId()

ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.

Returns:

value or null for none

setAdvertiserGroupId

public Advertiser setAdvertiserGroupId(Long advertiserGroupId)

ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.

Parameters:

advertiserGroupId - advertiserGroupId or null for none

getClickThroughUrlSuffix

public String getClickThroughUrlSuffix()

Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.

Returns:

value or null for none

setClickThroughUrlSuffix

public Advertiser setClickThroughUrlSuffix(String clickThroughUrlSuffix)

Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.

Parameters:

clickThroughUrlSuffix - clickThroughUrlSuffix or null for none

getDefaultClickThroughEventTagId

public Long getDefaultClickThroughEventTagId()

ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.

Returns:

value or null for none

setDefaultClickThroughEventTagId

public Advertiser setDefaultClickThroughEventTagId(Long defaultClickThroughEventTagId)

ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.

Parameters:

defaultClickThroughEventTagId - defaultClickThroughEventTagId or null for none

getDefaultEmail

public String getDefaultEmail()

Default email address used in sender field for tag emails.

Returns:

value or null for none

setDefaultEmail

public Advertiser setDefaultEmail(String defaultEmail)

Default email address used in sender field for tag emails.

Parameters:

defaultEmail - defaultEmail or null for none

getEuPoliticalAdsDeclaration

public String getEuPoliticalAdsDeclaration()

Optional. Whether the advertiser plans to serve EU political ads.

Returns:

value or null for none

setEuPoliticalAdsDeclaration

public Advertiser setEuPoliticalAdsDeclaration(String euPoliticalAdsDeclaration)

Optional. Whether the advertiser plans to serve EU political ads.

Parameters:

euPoliticalAdsDeclaration - euPoliticalAdsDeclaration or null for none

getFloodlightConfigurationId

public Long getFloodlightConfigurationId()

Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. - This advertiser's original floodlight configuration is not already shared with another advertiser.

Returns:

value or null for none

setFloodlightConfigurationId

public Advertiser setFloodlightConfigurationId(Long floodlightConfigurationId)

Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. - This advertiser's original floodlight configuration is not already shared with another advertiser.

Parameters:

floodlightConfigurationId - floodlightConfigurationId or null for none

getFloodlightConfigurationIdDimensionValue

public DimensionValue getFloodlightConfigurationIdDimensionValue()

Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.

Returns:

value or null for none

setFloodlightConfigurationIdDimensionValue

public Advertiser setFloodlightConfigurationIdDimensionValue(DimensionValue floodlightConfigurationIdDimensionValue)

Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.

Parameters:

floodlightConfigurationIdDimensionValue - floodlightConfigurationIdDimensionValue or null for none

getId

public Long getId()

ID of this advertiser. This is a read-only, auto-generated field.

Returns:

value or null for none

setId

public Advertiser setId(Long id)

ID of this advertiser. This is a read-only, auto-generated field.

Parameters:

id - id or null for none

getIdDimensionValue

public DimensionValue getIdDimensionValue()

Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.

Returns:

value or null for none

setIdDimensionValue

public Advertiser setIdDimensionValue(DimensionValue idDimensionValue)

Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.

Parameters:

idDimensionValue - idDimensionValue or null for none

getKind

public String getKind()

Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".

Returns:

value or null for none

setKind

public Advertiser setKind(String kind)

Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".

Parameters:

kind - kind or null for none

getMeasurementPartnerLink

public MeasurementPartnerAdvertiserLink getMeasurementPartnerLink()

Measurement partner advertiser link for tag wrapping.

Returns:

value or null for none

setMeasurementPartnerLink

public Advertiser setMeasurementPartnerLink(MeasurementPartnerAdvertiserLink measurementPartnerLink)

Measurement partner advertiser link for tag wrapping.

Parameters:

measurementPartnerLink - measurementPartnerLink or null for none

getName

public String getName()

Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.

Returns:

value or null for none

setName

public Advertiser setName(String name)

Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.

Parameters:

name - name or null for none

getOriginalFloodlightConfigurationId

public Long getOriginalFloodlightConfigurationId()

Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.

Returns:

value or null for none

setOriginalFloodlightConfigurationId

public Advertiser setOriginalFloodlightConfigurationId(Long originalFloodlightConfigurationId)

Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.

Parameters:

originalFloodlightConfigurationId - originalFloodlightConfigurationId or null for none

getStatus

public String getStatus()

Status of this advertiser.

Returns:

value or null for none

setStatus

public Advertiser setStatus(String status)

Status of this advertiser.

Parameters:

status - status or null for none

getSubaccountId

public Long getSubaccountId()

Subaccount ID of this advertiser.This is a read-only field that can be left blank.

Returns:

value or null for none

setSubaccountId

public Advertiser setSubaccountId(Long subaccountId)

Subaccount ID of this advertiser.This is a read-only field that can be left blank.

Parameters:

subaccountId - subaccountId or null for none

getSuspended

public Boolean getSuspended()

Suspension status of this advertiser.

Returns:

value or null for none

setSuspended

public Advertiser setSuspended(Boolean suspended)

Suspension status of this advertiser.

Parameters:

suspended - suspended or null for none

set

public Advertiser set(String fieldName,
                      Object value)

Overrides:

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

clone

public Advertiser clone()

Overrides:

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