@googleapis/merchantapi 16.0.0 → 17.0.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 +20 -0
- package/accounts_v1.ts +344 -140
- package/accounts_v1beta.ts +342 -136
- package/build/accounts_v1.d.ts +194 -0
- package/build/accounts_v1.js +41 -0
- 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 -14
- package/build/inventories_v1.js.map +1 -1
- package/build/inventories_v1beta.d.ts +14 -14
- package/build/inventories_v1beta.js.map +1 -1
- package/build/issueresolution_v1.d.ts +2 -2
- package/build/issueresolution_v1.js.map +1 -1
- package/build/issueresolution_v1beta.d.ts +2 -2
- 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 +9 -9
- package/build/products_v1.js.map +1 -1
- package/build/products_v1beta.d.ts +9 -9
- 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 -26
- package/inventories_v1beta.ts +20 -26
- package/issueresolution_v1.ts +6 -10
- package/issueresolution_v1beta.ts +6 -10
- 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 +14 -19
- package/products_v1beta.ts +14 -19
- 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/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
|
/**
|
|
@@ -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
|
/**
|
|
@@ -1325,7 +1325,7 @@ 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
1330
|
* });
|
|
1331
1331
|
* console.log(res.data);
|
|
@@ -1592,7 +1592,7 @@ export namespace merchantapi_products_v1 {
|
|
|
1592
1592
|
}
|
|
1593
1593
|
|
|
1594
1594
|
/**
|
|
1595
|
-
* 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.
|
|
1596
1596
|
* @example
|
|
1597
1597
|
* ```js
|
|
1598
1598
|
* // Before running the sample:
|
|
@@ -1624,7 +1624,7 @@ export namespace merchantapi_products_v1 {
|
|
|
1624
1624
|
* const res = await merchantapi.accounts.productInputs.patch({
|
|
1625
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`.
|
|
1626
1626
|
* dataSource: 'placeholder-value',
|
|
1627
|
-
* // 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`.
|
|
1628
1628
|
* name: 'accounts/my-account/productInputs/my-productInput',
|
|
1629
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.
|
|
1630
1630
|
* updateMask: 'placeholder-value',
|
|
@@ -1757,19 +1757,17 @@ export namespace merchantapi_products_v1 {
|
|
|
1757
1757
|
}
|
|
1758
1758
|
}
|
|
1759
1759
|
|
|
1760
|
-
export interface Params$Resource$Accounts$Productinputs$Delete
|
|
1761
|
-
extends StandardParameters {
|
|
1760
|
+
export interface Params$Resource$Accounts$Productinputs$Delete extends StandardParameters {
|
|
1762
1761
|
/**
|
|
1763
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`.
|
|
1764
1763
|
*/
|
|
1765
1764
|
dataSource?: string;
|
|
1766
1765
|
/**
|
|
1767
|
-
* 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`.
|
|
1768
1767
|
*/
|
|
1769
1768
|
name?: string;
|
|
1770
1769
|
}
|
|
1771
|
-
export interface Params$Resource$Accounts$Productinputs$Insert
|
|
1772
|
-
extends StandardParameters {
|
|
1770
|
+
export interface Params$Resource$Accounts$Productinputs$Insert extends StandardParameters {
|
|
1773
1771
|
/**
|
|
1774
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`.
|
|
1775
1773
|
*/
|
|
@@ -1784,14 +1782,13 @@ export namespace merchantapi_products_v1 {
|
|
|
1784
1782
|
*/
|
|
1785
1783
|
requestBody?: Schema$ProductInput;
|
|
1786
1784
|
}
|
|
1787
|
-
export interface Params$Resource$Accounts$Productinputs$Patch
|
|
1788
|
-
extends StandardParameters {
|
|
1785
|
+
export interface Params$Resource$Accounts$Productinputs$Patch extends StandardParameters {
|
|
1789
1786
|
/**
|
|
1790
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`.
|
|
1791
1788
|
*/
|
|
1792
1789
|
dataSource?: string;
|
|
1793
1790
|
/**
|
|
1794
|
-
* 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`.
|
|
1795
1792
|
*/
|
|
1796
1793
|
name?: string;
|
|
1797
1794
|
/**
|
|
@@ -1842,7 +1839,7 @@ export namespace merchantapi_products_v1 {
|
|
|
1842
1839
|
*
|
|
1843
1840
|
* // Do the magic
|
|
1844
1841
|
* const res = await merchantapi.accounts.products.get({
|
|
1845
|
-
* // 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`.
|
|
1846
1843
|
* name: 'accounts/my-account/products/my-product',
|
|
1847
1844
|
* });
|
|
1848
1845
|
* console.log(res.data);
|
|
@@ -2103,15 +2100,13 @@ export namespace merchantapi_products_v1 {
|
|
|
2103
2100
|
}
|
|
2104
2101
|
}
|
|
2105
2102
|
|
|
2106
|
-
export interface Params$Resource$Accounts$Products$Get
|
|
2107
|
-
extends StandardParameters {
|
|
2103
|
+
export interface Params$Resource$Accounts$Products$Get extends StandardParameters {
|
|
2108
2104
|
/**
|
|
2109
|
-
* 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`.
|
|
2110
2106
|
*/
|
|
2111
2107
|
name?: string;
|
|
2112
2108
|
}
|
|
2113
|
-
export interface Params$Resource$Accounts$Products$List
|
|
2114
|
-
extends StandardParameters {
|
|
2109
|
+
export interface Params$Resource$Accounts$Products$List extends StandardParameters {
|
|
2115
2110
|
/**
|
|
2116
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.
|
|
2117
2112
|
*/
|
package/products_v1beta.ts
CHANGED
|
@@ -745,7 +745,7 @@ export namespace merchantapi_products_v1beta {
|
|
|
745
745
|
ratio?: number | null;
|
|
746
746
|
}
|
|
747
747
|
/**
|
|
748
|
-
* A message that represents loyalty program.
|
|
748
|
+
* LINT.IfChange(LoyaltyProgram) A message that represents loyalty program.
|
|
749
749
|
*/
|
|
750
750
|
export interface Schema$LoyaltyProgram {
|
|
751
751
|
/**
|
|
@@ -915,7 +915,7 @@ export namespace merchantapi_products_v1beta {
|
|
|
915
915
|
*/
|
|
916
916
|
feedLabel?: string | null;
|
|
917
917
|
/**
|
|
918
|
-
* Identifier. The name of the product
|
|
918
|
+
* 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`.
|
|
919
919
|
*/
|
|
920
920
|
name?: string | null;
|
|
921
921
|
/**
|
|
@@ -1259,7 +1259,7 @@ export namespace merchantapi_products_v1beta {
|
|
|
1259
1259
|
* const res = await merchantapi.accounts.productInputs.delete({
|
|
1260
1260
|
* // 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`.
|
|
1261
1261
|
* dataSource: 'placeholder-value',
|
|
1262
|
-
* // Required. The name of the product input
|
|
1262
|
+
* // 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`.
|
|
1263
1263
|
* name: 'accounts/my-account/productInputs/my-productInput',
|
|
1264
1264
|
* });
|
|
1265
1265
|
* console.log(res.data);
|
|
@@ -1526,7 +1526,7 @@ export namespace merchantapi_products_v1beta {
|
|
|
1526
1526
|
}
|
|
1527
1527
|
|
|
1528
1528
|
/**
|
|
1529
|
-
* 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.
|
|
1529
|
+
* 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.
|
|
1530
1530
|
* @example
|
|
1531
1531
|
* ```js
|
|
1532
1532
|
* // Before running the sample:
|
|
@@ -1558,7 +1558,7 @@ export namespace merchantapi_products_v1beta {
|
|
|
1558
1558
|
* const res = await merchantapi.accounts.productInputs.patch({
|
|
1559
1559
|
* // 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`.
|
|
1560
1560
|
* dataSource: 'placeholder-value',
|
|
1561
|
-
* // Identifier. The name of the product
|
|
1561
|
+
* // 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`.
|
|
1562
1562
|
* name: 'accounts/my-account/productInputs/my-productInput',
|
|
1563
1563
|
* // 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.
|
|
1564
1564
|
* updateMask: 'placeholder-value',
|
|
@@ -1691,19 +1691,17 @@ export namespace merchantapi_products_v1beta {
|
|
|
1691
1691
|
}
|
|
1692
1692
|
}
|
|
1693
1693
|
|
|
1694
|
-
export interface Params$Resource$Accounts$Productinputs$Delete
|
|
1695
|
-
extends StandardParameters {
|
|
1694
|
+
export interface Params$Resource$Accounts$Productinputs$Delete extends StandardParameters {
|
|
1696
1695
|
/**
|
|
1697
1696
|
* 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`.
|
|
1698
1697
|
*/
|
|
1699
1698
|
dataSource?: string;
|
|
1700
1699
|
/**
|
|
1701
|
-
* Required. The name of the product input
|
|
1700
|
+
* 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`.
|
|
1702
1701
|
*/
|
|
1703
1702
|
name?: string;
|
|
1704
1703
|
}
|
|
1705
|
-
export interface Params$Resource$Accounts$Productinputs$Insert
|
|
1706
|
-
extends StandardParameters {
|
|
1704
|
+
export interface Params$Resource$Accounts$Productinputs$Insert extends StandardParameters {
|
|
1707
1705
|
/**
|
|
1708
1706
|
* 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`.
|
|
1709
1707
|
*/
|
|
@@ -1718,14 +1716,13 @@ export namespace merchantapi_products_v1beta {
|
|
|
1718
1716
|
*/
|
|
1719
1717
|
requestBody?: Schema$ProductInput;
|
|
1720
1718
|
}
|
|
1721
|
-
export interface Params$Resource$Accounts$Productinputs$Patch
|
|
1722
|
-
extends StandardParameters {
|
|
1719
|
+
export interface Params$Resource$Accounts$Productinputs$Patch extends StandardParameters {
|
|
1723
1720
|
/**
|
|
1724
1721
|
* 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`.
|
|
1725
1722
|
*/
|
|
1726
1723
|
dataSource?: string;
|
|
1727
1724
|
/**
|
|
1728
|
-
* Identifier. The name of the product
|
|
1725
|
+
* 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`.
|
|
1729
1726
|
*/
|
|
1730
1727
|
name?: string;
|
|
1731
1728
|
/**
|
|
@@ -1776,7 +1773,7 @@ export namespace merchantapi_products_v1beta {
|
|
|
1776
1773
|
*
|
|
1777
1774
|
* // Do the magic
|
|
1778
1775
|
* const res = await merchantapi.accounts.products.get({
|
|
1779
|
-
* // Required. The name of the product
|
|
1776
|
+
* // 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`.
|
|
1780
1777
|
* name: 'accounts/my-account/products/my-product',
|
|
1781
1778
|
* });
|
|
1782
1779
|
* console.log(res.data);
|
|
@@ -2037,15 +2034,13 @@ export namespace merchantapi_products_v1beta {
|
|
|
2037
2034
|
}
|
|
2038
2035
|
}
|
|
2039
2036
|
|
|
2040
|
-
export interface Params$Resource$Accounts$Products$Get
|
|
2041
|
-
extends StandardParameters {
|
|
2037
|
+
export interface Params$Resource$Accounts$Products$Get extends StandardParameters {
|
|
2042
2038
|
/**
|
|
2043
|
-
* Required. The name of the product
|
|
2039
|
+
* 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`.
|
|
2044
2040
|
*/
|
|
2045
2041
|
name?: string;
|
|
2046
2042
|
}
|
|
2047
|
-
export interface Params$Resource$Accounts$Products$List
|
|
2048
|
-
extends StandardParameters {
|
|
2043
|
+
export interface Params$Resource$Accounts$Products$List extends StandardParameters {
|
|
2049
2044
|
/**
|
|
2050
2045
|
* 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.
|
|
2051
2046
|
*/
|
package/promotions_v1.ts
CHANGED
|
@@ -958,15 +958,13 @@ export namespace merchantapi_promotions_v1 {
|
|
|
958
958
|
}
|
|
959
959
|
}
|
|
960
960
|
|
|
961
|
-
export interface Params$Resource$Accounts$Promotions$Get
|
|
962
|
-
extends StandardParameters {
|
|
961
|
+
export interface Params$Resource$Accounts$Promotions$Get extends StandardParameters {
|
|
963
962
|
/**
|
|
964
963
|
* Required. The name of the promotion to retrieve. Format: `accounts/{account\}/promotions/{promotions\}`
|
|
965
964
|
*/
|
|
966
965
|
name?: string;
|
|
967
966
|
}
|
|
968
|
-
export interface Params$Resource$Accounts$Promotions$Insert
|
|
969
|
-
extends StandardParameters {
|
|
967
|
+
export interface Params$Resource$Accounts$Promotions$Insert extends StandardParameters {
|
|
970
968
|
/**
|
|
971
969
|
* Required. The account where the promotion will be inserted. Format: accounts/{account\}
|
|
972
970
|
*/
|
|
@@ -977,8 +975,7 @@ export namespace merchantapi_promotions_v1 {
|
|
|
977
975
|
*/
|
|
978
976
|
requestBody?: Schema$InsertPromotionRequest;
|
|
979
977
|
}
|
|
980
|
-
export interface Params$Resource$Accounts$Promotions$List
|
|
981
|
-
extends StandardParameters {
|
|
978
|
+
export interface Params$Resource$Accounts$Promotions$List extends StandardParameters {
|
|
982
979
|
/**
|
|
983
980
|
* Optional. The maximum number of promotions to return. The service may return fewer than this value. The maximum value is 250; values above 250 will be coerced to 250. If unspecified, the maximum number of promotions will be returned.
|
|
984
981
|
*/
|
package/promotions_v1beta.ts
CHANGED
|
@@ -958,15 +958,13 @@ export namespace merchantapi_promotions_v1beta {
|
|
|
958
958
|
}
|
|
959
959
|
}
|
|
960
960
|
|
|
961
|
-
export interface Params$Resource$Accounts$Promotions$Get
|
|
962
|
-
extends StandardParameters {
|
|
961
|
+
export interface Params$Resource$Accounts$Promotions$Get extends StandardParameters {
|
|
963
962
|
/**
|
|
964
963
|
* Required. The name of the promotion to retrieve. Format: `accounts/{account\}/promotions/{promotions\}`
|
|
965
964
|
*/
|
|
966
965
|
name?: string;
|
|
967
966
|
}
|
|
968
|
-
export interface Params$Resource$Accounts$Promotions$Insert
|
|
969
|
-
extends StandardParameters {
|
|
967
|
+
export interface Params$Resource$Accounts$Promotions$Insert extends StandardParameters {
|
|
970
968
|
/**
|
|
971
969
|
* Required. The account where the promotion will be inserted. Format: accounts/{account\}
|
|
972
970
|
*/
|
|
@@ -977,8 +975,7 @@ export namespace merchantapi_promotions_v1beta {
|
|
|
977
975
|
*/
|
|
978
976
|
requestBody?: Schema$InsertPromotionRequest;
|
|
979
977
|
}
|
|
980
|
-
export interface Params$Resource$Accounts$Promotions$List
|
|
981
|
-
extends StandardParameters {
|
|
978
|
+
export interface Params$Resource$Accounts$Promotions$List extends StandardParameters {
|
|
982
979
|
/**
|
|
983
980
|
* Optional. The maximum number of promotions to return. The service may return fewer than this value. The maximum value is 250; values above 250 will be coerced to 250. If unspecified, the maximum number of promotions will be returned.
|
|
984
981
|
*/
|