@googleapis/merchantapi 16.1.0 → 17.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +23 -0
- package/accounts_v1.ts +344 -501
- package/accounts_v1beta.ts +342 -136
- package/build/accounts_v1.d.ts +194 -196
- package/build/accounts_v1.js +41 -73
- package/build/accounts_v1.js.map +1 -1
- package/build/accounts_v1beta.d.ts +194 -0
- package/build/accounts_v1beta.js +41 -0
- package/build/accounts_v1beta.js.map +1 -1
- package/build/conversions_v1.js.map +1 -1
- package/build/conversions_v1beta.js.map +1 -1
- package/build/datasources_v1.js.map +1 -1
- package/build/datasources_v1beta.js.map +1 -1
- package/build/inventories_v1.d.ts +14 -50
- package/build/inventories_v1.js.map +1 -1
- package/build/inventories_v1beta.d.ts +14 -50
- package/build/inventories_v1beta.js.map +1 -1
- package/build/issueresolution_v1.d.ts +2 -8
- package/build/issueresolution_v1.js.map +1 -1
- package/build/issueresolution_v1beta.d.ts +2 -8
- package/build/issueresolution_v1beta.js.map +1 -1
- package/build/lfp_v1.js.map +1 -1
- package/build/lfp_v1beta.js.map +1 -1
- package/build/notifications_v1.js.map +1 -1
- package/build/notifications_v1beta.js.map +1 -1
- package/build/ordertracking_v1.js.map +1 -1
- package/build/ordertracking_v1beta.js.map +1 -1
- package/build/products_v1.d.ts +11 -29
- package/build/products_v1.js.map +1 -1
- package/build/products_v1beta.d.ts +11 -29
- package/build/products_v1beta.js.map +1 -1
- package/build/promotions_v1.js.map +1 -1
- package/build/promotions_v1beta.js.map +1 -1
- package/build/quota_v1.d.ts +196 -0
- package/build/quota_v1.js +73 -0
- package/build/quota_v1.js.map +1 -1
- package/build/quota_v1beta.js.map +1 -1
- package/build/reports_v1.js.map +1 -1
- package/build/reports_v1beta.js.map +1 -1
- package/build/reviews_v1beta.js.map +1 -1
- package/build/tsconfig.tsbuildinfo +1 -1
- package/conversions_v1.ts +6 -12
- package/conversions_v1beta.ts +6 -12
- package/datasources_v1.ts +7 -14
- package/datasources_v1beta.ts +7 -14
- package/inventories_v1.ts +20 -62
- package/inventories_v1beta.ts +20 -62
- package/issueresolution_v1.ts +6 -16
- package/issueresolution_v1beta.ts +6 -16
- package/lfp_v1.ts +7 -14
- package/lfp_v1beta.ts +7 -14
- package/notifications_v1.ts +5 -10
- package/notifications_v1beta.ts +5 -10
- package/ordertracking_v1.ts +1 -2
- package/ordertracking_v1beta.ts +1 -2
- package/package.json +1 -1
- package/products_v1.ts +16 -39
- package/products_v1beta.ts +16 -39
- package/promotions_v1.ts +3 -6
- package/promotions_v1beta.ts +3 -6
- package/quota_v1.ts +357 -2
- package/quota_v1beta.ts +1 -2
- package/reports_v1.ts +1 -2
- package/reports_v1beta.ts +1 -2
- package/reviews_v1beta.ts +8 -16
package/datasources_v1beta.ts
CHANGED
|
@@ -1457,8 +1457,7 @@ export namespace merchantapi_datasources_v1beta {
|
|
|
1457
1457
|
}
|
|
1458
1458
|
}
|
|
1459
1459
|
|
|
1460
|
-
export interface Params$Resource$Accounts$Datasources$Create
|
|
1461
|
-
extends StandardParameters {
|
|
1460
|
+
export interface Params$Resource$Accounts$Datasources$Create extends StandardParameters {
|
|
1462
1461
|
/**
|
|
1463
1462
|
* Required. The account where this data source will be created. Format: `accounts/{account\}`
|
|
1464
1463
|
*/
|
|
@@ -1469,15 +1468,13 @@ export namespace merchantapi_datasources_v1beta {
|
|
|
1469
1468
|
*/
|
|
1470
1469
|
requestBody?: Schema$DataSource;
|
|
1471
1470
|
}
|
|
1472
|
-
export interface Params$Resource$Accounts$Datasources$Delete
|
|
1473
|
-
extends StandardParameters {
|
|
1471
|
+
export interface Params$Resource$Accounts$Datasources$Delete extends StandardParameters {
|
|
1474
1472
|
/**
|
|
1475
1473
|
* Required. The name of the data source to delete. Format: `accounts/{account\}/dataSources/{datasource\}`
|
|
1476
1474
|
*/
|
|
1477
1475
|
name?: string;
|
|
1478
1476
|
}
|
|
1479
|
-
export interface Params$Resource$Accounts$Datasources$Fetch
|
|
1480
|
-
extends StandardParameters {
|
|
1477
|
+
export interface Params$Resource$Accounts$Datasources$Fetch extends StandardParameters {
|
|
1481
1478
|
/**
|
|
1482
1479
|
* Required. The name of the data source resource to fetch. Format: `accounts/{account\}/dataSources/{datasource\}`
|
|
1483
1480
|
*/
|
|
@@ -1488,15 +1485,13 @@ export namespace merchantapi_datasources_v1beta {
|
|
|
1488
1485
|
*/
|
|
1489
1486
|
requestBody?: Schema$FetchDataSourceRequest;
|
|
1490
1487
|
}
|
|
1491
|
-
export interface Params$Resource$Accounts$Datasources$Get
|
|
1492
|
-
extends StandardParameters {
|
|
1488
|
+
export interface Params$Resource$Accounts$Datasources$Get extends StandardParameters {
|
|
1493
1489
|
/**
|
|
1494
1490
|
* Required. The name of the data source to retrieve. Format: `accounts/{account\}/dataSources/{datasource\}`
|
|
1495
1491
|
*/
|
|
1496
1492
|
name?: string;
|
|
1497
1493
|
}
|
|
1498
|
-
export interface Params$Resource$Accounts$Datasources$List
|
|
1499
|
-
extends StandardParameters {
|
|
1494
|
+
export interface Params$Resource$Accounts$Datasources$List extends StandardParameters {
|
|
1500
1495
|
/**
|
|
1501
1496
|
* Optional. The maximum number of data sources to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified, the maximum number of data sources will be returned.
|
|
1502
1497
|
*/
|
|
@@ -1510,8 +1505,7 @@ export namespace merchantapi_datasources_v1beta {
|
|
|
1510
1505
|
*/
|
|
1511
1506
|
parent?: string;
|
|
1512
1507
|
}
|
|
1513
|
-
export interface Params$Resource$Accounts$Datasources$Patch
|
|
1514
|
-
extends StandardParameters {
|
|
1508
|
+
export interface Params$Resource$Accounts$Datasources$Patch extends StandardParameters {
|
|
1515
1509
|
/**
|
|
1516
1510
|
* Required. Identifier. The name of the data source. Format: `accounts/{account\}/dataSources/{datasource\}`
|
|
1517
1511
|
*/
|
|
@@ -1678,8 +1672,7 @@ export namespace merchantapi_datasources_v1beta {
|
|
|
1678
1672
|
}
|
|
1679
1673
|
}
|
|
1680
1674
|
|
|
1681
|
-
export interface Params$Resource$Accounts$Datasources$Fileuploads$Get
|
|
1682
|
-
extends StandardParameters {
|
|
1675
|
+
export interface Params$Resource$Accounts$Datasources$Fileuploads$Get extends StandardParameters {
|
|
1683
1676
|
/**
|
|
1684
1677
|
* Required. The name of the data source file upload to retrieve. Format: `accounts/{account\}/dataSources/{datasource\}/fileUploads/latest`
|
|
1685
1678
|
*/
|
package/inventories_v1.ts
CHANGED
|
@@ -180,7 +180,7 @@ export namespace merchantapi_inventories_v1 {
|
|
|
180
180
|
*/
|
|
181
181
|
localInventoryAttributes?: Schema$LocalInventoryAttributes;
|
|
182
182
|
/**
|
|
183
|
-
* Output only. The name of the `LocalInventory` resource. Format: `accounts/{account\}/products/{product\}/localInventories/{store_code\}`
|
|
183
|
+
* Output only. The name of the `LocalInventory` resource. Format: `accounts/{account\}/products/{product\}/localInventories/{store_code\}` The `{product\}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product\}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `store_code` "store123", the `{product\}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the local inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/localInventories/store123`. 2. **Plain Format**: The `{product\}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product\}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a local inventory at `store_code` "store123" would be: `accounts/123/products/online~en~US~sku123/localInventories/store123`.
|
|
184
184
|
*/
|
|
185
185
|
name?: string | null;
|
|
186
186
|
/**
|
|
@@ -309,7 +309,7 @@ export namespace merchantapi_inventories_v1 {
|
|
|
309
309
|
*/
|
|
310
310
|
account?: string | null;
|
|
311
311
|
/**
|
|
312
|
-
* Output only. The name of the `RegionalInventory` resource. Format: `
|
|
312
|
+
* Output only. The name of the `RegionalInventory` resource. Format: `accounts/{account\}/products/{product\}/regionalInventories/{region\}` The `{product\}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product\}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `region` "region123", the `{product\}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/regionalInventories/region123`. 2. **Plain Format**: The `{product\}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product\}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a regional inventory in `region` "region123" would be: `accounts/123/products/online~en~US~sku123/regionalInventories/region123`.
|
|
313
313
|
*/
|
|
314
314
|
name?: string | null;
|
|
315
315
|
/**
|
|
@@ -403,10 +403,8 @@ export namespace merchantapi_inventories_v1 {
|
|
|
403
403
|
*
|
|
404
404
|
* // Do the magic
|
|
405
405
|
* const res = await merchantapi.accounts.products.localInventories.delete({
|
|
406
|
-
* // Required. The name of the local inventory for the given product to delete. Format: `accounts/{account\}/products/{product\}/localInventories/{store_code\}`
|
|
406
|
+
* // Required. The name of the local inventory for the given product to delete. Format: `accounts/{account\}/products/{product\}/localInventories/{store_code\}` The `{product\}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product\}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `store_code` "store123", the `{product\}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the local inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/localInventories/store123`. 2. **Plain Format**: The `{product\}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product\}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a local inventory at `store_code` "store123" would be: `accounts/123/products/online~en~US~sku123/localInventories/store123`.
|
|
407
407
|
* name: 'accounts/my-account/products/my-product/localInventories/my-localInventorie',
|
|
408
|
-
* // Optional. If true, the `{product\}` in the `name` field of the request will be interpreted as unpadded base64url-encoded and decoded during request processing to match the decoded value. Default value is `false`. Use this if your `{product\}` contains special characters, such as forward slash `/` or other characters that are unpadded base64url-encoded (as per RFC 7515: https://datatracker.ietf.org/doc/html/rfc7515#section-2). Note that future versions of the API will only accept unpadded base64url-encoded product ids, so we strongly recommend proactively setting this to `true` and encoding the product ids.
|
|
409
|
-
* productIdBase64UrlEncoded: 'placeholder-value',
|
|
410
408
|
* });
|
|
411
409
|
* console.log(res.data);
|
|
412
410
|
*
|
|
@@ -541,10 +539,8 @@ export namespace merchantapi_inventories_v1 {
|
|
|
541
539
|
*
|
|
542
540
|
* // Do the magic
|
|
543
541
|
* const res = await merchantapi.accounts.products.localInventories.insert({
|
|
544
|
-
* // Required. The account and product where this inventory will be inserted. Format: `accounts/{account\}/products/{product\}`
|
|
542
|
+
* // Required. The account and product where this inventory will be inserted. Format: `accounts/{account\}/products/{product\}` The `{product\}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product\}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product\}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product\}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product\}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`.
|
|
545
543
|
* parent: 'accounts/my-account/products/my-product',
|
|
546
|
-
* // Optional. If true, the `{product\}` in the `parent` field of the request will be interpreted as unpadded base64url-encoded and decoded during request processing to match the decoded value. Default value is `false`. Use this if your `{product\}` contains special characters, such as forward slash `/` or other characters that are unpadded base64url-encoded (as per RFC 7515: https://datatracker.ietf.org/doc/html/rfc7515#section-2). Note that future versions of the API will only accept unpadded base64url-encoded product ids, so we strongly recommend proactively setting this to `true` and encoding the product ids.
|
|
547
|
-
* productIdBase64UrlEncoded: 'placeholder-value',
|
|
548
544
|
*
|
|
549
545
|
* // Request body metadata
|
|
550
546
|
* requestBody: {
|
|
@@ -698,10 +694,8 @@ export namespace merchantapi_inventories_v1 {
|
|
|
698
694
|
* pageSize: 'placeholder-value',
|
|
699
695
|
* // A page token, received from a previous `ListLocalInventories` call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to `ListLocalInventories` must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.
|
|
700
696
|
* pageToken: 'placeholder-value',
|
|
701
|
-
* // Required. The `name` of the parent product to list local inventories for. Format: `accounts/{account\}/products/{product\}`
|
|
697
|
+
* // Required. The `name` of the parent product to list local inventories for. Format: `accounts/{account\}/products/{product\}` The `{product\}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product\}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product\}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product\}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product\}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`.
|
|
702
698
|
* parent: 'accounts/my-account/products/my-product',
|
|
703
|
-
* // Optional. If true, the `{product\}` in the `parent` field of the request will be interpreted as unpadded base64url-encoded and decoded during request processing to match the decoded value. Default value is `false`. Use this if your `{product\}` contains special characters, such as forward slash `/` or other characters that are unpadded base64url-encoded (as per RFC 7515: https://datatracker.ietf.org/doc/html/rfc7515#section-2). Note that future versions of the API will only accept unpadded base64url-encoded product ids, so we strongly recommend proactively setting this to `true` and encoding the product ids.
|
|
704
|
-
* productIdBase64UrlEncoded: 'placeholder-value',
|
|
705
699
|
* });
|
|
706
700
|
* console.log(res.data);
|
|
707
701
|
*
|
|
@@ -813,35 +807,24 @@ export namespace merchantapi_inventories_v1 {
|
|
|
813
807
|
}
|
|
814
808
|
}
|
|
815
809
|
|
|
816
|
-
export interface Params$Resource$Accounts$Products$Localinventories$Delete
|
|
817
|
-
extends StandardParameters {
|
|
810
|
+
export interface Params$Resource$Accounts$Products$Localinventories$Delete extends StandardParameters {
|
|
818
811
|
/**
|
|
819
|
-
* Required. The name of the local inventory for the given product to delete. Format: `accounts/{account\}/products/{product\}/localInventories/{store_code\}`
|
|
812
|
+
* Required. The name of the local inventory for the given product to delete. Format: `accounts/{account\}/products/{product\}/localInventories/{store_code\}` The `{product\}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product\}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `store_code` "store123", the `{product\}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the local inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/localInventories/store123`. 2. **Plain Format**: The `{product\}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product\}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a local inventory at `store_code` "store123" would be: `accounts/123/products/online~en~US~sku123/localInventories/store123`.
|
|
820
813
|
*/
|
|
821
814
|
name?: string;
|
|
822
|
-
/**
|
|
823
|
-
* Optional. If true, the `{product\}` in the `name` field of the request will be interpreted as unpadded base64url-encoded and decoded during request processing to match the decoded value. Default value is `false`. Use this if your `{product\}` contains special characters, such as forward slash `/` or other characters that are unpadded base64url-encoded (as per RFC 7515: https://datatracker.ietf.org/doc/html/rfc7515#section-2). Note that future versions of the API will only accept unpadded base64url-encoded product ids, so we strongly recommend proactively setting this to `true` and encoding the product ids.
|
|
824
|
-
*/
|
|
825
|
-
productIdBase64UrlEncoded?: boolean;
|
|
826
815
|
}
|
|
827
|
-
export interface Params$Resource$Accounts$Products$Localinventories$Insert
|
|
828
|
-
extends StandardParameters {
|
|
816
|
+
export interface Params$Resource$Accounts$Products$Localinventories$Insert extends StandardParameters {
|
|
829
817
|
/**
|
|
830
|
-
* Required. The account and product where this inventory will be inserted. Format: `accounts/{account\}/products/{product\}`
|
|
818
|
+
* Required. The account and product where this inventory will be inserted. Format: `accounts/{account\}/products/{product\}` The `{product\}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product\}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product\}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product\}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product\}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`.
|
|
831
819
|
*/
|
|
832
820
|
parent?: string;
|
|
833
|
-
/**
|
|
834
|
-
* Optional. If true, the `{product\}` in the `parent` field of the request will be interpreted as unpadded base64url-encoded and decoded during request processing to match the decoded value. Default value is `false`. Use this if your `{product\}` contains special characters, such as forward slash `/` or other characters that are unpadded base64url-encoded (as per RFC 7515: https://datatracker.ietf.org/doc/html/rfc7515#section-2). Note that future versions of the API will only accept unpadded base64url-encoded product ids, so we strongly recommend proactively setting this to `true` and encoding the product ids.
|
|
835
|
-
*/
|
|
836
|
-
productIdBase64UrlEncoded?: boolean;
|
|
837
821
|
|
|
838
822
|
/**
|
|
839
823
|
* Request body metadata
|
|
840
824
|
*/
|
|
841
825
|
requestBody?: Schema$LocalInventory;
|
|
842
826
|
}
|
|
843
|
-
export interface Params$Resource$Accounts$Products$Localinventories$List
|
|
844
|
-
extends StandardParameters {
|
|
827
|
+
export interface Params$Resource$Accounts$Products$Localinventories$List extends StandardParameters {
|
|
845
828
|
/**
|
|
846
829
|
* The maximum number of `LocalInventory` resources for the given product to return. The service returns fewer than this value if the number of inventories for the given product is less that than the `pageSize`. The default value is 25000. The maximum value is 25000; If a value higher than the maximum is specified, then the `pageSize` will default to the maximum
|
|
847
830
|
*/
|
|
@@ -851,13 +834,9 @@ export namespace merchantapi_inventories_v1 {
|
|
|
851
834
|
*/
|
|
852
835
|
pageToken?: string;
|
|
853
836
|
/**
|
|
854
|
-
* Required. The `name` of the parent product to list local inventories for. Format: `accounts/{account\}/products/{product\}`
|
|
837
|
+
* Required. The `name` of the parent product to list local inventories for. Format: `accounts/{account\}/products/{product\}` The `{product\}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product\}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product\}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product\}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product\}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`.
|
|
855
838
|
*/
|
|
856
839
|
parent?: string;
|
|
857
|
-
/**
|
|
858
|
-
* Optional. If true, the `{product\}` in the `parent` field of the request will be interpreted as unpadded base64url-encoded and decoded during request processing to match the decoded value. Default value is `false`. Use this if your `{product\}` contains special characters, such as forward slash `/` or other characters that are unpadded base64url-encoded (as per RFC 7515: https://datatracker.ietf.org/doc/html/rfc7515#section-2). Note that future versions of the API will only accept unpadded base64url-encoded product ids, so we strongly recommend proactively setting this to `true` and encoding the product ids.
|
|
859
|
-
*/
|
|
860
|
-
productIdBase64UrlEncoded?: boolean;
|
|
861
840
|
}
|
|
862
841
|
|
|
863
842
|
export class Resource$Accounts$Products$Regionalinventories {
|
|
@@ -897,10 +876,8 @@ export namespace merchantapi_inventories_v1 {
|
|
|
897
876
|
*
|
|
898
877
|
* // Do the magic
|
|
899
878
|
* const res = await merchantapi.accounts.products.regionalInventories.delete({
|
|
900
|
-
* // Required. The name of the `RegionalInventory` resource to delete. Format: `accounts/{account\}/products/{product\}/regionalInventories/{region\}`
|
|
879
|
+
* // Required. The name of the `RegionalInventory` resource to delete. Format: `accounts/{account\}/products/{product\}/regionalInventories/{region\}` The `{product\}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product\}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `region` "region123", the `{product\}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/regionalInventories/region123`. 2. **Plain Format**: The `{product\}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product\}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a regional inventory in `region` "region123" would be: `accounts/123/products/online~en~US~sku123/regionalInventories/region123`.
|
|
901
880
|
* name: 'accounts/my-account/products/my-product/regionalInventories/my-regionalInventorie',
|
|
902
|
-
* // Optional. If true, the `{product\}` in the `name` field of the request will be interpreted as unpadded base64url-encoded and decoded during request processing to match the decoded value. Default value is `false`. Use this if your `{product\}` contains special characters, such as forward slash `/` or other characters that are unpadded base64url-encoded (as per RFC 7515: https://datatracker.ietf.org/doc/html/rfc7515#section-2). Note that future versions of the API will only accept unpadded base64url-encoded product ids, so we strongly recommend proactively setting this to `true` and encoding the product ids.
|
|
903
|
-
* productIdBase64UrlEncoded: 'placeholder-value',
|
|
904
881
|
* });
|
|
905
882
|
* console.log(res.data);
|
|
906
883
|
*
|
|
@@ -1035,10 +1012,8 @@ export namespace merchantapi_inventories_v1 {
|
|
|
1035
1012
|
*
|
|
1036
1013
|
* // Do the magic
|
|
1037
1014
|
* const res = await merchantapi.accounts.products.regionalInventories.insert({
|
|
1038
|
-
* // Required. The account and product where this inventory will be inserted. Format: `accounts/{account\}/products/{product\}`
|
|
1015
|
+
* // Required. The account and product where this inventory will be inserted. Format: `accounts/{account\}/products/{product\}` The `{product\}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product\}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product\}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product\}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product\}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`.
|
|
1039
1016
|
* parent: 'accounts/my-account/products/my-product',
|
|
1040
|
-
* // Optional. If true, the `{product\}` in the `parent` field of the request will be interpreted as unpadded base64url-encoded and decoded during request processing to match the decoded value. Default value is `false`. Use this if your `{product\}` contains special characters, such as forward slash `/` or other characters that are unpadded base64url-encoded (as per RFC 7515: https://datatracker.ietf.org/doc/html/rfc7515#section-2). Note that future versions of the API will only accept unpadded base64url-encoded product ids, so we strongly recommend proactively setting this to `true` and encoding the product ids.
|
|
1041
|
-
* productIdBase64UrlEncoded: 'placeholder-value',
|
|
1042
1017
|
*
|
|
1043
1018
|
* // Request body metadata
|
|
1044
1019
|
* requestBody: {
|
|
@@ -1192,10 +1167,8 @@ export namespace merchantapi_inventories_v1 {
|
|
|
1192
1167
|
* pageSize: 'placeholder-value',
|
|
1193
1168
|
* // A page token, received from a previous `ListRegionalInventories` call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to `ListRegionalInventories` must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.
|
|
1194
1169
|
* pageToken: 'placeholder-value',
|
|
1195
|
-
* // Required. The `name` of the parent product to list `RegionalInventory` resources for. Format: `accounts/{account\}/products/{product\}`
|
|
1170
|
+
* // Required. The `name` of the parent product to list `RegionalInventory` resources for. Format: `accounts/{account\}/products/{product\}` The `{product\}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product\}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product\}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product\}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product\}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`.
|
|
1196
1171
|
* parent: 'accounts/my-account/products/my-product',
|
|
1197
|
-
* // Optional. If true, the `{product\}` in the `parent` field of the request will be interpreted as unpadded base64url-encoded and decoded during request processing to match the decoded value. Default value is `false`. Use this if your `{product\}` contains special characters, such as forward slash `/` or other characters that are unpadded base64url-encoded (as per RFC 7515: https://datatracker.ietf.org/doc/html/rfc7515#section-2). Note that future versions of the API will only accept unpadded base64url-encoded product ids, so we strongly recommend proactively setting this to `true` and encoding the product ids.
|
|
1198
|
-
* productIdBase64UrlEncoded: 'placeholder-value',
|
|
1199
1172
|
* });
|
|
1200
1173
|
* console.log(res.data);
|
|
1201
1174
|
*
|
|
@@ -1308,35 +1281,24 @@ export namespace merchantapi_inventories_v1 {
|
|
|
1308
1281
|
}
|
|
1309
1282
|
}
|
|
1310
1283
|
|
|
1311
|
-
export interface Params$Resource$Accounts$Products$Regionalinventories$Delete
|
|
1312
|
-
extends StandardParameters {
|
|
1284
|
+
export interface Params$Resource$Accounts$Products$Regionalinventories$Delete extends StandardParameters {
|
|
1313
1285
|
/**
|
|
1314
|
-
* Required. The name of the `RegionalInventory` resource to delete. Format: `accounts/{account\}/products/{product\}/regionalInventories/{region\}`
|
|
1286
|
+
* Required. The name of the `RegionalInventory` resource to delete. Format: `accounts/{account\}/products/{product\}/regionalInventories/{region\}` The `{product\}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product\}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `region` "region123", the `{product\}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/regionalInventories/region123`. 2. **Plain Format**: The `{product\}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product\}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a regional inventory in `region` "region123" would be: `accounts/123/products/online~en~US~sku123/regionalInventories/region123`.
|
|
1315
1287
|
*/
|
|
1316
1288
|
name?: string;
|
|
1317
|
-
/**
|
|
1318
|
-
* Optional. If true, the `{product\}` in the `name` field of the request will be interpreted as unpadded base64url-encoded and decoded during request processing to match the decoded value. Default value is `false`. Use this if your `{product\}` contains special characters, such as forward slash `/` or other characters that are unpadded base64url-encoded (as per RFC 7515: https://datatracker.ietf.org/doc/html/rfc7515#section-2). Note that future versions of the API will only accept unpadded base64url-encoded product ids, so we strongly recommend proactively setting this to `true` and encoding the product ids.
|
|
1319
|
-
*/
|
|
1320
|
-
productIdBase64UrlEncoded?: boolean;
|
|
1321
1289
|
}
|
|
1322
|
-
export interface Params$Resource$Accounts$Products$Regionalinventories$Insert
|
|
1323
|
-
extends StandardParameters {
|
|
1290
|
+
export interface Params$Resource$Accounts$Products$Regionalinventories$Insert extends StandardParameters {
|
|
1324
1291
|
/**
|
|
1325
|
-
* Required. The account and product where this inventory will be inserted. Format: `accounts/{account\}/products/{product\}`
|
|
1292
|
+
* Required. The account and product where this inventory will be inserted. Format: `accounts/{account\}/products/{product\}` The `{product\}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product\}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product\}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product\}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product\}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`.
|
|
1326
1293
|
*/
|
|
1327
1294
|
parent?: string;
|
|
1328
|
-
/**
|
|
1329
|
-
* Optional. If true, the `{product\}` in the `parent` field of the request will be interpreted as unpadded base64url-encoded and decoded during request processing to match the decoded value. Default value is `false`. Use this if your `{product\}` contains special characters, such as forward slash `/` or other characters that are unpadded base64url-encoded (as per RFC 7515: https://datatracker.ietf.org/doc/html/rfc7515#section-2). Note that future versions of the API will only accept unpadded base64url-encoded product ids, so we strongly recommend proactively setting this to `true` and encoding the product ids.
|
|
1330
|
-
*/
|
|
1331
|
-
productIdBase64UrlEncoded?: boolean;
|
|
1332
1295
|
|
|
1333
1296
|
/**
|
|
1334
1297
|
* Request body metadata
|
|
1335
1298
|
*/
|
|
1336
1299
|
requestBody?: Schema$RegionalInventory;
|
|
1337
1300
|
}
|
|
1338
|
-
export interface Params$Resource$Accounts$Products$Regionalinventories$List
|
|
1339
|
-
extends StandardParameters {
|
|
1301
|
+
export interface Params$Resource$Accounts$Products$Regionalinventories$List extends StandardParameters {
|
|
1340
1302
|
/**
|
|
1341
1303
|
* The maximum number of `RegionalInventory` resources for the given product to return. The service returns fewer than this value if the number of inventories for the given product is less that than the `pageSize`. The default value is 25000. The maximum value is 100000; If a value higher than the maximum is specified, then the `pageSize` will default to the maximum.
|
|
1342
1304
|
*/
|
|
@@ -1346,12 +1308,8 @@ export namespace merchantapi_inventories_v1 {
|
|
|
1346
1308
|
*/
|
|
1347
1309
|
pageToken?: string;
|
|
1348
1310
|
/**
|
|
1349
|
-
* Required. The `name` of the parent product to list `RegionalInventory` resources for. Format: `accounts/{account\}/products/{product\}`
|
|
1311
|
+
* Required. The `name` of the parent product to list `RegionalInventory` resources for. Format: `accounts/{account\}/products/{product\}` The `{product\}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product\}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product\}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product\}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product\}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`.
|
|
1350
1312
|
*/
|
|
1351
1313
|
parent?: string;
|
|
1352
|
-
/**
|
|
1353
|
-
* Optional. If true, the `{product\}` in the `parent` field of the request will be interpreted as unpadded base64url-encoded and decoded during request processing to match the decoded value. Default value is `false`. Use this if your `{product\}` contains special characters, such as forward slash `/` or other characters that are unpadded base64url-encoded (as per RFC 7515: https://datatracker.ietf.org/doc/html/rfc7515#section-2). Note that future versions of the API will only accept unpadded base64url-encoded product ids, so we strongly recommend proactively setting this to `true` and encoding the product ids.
|
|
1354
|
-
*/
|
|
1355
|
-
productIdBase64UrlEncoded?: boolean;
|
|
1356
1314
|
}
|
|
1357
1315
|
}
|
package/inventories_v1beta.ts
CHANGED
|
@@ -205,7 +205,7 @@ export namespace merchantapi_inventories_v1beta {
|
|
|
205
205
|
*/
|
|
206
206
|
instoreProductLocation?: string | null;
|
|
207
207
|
/**
|
|
208
|
-
* Output only. The name of the `LocalInventory` resource. Format: `accounts/{account\}/products/{product\}/localInventories/{store_code\}`
|
|
208
|
+
* Output only. The name of the `LocalInventory` resource. Format: `accounts/{account\}/products/{product\}/localInventories/{store_code\}` The `{product\}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product\}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `store_code` "store123", the `{product\}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the local inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/localInventories/store123`. 2. **Plain Format**: The `{product\}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product\}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a local inventory at `store_code` "store123" would be: `accounts/123/products/online~en~US~sku123/localInventories/store123`.
|
|
209
209
|
*/
|
|
210
210
|
name?: string | null;
|
|
211
211
|
/**
|
|
@@ -329,7 +329,7 @@ export namespace merchantapi_inventories_v1beta {
|
|
|
329
329
|
*/
|
|
330
330
|
customAttributes?: Schema$CustomAttribute[];
|
|
331
331
|
/**
|
|
332
|
-
* Output only. The name of the `RegionalInventory` resource. Format: `
|
|
332
|
+
* Output only. The name of the `RegionalInventory` resource. Format: `accounts/{account\}/products/{product\}/regionalInventories/{region\}` The `{product\}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product\}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `region` "region123", the `{product\}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/regionalInventories/region123`. 2. **Plain Format**: The `{product\}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product\}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a regional inventory in `region` "region123" would be: `accounts/123/products/online~en~US~sku123/regionalInventories/region123`.
|
|
333
333
|
*/
|
|
334
334
|
name?: string | null;
|
|
335
335
|
/**
|
|
@@ -410,10 +410,8 @@ export namespace merchantapi_inventories_v1beta {
|
|
|
410
410
|
*
|
|
411
411
|
* // Do the magic
|
|
412
412
|
* const res = await merchantapi.accounts.products.localInventories.delete({
|
|
413
|
-
* // Required. The name of the local inventory for the given product to delete. Format: `accounts/{account\}/products/{product\}/localInventories/{store_code\}`
|
|
413
|
+
* // Required. The name of the local inventory for the given product to delete. Format: `accounts/{account\}/products/{product\}/localInventories/{store_code\}` The `{product\}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product\}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `store_code` "store123", the `{product\}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the local inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/localInventories/store123`. 2. **Plain Format**: The `{product\}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product\}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a local inventory at `store_code` "store123" would be: `accounts/123/products/online~en~US~sku123/localInventories/store123`.
|
|
414
414
|
* name: 'accounts/my-account/products/my-product/localInventories/my-localInventorie',
|
|
415
|
-
* // Optional. If true, the `{product\}` in the `name` field of the request will be interpreted as unpadded base64url-encoded and decoded during request processing to match the decoded value. Default value is `false`. Use this if your `{product\}` contains special characters, such as forward slash `/` or other characters that are unpadded base64url-encoded (as per RFC 7515: https://datatracker.ietf.org/doc/html/rfc7515#section-2). Note that future versions of the API will only accept unpadded base64url-encoded product ids, so we strongly recommend proactively setting this to `true` and encoding the product ids.
|
|
416
|
-
* productIdBase64UrlEncoded: 'placeholder-value',
|
|
417
415
|
* });
|
|
418
416
|
* console.log(res.data);
|
|
419
417
|
*
|
|
@@ -548,10 +546,8 @@ export namespace merchantapi_inventories_v1beta {
|
|
|
548
546
|
*
|
|
549
547
|
* // Do the magic
|
|
550
548
|
* const res = await merchantapi.accounts.products.localInventories.insert({
|
|
551
|
-
* // Required. The account and product where this inventory will be inserted. Format: `accounts/{account\}/products/{product\}`
|
|
549
|
+
* // Required. The account and product where this inventory will be inserted. Format: `accounts/{account\}/products/{product\}` The `{product\}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product\}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product\}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product\}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product\}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`.
|
|
552
550
|
* parent: 'accounts/my-account/products/my-product',
|
|
553
|
-
* // Optional. If true, the `{product\}` in the `parent` field of the request will be interpreted as unpadded base64url-encoded and decoded during request processing to match the decoded value. Default value is `false`. Use this if your `{product\}` contains special characters, such as forward slash `/` or other characters that are unpadded base64url-encoded (as per RFC 7515: https://datatracker.ietf.org/doc/html/rfc7515#section-2). Note that future versions of the API will only accept unpadded base64url-encoded product ids, so we strongly recommend proactively setting this to `true` and encoding the product ids.
|
|
554
|
-
* productIdBase64UrlEncoded: 'placeholder-value',
|
|
555
551
|
*
|
|
556
552
|
* // Request body metadata
|
|
557
553
|
* requestBody: {
|
|
@@ -721,10 +717,8 @@ export namespace merchantapi_inventories_v1beta {
|
|
|
721
717
|
* pageSize: 'placeholder-value',
|
|
722
718
|
* // A page token, received from a previous `ListLocalInventories` call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to `ListLocalInventories` must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.
|
|
723
719
|
* pageToken: 'placeholder-value',
|
|
724
|
-
* // Required. The `name` of the parent product to list local inventories for. Format: `accounts/{account\}/products/{product\}`
|
|
720
|
+
* // Required. The `name` of the parent product to list local inventories for. Format: `accounts/{account\}/products/{product\}` The `{product\}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product\}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product\}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product\}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product\}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`.
|
|
725
721
|
* parent: 'accounts/my-account/products/my-product',
|
|
726
|
-
* // Optional. If true, the `{product\}` in the `parent` field of the request will be interpreted as unpadded base64url-encoded and decoded during request processing to match the decoded value. Default value is `false`. Use this if your `{product\}` contains special characters, such as forward slash `/` or other characters that are unpadded base64url-encoded (as per RFC 7515: https://datatracker.ietf.org/doc/html/rfc7515#section-2). Note that future versions of the API will only accept unpadded base64url-encoded product ids, so we strongly recommend proactively setting this to `true` and encoding the product ids.
|
|
727
|
-
* productIdBase64UrlEncoded: 'placeholder-value',
|
|
728
722
|
* });
|
|
729
723
|
* console.log(res.data);
|
|
730
724
|
*
|
|
@@ -836,35 +830,24 @@ export namespace merchantapi_inventories_v1beta {
|
|
|
836
830
|
}
|
|
837
831
|
}
|
|
838
832
|
|
|
839
|
-
export interface Params$Resource$Accounts$Products$Localinventories$Delete
|
|
840
|
-
extends StandardParameters {
|
|
833
|
+
export interface Params$Resource$Accounts$Products$Localinventories$Delete extends StandardParameters {
|
|
841
834
|
/**
|
|
842
|
-
* Required. The name of the local inventory for the given product to delete. Format: `accounts/{account\}/products/{product\}/localInventories/{store_code\}`
|
|
835
|
+
* Required. The name of the local inventory for the given product to delete. Format: `accounts/{account\}/products/{product\}/localInventories/{store_code\}` The `{product\}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product\}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `store_code` "store123", the `{product\}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the local inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/localInventories/store123`. 2. **Plain Format**: The `{product\}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product\}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a local inventory at `store_code` "store123" would be: `accounts/123/products/online~en~US~sku123/localInventories/store123`.
|
|
843
836
|
*/
|
|
844
837
|
name?: string;
|
|
845
|
-
/**
|
|
846
|
-
* Optional. If true, the `{product\}` in the `name` field of the request will be interpreted as unpadded base64url-encoded and decoded during request processing to match the decoded value. Default value is `false`. Use this if your `{product\}` contains special characters, such as forward slash `/` or other characters that are unpadded base64url-encoded (as per RFC 7515: https://datatracker.ietf.org/doc/html/rfc7515#section-2). Note that future versions of the API will only accept unpadded base64url-encoded product ids, so we strongly recommend proactively setting this to `true` and encoding the product ids.
|
|
847
|
-
*/
|
|
848
|
-
productIdBase64UrlEncoded?: boolean;
|
|
849
838
|
}
|
|
850
|
-
export interface Params$Resource$Accounts$Products$Localinventories$Insert
|
|
851
|
-
extends StandardParameters {
|
|
839
|
+
export interface Params$Resource$Accounts$Products$Localinventories$Insert extends StandardParameters {
|
|
852
840
|
/**
|
|
853
|
-
* Required. The account and product where this inventory will be inserted. Format: `accounts/{account\}/products/{product\}`
|
|
841
|
+
* Required. The account and product where this inventory will be inserted. Format: `accounts/{account\}/products/{product\}` The `{product\}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product\}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product\}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product\}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product\}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`.
|
|
854
842
|
*/
|
|
855
843
|
parent?: string;
|
|
856
|
-
/**
|
|
857
|
-
* Optional. If true, the `{product\}` in the `parent` field of the request will be interpreted as unpadded base64url-encoded and decoded during request processing to match the decoded value. Default value is `false`. Use this if your `{product\}` contains special characters, such as forward slash `/` or other characters that are unpadded base64url-encoded (as per RFC 7515: https://datatracker.ietf.org/doc/html/rfc7515#section-2). Note that future versions of the API will only accept unpadded base64url-encoded product ids, so we strongly recommend proactively setting this to `true` and encoding the product ids.
|
|
858
|
-
*/
|
|
859
|
-
productIdBase64UrlEncoded?: boolean;
|
|
860
844
|
|
|
861
845
|
/**
|
|
862
846
|
* Request body metadata
|
|
863
847
|
*/
|
|
864
848
|
requestBody?: Schema$LocalInventory;
|
|
865
849
|
}
|
|
866
|
-
export interface Params$Resource$Accounts$Products$Localinventories$List
|
|
867
|
-
extends StandardParameters {
|
|
850
|
+
export interface Params$Resource$Accounts$Products$Localinventories$List extends StandardParameters {
|
|
868
851
|
/**
|
|
869
852
|
* The maximum number of `LocalInventory` resources for the given product to return. The service returns fewer than this value if the number of inventories for the given product is less that than the `pageSize`. The default value is 25000. The maximum value is 25000; If a value higher than the maximum is specified, then the `pageSize` will default to the maximum
|
|
870
853
|
*/
|
|
@@ -874,13 +857,9 @@ export namespace merchantapi_inventories_v1beta {
|
|
|
874
857
|
*/
|
|
875
858
|
pageToken?: string;
|
|
876
859
|
/**
|
|
877
|
-
* Required. The `name` of the parent product to list local inventories for. Format: `accounts/{account\}/products/{product\}`
|
|
860
|
+
* Required. The `name` of the parent product to list local inventories for. Format: `accounts/{account\}/products/{product\}` The `{product\}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product\}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product\}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product\}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product\}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`.
|
|
878
861
|
*/
|
|
879
862
|
parent?: string;
|
|
880
|
-
/**
|
|
881
|
-
* Optional. If true, the `{product\}` in the `parent` field of the request will be interpreted as unpadded base64url-encoded and decoded during request processing to match the decoded value. Default value is `false`. Use this if your `{product\}` contains special characters, such as forward slash `/` or other characters that are unpadded base64url-encoded (as per RFC 7515: https://datatracker.ietf.org/doc/html/rfc7515#section-2). Note that future versions of the API will only accept unpadded base64url-encoded product ids, so we strongly recommend proactively setting this to `true` and encoding the product ids.
|
|
882
|
-
*/
|
|
883
|
-
productIdBase64UrlEncoded?: boolean;
|
|
884
863
|
}
|
|
885
864
|
|
|
886
865
|
export class Resource$Accounts$Products$Regionalinventories {
|
|
@@ -920,10 +899,8 @@ export namespace merchantapi_inventories_v1beta {
|
|
|
920
899
|
*
|
|
921
900
|
* // Do the magic
|
|
922
901
|
* const res = await merchantapi.accounts.products.regionalInventories.delete({
|
|
923
|
-
* // Required. The name of the `RegionalInventory` resource to delete. Format: `accounts/{account\}/products/{product\}/regionalInventories/{region\}`
|
|
902
|
+
* // Required. The name of the `RegionalInventory` resource to delete. Format: `accounts/{account\}/products/{product\}/regionalInventories/{region\}` The `{product\}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product\}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `region` "region123", the `{product\}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/regionalInventories/region123`. 2. **Plain Format**: The `{product\}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product\}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a regional inventory in `region` "region123" would be: `accounts/123/products/online~en~US~sku123/regionalInventories/region123`.
|
|
924
903
|
* name: 'accounts/my-account/products/my-product/regionalInventories/my-regionalInventorie',
|
|
925
|
-
* // Optional. If true, the `{product\}` in the `name` field of the request will be interpreted as unpadded base64url-encoded and decoded during request processing to match the decoded value. Default value is `false`. Use this if your `{product\}` contains special characters, such as forward slash `/` or other characters that are unpadded base64url-encoded (as per RFC 7515: https://datatracker.ietf.org/doc/html/rfc7515#section-2). Note that future versions of the API will only accept unpadded base64url-encoded product ids, so we strongly recommend proactively setting this to `true` and encoding the product ids.
|
|
926
|
-
* productIdBase64UrlEncoded: 'placeholder-value',
|
|
927
904
|
* });
|
|
928
905
|
* console.log(res.data);
|
|
929
906
|
*
|
|
@@ -1058,10 +1035,8 @@ export namespace merchantapi_inventories_v1beta {
|
|
|
1058
1035
|
*
|
|
1059
1036
|
* // Do the magic
|
|
1060
1037
|
* const res = await merchantapi.accounts.products.regionalInventories.insert({
|
|
1061
|
-
* // Required. The account and product where this inventory will be inserted. Format: `accounts/{account\}/products/{product\}`
|
|
1038
|
+
* // Required. The account and product where this inventory will be inserted. Format: `accounts/{account\}/products/{product\}` The `{product\}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product\}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product\}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product\}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product\}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`.
|
|
1062
1039
|
* parent: 'accounts/my-account/products/my-product',
|
|
1063
|
-
* // Optional. If true, the `{product\}` in the `parent` field of the request will be interpreted as unpadded base64url-encoded and decoded during request processing to match the decoded value. Default value is `false`. Use this if your `{product\}` contains special characters, such as forward slash `/` or other characters that are unpadded base64url-encoded (as per RFC 7515: https://datatracker.ietf.org/doc/html/rfc7515#section-2). Note that future versions of the API will only accept unpadded base64url-encoded product ids, so we strongly recommend proactively setting this to `true` and encoding the product ids.
|
|
1064
|
-
* productIdBase64UrlEncoded: 'placeholder-value',
|
|
1065
1040
|
*
|
|
1066
1041
|
* // Request body metadata
|
|
1067
1042
|
* requestBody: {
|
|
@@ -1224,10 +1199,8 @@ export namespace merchantapi_inventories_v1beta {
|
|
|
1224
1199
|
* pageSize: 'placeholder-value',
|
|
1225
1200
|
* // A page token, received from a previous `ListRegionalInventories` call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to `ListRegionalInventories` must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.
|
|
1226
1201
|
* pageToken: 'placeholder-value',
|
|
1227
|
-
* // Required. The `name` of the parent product to list `RegionalInventory` resources for. Format: `accounts/{account\}/products/{product\}`
|
|
1202
|
+
* // Required. The `name` of the parent product to list `RegionalInventory` resources for. Format: `accounts/{account\}/products/{product\}` The `{product\}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product\}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product\}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product\}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product\}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`.
|
|
1228
1203
|
* parent: 'accounts/my-account/products/my-product',
|
|
1229
|
-
* // Optional. If true, the `{product\}` in the `parent` field of the request will be interpreted as unpadded base64url-encoded and decoded during request processing to match the decoded value. Default value is `false`. Use this if your `{product\}` contains special characters, such as forward slash `/` or other characters that are unpadded base64url-encoded (as per RFC 7515: https://datatracker.ietf.org/doc/html/rfc7515#section-2). Note that future versions of the API will only accept unpadded base64url-encoded product ids, so we strongly recommend proactively setting this to `true` and encoding the product ids.
|
|
1230
|
-
* productIdBase64UrlEncoded: 'placeholder-value',
|
|
1231
1204
|
* });
|
|
1232
1205
|
* console.log(res.data);
|
|
1233
1206
|
*
|
|
@@ -1340,35 +1313,24 @@ export namespace merchantapi_inventories_v1beta {
|
|
|
1340
1313
|
}
|
|
1341
1314
|
}
|
|
1342
1315
|
|
|
1343
|
-
export interface Params$Resource$Accounts$Products$Regionalinventories$Delete
|
|
1344
|
-
extends StandardParameters {
|
|
1316
|
+
export interface Params$Resource$Accounts$Products$Regionalinventories$Delete extends StandardParameters {
|
|
1345
1317
|
/**
|
|
1346
|
-
* Required. The name of the `RegionalInventory` resource to delete. Format: `accounts/{account\}/products/{product\}/regionalInventories/{region\}`
|
|
1318
|
+
* Required. The name of the `RegionalInventory` resource to delete. Format: `accounts/{account\}/products/{product\}/regionalInventories/{region\}` The `{product\}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product\}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `region` "region123", the `{product\}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw/regionalInventories/region123`. 2. **Plain Format**: The `{product\}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product\}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format for the product segment is `channel~content_language~feed_label~offer_id`. For example, the full resource name for a regional inventory in `region` "region123" would be: `accounts/123/products/online~en~US~sku123/regionalInventories/region123`.
|
|
1347
1319
|
*/
|
|
1348
1320
|
name?: string;
|
|
1349
|
-
/**
|
|
1350
|
-
* Optional. If true, the `{product\}` in the `name` field of the request will be interpreted as unpadded base64url-encoded and decoded during request processing to match the decoded value. Default value is `false`. Use this if your `{product\}` contains special characters, such as forward slash `/` or other characters that are unpadded base64url-encoded (as per RFC 7515: https://datatracker.ietf.org/doc/html/rfc7515#section-2). Note that future versions of the API will only accept unpadded base64url-encoded product ids, so we strongly recommend proactively setting this to `true` and encoding the product ids.
|
|
1351
|
-
*/
|
|
1352
|
-
productIdBase64UrlEncoded?: boolean;
|
|
1353
1321
|
}
|
|
1354
|
-
export interface Params$Resource$Accounts$Products$Regionalinventories$Insert
|
|
1355
|
-
extends StandardParameters {
|
|
1322
|
+
export interface Params$Resource$Accounts$Products$Regionalinventories$Insert extends StandardParameters {
|
|
1356
1323
|
/**
|
|
1357
|
-
* Required. The account and product where this inventory will be inserted. Format: `accounts/{account\}/products/{product\}`
|
|
1324
|
+
* Required. The account and product where this inventory will be inserted. Format: `accounts/{account\}/products/{product\}` The `{product\}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product\}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product\}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product\}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product\}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`.
|
|
1358
1325
|
*/
|
|
1359
1326
|
parent?: string;
|
|
1360
|
-
/**
|
|
1361
|
-
* Optional. If true, the `{product\}` in the `parent` field of the request will be interpreted as unpadded base64url-encoded and decoded during request processing to match the decoded value. Default value is `false`. Use this if your `{product\}` contains special characters, such as forward slash `/` or other characters that are unpadded base64url-encoded (as per RFC 7515: https://datatracker.ietf.org/doc/html/rfc7515#section-2). Note that future versions of the API will only accept unpadded base64url-encoded product ids, so we strongly recommend proactively setting this to `true` and encoding the product ids.
|
|
1362
|
-
*/
|
|
1363
|
-
productIdBase64UrlEncoded?: boolean;
|
|
1364
1327
|
|
|
1365
1328
|
/**
|
|
1366
1329
|
* Request body metadata
|
|
1367
1330
|
*/
|
|
1368
1331
|
requestBody?: Schema$RegionalInventory;
|
|
1369
1332
|
}
|
|
1370
|
-
export interface Params$Resource$Accounts$Products$Regionalinventories$List
|
|
1371
|
-
extends StandardParameters {
|
|
1333
|
+
export interface Params$Resource$Accounts$Products$Regionalinventories$List extends StandardParameters {
|
|
1372
1334
|
/**
|
|
1373
1335
|
* The maximum number of `RegionalInventory` resources for the given product to return. The service returns fewer than this value if the number of inventories for the given product is less that than the `pageSize`. The default value is 25000. The maximum value is 100000; If a value higher than the maximum is specified, then the `pageSize` will default to the maximum.
|
|
1374
1336
|
*/
|
|
@@ -1378,12 +1340,8 @@ export namespace merchantapi_inventories_v1beta {
|
|
|
1378
1340
|
*/
|
|
1379
1341
|
pageToken?: string;
|
|
1380
1342
|
/**
|
|
1381
|
-
* Required. The `name` of the parent product to list `RegionalInventory` resources for. Format: `accounts/{account\}/products/{product\}`
|
|
1343
|
+
* Required. The `name` of the parent product to list `RegionalInventory` resources for. Format: `accounts/{account\}/products/{product\}` The `{product\}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product\}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product\}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product\}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{product\}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product\}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`.
|
|
1382
1344
|
*/
|
|
1383
1345
|
parent?: string;
|
|
1384
|
-
/**
|
|
1385
|
-
* Optional. If true, the `{product\}` in the `parent` field of the request will be interpreted as unpadded base64url-encoded and decoded during request processing to match the decoded value. Default value is `false`. Use this if your `{product\}` contains special characters, such as forward slash `/` or other characters that are unpadded base64url-encoded (as per RFC 7515: https://datatracker.ietf.org/doc/html/rfc7515#section-2). Note that future versions of the API will only accept unpadded base64url-encoded product ids, so we strongly recommend proactively setting this to `true` and encoding the product ids.
|
|
1386
|
-
*/
|
|
1387
|
-
productIdBase64UrlEncoded?: boolean;
|
|
1388
1346
|
}
|
|
1389
1347
|
}
|