Class: Google::Shopping::Merchant::Reports::V1beta::BestSellersProductClusterView

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/shopping/merchant/reports/v1beta/reports.rb

Overview

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.

Defined Under Namespace

Modules: InventoryStatus

Instance Attribute Summary collapse

Instance Attribute Details

#brand ⇒ ::String

Returns Brand of the product cluster.

Returns:

  • (::String) —

    Brand of the product cluster.



826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 826

class BestSellersProductClusterView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of the product cluster or brand in your inventory.
  module InventoryStatus
    # Not specified.
    INVENTORY_STATUS_UNSPECIFIED = 0

    # You have a product for this product cluster or brand in stock.
    IN_STOCK = 1

    # You have a product for this product cluster or brand in inventory but it
    # is currently out of stock.
    OUT_OF_STOCK = 2

    # You do not have a product for this product cluster or brand in inventory.
    NOT_IN_INVENTORY = 3
  end
end

#brand_inventory_status ⇒ ::Google::Shopping::Merchant::Reports::V1beta::BestSellersProductClusterView::InventoryStatus

Returns 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.

Returns:



826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 826

class BestSellersProductClusterView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of the product cluster or brand in your inventory.
  module InventoryStatus
    # Not specified.
    INVENTORY_STATUS_UNSPECIFIED = 0

    # You have a product for this product cluster or brand in stock.
    IN_STOCK = 1

    # You have a product for this product cluster or brand in inventory but it
    # is currently out of stock.
    OUT_OF_STOCK = 2

    # You do not have a product for this product cluster or brand in inventory.
    NOT_IN_INVENTORY = 3
  end
end

#category_l1 ⇒ ::String

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

Returns:



826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 826

class BestSellersProductClusterView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of the product cluster or brand in your inventory.
  module InventoryStatus
    # Not specified.
    INVENTORY_STATUS_UNSPECIFIED = 0

    # You have a product for this product cluster or brand in stock.
    IN_STOCK = 1

    # You have a product for this product cluster or brand in inventory but it
    # is currently out of stock.
    OUT_OF_STOCK = 2

    # You do not have a product for this product cluster or brand in inventory.
    NOT_IN_INVENTORY = 3
  end
end

#category_l2 ⇒ ::String

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

Returns:



826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 826

class BestSellersProductClusterView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of the product cluster or brand in your inventory.
  module InventoryStatus
    # Not specified.
    INVENTORY_STATUS_UNSPECIFIED = 0

    # You have a product for this product cluster or brand in stock.
    IN_STOCK = 1

    # You have a product for this product cluster or brand in inventory but it
    # is currently out of stock.
    OUT_OF_STOCK = 2

    # You do not have a product for this product cluster or brand in inventory.
    NOT_IN_INVENTORY = 3
  end
end

#category_l3 ⇒ ::String

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

Returns:



826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 826

class BestSellersProductClusterView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of the product cluster or brand in your inventory.
  module InventoryStatus
    # Not specified.
    INVENTORY_STATUS_UNSPECIFIED = 0

    # You have a product for this product cluster or brand in stock.
    IN_STOCK = 1

    # You have a product for this product cluster or brand in inventory but it
    # is currently out of stock.
    OUT_OF_STOCK = 2

    # You do not have a product for this product cluster or brand in inventory.
    NOT_IN_INVENTORY = 3
  end
end

#category_l4 ⇒ ::String

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

Returns:



826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 826

class BestSellersProductClusterView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of the product cluster or brand in your inventory.
  module InventoryStatus
    # Not specified.
    INVENTORY_STATUS_UNSPECIFIED = 0

    # You have a product for this product cluster or brand in stock.
    IN_STOCK = 1

    # You have a product for this product cluster or brand in inventory but it
    # is currently out of stock.
    OUT_OF_STOCK = 2

    # You do not have a product for this product cluster or brand in inventory.
    NOT_IN_INVENTORY = 3
  end
end

#category_l5 ⇒ ::String

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

Returns:



826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 826

