com.google.api.services.dfareporting

Class Dfareporting.Sites.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<SitesListResponse>

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Dfareporting.Sites

public class Dfareporting.Sites.List
extends DfareportingRequest<SitesListResponse>

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 sites, possibly filtered.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
Boolean	getAcceptsInStreamVideoPlacements() This search filter is no longer supported and will have no effect on the results returned.
Boolean	getAcceptsInterstitialPlacements() This search filter is no longer supported and will have no effect on the results returned.
Boolean	getAcceptsPublisherPaidPlacements() Select only sites that accept publisher paid placements.
Boolean	getAdWordsSite() Select only AdWords sites.
Boolean	getApproved() Select only approved sites.
List<Long>	getCampaignIds() Select only sites with these campaign IDs.
List<Long>	getDirectorySiteIds() Select only sites with these directory site IDs.
List<Long>	getIds() Select only sites with these IDs.
Integer	getMaxResults() Maximum number of results to return.
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, ID or keyName.
String	getSortField() Field by which to sort the list.
String	getSortOrder() Order of sorted results.
Long	getSubaccountId() Select only sites with this subaccount ID.
Boolean	getUnmappedSite() Select only sites that have not been mapped to a directory site.
Dfareporting.Sites.List	set(String parameterName, Object value)
Dfareporting.Sites.List	set$Xgafv(String $Xgafv) V1 error format.
Dfareporting.Sites.List	setAcceptsInStreamVideoPlacements(Boolean acceptsInStreamVideoPlacements) This search filter is no longer supported and will have no effect on the results returned.
Dfareporting.Sites.List	setAcceptsInterstitialPlacements(Boolean acceptsInterstitialPlacements) This search filter is no longer supported and will have no effect on the results returned.
Dfareporting.Sites.List	setAcceptsPublisherPaidPlacements(Boolean acceptsPublisherPaidPlacements) Select only sites that accept publisher paid placements.
Dfareporting.Sites.List	setAccessToken(String accessToken) OAuth access token.
Dfareporting.Sites.List	setAdWordsSite(Boolean adWordsSite) Select only AdWords sites.
Dfareporting.Sites.List	setAlt(String alt) Data format for response.
Dfareporting.Sites.List	setApproved(Boolean approved) Select only approved sites.
Dfareporting.Sites.List	setCallback(String callback) JSONP
Dfareporting.Sites.List	setCampaignIds(List<Long> campaignIds) Select only sites with these campaign IDs.
Dfareporting.Sites.List	setDirectorySiteIds(List<Long> directorySiteIds) Select only sites with these directory site IDs.
Dfareporting.Sites.List	setFields(String fields) Selector specifying which fields to include in a partial response.
Dfareporting.Sites.List	setIds(List<Long> ids) Select only sites with these IDs.
Dfareporting.Sites.List	setKey(String key) API key.
Dfareporting.Sites.List	setMaxResults(Integer maxResults) Maximum number of results to return.
Dfareporting.Sites.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Dfareporting.Sites.List	setPageToken(String pageToken) Value of the nextPageToken from the previous result page.
Dfareporting.Sites.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Dfareporting.Sites.List	setProfileId(Long profileId) User profile ID associated with this request.
Dfareporting.Sites.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Dfareporting.Sites.List	setSearchString(String searchString) Allows searching for objects by name, ID or keyName.
Dfareporting.Sites.List	setSortField(String sortField) Field by which to sort the list.
Dfareporting.Sites.List	setSortOrder(String sortOrder) Order of sorted results.
Dfareporting.Sites.List	setSubaccountId(Long subaccountId) Select only sites with this subaccount ID.
Dfareporting.Sites.List	setUnmappedSite(Boolean unmappedSite) Select only sites that have not been mapped to a directory site.
Dfareporting.Sites.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Dfareporting.Sites.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 sites, possibly filtered. This method supports paging. Create a request for the method "sites.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<SitesListResponse>

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

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

Description copied from class: DfareportingRequest

V1 error format.

Overrides:

set$Xgafv in class DfareportingRequest<SitesListResponse>

setAccessToken

public Dfareporting.Sites.List setAccessToken(String accessToken)

Description copied from class: DfareportingRequest

OAuth access token.

Overrides:

setAccessToken in class DfareportingRequest<SitesListResponse>

setAlt

public Dfareporting.Sites.List setAlt(String alt)

Description copied from class: DfareportingRequest

Data format for response.

Overrides:

setAlt in class DfareportingRequest<SitesListResponse>

setCallback

public Dfareporting.Sites.List setCallback(String callback)

Description copied from class: DfareportingRequest

JSONP

Overrides:

setCallback in class DfareportingRequest<SitesListResponse>

setFields

