|
1332 | 1332 | "https://www.googleapis.com/auth/content" |
1333 | 1333 | ] |
1334 | 1334 | } |
| 1335 | + }, |
| 1336 | + "resources": { |
| 1337 | + "checkoutSettings": { |
| 1338 | + "methods": { |
| 1339 | + "create": { |
| 1340 | + "description": "Creates `CheckoutSettings` for the given merchant.", |
| 1341 | + "flatPath": "accounts/v1beta/accounts/{accountsId}/programs/{programsId}/checkoutSettings", |
| 1342 | + "httpMethod": "POST", |
| 1343 | + "id": "merchantapi.accounts.programs.checkoutSettings.create", |
| 1344 | + "parameterOrder": [ |
| 1345 | + "parent" |
| 1346 | + ], |
| 1347 | + "parameters": { |
| 1348 | + "parent": { |
| 1349 | + "description": "Required. The merchant account for which the `CheckoutSettings` will be created.", |
| 1350 | + "location": "path", |
| 1351 | + "pattern": "^accounts/[^/]+/programs/[^/]+$", |
| 1352 | + "required": true, |
| 1353 | + "type": "string" |
| 1354 | + } |
| 1355 | + }, |
| 1356 | + "path": "accounts/v1beta/{+parent}/checkoutSettings", |
| 1357 | + "request": { |
| 1358 | + "$ref": "CheckoutSettings" |
| 1359 | + }, |
| 1360 | + "response": { |
| 1361 | + "$ref": "CheckoutSettings" |
| 1362 | + }, |
| 1363 | + "scopes": [ |
| 1364 | + "https://www.googleapis.com/auth/content" |
| 1365 | + ] |
| 1366 | + }, |
| 1367 | + "deleteCheckoutSettings": { |
| 1368 | + "description": "Deletes `CheckoutSettings` and unenrolls merchant from `Checkout` program.", |
| 1369 | + "flatPath": "accounts/v1beta/accounts/{accountsId}/programs/{programsId}/checkoutSettings", |
| 1370 | + "httpMethod": "DELETE", |
| 1371 | + "id": "merchantapi.accounts.programs.checkoutSettings.deleteCheckoutSettings", |
| 1372 | + "parameterOrder": [ |
| 1373 | + "name" |
| 1374 | + ], |
| 1375 | + "parameters": { |
| 1376 | + "name": { |
| 1377 | + "description": "Required. The name/identifier of the merchant account. Format: `accounts/{account}/programs/{program}/checkoutSettings`", |
| 1378 | + "location": "path", |
| 1379 | + "pattern": "^accounts/[^/]+/programs/[^/]+/checkoutSettings$", |
| 1380 | + "required": true, |
| 1381 | + "type": "string" |
| 1382 | + } |
| 1383 | + }, |
| 1384 | + "path": "accounts/v1beta/{+name}", |
| 1385 | + "response": { |
| 1386 | + "$ref": "Empty" |
| 1387 | + }, |
| 1388 | + "scopes": [ |
| 1389 | + "https://www.googleapis.com/auth/content" |
| 1390 | + ] |
| 1391 | + }, |
| 1392 | + "getCheckoutSettings": { |
| 1393 | + "description": "Gets `CheckoutSettings` for the given merchant. This includes information about review state, enrollment state and URL settings.", |
| 1394 | + "flatPath": "accounts/v1beta/accounts/{accountsId}/programs/{programsId}/checkoutSettings", |
| 1395 | + "httpMethod": "GET", |
| 1396 | + "id": "merchantapi.accounts.programs.checkoutSettings.getCheckoutSettings", |
| 1397 | + "parameterOrder": [ |
| 1398 | + "name" |
| 1399 | + ], |
| 1400 | + "parameters": { |
| 1401 | + "name": { |
| 1402 | + "description": "Required. The name/identifier of the merchant account. Format: `accounts/{account}/programs/{program}/checkoutSettings`", |
| 1403 | + "location": "path", |
| 1404 | + "pattern": "^accounts/[^/]+/programs/[^/]+/checkoutSettings$", |
| 1405 | + "required": true, |
| 1406 | + "type": "string" |
| 1407 | + } |
| 1408 | + }, |
| 1409 | + "path": "accounts/v1beta/{+name}", |
| 1410 | + "response": { |
| 1411 | + "$ref": "CheckoutSettings" |
| 1412 | + }, |
| 1413 | + "scopes": [ |
| 1414 | + "https://www.googleapis.com/auth/content" |
| 1415 | + ] |
| 1416 | + }, |
| 1417 | + "updateCheckoutSettings": { |
| 1418 | + "description": "Updates `CheckoutSettings` for the given merchant.", |
| 1419 | + "flatPath": "accounts/v1beta/accounts/{accountsId}/programs/{programsId}/checkoutSettings", |
| 1420 | + "httpMethod": "PATCH", |
| 1421 | + "id": "merchantapi.accounts.programs.checkoutSettings.updateCheckoutSettings", |
| 1422 | + "parameterOrder": [ |
| 1423 | + "name" |
| 1424 | + ], |
| 1425 | + "parameters": { |
| 1426 | + "name": { |
| 1427 | + "description": "Identifier. The resource name of the program configuration settings. Format: `accounts/{account}/programs/{program}/checkoutSettings`", |
| 1428 | + "location": "path", |
| 1429 | + "pattern": "^accounts/[^/]+/programs/[^/]+/checkoutSettings$", |
| 1430 | + "required": true, |
| 1431 | + "type": "string" |
| 1432 | + }, |
| 1433 | + "updateMask": { |
| 1434 | + "description": "Required. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `eligible_destinations` - `uri_settings`", |
| 1435 | + "format": "google-fieldmask", |
| 1436 | + "location": "query", |
| 1437 | + "type": "string" |
| 1438 | + } |
| 1439 | + }, |
| 1440 | + "path": "accounts/v1beta/{+name}", |
| 1441 | + "request": { |
| 1442 | + "$ref": "CheckoutSettings" |
| 1443 | + }, |
| 1444 | + "response": { |
| 1445 | + "$ref": "CheckoutSettings" |
| 1446 | + }, |
| 1447 | + "scopes": [ |
| 1448 | + "https://www.googleapis.com/auth/content" |
| 1449 | + ] |
| 1450 | + } |
| 1451 | + } |
| 1452 | + } |
1335 | 1453 | } |
1336 | 1454 | }, |
1337 | 1455 | "regions": { |
|
2108 | 2226 | } |
2109 | 2227 | } |
2110 | 2228 | }, |
2111 | | - "revision": "20250621", |
| 2229 | + "revision": "20250628", |
2112 | 2230 | "rootUrl": "https://merchantapi.googleapis.com/", |
2113 | 2231 | "schemas": { |
2114 | 2232 | "About": { |
|
2679 | 2797 | }, |
2680 | 2798 | "type": "object" |
2681 | 2799 | }, |
| 2800 | + "CheckoutSettings": { |
| 2801 | + "description": "[CheckoutSettings](https://support.google.com/merchants/answer/13945960) for a specific merchant.", |
| 2802 | + "id": "CheckoutSettings", |
| 2803 | + "properties": { |
| 2804 | + "effectiveEnrollmentState": { |
| 2805 | + "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 (for only marketplace sellers).", |
| 2806 | + "enum": [ |
| 2807 | + "CHECKOUT_ENROLLMENT_STATE_UNSPECIFIED", |
| 2808 | + "INACTIVE", |
| 2809 | + "ENROLLED", |
| 2810 | + "OPTED_OUT" |
| 2811 | + ], |
| 2812 | + "enumDescriptions": [ |
| 2813 | + "Default enrollment state when enrollment state is not specified.", |
| 2814 | + "Merchant has not enrolled into the program.", |
| 2815 | + "Merchant has enrolled into the program by providing either an account level URL or checkout URLs as part of their feed.", |
| 2816 | + "Merchant has previously enrolled but opted out of the program." |
| 2817 | + ], |
| 2818 | + "readOnly": true, |
| 2819 | + "type": "string" |
| 2820 | + }, |
| 2821 | + "effectiveReviewState": { |
| 2822 | + "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 (for only marketplace sellers).", |
| 2823 | + "enum": [ |
| 2824 | + "CHECKOUT_REVIEW_STATE_UNSPECIFIED", |
| 2825 | + "IN_REVIEW", |
| 2826 | + "APPROVED", |
| 2827 | + "DISAPPROVED" |
| 2828 | + ], |
| 2829 | + "enumDescriptions": [ |
| 2830 | + "Default review state when review state is not specified.", |
| 2831 | + "Merchant provided URLs are being reviewed for data quality issues.", |
| 2832 | + "Merchant account has been approved. Indicates the data quality checks have passed.", |
| 2833 | + "Merchant account has been disapproved due to data quality issues." |
| 2834 | + ], |
| 2835 | + "readOnly": true, |
| 2836 | + "type": "string" |
| 2837 | + }, |
| 2838 | + "effectiveUriSettings": { |
| 2839 | + "$ref": "UriSettings", |
| 2840 | + "description": "Output only. The effective value of `uri_settings` for a given merchant. If account level settings are present then this value will be a copy of url settings. Otherwise, it will have the value of the parent account (for only marketplace sellers).", |
| 2841 | + "readOnly": true |
| 2842 | + }, |
| 2843 | + "eligibleDestinations": { |
| 2844 | + "description": "Optional. The destinations to which the checkout program applies, valid destination values are `SHOPPING_ADS`, `FREE_LISTINGS`", |
| 2845 | + "items": { |
| 2846 | + "enum": [ |
| 2847 | + "DESTINATION_ENUM_UNSPECIFIED", |
| 2848 | + "SHOPPING_ADS", |
| 2849 | + "DISPLAY_ADS", |
| 2850 | + "LOCAL_INVENTORY_ADS", |
| 2851 | + "FREE_LISTINGS", |
| 2852 | + "FREE_LOCAL_LISTINGS", |
| 2853 | + "YOUTUBE_SHOPPING", |
| 2854 | + "YOUTUBE_SHOPPING_CHECKOUT", |
| 2855 | + "YOUTUBE_AFFILIATE", |
| 2856 | + "FREE_VEHICLE_LISTINGS", |
| 2857 | + "VEHICLE_ADS", |
| 2858 | + "CLOUD_RETAIL", |
| 2859 | + "LOCAL_CLOUD_RETAIL" |
| 2860 | + ], |
| 2861 | + "enumDescriptions": [ |
| 2862 | + "Not specified.", |
| 2863 | + "[Shopping ads](https://support.google.com/google-ads/answer/2454022).", |
| 2864 | + "[Display ads](https://support.google.com/merchants/answer/6069387).", |
| 2865 | + "[Local inventory ads](https://support.google.com/merchants/answer/3057972).", |
| 2866 | + "[Free listings](https://support.google.com/merchants/answer/9199328).", |
| 2867 | + "[Free local product listings](https://support.google.com/merchants/answer/9825611).", |
| 2868 | + "[YouTube Shopping](https://support.google.com/merchants/answer/12362804).", |
| 2869 | + "Youtube shopping checkout.", |
| 2870 | + "[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).", |
| 2871 | + "[Free vehicle listings](https://support.google.com/merchants/answer/11189169).", |
| 2872 | + "[Vehicle ads](https://support.google.com/merchants/answer/11189169).", |
| 2873 | + "[Cloud retail](https://cloud.google.com/solutions/retail).", |
| 2874 | + "[Local cloud retail](https://cloud.google.com/solutions/retail)." |
| 2875 | + ], |
| 2876 | + "type": "string" |
| 2877 | + }, |
| 2878 | + "type": "array" |
| 2879 | + }, |
| 2880 | + "enrollmentState": { |
| 2881 | + "description": "Output only. Reflects the merchant enrollment state in `Checkout` program.", |
| 2882 | + "enum": [ |
| 2883 | + "CHECKOUT_ENROLLMENT_STATE_UNSPECIFIED", |
| 2884 | + "INACTIVE", |
| 2885 | + "ENROLLED", |
| 2886 | + "OPTED_OUT" |
| 2887 | + ], |
| 2888 | + "enumDescriptions": [ |
| 2889 | + "Default enrollment state when enrollment state is not specified.", |
| 2890 | + "Merchant has not enrolled into the program.", |
| 2891 | + "Merchant has enrolled into the program by providing either an account level URL or checkout URLs as part of their feed.", |
| 2892 | + "Merchant has previously enrolled but opted out of the program." |
| 2893 | + ], |
| 2894 | + "readOnly": true, |
| 2895 | + "type": "string" |
| 2896 | + }, |
| 2897 | + "name": { |
| 2898 | + "description": "Identifier. The resource name of the program configuration settings. Format: `accounts/{account}/programs/{program}/checkoutSettings`", |
| 2899 | + "type": "string" |
| 2900 | + }, |
| 2901 | + "reviewState": { |
| 2902 | + "description": "Output only. Reflects the merchant review state in `Checkout` program. 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.For more details, check the help center doc.", |
| 2903 | + "enum": [ |
| 2904 | + "CHECKOUT_REVIEW_STATE_UNSPECIFIED", |
| 2905 | + "IN_REVIEW", |
| 2906 | + "APPROVED", |
| 2907 | + "DISAPPROVED" |
| 2908 | + ], |
| 2909 | + "enumDescriptions": [ |
| 2910 | + "Default review state when review state is not specified.", |
| 2911 | + "Merchant provided URLs are being reviewed for data quality issues.", |
| 2912 | + "Merchant account has been approved. Indicates the data quality checks have passed.", |
| 2913 | + "Merchant account has been disapproved due to data quality issues." |
| 2914 | + ], |
| 2915 | + "readOnly": true, |
| 2916 | + "type": "string" |
| 2917 | + }, |
| 2918 | + "uriSettings": { |
| 2919 | + "$ref": "UriSettings", |
| 2920 | + "description": "URI settings for cart or checkout URL." |
| 2921 | + } |
| 2922 | + }, |
| 2923 | + "type": "object" |
| 2924 | + }, |
2682 | 2925 | "ClaimHomepageRequest": { |
2683 | 2926 | "description": "Request message for the `ClaimHomepage` method.", |
2684 | 2927 | "id": "ClaimHomepageRequest", |
|
4910 | 5153 | "properties": {}, |
4911 | 5154 | "type": "object" |
4912 | 5155 | }, |
| 5156 | + "UriSettings": { |
| 5157 | + "description": "URL settings for cart or checkout URL.", |
| 5158 | + "id": "UriSettings", |
| 5159 | + "properties": { |
| 5160 | + "cartUriTemplate": { |
| 5161 | + "description": "Cart 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. For more details, check the [help center doc](https://support.google.com/merchants/answer/13945960#method1&zippy=%2Cproduct-level-url-formatting%2Caccount-level-url-formatting)", |
| 5162 | + "type": "string" |
| 5163 | + }, |
| 5164 | + "checkoutUriTemplate": { |
| 5165 | + "description": "Checkout URL template. When the placeholders are expanded will redirect the buyer to the merchant checkout page with the item in the cart. For more details, check the [help center doc](https://support.google.com/merchants/answer/13945960#method1&zippy=%2Cproduct-level-url-formatting%2Caccount-level-url-formatting)", |
| 5166 | + "type": "string" |
| 5167 | + } |
| 5168 | + }, |
| 5169 | + "type": "object" |
| 5170 | + }, |
4913 | 5171 | "User": { |
4914 | 5172 | "description": "The `User` message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).", |
4915 | 5173 | "id": "User", |
|
0 commit comments