class BestSellersProductClusterView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of the product cluster or brand in your inventory.
  module InventoryStatus
    # Not specified.
    INVENTORY_STATUS_UNSPECIFIED = 0

    # You have a product for this product cluster or brand in stock.
    IN_STOCK = 1

    # You have a product for this product cluster or brand in inventory but it
    # is currently out of stock.
    OUT_OF_STOCK = 2

    # You do not have a product for this product cluster or brand in inventory.
    NOT_IN_INVENTORY = 3
  end
end

#inventory_status ⇒ ::Google::Shopping::Merchant::Reports::V1beta::BestSellersProductClusterView::InventoryStatus

Returns 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.

Returns:



826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 826

class BestSellersProductClusterView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of the product cluster or brand in your inventory.
  module InventoryStatus
    # Not specified.
    INVENTORY_STATUS_UNSPECIFIED = 0

    # You have a product for this product cluster or brand in stock.
    IN_STOCK = 1

    # You have a product for this product cluster or brand in inventory but it
    # is currently out of stock.
    OUT_OF_STOCK = 2

    # You do not have a product for this product cluster or brand in inventory.
    NOT_IN_INVENTORY = 3
  end
end

#previous_rank ⇒ ::Integer

Returns Popularity rank in the previous week or month.

Returns:

  • (::Integer) —

    Popularity rank in the previous week or month.



826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 826

class BestSellersProductClusterView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of the product cluster or brand in your inventory.
  module InventoryStatus
    # Not specified.
    INVENTORY_STATUS_UNSPECIFIED = 0

    # You have a product for this product cluster or brand in stock.
    IN_STOCK = 1

    # You have a product for this product cluster or brand in inventory but it
    # is currently out of stock.
    OUT_OF_STOCK = 2

    # You do not have a product for this product cluster or brand in inventory.
    NOT_IN_INVENTORY = 3
  end
end

#previous_relative_demand ⇒ ::Google::Shopping::Merchant::Reports::V1beta::RelativeDemand::RelativeDemandEnum

Returns 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.

Returns:



826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 826

class BestSellersProductClusterView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of the product cluster or brand in your inventory.
  module InventoryStatus
    # Not specified.
    INVENTORY_STATUS_UNSPECIFIED = 0

    # You have a product for this product cluster or brand in stock.
    IN_STOCK = 1

    # You have a product for this product cluster or brand in inventory but it
    # is currently out of stock.
    OUT_OF_STOCK = 2

    # You do not have a product for this product cluster or brand in inventory.
    NOT_IN_INVENTORY = 3
  end
end

#rank ⇒ ::Integer

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

Returns:

  • (::Integer) —

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



826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 826

class BestSellersProductClusterView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of the product cluster or brand in your inventory.
  module InventoryStatus
    # Not specified.
    INVENTORY_STATUS_UNSPECIFIED = 0

    # You have a product for this product cluster or brand in stock.
    IN_STOCK = 1

    # You have a product for this product cluster or brand in inventory but it
    # is currently out of stock.
    OUT_OF_STOCK = 2

    # You do not have a product for this product cluster or brand in inventory.
    NOT_IN_INVENTORY = 3
  end
end

#relative_demand ⇒ ::Google::Shopping::Merchant::Reports::V1beta::RelativeDemand::RelativeDemandEnum

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

Returns:



826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 826

class BestSellersProductClusterView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of the product cluster or brand in your inventory.
  module InventoryStatus
    # Not specified.
    INVENTORY_STATUS_UNSPECIFIED = 0

    # You have a product for this product cluster or brand in stock.
    IN_STOCK = 1

    # You have a product for this product cluster or brand in inventory but it
    # is currently out of stock.
    OUT_OF_STOCK = 2

    # You do not have a product for this product cluster or brand in inventory.
    NOT_IN_INVENTORY = 3
  end
end

#relative_demand_change ⇒ ::Google::Shopping::Merchant::Reports::V1beta::RelativeDemandChangeType::RelativeDemandChangeTypeEnum

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

Returns:



826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 826

class BestSellersProductClusterView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of the product cluster or brand in your inventory.
  module InventoryStatus
    # Not specified.
    INVENTORY_STATUS_UNSPECIFIED = 0

    # You have a product for this product cluster or brand in stock.
    IN_STOCK = 1

    # You have a product for this product cluster or brand in inventory but it
    # is currently out of stock.
    OUT_OF_STOCK = 2

    # You do not have a product for this product cluster or brand in inventory.
    NOT_IN_INVENTORY = 3
  end
