feat(content): update the API

#### content:v2.1 The following keys were added: - resources.buyongoogleprograms.methods.activate.description - resources.buyongoogleprograms.methods.activate.flatPath - resources.buyongoogleprograms.methods.activate.httpMethod - resources.buyongoogleprograms.methods.activate.id - resources.buyongoogleprograms.methods.activate.parameterOrder - resources.buyongoogleprograms.methods.activate.parameters.merchantId.description - resources.buyongoogleprograms.methods.activate.parameters.merchantId.format - resources.buyongoogleprograms.methods.activate.parameters.merchantId.location - resources.buyongoogleprograms.methods.activate.parameters.merchantId.required - resources.buyongoogleprograms.methods.activate.parameters.merchantId.type - resources.buyongoogleprograms.methods.activate.parameters.regionCode.description - resources.buyongoogleprograms.methods.activate.parameters.regionCode.location - resources.buyongoogleprograms.methods.activate.parameters.regionCode.required - resources.buyongoogleprograms.methods.activate.parameters.regionCode.type - resources.buyongoogleprograms.methods.activate.path - resources.buyongoogleprograms.methods.activate.request.$ref - resources.buyongoogleprograms.methods.activate.scopes - resources.buyongoogleprograms.methods.pause.description - resources.buyongoogleprograms.methods.pause.flatPath - resources.buyongoogleprograms.methods.pause.httpMethod - resources.buyongoogleprograms.methods.pause.id - resources.buyongoogleprograms.methods.pause.parameterOrder - resources.buyongoogleprograms.methods.pause.parameters.merchantId.description - resources.buyongoogleprograms.methods.pause.parameters.merchantId.format - resources.buyongoogleprograms.methods.pause.parameters.merchantId.location - resources.buyongoogleprograms.methods.pause.parameters.merchantId.required - resources.buyongoogleprograms.methods.pause.parameters.merchantId.type - resources.buyongoogleprograms.methods.pause.parameters.regionCode.description - resources.buyongoogleprograms.methods.pause.parameters.regionCode.location - resources.buyongoogleprograms.methods.pause.parameters.regionCode.required - resources.buyongoogleprograms.methods.pause.parameters.regionCode.type - resources.buyongoogleprograms.methods.pause.path - resources.buyongoogleprograms.methods.pause.request.$ref - resources.buyongoogleprograms.methods.pause.scopes - resources.buyongoogleprograms.methods.requestreview.description - resources.buyongoogleprograms.methods.requestreview.flatPath - resources.buyongoogleprograms.methods.requestreview.httpMethod - resources.buyongoogleprograms.methods.requestreview.id - resources.buyongoogleprograms.methods.requestreview.parameterOrder - resources.buyongoogleprograms.methods.requestreview.parameters.merchantId.description - resources.buyongoogleprograms.methods.requestreview.parameters.merchantId.format - resources.buyongoogleprograms.methods.requestreview.parameters.merchantId.location - resources.buyongoogleprograms.methods.requestreview.parameters.merchantId.required - resources.buyongoogleprograms.methods.requestreview.parameters.merchantId.type - resources.buyongoogleprograms.methods.requestreview.parameters.regionCode.description - resources.buyongoogleprograms.methods.requestreview.parameters.regionCode.location - resources.buyongoogleprograms.methods.requestreview.parameters.regionCode.required - resources.buyongoogleprograms.methods.requestreview.parameters.regionCode.type - resources.buyongoogleprograms.methods.requestreview.path - resources.buyongoogleprograms.methods.requestreview.request.$ref - resources.buyongoogleprograms.methods.requestreview.scopes - schemas.ActivateBuyOnGoogleProgramRequest.description - schemas.ActivateBuyOnGoogleProgramRequest.id - schemas.ActivateBuyOnGoogleProgramRequest.type - schemas.PauseBuyOnGoogleProgramRequest.description - schemas.PauseBuyOnGoogleProgramRequest.id - schemas.PauseBuyOnGoogleProgramRequest.type - schemas.ProductShipping.properties.maxHandlingTime.description - schemas.ProductShipping.properties.maxHandlingTime.format - schemas.ProductShipping.properties.maxHandlingTime.type - schemas.ProductShipping.properties.maxTransitTime.description - schemas.ProductShipping.properties.maxTransitTime.format - schemas.ProductShipping.properties.maxTransitTime.type - schemas.ProductShipping.properties.minHandlingTime.description - schemas.ProductShipping.properties.minHandlingTime.format - schemas.ProductShipping.properties.minHandlingTime.type - schemas.ProductShipping.properties.minTransitTime.description - schemas.ProductShipping.properties.minTransitTime.format - schemas.ProductShipping.properties.minTransitTime.type - schemas.RequestReviewBuyOnGoogleProgramRequest.description - schemas.RequestReviewBuyOnGoogleProgramRequest.id - schemas.RequestReviewBuyOnGoogleProgramRequest.type The following keys were changed: - resources.buyongoogleprograms.methods.get.description - resources.buyongoogleprograms.methods.onboard.description - schemas.BuyOnGoogleProgramStatus.properties.participationStage.enum - schemas.BuyOnGoogleProgramStatus.properties.participationStage.enumDescriptions - schemas.InapplicabilityDetails.properties.inapplicableReason.enum - schemas.InapplicabilityDetails.properties.inapplicableReason.enumDescriptions - schemas.SearchRequest.properties.query.description - schemas.Segments.description
googleapis · Apr 20, 2021 · 364279c · 364279c
1 parent 23b7424
commit 364279c
Show file tree

