Class: Google::Apis::MerchantapiReportsV1beta::CompetitiveVisibilityCompetitorView

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_competitor_view table. Competitive visibility report with businesses with similar visibility. 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) ⇒ CompetitiveVisibilityCompetitorView

Returns a new instance of CompetitiveVisibilityCompetitorView.



440
441
442
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 440

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

Instance Attribute Details

#ads_organic_ratio ⇒ Float

Ads / organic ratio shows how often the domain receives impressions from Shopping ads compared to organic traffic. The number is rounded and bucketed. Cannot be filtered on in the 'WHERE' clause. Corresponds to the JSON property adsOrganicRatio

Returns:

  • (Float) 


361
362
363
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 361

def ads_organic_ratio
  @ads_organic_ratio
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:



373
374
375
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 373

def date
  @date
end

#domain ⇒ String

Domain of your competitor or your domain, if 'is_your_domain' is true. Required in the SELECT clause. Cannot be filtered on in the 'WHERE' clause. Corresponds to the JSON property domain

Returns:

  • (String) 


379
380
381
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 379

def domain
  @domain
end

#higher_position_rate ⇒ Float

Higher position rate shows how often a competitor’s offer got placed in a higher position on the page than your offer. Cannot be filtered on in the 'WHERE' clause. Corresponds to the JSON property higherPositionRate

Returns:

  • (Float) 


387
388
389
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 387

def higher_position_rate
  @higher_position_rate
end

#is_your_domain ⇒ Boolean Also known as: is_your_domain?

True if this row contains data for your domain. Cannot be filtered on in the ' WHERE' clause. Corresponds to the JSON property isYourDomain

Returns:

  • (Boolean) 


393
394
395
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 393

def is_your_domain
  @is_your_domain
end

#page_overlap_rate ⇒ Float

Page overlap rate shows how frequently competing retailers’ offers are shown together with your offers on the same page. Cannot be filtered on in the 'WHERE' clause. Corresponds to the JSON property pageOverlapRate

Returns:

  • (Float) 


402
403
404
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 402

def page_overlap_rate
  @page_overlap_rate
end

#rank ⇒ Fixnum

Position of the domain in the similar businesses ranking for the selected keys (date, report_category_id, report_country_code, traffic_source) based on impressions. 1 is the highest. Cannot be filtered on in the 'WHERE' clause. Corresponds to the JSON property rank

Returns:

  • (Fixnum) 


409
410
411
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 409

def rank
  @rank
end

#relative_visibility ⇒ Float

Relative visibility shows how often your competitors’ offers are shown compared to your offers. In other words, this is the number of displayed impressions of a competitor retailer divided by the number of your displayed impressions during a selected time range for a selected product category and country. Cannot be filtered on in the 'WHERE' clause. Corresponds to the JSON property relativeVisibility

Returns:

  • (Float) 


419
420
421
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 419

def relative_visibility
  @relative_visibility
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) 


427
428
429
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 427

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) 


433
434
435
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 433

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) 


438
439
440
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 438

def traffic_source
  @traffic_source
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



445
446
447
448
449
450
451
452
453
454
455
456
457
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 445

def update!(**args)
  @ads_organic_ratio = args[:ads_organic_ratio] if args.key?(:ads_organic_ratio)
  @date = args[:date] if args.key?(:date)
  @domain = args[:domain] if args.key?(:domain)
  @higher_position_rate = args[:higher_position_rate] if args.key?(:higher_position_rate)
  @is_your_domain = args[:is_your_domain] if args.key?(:is_your_domain)
  @page_overlap_rate = args[:page_overlap_rate] if args.key?(:page_overlap_rate)
  @rank = args[:rank] if args.key?(:rank)
  @relative_visibility = args[:relative_visibility] if args.key?(:relative_visibility)
  @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)
end