AdExchangeBuyerII.Accounts.Creatives.DealAssociations.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<ListDealAssociationsResponse>
        
        com.google.api.services.adexchangebuyer2.v2beta1.AdExchangeBuyerII.Accounts.Creatives.DealAssociations.List

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

Enclosing class:: AdExchangeBuyerII.Accounts.Creatives.DealAssociations

public class AdExchangeBuyerII.Accounts.Creatives.DealAssociations.List
extends AdExchangeBuyerIIRequest<ListDealAssociationsResponse>

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(String accountId, String creativeId)
List all creative-deal associations.

Constructors
Modifier	Constructor and Description
`protected`	`List(String accountId, String creativeId)` List all creative-deal associations.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpRequest`	`buildHttpRequestUsingHead()`
`HttpResponse`	`executeUsingHead()`
`String`	`getAccountId()` The account to list the associations from.
`String`	`getCreativeId()` The creative ID to list the associations from.
`Integer`	`getPageSize()` Requested page size.
`String`	`getPageToken()` A token identifying a page of results the server should return.
`String`	`getQuery()` An optional query string to filter deal associations.
`AdExchangeBuyerII.Accounts.Creatives.DealAssociations.List`	`set(String parameterName, Object value)`
`AdExchangeBuyerII.Accounts.Creatives.DealAssociations.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`AdExchangeBuyerII.Accounts.Creatives.DealAssociations.List`	`setAccessToken(String accessToken)` OAuth access token.
`AdExchangeBuyerII.Accounts.Creatives.DealAssociations.List`	`setAccountId(String accountId)` The account to list the associations from.
`AdExchangeBuyerII.Accounts.Creatives.DealAssociations.List`	`setAlt(String alt)` Data format for response.
`AdExchangeBuyerII.Accounts.Creatives.DealAssociations.List`	`setCallback(String callback)` JSONP
`AdExchangeBuyerII.Accounts.Creatives.DealAssociations.List`	`setCreativeId(String creativeId)` The creative ID to list the associations from.
`AdExchangeBuyerII.Accounts.Creatives.DealAssociations.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`AdExchangeBuyerII.Accounts.Creatives.DealAssociations.List`	`setKey(String key)` API key.
`AdExchangeBuyerII.Accounts.Creatives.DealAssociations.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`AdExchangeBuyerII.Accounts.Creatives.DealAssociations.List`	`setPageSize(Integer pageSize)` Requested page size.
`AdExchangeBuyerII.Accounts.Creatives.DealAssociations.List`	`setPageToken(String pageToken)` A token identifying a page of results the server should return.
`AdExchangeBuyerII.Accounts.Creatives.DealAssociations.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`AdExchangeBuyerII.Accounts.Creatives.DealAssociations.List`	`setQuery(String query)` An optional query string to filter deal associations.
`AdExchangeBuyerII.Accounts.Creatives.DealAssociations.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`AdExchangeBuyerII.Accounts.Creatives.DealAssociations.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`AdExchangeBuyerII.Accounts.Creatives.DealAssociations.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(String accountId,
               String creativeId)
```
    List all creative-deal associations. Create a request for the method "dealAssociations.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 - The account to list the associations from. Specify "-" to list all creatives the current user has access to.
    
    creativeId - The creative ID to list the associations from. Specify "-" to list all creatives under the above account.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public HttpResponse executeUsingHead()
                              throws IOException
```
    Overrides:
    
    executeUsingHead in class AbstractGoogleClientRequest<ListDealAssociationsResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class AbstractGoogleClientRequest<ListDealAssociationsResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public AdExchangeBuyerII.Accounts.Creatives.DealAssociations.List set$Xgafv(String $Xgafv)
```
    Description copied from class: AdExchangeBuyerIIRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class AdExchangeBuyerIIRequest<ListDealAssociationsResponse>
  - setAccessToken
```
public AdExchangeBuyerII.Accounts.Creatives.DealAssociations.List setAccessToken(String accessToken)
```
    Description copied from class: AdExchangeBuyerIIRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class AdExchangeBuyerIIRequest<ListDealAssociationsResponse>
  - setAlt
```
public AdExchangeBuyerII.Accounts.Creatives.DealAssociations.List setAlt(String alt)
```
    Description copied from class: AdExchangeBuyerIIRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class AdExchangeBuyerIIRequest<ListDealAssociationsResponse>
  - setCallback
```
public AdExchangeBuyerII.Accounts.Creatives.DealAssociations.List setCallback(String callback)
```
    Description copied from class: AdExchangeBuyerIIRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class AdExchangeBuyerIIRequest<ListDealAssociationsResponse>
  - setFields
```
public AdExchangeBuyerII.Accounts.Creatives.DealAssociations.List setFields(String fields)
```
    Description copied from class: AdExchangeBuyerIIRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class AdExchangeBuyerIIRequest<ListDealAssociationsResponse>
  - setKey
```
public AdExchangeBuyerII.Accounts.Creatives.DealAssociations.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<ListDealAssociationsResponse>
  - setOauthToken
