com.google.api.services.dfareporting

Class Dfareporting.Advertisers.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<AdvertisersListResponse>

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Dfareporting.Advertisers

public class Dfareporting.Advertisers.List
extends DfareportingRequest<AdvertisersListResponse>

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	List(Long profileId) Retrieves a list of advertisers, possibly filtered.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
List<Long>	getAdvertiserGroupIds() Select only advertisers with these advertiser group IDs.
List<Long>	getFloodlightConfigurationIds() Select only advertisers with these floodlight configuration IDs.
List<Long>	getIds() Select only advertisers with these IDs.
Boolean	getIncludeAdvertisersWithoutGroupsOnly() Select only advertisers which do not belong to any advertiser group.
Integer	getMaxResults() Maximum number of results to return.
Boolean	getOnlyParent() Select only advertisers which use another advertiser's floodlight configuration.
String	getPageToken() Value of the nextPageToken from the previous result page.
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.
String	getStatus() Select only advertisers with the specified status.
Long	getSubaccountId() Select only advertisers with these subaccount IDs.
Dfareporting.Advertisers.List	set(String parameterName, Object value)
Dfareporting.Advertisers.List	set$Xgafv(String $Xgafv) V1 error format.
Dfareporting.Advertisers.List	setAccessToken(String accessToken) OAuth access token.
Dfareporting.Advertisers.List	setAdvertiserGroupIds(List<Long> advertiserGroupIds) Select only advertisers with these advertiser group IDs.
Dfareporting.Advertisers.List	setAlt(String alt) Data format for response.
Dfareporting.Advertisers.List	setCallback(String callback) JSONP
Dfareporting.Advertisers.List	setFields(String fields) Selector specifying which fields to include in a partial response.
Dfareporting.Advertisers.List	setFloodlightConfigurationIds(List<Long> floodlightConfigurationIds) Select only advertisers with these floodlight configuration IDs.
Dfareporting.Advertisers.List	setIds(List<Long> ids) Select only advertisers with these IDs.
Dfareporting.Advertisers.List	setIncludeAdvertisersWithoutGroupsOnly(Boolean includeAdvertisersWithoutGroupsOnly) Select only advertisers which do not belong to any advertiser group.
Dfareporting.Advertisers.List	setKey(String key) API key.
Dfareporting.Advertisers.List	setMaxResults(Integer maxResults) Maximum number of results to return.
Dfareporting.Advertisers.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Dfareporting.Advertisers.List	setOnlyParent(Boolean onlyParent) Select only advertisers which use another advertiser's floodlight configuration.
Dfareporting.Advertisers.List	setPageToken(String pageToken) Value of the nextPageToken from the previous result page.
Dfareporting.Advertisers.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Dfareporting.Advertisers.List	setProfileId(Long profileId) User profile ID associated with this request.
Dfareporting.Advertisers.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Dfareporting.Advertisers.List	setSearchString(String searchString) Allows searching for objects by name or ID.
Dfareporting.Advertisers.List	setSortField(String sortField) Field by which to sort the list.
Dfareporting.Advertisers.List	setSortOrder(String sortOrder) Order of sorted results.
Dfareporting.Advertisers.List	setStatus(String status) Select only advertisers with the specified status.
Dfareporting.Advertisers.List	setSubaccountId(Long subaccountId) Select only advertisers with these subaccount IDs.
Dfareporting.Advertisers.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Dfareporting.Advertisers.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 advertisers, possibly filtered. This method supports paging. Create a request for the method "advertisers.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<AdvertisersListResponse>

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

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

Description copied from class: DfareportingRequest

V1 error format.

Overrides:

set$Xgafv in class DfareportingRequest<AdvertisersListResponse>

setAccessToken

public Dfareporting.Advertisers.List setAccessToken(String accessToken)

Description copied from class: DfareportingRequest

OAuth access token.

Overrides:

setAccessToken in class DfareportingRequest<AdvertisersListResponse>

setAlt

public Dfareporting.Advertisers.List setAlt(String alt)

Description copied from class: DfareportingRequest

Data format for response.

Overrides:

setAlt in class DfareportingRequest<AdvertisersListResponse>

setCallback

public Dfareporting.Advertisers.List setCallback(String callback)

Description copied from class: DfareportingRequest

JSONP

