Class BestSellersProductClusterView.Builder (0.22.0)

public static final class BestSellersProductClusterView.Builder extends GeneratedMessageV3.Builder<BestSellersProductClusterView.Builder> implements BestSellersProductClusterViewOrBuilder

Fields available for query in best_sellers_product_cluster_view table.

Best sellers report with top product clusters. A product cluster is a grouping for different offers and variants that represent the same product, for example, Google Pixel 7.

Values are only set for fields requested explicitly in the request's search query.

Protobuf type google.shopping.merchant.reports.v1beta.BestSellersProductClusterView

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllVariantGtins(Iterable<String> values)

public BestSellersProductClusterView.Builder addAllVariantGtins(Iterable<String> values)

GTINs of example variants of the product cluster.

repeated string variant_gtins = 13;

Parameter
Name Description
values Iterable<String>

The variantGtins to add.

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BestSellersProductClusterView.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BestSellersProductClusterView.Builder
Overrides

addVariantGtins(String value)

public BestSellersProductClusterView.Builder addVariantGtins(String value)

GTINs of example variants of the product cluster.

repeated string variant_gtins = 13;

Parameter
Name Description
value String

The variantGtins to add.

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

addVariantGtinsBytes(ByteString value)

public BestSellersProductClusterView.Builder addVariantGtinsBytes(ByteString value)

GTINs of example variants of the product cluster.

repeated string variant_gtins = 13;

Parameter
Name Description
value ByteString

The bytes of the variantGtins to add.

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

build()

public BestSellersProductClusterView build()
Returns
Type Description
BestSellersProductClusterView

buildPartial()

public BestSellersProductClusterView buildPartial()
Returns
Type Description
BestSellersProductClusterView

clear()

public BestSellersProductClusterView.Builder clear()
Returns
Type Description
BestSellersProductClusterView.Builder
Overrides

clearBrand()

public BestSellersProductClusterView.Builder clearBrand()

Brand of the product cluster.

optional string brand = 7;

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

clearBrandInventoryStatus()

public BestSellersProductClusterView.Builder clearBrandInventoryStatus()

Whether there is at least one product of the brand currently IN_STOCK in your product data source in at least one of the countries, all products are OUT_OF_STOCK in your product data source 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.Builder

This builder for chaining.

clearCategoryL1()

public BestSellersProductClusterView.Builder clearCategoryL1()

Product category (1st level) of the product cluster, represented in Google's product taxonomy.

optional string category_l1 = 8;

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

clearCategoryL2()

public BestSellersProductClusterView.Builder clearCategoryL2()

Product category (2nd level) of the product cluster, represented in Google's product taxonomy.

optional string category_l2 = 9;

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

clearCategoryL3()

public BestSellersProductClusterView.Builder clearCategoryL3()

Product category (3rd level) of the product cluster, represented in Google's product taxonomy.

optional string category_l3 = 10;

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

clearCategoryL4()

public BestSellersProductClusterView.Builder clearCategoryL4()

Product category (4th level) of the product cluster, represented in Google's product taxonomy.

optional string category_l4 = 11;

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

clearCategoryL5()

public BestSellersProductClusterView.Builder clearCategoryL5()

Product category (5th level) of the product cluster, represented in Google's product taxonomy.

optional string category_l5 = 12;

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public BestSellersProductClusterView.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
BestSellersProductClusterView.Builder
Overrides

clearInventoryStatus()

public BestSellersProductClusterView.Builder clearInventoryStatus()

Whether the product cluster is IN_STOCK in your product data source in at least one of the countries, OUT_OF_STOCK in your product data source 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.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public BestSellersProductClusterView.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
BestSellersProductClusterView.Builder
Overrides

clearPreviousRank()

public BestSellersProductClusterView.Builder clearPreviousRank()

Popularity rank in the previous week or month.

optional int64 previous_rank = 17;

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

clearPreviousRelativeDemand()

public BestSellersProductClusterView.Builder clearPreviousRelativeDemand()

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
BestSellersProductClusterView.Builder

This builder for chaining.

clearRank()