```
public AdExchangeBuyerII.Accounts.Creatives.DealAssociations.List setOauthToken(String oauthToken)
```
    Description copied from class: AdExchangeBuyerIIRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class AdExchangeBuyerIIRequest<ListDealAssociationsResponse>
  - setPrettyPrint
```
public AdExchangeBuyerII.Accounts.Creatives.DealAssociations.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: AdExchangeBuyerIIRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class AdExchangeBuyerIIRequest<ListDealAssociationsResponse>
  - setQuotaUser
```
public AdExchangeBuyerII.Accounts.Creatives.DealAssociations.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<ListDealAssociationsResponse>
  - setUploadType
```
public AdExchangeBuyerII.Accounts.Creatives.DealAssociations.List setUploadType(String uploadType)
```
    Description copied from class: AdExchangeBuyerIIRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class AdExchangeBuyerIIRequest<ListDealAssociationsResponse>
  - setUploadProtocol
```
public AdExchangeBuyerII.Accounts.Creatives.DealAssociations.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: AdExchangeBuyerIIRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class AdExchangeBuyerIIRequest<ListDealAssociationsResponse>
  - getAccountId
```
public String getAccountId()
```
    The account to list the associations from. Specify "-" to list all creatives the current user has access to.
  - setAccountId
```
public AdExchangeBuyerII.Accounts.Creatives.DealAssociations.List setAccountId(String accountId)
```
    The account to list the associations from. Specify "-" to list all creatives the current user has access to.
  - getCreativeId
```
public String getCreativeId()
```
    The creative ID to list the associations from. Specify "-" to list all creatives under the above account.
  - setCreativeId
```
public AdExchangeBuyerII.Accounts.Creatives.DealAssociations.List setCreativeId(String creativeId)
```
    The creative ID to list the associations from. Specify "-" to list all creatives under the above account.
  - getPageSize
```
public Integer getPageSize()
```
    Requested page size. Server may return fewer associations than requested. If unspecified, server will pick an appropriate default.
  - setPageSize
```
public AdExchangeBuyerII.Accounts.Creatives.DealAssociations.List setPageSize(Integer pageSize)
```
    Requested page size. Server may return fewer associations than requested. If unspecified, 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 ListDealAssociationsResponse.next_page_token returned from the previous call to 'ListDealAssociations' method.
  - setPageToken
```
public AdExchangeBuyerII.Accounts.Creatives.DealAssociations.List setPageToken(String pageToken)
```
    A token identifying a page of results the server should return. Typically, this is the value of ListDealAssociationsResponse.next_page_token returned from the previous call to 'ListDealAssociations' method.
  - getQuery
```
public String getQuery()
```
    An optional query string to filter deal associations. If no filter is specified, all associations will be returned. Supported queries are: - accountId=*account_id_string* - creativeId=*creative_id_string* - dealsId=*deals_id_string* - dealsStatus:{approved, conditionally_approved, disapproved, not_checked} - openAuctionStatus:{approved, conditionally_approved, disapproved, not_checked} Example: 'dealsId=12345 AND dealsStatus:disapproved'
  - setQuery
```
public AdExchangeBuyerII.Accounts.Creatives.DealAssociations.List setQuery(String query)
```
    An optional query string to filter deal associations. If no filter is specified, all associations will be returned. Supported queries are: - accountId=*account_id_string* - creativeId=*creative_id_string* - dealsId=*deals_id_string* - dealsStatus:{approved, conditionally_approved, disapproved, not_checked} - openAuctionStatus:{approved, conditionally_approved, disapproved, not_checked} Example: 'dealsId=12345 AND dealsStatus:disapproved'
  - set
```
public AdExchangeBuyerII.Accounts.Creatives.DealAssociations.List set(String parameterName,
                                                                      Object value)
```
    Overrides:
    
    set in class AdExchangeBuyerIIRequest<ListDealAssociationsResponse>

Class AdExchangeBuyerII.Accounts.Creatives.DealAssociations.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

getCreativeId

setCreativeId

getPageSize

setPageSize

getPageToken

setPageToken

getQuery

setQuery

set