@googleapis/merchantapi 17.2.0 → 17.4.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 +15 -0
- package/accounts_v1.ts +180 -12
- package/accounts_v1beta.ts +179 -12
- package/build/accounts_v1.d.ts +102 -12
- package/build/accounts_v1.js +32 -0
- package/build/accounts_v1.js.map +1 -1
- package/build/accounts_v1beta.d.ts +102 -12
- package/build/accounts_v1beta.js +32 -0
- package/build/accounts_v1beta.js.map +1 -1
- package/build/datasources_v1.d.ts +4 -4
- package/build/datasources_v1beta.d.ts +4 -4
- package/build/inventories_v1.d.ts +67 -14
- package/build/inventories_v1.js.map +1 -1
- package/build/inventories_v1beta.d.ts +26 -14
- package/build/inventories_v1beta.js.map +1 -1
- package/build/issueresolution_v1.d.ts +3 -3
- package/build/issueresolution_v1beta.d.ts +3 -3
- package/build/notifications_v1.d.ts +2 -2
- package/build/notifications_v1beta.d.ts +2 -2
- package/build/products_v1.d.ts +231 -12
- package/build/products_v1.js.map +1 -1
- package/build/products_v1beta.d.ts +41 -12
- package/build/products_v1beta.js.map +1 -1
- package/build/promotions_v1.d.ts +66 -22
- package/build/promotions_v1.js.map +1 -1
- package/build/promotions_v1beta.d.ts +66 -22
- package/build/promotions_v1beta.js.map +1 -1
- package/build/reports_v1.d.ts +39 -6
- package/build/reports_v1.js.map +1 -1
- package/build/reports_v1beta.d.ts +39 -6
- package/build/reports_v1beta.js.map +1 -1
- package/build/tsconfig.tsbuildinfo +1 -1
- package/datasources_v1.ts +4 -4
- package/datasources_v1beta.ts +4 -4
- package/inventories_v1.ts +67 -14
- package/inventories_v1beta.ts +26 -14
- package/issueresolution_v1.ts +3 -3
- package/issueresolution_v1beta.ts +3 -3
- package/notifications_v1.ts +2 -2
- package/notifications_v1beta.ts +2 -2
- package/package.json +1 -1
- package/products_v1.ts +231 -12
- package/products_v1beta.ts +41 -12
- package/promotions_v1.ts +66 -22
- package/promotions_v1beta.ts +66 -22
- package/reports_v1.ts +39 -6
- package/reports_v1beta.ts +39 -6
|
@@ -318,7 +318,7 @@ export declare namespace merchantapi_datasources_v1 {
|
|
|
318
318
|
*/
|
|
319
319
|
contentLanguage?: string | null;
|
|
320
320
|
/**
|
|
321
|
-
* Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).
|
|
321
|
+
* Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).
|
|
322
322
|
*/
|
|
323
323
|
feedLabel?: string | null;
|
|
324
324
|
}
|
|
@@ -348,7 +348,7 @@ export declare namespace merchantapi_datasources_v1 {
|
|
|
348
348
|
*/
|
|
349
349
|
destinations?: Schema$Destination[];
|
|
350
350
|
/**
|
|
351
|
-
* Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).
|
|
351
|
+
* Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). For more information about feed label, see [Create a primary data source for products](https://developers.google.com/merchant/api/guides/data-sources/api-sources#create-primary-data-source). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction.
|
|
352
352
|
*/
|
|
353
353
|
feedLabel?: string | null;
|
|
354
354
|
/**
|
|
@@ -442,7 +442,7 @@ export declare namespace merchantapi_datasources_v1 {
|
|
|
442
442
|
*/
|
|
443
443
|
contentLanguage?: string | null;
|
|
444
444
|
/**
|
|
445
|
-
* Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).
|
|
445
|
+
* Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).
|
|
446
446
|
*/
|
|
447
447
|
feedLabel?: string | null;
|
|
448
448
|
}
|
|
@@ -455,7 +455,7 @@ export declare namespace merchantapi_datasources_v1 {
|
|
|
455
455
|
*/
|
|
456
456
|
contentLanguage?: string | null;
|
|
457
457
|
/**
|
|
458
|
-
* Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).
|
|
458
|
+
* Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction.
|
|
459
459
|
*/
|
|
460
460
|
feedLabel?: string | null;
|
|
461
461
|
/**
|
|
@@ -318,7 +318,7 @@ export declare namespace merchantapi_datasources_v1beta {
|
|
|
318
318
|
*/
|
|
319
319
|
contentLanguage?: string | null;
|
|
320
320
|
/**
|
|
321
|
-
* Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).
|
|
321
|
+
* Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).
|
|
322
322
|
*/
|
|
323
323
|
feedLabel?: string | null;
|
|
324
324
|
}
|
|
@@ -352,7 +352,7 @@ export declare namespace merchantapi_datasources_v1beta {
|
|
|
352
352
|
*/
|
|
353
353
|
destinations?: Schema$Destination[];
|
|
354
354
|
/**
|
|
355
|
-
* Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).
|
|
355
|
+
* Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). For more information about feed label, see [Create a primary data source for products](https://developers.google.com/merchant/api/guides/data-sources/api-sources#create-primary-data-source). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction.
|
|
356
356
|
*/
|
|
357
357
|
feedLabel?: string | null;
|
|
358
358
|
}
|
|
@@ -442,7 +442,7 @@ export declare namespace merchantapi_datasources_v1beta {
|
|
|
442
442
|
*/
|
|
443
443
|
contentLanguage?: string | null;
|
|
444
444
|
/**
|
|
445
|
-
* Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).
|
|
445
|
+
* Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).
|
|
446
446
|
*/
|
|
447
447
|
feedLabel?: string | null;
|
|
448
448
|
}
|
|
@@ -455,7 +455,7 @@ export declare namespace merchantapi_datasources_v1beta {
|
|
|
455
455
|
*/
|
|
456
456
|
contentLanguage?: string | null;
|
|
457
457
|
/**
|
|
458
|
-
* Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).
|
|
458
|
+
* Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction.
|
|
459
459
|
*/
|
|
460
460
|
feedLabel?: string | null;
|
|
461
461
|
/**
|
|
@@ -88,6 +88,39 @@ export declare namespace merchantapi_inventories_v1 {
|
|
|
88
88
|
*/
|
|
89
89
|
startTime?: string | null;
|
|
90
90
|
}
|
|
91
|
+
/**
|
|
92
|
+
* A message that represents loyalty program.
|
|
93
|
+
*/
|
|
94
|
+
export interface Schema$InventoryLoyaltyProgram {
|
|
95
|
+
/**
|
|
96
|
+
* The cashback that can be used for future purchases.
|
|
97
|
+
*/
|
|
98
|
+
cashbackForFutureUse?: Schema$Price;
|
|
99
|
+
/**
|
|
100
|
+
* The amount of loyalty points earned on a purchase.
|
|
101
|
+
*/
|
|
102
|
+
loyaltyPoints?: string | null;
|
|
103
|
+
/**
|
|
104
|
+
* A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash.
|
|
105
|
+
*/
|
|
106
|
+
memberPriceEffectiveInterval?: Schema$Interval;
|
|
107
|
+
/**
|
|
108
|
+
* The price for members of the given tier, that is, the instant discount price. Must be smaller or equal to the regular price.
|
|
109
|
+
*/
|
|
110
|
+
price?: Schema$Price;
|
|
111
|
+
/**
|
|
112
|
+
* The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a business entity and a loyalty program entity. The label must be provided if there are multiple loyalty programs available for the merchant, so that the system can associate the assets below (for example, price and points) with the correct business. The corresponding program must be linked to the Merchant Center account.
|
|
113
|
+
*/
|
|
114
|
+
programLabel?: string | null;
|
|
115
|
+
/**
|
|
116
|
+
* The label of the shipping benefit. If the field has value, this offer has loyalty shipping benefit. If the field value isn't provided, the item is not eligible for loyalty shipping for the given loyalty tier.
|
|
117
|
+
*/
|
|
118
|
+
shippingLabel?: string | null;
|
|
119
|
+
/**
|
|
120
|
+
* The label of the tier within the loyalty program. Must match one of the labels within the program.
|
|
121
|
+
*/
|
|
122
|
+
tierLabel?: string | null;
|
|
123
|
+
}
|
|
91
124
|
/**
|
|
92
125
|
* Response message for the `ListLocalInventories` method.
|
|
93
126
|
*/
|
|
@@ -122,12 +155,16 @@ export declare namespace merchantapi_inventories_v1 {
|
|
|
122
155
|
* Output only. The account that owns the product. This field will be ignored if set by the client.
|
|
123
156
|
*/
|
|
124
157
|
account?: string | null;
|
|
158
|
+
/**
|
|
159
|
+
* Output only. The unpadded base64url encoded name of the `LocalInventory` resource. Format: `accounts/{account\}/products/{product\}/localInventories/{store_code\}` where the `{product\}` segment is the unpadded base64url encoded value of the identifier of the form `content_language~feed_label~offer_id`. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123` for the decoded product ID `en~US~sku/123` and `store_code` "store123". Can be used directly as input to the API methods that require the local product identifier within the local inventory name to be encoded if it contains special characters, for example [`GetLocalInventory`](https://developers.google.com/merchant/api/reference/rest/inventories_v1/accounts.products.localInventories/get).
|
|
160
|
+
*/
|
|
161
|
+
base64EncodedName?: string | null;
|
|
125
162
|
/**
|
|
126
163
|
* Optional. A list of local inventory attributes.
|
|
127
164
|
*/
|
|
128
165
|
localInventoryAttributes?: Schema$LocalInventoryAttributes;
|
|
129
166
|
/**
|
|
130
|
-
* 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-
|
|
167
|
+
* 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-VVN-c2t1LzEyMw`. The full resource name for the local inventory would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw/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.
|
|
131
168
|
*/
|
|
132
169
|
name?: string | null;
|
|
133
170
|
/**
|
|
@@ -147,6 +184,10 @@ export declare namespace merchantapi_inventories_v1 {
|
|
|
147
184
|
* Optional. Location of the product inside the store. Maximum length is 20 bytes.
|
|
148
185
|
*/
|
|
149
186
|
instoreProductLocation?: string | null;
|
|
187
|
+
/**
|
|
188
|
+
* Optional. An optional list of loyalty programs containing applicable loyalty member prices for this product at this store. This field is used to show store-specific member prices on Local Inventory Ads (LIA). To use this, the loyalty program must be configured in Google Merchant Center. The benefits provided must match the merchant's website and be clear to members. This is only applicable for merchants in supported countries. See [Loyalty program](https://support.google.com/merchants/answer/12922446) for details on supported countries and loyalty program configuration. For local inventory specific details, see the [Local inventory data specification](https://support.google.com/merchants/answer/3061342).
|
|
189
|
+
*/
|
|
190
|
+
loyaltyPrograms?: Schema$InventoryLoyaltyProgram[];
|
|
150
191
|
/**
|
|
151
192
|
* Optional. Supported [pickup method](https://support.google.com/merchants/answer/3061342) for this product. Unless the value is `"not supported"`, this field must be submitted together with `pickupSla`.
|
|
152
193
|
*/
|
|
@@ -256,7 +297,11 @@ export declare namespace merchantapi_inventories_v1 {
|
|
|
256
297
|
*/
|
|
257
298
|
account?: string | null;
|
|
258
299
|
/**
|
|
259
|
-
* Output only. The name of the `RegionalInventory` resource. Format: `accounts/{account\}/products/{product\}/regionalInventories/{region\}`
|
|
300
|
+
* Output only. The unpadded base64url encoded name of the `RegionalInventory` resource. Format: `accounts/{account\}/products/{product\}/regionalInventories/{region\}` where the `{product\}` segment is the unpadded base64url encoded value of the identifier of the form `content_language~feed_label~offer_id`. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123` for the decoded product ID `en~US~sku/123` and `region` "region123". Can be used directly as input to the API methods that require the product identifier within the regional inventory name to be encoded if it contains special characters, for example [`GetRegionalInventory`](https://developers.google.com/merchant/api/reference/rest/inventories_v1/accounts.products.regionalInventories/get).
|
|
301
|
+
*/
|
|
302
|
+
base64EncodedName?: string | null;
|
|
303
|
+
/**
|
|
304
|
+
* 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 unpadded base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw/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.
|
|
260
305
|
*/
|
|
261
306
|
name?: string | null;
|
|
262
307
|
/**
|
|
@@ -276,6 +321,10 @@ export declare namespace merchantapi_inventories_v1 {
|
|
|
276
321
|
* Optional. [Availability](https://support.google.com/merchants/answer/14644124) of the product in this region.
|
|
277
322
|
*/
|
|
278
323
|
availability?: string | null;
|
|
324
|
+
/**
|
|
325
|
+
* Optional. An optional list of loyalty programs containing applicable loyalty member prices for this product in this region. This field is used to show region-specific member prices on Product Listing Ads (PLA). To use this, the loyalty program must be configured in Google Merchant Center, and the merchant must be using the Regional Availability and Pricing (RAAP) feature. The benefits provided must match the merchant's website and be clear to members. This is only applicable for merchants in supported countries. See [Loyalty program](https://support.google.com/merchants/answer/12922446) for details on supported countries and loyalty program configuration. Also see [Regional availability and pricing](https://support.google.com/merchants/answer/14644124) and [How to set up regional member pricing](https://support.google.com/merchants/answer/16388178) for more information.
|
|
326
|
+
*/
|
|
327
|
+
loyaltyPrograms?: Schema$InventoryLoyaltyProgram[];
|
|
279
328
|
/**
|
|
280
329
|
* Optional. Price of the product in this region.
|
|
281
330
|
*/
|
|
@@ -334,7 +383,7 @@ export declare namespace merchantapi_inventories_v1 {
|
|
|
334
383
|
*
|
|
335
384
|
* // Do the magic
|
|
336
385
|
* const res = await merchantapi.accounts.products.localInventories.delete({
|
|
337
|
-
* // 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-
|
|
386
|
+
* // 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 unpadded base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the local inventory would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw/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.
|
|
338
387
|
* name: 'accounts/my-account/products/my-product/localInventories/my-localInventorie',
|
|
339
388
|
* });
|
|
340
389
|
* console.log(res.data);
|
|
@@ -392,7 +441,7 @@ export declare namespace merchantapi_inventories_v1 {
|
|
|
392
441
|
*
|
|
393
442
|
* // Do the magic
|
|
394
443
|
* const res = await merchantapi.accounts.products.localInventories.insert({
|
|
395
|
-
* // 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-
|
|
444
|
+
* // 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 unpadded base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw`. 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.
|
|
396
445
|
* parent: 'accounts/my-account/products/my-product',
|
|
397
446
|
*
|
|
398
447
|
* // Request body metadata
|
|
@@ -400,6 +449,7 @@ export declare namespace merchantapi_inventories_v1 {
|
|
|
400
449
|
* // request body parameters
|
|
401
450
|
* // {
|
|
402
451
|
* // "account": "my_account",
|
|
452
|
+
* // "base64EncodedName": "my_base64EncodedName",
|
|
403
453
|
* // "localInventoryAttributes": {},
|
|
404
454
|
* // "name": "my_name",
|
|
405
455
|
* // "storeCode": "my_storeCode"
|
|
@@ -411,6 +461,7 @@ export declare namespace merchantapi_inventories_v1 {
|
|
|
411
461
|
* // Example response
|
|
412
462
|
* // {
|
|
413
463
|
* // "account": "my_account",
|
|
464
|
+
* // "base64EncodedName": "my_base64EncodedName",
|
|
414
465
|
* // "localInventoryAttributes": {},
|
|
415
466
|
* // "name": "my_name",
|
|
416
467
|
* // "storeCode": "my_storeCode"
|
|
@@ -470,7 +521,7 @@ export declare namespace merchantapi_inventories_v1 {
|
|
|
470
521
|
* pageSize: 'placeholder-value',
|
|
471
522
|
* // 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.
|
|
472
523
|
* pageToken: 'placeholder-value',
|
|
473
|
-
* // 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-
|
|
524
|
+
* // 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 unpadded base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw`. 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.
|
|
474
525
|
* parent: 'accounts/my-account/products/my-product',
|
|
475
526
|
* });
|
|
476
527
|
* console.log(res.data);
|
|
@@ -503,13 +554,13 @@ export declare namespace merchantapi_inventories_v1 {
|
|
|
503
554
|
}
|
|
504
555
|
export interface Params$Resource$Accounts$Products$Localinventories$Delete extends StandardParameters {
|
|
505
556
|
/**
|
|
506
|
-
* 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-
|
|
557
|
+
* 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 unpadded base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the local inventory would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw/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.
|
|
507
558
|
*/
|
|
508
559
|
name?: string;
|
|
509
560
|
}
|
|
510
561
|
export interface Params$Resource$Accounts$Products$Localinventories$Insert extends StandardParameters {
|
|
511
562
|
/**
|
|
512
|
-
* 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-
|
|
563
|
+
* 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 unpadded base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw`. 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.
|
|
513
564
|
*/
|
|
514
565
|
parent?: string;
|
|
515
566
|
/**
|
|
@@ -527,7 +578,7 @@ export declare namespace merchantapi_inventories_v1 {
|
|
|
527
578
|
*/
|
|
528
579
|
pageToken?: string;
|
|
529
580
|
/**
|
|
530
|
-
* 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-
|
|
581
|
+
* 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 unpadded base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw`. 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.
|
|
531
582
|
*/
|
|
532
583
|
parent?: string;
|
|
533
584
|
}
|
|
@@ -565,7 +616,7 @@ export declare namespace merchantapi_inventories_v1 {
|
|
|
565
616
|
*
|
|
566
617
|
* // Do the magic
|
|
567
618
|
* const res = await merchantapi.accounts.products.regionalInventories.delete({
|
|
568
|
-
* // 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-
|
|
619
|
+
* // 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 unpadded base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw/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.
|
|
569
620
|
* name: 'accounts/my-account/products/my-product/regionalInventories/my-regionalInventorie',
|
|
570
621
|
* });
|
|
571
622
|
* console.log(res.data);
|
|
@@ -623,7 +674,7 @@ export declare namespace merchantapi_inventories_v1 {
|
|
|
623
674
|
*
|
|
624
675
|
* // Do the magic
|
|
625
676
|
* const res = await merchantapi.accounts.products.regionalInventories.insert({
|
|
626
|
-
* // 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-
|
|
677
|
+
* // 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 unpadded base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw`. 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.
|
|
627
678
|
* parent: 'accounts/my-account/products/my-product',
|
|
628
679
|
*
|
|
629
680
|
* // Request body metadata
|
|
@@ -631,6 +682,7 @@ export declare namespace merchantapi_inventories_v1 {
|
|
|
631
682
|
* // request body parameters
|
|
632
683
|
* // {
|
|
633
684
|
* // "account": "my_account",
|
|
685
|
+
* // "base64EncodedName": "my_base64EncodedName",
|
|
634
686
|
* // "name": "my_name",
|
|
635
687
|
* // "region": "my_region",
|
|
636
688
|
* // "regionalInventoryAttributes": {}
|
|
@@ -642,6 +694,7 @@ export declare namespace merchantapi_inventories_v1 {
|
|
|
642
694
|
* // Example response
|
|
643
695
|
* // {
|
|
644
696
|
* // "account": "my_account",
|
|
697
|
+
* // "base64EncodedName": "my_base64EncodedName",
|
|
645
698
|
* // "name": "my_name",
|
|
646
699
|
* // "region": "my_region",
|
|
647
700
|
* // "regionalInventoryAttributes": {}
|
|
@@ -701,7 +754,7 @@ export declare namespace merchantapi_inventories_v1 {
|
|
|
701
754
|
* pageSize: 'placeholder-value',
|
|
702
755
|
* // 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.
|
|
703
756
|
* pageToken: 'placeholder-value',
|
|
704
|
-
* // 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-
|
|
757
|
+
* // 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 unpadded base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw`. 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.
|
|
705
758
|
* parent: 'accounts/my-account/products/my-product',
|
|
706
759
|
* });
|
|
707
760
|
* console.log(res.data);
|
|
@@ -734,13 +787,13 @@ export declare namespace merchantapi_inventories_v1 {
|
|
|
734
787
|
}
|
|
735
788
|
export interface Params$Resource$Accounts$Products$Regionalinventories$Delete extends StandardParameters {
|
|
736
789
|
/**
|
|
737
|
-
* 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-
|
|
790
|
+
* 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 unpadded base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw/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.
|
|
738
791
|
*/
|
|
739
792
|
name?: string;
|
|
740
793
|
}
|
|
741
794
|
export interface Params$Resource$Accounts$Products$Regionalinventories$Insert extends StandardParameters {
|
|
742
795
|
/**
|
|
743
|
-
* 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-
|
|
796
|
+
* 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 unpadded base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw`. 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.
|
|
744
797
|
*/
|
|
745
798
|
parent?: string;
|
|
746
799
|
/**
|
|
@@ -758,7 +811,7 @@ export declare namespace merchantapi_inventories_v1 {
|
|
|
758
811
|
*/
|
|
759
812
|
pageToken?: string;
|
|
760
813
|
/**
|
|
761
|
-
* 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-
|
|
814
|
+
* 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 unpadded base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw`. 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.
|
|
762
815
|
*/
|
|
763
816
|
parent?: string;
|
|
764
817
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"inventories_v1.js","sourceRoot":"","sources":["../inventories_v1.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,gDAAgD;AAChD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;;;AAEjC,uDAAuD;AACvD,sDAAsD;AACtD,0DAA0D;AAC1D,oDAAoD;AACpD,4CAA4C;AAE5C,yDAe2B;AAG3B,IAAiB,0BAA0B,
|
|
1
|
+
{"version":3,"file":"inventories_v1.js","sourceRoot":"","sources":["../inventories_v1.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,gDAAgD;AAChD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;;;AAEjC,uDAAuD;AACvD,sDAAsD;AACtD,0DAA0D;AAC1D,oDAAoD;AACpD,4CAA4C;AAE5C,yDAe2B;AAG3B,IAAiB,0BAA0B,CAkzC1C;AAlzCD,WAAiB,0BAA0B;IAgEzC;;;;;;;;;;OAUG;IACH,MAAa,WAAW;QACtB,OAAO,CAAoB;QAC3B,QAAQ,CAAoB;QAE5B,YAAY,OAAsB,EAAE,MAA2B;YAC7D,IAAI,CAAC,OAAO,GAAG;gBACb,QAAQ,EAAE,OAAO,IAAI,EAAE;gBACvB,MAAM;aACP,CAAC;YAEF,IAAI,CAAC,QAAQ,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtD,CAAC;KACF;IAZY,sCAAW,cAYvB,CAAA;IA8QD,MAAa,iBAAiB;QAC5B,OAAO,CAAoB;QAC3B,QAAQ,CAA6B;QACrC,YAAY,OAA0B;YACpC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;YACvB,IAAI,CAAC,QAAQ,GAAG,IAAI,0BAA0B,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/D,CAAC;KACF;IAPY,4CAAiB,oBAO7B,CAAA;IAED,MAAa,0BAA0B;QACrC,OAAO,CAAoB;QAC3B,gBAAgB,CAA8C;QAC9D,mBAAmB,CAAiD;QACpE,YAAY,OAA0B;YACpC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;YACvB,IAAI,CAAC,gBAAgB,GAAG,IAAI,2CAA2C,CACrE,IAAI,CAAC,OAAO,CACb,CAAC;YACF,IAAI,CAAC,mBAAmB;gBACtB,IAAI,8CAA8C,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACrE,CAAC;KACF;IAZY,qDAA0B,6BAYtC,CAAA;IAED,MAAa,2CAA2C;QACtD,OAAO,CAAoB;QAC3B,YAAY,OAA0B;YACpC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACzB,CAAC;QA6ED,MAAM,CACJ,gBAGkC,EAClC,iBAIkC,EAClC,QAEkC;YAKlC,IAAI,MAAM,GAAG,CAAC,gBAAgB;gBAC5B,EAAE,CAA8D,CAAC;YACnE,IAAI,OAAO,GAAG,CAAC,iBAAiB,IAAI,EAAE,CAAkB,CAAC;YAEzD,IAAI,OAAO,gBAAgB,KAAK,UAAU,EAAE,CAAC;gBAC3C,QAAQ,GAAG,gBAAgB,CAAC;gBAC5B,MAAM;oBACJ,EAA+D,CAAC;gBAClE,OAAO,GAAG,EAAE,CAAC;YACf,CAAC;YAED,IAAI,OAAO,iBAAiB,KAAK,UAAU,EAAE,CAAC;gBAC5C,QAAQ,GAAG,iBAAiB,CAAC;gBAC7B,OAAO,GAAG,EAAE,CAAC;YACf,CAAC;YAED,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,qCAAqC,CAAC;YACzE,MAAM,UAAU,GAAG;gBACjB,OAAO,EAAE,MAAM,CAAC,MAAM,CACpB;oBACE,GAAG,EAAE,CAAC,OAAO,GAAG,yBAAyB,CAAC,CAAC,OAAO,CAChD,cAAc,EACd,IAAI,CACL;oBACD,MAAM,EAAE,QAAQ;oBAChB,UAAU,EAAE,EAAE;iBACf,EACD,OAAO,CACR;gBACD,MAAM;gBACN,cAAc,EAAE,CAAC,MAAM,CAAC;gBACxB,UAAU,EAAE,CAAC,MAAM,CAAC;gBACpB,OAAO,EAAE,IAAI,CAAC,OAAO;aACtB,CAAC;YACF,IAAI,QAAQ,EAAE,CAAC;gBACb,IAAA,oCAAgB,EACd,UAAU,EACV,QAAyC,CAC1C,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,OAAO,IAAA,oCAAgB,EAAe,UAAU,CAAC,CAAC;YACpD,CAAC;QACH,CAAC;QA+FD,MAAM,CACJ,gBAGkC,EAClC,iBAIkC,EAClC,QAEkC;YAKlC,IAAI,MAAM,GAAG,CAAC,gBAAgB;gBAC5B,EAAE,CAA8D,CAAC;YACnE,IAAI,OAAO,GAAG,CAAC,iBAAiB,IAAI,EAAE,CAAkB,CAAC;YAEzD,IAAI,OAAO,gBAAgB,KAAK,UAAU,EAAE,CAAC;gBAC3C,QAAQ,GAAG,gBAAgB,CAAC;gBAC5B,MAAM;oBACJ,EAA+D,CAAC;gBAClE,OAAO,GAAG,EAAE,CAAC;YACf,CAAC;YAED,IAAI,OAAO,iBAAiB,KAAK,UAAU,EAAE,CAAC;gBAC5C,QAAQ,GAAG,iBAAiB,CAAC;gBAC7B,OAAO,GAAG,EAAE,CAAC;YACf,CAAC;YAED,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,qCAAqC,CAAC;YACzE,MAAM,UAAU,GAAG;gBACjB,OAAO,EAAE,MAAM,CAAC,MAAM,CACpB;oBACE,GAAG,EAAE,CACH,OAAO,GAAG,mDAAmD,CAC9D,CAAC,OAAO,CAAC,cAAc,EAAE,IAAI,CAAC;oBAC/B,MAAM,EAAE,MAAM;oBACd,UAAU,EAAE,EAAE;iBACf,EACD,OAAO,CACR;gBACD,MAAM;gBACN,cAAc,EAAE,CAAC,QAAQ,CAAC;gBAC1B,UAAU,EAAE,CAAC,QAAQ,CAAC;gBACtB,OAAO,EAAE,IAAI,CAAC,OAAO;aACtB,CAAC;YACF,IAAI,QAAQ,EAAE,CAAC;gBACb,IAAA,oCAAgB,EACd,UAAU,EACV,QAAyC,CAC1C,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,OAAO,IAAA,oCAAgB,EAAwB,UAAU,CAAC,CAAC;YAC7D,CAAC;QACH,CAAC;QAwFD,IAAI,CACF,gBAGkC,EAClC,iBAIkC,EAClC,QAEkC;YAKlC,IAAI,MAAM,GAAG,CAAC,gBAAgB;gBAC5B,EAAE,CAA4D,CAAC;YACjE,IAAI,OAAO,GAAG,CAAC,iBAAiB,IAAI,EAAE,CAAkB,CAAC;YAEzD,IAAI,OAAO,gBAAgB,KAAK,UAAU,EAAE,CAAC;gBAC3C,QAAQ,GAAG,gBAAgB,CAAC;gBAC5B,MAAM,GAAG,EAA6D,CAAC;gBACvE,OAAO,GAAG,EAAE,CAAC;YACf,CAAC;YAED,IAAI,OAAO,iBAAiB,KAAK,UAAU,EAAE,CAAC;gBAC5C,QAAQ,GAAG,iBAAiB,CAAC;gBAC7B,OAAO,GAAG,EAAE,CAAC;YACf,CAAC;YAED,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,qCAAqC,CAAC;YACzE,MAAM,UAAU,GAAG;gBACjB,OAAO,EAAE,MAAM,CAAC,MAAM,CACpB;oBACE,GAAG,EAAE,CACH,OAAO,GAAG,4CAA4C,CACvD,CAAC,OAAO,CAAC,cAAc,EAAE,IAAI,CAAC;oBAC/B,MAAM,EAAE,KAAK;oBACb,UAAU,EAAE,EAAE;iBACf,EACD,OAAO,CACR;gBACD,MAAM;gBACN,cAAc,EAAE,CAAC,QAAQ,CAAC;gBAC1B,UAAU,EAAE,CAAC,QAAQ,CAAC;gBACtB,OAAO,EAAE,IAAI,CAAC,OAAO;aACtB,CAAC;YACF,IAAI,QAAQ,EAAE,CAAC;gBACb,IAAA,oCAAgB,EACd,UAAU,EACV,QAAyC,CAC1C,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,OAAO,IAAA,oCAAgB,EACrB,UAAU,CACX,CAAC;YACJ,CAAC;QACH,CAAC;KACF;IAzbY,sEAA2C,8CAybvD,CAAA;IAkCD,MAAa,8CAA8C;QACzD,OAAO,CAAoB;QAC3B,YAAY,OAA0B;YACpC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACzB,CAAC;QA6ED,MAAM,CACJ,gBAGkC,EAClC,iBAIkC,EAClC,QAEkC;YAKlC,IAAI,MAAM,GAAG,CAAC,gBAAgB;gBAC5B,EAAE,CAAiE,CAAC;YACtE,IAAI,OAAO,GAAG,CAAC,iBAAiB,IAAI,EAAE,CAAkB,CAAC;YAEzD,IAAI,OAAO,gBAAgB,KAAK,UAAU,EAAE,CAAC;gBAC3C,QAAQ,GAAG,gBAAgB,CAAC;gBAC5B,MAAM;oBACJ,EAAkE,CAAC;gBACrE,OAAO,GAAG,EAAE,CAAC;YACf,CAAC;YAED,IAAI,OAAO,iBAAiB,KAAK,UAAU,EAAE,CAAC;gBAC5C,QAAQ,GAAG,iBAAiB,CAAC;gBAC7B,OAAO,GAAG,EAAE,CAAC;YACf,CAAC;YAED,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,qCAAqC,CAAC;YACzE,MAAM,UAAU,GAAG;gBACjB,OAAO,EAAE,MAAM,CAAC,MAAM,CACpB;oBACE,GAAG,EAAE,CAAC,OAAO,GAAG,yBAAyB,CAAC,CAAC,OAAO,CAChD,cAAc,EACd,IAAI,CACL;oBACD,MAAM,EAAE,QAAQ;oBAChB,UAAU,EAAE,EAAE;iBACf,EACD,OAAO,CACR;gBACD,MAAM;gBACN,cAAc,EAAE,CAAC,MAAM,CAAC;gBACxB,UAAU,EAAE,CAAC,MAAM,CAAC;gBACpB,OAAO,EAAE,IAAI,CAAC,OAAO;aACtB,CAAC;YACF,IAAI,QAAQ,EAAE,CAAC;gBACb,IAAA,oCAAgB,EACd,UAAU,EACV,QAAyC,CAC1C,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,OAAO,IAAA,oCAAgB,EAAe,UAAU,CAAC,CAAC;YACpD,CAAC;QACH,CAAC;QA+FD,MAAM,CACJ,gBAGkC,EAClC,iBAIkC,EAClC,QAEkC;YAKlC,IAAI,MAAM,GAAG,CAAC,gBAAgB;gBAC5B,EAAE,CAAiE,CAAC;YACtE,IAAI,OAAO,GAAG,CAAC,iBAAiB,IAAI,EAAE,CAAkB,CAAC;YAEzD,IAAI,OAAO,gBAAgB,KAAK,UAAU,EAAE,CAAC;gBAC3C,QAAQ,GAAG,gBAAgB,CAAC;gBAC5B,MAAM;oBACJ,EAAkE,CAAC;gBACrE,OAAO,GAAG,EAAE,CAAC;YACf,CAAC;YAED,IAAI,OAAO,iBAAiB,KAAK,UAAU,EAAE,CAAC;gBAC5C,QAAQ,GAAG,iBAAiB,CAAC;gBAC7B,OAAO,GAAG,EAAE,CAAC;YACf,CAAC;YAED,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,qCAAqC,CAAC;YACzE,MAAM,UAAU,GAAG;gBACjB,OAAO,EAAE,MAAM,CAAC,MAAM,CACpB;oBACE,GAAG,EAAE,CACH,OAAO,GAAG,sDAAsD,CACjE,CAAC,OAAO,CAAC,cAAc,EAAE,IAAI,CAAC;oBAC/B,MAAM,EAAE,MAAM;oBACd,UAAU,EAAE,EAAE;iBACf,EACD,OAAO,CACR;gBACD,MAAM;gBACN,cAAc,EAAE,CAAC,QAAQ,CAAC;gBAC1B,UAAU,EAAE,CAAC,QAAQ,CAAC;gBACtB,OAAO,EAAE,IAAI,CAAC,OAAO;aACtB,CAAC;YACF,IAAI,QAAQ,EAAE,CAAC;gBACb,IAAA,oCAAgB,EACd,UAAU,EACV,QAAyC,CAC1C,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,OAAO,IAAA,oCAAgB,EAA2B,UAAU,CAAC,CAAC;YAChE,CAAC;QACH,CAAC;QAwFD,IAAI,CACF,gBAGkC,EAClC,iBAIkC,EAClC,QAEkC;YAKlC,IAAI,MAAM,GAAG,CAAC,gBAAgB;gBAC5B,EAAE,CAA+D,CAAC;YACpE,IAAI,OAAO,GAAG,CAAC,iBAAiB,IAAI,EAAE,CAAkB,CAAC;YAEzD,IAAI,OAAO,gBAAgB,KAAK,UAAU,EAAE,CAAC;gBAC3C,QAAQ,GAAG,gBAAgB,CAAC;gBAC5B,MAAM;oBACJ,EAAgE,CAAC;gBACnE,OAAO,GAAG,EAAE,CAAC;YACf,CAAC;YAED,IAAI,OAAO,iBAAiB,KAAK,UAAU,EAAE,CAAC;gBAC5C,QAAQ,GAAG,iBAAiB,CAAC;gBAC7B,OAAO,GAAG,EAAE,CAAC;YACf,CAAC;YAED,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,qCAAqC,CAAC;YACzE,MAAM,UAAU,GAAG;gBACjB,OAAO,EAAE,MAAM,CAAC,MAAM,CACpB;oBACE,GAAG,EAAE,CACH,OAAO,GAAG,+CAA+C,CAC1D,CAAC,OAAO,CAAC,cAAc,EAAE,IAAI,CAAC;oBAC/B,MAAM,EAAE,KAAK;oBACb,UAAU,EAAE,EAAE;iBACf,EACD,OAAO,CACR;gBACD,MAAM;gBACN,cAAc,EAAE,CAAC,QAAQ,CAAC;gBAC1B,UAAU,EAAE,CAAC,QAAQ,CAAC;gBACtB,OAAO,EAAE,IAAI,CAAC,OAAO;aACtB,CAAC;YACF,IAAI,QAAQ,EAAE,CAAC;gBACb,IAAA,oCAAgB,EACd,UAAU,EACV,QAAyC,CAC1C,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,OAAO,IAAA,oCAAgB,EACrB,UAAU,CACX,CAAC;YACJ,CAAC;QACH,CAAC;KACF;IA1bY,yEAA8C,iDA0b1D,CAAA;AAiCH,CAAC,EAlzCgB,0BAA0B,0CAA1B,0BAA0B,QAkzC1C"}
|