Class: Google::Apis::MerchantapiReportsV1beta::BestSellersBrandView

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/merchantapi_reports_v1beta/classes.rb,
lib/google/apis/merchantapi_reports_v1beta/representations.rb,
lib/google/apis/merchantapi_reports_v1beta/representations.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 Method Summary collapse

Constructor Details

#initialize(**args) ⇒ BestSellersBrandView

Returns a new instance of BestSellersBrandView.



100
101
102
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 100

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#brand ⇒ String

Name of the brand. Corresponds to the JSON property brand

Returns:

  • (String) 


35
36
37
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 35

def brand
  @brand
end

#previous_rank ⇒ Fixnum

Popularity rank in the previous week or month. Corresponds to the JSON property previousRank

Returns:

  • (Fixnum) 


40
41
42
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 40

def previous_rank
  @previous_rank
end

#previous_relative_demand ⇒ String

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

Returns:

  • (String) 


46
47
48
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 46

def previous_relative_demand
  @previous_relative_demand
end

#rank ⇒ Fixnum

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

Returns:

  • (Fixnum) 


52
53
54
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 52

def rank
  @rank
end

#relative_demand ⇒ String

Estimated demand in relation to the brand with the highest popularity rank in the same category and country. Corresponds to the JSON property relativeDemand

Returns:

  • (String) 


58
59
60
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 58

def relative_demand
  @relative_demand
end

#relative_demand_change ⇒ String

Change in the estimated demand. Whether it rose, sank or remained flat. Corresponds to the JSON property relativeDemandChange

Returns:

  • (String) 


63
64
65
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 63

def relative_demand_change
  @relative_demand_change
end

#report_category_id ⇒ Fixnum

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. Corresponds to the JSON property reportCategoryId

Returns:

  • (Fixnum) 


72
73
74
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 72

def report_category_id
  @report_category_id
end

#report_country_code ⇒ 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. Corresponds to the JSON property reportCountryCode

Returns:

  • (String) 


79
80
81
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 79

def report_country_code
  @report_country_code
end

#report_date ⇒ Google::Apis::MerchantapiReportsV1beta::Date

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type. TimeOfDay * google.type.DateTime * google.protobuf.Timestamp Corresponds to the JSON property reportDate

Returns:



91
92
93
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 91

def report_date
  @report_date
end

#report_granularity ⇒ String

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. Corresponds to the JSON property reportGranularity

Returns:

  • (String) 


98
99
100
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 98

def report_granularity
  @report_granularity
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 105

def update!(**args)
  @brand = args[:brand] if args.key?(:brand)
  @previous_rank = args[:previous_rank] if args.key?(:previous_rank)
  @previous_relative_demand = args[:previous_relative_demand] if args.key?(:previous_relative_demand)
  @rank = args[:rank] if args.key?(:rank)
  @relative_demand = args[:relative_demand] if args.key?(:relative_demand)
  @relative_demand_change = args[:relative_demand_change] if args.key?(:relative_demand_change)
  @report_category_id = args[:report_category_id] if args.key?(:report_category_id)
  @report_country_code = args[:report_country_code] if args.key?(:report_country_code)
  @report_date = args[:report_date] if args.key?(:report_date)
  @report_granularity = args[:report_granularity] if args.key?(:report_granularity)
end