Class: Google::Shopping::Merchant::Reports::V1beta::BestSellersBrandView

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_brand_view table.

Best sellers report with top brands.

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

Instance Attribute Summary collapse

Instance Attribute Details

#brand ⇒ ::String

Returns Name of the brand.

Returns:

  • (::String) —

    Name of the brand.



881
882
883
884
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 881

class BestSellersBrandView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#previous_rank ⇒ ::Integer

Returns Popularity rank in the previous week or month.

Returns:

  • (::Integer) —

    Popularity rank in the previous week or month.



881
882
883
884
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 881

class BestSellersBrandView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

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

Returns Estimated demand in relation to the brand with the highest popularity rank in the same category and country in the previous week or month.

Returns:



881
882
883
884
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 881

class BestSellersBrandView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#rank ⇒ ::Integer

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

Returns:

  • (::Integer) —

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



881
882
883
884
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 881

class BestSellersBrandView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

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

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

Returns:



881
882
883
884
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 881

class BestSellersBrandView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
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:



881
882
883
884
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 881

class BestSellersBrandView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
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.



881
882
883
884
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 881

class BestSellersBrandView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
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.



881
882
883
884
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 881

class BestSellersBrandView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
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.



881
882
883
884
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 881

class BestSellersBrandView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
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:



881
882
883
884
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 881

class BestSellersBrandView
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end