ShoppingContent.Collections.List (Content API for Shopping v2.1-rev20241023-2.0.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.content.ShoppingContentRequest<ListCollectionsResponse>
        
        com.google.api.services.content.ShoppingContent.Collections.List

All Implemented Interfaces:: Cloneable, Map<String,Object>

Enclosing class:: ShoppingContent.Collections

public class ShoppingContent.Collections.List
extends ShoppingContentRequest<ListCollectionsResponse>

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 List(Long merchantId)
Lists the collections in your Merchant Center account.

Constructors
Modifier	Constructor and Description
`protected`	`List(Long merchantId)` Lists the collections in your Merchant Center account.

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()`
`Long`	`getMerchantId()` Required.
`Integer`	`getPageSize()` The maximum number of collections to return in the response, used for paging.
`String`	`getPageToken()` Token (if provided) to retrieve the subsequent page.
`ShoppingContent.Collections.List`	`set(String parameterName, Object value)`
`ShoppingContent.Collections.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`ShoppingContent.Collections.List`	`setAccessToken(String accessToken)` OAuth access token.
`ShoppingContent.Collections.List`	`setAlt(String alt)` Data format for response.
`ShoppingContent.Collections.List`	`setCallback(String callback)` JSONP
`ShoppingContent.Collections.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`ShoppingContent.Collections.List`	`setKey(String key)` API key.
`ShoppingContent.Collections.List`	`setMerchantId(Long merchantId)` Required.
`ShoppingContent.Collections.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`ShoppingContent.Collections.List`	`setPageSize(Integer pageSize)` The maximum number of collections to return in the response, used for paging.
`ShoppingContent.Collections.List`	`setPageToken(String pageToken)` Token (if provided) to retrieve the subsequent page.
`ShoppingContent.Collections.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`ShoppingContent.Collections.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`ShoppingContent.Collections.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`ShoppingContent.Collections.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)
```
    Lists the collections in your Merchant Center account. The response might contain fewer items than specified by page_size. Rely on next_page_token to determine if there are more items to be requested. Create a request for the method "collections.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. This account cannot be a multi-client account.
    
    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<ListCollectionsResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListCollectionsResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public ShoppingContent.Collections.List set$Xgafv(String $Xgafv)
```
    Description copied from class: ShoppingContentRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class ShoppingContentRequest<ListCollectionsResponse>
  - setAccessToken
```
public ShoppingContent.Collections.List setAccessToken(String accessToken)
```
    Description copied from class: ShoppingContentRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class ShoppingContentRequest<ListCollectionsResponse>
  - setAlt
```
public ShoppingContent.Collections.List setAlt(String alt)
```
    Description copied from class: ShoppingContentRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class ShoppingContentRequest<ListCollectionsResponse>
  - setCallback
```
public ShoppingContent.Collections.List setCallback(String callback)
```
    Description copied from class: ShoppingContentRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class ShoppingContentRequest<ListCollectionsResponse>
  - setFields
```
public ShoppingContent.Collections.List setFields(String fields)
```
    Description copied from class: ShoppingContentRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class ShoppingContentRequest<ListCollectionsResponse>
  - setKey
```
public ShoppingContent.Collections.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<ListCollectionsResponse>
  - setOauthToken
```
public ShoppingContent.Collections.List setOauthToken(String oauthToken)
```
    Description copied from class: ShoppingContentRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class ShoppingContentRequest<ListCollectionsResponse>
  - setPrettyPrint
```
public ShoppingContent.Collections.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: ShoppingContentRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class ShoppingContentRequest<ListCollectionsResponse>
  - setQuotaUser
```
public ShoppingContent.Collections.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<ListCollectionsResponse>
  - setUploadType
```
public ShoppingContent.Collections.List setUploadType(String uploadType)
```
    Description copied from class: ShoppingContentRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class ShoppingContentRequest<ListCollectionsResponse>
  - setUploadProtocol
```
public ShoppingContent.Collections.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: ShoppingContentRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class ShoppingContentRequest<ListCollectionsResponse>
  - getMerchantId
```
public Long getMerchantId()
```
    Required. The ID of the account that contains the collection. This account cannot be a multi-client account.
  - setMerchantId
```
public ShoppingContent.Collections.List setMerchantId(Long merchantId)
```
    Required. The ID of the account that contains the collection. This account cannot be a multi-client account.
  - getPageSize
```
public Integer getPageSize()
```
    The maximum number of collections to return in the response, used for paging. Defaults to 50; values above 1000 will be coerced to 1000.
  - setPageSize
```
public ShoppingContent.Collections.List setPageSize(Integer pageSize)
```
    The maximum number of collections to return in the response, used for paging. Defaults to 50; values above 1000 will be coerced to 1000.
  - getPageToken
```
public String getPageToken()
```
    Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.
  - setPageToken
```
public ShoppingContent.Collections.List setPageToken(String pageToken)
```
    Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.
  - set
```
public ShoppingContent.Collections.List set(String parameterName,
                                            Object value)
```
    Overrides:
    
    set in class ShoppingContentRequest<ListCollectionsResponse>

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

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

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getMerchantId

setMerchantId

getPageSize

setPageSize

getPageToken

setPageToken

set