feat(content): update the API

#### content:v2.1 The following keys were added: - schemas.AccountCredentials.properties.purpose.enumDeprecated - schemas.CompetitiveVisibility.description - schemas.CompetitiveVisibility.id - schemas.CompetitiveVisibility.properties.adsOrganicRatio.description - schemas.CompetitiveVisibility.properties.adsOrganicRatio.format - schemas.CompetitiveVisibility.properties.adsOrganicRatio.type - schemas.CompetitiveVisibility.properties.categoryBenchmarkVisibilityTrend.description - schemas.CompetitiveVisibility.properties.categoryBenchmarkVisibilityTrend.format - schemas.CompetitiveVisibility.properties.categoryBenchmarkVisibilityTrend.type - schemas.CompetitiveVisibility.properties.categoryId.description - schemas.CompetitiveVisibility.properties.categoryId.format - schemas.CompetitiveVisibility.properties.categoryId.type - schemas.CompetitiveVisibility.properties.countryCode.description - schemas.CompetitiveVisibility.properties.countryCode.type - schemas.CompetitiveVisibility.properties.date.$ref - schemas.CompetitiveVisibility.properties.date.description - schemas.CompetitiveVisibility.properties.domain.description - schemas.CompetitiveVisibility.properties.domain.type - schemas.CompetitiveVisibility.properties.higherPositionRate.description - schemas.CompetitiveVisibility.properties.higherPositionRate.format - schemas.CompetitiveVisibility.properties.higherPositionRate.type - schemas.CompetitiveVisibility.properties.isYourDomain.description - schemas.CompetitiveVisibility.properties.isYourDomain.type - schemas.CompetitiveVisibility.properties.pageOverlapRate.description - schemas.CompetitiveVisibility.properties.pageOverlapRate.format - schemas.CompetitiveVisibility.properties.pageOverlapRate.type - schemas.CompetitiveVisibility.properties.rank.description - schemas.CompetitiveVisibility.properties.rank.format - schemas.CompetitiveVisibility.properties.rank.type - schemas.CompetitiveVisibility.properties.trafficSource.description - schemas.CompetitiveVisibility.properties.trafficSource.enum - schemas.CompetitiveVisibility.properties.trafficSource.enumDescriptions - schemas.CompetitiveVisibility.properties.trafficSource.type - schemas.CompetitiveVisibility.properties.yourDomainVisibilityTrend.description - schemas.CompetitiveVisibility.properties.yourDomainVisibilityTrend.format - schemas.CompetitiveVisibility.properties.yourDomainVisibilityTrend.type - schemas.CompetitiveVisibility.type - schemas.CustomAttribute.description - schemas.OrderTrackingSignalLineItemDetails.properties.productDescription.deprecated - schemas.OrderTrackingSignalLineItemDetails.properties.sku.deprecated - schemas.OrderTrackingSignalLineItemDetails.properties.upc.deprecated - schemas.Product.properties.virtualModelLink.description - schemas.Product.properties.virtualModelLink.type - schemas.ProductStatusDestinationStatus.properties.status.deprecated - schemas.ProductstatusesCustomBatchRequestEntry.properties.includeAttributes.deprecated - schemas.Promotion.properties.promotionDisplayDates.deprecated - schemas.Promotion.properties.promotionEffectiveDates.deprecated - schemas.ReportRow.properties.competitiveVisibility.$ref - schemas.ReportRow.properties.competitiveVisibility.description - schemas.RepricingProductReport.properties.buyboxWinningProductStats.deprecated - schemas.RepricingRuleReport.properties.buyboxWinningRuleStats.deprecated
googleapis · Jul 18, 2023 · c3fa716 · c3fa716
1 parent 82e111e
commit c3fa716
Show file tree

Hide file tree

Showing 2 changed files with 172 additions and 6 deletions.
diff --git a/discovery/content-v2.1.json b/discovery/content-v2.1.json
@@ -6271,7 +6271,7 @@
       }
     }
   },
