com.google.api.services.dfareporting

Class Dfareporting.Placements.Generatetags

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<PlacementsGenerateTagsResponse>

com.google.api.services.dfareporting.Dfareporting.Placements.Generatetags

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Dfareporting.Placements

public class Dfareporting.Placements.Generatetags
extends DfareportingRequest<PlacementsGenerateTagsResponse>

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

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Generatetags(Long profileId) Generates tags for a placement.

Method Summary

Modifier and Type	Method and Description
Long	getCampaignId() Generate placements belonging to this campaign.
List<Long>	getPlacementIds() Generate tags for these placements.
Long	getProfileId() User profile ID associated with this request.
List<String>	getTagFormats() Tag formats to generate for these placements.
Boolean	getTagPropertiesDcDbmMacroIncluded() Optional.
Boolean	getTagPropertiesGppMacrosIncluded() Optional.
Boolean	getTagPropertiesTcfGdprMacrosIncluded() Optional.
boolean	isTagPropertiesTcfGdprMacrosIncluded() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
Dfareporting.Placements.Generatetags	set(String parameterName, Object value)
Dfareporting.Placements.Generatetags	set$Xgafv(String $Xgafv) V1 error format.
Dfareporting.Placements.Generatetags	setAccessToken(String accessToken) OAuth access token.
Dfareporting.Placements.Generatetags	setAlt(String alt) Data format for response.
Dfareporting.Placements.Generatetags	setCallback(String callback) JSONP
Dfareporting.Placements.Generatetags	setCampaignId(Long campaignId) Generate placements belonging to this campaign.
Dfareporting.Placements.Generatetags	setFields(String fields) Selector specifying which fields to include in a partial response.
Dfareporting.Placements.Generatetags	setKey(String key) API key.
Dfareporting.Placements.Generatetags	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Dfareporting.Placements.Generatetags	setPlacementIds(List<Long> placementIds) Generate tags for these placements.
Dfareporting.Placements.Generatetags	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Dfareporting.Placements.Generatetags	setProfileId(Long profileId) User profile ID associated with this request.
Dfareporting.Placements.Generatetags	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Dfareporting.Placements.Generatetags	setTagFormats(List<String> tagFormats) Tag formats to generate for these placements.
Dfareporting.Placements.Generatetags	setTagPropertiesDcDbmMacroIncluded(Boolean tagPropertiesDcDbmMacroIncluded) Optional.
Dfareporting.Placements.Generatetags	setTagPropertiesGppMacrosIncluded(Boolean tagPropertiesGppMacrosIncluded) Optional.
Dfareporting.Placements.Generatetags	setTagPropertiesTcfGdprMacrosIncluded(Boolean tagPropertiesTcfGdprMacrosIncluded) Optional.
Dfareporting.Placements.Generatetags	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Dfareporting.Placements.Generatetags	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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, 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

Generatetags

protected Generatetags(Long profileId)

Generates tags for a placement. Create a request for the method "placements.generatetags". 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

set$Xgafv

public Dfareporting.Placements.Generatetags set$Xgafv(String $Xgafv)

Description copied from class: DfareportingRequest

V1 error format.

Overrides:

set$Xgafv in class DfareportingRequest<PlacementsGenerateTagsResponse>

setAccessToken

public Dfareporting.Placements.Generatetags setAccessToken(String accessToken)

Description copied from class: DfareportingRequest

OAuth access token.

Overrides:

setAccessToken in class DfareportingRequest<PlacementsGenerateTagsResponse>

setAlt

public Dfareporting.Placements.Generatetags setAlt(String alt)

Description copied from class: DfareportingRequest

Data format for response.

Overrides:

setAlt in class DfareportingRequest<PlacementsGenerateTagsResponse>

setCallback

public Dfareporting.Placements.Generatetags setCallback(String callback)

Description copied from class: DfareportingRequest

JSONP

Overrides:

setCallback in class DfareportingRequest<PlacementsGenerateTagsResponse>

setFields

public Dfareporting.Placements.Generatetags setFields(String fields)

Description copied from class: DfareportingRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DfareportingRequest<PlacementsGenerateTagsResponse>

setKey

public Dfareporting.Placements.Generatetags 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<PlacementsGenerateTagsResponse>

setOauthToken

public Dfareporting.Placements.Generatetags setOauthToken(String oauthToken)

Description copied from class: DfareportingRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DfareportingRequest<PlacementsGenerateTagsResponse>

setPrettyPrint

