com.google.api.services.dfareporting

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

com.google.api.services.dfareporting.Dfareporting.InventoryItems.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Dfareporting.InventoryItems

public class Dfareporting.InventoryItems.List
extends DfareportingRequest<InventoryItemsListResponse>

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 inventory items, possibly filtered.

Method Summary

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 inventory items with these IDs.
Boolean	getInPlan() Select only inventory items that are in plan.
Integer	getMaxResults() Maximum number of results to return.
List<Long>	getOrderId() Select only inventory items that belong to specified orders.
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 order documents.
List<Long>	getSiteId() Select only inventory items that are associated with these sites.
String	getSortField() Field by which to sort the list.
String	getSortOrder() Order of sorted results.
String	getType() Select only inventory items with this type.
Dfareporting.InventoryItems.List	set(String parameterName, Object value)
Dfareporting.InventoryItems.List	set$Xgafv(String $Xgafv) V1 error format.
Dfareporting.InventoryItems.List	setAccessToken(String accessToken) OAuth access token.
Dfareporting.InventoryItems.List	setAlt(String alt) Data format for response.
Dfareporting.InventoryItems.List	setCallback(String callback) JSONP
Dfareporting.InventoryItems.List	setFields(String fields) Selector specifying which fields to include in a partial response.
Dfareporting.InventoryItems.List	setIds(List<Long> ids) Select only inventory items with these IDs.
Dfareporting.InventoryItems.List	setInPlan(Boolean inPlan) Select only inventory items that are in plan.
Dfareporting.InventoryItems.List	setKey(String key) API key.
Dfareporting.InventoryItems.List	setMaxResults(Integer maxResults) Maximum number of results to return.
Dfareporting.InventoryItems.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Dfareporting.InventoryItems.List	setOrderId(List<Long> orderId) Select only inventory items that belong to specified orders.
Dfareporting.InventoryItems.List	setPageToken(String pageToken) Value of the nextPageToken from the previous result page.
Dfareporting.InventoryItems.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Dfareporting.InventoryItems.List	setProfileId(Long profileId) User profile ID associated with this request.
Dfareporting.InventoryItems.List	setProjectId(Long projectId) Project ID for order documents.
Dfareporting.InventoryItems.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Dfareporting.InventoryItems.List	setSiteId(List<Long> siteId) Select only inventory items that are associated with these sites.
Dfareporting.InventoryItems.List	setSortField(String sortField) Field by which to sort the list.
Dfareporting.InventoryItems.List	setSortOrder(String sortOrder) Order of sorted results.
Dfareporting.InventoryItems.List	setType(String type) Select only inventory items with this type.
Dfareporting.InventoryItems.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Dfareporting.InventoryItems.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 inventory items, possibly filtered. This method supports paging. Create a request for the method "inventoryItems.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 order documents.

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<InventoryItemsListResponse>

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<InventoryItemsListResponse>

Throws:

IOException

set$Xgafv

public Dfareporting.InventoryItems.List set$Xgafv(String $Xgafv)

Description copied from class: DfareportingRequest

V1 error format.

Overrides:

set$Xgafv in class DfareportingRequest<InventoryItemsListResponse>

setAccessToken

public Dfareporting.InventoryItems.List setAccessToken(String accessToken)

Description copied from class: DfareportingRequest

OAuth access token.

Overrides:

setAccessToken in class DfareportingRequest<InventoryItemsListResponse>

setAlt

public Dfareporting.InventoryItems.List setAlt(String alt)

Description copied from class: DfareportingRequest

Data format for response.

Overrides:

setAlt in class DfareportingRequest<InventoryItemsListResponse>

setCallback

public Dfareporting.InventoryItems.List setCallback(String callback)

Description copied from class: DfareportingRequest

JSONP

Overrides:

setCallback in class DfareportingRequest<InventoryItemsListResponse>

setFields

public Dfareporting.InventoryItems.List setFields(String fields)

Description copied from class: DfareportingRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DfareportingRequest<InventoryItemsListResponse>

setKey

public Dfareporting.InventoryItems.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<InventoryItemsListResponse>

setOauthToken

public Dfareporting.InventoryItems.List setOauthToken(String oauthToken)

Description copied from class: DfareportingRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DfareportingRequest<InventoryItemsListResponse>

setPrettyPrint

public Dfareporting.InventoryItems.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: DfareportingRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DfareportingRequest<InventoryItemsListResponse>

setQuotaUser

public Dfareporting.InventoryItems.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<InventoryItemsListResponse>

setUploadType

public Dfareporting.InventoryItems.List setUploadType(String uploadType)

Description copied from class: DfareportingRequest

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

Overrides:

setUploadType in class DfareportingRequest<InventoryItemsListResponse>

setUploadProtocol

public Dfareporting.InventoryItems.List setUploadProtocol(String uploadProtocol)

Description copied from class: DfareportingRequest

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

Overrides:

setUploadProtocol in class DfareportingRequest<InventoryItemsListResponse>

getProfileId

public Long getProfileId()

User profile ID associated with this request.

setProfileId

public Dfareporting.InventoryItems.List setProfileId(Long profileId)

User profile ID associated with this request.

getProjectId

public Long getProjectId()

Project ID for order documents.

setProjectId

public Dfareporting.InventoryItems.List setProjectId(Long projectId)

Project ID for order documents.

getIds

public List<Long> getIds()

Select only inventory items with these IDs.

setIds

public Dfareporting.InventoryItems.List setIds(List<Long> ids)

Select only inventory items with these IDs.

getInPlan

public Boolean getInPlan()

Select only inventory items that are in plan.

setInPlan

public Dfareporting.InventoryItems.List setInPlan(Boolean inPlan)

Select only inventory items that are in plan.

getMaxResults

public Integer getMaxResults()

Maximum number of results to return. [default: 1000]

setMaxResults

public Dfareporting.InventoryItems.List setMaxResults(Integer maxResults)

Maximum number of results to return.

getOrderId

public List<Long> getOrderId()

Select only inventory items that belong to specified orders.

setOrderId

public Dfareporting.InventoryItems.List setOrderId(List<Long> orderId)

Select only inventory items that belong to specified orders.

getPageToken

public String getPageToken()

Value of the nextPageToken from the previous result page.

setPageToken

public Dfareporting.InventoryItems.List setPageToken(String pageToken)

Value of the nextPageToken from the previous result page.

getSiteId

public List<Long> getSiteId()

Select only inventory items that are associated with these sites.

setSiteId

public Dfareporting.InventoryItems.List setSiteId(List<Long> siteId)

Select only inventory items that are associated with these sites.

getSortField

public String getSortField()

Field by which to sort the list. [default: ID]

setSortField

public Dfareporting.InventoryItems.List setSortField(String sortField)

Field by which to sort the list.

getSortOrder

public String getSortOrder()

Order of sorted results. [default: ASCENDING]

setSortOrder

public Dfareporting.InventoryItems.List setSortOrder(String sortOrder)

Order of sorted results.

getType

public String getType()

Select only inventory items with this type.

setType

public Dfareporting.InventoryItems.List setType(String type)

Select only inventory items with this type.

set

public Dfareporting.InventoryItems.List set(String parameterName,
                                            Object value)

Overrides:

set in class DfareportingRequest<InventoryItemsListResponse>