com.google.api.services.content

Class ShoppingContent.Promotions.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.content.ShoppingContentRequest<ListPromotionResponse>

com.google.api.services.content.ShoppingContent.Promotions.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

ShoppingContent.Promotions

public class ShoppingContent.Promotions.List
extends ShoppingContentRequest<ListPromotionResponse>

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 merchantId) List all promotions from your Merchant Center account.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getCountryCode() [ CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) (for example, [ "US"), used as a filter on promotions target country.
String	getLanguageCode() The two-letter ISO 639-1 language code associated with the promotions, used as a filter.
Long	getMerchantId() Required.
Integer	getPageSize() The maximum number of promotions to return.
String	getPageToken() A page token, received from a previous `ListPromotion` call.
ShoppingContent.Promotions.List	set(String parameterName, Object value)
ShoppingContent.Promotions.List	set$Xgafv(String $Xgafv) V1 error format.
ShoppingContent.Promotions.List	setAccessToken(String accessToken) OAuth access token.
ShoppingContent.Promotions.List	setAlt(String alt) Data format for response.
ShoppingContent.Promotions.List	setCallback(String callback) JSONP
ShoppingContent.Promotions.List	setCountryCode(String countryCode) [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) (for example, "US"), used as a filter on promotions target country.
ShoppingContent.Promotions.List	setFields(String fields) Selector specifying which fields to include in a partial response.
ShoppingContent.Promotions.List	setKey(String key) API key.
ShoppingContent.Promotions.List	setLanguageCode(String languageCode) The two-letter ISO 639-1 language code associated with the promotions, used as a filter.
ShoppingContent.Promotions.List	setMerchantId(Long merchantId) Required.
ShoppingContent.Promotions.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
ShoppingContent.Promotions.List	setPageSize(Integer pageSize) The maximum number of promotions to return.
ShoppingContent.Promotions.List	setPageToken(String pageToken) A page token, received from a previous `ListPromotion` call.
ShoppingContent.Promotions.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
ShoppingContent.Promotions.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
ShoppingContent.Promotions.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
ShoppingContent.Promotions.List	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, 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 merchantId)

List all promotions from your Merchant Center account. Create a request for the method "promotions.list". 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. The ID of the account that contains the collection.

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

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

public ShoppingContent.Promotions.List set$Xgafv(String $Xgafv)

Description copied from class: ShoppingContentRequest

V1 error format.

Overrides:

set$Xgafv in class ShoppingContentRequest<ListPromotionResponse>

setAccessToken

public ShoppingContent.Promotions.List setAccessToken(String accessToken)

Description copied from class: ShoppingContentRequest

OAuth access token.

Overrides:

setAccessToken in class ShoppingContentRequest<ListPromotionResponse>

setAlt

public ShoppingContent.Promotions.List setAlt(String alt)

Description copied from class: ShoppingContentRequest

Data format for response.

Overrides:

setAlt in class ShoppingContentRequest<ListPromotionResponse>

setCallback

public ShoppingContent.Promotions.List setCallback(String callback)

Description copied from class: ShoppingContentRequest

JSONP

Overrides:

setCallback in class ShoppingContentRequest<ListPromotionResponse>

setFields

public ShoppingContent.Promotions.List setFields(String fields)

Description copied from class: ShoppingContentRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class ShoppingContentRequest<ListPromotionResponse>

setKey

public ShoppingContent.Promotions.List 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<ListPromotionResponse>

setOauthToken

public ShoppingContent.Promotions.List setOauthToken(String oauthToken)

Description copied from class: ShoppingContentRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ShoppingContentRequest<ListPromotionResponse>

setPrettyPrint

public ShoppingContent.Promotions.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: ShoppingContentRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ShoppingContentRequest<ListPromotionResponse>

setQuotaUser

public ShoppingContent.Promotions.List 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<ListPromotionResponse>

setUploadType

public ShoppingContent.Promotions.List setUploadType(String uploadType)

Description copied from class: ShoppingContentRequest

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

Overrides:

setUploadType in class ShoppingContentRequest<ListPromotionResponse>

setUploadProtocol

public ShoppingContent.Promotions.List setUploadProtocol(String uploadProtocol)

Description copied from class: ShoppingContentRequest

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

Overrides:

setUploadProtocol in class ShoppingContentRequest<ListPromotionResponse>

getMerchantId

public Long getMerchantId()

Required. The ID of the account that contains the collection.

setMerchantId

public ShoppingContent.Promotions.List setMerchantId(Long merchantId)

Required. The ID of the account that contains the collection.

getCountryCode

public String getCountryCode()

[ CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) (for example, [ "US"), used as a filter on promotions target country. [

setCountryCode

public ShoppingContent.Promotions.List setCountryCode(String countryCode)

[CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) (for example, "US"), used as a filter on promotions target country.

getLanguageCode

public String getLanguageCode()

The two-letter ISO 639-1 language code associated with the promotions, used as a filter.

setLanguageCode

public ShoppingContent.Promotions.List setLanguageCode(String languageCode)

The two-letter ISO 639-1 language code associated with the promotions, used as a filter.

getPageSize

public Integer getPageSize()

The maximum number of promotions to return. The service may return fewer than this value. If unspecified, at most 50 labels will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

setPageSize

public ShoppingContent.Promotions.List setPageSize(Integer pageSize)

The maximum number of promotions to return. The service may return fewer than this value. If unspecified, at most 50 labels will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

getPageToken

public String getPageToken()

A page token, received from a previous `ListPromotion` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPromotion` must match the call that provided the page token.

setPageToken

public ShoppingContent.Promotions.List setPageToken(String pageToken)

A page token, received from a previous `ListPromotion` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPromotion` must match the call that provided the page token.

set

public ShoppingContent.Promotions.List set(String parameterName,
                                           Object value)

Overrides:

set in class ShoppingContentRequest<ListPromotionResponse>