Class: Google::Apis::MerchantapiReportsV1beta::CompetitiveVisibilityTopMerchantView

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_top_merchant_view table. Competitive visibility report with business with highest 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) ⇒ CompetitiveVisibilityTopMerchantView

Returns a new instance of CompetitiveVisibilityTopMerchantView.



542
543
544
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 542

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) 


473
474
475
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 473

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:



485
486
487
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 485

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) 


491
492
493
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 491

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) 


499
500
501
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 499

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) 


505
506
507
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 505

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) 


514
515
516
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 514

def page_overlap_rate
  @page_overlap_rate
end

#rank ⇒ Fixnum

Position of the domain in the top merchants 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) 


521
522
523
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 521

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


529
530
531
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 529

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) 


535
536
537
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 535

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) 


540
541
542
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 540

def traffic_source
  @traffic_source
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'lib/google/apis/merchantapi_reports_v1beta/classes.rb', line 547

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