Dfareporting.Reports.List (DCM/DFA Reporting And Trafficking API v3.3-rev20190124-1.26.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<ReportList>
        
        com.google.api.services.dfareporting.Dfareporting.Reports.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Dfareporting.Reports
```
public class Dfareporting.Reports.List
extends DfareportingRequest<ReportList>
```

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 list of reports.

Constructors
Modifier	Constructor and Description
`protected`	`List(Long profileId)` Retrieves list of reports.

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()`
`Integer`	`getMaxResults()` Maximum number of results to return.
`String`	`getPageToken()` The value of the nextToken from the previous result page.
`Long`	`getProfileId()` The DFA user profile ID.
`String`	`getScope()` The scope that defines which results are returned.
`String`	`getSortField()` The field by which to sort the list.
`String`	`getSortOrder()` Order of sorted results.
`Dfareporting.Reports.List`	`set(String parameterName, Object value)`
`Dfareporting.Reports.List`	`setAlt(String alt)` Data format for the response.
`Dfareporting.Reports.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Dfareporting.Reports.List`	`setKey(String key)` API key.
`Dfareporting.Reports.List`	`setMaxResults(Integer maxResults)` Maximum number of results to return.
`Dfareporting.Reports.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Dfareporting.Reports.List`	`setPageToken(String pageToken)` The value of the nextToken from the previous result page.
`Dfareporting.Reports.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Dfareporting.Reports.List`	`setProfileId(Long profileId)` The DFA user profile ID.
`Dfareporting.Reports.List`	`setQuotaUser(String quotaUser)` An opaque string that represents a user for quota purposes.
`Dfareporting.Reports.List`	`setScope(String scope)` The scope that defines which results are returned.
`Dfareporting.Reports.List`	`setSortField(String sortField)` The field by which to sort the list.
`Dfareporting.Reports.List`	`setSortOrder(String sortOrder)` Order of sorted results.
`Dfareporting.Reports.List`	`setUserIp(String userIp)` Deprecated.

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 list of reports. Create a request for the method "reports.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 - The DFA user profile ID.
    
    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<ReportList>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ReportList>
    
    Throws:
    
    IOException
  - setAlt
```
public Dfareporting.Reports.List setAlt(String alt)
```
    Description copied from class: DfareportingRequest
    
    Data format for the response.
    
    Overrides:
    
    setAlt in class DfareportingRequest<ReportList>
  - setFields
```
public Dfareporting.Reports.List setFields(String fields)
```
    Description copied from class: DfareportingRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class DfareportingRequest<ReportList>
  - setKey
```
public Dfareporting.Reports.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<ReportList>
  - setOauthToken
```
public Dfareporting.Reports.List setOauthToken(String oauthToken)
```
    Description copied from class: DfareportingRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class DfareportingRequest<ReportList>
  - setPrettyPrint
```
public Dfareporting.Reports.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: DfareportingRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class DfareportingRequest<ReportList>
  - setQuotaUser
```
public Dfareporting.Reports.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<ReportList>
  - setUserIp
```
public Dfareporting.Reports.List setUserIp(String userIp)
```
    Description copied from class: DfareportingRequest
    
    Deprecated. Please use quotaUser instead.
    
    Overrides:
    
    setUserIp in class DfareportingRequest<ReportList>
  - getProfileId
```
public Long getProfileId()
```
    The DFA user profile ID.
  - setProfileId
```
public Dfareporting.Reports.List setProfileId(Long profileId)
```
    The DFA user profile ID.
  - getMaxResults
```
public Integer getMaxResults()
```
    Maximum number of results to return. [default: 10] [minimum: 0] [maximum: 10]
  - setMaxResults
```
public Dfareporting.Reports.List setMaxResults(Integer maxResults)
```
    Maximum number of results to return.
  - getPageToken
```
public String getPageToken()
```
    The value of the nextToken from the previous result page.
  - setPageToken
```
public Dfareporting.Reports.List setPageToken(String pageToken)
```
    The value of the nextToken from the previous result page.
  - getScope
```
public String getScope()
```
    The scope that defines which results are returned. [default: MINE]
  - setScope
```
public Dfareporting.Reports.List setScope(String scope)
```
    The scope that defines which results are returned.
  - getSortField
```
public String getSortField()
```
    The field by which to sort the list. [default: LAST_MODIFIED_TIME]
  - setSortField
```
public Dfareporting.Reports.List setSortField(String sortField)
```
    The field by which to sort the list.
  - getSortOrder
```
public String getSortOrder()
```
    Order of sorted results. [default: DESCENDING]
  - setSortOrder
```
public Dfareporting.Reports.List setSortOrder(String sortOrder)
```
    Order of sorted results.
  - set
```
public Dfareporting.Reports.List set(String parameterName,
                                     Object value)
```
    Overrides:
    
    set in class DfareportingRequest<ReportList>

Class Dfareporting.Reports.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

setAlt

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUserIp

getProfileId

setProfileId

getMaxResults

setMaxResults

getPageToken

setPageToken

getScope

setScope

getSortField

setSortField

getSortOrder

setSortOrder

set