com.google.api.services.dfareporting.model

Class EventTag

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Contains properties of an event tag.

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

Method Summary

Modifier and Type	Method and Description
EventTag	clone()
Long	getAccountId() Account ID of this event tag.
Long	getAdvertiserId() Advertiser ID of this event tag.
DimensionValue	getAdvertiserIdDimensionValue() Dimension value for the ID of the advertiser.
Long	getCampaignId() Campaign ID of this event tag.
DimensionValue	getCampaignIdDimensionValue() Dimension value for the ID of the campaign.
Boolean	getEnabledByDefault() Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
Boolean	getExcludeFromAdxRequests() Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange.
Long	getId() ID of this event tag.
String	getKind() Identifies what kind of resource this is.
String	getName() Name of this event tag.
String	getSiteFilterType() Site filter type for this event tag.
List<Long>	getSiteIds() Filter list of site IDs associated with this event tag.
Boolean	getSslCompliant() Whether this tag is SSL-compliant or not.
String	getStatus() Status of this event tag.
Long	getSubaccountId() Subaccount ID of this event tag.
String	getType() Event tag type.
String	getUrl() Payload URL for this event tag.
Integer	getUrlEscapeLevels() Number of times the landing page URL should be URL-escaped before being appended to the click- through event tag URL.
EventTag	set(String fieldName, Object value)
EventTag	setAccountId(Long accountId) Account ID of this event tag.
EventTag	setAdvertiserId(Long advertiserId) Advertiser ID of this event tag.
EventTag	setAdvertiserIdDimensionValue(DimensionValue advertiserIdDimensionValue) Dimension value for the ID of the advertiser.
EventTag	setCampaignId(Long campaignId) Campaign ID of this event tag.
EventTag	setCampaignIdDimensionValue(DimensionValue campaignIdDimensionValue) Dimension value for the ID of the campaign.
EventTag	setEnabledByDefault(Boolean enabledByDefault) Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
EventTag	setExcludeFromAdxRequests(Boolean excludeFromAdxRequests) Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange.
EventTag	setId(Long id) ID of this event tag.
EventTag	setKind(String kind) Identifies what kind of resource this is.
EventTag	setName(String name) Name of this event tag.
EventTag	setSiteFilterType(String siteFilterType) Site filter type for this event tag.
EventTag	setSiteIds(List<Long> siteIds) Filter list of site IDs associated with this event tag.
EventTag	setSslCompliant(Boolean sslCompliant) Whether this tag is SSL-compliant or not.
EventTag	setStatus(String status) Status of this event tag.
EventTag	setSubaccountId(Long subaccountId) Subaccount ID of this event tag.
EventTag	setType(String type) Event tag type.
EventTag	setUrl(String url) Payload URL for this event tag.
EventTag	setUrlEscapeLevels(Integer urlEscapeLevels) Number of times the landing page URL should be URL-escaped before being appended to the click- through event tag 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, 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

EventTag

public EventTag()

Method Detail

getAccountId

public Long getAccountId()

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

Returns:

value or null for none

setAccountId

public EventTag setAccountId(Long accountId)

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

Parameters:

accountId - accountId or null for none

getAdvertiserId

public Long getAdvertiserId()

Advertiser ID of this event tag. This field or the campaignId field is required on insertion.

Returns:

value or null for none

setAdvertiserId

public EventTag setAdvertiserId(Long advertiserId)

Advertiser ID of this event tag. This field or the campaignId field is required on insertion.

Parameters:

advertiserId - advertiserId or null for none

getAdvertiserIdDimensionValue

public DimensionValue getAdvertiserIdDimensionValue()

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

Returns:

value or null for none

setAdvertiserIdDimensionValue

public EventTag setAdvertiserIdDimensionValue(DimensionValue advertiserIdDimensionValue)

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

Parameters:

advertiserIdDimensionValue - advertiserIdDimensionValue or null for none

getCampaignId

public Long getCampaignId()

Campaign ID of this event tag. This field or the advertiserId field is required on insertion.

