com.google.api.services.dfareporting

Class Dfareporting.Creatives.List

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.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<CreativesListResponse>

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

All Implemented Interfaces:

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

Enclosing class:

Dfareporting.Creatives

public class Dfareporting.Creatives.List
extends DfareportingRequest<CreativesListResponse>

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>

Field Summary

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

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Dfareporting.Creatives.List(java.lang.Long profileId) Retrieves a list of creatives, possibly filtered.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
java.lang.Boolean	getActive() Select only active creatives.
java.lang.Long	getAdvertiserId() Select only creatives with this advertiser ID.
java.lang.Boolean	getArchived() Select only archived creatives.
java.lang.Long	getCampaignId() Select only creatives with this campaign ID.
java.util.List<java.lang.Long>	getCompanionCreativeIds() Select only in-stream video creatives with these companion IDs.
java.util.List<java.lang.Long>	getCreativeFieldIds() Select only creatives with these creative field IDs.
java.util.List<java.lang.Long>	getIds() Select only creatives with these IDs.
java.lang.Integer	getMaxResults() Maximum number of results to return.
java.lang.String	getPageToken() Value of the nextPageToken from the previous result page.
java.lang.Long	getProfileId() User profile ID associated with this request.
java.util.List<java.lang.Long>	getRenderingIds() Select only creatives with these rendering IDs.
java.lang.String	getSearchString() Allows searching for objects by name or ID.
java.util.List<java.lang.Long>	getSizeIds() Select only creatives with these size IDs.
java.lang.String	getSortField() Field by which to sort the list.
java.lang.String	getSortOrder() Order of sorted results.
java.lang.Long	getStudioCreativeId() Select only creatives corresponding to this Studio creative ID.
java.util.List<java.lang.String>	getTypes() Select only creatives with these creative types.
Dfareporting.Creatives.List	set(java.lang.String parameterName, java.lang.Object value)
Dfareporting.Creatives.List	setActive(java.lang.Boolean active) Select only active creatives.
Dfareporting.Creatives.List	setAdvertiserId(java.lang.Long advertiserId) Select only creatives with this advertiser ID.
Dfareporting.Creatives.List	setAlt(java.lang.String alt) Data format for the response.
Dfareporting.Creatives.List	setArchived(java.lang.Boolean archived) Select only archived creatives.
Dfareporting.Creatives.List	setCampaignId(java.lang.Long campaignId) Select only creatives with this campaign ID.
Dfareporting.Creatives.List	setCompanionCreativeIds(java.util.List<java.lang.Long> companionCreativeIds) Select only in-stream video creatives with these companion IDs.
Dfareporting.Creatives.List	setCreativeFieldIds(java.util.List<java.lang.Long> creativeFieldIds) Select only creatives with these creative field IDs.
Dfareporting.Creatives.List	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
Dfareporting.Creatives.List	setIds(java.util.List<java.lang.Long> ids) Select only creatives with these IDs.
Dfareporting.Creatives.List	setKey(java.lang.String key) API key.
Dfareporting.Creatives.List	setMaxResults(java.lang.Integer maxResults) Maximum number of results to return.
Dfareporting.Creatives.List	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
Dfareporting.Creatives.List	setPageToken(java.lang.String pageToken) Value of the nextPageToken from the previous result page.
Dfareporting.Creatives.List	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
Dfareporting.Creatives.List	setProfileId(java.lang.Long profileId) User profile ID associated with this request.
Dfareporting.Creatives.List	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
Dfareporting.Creatives.List	setRenderingIds(java.util.List<java.lang.Long> renderingIds) Select only creatives with these rendering IDs.
Dfareporting.Creatives.List	setSearchString(java.lang.String searchString) Allows searching for objects by name or ID.
Dfareporting.Creatives.List	setSizeIds(java.util.List<java.lang.Long> sizeIds) Select only creatives with these size IDs.
Dfareporting.Creatives.List	setSortField(java.lang.String sortField) Field by which to sort the list.
Dfareporting.Creatives.List	setSortOrder(java.lang.String sortOrder) Order of sorted results.
Dfareporting.Creatives.List	setStudioCreativeId(java.lang.Long studioCreativeId) Select only creatives corresponding to this Studio creative ID.
Dfareporting.Creatives.List	setTypes(java.util.List<java.lang.String> types) Select only creatives with these creative types.
Dfareporting.Creatives.List	setUserIp(java.lang.String userIp) IP address of the site where the request originates.

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

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, 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, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

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

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Dfareporting.Creatives.List

protected Dfareporting.Creatives.List(java.lang.Long profileId)

Retrieves a list of creatives, possibly filtered. This method supports paging. Create a request for the method "creatives.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 java.io.IOException

Overrides:

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

Throws:

java.io.IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

java.io.IOException

setAlt

public Dfareporting.Creatives.List setAlt(java.lang.String alt)

Description copied from class: DfareportingRequest

Data format for the response.

Overrides:

setAlt in class DfareportingRequest<CreativesListResponse>

setFields

public Dfareporting.Creatives.List setFields(java.lang.String fields)

Description copied from class: DfareportingRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DfareportingRequest<CreativesListResponse>

setKey

