ShoppingContent.Accounts.Labels.List (Content API for Shopping v2.1-rev20201204-1.31.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<ListAccountLabelsResponse>
        
        com.google.api.services.content.ShoppingContent.Accounts.Labels.List

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

Enclosing class:: ShoppingContent.Accounts.Labels

public class ShoppingContent.Accounts.Labels.List
extends ShoppingContentRequest<ListAccountLabelsResponse>

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(Long accountId)
Lists the labels assigned to an account.

Constructors
Modifier	Constructor and Description
`protected`	`List(Long accountId)` Lists the labels assigned to an account.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpRequest`	`buildHttpRequestUsingHead()`
`HttpResponse`	`executeUsingHead()`
`Long`	`getAccountId()` Required.
`Integer`	`getPageSize()` The maximum number of labels to return.
`String`	`getPageToken()` A page token, received from a previous `ListAccountLabels` call.
`ShoppingContent.Accounts.Labels.List`	`set(String parameterName, Object value)`
`ShoppingContent.Accounts.Labels.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`ShoppingContent.Accounts.Labels.List`	`setAccessToken(String accessToken)` OAuth access token.
`ShoppingContent.Accounts.Labels.List`	`setAccountId(Long accountId)` Required.
`ShoppingContent.Accounts.Labels.List`	`setAlt(String alt)` Data format for response.
`ShoppingContent.Accounts.Labels.List`	`setCallback(String callback)` JSONP
`ShoppingContent.Accounts.Labels.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`ShoppingContent.Accounts.Labels.List`	`setKey(String key)` API key.
`ShoppingContent.Accounts.Labels.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`ShoppingContent.Accounts.Labels.List`	`setPageSize(Integer pageSize)` The maximum number of labels to return.
`ShoppingContent.Accounts.Labels.List`	`setPageToken(String pageToken)` A page token, received from a previous `ListAccountLabels` call.
`ShoppingContent.Accounts.Labels.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`ShoppingContent.Accounts.Labels.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`ShoppingContent.Accounts.Labels.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`ShoppingContent.Accounts.Labels.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.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 accountId)
```
    Lists the labels assigned to an account. Create a request for the method "labels.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:
    
    accountId - Required. The account id for whose labels are to be listed.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public HttpResponse executeUsingHead()
                              throws IOException
```
    Overrides:
    
    executeUsingHead in class AbstractGoogleClientRequest<ListAccountLabelsResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class AbstractGoogleClientRequest<ListAccountLabelsResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public ShoppingContent.Accounts.Labels.List set$Xgafv(String $Xgafv)
```
    Description copied from class: ShoppingContentRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class ShoppingContentRequest<ListAccountLabelsResponse>
  - setAccessToken
```
public ShoppingContent.Accounts.Labels.List setAccessToken(String accessToken)
```
    Description copied from class: ShoppingContentRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class ShoppingContentRequest<ListAccountLabelsResponse>
  - setAlt
```
public ShoppingContent.Accounts.Labels.List setAlt(String alt)
```
    Description copied from class: ShoppingContentRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class ShoppingContentRequest<ListAccountLabelsResponse>
  - setCallback
```
public ShoppingContent.Accounts.Labels.List setCallback(String callback)
```
    Description copied from class: ShoppingContentRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class ShoppingContentRequest<ListAccountLabelsResponse>
  - setFields
```
public ShoppingContent.Accounts.Labels.List setFields(String fields)
```
    Description copied from class: ShoppingContentRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class ShoppingContentRequest<ListAccountLabelsResponse>
  - setKey
```
public ShoppingContent.Accounts.Labels.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<ListAccountLabelsResponse>
  - setOauthToken
```
public ShoppingContent.Accounts.Labels.List setOauthToken(String oauthToken)
```
    Description copied from class: ShoppingContentRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class ShoppingContentRequest<ListAccountLabelsResponse>
  - setPrettyPrint
```
public ShoppingContent.Accounts.Labels.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: ShoppingContentRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class ShoppingContentRequest<ListAccountLabelsResponse>
  - setQuotaUser
```
public ShoppingContent.Accounts.Labels.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<ListAccountLabelsResponse>
  - setUploadType
```
public ShoppingContent.Accounts.Labels.List setUploadType(String uploadType)
```
    Description copied from class: ShoppingContentRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class ShoppingContentRequest<ListAccountLabelsResponse>
  - setUploadProtocol
```
public ShoppingContent.Accounts.Labels.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: ShoppingContentRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class ShoppingContentRequest<ListAccountLabelsResponse>
  - getAccountId
```
public Long getAccountId()
```
    Required. The account id for whose labels are to be listed.
  - setAccountId
```
public ShoppingContent.Accounts.Labels.List setAccountId(Long accountId)
```
    Required. The account id for whose labels are to be listed.
  - getPageSize
```
public Integer getPageSize()
```
    The maximum number of labels 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.Accounts.Labels.List setPageSize(Integer pageSize)
```
    The maximum number of labels 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 `ListAccountLabels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountLabels` must match the call that provided the page token.
  - setPageToken
```
public ShoppingContent.Accounts.Labels.List setPageToken(String pageToken)
```
    A page token, received from a previous `ListAccountLabels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountLabels` must match the call that provided the page token.
  - set
```
public ShoppingContent.Accounts.Labels.List set(String parameterName,
                                                Object value)
```
    Overrides:
    
    set in class ShoppingContentRequest<ListAccountLabelsResponse>

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

getAccountId

setAccountId

getPageSize

setPageSize

getPageToken

setPageToken

set