Hide file tree

Showing 2 changed files with 623 additions and 10 deletions.
diff --git a/discovery/content-v2.1.json b/discovery/content-v2.1.json
@@ -1020,8 +1020,40 @@
     },
     "buyongoogleprograms": {
       "methods": {
+        "activate": {
+          "description": "Reactivates the BoG program in your Merchant Center account. Moves the program to the active state when allowed, e.g. when paused. Important: This method is only whitelisted for selected merchants.",
+          "flatPath": "{merchantId}/buyongoogleprograms/{regionCode}/activate",
+          "httpMethod": "POST",
+          "id": "content.buyongoogleprograms.activate",
+          "parameterOrder": [
+            "merchantId",
+            "regionCode"
+          ],
+          "parameters": {
+            "merchantId": {
+              "description": "Required. The ID of the account.",
+              "format": "int64",
+              "location": "path",
+              "required": true,
+              "type": "string"
+            },
+            "regionCode": {
+              "description": "The program region code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Currently only US is available.",
+              "location": "path",
+              "required": true,
+              "type": "string"
+            }
+          },
+          "path": "{merchantId}/buyongoogleprograms/{regionCode}/activate",
+          "request": {
+            "$ref": "ActivateBuyOnGoogleProgramRequest"
+          },
+          "scopes": [
+            "https://www.googleapis.com/auth/content"
+          ]
+        },
         "get": {
-          "description": "Retrieves a status of BoG program for your Merchant Center account.",
+          "description": "Retrieves a status of the BoG program for your Merchant Center account.",
           "flatPath": "{merchantId}/buyongoogleprograms/{regionCode}",
           "httpMethod": "GET",
           "id": "content.buyongoogleprograms.get",
@@ -1053,7 +1085,7 @@
           ]
         },
         "onboard": {
-          "description": "Onboards BoG in your Merchant Center account. By using this method, you agree to the [Terms of Service](https://merchants.google.com/mc/termsofservice/transactions/US/latest). Calling this method is only possible if the authenticated account is the same as the merchant id in the request. Calling this method multiple times will only accept Terms of Service if the latest version is not currently signed.",
+          "description": "Onboards the BoG program in your Merchant Center account. By using this method, you agree to the [Terms of Service](https://merchants.google.com/mc/termsofservice/transactions/US/latest). Calling this method is only possible if the authenticated account is the same as the merchant id in the request. Calling this method multiple times will only accept Terms of Service if the latest version is not currently signed.",
           "flatPath": "{merchantId}/buyongoogleprograms/{regionCode}/onboard",
           "httpMethod": "POST",
           "id": "content.buyongoogleprograms.onboard",
@@ -1083,6 +1115,70 @@
           "scopes": [
             "https://www.googleapis.com/auth/content"
           ]
+        },
+        "pause": {
+          "description": "Pauses the BoG program in your Merchant Center account. Important: This method is only whitelisted for selected merchants.",
+          "flatPath": "{merchantId}/buyongoogleprograms/{regionCode}/pause",
+          "httpMethod": "POST",
+          "id": "content.buyongoogleprograms.pause",
+          "parameterOrder": [
+            "merchantId",
+            "regionCode"
+          ],
+          "parameters": {
+            "merchantId": {
+              "description": "Required. The ID of the account.",
+              "format": "int64",
+              "location": "path",
+              "required": true,
+              "type": "string"
+            },
+            "regionCode": {
+              "description": "The program region code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Currently only US is available.",
+              "location": "path",
+              "required": true,
+              "type": "string"
+            }
+          },
+          "path": "{merchantId}/buyongoogleprograms/{regionCode}/pause",
+          "request": {
+            "$ref": "PauseBuyOnGoogleProgramRequest"
+          },
+          "scopes": [
+            "https://www.googleapis.com/auth/content"
+          ]
+        },
+        "requestreview": {
+          "description": "Requests review and then activates the BoG program in your Merchant Center account for the first time. Moves the program to the REVIEW_PENDING state. Important: This method is only whitelisted for selected merchants.",
+          "flatPath": "{merchantId}/buyongoogleprograms/{regionCode}/requestreview",
+          "httpMethod": "POST",
+          "id": "content.buyongoogleprograms.requestreview",
+          "parameterOrder": [
+            "merchantId",
+            "regionCode"
+          ],
+          "parameters": {
+            "merchantId": {
+              "description": "Required. The ID of the account.",
+              "format": "int64",
+              "location": "path",
+              "required": true,
+              "type": "string"
+            },
+            "regionCode": {
+              "description": "The program region code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Currently only US is available.",
+              "location": "path",
+              "required": true,
+              "type": "string"
+            }
+          },
+          "path": "{merchantId}/buyongoogleprograms/{regionCode}/requestreview",
+          "request": {
+            "$ref": "RequestReviewBuyOnGoogleProgramRequest"
+          },
+          "scopes": [
+            "https://www.googleapis.com/auth/content"
+          ]
         }
       }
     },
