- 1.6.0 (latest)
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
- 0.46.0
- 0.44.0
- 0.43.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
public interface BestSellersProductClusterViewOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getBrand()
public abstract String getBrand()Brand of the product cluster.
optional string brand = 7;
| Returns | |
|---|---|
| Type | Description |
String |
The brand. |
getBrandBytes()
public abstract ByteString getBrandBytes()Brand of the product cluster.
optional string brand = 7;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for brand. |
getBrandInventoryStatus()
public abstract BestSellersProductClusterView.InventoryStatus getBrandInventoryStatus() Whether there is at least one product of the brand currently IN_STOCK in
your product feed in at least one of the countries, all products are
OUT_OF_STOCK in your product feed in all countries, or
NOT_IN_INVENTORY.
The field doesn't take the Best sellers report country filter into account.
optional .google.shopping.merchant.reports.v1beta.BestSellersProductClusterView.InventoryStatus brand_inventory_status = 15;
| Returns | |
|---|---|
| Type | Description |
BestSellersProductClusterView.InventoryStatus |
The brandInventoryStatus. |
getBrandInventoryStatusValue()
public abstract int getBrandInventoryStatusValue() Whether there is at least one product of the brand currently IN_STOCK in
your product feed in at least one of the countries, all products are
OUT_OF_STOCK in your product feed in all countries, or
NOT_IN_INVENTORY.
The field doesn't take the Best sellers report country filter into account.
optional .google.shopping.merchant.reports.v1beta.BestSellersProductClusterView.InventoryStatus brand_inventory_status = 15;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for brandInventoryStatus. |
getCategoryL1()
public abstract String getCategoryL1()Product category (1st level) of the product cluster, represented in Google's product taxonomy.
optional string category_l1 = 8;
| Returns | |
|---|---|
| Type | Description |
String |
The categoryL1. |
getCategoryL1Bytes()
public abstract ByteString getCategoryL1Bytes()Product category (1st level) of the product cluster, represented in Google's product taxonomy.
optional string category_l1 = 8;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for categoryL1. |
getCategoryL2()
public abstract String getCategoryL2()Product category (2nd level) of the product cluster, represented in Google's product taxonomy.
optional string category_l2 = 9;
| Returns | |
|---|---|
| Type | Description |
String |
The categoryL2. |
getCategoryL2Bytes()
public abstract ByteString getCategoryL2Bytes()Product category (2nd level) of the product cluster, represented in Google's product taxonomy.
optional string category_l2 = 9;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for categoryL2. |
getCategoryL3()
public abstract String getCategoryL3()Product category (3rd level) of the product cluster, represented in Google's product taxonomy.
optional string category_l3 = 10;
| Returns | |
|---|---|
| Type | Description |
String |
The categoryL3. |
getCategoryL3Bytes()
public abstract ByteString getCategoryL3Bytes()Product category (3rd level) of the product cluster, represented in Google's product taxonomy.
optional string category_l3 = 10;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for categoryL3. |
getCategoryL4()
public abstract String getCategoryL4()Product category (4th level) of the product cluster, represented in Google's product taxonomy.
optional string category_l4 = 11;
| Returns | |
|---|---|
| Type | Description |
String |
The categoryL4. |
getCategoryL4Bytes()
public abstract ByteString getCategoryL4Bytes()Product category (4th level) of the product cluster, represented in Google's product taxonomy.
optional string category_l4 = 11;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for categoryL4. |
getCategoryL5()
public abstract String getCategoryL5()Product category (5th level) of the product cluster, represented in Google's product taxonomy.
optional string category_l5 = 12;
| Returns | |
|---|---|
| Type | Description |
String |
The categoryL5. |
getCategoryL5Bytes()
public abstract ByteString getCategoryL5Bytes()Product category (5th level) of the product cluster, represented in Google's product taxonomy.
optional string category_l5 = 12;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for categoryL5. |
getInventoryStatus()
public abstract BestSellersProductClusterView.InventoryStatus getInventoryStatus() Whether the product cluster is IN_STOCK in your product feed in at least
one of the countries, OUT_OF_STOCK in your product feed in all countries,
or NOT_IN_INVENTORY at all.
The field doesn't take the Best sellers report country filter into account.
optional .google.shopping.merchant.reports.v1beta.BestSellersProductClusterView.InventoryStatus inventory_status = 14;
| Returns | |
|---|---|
| Type | Description |
BestSellersProductClusterView.InventoryStatus |
The inventoryStatus. |
getInventoryStatusValue()
public abstract int getInventoryStatusValue() Whether the product cluster is IN_STOCK in your product feed in at least
one of the countries, OUT_OF_STOCK in your product feed in all countries,
or NOT_IN_INVENTORY at all.
The field doesn't take the Best sellers report country filter into account.
optional .google.shopping.merchant.reports.v1beta.BestSellersProductClusterView.InventoryStatus inventory_status = 14;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for inventoryStatus. |
getPreviousRank()
public abstract long getPreviousRank()Popularity rank in the previous week or month.
optional int64 previous_rank = 17;
| Returns | |
|---|---|
| Type | Description |
long |
The previousRank. |
getPreviousRelativeDemand()
public abstract RelativeDemand.RelativeDemandEnum getPreviousRelativeDemand()Estimated demand in relation to the product cluster with the highest popularity rank in the same category and country in the previous week or month.
optional .google.shopping.merchant.reports.v1beta.RelativeDemand.RelativeDemandEnum previous_relative_demand = 19;
| Returns | |
|---|---|
| Type | Description |
RelativeDemand.RelativeDemandEnum |
The previousRelativeDemand. |
getPreviousRelativeDemandValue()
public abstract int getPreviousRelativeDemandValue()Estimated demand in relation to the product cluster with the highest popularity rank in the same category and country in the previous week or month.
optional .google.shopping.merchant.reports.v1beta.RelativeDemand.RelativeDemandEnum previous_relative_demand = 19;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for previousRelativeDemand. |
getRank()
public abstract long getRank()Popularity of the product cluster on Ads and organic surfaces, in the selected category and country, based on the estimated number of units sold.
optional int64 rank = 16;
| Returns | |
|---|---|
| Type | Description |
long |
The rank. |
getRelativeDemand()
public abstract RelativeDemand.RelativeDemandEnum getRelativeDemand()Estimated demand in relation to the product cluster with the highest popularity rank in the same category and country.
optional .google.shopping.merchant.reports.v1beta.RelativeDemand.RelativeDemandEnum relative_demand = 18;
| Returns | |
|---|---|
| Type | Description |
RelativeDemand.RelativeDemandEnum |
The relativeDemand. |
getRelativeDemandChange()
public abstract RelativeDemandChangeType.RelativeDemandChangeTypeEnum getRelativeDemandChange()Change in the estimated demand. Whether it rose, sank or remained flat.
optional .google.shopping.merchant.reports.v1beta.RelativeDemandChangeType.RelativeDemandChangeTypeEnum relative_demand_change = 20;
| Returns | |
|---|---|
| Type | Description |
RelativeDemandChangeType.RelativeDemandChangeTypeEnum |
The relativeDemandChange. |
getRelativeDemandChangeValue()
public abstract int getRelativeDemandChangeValue()Change in the estimated demand. Whether it rose, sank or remained flat.
optional .google.shopping.merchant.reports.v1beta.RelativeDemandChangeType.RelativeDemandChangeTypeEnum relative_demand_change = 20;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for relativeDemandChange. |
getRelativeDemandValue()
public abstract int getRelativeDemandValue()Estimated demand in relation to the product cluster with the highest popularity rank in the same category and country.
optional .google.shopping.merchant.reports.v1beta.RelativeDemand.RelativeDemandEnum relative_demand = 18;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for relativeDemand. |
getReportCategoryId()
public abstract long 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.
optional int64 report_category_id = 4;
| Returns | |
|---|---|
| Type | Description |
long |
The reportCategoryId. |
getReportCountryCode()
public abstract String 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.
optional string report_country_code = 3;
| Returns | |
|---|---|
| Type | Description |
String |
The reportCountryCode. |
getReportCountryCodeBytes()
public abstract ByteString getReportCountryCodeBytes()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.
optional string report_country_code = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for reportCountryCode. |
getReportDate()
public abstract 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.
Required in the
SELECTclause. If aWHEREcondition onreport_dateis not specified in the query, the latest available weekly or monthly report is returned.
.google.type.Date report_date = 1;
| Returns | |
|---|---|
| Type | Description |
com.google.type.Date |
The reportDate. |
getReportDateOrBuilder()
public abstract DateOrBuilder getReportDateOrBuilder()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
SELECTclause. If aWHEREcondition onreport_dateis not specified in the query, the latest available weekly or monthly report is returned.
.google.type.Date report_date = 1;
| Returns | |
|---|---|
| Type | Description |
com.google.type.DateOrBuilder |
|
getReportGranularity()
public abstract ReportGranularity.ReportGranularityEnum 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.
optional .google.shopping.merchant.reports.v1beta.ReportGranularity.ReportGranularityEnum report_granularity = 2;
| Returns | |
|---|---|
| Type | Description |
ReportGranularity.ReportGranularityEnum |
The reportGranularity. |
getReportGranularityValue()
public abstract int getReportGranularityValue()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.
optional .google.shopping.merchant.reports.v1beta.ReportGranularity.ReportGranularityEnum report_granularity = 2;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for reportGranularity. |
getTitle()
public abstract String getTitle()Title of the product cluster.
optional string title = 6;
| Returns | |
|---|---|
| Type | Description |
String |
The title. |
getTitleBytes()
public abstract ByteString getTitleBytes()Title of the product cluster.
optional string title = 6;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for title. |
getVariantGtins(int index)
public abstract String getVariantGtins(int index)GTINs of example variants of the product cluster.
repeated string variant_gtins = 13;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The variantGtins at the given index. |
getVariantGtinsBytes(int index)
public abstract ByteString getVariantGtinsBytes(int index)GTINs of example variants of the product cluster.
repeated string variant_gtins = 13;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the variantGtins at the given index. |
getVariantGtinsCount()
public abstract int getVariantGtinsCount()GTINs of example variants of the product cluster.
repeated string variant_gtins = 13;
| Returns | |
|---|---|
| Type | Description |
int |
The count of variantGtins. |
getVariantGtinsList()
public abstract List<String> getVariantGtinsList()GTINs of example variants of the product cluster.
repeated string variant_gtins = 13;
| Returns | |
|---|---|
| Type | Description |
List<String> |
A list containing the variantGtins. |
hasBrand()
public abstract boolean hasBrand()Brand of the product cluster.
optional string brand = 7;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the brand field is set. |
hasBrandInventoryStatus()
public abstract boolean hasBrandInventoryStatus() Whether there is at least one product of the brand currently IN_STOCK in
your product feed in at least one of the countries, all products are
OUT_OF_STOCK in your product feed in all countries, or
NOT_IN_INVENTORY.
The field doesn't take the Best sellers report country filter into account.
optional .google.shopping.merchant.reports.v1beta.BestSellersProductClusterView.InventoryStatus brand_inventory_status = 15;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the brandInventoryStatus field is set. |
hasCategoryL1()
public abstract boolean hasCategoryL1()Product category (1st level) of the product cluster, represented in Google's product taxonomy.
optional string category_l1 = 8;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the categoryL1 field is set. |
hasCategoryL2()
public abstract boolean hasCategoryL2()Product category (2nd level) of the product cluster, represented in Google's product taxonomy.
optional string category_l2 = 9;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the categoryL2 field is set. |
hasCategoryL3()
public abstract boolean hasCategoryL3()Product category (3rd level) of the product cluster, represented in Google's product taxonomy.
optional string category_l3 = 10;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the categoryL3 field is set. |
hasCategoryL4()
public abstract boolean hasCategoryL4()Product category (4th level) of the product cluster, represented in Google's product taxonomy.
optional string category_l4 = 11;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the categoryL4 field is set. |
hasCategoryL5()
public abstract boolean hasCategoryL5()Product category (5th level) of the product cluster, represented in Google's product taxonomy.
optional string category_l5 = 12;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the categoryL5 field is set. |
hasInventoryStatus()
public abstract boolean hasInventoryStatus() Whether the product cluster is IN_STOCK in your product feed in at least
one of the countries, OUT_OF_STOCK in your product feed in all countries,
or NOT_IN_INVENTORY at all.
The field doesn't take the Best sellers report country filter into account.
optional .google.shopping.merchant.reports.v1beta.BestSellersProductClusterView.InventoryStatus inventory_status = 14;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the inventoryStatus field is set. |
hasPreviousRank()
public abstract boolean hasPreviousRank()Popularity rank in the previous week or month.
optional int64 previous_rank = 17;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the previousRank field is set. |
hasPreviousRelativeDemand()
public abstract boolean hasPreviousRelativeDemand()Estimated demand in relation to the product cluster with the highest popularity rank in the same category and country in the previous week or month.
optional .google.shopping.merchant.reports.v1beta.RelativeDemand.RelativeDemandEnum previous_relative_demand = 19;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the previousRelativeDemand field is set. |
hasRank()
public abstract boolean hasRank()Popularity of the product cluster on Ads and organic surfaces, in the selected category and country, based on the estimated number of units sold.
optional int64 rank = 16;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the rank field is set. |
hasRelativeDemand()
public abstract boolean hasRelativeDemand()Estimated demand in relation to the product cluster with the highest popularity rank in the same category and country.
optional .google.shopping.merchant.reports.v1beta.RelativeDemand.RelativeDemandEnum relative_demand = 18;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the relativeDemand field is set. |
hasRelativeDemandChange()
public abstract boolean hasRelativeDemandChange()Change in the estimated demand. Whether it rose, sank or remained flat.
optional .google.shopping.merchant.reports.v1beta.RelativeDemandChangeType.RelativeDemandChangeTypeEnum relative_demand_change = 20;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the relativeDemandChange field is set. |
hasReportCategoryId()
public abstract boolean hasReportCategoryId()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.
optional int64 report_category_id = 4;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the reportCategoryId field is set. |
hasReportCountryCode()
public abstract boolean hasReportCountryCode()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.
optional string report_country_code = 3;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the reportCountryCode field is set. |
hasReportDate()
public abstract boolean hasReportDate()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
SELECTclause. If aWHEREcondition onreport_dateis not specified in the query, the latest available weekly or monthly report is returned.
.google.type.Date report_date = 1;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the reportDate field is set. |
hasReportGranularity()
public abstract boolean hasReportGranularity()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.
optional .google.shopping.merchant.reports.v1beta.ReportGranularity.ReportGranularityEnum report_granularity = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the reportGranularity field is set. |
hasTitle()
public abstract boolean hasTitle()Title of the product cluster.
optional string title = 6;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the title field is set. |