end

#report_category_id ⇒ ::Integer

Returns 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.

Returns:

  • (::Integer) —

    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.



826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 826

class BestSellersProductClusterView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of the product cluster or brand in your inventory.
  module InventoryStatus
    # Not specified.
    INVENTORY_STATUS_UNSPECIFIED = 0

    # You have a product for this product cluster or brand in stock.
    IN_STOCK = 1

    # You have a product for this product cluster or brand in inventory but it
    # is currently out of stock.
    OUT_OF_STOCK = 2

    # You do not have a product for this product cluster or brand in inventory.
    NOT_IN_INVENTORY = 3
  end
end

#report_country_code ⇒ ::String

Returns 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.

Returns:

  • (::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.



826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 826

class BestSellersProductClusterView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of the product cluster or brand in your inventory.
  module InventoryStatus
    # Not specified.
    INVENTORY_STATUS_UNSPECIFIED = 0

    # You have a product for this product cluster or brand in stock.
    IN_STOCK = 1

    # You have a product for this product cluster or brand in inventory but it
    # is currently out of stock.
    OUT_OF_STOCK = 2

    # You do not have a product for this product cluster or brand in inventory.
    NOT_IN_INVENTORY = 3
  end
end

#report_date ⇒ ::Google::Type::Date

Returns 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.

Returns:

  • (::Google::Type::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.



826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 826

class BestSellersProductClusterView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of the product cluster or brand in your inventory.
  module InventoryStatus
    # Not specified.
    INVENTORY_STATUS_UNSPECIFIED = 0

    # You have a product for this product cluster or brand in stock.
    IN_STOCK = 1

    # You have a product for this product cluster or brand in inventory but it
    # is currently out of stock.
    OUT_OF_STOCK = 2

    # You do not have a product for this product cluster or brand in inventory.
    NOT_IN_INVENTORY = 3
  end
end

#report_granularity ⇒ ::Google::Shopping::Merchant::Reports::V1beta::ReportGranularity::ReportGranularityEnum

Returns 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.

Returns:



826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 826

class BestSellersProductClusterView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of the product cluster or brand in your inventory.
  module InventoryStatus
    # Not specified.
    INVENTORY_STATUS_UNSPECIFIED = 0

    # You have a product for this product cluster or brand in stock.
    IN_STOCK = 1

    # You have a product for this product cluster or brand in inventory but it
    # is currently out of stock.
    OUT_OF_STOCK = 2

    # You do not have a product for this product cluster or brand in inventory.
    NOT_IN_INVENTORY = 3
  end
end

#title ⇒ ::String

Returns Title of the product cluster.

Returns:

  • (::String) —

    Title of the product cluster.



826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 826

class BestSellersProductClusterView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of the product cluster or brand in your inventory.
  module InventoryStatus
    # Not specified.
    INVENTORY_STATUS_UNSPECIFIED = 0

    # You have a product for this product cluster or brand in stock.
    IN_STOCK = 1

    # You have a product for this product cluster or brand in inventory but it
    # is currently out of stock.
    OUT_OF_STOCK = 2

    # You do not have a product for this product cluster or brand in inventory.
    NOT_IN_INVENTORY = 3
  end
end

#variant_gtins ⇒ ::Array<::String>

Returns GTINs of example variants of the product cluster.

Returns:

  • (::Array<::String>) —

    GTINs of example variants of the product cluster.



826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 826

class BestSellersProductClusterView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Status of the product cluster or brand in your inventory.
  module InventoryStatus
    # Not specified.
    INVENTORY_STATUS_UNSPECIFIED = 0

    # You have a product for this product cluster or brand in stock.
    IN_STOCK = 1

    # You have a product for this product cluster or brand in inventory but it
    # is currently out of stock.
    OUT_OF_STOCK = 2

    # You do not have a product for this product cluster or brand in inventory.
    NOT_IN_INVENTORY = 3
  end
end