ShoppingContent.Repricingrules.Repricingreports.List (Content API for Shopping v2.1-rev20231105-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<ListRepricingRuleReportsResponse>
        
        com.google.api.services.content.ShoppingContent.Repricingrules.Repricingreports.List

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

Enclosing class:: ShoppingContent.Repricingrules.Repricingreports

public class ShoppingContent.Repricingrules.Repricingreports.List
extends ShoppingContentRequest<ListRepricingRuleReportsResponse>

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, String ruleId)
*Deprecated*: New merchants can't start using this service.

Constructors
Modifier	Constructor and Description
`protected`	`List(Long merchantId, String ruleId)` Deprecated: New merchants can't start using this service.

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()`
`String`	`getEndDate()` Gets Repricing reports on and before this date in the merchant's timezone.
`Long`	`getMerchantId()` Required.
`Integer`	`getPageSize()` Maximum number of daily reports to return.
`String`	`getPageToken()` Token (if provided) to retrieve the subsequent page.
`String`	`getRuleId()` Required.
`String`	`getStartDate()` Gets Repricing reports on and after this date in the merchant's timezone, up to one year ago.
`ShoppingContent.Repricingrules.Repricingreports.List`	`set(String parameterName, Object value)`
`ShoppingContent.Repricingrules.Repricingreports.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`ShoppingContent.Repricingrules.Repricingreports.List`	`setAccessToken(String accessToken)` OAuth access token.
`ShoppingContent.Repricingrules.Repricingreports.List`	`setAlt(String alt)` Data format for response.
`ShoppingContent.Repricingrules.Repricingreports.List`	`setCallback(String callback)` JSONP
`ShoppingContent.Repricingrules.Repricingreports.List`	`setEndDate(String endDate)` Gets Repricing reports on and before this date in the merchant's timezone.
`ShoppingContent.Repricingrules.Repricingreports.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`ShoppingContent.Repricingrules.Repricingreports.List`	`setKey(String key)` API key.
`ShoppingContent.Repricingrules.Repricingreports.List`	`setMerchantId(Long merchantId)` Required.
`ShoppingContent.Repricingrules.Repricingreports.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`ShoppingContent.Repricingrules.Repricingreports.List`	`setPageSize(Integer pageSize)` Maximum number of daily reports to return.
`ShoppingContent.Repricingrules.Repricingreports.List`	`setPageToken(String pageToken)` Token (if provided) to retrieve the subsequent page.
`ShoppingContent.Repricingrules.Repricingreports.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`ShoppingContent.Repricingrules.Repricingreports.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`ShoppingContent.Repricingrules.Repricingreports.List`	`setRuleId(String ruleId)` Required.
`ShoppingContent.Repricingrules.Repricingreports.List`	`setStartDate(String startDate)` Gets Repricing reports on and after this date in the merchant's timezone, up to one year ago.
`ShoppingContent.Repricingrules.Repricingreports.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`ShoppingContent.Repricingrules.Repricingreports.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,
               String ruleId)
```
    *Deprecated*: New merchants can't start using this service. Lists the metrics report for a given Repricing rule. Create a request for the method "repricingreports.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. Id of the merchant who owns the Repricing rule.
    
    ruleId - Required. Id of the Repricing rule.
    
    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<ListRepricingRuleReportsResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListRepricingRuleReportsResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public ShoppingContent.Repricingrules.Repricingreports.List set$Xgafv(String $Xgafv)
```
    Description copied from class: ShoppingContentRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class ShoppingContentRequest<ListRepricingRuleReportsResponse>
  - setAccessToken
```
public ShoppingContent.Repricingrules.Repricingreports.List setAccessToken(String accessToken)
```
    Description copied from class: ShoppingContentRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class ShoppingContentRequest<ListRepricingRuleReportsResponse>
  - setAlt
```
public ShoppingContent.Repricingrules.Repricingreports.List setAlt(String alt)
```
    Description copied from class: ShoppingContentRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class ShoppingContentRequest<ListRepricingRuleReportsResponse>
  - setCallback