public BestSellersProductClusterView.Builder clearRank()

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
BestSellersProductClusterView.Builder

This builder for chaining.

clearRelativeDemand()

public BestSellersProductClusterView.Builder clearRelativeDemand()

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
BestSellersProductClusterView.Builder

This builder for chaining.

clearRelativeDemandChange()

public BestSellersProductClusterView.Builder clearRelativeDemandChange()

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
BestSellersProductClusterView.Builder

This builder for chaining.

clearReportCategoryId()

public BestSellersProductClusterView.Builder clearReportCategoryId()

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
BestSellersProductClusterView.Builder

This builder for chaining.

clearReportCountryCode()

public BestSellersProductClusterView.Builder clearReportCountryCode()

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
BestSellersProductClusterView.Builder

This builder for chaining.

clearReportDate()

public BestSellersProductClusterView.Builder clearReportDate()

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.

.google.type.Date report_date = 1;

Returns
Type Description
BestSellersProductClusterView.Builder

clearReportGranularity()

public BestSellersProductClusterView.Builder clearReportGranularity()

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
BestSellersProductClusterView.Builder

This builder for chaining.

clearTitle()

public BestSellersProductClusterView.Builder clearTitle()

Title of the product cluster.

optional string title = 6;

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

clearVariantGtins()

public BestSellersProductClusterView.Builder clearVariantGtins()

GTINs of example variants of the product cluster.

repeated string variant_gtins = 13;

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

clone()

public BestSellersProductClusterView.Builder clone()
Returns
Type Description
BestSellersProductClusterView.Builder
Overrides

getBrand()

public String getBrand()

Brand of the product cluster.

optional string brand = 7;

Returns
Type Description
String

The brand.

getBrandBytes()

public ByteString getBrandBytes()

Brand of the product cluster.

optional string brand = 7;

Returns
Type Description
ByteString

The bytes for brand.

getBrandInventoryStatus()

public BestSellersProductClusterView.InventoryStatus getBrandInventoryStatus()

Whether there is at least one product of the brand currently IN_STOCK in your product data source in at least one of the countries, all products are OUT_OF_STOCK in your product data source 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 int getBrandInventoryStatusValue()

Whether there is at least one product of the brand currently IN_STOCK in your product data source in at least one of the countries, all products are OUT_OF_STOCK in your product data source 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 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 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 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 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 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 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 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 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 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 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.

getDefaultInstanceForType()

public BestSellersProductClusterView getDefaultInstanceForType()
Returns
Type Description
BestSellersProductClusterView

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getInventoryStatus()

public BestSellersProductClusterView.InventoryStatus getInventoryStatus()

Whether the product cluster is IN_STOCK in your product data source in at least one of the countries, OUT_OF_STOCK in your product data source 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 int getInventoryStatusValue()

Whether the product cluster is IN_STOCK in your product data source in at least one of the countries, OUT_OF_STOCK in your product data source 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 long getPreviousRank()

Popularity rank in the previous week or month.

optional int64 previous_rank = 17;

Returns
Type Description
long

The previousRank.

getPreviousRelativeDemand()

public 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 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 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 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 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 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 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 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 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 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 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 SELECT clause. If a WHERE condition on report_date is 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.

getReportDateBuilder()

public Date.Builder getReportDateBuilder()

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.

.google.type.Date report_date = 1;

Returns
Type Description
com.google.type.Date.Builder

getReportDateOrBuilder()

public 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 SELECT clause. If a WHERE condition on report_date is 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 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 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 String getTitle()

Title of the product cluster.

optional string title = 6;

Returns
Type Description
String

The title.

getTitleBytes()

public ByteString getTitleBytes()

Title of the product cluster.

optional string title = 6;

Returns
Type Description
ByteString

The bytes for title.

getVariantGtins(int index)

public String getVariantGtins(int index)

GTINs of example variants of the product cluster.

repeated string variant_gtins = 13;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The variantGtins at the given index.

getVariantGtinsBytes(int index)

public ByteString getVariantGtinsBytes(int index)

