com.google.api.services.dfareporting

Class Dfareporting.EventTags.List

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.dfareporting.DfareportingRequest<EventTagsListResponse>

com.google.api.services.dfareporting.Dfareporting.EventTags.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Dfareporting.EventTags

public class Dfareporting.EventTags.List
extends DfareportingRequest<EventTagsListResponse>

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>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	List(Long profileId) Retrieves a list of event tags, possibly filtered.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
Long	getAdId() Select only event tags that belong to this ad.
Long	getAdvertiserId() Select only event tags that belong to this advertiser.
Long	getCampaignId() Select only event tags that belong to this campaign.
Boolean	getDefinitionsOnly() Examine only the specified campaign or advertiser's event tags for matching selector criteria.
Boolean	getEnabled() Select only enabled event tags.
List<String>	getEventTagTypes() Select only event tags with the specified event tag types.
List<Long>	getIds() Select only event tags with these IDs.
Long	getProfileId() User profile ID associated with this request.
String	getSearchString() Allows searching for objects by name or ID.
String	getSortField() Field by which to sort the list.
String	getSortOrder() Order of sorted results.
Dfareporting.EventTags.List	set(String parameterName, Object value)
Dfareporting.EventTags.List	set$Xgafv(String $Xgafv) V1 error format.
Dfareporting.EventTags.List	setAccessToken(String accessToken) OAuth access token.
Dfareporting.EventTags.List	setAdId(Long adId) Select only event tags that belong to this ad.
Dfareporting.EventTags.List	setAdvertiserId(Long advertiserId) Select only event tags that belong to this advertiser.
Dfareporting.EventTags.List	setAlt(String alt) Data format for response.
Dfareporting.EventTags.List	setCallback(String callback) JSONP
Dfareporting.EventTags.List	setCampaignId(Long campaignId) Select only event tags that belong to this campaign.
Dfareporting.EventTags.List	setDefinitionsOnly(Boolean definitionsOnly) Examine only the specified campaign or advertiser's event tags for matching selector criteria.
Dfareporting.EventTags.List	setEnabled(Boolean enabled) Select only enabled event tags.
Dfareporting.EventTags.List	setEventTagTypes(List<String> eventTagTypes) Select only event tags with the specified event tag types.
Dfareporting.EventTags.List	setFields(String fields) Selector specifying which fields to include in a partial response.
Dfareporting.EventTags.List	setIds(List<Long> ids) Select only event tags with these IDs.
Dfareporting.EventTags.List	setKey(String key) API key.
Dfareporting.EventTags.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Dfareporting.EventTags.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Dfareporting.EventTags.List	setProfileId(Long profileId) User profile ID associated with this request.
Dfareporting.EventTags.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Dfareporting.EventTags.List	setSearchString(String searchString) Allows searching for objects by name or ID.
Dfareporting.EventTags.List	setSortField(String sortField) Field by which to sort the list.
Dfareporting.EventTags.List	setSortOrder(String sortOrder) Order of sorted results.
Dfareporting.EventTags.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Dfareporting.EventTags.List	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.dfareporting.DfareportingRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

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

List

protected List(Long profileId)

Retrieves a list of event tags, possibly filtered. Create a request for the method "eventTags.list". This request holds the parameters needed by the the dfareporting server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Dfareporting.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

profileId - User profile ID associated with this request.

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<EventTagsListResponse>

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<EventTagsListResponse>

Throws:

IOException

set$Xgafv

public Dfareporting.EventTags.List set$Xgafv(String $Xgafv)

Description copied from class: DfareportingRequest

V1 error format.

Overrides:

set$Xgafv in class DfareportingRequest<EventTagsListResponse>

setAccessToken

public Dfareporting.EventTags.List setAccessToken(String accessToken)

Description copied from class: DfareportingRequest

OAuth access token.

Overrides:

setAccessToken in class DfareportingRequest<EventTagsListResponse>

setAlt

public Dfareporting.EventTags.List setAlt(String alt)

Description copied from class: DfareportingRequest

Data format for response.

Overrides:

setAlt in class DfareportingRequest<EventTagsListResponse>

setCallback