public Dfareporting.Sites.List setFields(String fields)

Description copied from class: DfareportingRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DfareportingRequest<SitesListResponse>

setKey

public Dfareporting.Sites.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<SitesListResponse>

setOauthToken

public Dfareporting.Sites.List setOauthToken(String oauthToken)

Description copied from class: DfareportingRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DfareportingRequest<SitesListResponse>

setPrettyPrint

public Dfareporting.Sites.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: DfareportingRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DfareportingRequest<SitesListResponse>

setQuotaUser

public Dfareporting.Sites.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<SitesListResponse>

setUploadType

public Dfareporting.Sites.List setUploadType(String uploadType)

Description copied from class: DfareportingRequest

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

Overrides:

setUploadType in class DfareportingRequest<SitesListResponse>

setUploadProtocol

public Dfareporting.Sites.List setUploadProtocol(String uploadProtocol)

Description copied from class: DfareportingRequest

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

Overrides:

setUploadProtocol in class DfareportingRequest<SitesListResponse>

getProfileId

public Long getProfileId()

User profile ID associated with this request.

setProfileId

public Dfareporting.Sites.List setProfileId(Long profileId)

User profile ID associated with this request.

getAcceptsInStreamVideoPlacements

public Boolean getAcceptsInStreamVideoPlacements()

This search filter is no longer supported and will have no effect on the results returned.

setAcceptsInStreamVideoPlacements

public Dfareporting.Sites.List setAcceptsInStreamVideoPlacements(Boolean acceptsInStreamVideoPlacements)

This search filter is no longer supported and will have no effect on the results returned.

getAcceptsInterstitialPlacements

public Boolean getAcceptsInterstitialPlacements()

This search filter is no longer supported and will have no effect on the results returned.

setAcceptsInterstitialPlacements

public Dfareporting.Sites.List setAcceptsInterstitialPlacements(Boolean acceptsInterstitialPlacements)

This search filter is no longer supported and will have no effect on the results returned.

getAcceptsPublisherPaidPlacements

public Boolean getAcceptsPublisherPaidPlacements()

Select only sites that accept publisher paid placements.

setAcceptsPublisherPaidPlacements

public Dfareporting.Sites.List setAcceptsPublisherPaidPlacements(Boolean acceptsPublisherPaidPlacements)

Select only sites that accept publisher paid placements.

getAdWordsSite

public Boolean getAdWordsSite()

Select only AdWords sites.

setAdWordsSite

public Dfareporting.Sites.List setAdWordsSite(Boolean adWordsSite)

Select only AdWords sites.

getApproved

public Boolean getApproved()

Select only approved sites.

setApproved

public Dfareporting.Sites.List setApproved(Boolean approved)

Select only approved sites.

getCampaignIds

public List<Long> getCampaignIds()

Select only sites with these campaign IDs.

setCampaignIds

public Dfareporting.Sites.List setCampaignIds(List<Long> campaignIds)

Select only sites with these campaign IDs.

getDirectorySiteIds

public List<Long> getDirectorySiteIds()

Select only sites with these directory site IDs.

setDirectorySiteIds

public Dfareporting.Sites.List setDirectorySiteIds(List<Long> directorySiteIds)

Select only sites with these directory site IDs.

getIds

public List<Long> getIds()

Select only sites with these IDs.

setIds

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

Select only sites with these IDs.

getMaxResults

public Integer getMaxResults()

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

setMaxResults

public Dfareporting.Sites.List setMaxResults(Integer maxResults)

Maximum number of results to return.

getPageToken

public String getPageToken()

Value of the nextPageToken from the previous result page.

setPageToken

public Dfareporting.Sites.List setPageToken(String pageToken)

Value of the nextPageToken from the previous result page.

getSearchString

public String getSearchString()

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

setSearchString

public Dfareporting.Sites.List setSearchString(String searchString)

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

getSortField

public String getSortField()

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

setSortField

public Dfareporting.Sites.List setSortField(String sortField)

Field by which to sort the list.

getSortOrder

public String getSortOrder()

Order of sorted results. [default: ASCENDING]

setSortOrder

public Dfareporting.Sites.List setSortOrder(String sortOrder)

Order of sorted results.

getSubaccountId

public Long getSubaccountId()

Select only sites with this subaccount ID.

setSubaccountId

public Dfareporting.Sites.List setSubaccountId(Long subaccountId)

Select only sites with this subaccount ID.

getUnmappedSite

public Boolean getUnmappedSite()

Select only sites that have not been mapped to a directory site.

setUnmappedSite

public Dfareporting.Sites.List setUnmappedSite(Boolean unmappedSite)

Select only sites that have not been mapped to a directory site.

set

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

Overrides:

set in class DfareportingRequest<SitesListResponse>