Class CompetitiveVisibility
Fields related to [competitive visibility reports] (https://support.google.com/merchants/answer/11366442).
Implements
Inherited Members
Namespace: Google.Apis.ShoppingContent.v2_1.Data
Assembly: Google.Apis.ShoppingContent.v2_1.dll
Syntax
public class CompetitiveVisibility : IDirectResponseSchema
Properties
AdsOrganicRatio
[Ads / organic ratio] (https://support.google.com/merchants/answer/11366442#zippy=%2Cadsfree-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.
Declaration
[JsonProperty("adsOrganicRatio")]
public virtual double? AdsOrganicRatio { get; set; }
Property Value
| Type | Description |
|---|---|
| double? |
CategoryBenchmarkVisibilityTrend
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.
Declaration
[JsonProperty("categoryBenchmarkVisibilityTrend")]
public virtual double? CategoryBenchmarkVisibilityTrend { get; set; }
Property Value
| Type | Description |
|---|---|
| double? |
CategoryId
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.
Declaration
[JsonProperty("categoryId")]
public virtual long? CategoryId { get; set; }
Property Value
| Type | Description |
|---|---|
| long? |
CountryCode
The country where impression appeared. Required in the SELECT clause. A WHERE condition on
competitive_visibility.country_code is required in the query.
Declaration
[JsonProperty("countryCode")]
public virtual string CountryCode { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Date
Date of this row. Available only in CompetitiveVisibilityBenchmarkView and
CompetitiveVisibilityCompetitorView. Required in the SELECT clause for
CompetitiveVisibilityMarketBenchmarkView.
Declaration
[JsonProperty("date")]
public virtual Date Date { get; set; }
Property Value
| Type | Description |
|---|---|
| Date |
Domain
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.
Declaration
[JsonProperty("domain")]
public virtual string Domain { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
HigherPositionRate
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.
Declaration
[JsonProperty("higherPositionRate")]
public virtual double? HigherPositionRate { get; set; }
Property Value
| Type | Description |
|---|---|
| double? |
IsYourDomain
True if this row contains data for your domain. Available only in CompetitiveVisibilityTopMerchantView and
CompetitiveVisibilityCompetitorView. Cannot be filtered on in the 'WHERE' clause.
Declaration
[JsonProperty("isYourDomain")]
public virtual bool? IsYourDomain { get; set; }
Property Value
| Type | Description |
|---|---|
| bool? |
PageOverlapRate
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.
Declaration
[JsonProperty("pageOverlapRate")]
public virtual double? PageOverlapRate { get; set; }
Property Value
| Type | Description |
|---|---|
| double? |
Rank
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.
Declaration
[JsonProperty("rank")]
public virtual ulong? Rank { get; set; }
Property Value
| Type | Description |
|---|---|
| ulong? |
RelativeVisibility
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.
Declaration
[JsonProperty("relativeVisibility")]
public virtual double? RelativeVisibility { get; set; }
Property Value
| Type | Description |
|---|---|
| double? |
TrafficSource
Type of impression listing. Required in the SELECT clause. Cannot be filtered on in the 'WHERE' clause.
Declaration
[JsonProperty("trafficSource")]
public virtual string TrafficSource { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
YourDomainVisibilityTrend
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.
Declaration
[JsonProperty("yourDomainVisibilityTrend")]
public virtual double? YourDomainVisibilityTrend { get; set; }
Property Value
| Type | Description |
|---|---|
| double? |