GTINs of example variants of the product cluster.

repeated string variant_gtins = 13;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the variantGtins at the given index.

getVariantGtinsCount()

public 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 ProtocolStringList getVariantGtinsList()

GTINs of example variants of the product cluster.

repeated string variant_gtins = 13;

Returns
Type Description
ProtocolStringList

A list containing the variantGtins.

hasBrand()

public boolean hasBrand()

Brand of the product cluster.

optional string brand = 7;

Returns
Type Description
boolean

Whether the brand field is set.

hasBrandInventoryStatus()

public boolean hasBrandInventoryStatus()

Whether there is at least one product of the brand currently IN_STOCK in your product data source in at least one of the countries, all products are OUT_OF_STOCK in your product data source 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 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 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 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 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 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 boolean hasInventoryStatus()

Whether the product cluster is IN_STOCK in your product data source in at least one of the countries, OUT_OF_STOCK in your product data source 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 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 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 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 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 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 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 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 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 SELECT clause. If a WHERE condition on report_date is 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 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 boolean hasTitle()

Title of the product cluster.

optional string title = 6;

Returns
Type Description
boolean

Whether the title field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BestSellersProductClusterView.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BestSellersProductClusterView.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public BestSellersProductClusterView.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
BestSellersProductClusterView.Builder
Overrides

mergeFrom(BestSellersProductClusterView other)

public BestSellersProductClusterView.Builder mergeFrom(BestSellersProductClusterView other)
Parameter
Name Description
other BestSellersProductClusterView
Returns
Type Description
BestSellersProductClusterView.Builder

mergeReportDate(Date value)

public BestSellersProductClusterView.Builder mergeReportDate(Date value)

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.

.google.type.Date report_date = 1;

Parameter
Name Description
value com.google.type.Date
Returns
Type Description
BestSellersProductClusterView.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BestSellersProductClusterView.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BestSellersProductClusterView.Builder
Overrides

setBrand(String value)

public BestSellersProductClusterView.Builder setBrand(String value)

Brand of the product cluster.

optional string brand = 7;

Parameter
Name Description
value String

The brand to set.

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

setBrandBytes(ByteString value)

public BestSellersProductClusterView.Builder setBrandBytes(ByteString value)

Brand of the product cluster.

optional string brand = 7;

Parameter
Name Description
value ByteString

The bytes for brand to set.

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

setBrandInventoryStatus(BestSellersProductClusterView.InventoryStatus value)

public BestSellersProductClusterView.Builder setBrandInventoryStatus(BestSellersProductClusterView.InventoryStatus value)

Whether there is at least one product of the brand currently IN_STOCK in your product data source in at least one of the countries, all products are OUT_OF_STOCK in your product data source 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;

Parameter
Name Description
value BestSellersProductClusterView.InventoryStatus

The brandInventoryStatus to set.

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

setBrandInventoryStatusValue(int value)

public BestSellersProductClusterView.Builder setBrandInventoryStatusValue(int value)

Whether there is at least one product of the brand currently IN_STOCK in your product data source in at least one of the countries, all products are OUT_OF_STOCK in your product data source 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;

Parameter
Name Description
value int

The enum numeric value on the wire for brandInventoryStatus to set.

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

setCategoryL1(String value)

public BestSellersProductClusterView.Builder setCategoryL1(String value)

Product category (1st level) of the product cluster, represented in Google's product taxonomy.

optional string category_l1 = 8;

Parameter
Name Description
value String

The categoryL1 to set.

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

setCategoryL1Bytes(ByteString value)

public BestSellersProductClusterView.Builder setCategoryL1Bytes(ByteString value)

Product category (1st level) of the product cluster, represented in Google's product taxonomy.

optional string category_l1 = 8;

Parameter
Name Description
value ByteString

The bytes for categoryL1 to set.

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

setCategoryL2(String value)

public BestSellersProductClusterView.Builder setCategoryL2(String value)

Product category (2nd level) of the product cluster, represented in Google's product taxonomy.

optional string category_l2 = 9;

Parameter
Name Description
value String

The categoryL2 to set.

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

