View Source GoogleApi.MerchantAPI.Reports_v1beta.Model.CompetitiveVisibilityTopMerchantView (google_api_merchant_api v0.3.0)

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.

Attributes

  • adsOrganicRatio (type: float(), default: nil) - [Ads / organic ratio] (https://support.google.com/merchants/answer/11366442#zippy=%2Cads-free-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.
  • date (type: GoogleApi.MerchantAPI.Reports_v1beta.Model.Date.t, default: nil) - Date of this row. Cannot be selected in the SELECT clause. A condition on date is required in the WHERE clause.
  • domain (type: String.t, default: nil) - 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.
  • higherPositionRate (type: float(), default: nil) - [Higher position rate] (https://support.google.com/merchants/answer/11366442#zippy=%2Chigher-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.
  • isYourDomain (type: boolean(), default: nil) - True if this row contains data for your domain. Cannot be filtered on in the 'WHERE' clause.
  • pageOverlapRate (type: float(), default: nil) - [Page overlap rate] (https://support.google.com/merchants/answer/11366442#zippy=%2Cpage-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.
  • rank (type: String.t, default: nil) - 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.
  • reportCategoryId (type: String.t, default: nil) - 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.
  • reportCountryCode (type: String.t, default: nil) - Country where impressions appeared. Required in the SELECT clause. A condition on report_country_code is required in the WHERE clause.
  • trafficSource (type: String.t, default: nil) - Traffic source of impressions. Required in the SELECT clause.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() ::
  %GoogleApi.MerchantAPI.Reports_v1beta.Model.CompetitiveVisibilityTopMerchantView{
    adsOrganicRatio: float() | nil,
    date: GoogleApi.MerchantAPI.Reports_v1beta.Model.Date.t() | nil,
    domain: String.t() | nil,
    higherPositionRate: float() | nil,
    isYourDomain: boolean() | nil,
    pageOverlapRate: float() | nil,
    rank: String.t() | nil,
    reportCategoryId: String.t() | nil,
    reportCountryCode: String.t() | nil,
    trafficSource: String.t() | nil
  }

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.