Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 201a391

Browse files
committedAug 8, 2023
feat(content): update the api
#### content:v2.1 The following keys were added: - schemas.CompetitiveVisibility.properties.relativeVisibility (Total Keys: 2)
1 parent 0cead0c commit 201a391

File tree

2 files changed

+25
-19
lines changed

2 files changed

+25
-19
lines changed
 

‎docs/dyn/content_v2_1.reports.html

+10-9
Original file line numberDiff line numberDiff line change
@@ -134,22 +134,23 @@ <h3>Method Details</h3>
134134
&quot;brand&quot;: { # Brand fields. Values are only set for fields requested explicitly in the request&#x27;s search query. # Brand fields requested by the merchant in the query. Field values are only set if the merchant queries `BestSellersBrandView`.
135135
&quot;name&quot;: &quot;A String&quot;, # Name of the brand.
136136
},
137-
&quot;competitiveVisibility&quot;: { # Fields related to [competitive visibility reports] (https://support.google.com/merchants/answer/11366442). # Competitive visibility fields requested by the merchant in the query. Field values are only set if the merchant queries `CompetitiveVisibilityTopMerchantView` or `CompetitiveVisibilityBenchmarkView`.
138-
&quot;adsOrganicRatio&quot;: 3.14, # [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`. Cannot be filtered on in the &#x27;WHERE&#x27; clause.
137+
&quot;competitiveVisibility&quot;: { # Fields related to [competitive visibility reports] (https://support.google.com/merchants/answer/11366442). # Competitive visibility fields requested by the merchant in the query. Field values are only set if the merchant queries `CompetitiveVisibilityTopMerchantView`, `CompetitiveVisibilityBenchmarkView` or `CompetitiveVisibilityCompetitorView`.
138+
&quot;adsOrganicRatio&quot;: 3.14, # [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 &#x27;WHERE&#x27; clause.
139139
&quot;categoryBenchmarkVisibilityTrend&quot;: 3.14, # 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 &#x27;WHERE&#x27; clause.
140140
&quot;categoryId&quot;: &quot;A String&quot;, # Google product category ID to calculate the report for, represented in [Google&#x27;s product taxonomy](https://support.google.com/merchants/answer/6324436). Required in the `SELECT` clause. A `WHERE` condition on `competitive_visibility.category_id` is required in the query.
141141
&quot;countryCode&quot;: &quot;A String&quot;, # The country where impression appeared. Required in the `SELECT` clause. A `WHERE` condition on `competitive_visibility.country_code` is required in the query.
142-
&quot;date&quot;: { # 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 # Date of this row. Available only in `CompetitiveVisibilityBenchmarkView`. Required in the `SELECT` clause for `CompetitiveVisibilityMarketBenchmarkView`.
142+
&quot;date&quot;: { # 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 # Date of this row. Available only in `CompetitiveVisibilityBenchmarkView` and `CompetitiveVisibilityCompetitorView`. Required in the `SELECT` clause for `CompetitiveVisibilityMarketBenchmarkView`.
143143
&quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
144144
&quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
145145
&quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
146146
},
147-
&quot;domain&quot;: &quot;A String&quot;, # Domain of your competitor or your domain, if &#x27;is_your_domain&#x27; is true. Available only in `CompetitiveVisibilityTopMerchantView`. Required in the `SELECT` clause for `CompetitiveVisibilityTopMerchantView`. Cannot be filtered on in the &#x27;WHERE&#x27; clause.
148-
&quot;higherPositionRate&quot;: 3.14, # 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`. Cannot be filtered on in the &#x27;WHERE&#x27; clause.
149-
&quot;isYourDomain&quot;: True or False, # True if this row contains data for your domain. Available only in `CompetitiveVisibilityTopMerchantView`. Cannot be filtered on in the &#x27;WHERE&#x27; clause.
150-
&quot;pageOverlapRate&quot;: 3.14, # Page overlap rate describes how frequently competing retailers’ offers are shown together with your offers on the same page. Available only in `CompetitiveVisibilityTopMerchantView`. Cannot be filtered on in the &#x27;WHERE&#x27; clause.
151-
&quot;rank&quot;: &quot;A String&quot;, # 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`. Cannot be filtered on in the &#x27;WHERE&#x27; clause.
152-
&quot;trafficSource&quot;: &quot;A String&quot;, # Type of impression listing. Required in the `SELECT` clause for `CompetitiveVisibilityTopMerchantView` and `CompetitiveVisibilityMarketBenchmarkView`. Cannot be filtered on in the &#x27;WHERE&#x27; clause.
147+
&quot;domain&quot;: &quot;A String&quot;, # Domain of your competitor or your domain, if &#x27;is_your_domain&#x27; is true. Available only in `CompetitiveVisibilityTopMerchantView` and `CompetitiveVisibilityCompetitorView`. Required in the `SELECT` clause for `CompetitiveVisibilityTopMerchantView` and `CompetitiveVisibilityCompetitorView`. Cannot be filtered on in the &#x27;WHERE&#x27; clause.
148+
&quot;higherPositionRate&quot;: 3.14, # 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 &#x27;WHERE&#x27; clause.
149+
&quot;isYourDomain&quot;: True or False, # True if this row contains data for your domain. Available only in `CompetitiveVisibilityTopMerchantView` and `CompetitiveVisibilityCompetitorView`. Cannot be filtered on in the &#x27;WHERE&#x27; clause.
150+
&quot;pageOverlapRate&quot;: 3.14, # 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 &#x27;WHERE&#x27; clause.
151+
&quot;rank&quot;: &quot;A String&quot;, # 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 &#x27;WHERE&#x27; clause.
152+
&quot;relativeVisibility&quot;: 3.14, # 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 &#x27;WHERE&#x27; clause.
153+
&quot;trafficSource&quot;: &quot;A String&quot;, # Type of impression listing. Required in the `SELECT` clause. Cannot be filtered on in the &#x27;WHERE&#x27; clause.
153154
&quot;yourDomainVisibilityTrend&quot;: 3.14, # 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 &#x27;WHERE&#x27; clause.
154155
},
155156
&quot;metrics&quot;: { # Performance metrics. Values are only set for metrics requested explicitly in the request&#x27;s search query. # Metrics requested by the merchant in the query. Metric values are only set for metrics requested explicitly in the query.

‎googleapiclient/discovery_cache/documents/content.v2.1.json

+15-10
Original file line numberDiff line numberDiff line change
@@ -6352,7 +6352,7 @@
63526352
}
63536353
}
63546354
},
6355-
"revision": "20230731",
6355+
"revision": "20230803",
63566356
"rootUrl": "https://shoppingcontent.googleapis.com/",
63576357
"schemas": {
63586358
"Account": {
@@ -8293,7 +8293,7 @@
82938293
"id": "CompetitiveVisibility",
82948294
"properties": {
82958295
"adsOrganicRatio": {
8296-
"description": "[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`. Cannot be filtered on in the 'WHERE' clause.",
8296+
"description": "[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.",
82978297
"format": "double",
82988298
"type": "number"
82998299
},
@@ -8313,33 +8313,38 @@
83138313
},
83148314
"date": {
83158315
"$ref": "Date",
8316-
"description": "Date of this row. Available only in `CompetitiveVisibilityBenchmarkView`. Required in the `SELECT` clause for `CompetitiveVisibilityMarketBenchmarkView`."
8316+
"description": "Date of this row. Available only in `CompetitiveVisibilityBenchmarkView` and `CompetitiveVisibilityCompetitorView`. Required in the `SELECT` clause for `CompetitiveVisibilityMarketBenchmarkView`."
83178317
},
83188318
"domain": {
8319-
"description": "Domain of your competitor or your domain, if 'is_your_domain' is true. Available only in `CompetitiveVisibilityTopMerchantView`. Required in the `SELECT` clause for `CompetitiveVisibilityTopMerchantView`. Cannot be filtered on in the 'WHERE' clause.",
8319+
"description": "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.",
83208320
"type": "string"
83218321
},
83228322
"higherPositionRate": {
8323-
"description": "Higher position rate shows how often a competitor\u2019s offer got placed in a higher position on the page than your offer. Available only in `CompetitiveVisibilityTopMerchantView`. Cannot be filtered on in the 'WHERE' clause.",
8323+
"description": "Higher position rate shows how often a competitor\u2019s 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.",
83248324
"format": "double",
83258325
"type": "number"
83268326
},
83278327
"isYourDomain": {
8328-
"description": "True if this row contains data for your domain. Available only in `CompetitiveVisibilityTopMerchantView`. Cannot be filtered on in the 'WHERE' clause.",
8328+
"description": "True if this row contains data for your domain. Available only in `CompetitiveVisibilityTopMerchantView` and `CompetitiveVisibilityCompetitorView`. Cannot be filtered on in the 'WHERE' clause.",
83298329
"type": "boolean"
83308330
},
83318331
"pageOverlapRate": {
8332-
"description": "Page overlap rate describes how frequently competing retailers\u2019 offers are shown together with your offers on the same page. Available only in `CompetitiveVisibilityTopMerchantView`. Cannot be filtered on in the 'WHERE' clause.",
8332+
"description": "Page overlap rate describes how frequently competing retailers\u2019 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.",
83338333
"format": "double",
83348334
"type": "number"
83358335
},
83368336
"rank": {
8337-
"description": "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`. Cannot be filtered on in the 'WHERE' clause.",
8337+
"description": "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.",
83388338
"format": "uint64",
83398339
"type": "string"
83408340
},
8341+
"relativeVisibility": {
8342+
"description": "Relative visibility shows how often your competitors\u2019 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.",
8343+
"format": "double",
8344+
"type": "number"
8345+
},
83418346
"trafficSource": {
8342-
"description": "Type of impression listing. Required in the `SELECT` clause for `CompetitiveVisibilityTopMerchantView` and `CompetitiveVisibilityMarketBenchmarkView`. Cannot be filtered on in the 'WHERE' clause.",
8347+
"description": "Type of impression listing. Required in the `SELECT` clause. Cannot be filtered on in the 'WHERE' clause.",
83438348
"enum": [
83448349
"UNKNOWN",
83458350
"ORGANIC",
@@ -15907,7 +15912,7 @@
1590715912
},
1590815913
"competitiveVisibility": {
1590915914
"$ref": "CompetitiveVisibility",
15910-
"description": "Competitive visibility fields requested by the merchant in the query. Field values are only set if the merchant queries `CompetitiveVisibilityTopMerchantView` or `CompetitiveVisibilityBenchmarkView`."
15915+
"description": "Competitive visibility fields requested by the merchant in the query. Field values are only set if the merchant queries `CompetitiveVisibilityTopMerchantView`, `CompetitiveVisibilityBenchmarkView` or `CompetitiveVisibilityCompetitorView`."
1591115916
},
1591215917
"metrics": {
1591315918
"$ref": "Metrics",

0 commit comments

Comments
 (0)
Please sign in to comment.