Show / Hide Table of Contents

Class BestSellersProductClusterView

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.

Inheritance
object
BestSellersProductClusterView
Implements
IMessage<BestSellersProductClusterView>
IEquatable<BestSellersProductClusterView>
IDeepCloneable<BestSellersProductClusterView>
IBufferMessage
IMessage
Inherited Members
object.GetHashCode()
object.GetType()
object.ToString()
Namespace: Google.Shopping.Merchant.Reports.V1
Assembly: Google.Shopping.Merchant.Reports.V1.dll
Syntax
public sealed class BestSellersProductClusterView : IMessage<BestSellersProductClusterView>, IEquatable<BestSellersProductClusterView>, IDeepCloneable<BestSellersProductClusterView>, IBufferMessage, IMessage

Constructors

BestSellersProductClusterView()

Declaration
public BestSellersProductClusterView()

BestSellersProductClusterView(BestSellersProductClusterView)

Declaration
public BestSellersProductClusterView(BestSellersProductClusterView other)
Parameters
Type Name Description
BestSellersProductClusterView other

Properties

Brand

Brand of the product cluster.

Declaration
public string Brand { get; set; }
Property Value
Type Description
string

BrandInventoryStatus

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.

Declaration
public BestSellersProductClusterView.Types.InventoryStatus BrandInventoryStatus { get; set; }
Property Value
Type Description
BestSellersProductClusterView.Types.InventoryStatus

CategoryL1

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

Declaration
public string CategoryL1 { get; set; }
Property Value
Type Description
string

CategoryL2

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

Declaration
public string CategoryL2 { get; set; }
Property Value
Type Description
string

CategoryL3

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

Declaration
public string CategoryL3 { get; set; }
Property Value
Type Description
string

CategoryL4

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

Declaration
public string CategoryL4 { get; set; }
Property Value
Type Description
string

CategoryL5

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

Declaration
public string CategoryL5 { get; set; }
Property Value
Type Description
string

HasBrand

Gets whether the "brand" field is set

Declaration
public bool HasBrand { get; }
Property Value
Type Description
bool

HasBrandInventoryStatus

Gets whether the "brand_inventory_status" field is set

Declaration
public bool HasBrandInventoryStatus { get; }
Property Value
Type Description
bool

HasCategoryL1

Gets whether the "category_l1" field is set

Declaration
public bool HasCategoryL1 { get; }
Property Value
Type Description
bool

HasCategoryL2

Gets whether the "category_l2" field is set

Declaration
public bool HasCategoryL2 { get; }
Property Value
Type Description
bool

HasCategoryL3

Gets whether the "category_l3" field is set

Declaration
public bool HasCategoryL3 { get; }
Property Value
Type Description
bool

HasCategoryL4

Gets whether the "category_l4" field is set

Declaration
public bool HasCategoryL4 { get; }
Property Value
Type Description
bool

HasCategoryL5

Gets whether the "category_l5" field is set

Declaration
public bool HasCategoryL5 { get; }
Property Value
Type Description
bool

HasInventoryStatus

Gets whether the "inventory_status" field is set

Declaration
public bool HasInventoryStatus { get; }
Property Value
Type Description
bool

HasPreviousRank

Gets whether the "previous_rank" field is set

Declaration
public bool HasPreviousRank { get; }
Property Value
Type Description
bool

HasPreviousRelativeDemand

Gets whether the "previous_relative_demand" field is set

Declaration
public bool HasPreviousRelativeDemand { get; }
Property Value
Type Description
bool

HasRank

Gets whether the "rank" field is set

Declaration
public bool HasRank { get; }
Property Value
Type Description
bool

HasRelativeDemand

Gets whether the "relative_demand" field is set

Declaration
public bool HasRelativeDemand { get; }
Property Value
Type Description
bool

HasRelativeDemandChange

Gets whether the "relative_demand_change" field is set

Declaration
public bool HasRelativeDemandChange { get; }
Property Value
Type Description
bool

HasReportCategoryId

Gets whether the "report_category_id" field is set

Declaration
public bool HasReportCategoryId { get; }
Property Value
Type Description
bool

HasReportCountryCode

Gets whether the "report_country_code" field is set

Declaration
public bool HasReportCountryCode { get; }
Property Value
Type Description
bool

HasReportGranularity

Gets whether the "report_granularity" field is set

Declaration
public bool HasReportGranularity { get; }
Property Value
Type Description
bool

HasTitle

Gets whether the "title" field is set

Declaration
public bool HasTitle { get; }
Property Value
Type Description
bool

InventoryStatus

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.

Declaration
public BestSellersProductClusterView.Types.InventoryStatus InventoryStatus { get; set; }
Property Value
Type Description
BestSellersProductClusterView.Types.InventoryStatus

PreviousRank

Popularity rank in the previous week or month.

Declaration
public long PreviousRank { get; set; }
Property Value
Type Description
long

PreviousRelativeDemand

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.

Declaration
public RelativeDemand.Types.RelativeDemandEnum PreviousRelativeDemand { get; set; }
Property Value
Type Description
RelativeDemand.Types.RelativeDemandEnum

Rank

Popularity of the product cluster on Ads and organic surfaces, in the selected category and country, based on the estimated number of units sold.

Declaration
public long Rank { get; set; }
Property Value
Type Description
long

RelativeDemand

Estimated demand in relation to the product cluster with the highest popularity rank in the same category and country.

Declaration
public RelativeDemand.Types.RelativeDemandEnum RelativeDemand { get; set; }
Property Value
Type Description
RelativeDemand.Types.RelativeDemandEnum

RelativeDemandChange

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

Declaration
public RelativeDemandChangeType.Types.RelativeDemandChangeTypeEnum RelativeDemandChange { get; set; }
Property Value
Type Description
RelativeDemandChangeType.Types.RelativeDemandChangeTypeEnum

ReportCategoryId

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.

Declaration
public long ReportCategoryId { get; set; }
Property Value
Type Description
long

ReportCountryCode

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.

Declaration
public string ReportCountryCode { get; set; }
Property Value
Type Description
string

ReportDate

Report date. The value of this field can only be one of the following:

  • The first day of the week (Monday) for weekly reports,
  • The first day of the month for monthly reports.

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.

Declaration
public Date ReportDate { get; set; }
Property Value
Type Description
Date

ReportGranularity

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.

Declaration
public ReportGranularity.Types.ReportGranularityEnum ReportGranularity { get; set; }
Property Value
Type Description
ReportGranularity.Types.ReportGranularityEnum

Title

Title of the product cluster.

Declaration
public string Title { get; set; }
Property Value
Type Description
string

VariantGtins

GTINs of example variants of the product cluster.

Declaration
public RepeatedField<string> VariantGtins { get; }
Property Value
Type Description
RepeatedField<string>
In this article
Back to top Generated by DocFX