Returns:

value or null for none

setCampaignId

public EventTag setCampaignId(Long campaignId)

Campaign ID of this event tag. This field or the advertiserId field is required on insertion.

Parameters:

campaignId - campaignId or null for none

getCampaignIdDimensionValue

public DimensionValue getCampaignIdDimensionValue()

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

Returns:

value or null for none

setCampaignIdDimensionValue

public EventTag setCampaignIdDimensionValue(DimensionValue campaignIdDimensionValue)

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

Parameters:

campaignIdDimensionValue - campaignIdDimensionValue or null for none

getEnabledByDefault

public Boolean getEnabledByDefault()

Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.

Returns:

value or null for none

setEnabledByDefault

public EventTag setEnabledByDefault(Boolean enabledByDefault)

Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.

Parameters:

enabledByDefault - enabledByDefault or null for none

getExcludeFromAdxRequests

public Boolean getExcludeFromAdxRequests()

Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.

Returns:

value or null for none

setExcludeFromAdxRequests

public EventTag setExcludeFromAdxRequests(Boolean excludeFromAdxRequests)

Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.

Parameters:

excludeFromAdxRequests - excludeFromAdxRequests or null for none

getId

public Long getId()

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

Returns:

value or null for none

setId

public EventTag setId(Long id)

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

Parameters:

id - id or null for none

getKind

public String getKind()

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

Returns:

value or null for none

setKind

public EventTag setKind(String kind)

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

Parameters:

kind - kind or null for none

getName

public String getName()

Name of this event tag. This is a required field and must be less than 256 characters long.

Returns:

value or null for none

setName

public EventTag setName(String name)

Name of this event tag. This is a required field and must be less than 256 characters long.

Parameters:

name - name or null for none

getSiteFilterType

public String getSiteFilterType()

Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.

Returns:

value or null for none

setSiteFilterType

public EventTag setSiteFilterType(String siteFilterType)

Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.

Parameters:

siteFilterType - siteFilterType or null for none

getSiteIds

public List<Long> getSiteIds()

Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a allowlist or blocklist filter.

Returns:

value or null for none

setSiteIds

public EventTag setSiteIds(List<Long> siteIds)

Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a allowlist or blocklist filter.

Parameters:

siteIds - siteIds or null for none

getSslCompliant

public Boolean getSslCompliant()

Whether this tag is SSL-compliant or not. This is a read-only field.

Returns:

value or null for none

setSslCompliant

public EventTag setSslCompliant(Boolean sslCompliant)

Whether this tag is SSL-compliant or not. This is a read-only field.

Parameters:

sslCompliant - sslCompliant or null for none

getStatus

public String getStatus()

Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.

Returns:

value or null for none

setStatus

public EventTag setStatus(String status)

Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.

Parameters:

status - status or null for none

getSubaccountId

public Long getSubaccountId()

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

Returns:

value or null for none

setSubaccountId

public EventTag setSubaccountId(Long subaccountId)

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

Parameters:

subaccountId - subaccountId or null for none

getType

public String getType()

Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.

Returns:

value or null for none

setType

public EventTag setType(String type)

Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.

Parameters:

type - type or null for none

getUrl

public String getUrl()

Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.

Returns:

value or null for none

setUrl

public EventTag setUrl(String url)

Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.

Parameters:

url - url or null for none

getUrlEscapeLevels

public Integer getUrlEscapeLevels()

Number of times the landing page URL should be URL-escaped before being appended to the click- through event tag URL. Only applies to click-through event tags as specified by the event tag type.

Returns:

value or null for none

setUrlEscapeLevels

public EventTag setUrlEscapeLevels(Integer urlEscapeLevels)

Number of times the landing page URL should be URL-escaped before being appended to the click- through event tag URL. Only applies to click-through event tags as specified by the event tag type.

Parameters:

urlEscapeLevels - urlEscapeLevels or null for none

set

public EventTag set(String fieldName,
                    Object value)

Overrides:

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

clone

public EventTag clone()

Overrides:

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