AdExchangeBuyerII.Accounts.Clients.List (Ad Exchange Buyer API II v2beta1-rev20210613-1.32.1)

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<ListClientsResponse>
        
        com.google.api.services.adexchangebuyer2.v2beta1.AdExchangeBuyerII.Accounts.Clients.List

All Implemented Interfaces:: Cloneable, Map<String,Object>

Enclosing class:: AdExchangeBuyerII.Accounts.Clients

public class AdExchangeBuyerII.Accounts.Clients.List
extends AdExchangeBuyerIIRequest<ListClientsResponse>

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)
Lists all the clients for the current sponsor buyer.

Constructors
Modifier	Constructor and Description
`protected`	`List(Long accountId)` Lists all the clients for the current sponsor buyer.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpRequest`	`buildHttpRequestUsingHead()`
`HttpResponse`	`executeUsingHead()`
`Long`	`getAccountId()` Unique numerical account ID of the sponsor buyer to list the clients for.
`Integer`	`getPageSize()` Requested page size.
`String`	`getPageToken()` A token identifying a page of results the server should return.
`String`	`getPartnerClientId()` Optional unique identifier (from the standpoint of an Ad Exchange sponsor buyer partner) of the client to return.
`AdExchangeBuyerII.Accounts.Clients.List`	`set(String parameterName, Object value)`
`AdExchangeBuyerII.Accounts.Clients.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`AdExchangeBuyerII.Accounts.Clients.List`	`setAccessToken(String accessToken)` OAuth access token.
`AdExchangeBuyerII.Accounts.Clients.List`	`setAccountId(Long accountId)` Unique numerical account ID of the sponsor buyer to list the clients for.
`AdExchangeBuyerII.Accounts.Clients.List`	`setAlt(String alt)` Data format for response.
`AdExchangeBuyerII.Accounts.Clients.List`	`setCallback(String callback)` JSONP
`AdExchangeBuyerII.Accounts.Clients.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`AdExchangeBuyerII.Accounts.Clients.List`	`setKey(String key)` API key.
`AdExchangeBuyerII.Accounts.Clients.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`AdExchangeBuyerII.Accounts.Clients.List`	`setPageSize(Integer pageSize)` Requested page size.
`AdExchangeBuyerII.Accounts.Clients.List`	`setPageToken(String pageToken)` A token identifying a page of results the server should return.
`AdExchangeBuyerII.Accounts.Clients.List`	`setPartnerClientId(String partnerClientId)` Optional unique identifier (from the standpoint of an Ad Exchange sponsor buyer partner) of the client to return.
`AdExchangeBuyerII.Accounts.Clients.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`AdExchangeBuyerII.Accounts.Clients.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`AdExchangeBuyerII.Accounts.Clients.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`AdExchangeBuyerII.Accounts.Clients.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.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)
```
    Lists all the clients for the current sponsor buyer. Create a request for the method "clients.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 - Unique numerical account ID of the sponsor buyer to list the clients for.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public HttpResponse executeUsingHead()
                              throws IOException
```
    Overrides:
    
    executeUsingHead in class AbstractGoogleClientRequest<ListClientsResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class AbstractGoogleClientRequest<ListClientsResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public AdExchangeBuyerII.Accounts.Clients.List set$Xgafv(String $Xgafv)
```
    Description copied from class: AdExchangeBuyerIIRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class AdExchangeBuyerIIRequest<ListClientsResponse>
  - setAccessToken
```
public AdExchangeBuyerII.Accounts.Clients.List setAccessToken(String accessToken)
```
    Description copied from class: AdExchangeBuyerIIRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class AdExchangeBuyerIIRequest<ListClientsResponse>
  - setAlt
```
public AdExchangeBuyerII.Accounts.Clients.List setAlt(String alt)
```
    Description copied from class: AdExchangeBuyerIIRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class AdExchangeBuyerIIRequest<ListClientsResponse>
  - setCallback
```
public AdExchangeBuyerII.Accounts.Clients.List setCallback(String callback)
```
    Description copied from class: AdExchangeBuyerIIRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class AdExchangeBuyerIIRequest<ListClientsResponse>
  - setFields
```
public AdExchangeBuyerII.Accounts.Clients.List setFields(String fields)
```
    Description copied from class: AdExchangeBuyerIIRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class AdExchangeBuyerIIRequest<ListClientsResponse>
  - setKey
```
public AdExchangeBuyerII.Accounts.Clients.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<ListClientsResponse>
  - setOauthToken
```
public AdExchangeBuyerII.Accounts.Clients.List setOauthToken(String oauthToken)
```
    Description copied from class: AdExchangeBuyerIIRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class AdExchangeBuyerIIRequest<ListClientsResponse>
  - setPrettyPrint
```
public AdExchangeBuyerII.Accounts.Clients.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: AdExchangeBuyerIIRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class AdExchangeBuyerIIRequest<ListClientsResponse>
  - setQuotaUser
```
public AdExchangeBuyerII.Accounts.Clients.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<ListClientsResponse>
  - setUploadType
```
public AdExchangeBuyerII.Accounts.Clients.List setUploadType(String uploadType)
```
    Description copied from class: AdExchangeBuyerIIRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class AdExchangeBuyerIIRequest<ListClientsResponse>
  - setUploadProtocol
```
public AdExchangeBuyerII.Accounts.Clients.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: AdExchangeBuyerIIRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class AdExchangeBuyerIIRequest<ListClientsResponse>
  - getAccountId
```
public Long getAccountId()
```
    Unique numerical account ID of the sponsor buyer to list the clients for.
  - setAccountId
```
public AdExchangeBuyerII.Accounts.Clients.List setAccountId(Long accountId)
```
    Unique numerical account ID of the sponsor buyer to list the clients for.
  - 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.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 ListClientsResponse.nextPageToken returned from the previous call to the accounts.clients.list method.
  - setPageToken
```
public AdExchangeBuyerII.Accounts.Clients.List setPageToken(String pageToken)
```
    A token identifying a page of results the server should return. Typically, this is the value of ListClientsResponse.nextPageToken returned from the previous call to the accounts.clients.list method.
  - getPartnerClientId
```
public String getPartnerClientId()
```
    Optional unique identifier (from the standpoint of an Ad Exchange sponsor buyer partner) of the client to return. If specified, at most one client will be returned in the response.
  - setPartnerClientId
```
public AdExchangeBuyerII.Accounts.Clients.List setPartnerClientId(String partnerClientId)
```
    Optional unique identifier (from the standpoint of an Ad Exchange sponsor buyer partner) of the client to return. If specified, at most one client will be returned in the response.
  - set
```
public AdExchangeBuyerII.Accounts.Clients.List set(String parameterName,
                                                   Object value)
```
    Overrides:
    
    set in class AdExchangeBuyerIIRequest<ListClientsResponse>

Class AdExchangeBuyerII.Accounts.Clients.List

Nested Class Summary

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

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

List

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getAccountId

setAccountId

getPageSize

setPageSize

getPageToken

setPageToken

getPartnerClientId

setPartnerClientId

set