@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/issueresolution_v1.ts
CHANGED
|
@@ -882,8 +882,7 @@ export namespace merchantapi_issueresolution_v1 {
|
|
|
882
882
|
}
|
|
883
883
|
}
|
|
884
884
|
|
|
885
|
-
export interface Params$Resource$Accounts$Aggregateproductstatuses$List
|
|
886
|
-
extends StandardParameters {
|
|
885
|
+
export interface Params$Resource$Accounts$Aggregateproductstatuses$List extends StandardParameters {
|
|
887
886
|
/**
|
|
888
887
|
* Optional. A filter expression that filters the aggregate product statuses. Filtering is only supported by the `reporting_context` and `country` field. For example: `reporting_context = "SHOPPING_ADS" AND country = "US"`.
|
|
889
888
|
*/
|
|
@@ -1094,10 +1093,8 @@ export namespace merchantapi_issueresolution_v1 {
|
|
|
1094
1093
|
* const res = await merchantapi.issueresolution.renderproductissues({
|
|
1095
1094
|
* // Optional. The [IETF BCP-47](https://tools.ietf.org/html/bcp47) language code used to localize an issue resolution content. If not set, the result will be in default language `en-US`.
|
|
1096
1095
|
* languageCode: 'placeholder-value',
|
|
1097
|
-
* // Required. The name of the product
|
|
1096
|
+
* // Required. The name of the product. 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`.
|
|
1098
1097
|
* name: 'accounts/my-account/products/my-product',
|
|
1099
|
-
* // 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.
|
|
1100
|
-
* productIdBase64UrlEncoded: 'placeholder-value',
|
|
1101
1098
|
* // Optional. The [IANA](https://www.iana.org/time-zones) timezone used to localize times in an issue resolution content. For example 'America/Los_Angeles'. If not set, results will use as a default UTC.
|
|
1102
1099
|
* timeZone: 'placeholder-value',
|
|
1103
1100
|
*
|
|
@@ -1368,8 +1365,7 @@ export namespace merchantapi_issueresolution_v1 {
|
|
|
1368
1365
|
}
|
|
1369
1366
|
}
|
|
1370
1367
|
|
|
1371
|
-
export interface Params$Resource$Issueresolution$Renderaccountissues
|
|
1372
|
-
extends StandardParameters {
|
|
1368
|
+
export interface Params$Resource$Issueresolution$Renderaccountissues extends StandardParameters {
|
|
1373
1369
|
/**
|
|
1374
1370
|
* Optional. The [IETF BCP-47](https://tools.ietf.org/html/bcp47) language code used to localize issue resolution content. If not set, the result will be in default language `en-US`.
|
|
1375
1371
|
*/
|
|
@@ -1388,20 +1384,15 @@ export namespace merchantapi_issueresolution_v1 {
|
|
|
1388
1384
|
*/
|
|
1389
1385
|
requestBody?: Schema$RenderIssuesRequestPayload;
|
|
1390
1386
|
}
|
|
1391
|
-
export interface Params$Resource$Issueresolution$Renderproductissues
|
|
1392
|
-
extends StandardParameters {
|
|
1387
|
+
export interface Params$Resource$Issueresolution$Renderproductissues extends StandardParameters {
|
|
1393
1388
|
/**
|
|
1394
1389
|
* Optional. The [IETF BCP-47](https://tools.ietf.org/html/bcp47) language code used to localize an issue resolution content. If not set, the result will be in default language `en-US`.
|
|
1395
1390
|
*/
|
|
1396
1391
|
languageCode?: string;
|
|
1397
1392
|
/**
|
|
1398
|
-
* Required. The name of the product
|
|
1393
|
+
* Required. The name of the product. 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`.
|
|
1399
1394
|
*/
|
|
1400
1395
|
name?: string;
|
|
1401
|
-
/**
|
|
1402
|
-
* 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.
|
|
1403
|
-
*/
|
|
1404
|
-
productIdBase64UrlEncoded?: boolean;
|
|
1405
1396
|
/**
|
|
1406
1397
|
* Optional. The [IANA](https://www.iana.org/time-zones) timezone used to localize times in an issue resolution content. For example 'America/Los_Angeles'. If not set, results will use as a default UTC.
|
|
1407
1398
|
*/
|
|
@@ -1412,8 +1403,7 @@ export namespace merchantapi_issueresolution_v1 {
|
|
|
1412
1403
|
*/
|
|
1413
1404
|
requestBody?: Schema$RenderIssuesRequestPayload;
|
|
1414
1405
|
}
|
|
1415
|
-
export interface Params$Resource$Issueresolution$Triggeraction
|
|
1416
|
-
extends StandardParameters {
|
|
1406
|
+
export interface Params$Resource$Issueresolution$Triggeraction extends StandardParameters {
|
|
1417
1407
|
/**
|
|
1418
1408
|
* Optional. Language code [IETF BCP 47 syntax](https://tools.ietf.org/html/bcp47) used to localize the response. If not set, the result will be in default language `en-US`.
|
|
1419
1409
|
*/
|
|
@@ -883,8 +883,7 @@ export namespace merchantapi_issueresolution_v1beta {
|
|
|
883
883
|
}
|
|
884
884
|
}
|
|
885
885
|
|
|
886
|
-
export interface Params$Resource$Accounts$Aggregateproductstatuses$List
|
|
887
|
-
extends StandardParameters {
|
|
886
|
+
export interface Params$Resource$Accounts$Aggregateproductstatuses$List extends StandardParameters {
|
|
888
887
|
/**
|
|
889
888
|
* Optional. A filter expression that filters the aggregate product statuses. Filtering is only supported by the `reporting_context` and `country` field. For example: `reporting_context = "SHOPPING_ADS" AND country = "US"`.
|
|
890
889
|
*/
|
|
@@ -1095,10 +1094,8 @@ export namespace merchantapi_issueresolution_v1beta {
|
|
|
1095
1094
|
* const res = await merchantapi.issueresolution.renderproductissues({
|
|
1096
1095
|
* // Optional. The [IETF BCP-47](https://tools.ietf.org/html/bcp47) language code used to localize an issue resolution content. If not set, the result will be in default language `en-US`.
|
|
1097
1096
|
* languageCode: 'placeholder-value',
|
|
1098
|
-
* // Required. The name of the product
|
|
1097
|
+
* // Required. The name of the product. 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`.
|
|
1099
1098
|
* name: 'accounts/my-account/products/my-product',
|
|
1100
|
-
* // 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.
|
|
1101
|
-
* productIdBase64UrlEncoded: 'placeholder-value',
|
|
1102
1099
|
* // Optional. The [IANA](https://www.iana.org/time-zones) timezone used to localize times in an issue resolution content. For example 'America/Los_Angeles'. If not set, results will use as a default UTC.
|
|
1103
1100
|
* timeZone: 'placeholder-value',
|
|
1104
1101
|
*
|
|
@@ -1369,8 +1366,7 @@ export namespace merchantapi_issueresolution_v1beta {
|
|
|
1369
1366
|
}
|
|
1370
1367
|
}
|
|
1371
1368
|
|
|
1372
|
-
export interface Params$Resource$Issueresolution$Renderaccountissues
|
|
1373
|
-
extends StandardParameters {
|
|
1369
|
+
export interface Params$Resource$Issueresolution$Renderaccountissues extends StandardParameters {
|
|
1374
1370
|
/**
|
|
1375
1371
|
* Optional. The [IETF BCP-47](https://tools.ietf.org/html/bcp47) language code used to localize issue resolution content. If not set, the result will be in default language `en-US`.
|
|
1376
1372
|
*/
|
|
@@ -1389,20 +1385,15 @@ export namespace merchantapi_issueresolution_v1beta {
|
|
|
1389
1385
|
*/
|
|
1390
1386
|
requestBody?: Schema$RenderIssuesRequestPayload;
|
|
1391
1387
|
}
|
|
1392
|
-
export interface Params$Resource$Issueresolution$Renderproductissues
|
|
1393
|
-
extends StandardParameters {
|
|
1388
|
+
export interface Params$Resource$Issueresolution$Renderproductissues extends StandardParameters {
|
|
1394
1389
|
/**
|
|
1395
1390
|
* Optional. The [IETF BCP-47](https://tools.ietf.org/html/bcp47) language code used to localize an issue resolution content. If not set, the result will be in default language `en-US`.
|
|
1396
1391
|
*/
|
|
1397
1392
|
languageCode?: string;
|
|
1398
1393
|
/**
|
|
1399
|
-
* Required. The name of the product
|
|
1394
|
+
* Required. The name of the product. 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`.
|
|
1400
1395
|
*/
|
|
1401
1396
|
name?: string;
|
|
1402
|
-
/**
|
|
1403
|
-
* 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.
|
|
1404
|
-
*/
|
|
1405
|
-
productIdBase64UrlEncoded?: boolean;
|
|
1406
1397
|
/**
|
|
1407
1398
|
* Optional. The [IANA](https://www.iana.org/time-zones) timezone used to localize times in an issue resolution content. For example 'America/Los_Angeles'. If not set, results will use as a default UTC.
|
|
1408
1399
|
*/
|
|
@@ -1413,8 +1404,7 @@ export namespace merchantapi_issueresolution_v1beta {
|
|
|
1413
1404
|
*/
|
|
1414
1405
|
requestBody?: Schema$RenderIssuesRequestPayload;
|
|
1415
1406
|
}
|
|
1416
|
-
export interface Params$Resource$Issueresolution$Triggeraction
|
|
1417
|
-
extends StandardParameters {
|
|
1407
|
+
export interface Params$Resource$Issueresolution$Triggeraction extends StandardParameters {
|
|
1418
1408
|
/**
|
|
1419
1409
|
* Optional. Language code [IETF BCP 47 syntax](https://tools.ietf.org/html/bcp47) used to localize the response. If not set, the result will be in default language `en-US`.
|
|
1420
1410
|
*/
|
package/lfp_v1.ts
CHANGED
|
@@ -671,8 +671,7 @@ export namespace merchantapi_lfp_v1 {
|
|
|
671
671
|
}
|
|
672
672
|
}
|
|
673
673
|
|
|
674
|
-
export interface Params$Resource$Accounts$Lfpinventories$Insert
|
|
675
|
-
extends StandardParameters {
|
|
674
|
+
export interface Params$Resource$Accounts$Lfpinventories$Insert extends StandardParameters {
|
|
676
675
|
/**
|
|
677
676
|
* Required. The LFP provider account. Format: `accounts/{account\}`
|
|
678
677
|
*/
|
|
@@ -829,8 +828,7 @@ export namespace merchantapi_lfp_v1 {
|
|
|
829
828
|
}
|
|
830
829
|
}
|
|
831
830
|
|
|
832
|
-
export interface Params$Resource$Accounts$Lfpmerchantstates$Get
|
|
833
|
-
extends StandardParameters {
|
|
831
|
+
export interface Params$Resource$Accounts$Lfpmerchantstates$Get extends StandardParameters {
|
|
834
832
|
/**
|
|
835
833
|
* Required. The name of the state to retrieve. Format: `accounts/{account\}/lfpMerchantStates/{target_merchant\}`. For example, `accounts/123456/lfpMerchantStates/567890`.
|
|
836
834
|
*/
|
|
@@ -1011,8 +1009,7 @@ export namespace merchantapi_lfp_v1 {
|
|
|
1011
1009
|
}
|
|
1012
1010
|
}
|
|
1013
1011
|
|
|
1014
|
-
export interface Params$Resource$Accounts$Lfpsales$Insert
|
|
1015
|
-
extends StandardParameters {
|
|
1012
|
+
export interface Params$Resource$Accounts$Lfpsales$Insert extends StandardParameters {
|
|
1016
1013
|
/**
|
|
1017
1014
|
* Required. The LFP provider account. Format: `accounts/{lfp_partner\}`
|
|
1018
1015
|
*/
|
|
@@ -1618,22 +1615,19 @@ export namespace merchantapi_lfp_v1 {
|
|
|
1618
1615
|
}
|
|
1619
1616
|
}
|
|
1620
1617
|
|
|
1621
|
-
export interface Params$Resource$Accounts$Lfpstores$Delete
|
|
1622
|
-
extends StandardParameters {
|
|
1618
|
+
export interface Params$Resource$Accounts$Lfpstores$Delete extends StandardParameters {
|
|
1623
1619
|
/**
|
|
1624
1620
|
* Required. The name of the store to delete for the target merchant account. Format: `accounts/{account\}/lfpStores/{target_merchant\}~{store_code\}`
|
|
1625
1621
|
*/
|
|
1626
1622
|
name?: string;
|
|
1627
1623
|
}
|
|
1628
|
-
export interface Params$Resource$Accounts$Lfpstores$Get
|
|
1629
|
-
extends StandardParameters {
|
|
1624
|
+
export interface Params$Resource$Accounts$Lfpstores$Get extends StandardParameters {
|
|
1630
1625
|
/**
|
|
1631
1626
|
* Required. The name of the store to retrieve. Format: `accounts/{account\}/lfpStores/{target_merchant\}~{store_code\}`
|
|
1632
1627
|
*/
|
|
1633
1628
|
name?: string;
|
|
1634
1629
|
}
|
|
1635
|
-
export interface Params$Resource$Accounts$Lfpstores$Insert
|
|
1636
|
-
extends StandardParameters {
|
|
1630
|
+
export interface Params$Resource$Accounts$Lfpstores$Insert extends StandardParameters {
|
|
1637
1631
|
/**
|
|
1638
1632
|
* Required. The LFP provider account Format: `accounts/{account\}`
|
|
1639
1633
|
*/
|
|
@@ -1644,8 +1638,7 @@ export namespace merchantapi_lfp_v1 {
|
|
|
1644
1638
|
*/
|
|
1645
1639
|
requestBody?: Schema$LfpStore;
|
|
1646
1640
|
}
|
|
1647
|
-
export interface Params$Resource$Accounts$Lfpstores$List
|
|
1648
|
-
extends StandardParameters {
|
|
1641
|
+
export interface Params$Resource$Accounts$Lfpstores$List extends StandardParameters {
|
|
1649
1642
|
/**
|
|
1650
1643
|
* Optional. The maximum number of `LfpStore` resources for the given account to return. The service returns fewer than this value if the number of stores for the given account is less than the `pageSize`. The default value is 250. The maximum value is 1000; If a value higher than the maximum is specified, then the `pageSize` will default to the maximum.
|
|
1651
1644
|
*/
|
package/lfp_v1beta.ts
CHANGED
|
@@ -670,8 +670,7 @@ export namespace merchantapi_lfp_v1beta {
|
|
|
670
670
|
}
|
|
671
671
|
}
|
|
672
672
|
|
|
673
|
-
export interface Params$Resource$Accounts$Lfpinventories$Insert
|
|
674
|
-
extends StandardParameters {
|
|
673
|
+
export interface Params$Resource$Accounts$Lfpinventories$Insert extends StandardParameters {
|
|
675
674
|
/**
|
|
676
675
|
* Required. The LFP provider account. Format: `accounts/{account\}`
|
|
677
676
|
*/
|
|
@@ -831,8 +830,7 @@ export namespace merchantapi_lfp_v1beta {
|
|
|
831
830
|
}
|
|
832
831
|
}
|
|
833
832
|
|
|
834
|
-
export interface Params$Resource$Accounts$Lfpmerchantstates$Get
|
|
835
|
-
extends StandardParameters {
|
|
833
|
+
export interface Params$Resource$Accounts$Lfpmerchantstates$Get extends StandardParameters {
|
|
836
834
|
/**
|
|
837
835
|
* Required. The name of the state to retrieve. Format: `accounts/{account\}/lfpMerchantStates/{target_merchant\}`. For example, `accounts/123456/lfpMerchantStates/567890`.
|
|
838
836
|
*/
|
|
@@ -1013,8 +1011,7 @@ export namespace merchantapi_lfp_v1beta {
|
|
|
1013
1011
|
}
|
|
1014
1012
|
}
|
|
1015
1013
|
|
|
1016
|
-
export interface Params$Resource$Accounts$Lfpsales$Insert
|
|
1017
|
-
extends StandardParameters {
|
|
1014
|
+
export interface Params$Resource$Accounts$Lfpsales$Insert extends StandardParameters {
|
|
1018
1015
|
/**
|
|
1019
1016
|
* Required. The LFP provider account. Format: `accounts/{lfp_partner\}`
|
|
1020
1017
|
*/
|
|
@@ -1626,22 +1623,19 @@ export namespace merchantapi_lfp_v1beta {
|
|
|
1626
1623
|
}
|
|
1627
1624
|
}
|
|
1628
1625
|
|
|
1629
|
-
export interface Params$Resource$Accounts$Lfpstores$Delete
|
|
1630
|
-
extends StandardParameters {
|
|
1626
|
+
export interface Params$Resource$Accounts$Lfpstores$Delete extends StandardParameters {
|
|
1631
1627
|
/**
|
|
1632
1628
|
* Required. The name of the store to delete for the target merchant account. Format: `accounts/{account\}/lfpStores/{target_merchant\}~{store_code\}`
|
|
1633
1629
|
*/
|
|
1634
1630
|
name?: string;
|
|
1635
1631
|
}
|
|
1636
|
-
export interface Params$Resource$Accounts$Lfpstores$Get
|
|
1637
|
-
extends StandardParameters {
|
|
1632
|
+
export interface Params$Resource$Accounts$Lfpstores$Get extends StandardParameters {
|
|
1638
1633
|
/**
|
|
1639
1634
|
* Required. The name of the store to retrieve. Format: `accounts/{account\}/lfpStores/{target_merchant\}~{store_code\}`
|
|
1640
1635
|
*/
|
|
1641
1636
|
name?: string;
|
|
1642
1637
|
}
|
|
1643
|
-
export interface Params$Resource$Accounts$Lfpstores$Insert
|
|
1644
|
-
extends StandardParameters {
|
|
1638
|
+
export interface Params$Resource$Accounts$Lfpstores$Insert extends StandardParameters {
|
|
1645
1639
|
/**
|
|
1646
1640
|
* Required. The LFP provider account Format: `accounts/{account\}`
|
|
1647
1641
|
*/
|
|
@@ -1652,8 +1646,7 @@ export namespace merchantapi_lfp_v1beta {
|
|
|
1652
1646
|
*/
|
|
1653
1647
|
requestBody?: Schema$LfpStore;
|
|
1654
1648
|
}
|
|
1655
|
-
export interface Params$Resource$Accounts$Lfpstores$List
|
|
1656
|
-
extends StandardParameters {
|
|
1649
|
+
export interface Params$Resource$Accounts$Lfpstores$List extends StandardParameters {
|
|
1657
1650
|
/**
|
|
1658
1651
|
* Optional. The maximum number of `LfpStore` resources for the given account to return. The service returns fewer than this value if the number of stores for the given account is less than the `pageSize`. The default value is 250. The maximum value is 1000; If a value higher than the maximum is specified, then the `pageSize` will default to the maximum.
|
|
1659
1652
|
*/
|
package/notifications_v1.ts
CHANGED
|
@@ -992,8 +992,7 @@ export namespace merchantapi_notifications_v1 {
|
|
|
992
992
|
}
|
|
993
993
|
}
|
|
994
994
|
|
|
995
|
-
export interface Params$Resource$Accounts$Notificationsubscriptions$Create
|
|
996
|
-
extends StandardParameters {
|
|
995
|
+
export interface Params$Resource$Accounts$Notificationsubscriptions$Create extends StandardParameters {
|
|
997
996
|
/**
|
|
998
997
|
* Required. The merchant account that owns the new notification subscription. Format: `accounts/{account\}`
|
|
999
998
|
*/
|
|
@@ -1004,22 +1003,19 @@ export namespace merchantapi_notifications_v1 {
|
|
|
1004
1003
|
*/
|
|
1005
1004
|
requestBody?: Schema$NotificationSubscription;
|
|
1006
1005
|
}
|
|
1007
|
-
export interface Params$Resource$Accounts$Notificationsubscriptions$Delete
|
|
1008
|
-
extends StandardParameters {
|
|
1006
|
+
export interface Params$Resource$Accounts$Notificationsubscriptions$Delete extends StandardParameters {
|
|
1009
1007
|
/**
|
|
1010
1008
|
* Required. The name of the notification subscription to be deleted.
|
|
1011
1009
|
*/
|
|
1012
1010
|
name?: string;
|
|
1013
1011
|
}
|
|
1014
|
-
export interface Params$Resource$Accounts$Notificationsubscriptions$Get
|
|
1015
|
-
extends StandardParameters {
|
|
1012
|
+
export interface Params$Resource$Accounts$Notificationsubscriptions$Get extends StandardParameters {
|
|
1016
1013
|
/**
|
|
1017
1014
|
* Required. The `name` of the notification subscription.
|
|
1018
1015
|
*/
|
|
1019
1016
|
name?: string;
|
|
1020
1017
|
}
|
|
1021
|
-
export interface Params$Resource$Accounts$Notificationsubscriptions$List
|
|
1022
|
-
extends StandardParameters {
|
|
1018
|
+
export interface Params$Resource$Accounts$Notificationsubscriptions$List extends StandardParameters {
|
|
1023
1019
|
/**
|
|
1024
1020
|
* The maximum number of notification subscriptions to return in a page. The default value for `page_size` is 100. The maximum value is `200`. Values above `200` will be coerced to `200`.
|
|
1025
1021
|
*/
|
|
@@ -1033,8 +1029,7 @@ export namespace merchantapi_notifications_v1 {
|
|
|
1033
1029
|
*/
|
|
1034
1030
|
parent?: string;
|
|
1035
1031
|
}
|
|
1036
|
-
export interface Params$Resource$Accounts$Notificationsubscriptions$Patch
|
|
1037
|
-
extends StandardParameters {
|
|
1032
|
+
export interface Params$Resource$Accounts$Notificationsubscriptions$Patch extends StandardParameters {
|
|
1038
1033
|
/**
|
|
1039
1034
|
* Output only. The `name` of the notification configuration. Generated by the Content API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account\}/notificationsubscriptions/{notification_subscription\}`
|
|
1040
1035
|
*/
|
package/notifications_v1beta.ts
CHANGED
|
@@ -994,8 +994,7 @@ export namespace merchantapi_notifications_v1beta {
|
|
|
994
994
|
}
|
|
995
995
|
}
|
|
996
996
|
|
|
997
|
-
export interface Params$Resource$Accounts$Notificationsubscriptions$Create
|
|
998
|
-
extends StandardParameters {
|
|
997
|
+
export interface Params$Resource$Accounts$Notificationsubscriptions$Create extends StandardParameters {
|
|
999
998
|
/**
|
|
1000
999
|
* Required. The merchant account that owns the new notification subscription. Format: `accounts/{account\}`
|
|
1001
1000
|
*/
|
|
@@ -1006,22 +1005,19 @@ export namespace merchantapi_notifications_v1beta {
|
|
|
1006
1005
|
*/
|
|
1007
1006
|
requestBody?: Schema$NotificationSubscription;
|
|
1008
1007
|
}
|
|
1009
|
-
export interface Params$Resource$Accounts$Notificationsubscriptions$Delete
|
|
1010
|
-
extends StandardParameters {
|
|
1008
|
+
export interface Params$Resource$Accounts$Notificationsubscriptions$Delete extends StandardParameters {
|
|
1011
1009
|
/**
|
|
1012
1010
|
* Required. The name of the notification subscription to be deleted.
|
|
1013
1011
|
*/
|
|
1014
1012
|
name?: string;
|
|
1015
1013
|
}
|
|
1016
|
-
export interface Params$Resource$Accounts$Notificationsubscriptions$Get
|
|
1017
|
-
extends StandardParameters {
|
|
1014
|
+
export interface Params$Resource$Accounts$Notificationsubscriptions$Get extends StandardParameters {
|
|
1018
1015
|
/**
|
|
1019
1016
|
* Required. The `name` of the notification subscription.
|
|
1020
1017
|
*/
|
|
1021
1018
|
name?: string;
|
|
1022
1019
|
}
|
|
1023
|
-
export interface Params$Resource$Accounts$Notificationsubscriptions$List
|
|
1024
|
-
extends StandardParameters {
|
|
1020
|
+
export interface Params$Resource$Accounts$Notificationsubscriptions$List extends StandardParameters {
|
|
1025
1021
|
/**
|
|
1026
1022
|
* The maximum number of notification subscriptions to return in a page. The default value for `page_size` is 100. The maximum value is `200`. Values above `200` will be coerced to `200`.
|
|
1027
1023
|
*/
|
|
@@ -1035,8 +1031,7 @@ export namespace merchantapi_notifications_v1beta {
|
|
|
1035
1031
|
*/
|
|
1036
1032
|
parent?: string;
|
|
1037
1033
|
}
|
|
1038
|
-
export interface Params$Resource$Accounts$Notificationsubscriptions$Patch
|
|
1039
|
-
extends StandardParameters {
|
|
1034
|
+
export interface Params$Resource$Accounts$Notificationsubscriptions$Patch extends StandardParameters {
|
|
1040
1035
|
/**
|
|
1041
1036
|
* Output only. The `name` of the notification configuration. Generated by the Content API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account\}/notificationsubscriptions/{notification_subscription\}`
|
|
1042
1037
|
*/
|
package/ordertracking_v1.ts
CHANGED
|
@@ -580,8 +580,7 @@ export namespace merchantapi_ordertracking_v1 {
|
|
|
580
580
|
}
|
|
581
581
|
}
|
|
582
582
|
|
|
583
|
-
export interface Params$Resource$Accounts$Ordertrackingsignals$Create
|
|
584
|
-
extends StandardParameters {
|
|
583
|
+
export interface Params$Resource$Accounts$Ordertrackingsignals$Create extends StandardParameters {
|
|
585
584
|
/**
|
|
586
585
|
* Output only. The ID that uniquely identifies this order tracking signal.
|
|
587
586
|
*/
|
package/ordertracking_v1beta.ts
CHANGED
|
@@ -584,8 +584,7 @@ export namespace merchantapi_ordertracking_v1beta {
|
|
|
584
584
|
}
|
|
585
585
|
}
|
|
586
586
|
|
|
587
|
-
export interface Params$Resource$Accounts$Ordertrackingsignals$Create
|
|
588
|
-
extends StandardParameters {
|
|
587
|
+
export interface Params$Resource$Accounts$Ordertrackingsignals$Create extends StandardParameters {
|
|
589
588
|
/**
|
|
590
589
|
* Output only. The ID that uniquely identifies this order tracking signal.
|
|
591
590
|
*/
|
package/package.json
CHANGED
package/products_v1.ts
CHANGED
|
@@ -396,7 +396,7 @@ export namespace merchantapi_products_v1 {
|
|
|
396
396
|
ratio?: number | null;
|
|
397
397
|
}
|
|
398
398
|
/**
|
|
399
|
-
* A message that represents loyalty program.
|
|
399
|
+
* LINT.IfChange(LoyaltyProgram) A message that represents loyalty program.
|
|
400
400
|
*/
|
|
401
401
|
export interface Schema$LoyaltyProgram {
|
|
402
402
|
/**
|
|
@@ -851,7 +851,7 @@ export namespace merchantapi_products_v1 {
|
|
|
851
851
|
*/
|
|
852
852
|
structuredTitle?: Schema$StructuredTitle;
|
|
853
853
|
/**
|
|
854
|
-
* Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.
|
|
854
|
+
* Number of periods (weeks, months or years) and amount of payment per period for an item with an associated subscription contract.
|
|
855
855
|
*/
|
|
856
856
|
subscriptionCost?: Schema$SubscriptionCost;
|
|
857
857
|
/**
|
|
@@ -972,7 +972,7 @@ export namespace merchantapi_products_v1 {
|
|
|
972
972
|
*/
|
|
973
973
|
legacyLocal?: boolean | null;
|
|
974
974
|
/**
|
|
975
|
-
* Identifier. The name of the product
|
|
975
|
+
* Identifier. The name of the product. Format: `accounts/{account\}/productInputs/{productinput\}` The {productinput\} 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 {productinput\} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput\}` 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 `{productinput\}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/productinputs/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{productinput\}` 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 `{productinput\}` 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/productinputs/online~en~US~sku123`.
|
|
976
976
|
*/
|
|
977
977
|
name?: string | null;
|
|
978
978
|
/**
|
|
@@ -1240,7 +1240,7 @@ export namespace merchantapi_products_v1 {
|
|
|
1240
1240
|
*/
|
|
1241
1241
|
amount?: Schema$Price;
|
|
1242
1242
|
/**
|
|
1243
|
-
* The type of subscription period. Supported values are: * "`month`" * "`year`"
|
|
1243
|
+
* The type of subscription period. Supported values are: * "`month`" * "`year`" * "`week`"
|
|
1244
1244
|
*/
|
|
1245
1245
|
period?: string | null;
|
|
1246
1246
|
/**
|
|
@@ -1325,10 +1325,8 @@ export namespace merchantapi_products_v1 {
|
|
|
1325
1325
|
* const res = await merchantapi.accounts.productInputs.delete({
|
|
1326
1326
|
* // Required. The primary or supplemental data source from which the product input should be deleted. Format: `accounts/{account\}/dataSources/{datasource\}`. For example, `accounts/123456/dataSources/104628`.
|
|
1327
1327
|
* dataSource: 'placeholder-value',
|
|
1328
|
-
* // Required. The name of the product input
|
|
1328
|
+
* // Required. The name of the product input to delete. Format: `accounts/{account\}/productInputs/{productInput\}` The {productInput\} 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 {productInput\} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productInput\}` 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 `{productInput\}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/productInputs/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{productInput\}` 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 `{productInput\}` 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/productinputs/online~en~US~sku123`.
|
|
1329
1329
|
* name: 'accounts/my-account/productInputs/my-productInput',
|
|
1330
|
-
* // Optional. If true, the `{productInput\}` 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 `{productInput\}` 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.
|
|
1331
|
-
* productIdBase64UrlEncoded: 'placeholder-value',
|
|
1332
1330
|
* });
|
|
1333
1331
|
* console.log(res.data);
|
|
1334
1332
|
*
|
|
@@ -1594,7 +1592,7 @@ export namespace merchantapi_products_v1 {
|
|
|
1594
1592
|
}
|
|
1595
1593
|
|
|
1596
1594
|
/**
|
|
1597
|
-
* Updates the existing product input in your Merchant Center account. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.
|
|
1595
|
+
* Updates the existing product input in your Merchant Center account. The name of the product input to update is taken from the `name` field within the `ProductInput` resource. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.
|
|
1598
1596
|
* @example
|
|
1599
1597
|
* ```js
|
|
1600
1598
|
* // Before running the sample:
|
|
@@ -1626,10 +1624,8 @@ export namespace merchantapi_products_v1 {
|
|
|
1626
1624
|
* const res = await merchantapi.accounts.productInputs.patch({
|
|
1627
1625
|
* // Required. The primary or supplemental product data source where `data_source` name identifies the product input to be updated. Only API data sources are supported. Format: `accounts/{account\}/dataSources/{datasource\}`. For example, `accounts/123456/dataSources/104628`.
|
|
1628
1626
|
* dataSource: 'placeholder-value',
|
|
1629
|
-
* // Identifier. The name of the product
|
|
1627
|
+
* // Identifier. The name of the product. Format: `accounts/{account\}/productInputs/{productinput\}` The {productinput\} 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 {productinput\} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput\}` 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 `{productinput\}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/productinputs/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{productinput\}` 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 `{productinput\}` 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/productinputs/online~en~US~sku123`.
|
|
1630
1628
|
* name: 'accounts/my-account/productInputs/my-productInput',
|
|
1631
|
-
* // Optional. If true, the `{productInput\}` 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 `{productInput\}` 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.
|
|
1632
|
-
* productIdBase64UrlEncoded: 'placeholder-value',
|
|
1633
1629
|
* // Optional. The list of product attributes to be updated. If the update mask is omitted, then it is treated as implied field mask equivalent to all fields that are populated (have a non-empty value). Attributes specified in the update mask without a value specified in the body will be deleted from the product. Update mask can only be specified for top level fields in attributes and custom attributes. To specify the update mask for custom attributes you need to add the `custom_attribute.` prefix. Providing special "*" value for full product replacement is not supported.
|
|
1634
1630
|
* updateMask: 'placeholder-value',
|
|
1635
1631
|
*
|
|
@@ -1761,23 +1757,17 @@ export namespace merchantapi_products_v1 {
|
|
|
1761
1757
|
}
|
|
1762
1758
|
}
|
|
1763
1759
|
|
|
1764
|
-
export interface Params$Resource$Accounts$Productinputs$Delete
|
|
1765
|
-
extends StandardParameters {
|
|
1760
|
+
export interface Params$Resource$Accounts$Productinputs$Delete extends StandardParameters {
|
|
1766
1761
|
/**
|
|
1767
1762
|
* Required. The primary or supplemental data source from which the product input should be deleted. Format: `accounts/{account\}/dataSources/{datasource\}`. For example, `accounts/123456/dataSources/104628`.
|
|
1768
1763
|
*/
|
|
1769
1764
|
dataSource?: string;
|
|
1770
1765
|
/**
|
|
1771
|
-
* Required. The name of the product input
|
|
1766
|
+
* Required. The name of the product input to delete. Format: `accounts/{account\}/productInputs/{productInput\}` The {productInput\} 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 {productInput\} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productInput\}` 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 `{productInput\}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/productInputs/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{productInput\}` 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 `{productInput\}` 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/productinputs/online~en~US~sku123`.
|
|
1772
1767
|
*/
|
|
1773
1768
|
name?: string;
|
|
1774
|
-
/**
|
|
1775
|
-
* Optional. If true, the `{productInput\}` 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 `{productInput\}` 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.
|
|
1776
|
-
*/
|
|
1777
|
-
productIdBase64UrlEncoded?: boolean;
|
|
1778
1769
|
}
|
|
1779
|
-
export interface Params$Resource$Accounts$Productinputs$Insert
|
|
1780
|
-
extends StandardParameters {
|
|
1770
|
+
export interface Params$Resource$Accounts$Productinputs$Insert extends StandardParameters {
|
|
1781
1771
|
/**
|
|
1782
1772
|
* Required. The primary or supplemental product data source name. If the product already exists and data source provided is different, then the product will be moved to a new data source. For more information, see [Create a primary data source](/merchant/api/guides/data-sources/api-sources#create-primary-data-source). Only API data sources are supported. Format: `accounts/{account\}/dataSources/{datasource\}`. For example, `accounts/123456/dataSources/104628`.
|
|
1783
1773
|
*/
|
|
@@ -1792,20 +1782,15 @@ export namespace merchantapi_products_v1 {
|
|
|
1792
1782
|
*/
|
|
1793
1783
|
requestBody?: Schema$ProductInput;
|
|
1794
1784
|
}
|
|
1795
|
-
export interface Params$Resource$Accounts$Productinputs$Patch
|
|
1796
|
-
extends StandardParameters {
|
|
1785
|
+
export interface Params$Resource$Accounts$Productinputs$Patch extends StandardParameters {
|
|
1797
1786
|
/**
|
|
1798
1787
|
* Required. The primary or supplemental product data source where `data_source` name identifies the product input to be updated. Only API data sources are supported. Format: `accounts/{account\}/dataSources/{datasource\}`. For example, `accounts/123456/dataSources/104628`.
|
|
1799
1788
|
*/
|
|
1800
1789
|
dataSource?: string;
|
|
1801
1790
|
/**
|
|
1802
|
-
* Identifier. The name of the product
|
|
1791
|
+
* Identifier. The name of the product. Format: `accounts/{account\}/productInputs/{productinput\}` The {productinput\} 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 {productinput\} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput\}` 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 `{productinput\}` segment must be the base64url encoding of this string, which is `ZW5-VVMtc2t1LzEyMw`. The full resource name for the product would be `accounts/123/productinputs/ZW5-VVMtc2t1LzEyMw`. 2. **Plain Format**: The `{productinput\}` 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 `{productinput\}` 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/productinputs/online~en~US~sku123`.
|
|
1803
1792
|
*/
|
|
1804
1793
|
name?: string;
|
|
1805
|
-
/**
|
|
1806
|
-
* Optional. If true, the `{productInput\}` 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 `{productInput\}` 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.
|
|
1807
|
-
*/
|
|
1808
|
-
productIdBase64UrlEncoded?: boolean;
|
|
1809
1794
|
/**
|
|
1810
1795
|
* Optional. The list of product attributes to be updated. If the update mask is omitted, then it is treated as implied field mask equivalent to all fields that are populated (have a non-empty value). Attributes specified in the update mask without a value specified in the body will be deleted from the product. Update mask can only be specified for top level fields in attributes and custom attributes. To specify the update mask for custom attributes you need to add the `custom_attribute.` prefix. Providing special "*" value for full product replacement is not supported.
|
|
1811
1796
|
*/
|
|
@@ -1854,10 +1839,8 @@ export namespace merchantapi_products_v1 {
|
|
|
1854
1839
|
*
|
|
1855
1840
|
* // Do the magic
|
|
1856
1841
|
* const res = await merchantapi.accounts.products.get({
|
|
1857
|
-
* // Required. The name of the product
|
|
1842
|
+
* // Required. The name of the product. 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`.
|
|
1858
1843
|
* name: 'accounts/my-account/products/my-product',
|
|
1859
|
-
* // 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.
|
|
1860
|
-
* productIdBase64UrlEncoded: 'placeholder-value',
|
|
1861
1844
|
* });
|
|
1862
1845
|
* console.log(res.data);
|
|
1863
1846
|
*
|
|
@@ -2117,19 +2100,13 @@ export namespace merchantapi_products_v1 {
|
|
|
2117
2100
|
}
|
|
2118
2101
|
}
|
|
2119
2102
|
|
|
2120
|
-
export interface Params$Resource$Accounts$Products$Get
|
|
2121
|
-
extends StandardParameters {
|
|
2103
|
+
export interface Params$Resource$Accounts$Products$Get extends StandardParameters {
|
|
2122
2104
|
/**
|
|
2123
|
-
* Required. The name of the product
|
|
2105
|
+
* Required. The name of the product. 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`.
|
|
2124
2106
|
*/
|
|
2125
2107
|
name?: string;
|
|
2126
|
-
/**
|
|
2127
|
-
* 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.
|
|
2128
|
-
*/
|
|
2129
|
-
productIdBase64UrlEncoded?: boolean;
|
|
2130
2108
|
}
|
|
2131
|
-
export interface Params$Resource$Accounts$Products$List
|
|
2132
|
-
extends StandardParameters {
|
|
2109
|
+
export interface Params$Resource$Accounts$Products$List extends StandardParameters {
|
|
2133
2110
|
/**
|
|
2134
2111
|
* The maximum number of products 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 default page size of 25 products will be returned.
|
|
2135
2112
|
*/
|