Class: Google::Apis::MerchantapiReportsV1beta::CompetitiveVisibilityBenchmarkView

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 competitive_visibility_benchmark_view table. Competitive visibility report with the category benchmark. 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) ⇒ CompetitiveVisibilityBenchmarkView

Returns a new instance of CompetitiveVisibilityBenchmarkView.



333
334
335
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 333

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

Instance Attribute Details

#category_benchmark_visibility_trend ⇒ Float

Change in visibility based on impressions with respect to the start of the selected time range (or first day with non-zero impressions) for a combined set of merchants with highest visibility approximating the market. Cannot be filtered on in the 'WHERE' clause. Corresponds to the JSON property categoryBenchmarkVisibilityTrend

Returns:

  • (Float) 


293
294
295
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 293

def category_benchmark_visibility_trend
  @category_benchmark_visibility_trend
end

#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 date

Returns:



305
306
307
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 305

def date
  @date
end

#report_category_id ⇒ Fixnum

Google product category ID to calculate the report for, represented in Google' s product taxonomy. Required in the SELECT clause. A condition on report_category_id is required in the WHERE clause. Corresponds to the JSON property reportCategoryId

Returns:

  • (Fixnum) 


313
314
315
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 313

def report_category_id
  @report_category_id
end

#report_country_code ⇒ String

Country where impressions appeared. Required in the SELECT clause. A condition on report_country_code is required in the WHERE clause. Corresponds to the JSON property reportCountryCode

Returns:

  • (String) 


319
320
321
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 319

def report_country_code
  @report_country_code
end

#traffic_source ⇒ String

Traffic source of impressions. Required in the SELECT clause. Corresponds to the JSON property trafficSource

Returns:

  • (String) 


324
325
326
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 324

def traffic_source
  @traffic_source
end

#your_domain_visibility_trend ⇒ Float

Change in visibility based on impressions for your domain with respect to the start of the selected time range (or first day with non-zero impressions). Cannot be filtered on in the 'WHERE' clause. Corresponds to the JSON property yourDomainVisibilityTrend

Returns:

  • (Float) 


331
332
333
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 331

def your_domain_visibility_trend
  @your_domain_visibility_trend
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



338
339
340
341
342
343
344
345
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 338

def update!(**args)
  @category_benchmark_visibility_trend = args[:category_benchmark_visibility_trend] if args.key?(:category_benchmark_visibility_trend)
  @date = args[:date] if args.key?(:date)
  @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)
  @traffic_source = args[:traffic_source] if args.key?(:traffic_source)
  @your_domain_visibility_trend = args[:your_domain_visibility_trend] if args.key?(:your_domain_visibility_trend)
end