Reference documentation and code samples for the Google Shopping Merchant Reports V1beta Client class BestSellersBrandView.
Fields available for query in best_sellers_brand_view
table.
Best sellers report with top brands. Values are only set for fields requested explicitly in the request's search query.
Generated from protobuf message google.shopping.merchant.reports.v1beta.BestSellersBrandView
Namespace
Google \ Shopping \ Merchant \ Reports \ V1betaMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ report_date |
Google\Type\Date
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. Required in the |
↳ report_granularity |
int
Granularity of the report. The ranking can be done over a week or a month timeframe. Required in the |
↳ report_country_code |
string
Country where the ranking is calculated. Represented in the ISO 3166 format. Required in the |
↳ report_category_id |
int|string
Google product category ID to calculate the ranking for, represented in Google's product taxonomy. Required in the |
↳ id |
string
Google-assigned id of the brand. |
↳ brand |
string
Name of the brand. |
↳ rank |
int|string
Popularity of the brand on Ads and organic surfaces, in the selected category and country, based on the estimated number of units sold. |
↳ previous_rank |
int|string
Popularity rank in the previous week or month. |
↳ relative_demand |
int
Estimated demand in relation to the brand with the highest popularity rank in the same category and country. |
↳ previous_relative_demand |
int
Estimated demand in relation to the brand with the highest popularity rank in the same category and country in the previous week or month. |
↳ relative_demand_change |
int
Change in the estimated demand. Whether it rose, sank or remained flat. |
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.
Required in the SELECT
clause. If a WHERE
condition on report_date
is
not specified in the query, the latest available weekly or monthly report
is returned.
Returns | |
---|---|
Type | Description |
Google\Type\Date|null |
hasReportDate
clearReportDate
setReportDate
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.
Required in the SELECT
clause. If a WHERE
condition on report_date
is
not specified in the query, the latest available weekly or monthly report
is returned.
Parameter | |
---|---|
Name | Description |
var |
Google\Type\Date
|
Returns | |
---|---|
Type | Description |
$this |
getReportGranularity
Granularity of the report. The ranking can be done over a week or a month timeframe.
Required in the SELECT
clause. Condition on report_granularity
is
required in the WHERE
clause.
Returns | |
---|---|
Type | Description |
int |
hasReportGranularity
clearReportGranularity
setReportGranularity
Granularity of the report. The ranking can be done over a week or a month timeframe.
Required in the SELECT
clause. Condition on report_granularity
is
required in the WHERE
clause.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getReportCountryCode
Country where the ranking is calculated. Represented in the ISO 3166 format.
Required in the SELECT
clause. Condition on report_country_code
is
required in the WHERE
clause.
Returns | |
---|---|
Type | Description |
string |
hasReportCountryCode
clearReportCountryCode
setReportCountryCode
Country where the ranking is calculated. Represented in the ISO 3166 format.
Required in the SELECT
clause. Condition on report_country_code
is
required in the WHERE
clause.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getReportCategoryId
Google product category ID to calculate the ranking for, represented in Google's product taxonomy.
Required in the SELECT
clause. If a WHERE
condition on
report_category_id
is not specified in the query, rankings for all
top-level categories are returned.
Returns | |
---|---|
Type | Description |
int|string |
hasReportCategoryId
clearReportCategoryId
setReportCategoryId
Google product category ID to calculate the ranking for, represented in Google's product taxonomy.
Required in the SELECT
clause. If a WHERE
condition on
report_category_id
is not specified in the query, rankings for all
top-level categories are returned.
Parameter | |
---|---|
Name | Description |
var |
int|string
|
Returns | |
---|---|
Type | Description |
$this |
getId
Google-assigned id of the brand.
Returns | |
---|---|
Type | Description |
string |
hasId
clearId
setId
Google-assigned id of the brand.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getBrand
Name of the brand.
Returns | |
---|---|
Type | Description |
string |
hasBrand
clearBrand
setBrand
Name of the brand.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getRank
Popularity of the brand on Ads and organic surfaces, in the selected category and country, based on the estimated number of units sold.
Returns | |
---|---|
Type | Description |
int|string |
hasRank
clearRank
setRank
Popularity of the brand on Ads and organic surfaces, in the selected category and country, based on the estimated number of units sold.
Parameter | |
---|---|
Name | Description |
var |
int|string
|
Returns | |
---|---|
Type | Description |
$this |
getPreviousRank
Popularity rank in the previous week or month.
Returns | |
---|---|
Type | Description |
int|string |
hasPreviousRank
clearPreviousRank
setPreviousRank
Popularity rank in the previous week or month.
Parameter | |
---|---|
Name | Description |
var |
int|string
|
Returns | |
---|---|
Type | Description |
$this |
getRelativeDemand
Estimated demand in relation to the brand with the highest popularity rank in the same category and country.
Returns | |
---|---|
Type | Description |
int |
hasRelativeDemand
clearRelativeDemand
setRelativeDemand
Estimated demand in relation to the brand with the highest popularity rank in the same category and country.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getPreviousRelativeDemand
Estimated demand in relation to the brand with the highest popularity rank in the same category and country in the previous week or month.
Returns | |
---|---|
Type | Description |
int |
hasPreviousRelativeDemand
clearPreviousRelativeDemand
setPreviousRelativeDemand
Estimated demand in relation to the brand with the highest popularity rank in the same category and country in the previous week or month.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getRelativeDemandChange
Change in the estimated demand. Whether it rose, sank or remained flat.
Returns | |
---|---|
Type | Description |
int |
hasRelativeDemandChange
clearRelativeDemandChange
setRelativeDemandChange
Change in the estimated demand. Whether it rose, sank or remained flat.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |