target.apidocs.com.google.api.services.content.model.BestSellers.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-content Show documentation

There is a newer version: v2.1-rev20241217-2.0.0

Show newest version







BestSellers (Content API for Shopping v2.1-rev20240609-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.content.model
Class BestSellers



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.content.model.BestSellers













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




public final class BestSellers
extends com.google.api.client.json.GenericJson
Fields related to the [Best sellers
 reports](https://support.google.com/merchants/answer/9488679).

  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 transmitted over HTTP when working with the Content API for Shopping. For a detailed explanation
 see:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












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>








Constructor Summary

Constructors 

Constructor and Description


BestSellers() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


BestSellers
clone() 


Long
getCategoryId()
Google product category ID to calculate the ranking for, represented in [Google's product
 taxonomy](https://support.google.com/merchants/answer/6324436).



String
getCountryCode()
Country where the ranking is calculated.



Long
getPreviousRank()
Popularity rank in the previous week or month.



String
getPreviousRelativeDemand()
Estimated demand in relation to the item with the highest popularity rank in the same category
 and country in the previous week or month.



Long
getRank()
Popularity on Shopping ads and free listings, in the selected category and country, based on
 the estimated number of units sold.



String
getRelativeDemand()
Estimated demand in relation to the item with the highest popularity rank in the same category
 and country.



String
getRelativeDemandChange()
Change in the estimated demand.



Date
getReportDate()
Report date.



String
getReportGranularity()
Granularity of the report.



BestSellers
set(String fieldName,
   Object value) 


BestSellers
setCategoryId(Long categoryId)
Google product category ID to calculate the ranking for, represented in [Google's product
 taxonomy](https://support.google.com/merchants/answer/6324436).



BestSellers
setCountryCode(String countryCode)
Country where the ranking is calculated.



BestSellers
setPreviousRank(Long previousRank)
Popularity rank in the previous week or month.



BestSellers
setPreviousRelativeDemand(String previousRelativeDemand)
Estimated demand in relation to the item with the highest popularity rank in the same category
 and country in the previous week or month.



BestSellers
setRank(Long rank)
Popularity on Shopping ads and free listings, in the selected category and country, based on
 the estimated number of units sold.



BestSellers
setRelativeDemand(String relativeDemand)
Estimated demand in relation to the item with the highest popularity rank in the same category
 and country.



BestSellers
setRelativeDemandChange(String relativeDemandChange)
Change in the estimated demand.



BestSellers
setReportDate(Date reportDate)
Report date.



BestSellers
setReportGranularity(String reportGranularity)
Granularity of the report.







Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString





Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





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





BestSellers
public BestSellers()









Method Detail





getCategoryId
public Long getCategoryId()
Google product category ID to calculate the ranking for, represented in [Google's product
 taxonomy](https://support.google.com/merchants/answer/6324436). If a `WHERE` condition on
 `best_sellers.category_id` is not specified in the query, rankings for all top-level categories
 are returned.

Returns:
value or null for none








setCategoryId
public BestSellers setCategoryId(Long categoryId)
Google product category ID to calculate the ranking for, represented in [Google's product
 taxonomy](https://support.google.com/merchants/answer/6324436). If a `WHERE` condition on
 `best_sellers.category_id` is not specified in the query, rankings for all top-level categories
 are returned.

Parameters:
categoryId - categoryId or null for none








getCountryCode
public String getCountryCode()
Country where the ranking is calculated. A `WHERE` condition on `best_sellers.country_code` is
 required in the query.

Returns:
value or null for none








setCountryCode
public BestSellers setCountryCode(String countryCode)
Country where the ranking is calculated. A `WHERE` condition on `best_sellers.country_code` is
 required in the query.

Parameters:
countryCode - countryCode or null for none








getPreviousRank
public Long getPreviousRank()
Popularity rank in the previous week or month.

Returns:
value or null for none








setPreviousRank
public BestSellers setPreviousRank(Long previousRank)
Popularity rank in the previous week or month.

Parameters:
previousRank - previousRank or null for none








getPreviousRelativeDemand
public String getPreviousRelativeDemand()
Estimated demand in relation to the item with the highest popularity rank in the same category
 and country in the previous week or month.

Returns:
value or null for none








setPreviousRelativeDemand
public BestSellers setPreviousRelativeDemand(String previousRelativeDemand)
Estimated demand in relation to the item with the highest popularity rank in the same category
 and country in the previous week or month.

Parameters:
previousRelativeDemand - previousRelativeDemand or null for none








getRank
public Long getRank()
Popularity on Shopping ads and free listings, in the selected category and country, based on
 the estimated number of units sold.

Returns:
value or null for none








setRank
public BestSellers setRank(Long rank)
Popularity on Shopping ads and free listings, in the selected category and country, based on
 the estimated number of units sold.

Parameters:
rank - rank or null for none








getRelativeDemand
public String getRelativeDemand()
Estimated demand in relation to the item with the highest popularity rank in the same category
 and country.

Returns:
value or null for none








setRelativeDemand
public BestSellers setRelativeDemand(String relativeDemand)
Estimated demand in relation to the item with the highest popularity rank in the same category
 and country.

Parameters:
relativeDemand - relativeDemand or null for none








getRelativeDemandChange
public String getRelativeDemandChange()
Change in the estimated demand. Whether it rose, sank or remained flat.

Returns:
value or null for none








setRelativeDemandChange
public BestSellers setRelativeDemandChange(String relativeDemandChange)
Change in the estimated demand. Whether it rose, sank or remained flat.

Parameters:
relativeDemandChange - relativeDemandChange or null for none








getReportDate
public Date getReportDate()
Report date. The value of this field can only be one of the following: * The first day of the
 week (Monday) for weekly reports. * The first day of the month for monthly reports. If a
 `WHERE` condition on `best_sellers.report_date` is not specified in the query, the latest
 available weekly or monthly report is returned.

Returns:
value or null for none








setReportDate
public BestSellers setReportDate(Date reportDate)
Report date. The value of this field can only be one of the following: * The first day of the
 week (Monday) for weekly reports. * The first day of the month for monthly reports. If a
 `WHERE` condition on `best_sellers.report_date` is not specified in the query, the latest
 available weekly or monthly report is returned.

Parameters:
reportDate - reportDate or null for none








getReportGranularity
public String getReportGranularity()
Granularity of the report. The ranking can be done over a week or a month timeframe. A `WHERE`
 condition on `best_sellers.report_granularity` is required in the query.

Returns:
value or null for none








setReportGranularity
public BestSellers setReportGranularity(String reportGranularity)
Granularity of the report. The ranking can be done over a week or a month timeframe. A `WHERE`
 condition on `best_sellers.report_granularity` is required in the query.

Parameters:
reportGranularity - reportGranularity or null for none








set
public BestSellers set(String fieldName,
                       Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public BestSellers clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Method and Description
`BestSellers`	`clone()`
`Long`	`getCategoryId()` Google product category ID to calculate the ranking for, represented in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).
`String`	`getCountryCode()` Country where the ranking is calculated.
`Long`	`getPreviousRank()` Popularity rank in the previous week or month.
`String`	`getPreviousRelativeDemand()` Estimated demand in relation to the item with the highest popularity rank in the same category and country in the previous week or month.
`Long`	`getRank()` Popularity on Shopping ads and free listings, in the selected category and country, based on the estimated number of units sold.
`String`	`getRelativeDemand()` Estimated demand in relation to the item with the highest popularity rank in the same category and country.
`String`	`getRelativeDemandChange()` Change in the estimated demand.
`Date`	`getReportDate()` Report date.
`String`	`getReportGranularity()` Granularity of the report.
`BestSellers`	`set(String fieldName, Object value)`
`BestSellers`	`setCategoryId(Long categoryId)` Google product category ID to calculate the ranking for, represented in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).
`BestSellers`	`setCountryCode(String countryCode)` Country where the ranking is calculated.
`BestSellers`	`setPreviousRank(Long previousRank)` Popularity rank in the previous week or month.
`BestSellers`	`setPreviousRelativeDemand(String previousRelativeDemand)` Estimated demand in relation to the item with the highest popularity rank in the same category and country in the previous week or month.
`BestSellers`	`setRank(Long rank)` Popularity on Shopping ads and free listings, in the selected category and country, based on the estimated number of units sold.
`BestSellers`	`setRelativeDemand(String relativeDemand)` Estimated demand in relation to the item with the highest popularity rank in the same category and country.
`BestSellers`	`setRelativeDemandChange(String relativeDemandChange)` Change in the estimated demand.
`BestSellers`	`setReportDate(Date reportDate)` Report date.
`BestSellers`	`setReportGranularity(String reportGranularity)` Granularity of the report.