Class BestSellersProductClusterView (0.20.0)

public final class BestSellersProductClusterView extends GeneratedMessageV3 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > BestSellersProductClusterView

Implements

BestSellersProductClusterViewOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

BRAND_FIELD_NUMBER

public static final int BRAND_FIELD_NUMBER

Field Value
Type	Description
`int`

BRAND_INVENTORY_STATUS_FIELD_NUMBER

public static final int BRAND_INVENTORY_STATUS_FIELD_NUMBER

Field Value
Type	Description
`int`

CATEGORY_L1_FIELD_NUMBER

public static final int CATEGORY_L1_FIELD_NUMBER

Field Value
Type	Description
`int`

CATEGORY_L2_FIELD_NUMBER

public static final int CATEGORY_L2_FIELD_NUMBER

Field Value
Type	Description
`int`

CATEGORY_L3_FIELD_NUMBER

public static final int CATEGORY_L3_FIELD_NUMBER

Field Value
Type	Description
`int`

CATEGORY_L4_FIELD_NUMBER

public static final int CATEGORY_L4_FIELD_NUMBER

Field Value
Type	Description
`int`

CATEGORY_L5_FIELD_NUMBER

public static final int CATEGORY_L5_FIELD_NUMBER

Field Value
Type	Description
`int`

INVENTORY_STATUS_FIELD_NUMBER

public static final int INVENTORY_STATUS_FIELD_NUMBER

Field Value
Type	Description
`int`

PREVIOUS_RANK_FIELD_NUMBER

public static final int PREVIOUS_RANK_FIELD_NUMBER

Field Value
Type	Description
`int`

PREVIOUS_RELATIVE_DEMAND_FIELD_NUMBER

public static final int PREVIOUS_RELATIVE_DEMAND_FIELD_NUMBER

Field Value
Type	Description
`int`

RANK_FIELD_NUMBER

public static final int RANK_FIELD_NUMBER

Field Value
Type	Description
`int`

RELATIVE_DEMAND_CHANGE_FIELD_NUMBER

public static final int RELATIVE_DEMAND_CHANGE_FIELD_NUMBER

Field Value
Type	Description
`int`

RELATIVE_DEMAND_FIELD_NUMBER

public static final int RELATIVE_DEMAND_FIELD_NUMBER

Field Value
Type	Description
`int`

REPORT_CATEGORY_ID_FIELD_NUMBER

public static final int REPORT_CATEGORY_ID_FIELD_NUMBER

Field Value
Type	Description
`int`

REPORT_COUNTRY_CODE_FIELD_NUMBER

public static final int REPORT_COUNTRY_CODE_FIELD_NUMBER

Field Value
Type	Description
`int`

REPORT_DATE_FIELD_NUMBER

public static final int REPORT_DATE_FIELD_NUMBER

Field Value
Type	Description
`int`

REPORT_GRANULARITY_FIELD_NUMBER

public static final int REPORT_GRANULARITY_FIELD_NUMBER

Field Value
Type	Description
`int`

TITLE_FIELD_NUMBER

public static final int TITLE_FIELD_NUMBER

Field Value
Type	Description
`int`

VARIANT_GTINS_FIELD_NUMBER

public static final int VARIANT_GTINS_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static BestSellersProductClusterView getDefaultInstance()

Returns
Type	Description
`BestSellersProductClusterView`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static BestSellersProductClusterView.Builder newBuilder()

Returns
Type	Description
`BestSellersProductClusterView.Builder`

newBuilder(BestSellersProductClusterView prototype)

public static BestSellersProductClusterView.Builder newBuilder(BestSellersProductClusterView prototype)

Parameter
Name	Description
`prototype`	`BestSellersProductClusterView`

Returns
Type	Description
`BestSellersProductClusterView.Builder`

parseDelimitedFrom(InputStream input)

public static BestSellersProductClusterView parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`BestSellersProductClusterView`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BestSellersProductClusterView parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`BestSellersProductClusterView`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static BestSellersProductClusterView parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`BestSellersProductClusterView`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BestSellersProductClusterView parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`BestSellersProductClusterView`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static BestSellersProductClusterView parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`BestSellersProductClusterView`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BestSellersProductClusterView parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`BestSellersProductClusterView`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static BestSellersProductClusterView parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`BestSellersProductClusterView`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BestSellersProductClusterView parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`BestSellersProductClusterView`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static BestSellersProductClusterView parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`BestSellersProductClusterView`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BestSellersProductClusterView parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`BestSellersProductClusterView`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static BestSellersProductClusterView parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`BestSellersProductClusterView`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BestSellersProductClusterView parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`BestSellersProductClusterView`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<BestSellersProductClusterView> parser()

Returns
Type	Description
`Parser<BestSellersProductClusterView>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

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()

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`

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.

getParserForType()

public Parser<BestSellersProductClusterView> getParserForType()

Returns
Type	Description
`Parser<BestSellersProductClusterView>`

Overrides

GeneratedMessageV3.getParserForType()

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.

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.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

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()

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.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public BestSellersProductClusterView.Builder newBuilderForType()

Returns
Type	Description
`BestSellersProductClusterView.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BestSellersProductClusterView.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`BestSellersProductClusterView.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public BestSellersProductClusterView.Builder toBuilder()

Returns
Type	Description
`BestSellersProductClusterView.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`