com.google.api.services.content

Class ShoppingContent.Reports.Search

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.content.ShoppingContentRequest<SearchResponse>

com.google.api.services.content.ShoppingContent.Reports.Search

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

ShoppingContent.Reports

public class ShoppingContent.Reports.Search
extends ShoppingContentRequest<SearchResponse>

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

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Search(Long merchantId, SearchRequest content) Retrieves merchant performance metrics matching the search query and optionally segmented by selected dimensions.

Method Summary

Modifier and Type	Method and Description
Long	getMerchantId() Required.
ShoppingContent.Reports.Search	set(String parameterName, Object value)
ShoppingContent.Reports.Search	set$Xgafv(String $Xgafv) V1 error format.
ShoppingContent.Reports.Search	setAccessToken(String accessToken) OAuth access token.
ShoppingContent.Reports.Search	setAlt(String alt) Data format for response.
ShoppingContent.Reports.Search	setCallback(String callback) JSONP
ShoppingContent.Reports.Search	setFields(String fields) Selector specifying which fields to include in a partial response.
ShoppingContent.Reports.Search	setKey(String key) API key.
ShoppingContent.Reports.Search	setMerchantId(Long merchantId) Required.
ShoppingContent.Reports.Search	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
ShoppingContent.Reports.Search	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
ShoppingContent.Reports.Search	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
ShoppingContent.Reports.Search	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
ShoppingContent.Reports.Search	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.content.ShoppingContentRequest

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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, 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

Search

protected Search(Long merchantId,
                 SearchRequest content)

Retrieves merchant performance metrics matching the search query and optionally segmented by selected dimensions. Create a request for the method "reports.search". This request holds the parameters needed by the the content server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

ShoppingContent.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

merchantId - Required. Id of the merchant making the call. Must be a standalone account or an MCA subaccount.

content - the SearchRequest

Since:

1.13

Method Detail

set$Xgafv

public ShoppingContent.Reports.Search set$Xgafv(String $Xgafv)

Description copied from class: ShoppingContentRequest

V1 error format.

Overrides:

set$Xgafv in class ShoppingContentRequest<SearchResponse>

setAccessToken

public ShoppingContent.Reports.Search setAccessToken(String accessToken)

Description copied from class: ShoppingContentRequest

OAuth access token.

Overrides:

setAccessToken in class ShoppingContentRequest<SearchResponse>

setAlt

public ShoppingContent.Reports.Search setAlt(String alt)

Description copied from class: ShoppingContentRequest

Data format for response.

Overrides:

setAlt in class ShoppingContentRequest<SearchResponse>

setCallback

public ShoppingContent.Reports.Search setCallback(String callback)

Description copied from class: ShoppingContentRequest

JSONP

Overrides:

setCallback in class ShoppingContentRequest<SearchResponse>

setFields

public ShoppingContent.Reports.Search setFields(String fields)

Description copied from class: ShoppingContentRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class ShoppingContentRequest<SearchResponse>

setKey

public ShoppingContent.Reports.Search setKey(String key)

Description copied from class: ShoppingContentRequest

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 ShoppingContentRequest<SearchResponse>

setOauthToken

public ShoppingContent.Reports.Search setOauthToken(String oauthToken)

Description copied from class: ShoppingContentRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ShoppingContentRequest<SearchResponse>

setPrettyPrint

public ShoppingContent.Reports.Search setPrettyPrint(Boolean prettyPrint)

Description copied from class: ShoppingContentRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ShoppingContentRequest<SearchResponse>

setQuotaUser

public ShoppingContent.Reports.Search setQuotaUser(String quotaUser)

Description copied from class: ShoppingContentRequest

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 ShoppingContentRequest<SearchResponse>

setUploadType

public ShoppingContent.Reports.Search setUploadType(String uploadType)

Description copied from class: ShoppingContentRequest

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

Overrides:

setUploadType in class ShoppingContentRequest<SearchResponse>

setUploadProtocol

public ShoppingContent.Reports.Search setUploadProtocol(String uploadProtocol)

Description copied from class: ShoppingContentRequest

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

Overrides:

setUploadProtocol in class ShoppingContentRequest<SearchResponse>

getMerchantId

public Long getMerchantId()

Required. Id of the merchant making the call. Must be a standalone account or an MCA subaccount.

setMerchantId

public ShoppingContent.Reports.Search setMerchantId(Long merchantId)

Required. Id of the merchant making the call. Must be a standalone account or an MCA subaccount.

set

public ShoppingContent.Reports.Search set(String parameterName,
                                          Object value)

Overrides:

set in class ShoppingContentRequest<SearchResponse>