@@ -5307,7 +5403,7 @@
       }
     }
   },
-  "revision": "20210331",
+  "revision": "20210414",
   "rootUrl": "https://shoppingcontent.googleapis.com/",
   "schemas": {
     "Account": {
@@ -6326,6 +6422,12 @@
       },
       "type": "object"
     },
+    "ActivateBuyOnGoogleProgramRequest": {
+      "description": "Request message for the ActivateProgram method.",
+      "id": "ActivateBuyOnGoogleProgramRequest",
+      "properties": {},
+      "type": "object"
+    },
     "Amount": {
       "id": "Amount",
       "properties": {
@@ -6372,6 +6474,9 @@
             "NOT_ELIGIBLE",
             "ELIGIBLE",
             "ONBOARDING",
+            "ELIGIBLE_FOR_REVIEW",
+            "PENDING_REVIEW",
+            "REVIEW_DISAPPROVED",
             "ACTIVE",
             "PAUSED"
           ],
@@ -6380,6 +6485,9 @@
             "Merchant is not eligible for onboarding to a given program in a specific region code.",
             "Merchant is eligible for onboarding to a given program in a specific region code.",
             "Merchant is onboarding to a given program in a specific region code.",
+            "Merchant fulfilled all the requirements and is ready to request review in a specific region code.",
+            "Merchant is waiting for the review to be completed in a specific region code.",
+            "The review for a merchant has been rejected in a specific region code.",
             "Merchant's program participation is active for a specific region code.",
             "Participation has been paused."
           ],