setCategoryL2Bytes(ByteString value)

public BestSellersProductClusterView.Builder setCategoryL2Bytes(ByteString value)

Product category (2nd level) of the product cluster, represented in Google's product taxonomy.

optional string category_l2 = 9;

Parameter
Name Description
value ByteString

The bytes for categoryL2 to set.

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

setCategoryL3(String value)

public BestSellersProductClusterView.Builder setCategoryL3(String value)

Product category (3rd level) of the product cluster, represented in Google's product taxonomy.

optional string category_l3 = 10;

Parameter
Name Description
value String

The categoryL3 to set.

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

setCategoryL3Bytes(ByteString value)

public BestSellersProductClusterView.Builder setCategoryL3Bytes(ByteString value)

Product category (3rd level) of the product cluster, represented in Google's product taxonomy.

optional string category_l3 = 10;

Parameter
Name Description
value ByteString

The bytes for categoryL3 to set.

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

setCategoryL4(String value)

public BestSellersProductClusterView.Builder setCategoryL4(String value)

Product category (4th level) of the product cluster, represented in Google's product taxonomy.

optional string category_l4 = 11;

Parameter
Name Description
value String

The categoryL4 to set.

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

setCategoryL4Bytes(ByteString value)

public BestSellersProductClusterView.Builder setCategoryL4Bytes(ByteString value)

Product category (4th level) of the product cluster, represented in Google's product taxonomy.

optional string category_l4 = 11;

Parameter
Name Description
value ByteString

The bytes for categoryL4 to set.

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

setCategoryL5(String value)

public BestSellersProductClusterView.Builder setCategoryL5(String value)

Product category (5th level) of the product cluster, represented in Google's product taxonomy.

optional string category_l5 = 12;

Parameter
Name Description
value String

The categoryL5 to set.

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

setCategoryL5Bytes(ByteString value)

public BestSellersProductClusterView.Builder setCategoryL5Bytes(ByteString value)

Product category (5th level) of the product cluster, represented in Google's product taxonomy.

optional string category_l5 = 12;

Parameter
Name Description
value ByteString

The bytes for categoryL5 to set.

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public BestSellersProductClusterView.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BestSellersProductClusterView.Builder
Overrides

setInventoryStatus(BestSellersProductClusterView.InventoryStatus value)

public BestSellersProductClusterView.Builder setInventoryStatus(BestSellersProductClusterView.InventoryStatus value)

Whether the product cluster is IN_STOCK in your product data source in at least one of the countries, OUT_OF_STOCK in your product data source 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;

Parameter
Name Description
value BestSellersProductClusterView.InventoryStatus

The inventoryStatus to set.

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

setInventoryStatusValue(int value)

public BestSellersProductClusterView.Builder setInventoryStatusValue(int value)

Whether the product cluster is IN_STOCK in your product data source in at least one of the countries, OUT_OF_STOCK in your product data source 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;

Parameter
Name Description
value int

The enum numeric value on the wire for inventoryStatus to set.

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

setPreviousRank(long value)

public BestSellersProductClusterView.Builder setPreviousRank(long value)

Popularity rank in the previous week or month.

optional int64 previous_rank = 17;

Parameter
Name Description
value long

The previousRank to set.

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

setPreviousRelativeDemand(RelativeDemand.RelativeDemandEnum value)

public BestSellersProductClusterView.Builder setPreviousRelativeDemand(RelativeDemand.RelativeDemandEnum value)

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;

Parameter
Name Description
value RelativeDemand.RelativeDemandEnum

The previousRelativeDemand to set.

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

setPreviousRelativeDemandValue(int value)

public BestSellersProductClusterView.Builder setPreviousRelativeDemandValue(int value)

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;

Parameter
Name Description
value int

The enum numeric value on the wire for previousRelativeDemand to set.

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

setRank(long value)

public BestSellersProductClusterView.Builder setRank(long value)

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;

Parameter
Name Description
value long

The rank to set.

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

setRelativeDemand(RelativeDemand.RelativeDemandEnum value)