Overrides:

setCallback in class DfareportingRequest<AdvertisersListResponse>

setFields

public Dfareporting.Advertisers.List setFields(String fields)

Description copied from class: DfareportingRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DfareportingRequest<AdvertisersListResponse>

setKey

public Dfareporting.Advertisers.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<AdvertisersListResponse>

setOauthToken

public Dfareporting.Advertisers.List setOauthToken(String oauthToken)

Description copied from class: DfareportingRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DfareportingRequest<AdvertisersListResponse>

setPrettyPrint

public Dfareporting.Advertisers.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: DfareportingRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DfareportingRequest<AdvertisersListResponse>

setQuotaUser

public Dfareporting.Advertisers.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<AdvertisersListResponse>

setUploadType

public Dfareporting.Advertisers.List setUploadType(String uploadType)

Description copied from class: DfareportingRequest

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

Overrides:

setUploadType in class DfareportingRequest<AdvertisersListResponse>

setUploadProtocol

public Dfareporting.Advertisers.List setUploadProtocol(String uploadProtocol)

Description copied from class: DfareportingRequest

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

Overrides:

setUploadProtocol in class DfareportingRequest<AdvertisersListResponse>

getProfileId

public Long getProfileId()

User profile ID associated with this request.

setProfileId

public Dfareporting.Advertisers.List setProfileId(Long profileId)

User profile ID associated with this request.

getAdvertiserGroupIds

public List<Long> getAdvertiserGroupIds()

Select only advertisers with these advertiser group IDs.

setAdvertiserGroupIds

public Dfareporting.Advertisers.List setAdvertiserGroupIds(List<Long> advertiserGroupIds)

Select only advertisers with these advertiser group IDs.

getFloodlightConfigurationIds

public List<Long> getFloodlightConfigurationIds()

Select only advertisers with these floodlight configuration IDs.

setFloodlightConfigurationIds

public Dfareporting.Advertisers.List setFloodlightConfigurationIds(List<Long> floodlightConfigurationIds)

Select only advertisers with these floodlight configuration IDs.

getIds

public List<Long> getIds()

Select only advertisers with these IDs.

setIds

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

Select only advertisers with these IDs.

getIncludeAdvertisersWithoutGroupsOnly

public Boolean getIncludeAdvertisersWithoutGroupsOnly()

Select only advertisers which do not belong to any advertiser group.

setIncludeAdvertisersWithoutGroupsOnly

public Dfareporting.Advertisers.List setIncludeAdvertisersWithoutGroupsOnly(Boolean includeAdvertisersWithoutGroupsOnly)

Select only advertisers which do not belong to any advertiser group.

getMaxResults

public Integer getMaxResults()

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

setMaxResults

public Dfareporting.Advertisers.List setMaxResults(Integer maxResults)

Maximum number of results to return.

getOnlyParent

public Boolean getOnlyParent()

Select only advertisers which use another advertiser's floodlight configuration.

setOnlyParent

public Dfareporting.Advertisers.List setOnlyParent(Boolean onlyParent)

Select only advertisers which use another advertiser's floodlight configuration.

getPageToken

public String getPageToken()

Value of the nextPageToken from the previous result page.

setPageToken

public Dfareporting.Advertisers.List setPageToken(String pageToken)

Value of the nextPageToken from the previous result page.

getSearchString

public String getSearchString()

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

setSearchString

public Dfareporting.Advertisers.List setSearchString(String searchString)

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

getSortField

public String getSortField()

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

setSortField

public Dfareporting.Advertisers.List setSortField(String sortField)

Field by which to sort the list.

getSortOrder

public String getSortOrder()

Order of sorted results. [default: ASCENDING]

setSortOrder

public Dfareporting.Advertisers.List setSortOrder(String sortOrder)

Order of sorted results.

getStatus

public String getStatus()

Select only advertisers with the specified status.

setStatus

public Dfareporting.Advertisers.List setStatus(String status)

Select only advertisers with the specified status.

getSubaccountId

public Long getSubaccountId()

Select only advertisers with these subaccount IDs.

setSubaccountId

public Dfareporting.Advertisers.List setSubaccountId(Long subaccountId)

Select only advertisers with these subaccount IDs.

set

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

Overrides:

set in class DfareportingRequest<AdvertisersListResponse>