```
public ShoppingContent.Repricingrules.Repricingreports.List setCallback(String callback)
```
    Description copied from class: ShoppingContentRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class ShoppingContentRequest<ListRepricingRuleReportsResponse>
  - setFields
```
public ShoppingContent.Repricingrules.Repricingreports.List setFields(String fields)
```
    Description copied from class: ShoppingContentRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class ShoppingContentRequest<ListRepricingRuleReportsResponse>
  - setKey
```
public ShoppingContent.Repricingrules.Repricingreports.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<ListRepricingRuleReportsResponse>
  - setOauthToken
```
public ShoppingContent.Repricingrules.Repricingreports.List setOauthToken(String oauthToken)
```
    Description copied from class: ShoppingContentRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class ShoppingContentRequest<ListRepricingRuleReportsResponse>
  - setPrettyPrint
```
public ShoppingContent.Repricingrules.Repricingreports.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: ShoppingContentRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class ShoppingContentRequest<ListRepricingRuleReportsResponse>
  - setQuotaUser
```
public ShoppingContent.Repricingrules.Repricingreports.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<ListRepricingRuleReportsResponse>
  - setUploadType
```
public ShoppingContent.Repricingrules.Repricingreports.List setUploadType(String uploadType)
```
    Description copied from class: ShoppingContentRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class ShoppingContentRequest<ListRepricingRuleReportsResponse>
  - setUploadProtocol
```
public ShoppingContent.Repricingrules.Repricingreports.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: ShoppingContentRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class ShoppingContentRequest<ListRepricingRuleReportsResponse>
  - getMerchantId
```
public Long getMerchantId()
```
    Required. Id of the merchant who owns the Repricing rule.
  - setMerchantId
```
public ShoppingContent.Repricingrules.Repricingreports.List setMerchantId(Long merchantId)
```
    Required. Id of the merchant who owns the Repricing rule.
  - getRuleId
```
public String getRuleId()
```
    Required. Id of the Repricing rule.
  - setRuleId
```
public ShoppingContent.Repricingrules.Repricingreports.List setRuleId(String ruleId)
```
    Required. Id of the Repricing rule.
  - getEndDate
```
public String getEndDate()
```
    Gets Repricing reports on and before this date in the merchant's timezone. You can only retrieve data up to 7 days ago (default) or earlier. Format: YYYY-MM-DD.
  - setEndDate
```
public ShoppingContent.Repricingrules.Repricingreports.List setEndDate(String endDate)
```
    Gets Repricing reports on and before this date in the merchant's timezone. You can only retrieve data up to 7 days ago (default) or earlier. Format: YYYY-MM-DD.
  - getPageSize
```
public Integer getPageSize()
```
    Maximum number of daily reports to return. Each report includes data from a single 24-hour period. The page size defaults to 50 and values above 1000 are coerced to 1000. This service may return fewer days than this value, for example, if the time between your start and end date is less than page size.
  - setPageSize
```
public ShoppingContent.Repricingrules.Repricingreports.List setPageSize(Integer pageSize)
```
    Maximum number of daily reports to return. Each report includes data from a single 24-hour period. The page size defaults to 50 and values above 1000 are coerced to 1000. This service may return fewer days than this value, for example, if the time between your start and end date is less than page size.
  - 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.Repricingrules.Repricingreports.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.
  - getStartDate
```
public String getStartDate()
```
    Gets Repricing reports on and after this date in the merchant's timezone, up to one year ago. Do not use a start date later than 7 days ago (default). Format: YYYY-MM-DD.
  - setStartDate
```
public ShoppingContent.Repricingrules.Repricingreports.List setStartDate(String startDate)
```
    Gets Repricing reports on and after this date in the merchant's timezone, up to one year ago. Do not use a start date later than 7 days ago (default). Format: YYYY-MM-DD.
  - set
```
public ShoppingContent.Repricingrules.Repricingreports.List set(String parameterName,
                                                                Object value)
```
    Overrides:
    
    set in class ShoppingContentRequest<ListRepricingRuleReportsResponse>

Class ShoppingContent.Repricingrules.Repricingreports.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

getRuleId

setRuleId

getEndDate

setEndDate

getPageSize

setPageSize

getPageToken

setPageToken

getStartDate

setStartDate

set