com.google.api.services.content

Class ShoppingContent.Accounts.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<AccountsListResponse>

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

ShoppingContent.Accounts

public class ShoppingContent.Accounts.List
extends ShoppingContentRequest<AccountsListResponse>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

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(BigInteger merchantId) Lists the sub-accounts in your Merchant Center account.

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
BigInteger	getLabel() If view is set to "css", only return accounts that are assigned label with given ID.
Long	getMaxResults() The maximum number of accounts to return in the response, used for paging.
BigInteger	getMerchantId() The ID of the managing account.
String	getPageToken() The token returned by the previous request.
String	getView() Controls which fields will be populated.
ShoppingContent.Accounts.List	set(String parameterName, Object value)
ShoppingContent.Accounts.List	setAlt(String alt) Data format for the response.
ShoppingContent.Accounts.List	setFields(String fields) Selector specifying which fields to include in a partial response.
ShoppingContent.Accounts.List	setKey(String key) API key.
ShoppingContent.Accounts.List	setLabel(BigInteger label) If view is set to "css", only return accounts that are assigned label with given ID.
ShoppingContent.Accounts.List	setMaxResults(Long maxResults) The maximum number of accounts to return in the response, used for paging.
ShoppingContent.Accounts.List	setMerchantId(BigInteger merchantId) The ID of the managing account.
ShoppingContent.Accounts.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
ShoppingContent.Accounts.List	setPageToken(String pageToken) The token returned by the previous request.
ShoppingContent.Accounts.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
ShoppingContent.Accounts.List	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
ShoppingContent.Accounts.List	setUserIp(String userIp) Deprecated.
ShoppingContent.Accounts.List	setView(String view) Controls which fields will be populated.

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

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, 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(BigInteger merchantId)

Lists the sub-accounts in your Merchant Center account. Create a request for the method "accounts.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 - The ID of the managing account. This must be a multi-client account.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<AccountsListResponse>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<AccountsListResponse>

Throws:

IOException

setAlt

public ShoppingContent.Accounts.List setAlt(String alt)

Description copied from class: ShoppingContentRequest

Data format for the response.

Overrides:

setAlt in class ShoppingContentRequest<AccountsListResponse>

setFields

public ShoppingContent.Accounts.List setFields(String fields)

Description copied from class: ShoppingContentRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class ShoppingContentRequest<AccountsListResponse>

setKey

public ShoppingContent.Accounts.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<AccountsListResponse>

setOauthToken

public ShoppingContent.Accounts.List setOauthToken(String oauthToken)

Description copied from class: ShoppingContentRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ShoppingContentRequest<AccountsListResponse>

setPrettyPrint

public ShoppingContent.Accounts.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: ShoppingContentRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ShoppingContentRequest<AccountsListResponse>

setQuotaUser

public ShoppingContent.Accounts.List setQuotaUser(String quotaUser)

Description copied from class: ShoppingContentRequest

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Overrides:

setQuotaUser in class ShoppingContentRequest<AccountsListResponse>

setUserIp

public ShoppingContent.Accounts.List setUserIp(String userIp)

Description copied from class: ShoppingContentRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class ShoppingContentRequest<AccountsListResponse>

getMerchantId

public BigInteger getMerchantId()

The ID of the managing account. This must be a multi-client account.

setMerchantId

public ShoppingContent.Accounts.List setMerchantId(BigInteger merchantId)

The ID of the managing account. This must be a multi-client account.

getLabel

public BigInteger getLabel()

If view is set to "css", only return accounts that are assigned label with given ID.

setLabel

public ShoppingContent.Accounts.List setLabel(BigInteger label)

If view is set to "css", only return accounts that are assigned label with given ID.

getMaxResults

public Long getMaxResults()

The maximum number of accounts to return in the response, used for paging.

setMaxResults

public ShoppingContent.Accounts.List setMaxResults(Long maxResults)

The maximum number of accounts to return in the response, used for paging.

getPageToken

public String getPageToken()

The token returned by the previous request.

setPageToken

public ShoppingContent.Accounts.List setPageToken(String pageToken)

The token returned by the previous request.

getView

public String getView()

Controls which fields will be populated. Acceptable values are: "merchant" and "css". The default value is "merchant".

setView

public ShoppingContent.Accounts.List setView(String view)

Controls which fields will be populated. Acceptable values are: "merchant" and "css". The default value is "merchant".

set

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

Overrides:

set in class ShoppingContentRequest<AccountsListResponse>