Struct google_api_proto::google::shopping::merchant::reports::v1beta::BestSellersProductClusterView

pub struct BestSellersProductClusterView {

    pub report_date: Option<Date>,
    pub report_granularity: Option<i32>,
    pub report_country_code: Option<String>,
    pub report_category_id: Option<i64>,
    pub title: Option<String>,
    pub brand: Option<String>,
    pub category_l1: Option<String>,
    pub category_l2: Option<String>,
    pub category_l3: Option<String>,
    pub category_l4: Option<String>,
    pub category_l5: Option<String>,
    pub variant_gtins: Vec<String>,
    pub inventory_status: Option<i32>,
    pub brand_inventory_status: Option<i32>,
    pub rank: Option<i64>,
    pub previous_rank: Option<i64>,
    pub relative_demand: Option<i32>,
    pub previous_relative_demand: Option<i32>,
    pub relative_demand_change: Option<i32>,
}

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.

Fields

report_date: Option<Date>

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

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

Required in the SELECT clause. If a WHERE condition on report_date is not specified in the query, the latest available weekly or monthly report is returned.

report_granularity: Option<i32>

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.

report_country_code: Option<String>

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.

report_category_id: Option<i64>

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.

title: Option<String>

Title of the product cluster.

brand: Option<String>

Brand of the product cluster.

category_l1: Option<String>

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

category_l2: Option<String>

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

category_l3: Option<String>

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

category_l4: Option<String>

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

category_l5: Option<String>

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

variant_gtins: Vec<String>

GTINs of example variants of the product cluster.

inventory_status: Option<i32>

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.

brand_inventory_status: Option<i32>

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.

rank: Option<i64>

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

previous_rank: Option<i64>

Popularity rank in the previous week or month.

relative_demand: Option<i32>

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

previous_relative_demand: Option<i32>

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.

relative_demand_change: Option<i32>

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

Implementations

impl BestSellersProductClusterView

pub fn report_granularity(&self) -> ReportGranularityEnum

Returns the enum value of report_granularity, or the default if the field is unset or set to an invalid enum value.

pub fn set_report_granularity(&mut self, value: ReportGranularityEnum)

Sets report_granularity to the provided enum value.

pub fn report_country_code(&self) -> &str

Returns the value of report_country_code, or the default value if report_country_code is unset.

pub fn report_category_id(&self) -> i64

Returns the value of report_category_id, or the default value if report_category_id is unset.

pub fn title(&self) -> &str

Returns the value of title, or the default value if title is unset.

pub fn brand(&self) -> &str

Returns the value of brand, or the default value if brand is unset.

pub fn category_l1(&self) -> &str

Returns the value of category_l1, or the default value if category_l1 is unset.

pub fn category_l2(&self) -> &str

Returns the value of category_l2, or the default value if category_l2 is unset.

pub fn category_l3(&self) -> &str

Returns the value of category_l3, or the default value if category_l3 is unset.

pub fn category_l4(&self) -> &str

Returns the value of category_l4, or the default value if category_l4 is unset.

pub fn category_l5(&self) -> &str

Returns the value of category_l5, or the default value if category_l5 is unset.

pub fn inventory_status(&self) -> InventoryStatus

Returns the enum value of inventory_status, or the default if the field is unset or set to an invalid enum value.

pub fn set_inventory_status(&mut self, value: InventoryStatus)

Sets inventory_status to the provided enum value.

pub fn brand_inventory_status(&self) -> InventoryStatus

Returns the enum value of brand_inventory_status, or the default if the field is unset or set to an invalid enum value.

pub fn set_brand_inventory_status(&mut self, value: InventoryStatus)

Sets brand_inventory_status to the provided enum value.

pub fn rank(&self) -> i64

Returns the value of rank, or the default value if rank is unset.

pub fn previous_rank(&self) -> i64

Returns the value of previous_rank, or the default value if previous_rank is unset.

pub fn relative_demand(&self) -> RelativeDemandEnum

Returns the enum value of relative_demand, or the default if the field is unset or set to an invalid enum value.

pub fn set_relative_demand(&mut self, value: RelativeDemandEnum)

Sets relative_demand to the provided enum value.

pub fn previous_relative_demand(&self) -> RelativeDemandEnum

Returns the enum value of previous_relative_demand, or the default if the field is unset or set to an invalid enum value.

pub fn set_previous_relative_demand(&mut self, value: RelativeDemandEnum)

Sets previous_relative_demand to the provided enum value.

pub fn relative_demand_change(&self) -> RelativeDemandChangeTypeEnum

Returns the enum value of relative_demand_change, or the default if the field is unset or set to an invalid enum value.

pub fn set_relative_demand_change( &mut self, value: RelativeDemandChangeTypeEnum )

Sets relative_demand_change to the provided enum value.

Trait Implementations

impl Clone for BestSellersProductClusterView

fn clone(&self) -> BestSellersProductClusterView

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BestSellersProductClusterView

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for BestSellersProductClusterView

fn default() -> Self

Returns the “default value” for a type.

impl Message for BestSellersProductClusterView

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for BestSellersProductClusterView

fn eq(&self, other: &BestSellersProductClusterView) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for BestSellersProductClusterView