-  "revision": "20230704",
+  "revision": "20230714",
   "rootUrl": "https://shoppingcontent.googleapis.com/",
   "schemas": {
     "Account": {
@@ -6486,6 +6486,11 @@
             "SHOPIFY_ORDER_MANAGEMENT",
             "SHOPIFY_INTEGRATION"
           ],
+          "enumDeprecated": [
+            false,
+            true,
+            false
+          ],
           "enumDescriptions": [
             "Unknown purpose.",
             "The credentials allow Google to manage Shopify orders on behalf of the merchant (deprecated).",
@@ -8118,6 +8123,80 @@
       },
       "type": "object"
     },
+    "CompetitiveVisibility": {
+      "description": "Fields related to [competitive visibility reports] (https://support.google.com/merchants/answer/11366442).",
+      "id": "CompetitiveVisibility",
+      "properties": {
+        "adsOrganicRatio": {
+          "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.",
+          "format": "double",
+          "type": "number"
+        },
+        "categoryBenchmarkVisibilityTrend": {
+          "description": "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.",
+          "format": "double",
+          "type": "number"
+        },
+        "categoryId": {
+          "description": "Google product category ID to calculate the report for, represented in [Google'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.",
+          "format": "int64",
+          "type": "string"
+        },
+        "countryCode": {
+          "description": "The country where impression appeared. Required in the `SELECT` clause. A `WHERE` condition on `competitive_visibility.country_code` is required in the query.",
+          "type": "string"
+        },
+        "date": {
+          "$ref": "Date",
+          "description": "Date of this row. Available only in `CompetitiveVisibilityBenchmarkView`. Required in the `SELECT` clause for `CompetitiveVisibilityMarketBenchmarkView`."
+        },
+        "domain": {
+          "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.",
+          "type": "string"
+        },
+        "higherPositionRate": {
+          "description": "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 'WHERE' clause.",
+          "format": "double",
+          "type": "number"
+        },
+        "isYourDomain": {
+          "description": "True if this row contains data for your domain. Available only in `CompetitiveVisibilityTopMerchantView`. Cannot be filtered on in the 'WHERE' clause.",
+          "type": "boolean"
+        },
+        "pageOverlapRate": {
+          "description": "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 'WHERE' clause.",
+          "format": "double",
+          "type": "number"
+        },
+        "rank": {
+          "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.",
+          "format": "uint64",
+          "type": "string"
+        },
+        "trafficSource": {
+          "description": "Type of impression listing. Required in the `SELECT` clause for `CompetitiveVisibilityTopMerchantView` and `CompetitiveVisibilityMarketBenchmarkView`. Cannot be filtered on in the 'WHERE' clause.",
+          "enum": [
+            "UNKNOWN",
+            "ORGANIC",
+            "ADS",
+            "ALL"
+          ],
+          "enumDescriptions": [
+            "Traffic source is unknown.",
+            "Organic traffic.",
+            "Traffic from Ads.",
+            "Organic and Ads traffic."
+          ],
+          "type": "string"
+        },
+        "yourDomainVisibilityTrend": {
+          "description": "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.",
+          "format": "double",
+          "type": "number"
+        }
+      },
+      "type": "object"
+    },
     "ConversionSource": {
       "description": "Represents a conversion source owned by a Merchant account. A merchant account can have up to 200 conversion sources.",
       "id": "ConversionSource",
@@ -8204,6 +8283,7 @@
       "type": "object"
     },
     "CustomAttribute": {
+      "description": "A message that represents custom attributes. Exactly one of `value` or `groupValues` must be provided. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per merchant, with total size of 102.4kB.",
       "id": "CustomAttribute",
       "properties": {
         "groupValues": {
@@ -11450,6 +11530,7 @@
           "type": "string"
         },
         "productDescription": {
+          "deprecated": true,
           "description": "Plain text description of this product (deprecated: Please use product_title instead).",
           "type": "string"
         },
@@ -11467,10 +11548,12 @@
           "type": "string"
         },
         "sku": {
+          "deprecated": true,
           "description": "Merchant SKU for this item (deprecated).",
           "type": "string"
         },
         "upc": {
+          "deprecated": true,
           "description": "Universal product code for this item (deprecated: Please use GTIN instead).",
           "type": "string"
         }
@@ -13785,6 +13868,10 @@
         "unitPricingMeasure": {
           "$ref": "ProductUnitPricingMeasure",
           "description": "The measure and dimension of an item."
+        },
+        "virtualModelLink": {
+          "description": "URL of the 3D model of the item to provide more visuals.",
+          "type": "string"
         }
       },
       "type": "object"
