Dfareporting.Orders.List (Campaign Manager 360 API v4-rev20230918-2.0.0)

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<OrdersListResponse>
        
        com.google.api.services.dfareporting.Dfareporting.Orders.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Dfareporting.Orders
```
public class Dfareporting.Orders.List
extends DfareportingRequest<OrdersListResponse>
```

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, Long projectId)
Retrieves a list of orders, possibly filtered.

Constructors
Modifier	Constructor and Description
`protected`	`List(Long profileId, Long projectId)` Retrieves a list of orders, possibly filtered.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`List<Long>`	`getIds()` Select only orders 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.
`Long`	`getProjectId()` Project ID for orders.
`String`	`getSearchString()` Allows searching for orders by name or ID.
`List<Long>`	`getSiteId()` Select only orders that are associated with these site IDs.
`String`	`getSortField()` Field by which to sort the list.
`String`	`getSortOrder()` Order of sorted results.
`Dfareporting.Orders.List`	`set(String parameterName, Object value)`
`Dfareporting.Orders.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`Dfareporting.Orders.List`	`setAccessToken(String accessToken)` OAuth access token.
`Dfareporting.Orders.List`	`setAlt(String alt)` Data format for response.
`Dfareporting.Orders.List`	`setCallback(String callback)` JSONP
`Dfareporting.Orders.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Dfareporting.Orders.List`	`setIds(List<Long> ids)` Select only orders with these IDs.
`Dfareporting.Orders.List`	`setKey(String key)` API key.
`Dfareporting.Orders.List`	`setMaxResults(Integer maxResults)` Maximum number of results to return.
`Dfareporting.Orders.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Dfareporting.Orders.List`	`setPageToken(String pageToken)` Value of the nextPageToken from the previous result page.
`Dfareporting.Orders.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Dfareporting.Orders.List`	`setProfileId(Long profileId)` User profile ID associated with this request.
`Dfareporting.Orders.List`	`setProjectId(Long projectId)` Project ID for orders.
`Dfareporting.Orders.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Dfareporting.Orders.List`	`setSearchString(String searchString)` Allows searching for orders by name or ID.
`Dfareporting.Orders.List`	`setSiteId(List<Long> siteId)` Select only orders that are associated with these site IDs.
`Dfareporting.Orders.List`	`setSortField(String sortField)` Field by which to sort the list.
`Dfareporting.Orders.List`	`setSortOrder(String sortOrder)` Order of sorted results.
`Dfareporting.Orders.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Dfareporting.Orders.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,
               Long projectId)
```
    Retrieves a list of orders, possibly filtered. This method supports paging. Create a request for the method "orders.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.
    
    projectId - Project ID for orders.
    
    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<OrdersListResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<OrdersListResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public Dfareporting.Orders.List set$Xgafv(String $Xgafv)
```
    Description copied from class: DfareportingRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class DfareportingRequest<OrdersListResponse>
  - setAccessToken
```
public Dfareporting.Orders.List setAccessToken(String accessToken)
```
    Description copied from class: DfareportingRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class DfareportingRequest<OrdersListResponse>
  - setAlt
```
public Dfareporting.Orders.List setAlt(String alt)
```
    Description copied from class: DfareportingRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class DfareportingRequest<OrdersListResponse>
  - setCallback
```
public Dfareporting.Orders.List setCallback(String callback)
```
    Description copied from class: DfareportingRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class DfareportingRequest<OrdersListResponse>
  - setFields
```
public Dfareporting.Orders.List setFields(String fields)
```
    Description copied from class: DfareportingRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class DfareportingRequest<OrdersListResponse>
  - setKey
```
public Dfareporting.Orders.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<OrdersListResponse>
  - setOauthToken
```
public Dfareporting.Orders.List setOauthToken(String oauthToken)
```
    Description copied from class: DfareportingRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class DfareportingRequest<OrdersListResponse>
  - setPrettyPrint
```
public Dfareporting.Orders.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: DfareportingRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class DfareportingRequest<OrdersListResponse>
  - setQuotaUser
```
public Dfareporting.Orders.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<OrdersListResponse>
  - setUploadType
```
public Dfareporting.Orders.List setUploadType(String uploadType)
```
    Description copied from class: DfareportingRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class DfareportingRequest<OrdersListResponse>
  - setUploadProtocol
```
public Dfareporting.Orders.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: DfareportingRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class DfareportingRequest<OrdersListResponse>
  - getProfileId
```
public Long getProfileId()
```
    User profile ID associated with this request.
  - setProfileId
```
public Dfareporting.Orders.List setProfileId(Long profileId)
```
    User profile ID associated with this request.
  - getProjectId
```
public Long getProjectId()
```
    Project ID for orders.
  - setProjectId
```
public Dfareporting.Orders.List setProjectId(Long projectId)
```
    Project ID for orders.
  - getIds
```
public List<Long> getIds()
```
    Select only orders with these IDs.
  - setIds
```
public Dfareporting.Orders.List setIds(List<Long> ids)
```
    Select only orders with these IDs.
  - getMaxResults
```
public Integer getMaxResults()
```
    Maximum number of results to return. [default: 1000]
  - setMaxResults
```
public Dfareporting.Orders.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.Orders.List setPageToken(String pageToken)
```
    Value of the nextPageToken from the previous result page.
  - getSearchString
```
public String getSearchString()
```
    Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, "order*2015" will return orders with names like "order June 2015", "order April 2015", or simply "order 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 "order" will match orders with name "my order", "order 2015", or simply "order".
  - setSearchString
```
public Dfareporting.Orders.List setSearchString(String searchString)
```
    Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, "order*2015" will return orders with names like "order June 2015", "order April 2015", or simply "order 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 "order" will match orders with name "my order", "order 2015", or simply "order".
  - getSiteId
```
public List<Long> getSiteId()
```
    Select only orders that are associated with these site IDs.
  - setSiteId
```
public Dfareporting.Orders.List setSiteId(List<Long> siteId)
```
    Select only orders that are associated with these site IDs.
  - getSortField
```
public String getSortField()
```
    Field by which to sort the list. [default: ID]
  - setSortField
```
public Dfareporting.Orders.List setSortField(String sortField)
```
    Field by which to sort the list.
  - getSortOrder
```
public String getSortOrder()
```
    Order of sorted results. [default: ASCENDING]
  - setSortOrder
```
public Dfareporting.Orders.List setSortOrder(String sortOrder)
```
    Order of sorted results.
  - set
```
public Dfareporting.Orders.List set(String parameterName,
                                    Object value)
```
    Overrides:
    
    set in class DfareportingRequest<OrdersListResponse>

Class Dfareporting.Orders.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.dfareporting.DfareportingRequest

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

getProfileId

setProfileId

getProjectId

setProjectId

getIds

setIds

getMaxResults

setMaxResults

getPageToken

setPageToken

getSearchString

setSearchString

getSiteId

setSiteId

getSortField

setSortField

getSortOrder

setSortOrder

set