com.google.api.services.adexchangebuyer2.v2beta1

Class AdExchangeBuyerII.Accounts.Clients.Users.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.adexchangebuyer2.v2beta1.AdExchangeBuyerIIRequest<ListClientUsersResponse>

com.google.api.services.adexchangebuyer2.v2beta1.AdExchangeBuyerII.Accounts.Clients.Users.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

AdExchangeBuyerII.Accounts.Clients.Users

public class AdExchangeBuyerII.Accounts.Clients.Users.List
extends AdExchangeBuyerIIRequest<ListClientUsersResponse>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

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 accountId, String clientAccountId) Lists all the known client users for a specified sponsor buyer account ID.

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
Long	getAccountId() Numerical account ID of the sponsor buyer of the client to list users for.
String	getClientAccountId() The account ID of the client buyer to list users for.
Integer	getPageSize() Requested page size.
String	getPageToken() A token identifying a page of results the server should return.
AdExchangeBuyerII.Accounts.Clients.Users.List	set(String parameterName, Object value)
AdExchangeBuyerII.Accounts.Clients.Users.List	set$Xgafv(String $Xgafv) V1 error format.
AdExchangeBuyerII.Accounts.Clients.Users.List	setAccessToken(String accessToken) OAuth access token.
AdExchangeBuyerII.Accounts.Clients.Users.List	setAccountId(Long accountId) Numerical account ID of the sponsor buyer of the client to list users for.
AdExchangeBuyerII.Accounts.Clients.Users.List	setAlt(String alt) Data format for response.
AdExchangeBuyerII.Accounts.Clients.Users.List	setCallback(String callback) JSONP
AdExchangeBuyerII.Accounts.Clients.Users.List	setClientAccountId(String clientAccountId) The account ID of the client buyer to list users for.
AdExchangeBuyerII.Accounts.Clients.Users.List	setFields(String fields) Selector specifying which fields to include in a partial response.
AdExchangeBuyerII.Accounts.Clients.Users.List	setKey(String key) API key.
AdExchangeBuyerII.Accounts.Clients.Users.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
AdExchangeBuyerII.Accounts.Clients.Users.List	setPageSize(Integer pageSize) Requested page size.
AdExchangeBuyerII.Accounts.Clients.Users.List	setPageToken(String pageToken) A token identifying a page of results the server should return.
AdExchangeBuyerII.Accounts.Clients.Users.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
AdExchangeBuyerII.Accounts.Clients.Users.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
AdExchangeBuyerII.Accounts.Clients.Users.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
AdExchangeBuyerII.Accounts.Clients.Users.List	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.adexchangebuyer2.v2beta1.AdExchangeBuyerIIRequest

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 accountId,
               String clientAccountId)

Lists all the known client users for a specified sponsor buyer account ID. Create a request for the method "users.list". This request holds the parameters needed by the the adexchangebuyer2 server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

AdExchangeBuyerII.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

accountId - Numerical account ID of the sponsor buyer of the client to list users for. (required)

clientAccountId - The account ID of the client buyer to list users for. (required) You must specify either a string representation of a numerical account identifier or the `-` character to list all the client users for all the clients of a given sponsor buyer.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<ListClientUsersResponse>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<ListClientUsersResponse>

Throws:

IOException

set$Xgafv

public AdExchangeBuyerII.Accounts.Clients.Users.List set$Xgafv(String $Xgafv)

Description copied from class: AdExchangeBuyerIIRequest

V1 error format.

Overrides:

set$Xgafv in class AdExchangeBuyerIIRequest<ListClientUsersResponse>

setAccessToken

public AdExchangeBuyerII.Accounts.Clients.Users.List setAccessToken(String accessToken)

Description copied from class: AdExchangeBuyerIIRequest

OAuth access token.

Overrides:

setAccessToken in class AdExchangeBuyerIIRequest<ListClientUsersResponse>

setAlt

public AdExchangeBuyerII.Accounts.Clients.Users.List setAlt(String alt)

