Class: Google::Apis::MerchantapiReportsV1beta::BestSellersProductClusterView

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ BestSellersProductClusterView

Returns a new instance of BestSellersProductClusterView.



252
253
254
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 252

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

Instance Attribute Details

#brand ⇒ String

Brand of the product cluster. Corresponds to the JSON property brand

Returns:

  • (String) 


130
131
132
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 130

def brand
  @brand
end

#brand_inventory_status ⇒ String

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

Returns:

  • (String) 


139
140
141
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 139

def brand_inventory_status
  @brand_inventory_status
end

#category_l1 ⇒ String

Product category (1st level) of the product cluster, represented in Google's product taxonomy. Corresponds to the JSON property categoryL1

Returns:

  • (String) 


145
146
147
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 145

def category_l1
  @category_l1
end

#category_l2 ⇒ String

Product category (2nd level) of the product cluster, represented in Google's product taxonomy. Corresponds to the JSON property categoryL2

Returns:

  • (String) 


151
152
153
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 151

def category_l2
  @category_l2
end

#category_l3 ⇒ String

Product category (3rd level) of the product cluster, represented in Google's product taxonomy. Corresponds to the JSON property categoryL3

Returns:

  • (String) 


157
158
159
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 157

def category_l3
  @category_l3
end

#category_l4 ⇒ String

Product category (4th level) of the product cluster, represented in Google's product taxonomy. Corresponds to the JSON property categoryL4

Returns:

  • (String) 


163
164
165
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 163

def category_l4
  @category_l4
end

#category_l5 ⇒ String

Product category (5th level) of the product cluster, represented in Google's product taxonomy. Corresponds to the JSON property categoryL5

Returns:

  • (String) 


169
170
171
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 169

def category_l5
  @category_l5
end

#inventory_status ⇒ String

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

Returns:

  • (String) 


177
178
179
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 177

def inventory_status
  @inventory_status
end

#previous_rank ⇒ Fixnum

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

Returns:

  • (Fixnum) 


182
183
184
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 182

def previous_rank
  @previous_rank
end

#previous_relative_demand ⇒ String

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

Returns:

  • (String) 


188
189
190
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 188

def previous_relative_demand
  @previous_relative_demand
end

#rank ⇒ Fixnum

Popularity of the product cluster 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) 


194
195
196
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 194

def rank
  @rank
end

#relative_demand ⇒ String

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

Returns:

  • (String) 


200
201
202
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 200

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) 


205
206
207
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 205

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) 


214
215
216
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 214

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) 


221
222
223
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 221

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:



233
234
235
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 233

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) 


240
241
242
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 240

def report_granularity
  @report_granularity
end

#title ⇒ String

Title of the product cluster. Corresponds to the JSON property title

Returns:

  • (String) 


245
246
247
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 245

def title
  @title
end

#variant_gtins ⇒ Array<String>

GTINs of example variants of the product cluster. Corresponds to the JSON property variantGtins

Returns:

  • (Array<String>) 


250
251
252
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 250

def variant_gtins
  @variant_gtins
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 257

def update!(**args)
  @brand = args[:brand] if args.key?(:brand)
  @brand_inventory_status = args[:brand_inventory_status] if args.key?(:brand_inventory_status)
  @category_l1 = args[:category_l1] if args.key?(:category_l1)
  @category_l2 = args[:category_l2] if args.key?(:category_l2)
  @category_l3 = args[:category_l3] if args.key?(:category_l3)
  @category_l4 = args[:category_l4] if args.key?(:category_l4)
  @category_l5 = args[:category_l5] if args.key?(:category_l5)
  @inventory_status = args[:inventory_status] if args.key?(:inventory_status)
  @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)
  @title = args[:title] if args.key?(:title)
  @variant_gtins = args[:variant_gtins] if args.key?(:variant_gtins)
end