public Dfareporting.Creatives.List setKey(java.lang.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<CreativesListResponse>

setOauthToken

public Dfareporting.Creatives.List setOauthToken(java.lang.String oauthToken)

Description copied from class: DfareportingRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DfareportingRequest<CreativesListResponse>

setPrettyPrint

public Dfareporting.Creatives.List setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: DfareportingRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DfareportingRequest<CreativesListResponse>

setQuotaUser

public Dfareporting.Creatives.List setQuotaUser(java.lang.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 userIp if both are provided.

Overrides:

setQuotaUser in class DfareportingRequest<CreativesListResponse>

setUserIp

public Dfareporting.Creatives.List setUserIp(java.lang.String userIp)

Description copied from class: DfareportingRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:

setUserIp in class DfareportingRequest<CreativesListResponse>

getProfileId

public java.lang.Long getProfileId()

User profile ID associated with this request.

setProfileId

public Dfareporting.Creatives.List setProfileId(java.lang.Long profileId)

User profile ID associated with this request.

getActive

public java.lang.Boolean getActive()

Select only active creatives. Leave blank to select active and inactive creatives.

setActive

public Dfareporting.Creatives.List setActive(java.lang.Boolean active)

Select only active creatives. Leave blank to select active and inactive creatives.

getAdvertiserId

public java.lang.Long getAdvertiserId()

Select only creatives with this advertiser ID.

setAdvertiserId

public Dfareporting.Creatives.List setAdvertiserId(java.lang.Long advertiserId)

Select only creatives with this advertiser ID.

getArchived

public java.lang.Boolean getArchived()

Select only archived creatives. Leave blank to select archived and unarchived creatives.

setArchived

public Dfareporting.Creatives.List setArchived(java.lang.Boolean archived)

Select only archived creatives. Leave blank to select archived and unarchived creatives.

getCampaignId

public java.lang.Long getCampaignId()

Select only creatives with this campaign ID.

setCampaignId

public Dfareporting.Creatives.List setCampaignId(java.lang.Long campaignId)

Select only creatives with this campaign ID.

getCompanionCreativeIds

public java.util.List<java.lang.Long> getCompanionCreativeIds()

Select only in-stream video creatives with these companion IDs.

setCompanionCreativeIds

public Dfareporting.Creatives.List setCompanionCreativeIds(java.util.List<java.lang.Long> companionCreativeIds)

Select only in-stream video creatives with these companion IDs.

getCreativeFieldIds

public java.util.List<java.lang.Long> getCreativeFieldIds()

Select only creatives with these creative field IDs.

setCreativeFieldIds

public Dfareporting.Creatives.List setCreativeFieldIds(java.util.List<java.lang.Long> creativeFieldIds)

Select only creatives with these creative field IDs.

getIds

public java.util.List<java.lang.Long> getIds()

Select only creatives with these IDs.

setIds

public Dfareporting.Creatives.List setIds(java.util.List<java.lang.Long> ids)

Select only creatives with these IDs.

getMaxResults

public java.lang.Integer getMaxResults()

Maximum number of results to return. [default: 1000] [minimum: 0] [maximum: 1000]

setMaxResults

public Dfareporting.Creatives.List setMaxResults(java.lang.Integer maxResults)

Maximum number of results to return.

getPageToken

public java.lang.String getPageToken()

Value of the nextPageToken from the previous result page.

setPageToken

public Dfareporting.Creatives.List setPageToken(java.lang.String pageToken)

Value of the nextPageToken from the previous result page.

getRenderingIds

public java.util.List<java.lang.Long> getRenderingIds()

Select only creatives with these rendering IDs.

setRenderingIds

public Dfareporting.Creatives.List setRenderingIds(java.util.List<java.lang.Long> renderingIds)

Select only creatives with these rendering IDs.

getSearchString

public java.lang.String getSearchString()

Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "creative*2015" will return objects with names like "creative June 2015", "creative April 2015", or simply "creative 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 "creative" will match objects with name "my creative", "creative 2015", or simply "creative".

setSearchString

public Dfareporting.Creatives.List setSearchString(java.lang.String searchString)

Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "creative*2015" will return objects with names like "creative June 2015", "creative April 2015", or simply "creative 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 "creative" will match objects with name "my creative", "creative 2015", or simply "creative".

getSizeIds

public java.util.List<java.lang.Long> getSizeIds()

Select only creatives with these size IDs.

setSizeIds

public Dfareporting.Creatives.List setSizeIds(java.util.List<java.lang.Long> sizeIds)

Select only creatives with these size IDs.

getSortField

public java.lang.String getSortField()

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

setSortField

public Dfareporting.Creatives.List setSortField(java.lang.String sortField)

Field by which to sort the list.

getSortOrder

public java.lang.String getSortOrder()

Order of sorted results. [default: ASCENDING]

setSortOrder

public Dfareporting.Creatives.List setSortOrder(java.lang.String sortOrder)

Order of sorted results.

getStudioCreativeId

public java.lang.Long getStudioCreativeId()

Select only creatives corresponding to this Studio creative ID.

setStudioCreativeId

public Dfareporting.Creatives.List setStudioCreativeId(java.lang.Long studioCreativeId)

Select only creatives corresponding to this Studio creative ID.

getTypes

public java.util.List<java.lang.String> getTypes()

Select only creatives with these creative types.

setTypes

public Dfareporting.Creatives.List setTypes(java.util.List<java.lang.String> types)

Select only creatives with these creative types.

set

public Dfareporting.Creatives.List set(java.lang.String parameterName,
                              java.lang.Object value)

Overrides:

set in class DfareportingRequest<CreativesListResponse>