public Dfareporting.Placements.Generatetags setPrettyPrint(Boolean prettyPrint)

Description copied from class: DfareportingRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DfareportingRequest<PlacementsGenerateTagsResponse>

setQuotaUser

public Dfareporting.Placements.Generatetags 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<PlacementsGenerateTagsResponse>

setUploadType

public Dfareporting.Placements.Generatetags setUploadType(String uploadType)

Description copied from class: DfareportingRequest

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

Overrides:

setUploadType in class DfareportingRequest<PlacementsGenerateTagsResponse>

setUploadProtocol

public Dfareporting.Placements.Generatetags setUploadProtocol(String uploadProtocol)

Description copied from class: DfareportingRequest

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

Overrides:

setUploadProtocol in class DfareportingRequest<PlacementsGenerateTagsResponse>

getProfileId

public Long getProfileId()

User profile ID associated with this request.

setProfileId

public Dfareporting.Placements.Generatetags setProfileId(Long profileId)

User profile ID associated with this request.

getCampaignId

public Long getCampaignId()

Generate placements belonging to this campaign. This is a required field.

setCampaignId

public Dfareporting.Placements.Generatetags setCampaignId(Long campaignId)

Generate placements belonging to this campaign. This is a required field.

getPlacementIds

public List<Long> getPlacementIds()

Generate tags for these placements.

setPlacementIds

public Dfareporting.Placements.Generatetags setPlacementIds(List<Long> placementIds)

Generate tags for these placements.

getTagFormats

public List<String> getTagFormats()

Tag formats to generate for these placements. *Note:* PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements.

setTagFormats

public Dfareporting.Placements.Generatetags setTagFormats(List<String> tagFormats)

Tag formats to generate for these placements. *Note:* PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements.

getTagPropertiesDcDbmMacroIncluded

public Boolean getTagPropertiesDcDbmMacroIncluded()

Optional. Indicates whether to include the dc_dbm macro in the generated tags. [Learn more](https://support.google.com/campaignmanager/answer/9280273) about this macro.

setTagPropertiesDcDbmMacroIncluded

public Dfareporting.Placements.Generatetags setTagPropertiesDcDbmMacroIncluded(Boolean tagPropertiesDcDbmMacroIncluded)

Optional. Indicates whether to include the dc_dbm macro in the generated tags. [Learn more](https://support.google.com/campaignmanager/answer/9280273) about this macro.

getTagPropertiesGppMacrosIncluded

public Boolean getTagPropertiesGppMacrosIncluded()

Optional. Indicates whether to include the GPP macro in the generated tags. [Learn more](https://support.google.com/campaignmanager/answer/10031693) about this macro.

setTagPropertiesGppMacrosIncluded

public Dfareporting.Placements.Generatetags setTagPropertiesGppMacrosIncluded(Boolean tagPropertiesGppMacrosIncluded)

Optional. Indicates whether to include the GPP macro in the generated tags. [Learn more](https://support.google.com/campaignmanager/answer/10031693) about this macro.

getTagPropertiesTcfGdprMacrosIncluded

public Boolean getTagPropertiesTcfGdprMacrosIncluded()

Optional. Indicates whether to include the TCF macro in the generated tags. Default true. [Learn more](https://support.google.com/campaignmanager/answer/10031693) about this macro. [default: true]

setTagPropertiesTcfGdprMacrosIncluded

public Dfareporting.Placements.Generatetags setTagPropertiesTcfGdprMacrosIncluded(Boolean tagPropertiesTcfGdprMacrosIncluded)

Optional. Indicates whether to include the TCF macro in the generated tags. Default true. [Learn more](https://support.google.com/campaignmanager/answer/10031693) about this macro.

isTagPropertiesTcfGdprMacrosIncluded

public boolean isTagPropertiesTcfGdprMacrosIncluded()

Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

Boolean properties can have four possible values: null, Data.NULL_BOOLEAN, Boolean.TRUE or Boolean.FALSE.

This method returns Boolean.TRUE if the default of the property is Boolean.TRUE and it is null or Data.NULL_BOOLEAN. Boolean.FALSE is returned if the default of the property is Boolean.FALSE and it is null or Data.NULL_BOOLEAN.

Optional. Indicates whether to include the TCF macro in the generated tags. Default true. [Learn more](https://support.google.com/campaignmanager/answer/10031693) about this macro.

set

public Dfareporting.Placements.Generatetags set(String parameterName,
                                                Object value)

Overrides:

set in class DfareportingRequest<PlacementsGenerateTagsResponse>