public Dfareporting.EventTags.List setCallback(String callback)

Description copied from class: DfareportingRequest

JSONP

Overrides:

setCallback in class DfareportingRequest<EventTagsListResponse>

setFields

public Dfareporting.EventTags.List setFields(String fields)

Description copied from class: DfareportingRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DfareportingRequest<EventTagsListResponse>

setKey

public Dfareporting.EventTags.List setKey(String key)

Description copied from class: DfareportingRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class DfareportingRequest<EventTagsListResponse>

setOauthToken

public Dfareporting.EventTags.List setOauthToken(String oauthToken)

Description copied from class: DfareportingRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DfareportingRequest<EventTagsListResponse>

setPrettyPrint

public Dfareporting.EventTags.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: DfareportingRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DfareportingRequest<EventTagsListResponse>

setQuotaUser

public Dfareporting.EventTags.List setQuotaUser(String quotaUser)

Description copied from class: DfareportingRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class DfareportingRequest<EventTagsListResponse>

setUploadType

public Dfareporting.EventTags.List setUploadType(String uploadType)

Description copied from class: DfareportingRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class DfareportingRequest<EventTagsListResponse>

setUploadProtocol

public Dfareporting.EventTags.List setUploadProtocol(String uploadProtocol)

Description copied from class: DfareportingRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class DfareportingRequest<EventTagsListResponse>

getProfileId

public Long getProfileId()

User profile ID associated with this request.

setProfileId

public Dfareporting.EventTags.List setProfileId(Long profileId)

User profile ID associated with this request.

getAdId

public Long getAdId()

Select only event tags that belong to this ad.

setAdId

public Dfareporting.EventTags.List setAdId(Long adId)

Select only event tags that belong to this ad.

getAdvertiserId

public Long getAdvertiserId()

Select only event tags that belong to this advertiser.

setAdvertiserId

public Dfareporting.EventTags.List setAdvertiserId(Long advertiserId)

Select only event tags that belong to this advertiser.

getCampaignId

public Long getCampaignId()

Select only event tags that belong to this campaign.

setCampaignId

public Dfareporting.EventTags.List setCampaignId(Long campaignId)

Select only event tags that belong to this campaign.

getDefinitionsOnly

public Boolean getDefinitionsOnly()

Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags.

setDefinitionsOnly

public Dfareporting.EventTags.List setDefinitionsOnly(Boolean definitionsOnly)

Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags.

getEnabled

public Boolean getEnabled()

Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well.

setEnabled

public Dfareporting.EventTags.List setEnabled(Boolean enabled)

Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well.

getEventTagTypes

public List<String> getEventTagTypes()

Select only event tags with the specified event tag types. Event tag types 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.

setEventTagTypes

public Dfareporting.EventTags.List setEventTagTypes(List<String> eventTagTypes)

Select only event tags with the specified event tag types. Event tag types 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.

getIds

public List<Long> getIds()

Select only event tags with these IDs.

setIds

public Dfareporting.EventTags.List setIds(List<Long> ids)

Select only event tags with these IDs.

getSearchString

public String getSearchString()

Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "eventtag*2015" will return objects with names like "eventtag June 2015", "eventtag April 2015", or simply "eventtag 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "eventtag" will match objects with name "my eventtag", "eventtag 2015", or simply "eventtag".

setSearchString

public Dfareporting.EventTags.List setSearchString(String searchString)

Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "eventtag*2015" will return objects with names like "eventtag June 2015", "eventtag April 2015", or simply "eventtag 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "eventtag" will match objects with name "my eventtag", "eventtag 2015", or simply "eventtag".

getSortField

public String getSortField()

Field by which to sort the list. [default: ID]

setSortField

public Dfareporting.EventTags.List setSortField(String sortField)

Field by which to sort the list.

getSortOrder

public String getSortOrder()

Order of sorted results. [default: ASCENDING]

setSortOrder

public Dfareporting.EventTags.List setSortOrder(String sortOrder)

Order of sorted results.

set

public Dfareporting.EventTags.List set(String parameterName,
                                       Object value)

Overrides:

set in class DfareportingRequest<EventTagsListResponse>