diff --git a/docs/dyn/content_v2_1.freelistingsprogram.checkoutsettings.html b/docs/dyn/content_v2_1.freelistingsprogram.checkoutsettings.html
new file mode 100644
index 00000000000..515187588b1
--- /dev/null
+++ b/docs/dyn/content_v2_1.freelistingsprogram.checkoutsettings.html
@@ -0,0 +1,180 @@
+
+
+
+
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+ delete(merchantId, x__xgafv=None)
+Deletes `Checkout` settings and unenrolls merchant from `Checkout` program.
+
+ get(merchantId, x__xgafv=None)
+Gets Checkout settings for the given merchant. This includes information about review state, enrollment state and URL settings.
+
+ insert(merchantId, body=None, x__xgafv=None)
+Enrolls merchant in `Checkout` program.
+Method Details
+
+
close()
+
Close httplib2 connections.
+
+
delete(merchantId, x__xgafv=None)
+
Deletes `Checkout` settings and unenrolls merchant from `Checkout` program.
+
+Args:
+ merchantId: string, Required. The ID of the account. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+
+
get(merchantId, x__xgafv=None)
+
Gets Checkout settings for the given merchant. This includes information about review state, enrollment state and URL settings.
+
+Args:
+ merchantId: string, Required. The ID of the account. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # `CheckoutSettings` for a specific merchant ID.
+ "effectiveEnrollmentState": "A String", # Output only. The effective value of enrollment state for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account.
+ "effectiveReviewState": "A String", # Output only. The effective value of review state for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account.
+ "effectiveUriSettings": { # Specifications related to the `Checkout` URL. The `UriTemplate` is of the form `https://www.mystore.com/checkout?item_id={id}` where `{id}` will be automatically replaced with data from the merchant account with this attribute [offer_id](https://developers.google.com/shopping-content/reference/rest/v2.1/products#Product.FIELDS.offer_id) # The effective value of `url_settings` for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account.
+ "cartUriTemplate": "A String", # URL template when the placeholders are expanded will redirect the buyer to the cart page on the merchant website with the selected item in cart.
+ "checkoutUriTemplate": "A String", # URL template when the placeholders are expanded will redirect the buyer to the merchant checkout page with the item in the cart.
+ },
+ "enrollmentState": "A String", # Output only. Reflects the merchant enrollment state in `Checkout` feature.
+ "merchantId": "A String", # Required. The ID of the account.
+ "reviewState": "A String", # Output only. Reflects the merchant review state in `Checkout` feature. This is set based on the data quality reviews of the URL provided by the merchant. A merchant with enrollment state as `ENROLLED` can be in the following review states: `IN_REVIEW`, `APPROVED` or `DISAPPROVED`. A merchant must be in an enrollment_state of `ENROLLED` before a review can begin for the merchant.
+ "uriSettings": { # Specifications related to the `Checkout` URL. The `UriTemplate` is of the form `https://www.mystore.com/checkout?item_id={id}` where `{id}` will be automatically replaced with data from the merchant account with this attribute [offer_id](https://developers.google.com/shopping-content/reference/rest/v2.1/products#Product.FIELDS.offer_id) # URL settings for cart or checkout URL.
+ "cartUriTemplate": "A String", # URL template when the placeholders are expanded will redirect the buyer to the cart page on the merchant website with the selected item in cart.
+ "checkoutUriTemplate": "A String", # URL template when the placeholders are expanded will redirect the buyer to the merchant checkout page with the item in the cart.
+ },
+}
+
+
insert(merchantId, body=None, x__xgafv=None)
+
Enrolls merchant in `Checkout` program.
+
+Args:
+ merchantId: string, Required. The ID of the account. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for the `InsertCheckoutSettings` method.
+ "uriSettings": { # Specifications related to the `Checkout` URL. The `UriTemplate` is of the form `https://www.mystore.com/checkout?item_id={id}` where `{id}` will be automatically replaced with data from the merchant account with this attribute [offer_id](https://developers.google.com/shopping-content/reference/rest/v2.1/products#Product.FIELDS.offer_id) # Required. The `UrlSettings` for the request. The presence of URL settings indicates `Checkout` enrollment.
+ "cartUriTemplate": "A String", # URL template when the placeholders are expanded will redirect the buyer to the cart page on the merchant website with the selected item in cart.
+ "checkoutUriTemplate": "A String", # URL template when the placeholders are expanded will redirect the buyer to the merchant checkout page with the item in the cart.
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # `CheckoutSettings` for a specific merchant ID.
+ "effectiveEnrollmentState": "A String", # Output only. The effective value of enrollment state for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account.
+ "effectiveReviewState": "A String", # Output only. The effective value of review state for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account.
+ "effectiveUriSettings": { # Specifications related to the `Checkout` URL. The `UriTemplate` is of the form `https://www.mystore.com/checkout?item_id={id}` where `{id}` will be automatically replaced with data from the merchant account with this attribute [offer_id](https://developers.google.com/shopping-content/reference/rest/v2.1/products#Product.FIELDS.offer_id) # The effective value of `url_settings` for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account.
+ "cartUriTemplate": "A String", # URL template when the placeholders are expanded will redirect the buyer to the cart page on the merchant website with the selected item in cart.
+ "checkoutUriTemplate": "A String", # URL template when the placeholders are expanded will redirect the buyer to the merchant checkout page with the item in the cart.
+ },
+ "enrollmentState": "A String", # Output only. Reflects the merchant enrollment state in `Checkout` feature.
+ "merchantId": "A String", # Required. The ID of the account.
+ "reviewState": "A String", # Output only. Reflects the merchant review state in `Checkout` feature. This is set based on the data quality reviews of the URL provided by the merchant. A merchant with enrollment state as `ENROLLED` can be in the following review states: `IN_REVIEW`, `APPROVED` or `DISAPPROVED`. A merchant must be in an enrollment_state of `ENROLLED` before a review can begin for the merchant.
+ "uriSettings": { # Specifications related to the `Checkout` URL. The `UriTemplate` is of the form `https://www.mystore.com/checkout?item_id={id}` where `{id}` will be automatically replaced with data from the merchant account with this attribute [offer_id](https://developers.google.com/shopping-content/reference/rest/v2.1/products#Product.FIELDS.offer_id) # URL settings for cart or checkout URL.
+ "cartUriTemplate": "A String", # URL template when the placeholders are expanded will redirect the buyer to the cart page on the merchant website with the selected item in cart.
+ "checkoutUriTemplate": "A String", # URL template when the placeholders are expanded will redirect the buyer to the merchant checkout page with the item in the cart.
+ },
+}
+
Instance Methods
+
+ checkoutsettings()
+
+Returns the checkoutsettings Resource.
+
close()
Close httplib2 connections.
diff --git a/docs/dyn/content_v2_1.pos.html b/docs/dyn/content_v2_1.pos.html
index 9ffd16b7029..4467c64d481 100644
--- a/docs/dyn/content_v2_1.pos.html
+++ b/docs/dyn/content_v2_1.pos.html
@@ -121,6 +121,8 @@ Method Details
"gtin": "A String", # Global Trade Item Number.
"itemId": "A String", # Required. A unique identifier for the item.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posInventory`"
+ "pickupMethod": "A String", # Optional. Supported pickup method for this offer. Unless the value is "not supported", this field must be submitted together with `pickupSla`. For accepted attribute values, see the [local product inventory feed specification](https://support.google.com/merchants/answer/3061342).
+ "pickupSla": "A String", # Optional. Expected date that an order will be ready for pickup relative to the order date. Must be submitted together with `pickupMethod`. For accepted attribute values, see the [local product inventory feed specification](https://support.google.com/merchants/answer/3061342).
"price": { # Required. The current price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
@@ -193,6 +195,8 @@ Method Details
"gtin": "A String", # Global Trade Item Number.
"itemId": "A String", # Required. A unique identifier for the item.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posInventory`"
+ "pickupMethod": "A String", # Optional. Supported pickup method for this offer. Unless the value is "not supported", this field must be submitted together with `pickupSla`. For accepted attribute values, see the [local product inventory feed specification](https://support.google.com/merchants/answer/3061342).
+ "pickupSla": "A String", # Optional. Expected date that an order will be ready for pickup relative to the order date. Must be submitted together with `pickupMethod`. For accepted attribute values, see the [local product inventory feed specification](https://support.google.com/merchants/answer/3061342).
"price": { # Required. The current price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
@@ -340,6 +344,8 @@ Method Details
"contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
"gtin": "A String", # Global Trade Item Number.
"itemId": "A String", # Required. A unique identifier for the item.
+ "pickupMethod": "A String", # Optional. Supported pickup method for this offer. Unless the value is "not supported", this field must be submitted together with `pickupSla`. For accepted attribute values, see the [local product inventory feed specification](https://support.google.com/merchants/answer/3061342).
+ "pickupSla": "A String", # Optional. Expected date that an order will be ready for pickup relative to the order date. Must be submitted together with `pickupMethod`. For accepted attribute values, see the [local product inventory feed specification](https://support.google.com/merchants/answer/3061342).
"price": { # Required. The current price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
@@ -363,6 +369,8 @@ Method Details
"gtin": "A String", # Global Trade Item Number.
"itemId": "A String", # Required. A unique identifier for the item.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#posInventoryResponse`".
+ "pickupMethod": "A String", # Optional. Supported pickup method for this offer. Unless the value is "not supported", this field must be submitted together with `pickupSla`. For accepted attribute values, see the [local product inventory feed specification](https://support.google.com/merchants/answer/3061342).
+ "pickupSla": "A String", # Optional. Expected date that an order will be ready for pickup relative to the order date. Must be submitted together with `pickupMethod`. For accepted attribute values, see the [local product inventory feed specification](https://support.google.com/merchants/answer/3061342).
"price": { # Required. The current price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
diff --git a/googleapiclient/discovery_cache/documents/content.v2.1.json b/googleapiclient/discovery_cache/documents/content.v2.1.json
index 539c0539ea2..0562725931c 100644
--- a/googleapiclient/discovery_cache/documents/content.v2.1.json
+++ b/googleapiclient/discovery_cache/documents/content.v2.1.json
@@ -2198,6 +2198,87 @@
"https://www.googleapis.com/auth/content"
]
}
+ },
+ "resources": {
+ "checkoutsettings": {
+ "methods": {
+ "delete": {
+ "description": "Deletes `Checkout` settings and unenrolls merchant from `Checkout` program.",
+ "flatPath": "{merchantId}/freelistingsprogram/checkoutsettings",
+ "httpMethod": "DELETE",
+ "id": "content.freelistingsprogram.checkoutsettings.delete",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "Required. The ID of the account.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/freelistingsprogram/checkoutsettings",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "get": {
+ "description": "Gets Checkout settings for the given merchant. This includes information about review state, enrollment state and URL settings.",
+ "flatPath": "{merchantId}/freelistingsprogram/checkoutsettings",
+ "httpMethod": "GET",
+ "id": "content.freelistingsprogram.checkoutsettings.get",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "Required. The ID of the account.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/freelistingsprogram/checkoutsettings",
+ "response": {
+ "$ref": "CheckoutSettings"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "insert": {
+ "description": "Enrolls merchant in `Checkout` program.",
+ "flatPath": "{merchantId}/freelistingsprogram/checkoutsettings",
+ "httpMethod": "POST",
+ "id": "content.freelistingsprogram.checkoutsettings.insert",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "Required. The ID of the account.",
+ "format": "int64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{merchantId}/freelistingsprogram/checkoutsettings",
+ "request": {
+ "$ref": "InsertCheckoutSettingsRequest"
+ },
+ "response": {
+ "$ref": "CheckoutSettings"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ }
+ }
}
},
"liasettings": {
@@ -6271,7 +6352,7 @@
}
}
},
- "revision": "20230722",
+ "revision": "20230731",
"rootUrl": "https://shoppingcontent.googleapis.com/",
"schemas": {
"Account": {
@@ -7867,6 +7948,90 @@
},
"type": "object"
},
+ "CheckoutSettings": {
+ "description": "`CheckoutSettings` for a specific merchant ID.",
+ "id": "CheckoutSettings",
+ "properties": {
+ "effectiveEnrollmentState": {
+ "description": "Output only. The effective value of enrollment state for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account.",
+ "enum": [
+ "CHECKOUT_ON_MERCHANT_ENROLLMENT_STATE_UNSPECIFIED",
+ "INACTIVE",
+ "ENROLLED"
+ ],
+ "enumDescriptions": [
+ "Default enrollment state when enrollment state is not specified.",
+ "Merchant has not enrolled into the feature.",
+ "Merchant has enrolled into the feature by providing either an account level URL or checkout URLs as part of their feed."
+ ],
+ "readOnly": true,
+ "type": "string"
+ },
+ "effectiveReviewState": {
+ "description": "Output only. The effective value of review state for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account.",
+ "enum": [
+ "CHECKOUT_ON_MERCHANT_REVIEW_STATE_UNSPECIFIED",
+ "IN_REVIEW",
+ "APPROVED",
+ "DISAPPROVED"
+ ],
+ "enumDescriptions": [
+ "Default review state when review state is not specified.",
+ "Merchant provided URLs are being reviewed for data quality issues.",
+ "Merchant account has been approved. Indicates the data quality checks have passed.",
+ "Merchant account has been disapproved due to data quality issues."
+ ],
+ "readOnly": true,
+ "type": "string"
+ },
+ "effectiveUriSettings": {
+ "$ref": "UrlSettings",
+ "description": "The effective value of `url_settings` for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account."
+ },
+ "enrollmentState": {
+ "description": "Output only. Reflects the merchant enrollment state in `Checkout` feature.",
+ "enum": [
+ "CHECKOUT_ON_MERCHANT_ENROLLMENT_STATE_UNSPECIFIED",
+ "INACTIVE",
+ "ENROLLED"
+ ],
+ "enumDescriptions": [
+ "Default enrollment state when enrollment state is not specified.",
+ "Merchant has not enrolled into the feature.",
+ "Merchant has enrolled into the feature by providing either an account level URL or checkout URLs as part of their feed."
+ ],
+ "readOnly": true,
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "Required. The ID of the account.",
+ "format": "int64",
+ "type": "string"
+ },
+ "reviewState": {
+ "description": "Output only. Reflects the merchant review state in `Checkout` feature. This is set based on the data quality reviews of the URL provided by the merchant. A merchant with enrollment state as `ENROLLED` can be in the following review states: `IN_REVIEW`, `APPROVED` or `DISAPPROVED`. A merchant must be in an enrollment_state of `ENROLLED` before a review can begin for the merchant.",
+ "enum": [
+ "CHECKOUT_ON_MERCHANT_REVIEW_STATE_UNSPECIFIED",
+ "IN_REVIEW",
+ "APPROVED",
+ "DISAPPROVED"
+ ],
+ "enumDescriptions": [
+ "Default review state when review state is not specified.",
+ "Merchant provided URLs are being reviewed for data quality issues.",
+ "Merchant account has been approved. Indicates the data quality checks have passed.",
+ "Merchant account has been disapproved due to data quality issues."
+ ],
+ "readOnly": true,
+ "type": "string"
+ },
+ "uriSettings": {
+ "$ref": "UrlSettings",
+ "description": "URL settings for cart or checkout URL."
+ }
+ },
+ "type": "object"
+ },
"CloudExportAdditionalProperties": {
"description": "Product property for the Cloud Retail API. For example, properties for a TV product could be \"Screen-Resolution\" or \"Screen-Size\".",
"id": "CloudExportAdditionalProperties",
@@ -9409,6 +9574,17 @@
},
"type": "object"
},
+ "InsertCheckoutSettingsRequest": {
+ "description": "Request message for the `InsertCheckoutSettings` method.",
+ "id": "InsertCheckoutSettingsRequest",
+ "properties": {
+ "uriSettings": {
+ "$ref": "UrlSettings",
+ "description": "Required. The `UrlSettings` for the request. The presence of URL settings indicates `Checkout` enrollment."
+ }
+ },
+ "type": "object"
+ },
"Installment": {
"id": "Installment",
"properties": {
@@ -12994,6 +13170,14 @@
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#posInventory`\"",
"type": "string"
},
+ "pickupMethod": {
+ "description": "Optional. Supported pickup method for this offer. Unless the value is \"not supported\", this field must be submitted together with `pickupSla`. For accepted attribute values, see the [local product inventory feed specification](https://support.google.com/merchants/answer/3061342).",
+ "type": "string"
+ },
+ "pickupSla": {
+ "description": "Optional. Expected date that an order will be ready for pickup relative to the order date. Must be submitted together with `pickupMethod`. For accepted attribute values, see the [local product inventory feed specification](https://support.google.com/merchants/answer/3061342).",
+ "type": "string"
+ },
"price": {
"$ref": "Price",
"description": "Required. The current price of the item."
@@ -13033,6 +13217,14 @@
"description": "Required. A unique identifier for the item.",
"type": "string"
},
+ "pickupMethod": {
+ "description": "Optional. Supported pickup method for this offer. Unless the value is \"not supported\", this field must be submitted together with `pickupSla`. For accepted attribute values, see the [local product inventory feed specification](https://support.google.com/merchants/answer/3061342).",
+ "type": "string"
+ },
+ "pickupSla": {
+ "description": "Optional. Expected date that an order will be ready for pickup relative to the order date. Must be submitted together with `pickupMethod`. For accepted attribute values, see the [local product inventory feed specification](https://support.google.com/merchants/answer/3061342).",
+ "type": "string"
+ },
"price": {
"$ref": "Price",
"description": "Required. The current price of the item."
@@ -13076,6 +13268,14 @@
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#posInventoryResponse`\".",
"type": "string"
},
+ "pickupMethod": {
+ "description": "Optional. Supported pickup method for this offer. Unless the value is \"not supported\", this field must be submitted together with `pickupSla`. For accepted attribute values, see the [local product inventory feed specification](https://support.google.com/merchants/answer/3061342).",
+ "type": "string"
+ },
+ "pickupSla": {
+ "description": "Optional. Expected date that an order will be ready for pickup relative to the order date. Must be submitted together with `pickupMethod`. For accepted attribute values, see the [local product inventory feed specification](https://support.google.com/merchants/answer/3061342).",
+ "type": "string"
+ },
"price": {
"$ref": "Price",
"description": "Required. The current price of the item."
@@ -18102,6 +18302,21 @@
},
"type": "object"
},
+ "UrlSettings": {
+ "description": "Specifications related to the `Checkout` URL. The `UriTemplate` is of the form `https://www.mystore.com/checkout?item_id={id}` where `{id}` will be automatically replaced with data from the merchant account with this attribute [offer_id](https://developers.google.com/shopping-content/reference/rest/v2.1/products#Product.FIELDS.offer_id)",
+ "id": "UrlSettings",
+ "properties": {
+ "cartUriTemplate": {
+ "description": "URL template when the placeholders are expanded will redirect the buyer to the cart page on the merchant website with the selected item in cart.",
+ "type": "string"
+ },
+ "checkoutUriTemplate": {
+ "description": "URL template when the placeholders are expanded will redirect the buyer to the merchant checkout page with the item in the cart.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"Value": {
"description": "The single value of a rate group or the value of a rate group table's cell. Exactly one of `noShipping`, `flatRate`, `pricePercentage`, `carrierRateName`, `subtableName` must be set.",
"id": "Value",