@@ -7491,7 +7599,9 @@
             "TRIUMPHED_OVER_BY_SAME_TYPE_RULE",
             "TRIUMPHED_OVER_BY_OTHER_RULE_ON_OFFER",
             "RESTRICTIONS_NOT_MET",
-            "UNCATEGORIZED"
+            "UNCATEGORIZED",
+            "INVALID_AUTO_PRICE_MIN",
+            "INVALID_FLOOR_CONFIG"
           ],
           "enumDescriptions": [
             "Default value. Should not be used.",
@@ -7500,7 +7610,9 @@
             "Another rule of the same type takes precedence over this one.",
             "Another rule of a different type takes precedence over this one.",
             "The rule restrictions are not met. For example, this may be the case if the calculated rule price is lower than floor price in the restriction.",
-            "The reason is not categorized to any known reason."
+            "The reason is not categorized to any known reason.",
+            "The auto_pricing_min_price is invalid. For example, it is missing or < 0.",
+            "The floor defined in the rule is invalid. For example, it has the wrong sign which results in a floor < 0."
           ],
           "type": "string"
         }
@@ -10648,6 +10760,12 @@
       },
       "type": "object"
     },
+    "PauseBuyOnGoogleProgramRequest": {
+      "description": "Request message for the PauseProgram method.",
+      "id": "PauseBuyOnGoogleProgramRequest",
+      "properties": {},
+      "type": "object"
+    },
     "PickupCarrierService": {
       "id": "PickupCarrierService",
       "properties": {
@@ -11611,6 +11729,26 @@
           "format": "int64",
           "type": "string"
         },
+        "maxHandlingTime": {
+          "description": "Maximum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds.",
+          "format": "int64",
+          "type": "string"
+        },
+        "maxTransitTime": {
+          "description": "Maximum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds.",
+          "format": "int64",
+          "type": "string"
+        },
+        "minHandlingTime": {
+          "description": "Minimum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. minHandlingTime can only be present together with maxHandlingTime; but it is not required if maxHandlingTime is present.",
+          "format": "int64",
+          "type": "string"
+        },
+        "minTransitTime": {
+          "description": "Minimum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. minTransitTime can only be present together with maxTransitTime; but it is not required if maxTransitTime is present.",
+          "format": "int64",
+          "type": "string"
+        },
         "postalCode": {
           "description": "The postal code range that the shipping rate applies to, represented by a postal code, a postal code prefix followed by a * wildcard, a range between two postal codes or two postal code prefixes of equal length.",
           "type": "string"
@@ -12752,6 +12890,12 @@
       },
       "type": "object"
     },
+    "RequestReviewBuyOnGoogleProgramRequest": {
+      "description": "Request message for the RequestReviewProgram method.",
+      "id": "RequestReviewBuyOnGoogleProgramRequest",
+      "properties": {},
+      "type": "object"
+    },
     "ReturnAddress": {
       "description": "Return address resource.",
       "id": "ReturnAddress",
@@ -13386,7 +13530,7 @@
           "type": "string"
         },
         "query": {
-          "description": "Required. Query that defines performance metrics to retrieve and dimensions according to which the metrics are to be segmented. ",
+          "description": "Required. Query that defines performance metrics to retrieve and dimensions according to which the metrics are to be segmented.",
           "type": "string"
         }
       },
@@ -13411,7 +13555,7 @@
       "type": "object"
     },
     "Segments": {
-      "description": "Dimensions according to which metrics are segmented in the response. Values of product dimensions, e.g., offer id, reflect the state of a product at the time of the corresponding event, e.g., impression or order. Segment fields cannot be selected in queries without also selecting at least one metric field. Values are only set for dimensions requested explicitly in the request's search query. Next id: 22",
+      "description": "Dimensions according to which metrics are segmented in the response. Values of product dimensions, e.g., offer id, reflect the state of a product at the time of the corresponding event, e.g., impression or order. Segment fields cannot be selected in queries without also selecting at least one metric field. Values are only set for dimensions requested explicitly in the request's search query.",
       "id": "Segments",
       "properties": {
         "date": {