Class: Google::Apis::ContentV2_1::CompetitiveVisibility

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/content_v2_1/classes.rb,
lib/google/apis/content_v2_1/representations.rb,
lib/google/apis/content_v2_1/representations.rb

Overview

Fields related to competitive visibility reports.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CompetitiveVisibility

Returns a new instance of CompetitiveVisibility.



3412
3413
3414
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 3412

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

Instance Attribute Details

#ads_organic_ratio ⇒ Float

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

Returns:

  • (Float) 


3308
3309
3310
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 3308

def ads_organic_ratio
  @ads_organic_ratio
end

#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. Available only in CompetitiveVisibilityBenchmarkView. Cannot be filtered on in the ' WHERE' clause. Corresponds to the JSON property categoryBenchmarkVisibilityTrend

Returns:

  • (Float) 


3317
3318
3319
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 3317

def category_benchmark_visibility_trend
  @category_benchmark_visibility_trend
end

#category_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


3325
3326
3327
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 3325

def category_id
  @category_id
end

#country_code ⇒ String

The country where impression appeared. Required in the SELECT clause. A WHERE condition on competitive_visibility.country_code is required in the query. Corresponds to the JSON property countryCode

Returns:

  • (String) 


3332
3333
3334
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 3332

def country_code
  @country_code
end

#date ⇒ Google::Apis::ContentV2_1::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:



3344
3345
3346
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 3344

def date
  @date
end

#domain ⇒ String

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

Returns:

  • (String) 


3353
3354
3355
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 3353

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. Available only in CompetitiveVisibilityTopMerchantView and CompetitiveVisibilityCompetitorView . Cannot be filtered on in the 'WHERE' clause. Corresponds to the JSON property higherPositionRate

Returns:

  • (Float) 


3361
3362
3363
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 3361

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. Available only in CompetitiveVisibilityTopMerchantView and CompetitiveVisibilityCompetitorView . Cannot be filtered on in the 'WHERE' clause. Corresponds to the JSON property isYourDomain

Returns:

  • (Boolean) 


3368
3369
3370
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 3368

def is_your_domain
  @is_your_domain
end

#page_overlap_rate ⇒ Float

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

Returns:

  • (Float) 


3377
3378
3379
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 3377

def page_overlap_rate
  @page_overlap_rate
end

#rank ⇒ Fixnum

Position of the domain in the top merchants ranking for the selected keys ( date, category_id, country_code, listing_type) based on impressions. 1 is the highest. Available only in CompetitiveVisibilityTopMerchantView and CompetitiveVisibilityCompetitorView. Cannot be filtered on in the 'WHERE' clause. Corresponds to the JSON property rank

Returns:

  • (Fixnum) 


3386
3387
3388
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 3386

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. Available only in CompetitiveVisibilityCompetitorView. Cannot be filtered on in the 'WHERE' clause. Corresponds to the JSON property relativeVisibility

Returns:

  • (Float) 


3396
3397
3398
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 3396

def relative_visibility
  @relative_visibility
end

#traffic_source ⇒ String

Type of impression listing. Required in the SELECT clause. Cannot be filtered on in the 'WHERE' clause. Corresponds to the JSON property trafficSource

Returns:

  • (String) 


3402
3403
3404
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 3402

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). Available only in CompetitiveVisibilityBenchmarkView. Cannot be filtered on in the 'WHERE' clause. Corresponds to the JSON property yourDomainVisibilityTrend

Returns:

  • (Float) 


3410
3411
3412
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 3410

def your_domain_visibility_trend
  @your_domain_visibility_trend
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 3417

def update!(**args)
  @ads_organic_ratio = args[:ads_organic_ratio] if args.key?(:ads_organic_ratio)
  @category_benchmark_visibility_trend = args[:category_benchmark_visibility_trend] if args.key?(:category_benchmark_visibility_trend)
  @category_id = args[:category_id] if args.key?(:category_id)
  @country_code = args[:country_code] if args.key?(:country_code)
  @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)
  @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