Description copied from class: AdExchangeBuyerIIRequest

Data format for response.

Overrides:

setAlt in class AdExchangeBuyerIIRequest<ListClientUsersResponse>

setCallback

public AdExchangeBuyerII.Accounts.Clients.Users.List setCallback(String callback)

Description copied from class: AdExchangeBuyerIIRequest

JSONP

Overrides:

setCallback in class AdExchangeBuyerIIRequest<ListClientUsersResponse>

setFields

public AdExchangeBuyerII.Accounts.Clients.Users.List setFields(String fields)

Description copied from class: AdExchangeBuyerIIRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class AdExchangeBuyerIIRequest<ListClientUsersResponse>

setKey

public AdExchangeBuyerII.Accounts.Clients.Users.List setKey(String key)

Description copied from class: AdExchangeBuyerIIRequest

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 AdExchangeBuyerIIRequest<ListClientUsersResponse>

setOauthToken

public AdExchangeBuyerII.Accounts.Clients.Users.List setOauthToken(String oauthToken)

Description copied from class: AdExchangeBuyerIIRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class AdExchangeBuyerIIRequest<ListClientUsersResponse>

setPrettyPrint

public AdExchangeBuyerII.Accounts.Clients.Users.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: AdExchangeBuyerIIRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class AdExchangeBuyerIIRequest<ListClientUsersResponse>

setQuotaUser

public AdExchangeBuyerII.Accounts.Clients.Users.List setQuotaUser(String quotaUser)

Description copied from class: AdExchangeBuyerIIRequest

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 AdExchangeBuyerIIRequest<ListClientUsersResponse>

setUploadType

public AdExchangeBuyerII.Accounts.Clients.Users.List setUploadType(String uploadType)

Description copied from class: AdExchangeBuyerIIRequest

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

Overrides:

setUploadType in class AdExchangeBuyerIIRequest<ListClientUsersResponse>

setUploadProtocol

public AdExchangeBuyerII.Accounts.Clients.Users.List setUploadProtocol(String uploadProtocol)

Description copied from class: AdExchangeBuyerIIRequest

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

Overrides:

setUploadProtocol in class AdExchangeBuyerIIRequest<ListClientUsersResponse>

getAccountId

public Long getAccountId()

Numerical account ID of the sponsor buyer of the client to list users for. (required)

setAccountId

public AdExchangeBuyerII.Accounts.Clients.Users.List setAccountId(Long accountId)

Numerical account ID of the sponsor buyer of the client to list users for. (required)

getClientAccountId

public String getClientAccountId()

The account ID of the client buyer to list users for. (required) You must specify either a string representation of a numerical account identifier or the `-` character to list all the client users for all the clients of a given sponsor buyer.

setClientAccountId

public AdExchangeBuyerII.Accounts.Clients.Users.List setClientAccountId(String clientAccountId)

The account ID of the client buyer to list users for. (required) You must specify either a string representation of a numerical account identifier or the `-` character to list all the client users for all the clients of a given sponsor buyer.

getPageSize

public Integer getPageSize()

Requested page size. The server may return fewer clients than requested. If unspecified, the server will pick an appropriate default.

setPageSize

public AdExchangeBuyerII.Accounts.Clients.Users.List setPageSize(Integer pageSize)

Requested page size. The server may return fewer clients than requested. If unspecified, the server will pick an appropriate default.

getPageToken

public String getPageToken()

A token identifying a page of results the server should return. Typically, this is the value of ListClientUsersResponse.nextPageToken returned from the previous call to the accounts.clients.users.list method.

setPageToken

public AdExchangeBuyerII.Accounts.Clients.Users.List setPageToken(String pageToken)

A token identifying a page of results the server should return. Typically, this is the value of ListClientUsersResponse.nextPageToken returned from the previous call to the accounts.clients.users.list method.

set

public AdExchangeBuyerII.Accounts.Clients.Users.List set(String parameterName,
                                                         Object value)

Overrides:

set in class AdExchangeBuyerIIRequest<ListClientUsersResponse>