@@ -14167,6 +14254,7 @@
           "type": "array"
         },
         "status": {
+          "deprecated": true,
           "description": "Deprecated. Destination approval status in `targetCountry` of the offer.",
           "type": "string"
         }
@@ -14703,6 +14791,7 @@
           "type": "array"
         },
         "includeAttributes": {
+          "deprecated": true,
           "description": "Deprecated: Setting this field has no effect and attributes are never included.",
           "type": "boolean"
         },
@@ -14983,6 +15072,7 @@
           "type": "array"
         },
         "promotionDisplayDates": {
+          "deprecated": true,
           "description": "String representation of the promotion display dates. Deprecated. Use `promotion_display_time_period` instead.",
           "type": "string"
         },
@@ -14991,6 +15081,7 @@
           "description": "`TimePeriod` representation of the promotion's display dates."
         },
         "promotionEffectiveDates": {
+          "deprecated": true,
           "description": "String representation of the promotion effective dates. Deprecated. Use `promotion_effective_time_period` instead.",
           "type": "string"
         },
@@ -15614,6 +15705,10 @@
           "$ref": "Brand",
           "description": "Brand fields requested by the merchant in the query. Field values are only set if the merchant queries `BestSellersBrandView`."
         },
+        "competitiveVisibility": {
+          "$ref": "CompetitiveVisibility",
+          "description": "Competitive visibility fields requested by the merchant in the query. Field values are only set if the merchant queries `CompetitiveVisibilityTopMerchantView` or `CompetitiveVisibilityBenchmarkView`."
+        },
         "metrics": {
           "$ref": "Metrics",
           "description": "Metrics requested by the merchant in the query. Metric values are only set for metrics requested explicitly in the query."
@@ -15652,6 +15747,7 @@
         },
         "buyboxWinningProductStats": {
           "$ref": "RepricingProductReportBuyboxWinningProductStats",
+          "deprecated": true,
           "description": "Stats specific to buybox winning rules for product report (deprecated)."
         },
         "date": {
@@ -15899,6 +15995,7 @@
       "properties": {
         "buyboxWinningRuleStats": {
           "$ref": "RepricingRuleReportBuyboxWinningRuleStats",
+          "deprecated": true,
           "description": "Stats specific to buybox winning rules for rule report (deprecated)."
         },
         "date": {

diff --git a/src/apis/content/v2.1.ts b/src/apis/content/v2.1.ts
@@ -1493,6 +1493,59 @@ export namespace content_v2_1 {
      */
     servability?: string | null;
   }
+  /**
+   * Fields related to [competitive visibility reports] (https://support.google.com/merchants/answer/11366442).
+   */
+  export interface Schema$CompetitiveVisibility {
+    /**
+     * [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.
+     */
+    adsOrganicRatio?: number | null;
+    /**
+     * 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.
+     */
+    categoryBenchmarkVisibilityTrend?: number | null;
+    /**
+     * Google product category ID to calculate the report for, represented in [Google'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.
+     */
+    categoryId?: string | null;
+    /**
+     * The country where impression appeared. Required in the `SELECT` clause. A `WHERE` condition on `competitive_visibility.country_code` is required in the query.
+     */
+    countryCode?: string | null;
+    /**
+     * Date of this row. Available only in `CompetitiveVisibilityBenchmarkView`. Required in the `SELECT` clause for `CompetitiveVisibilityMarketBenchmarkView`.
+     */
+    date?: Schema$Date;
+    /**
+     * 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.
+     */
+    domain?: string | null;
+    /**
+     * 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 'WHERE' clause.
+     */
+    higherPositionRate?: number | null;
+    /**
+     * True if this row contains data for your domain. Available only in `CompetitiveVisibilityTopMerchantView`. Cannot be filtered on in the 'WHERE' clause.
+     */
+    isYourDomain?: boolean | null;
+    /**
+     * 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 'WHERE' clause.
+     */
+    pageOverlapRate?: number | null;
+    /**
+     * 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.
+     */
+    rank?: string | null;
+    /**
+     * Type of impression listing. Required in the `SELECT` clause for `CompetitiveVisibilityTopMerchantView` and `CompetitiveVisibilityMarketBenchmarkView`. Cannot be filtered on in the 'WHERE' clause.
+     */
+    trafficSource?: string | null;
+    /**
+     * 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.
+     */
+    yourDomainVisibilityTrend?: number | null;
+  }
   /**
    * Represents a conversion source owned by a Merchant account. A merchant account can have up to 200 conversion sources.
    */
@@ -1547,6 +1600,9 @@ export namespace content_v2_1 {
      */
     labelIds?: string[] | null;
   }
+  /**
+   * A message that represents custom attributes. Exactly one of `value` or `groupValues` must be provided. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per merchant, with total size of 102.4kB.
+   */
   export interface Schema$CustomAttribute {
     /**
      * Subattributes within this attribute group. Exactly one of value or groupValues must be provided.
@@ -5810,6 +5866,10 @@ export namespace content_v2_1 {
      * The measure and dimension of an item.
      */
     unitPricingMeasure?: Schema$ProductUnitPricingMeasure;
+    /**
+     * URL of the 3D model of the item to provide more visuals.
+     */
+    virtualModelLink?: string | null;
   }
   export interface Schema$ProductAmount {
     /**
@@ -7092,6 +7152,10 @@ export namespace content_v2_1 {
      * Brand fields requested by the merchant in the query. Field values are only set if the merchant queries `BestSellersBrandView`.
      */
     brand?: Schema$Brand;
+    /**
+     * Competitive visibility fields requested by the merchant in the query. Field values are only set if the merchant queries `CompetitiveVisibilityTopMerchantView` or `CompetitiveVisibilityBenchmarkView`.
+     */
+    competitiveVisibility?: Schema$CompetitiveVisibility;
     /**
      * Metrics requested by the merchant in the query. Metric values are only set for metrics requested explicitly in the query.
      */
@@ -28106,7 +28170,8 @@ export namespace content_v2_1 {
      *   //   "title": "my_title",
      *   //   "transitTimeLabel": "my_transitTimeLabel",
      *   //   "unitPricingBaseMeasure": {},
-     *   //   "unitPricingMeasure": {}
+     *   //   "unitPricingMeasure": {},
+     *   //   "virtualModelLink": "my_virtualModelLink"
      *   // }
      * }
      *
@@ -28331,7 +28396,8 @@ export namespace content_v2_1 {
      *       //   "title": "my_title",
      *       //   "transitTimeLabel": "my_transitTimeLabel",
      *       //   "unitPricingBaseMeasure": {},
-     *       //   "unitPricingMeasure": {}
+     *       //   "unitPricingMeasure": {},
+     *       //   "virtualModelLink": "my_virtualModelLink"
      *       // }
      *     },
      *   });
@@ -28434,7 +28500,8 @@ export namespace content_v2_1 {
      *   //   "title": "my_title",
      *   //   "transitTimeLabel": "my_transitTimeLabel",
      *   //   "unitPricingBaseMeasure": {},
-     *   //   "unitPricingMeasure": {}
+     *   //   "unitPricingMeasure": {},
+     *   //   "virtualModelLink": "my_virtualModelLink"
      *   // }
      * }
      *
@@ -28802,7 +28869,8 @@ export namespace content_v2_1 {
      *       //   "title": "my_title",
      *       //   "transitTimeLabel": "my_transitTimeLabel",
      *       //   "unitPricingBaseMeasure": {},
-     *       //   "unitPricingMeasure": {}
+     *       //   "unitPricingMeasure": {},
+     *       //   "virtualModelLink": "my_virtualModelLink"
      *       // }
      *     },
      *   });
@@ -28905,7 +28973,8 @@ export namespace content_v2_1 {
      *   //   "title": "my_title",
      *   //   "transitTimeLabel": "my_transitTimeLabel",
      *   //   "unitPricingBaseMeasure": {},
-     *   //   "unitPricingMeasure": {}
+     *   //   "unitPricingMeasure": {},
+     *   //   "virtualModelLink": "my_virtualModelLink"
      *   // }
      * }
      *