public BestSellersProductClusterView.Builder setRelativeDemand(RelativeDemand.RelativeDemandEnum value)

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;

Parameter
Name Description
value RelativeDemand.RelativeDemandEnum

The relativeDemand to set.

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

setRelativeDemandChange(RelativeDemandChangeType.RelativeDemandChangeTypeEnum value)

public BestSellersProductClusterView.Builder setRelativeDemandChange(RelativeDemandChangeType.RelativeDemandChangeTypeEnum value)

Change in the estimated demand. Whether it rose, sank or remained flat.

optional .google.shopping.merchant.reports.v1beta.RelativeDemandChangeType.RelativeDemandChangeTypeEnum relative_demand_change = 20;

Parameter
Name Description
value RelativeDemandChangeType.RelativeDemandChangeTypeEnum

The relativeDemandChange to set.

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

setRelativeDemandChangeValue(int value)

public BestSellersProductClusterView.Builder setRelativeDemandChangeValue(int value)

Change in the estimated demand. Whether it rose, sank or remained flat.

optional .google.shopping.merchant.reports.v1beta.RelativeDemandChangeType.RelativeDemandChangeTypeEnum relative_demand_change = 20;

Parameter
Name Description
value int

The enum numeric value on the wire for relativeDemandChange to set.

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

setRelativeDemandValue(int value)

public BestSellersProductClusterView.Builder setRelativeDemandValue(int value)

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;

Parameter
Name Description
value int

The enum numeric value on the wire for relativeDemand to set.

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public BestSellersProductClusterView.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
BestSellersProductClusterView.Builder
Overrides

setReportCategoryId(long value)

public BestSellersProductClusterView.Builder setReportCategoryId(long value)

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;

Parameter
Name Description
value long

The reportCategoryId to set.

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

setReportCountryCode(String value)

public BestSellersProductClusterView.Builder setReportCountryCode(String value)

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;

Parameter
Name Description
value String

The reportCountryCode to set.

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

setReportCountryCodeBytes(ByteString value)

public BestSellersProductClusterView.Builder setReportCountryCodeBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for reportCountryCode to set.

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

setReportDate(Date value)

public BestSellersProductClusterView.Builder setReportDate(Date value)

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.

.google.type.Date report_date = 1;

Parameter
Name Description
value com.google.type.Date
Returns
Type Description
BestSellersProductClusterView.Builder

setReportDate(Date.Builder builderForValue)

public BestSellersProductClusterView.Builder setReportDate(Date.Builder builderForValue)

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.

.google.type.Date report_date = 1;

Parameter
Name Description
builderForValue com.google.type.Date.Builder
Returns
Type Description
BestSellersProductClusterView.Builder

setReportGranularity(ReportGranularity.ReportGranularityEnum value)

public BestSellersProductClusterView.Builder setReportGranularity(ReportGranularity.ReportGranularityEnum value)

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;

Parameter
Name Description
value ReportGranularity.ReportGranularityEnum

The reportGranularity to set.

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

setReportGranularityValue(int value)

public BestSellersProductClusterView.Builder setReportGranularityValue(int value)

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;

Parameter
Name Description
value int

The enum numeric value on the wire for reportGranularity to set.

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

setTitle(String value)

public BestSellersProductClusterView.Builder setTitle(String value)

Title of the product cluster.

optional string title = 6;

Parameter
Name Description
value String

The title to set.

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

setTitleBytes(ByteString value)

public BestSellersProductClusterView.Builder setTitleBytes(ByteString value)

Title of the product cluster.

optional string title = 6;

Parameter
Name Description
value ByteString

The bytes for title to set.

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final BestSellersProductClusterView.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BestSellersProductClusterView.Builder
Overrides

setVariantGtins(int index, String value)

public BestSellersProductClusterView.Builder setVariantGtins(int index, String value)

GTINs of example variants of the product cluster.

repeated string variant_gtins = 13;

Parameters
Name Description
index int

The index to set the value at.

value String

The variantGtins to set.

Returns
Type Description
BestSellersProductClusterView.Builder

This builder for chaining.