com.google.api.services.dfareporting

Class Dfareporting.AccountUserProfiles.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<AccountUserProfilesListResponse>

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Dfareporting.AccountUserProfiles

public class Dfareporting.AccountUserProfiles.List
extends DfareportingRequest<AccountUserProfilesListResponse>

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 account user profiles, 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	getActive() Select only active user profiles.
List<Long>	getIds() Select only user profiles 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 email.
String	getSortField() Field by which to sort the list.
String	getSortOrder() Order of sorted results.
Long	getSubaccountId() Select only user profiles with the specified subaccount ID.
Long	getUserRoleId() Select only user profiles with the specified user role ID.
Dfareporting.AccountUserProfiles.List	set(String parameterName, Object value)
Dfareporting.AccountUserProfiles.List	setActive(Boolean active) Select only active user profiles.
Dfareporting.AccountUserProfiles.List	setAlt(String alt) Data format for the response.
Dfareporting.AccountUserProfiles.List	setFields(String fields) Selector specifying which fields to include in a partial response.
Dfareporting.AccountUserProfiles.List	setIds(List<Long> ids) Select only user profiles with these IDs.
Dfareporting.AccountUserProfiles.List	setKey(String key) API key.
Dfareporting.AccountUserProfiles.List	setMaxResults(Integer maxResults) Maximum number of results to return.
Dfareporting.AccountUserProfiles.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Dfareporting.AccountUserProfiles.List	setPageToken(String pageToken) Value of the nextPageToken from the previous result page.
Dfareporting.AccountUserProfiles.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Dfareporting.AccountUserProfiles.List	setProfileId(Long profileId) User profile ID associated with this request.
Dfareporting.AccountUserProfiles.List	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
Dfareporting.AccountUserProfiles.List	setSearchString(String searchString) Allows searching for objects by name, ID or email.
Dfareporting.AccountUserProfiles.List	setSortField(String sortField) Field by which to sort the list.
Dfareporting.AccountUserProfiles.List	setSortOrder(String sortOrder) Order of sorted results.
Dfareporting.AccountUserProfiles.List	setSubaccountId(Long subaccountId) Select only user profiles with the specified subaccount ID.
Dfareporting.AccountUserProfiles.List	setUserIp(String userIp) Deprecated.
Dfareporting.AccountUserProfiles.List	setUserRoleId(Long userRoleId) Select only user profiles with the specified user role ID.

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

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 account user profiles, possibly filtered. This method supports paging. Create a request for the method "accountUserProfiles.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<AccountUserProfilesListResponse>

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

setAlt

public Dfareporting.AccountUserProfiles.List setAlt(String alt)

Description copied from class: DfareportingRequest

Data format for the response.

Overrides:

setAlt in class DfareportingRequest<AccountUserProfilesListResponse>

setFields

public Dfareporting.AccountUserProfiles.List setFields(String fields)

Description copied from class: DfareportingRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DfareportingRequest<AccountUserProfilesListResponse>

setKey

public Dfareporting.AccountUserProfiles.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<AccountUserProfilesListResponse>

setOauthToken

public Dfareporting.AccountUserProfiles.List setOauthToken(String oauthToken)

Description copied from class: DfareportingRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DfareportingRequest<AccountUserProfilesListResponse>

setPrettyPrint

public Dfareporting.AccountUserProfiles.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: DfareportingRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DfareportingRequest<AccountUserProfilesListResponse>

setQuotaUser

public Dfareporting.AccountUserProfiles.List setQuotaUser(String quotaUser)

Description copied from class: DfareportingRequest

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Overrides:

setQuotaUser in class DfareportingRequest<AccountUserProfilesListResponse>

setUserIp

public Dfareporting.AccountUserProfiles.List setUserIp(String userIp)

Description copied from class: DfareportingRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class DfareportingRequest<AccountUserProfilesListResponse>

getProfileId

public Long getProfileId()

User profile ID associated with this request.

setProfileId

public Dfareporting.AccountUserProfiles.List setProfileId(Long profileId)

User profile ID associated with this request.

getActive

public Boolean getActive()

Select only active user profiles.

setActive

public Dfareporting.AccountUserProfiles.List setActive(Boolean active)

Select only active user profiles.

getIds

public List<Long> getIds()

Select only user profiles with these IDs.

setIds

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

Select only user profiles with these IDs.

getMaxResults

public Integer getMaxResults()

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

setMaxResults

public Dfareporting.AccountUserProfiles.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.AccountUserProfiles.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 email. Wildcards (*) are allowed. For example, "user profile*2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 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 "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile".

setSearchString

public Dfareporting.AccountUserProfiles.List setSearchString(String searchString)

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

getSortField

public String getSortField()

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

setSortField

public Dfareporting.AccountUserProfiles.List setSortField(String sortField)

Field by which to sort the list.

getSortOrder

public String getSortOrder()

Order of sorted results. [default: ASCENDING]

setSortOrder

public Dfareporting.AccountUserProfiles.List setSortOrder(String sortOrder)

Order of sorted results.

getSubaccountId

public Long getSubaccountId()

Select only user profiles with the specified subaccount ID.

setSubaccountId

public Dfareporting.AccountUserProfiles.List setSubaccountId(Long subaccountId)

Select only user profiles with the specified subaccount ID.

getUserRoleId

public Long getUserRoleId()

Select only user profiles with the specified user role ID.

setUserRoleId

public Dfareporting.AccountUserProfiles.List setUserRoleId(Long userRoleId)

Select only user profiles with the specified user role ID.

set

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

Overrides:

set in class DfareportingRequest<AccountUserProfilesListResponse>