@googleapis/merchantapi 3.0.0 → 4.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 +18 -0
- package/accounts_v1beta.ts +359 -26
- package/build/accounts_v1beta.d.ts +194 -26
- package/build/accounts_v1beta.js +64 -0
- package/build/accounts_v1beta.js.map +1 -1
- package/build/conversions_v1beta.d.ts +10 -6
- package/build/conversions_v1beta.js.map +1 -1
- package/build/datasources_v1beta.d.ts +28 -7
- package/build/datasources_v1beta.js.map +1 -1
- package/build/inventories_v1beta.d.ts +10 -6
- package/build/inventories_v1beta.js.map +1 -1
- package/build/lfp_v1beta.d.ts +10 -6
- package/build/lfp_v1beta.js.map +1 -1
- package/build/notifications_v1beta.d.ts +10 -6
- package/build/notifications_v1beta.js.map +1 -1
- package/build/products_v1beta.d.ts +43 -7
- package/build/products_v1beta.js +32 -0
- package/build/products_v1beta.js.map +1 -1
- package/build/promotions_v1beta.d.ts +10 -6
- package/build/promotions_v1beta.js.map +1 -1
- package/build/quota_v1beta.d.ts +10 -6
- package/build/quota_v1beta.js.map +1 -1
- package/build/reports_v1beta.d.ts +10 -6
- package/build/reports_v1beta.js.map +1 -1
- package/build/reviews_v1beta.d.ts +12 -8
- package/build/reviews_v1beta.js.map +1 -1
- package/conversions_v1beta.ts +10 -6
- package/datasources_v1beta.ts +28 -7
- package/inventories_v1beta.ts +10 -6
- package/lfp_v1beta.ts +10 -6
- package/notifications_v1beta.ts +10 -6
- package/package.json +1 -1
- package/products_v1beta.ts +119 -7
- package/promotions_v1beta.ts +10 -6
- package/quota_v1beta.ts +10 -6
- package/reports_v1beta.ts +10 -6
- package/reviews_v1beta.ts +12 -8
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,23 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [4.1.0](https://github.com/googleapis/google-api-nodejs-client/compare/merchantapi-v4.0.0...merchantapi-v4.1.0) (2025-03-19)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* **merchantapi:** update the API ([8746072](https://github.com/googleapis/google-api-nodejs-client/commit/8746072672fa3625b7c15d3ed240541b66036dcb))
|
|
9
|
+
|
|
10
|
+
## [4.0.0](https://github.com/googleapis/google-api-nodejs-client/compare/merchantapi-v3.0.0...merchantapi-v4.0.0) (2025-03-18)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### ⚠ BREAKING CHANGES
|
|
14
|
+
|
|
15
|
+
* **merchantapi:** This release has breaking changes.
|
|
16
|
+
|
|
17
|
+
### Features
|
|
18
|
+
|
|
19
|
+
* **merchantapi:** update the API ([1e2ee7c](https://github.com/googleapis/google-api-nodejs-client/commit/1e2ee7c3563f8b8d17f4f3a469ec2f5efa54712e))
|
|
20
|
+
|
|
3
21
|
## [3.0.0](https://github.com/googleapis/google-api-nodejs-client/compare/merchantapi-v2.0.0...merchantapi-v3.0.0) (2025-02-04)
|
|
4
22
|
|
|
5
23
|
|
package/accounts_v1beta.ts
CHANGED
|
@@ -156,7 +156,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
156
156
|
*/
|
|
157
157
|
accountName?: string | null;
|
|
158
158
|
/**
|
|
159
|
-
* Whether this account contains adult content.
|
|
159
|
+
* Optional. Whether this account contains adult content.
|
|
160
160
|
*/
|
|
161
161
|
adultContent?: boolean | null;
|
|
162
162
|
/**
|
|
@@ -247,6 +247,19 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
247
247
|
*/
|
|
248
248
|
streetAddress?: string | null;
|
|
249
249
|
}
|
|
250
|
+
/**
|
|
251
|
+
* Instruction for adding a user to the account during creation.
|
|
252
|
+
*/
|
|
253
|
+
export interface Schema$AddUser {
|
|
254
|
+
/**
|
|
255
|
+
* Optional. Details about the user to be added. At the moment, only access rights may be specified.
|
|
256
|
+
*/
|
|
257
|
+
user?: Schema$User;
|
|
258
|
+
/**
|
|
259
|
+
* Required. The email address of the user (for example, `john.doe@gmail.com`).
|
|
260
|
+
*/
|
|
261
|
+
userId?: string | null;
|
|
262
|
+
}
|
|
250
263
|
/**
|
|
251
264
|
* Collection of information related to the [autofeed](https://support.google.com/merchants/answer/7538732) settings.
|
|
252
265
|
*/
|
|
@@ -264,6 +277,74 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
264
277
|
*/
|
|
265
278
|
name?: string | null;
|
|
266
279
|
}
|
|
280
|
+
/**
|
|
281
|
+
* This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973)
|
|
282
|
+
*/
|
|
283
|
+
export interface Schema$AutomaticImageImprovements {
|
|
284
|
+
/**
|
|
285
|
+
* Optional. Determines how the images should be automatically updated. If this field is not present and provided in the update mask, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
|
|
286
|
+
*/
|
|
287
|
+
accountImageImprovementsSettings?: Schema$ImageImprovementsAccountLevelSettings;
|
|
288
|
+
/**
|
|
289
|
+
* Output only. The effective value of allow_automatic_image_improvements. If account_image_improvements_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.
|
|
290
|
+
*/
|
|
291
|
+
effectiveAllowAutomaticImageImprovements?: boolean | null;
|
|
292
|
+
}
|
|
293
|
+
/**
|
|
294
|
+
* Collection of information related to the [automatic improvements](https://developers.google.com/shopping-content/guides/automatic-improvements) of an account.
|
|
295
|
+
*/
|
|
296
|
+
export interface Schema$AutomaticImprovements {
|
|
297
|
+
/**
|
|
298
|
+
* This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) This field is only updated (cleared) if provided in the update mask.
|
|
299
|
+
*/
|
|
300
|
+
imageImprovements?: Schema$AutomaticImageImprovements;
|
|
301
|
+
/**
|
|
302
|
+
* Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. This field is only updated (cleared) if provided in the update mask.
|
|
303
|
+
*/
|
|
304
|
+
itemUpdates?: Schema$AutomaticItemUpdates;
|
|
305
|
+
/**
|
|
306
|
+
* Identifier. The resource name of the automatic improvements. Format: `accounts/{account\}/automaticImprovements`.
|
|
307
|
+
*/
|
|
308
|
+
name?: string | null;
|
|
309
|
+
/**
|
|
310
|
+
* Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: * Delivery address of an order * Current handling time and shipping time settings * Estimated weekdays or business days * Parcel tracking data This field is only updated (cleared) if provided in the update mask.
|
|
311
|
+
*/
|
|
312
|
+
shippingImprovements?: Schema$AutomaticShippingImprovements;
|
|
313
|
+
}
|
|
314
|
+
/**
|
|
315
|
+
* Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown.
|
|
316
|
+
*/
|
|
317
|
+
export interface Schema$AutomaticItemUpdates {
|
|
318
|
+
/**
|
|
319
|
+
* Optional. Determines which attributes of the items should be automatically updated. If this field is not present and provided in the update mask, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator.
|
|
320
|
+
*/
|
|
321
|
+
accountItemUpdatesSettings?: Schema$ItemUpdatesAccountLevelSettings;
|
|
322
|
+
/**
|
|
323
|
+
* Output only. The effective value of allow_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. The default value is true if no settings are present. Read-only.
|
|
324
|
+
*/
|
|
325
|
+
effectiveAllowAvailabilityUpdates?: boolean | null;
|
|
326
|
+
/**
|
|
327
|
+
* Output only. The effective value of allow_condition_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. The default value is true if no settings are present. Read-only.
|
|
328
|
+
*/
|
|
329
|
+
effectiveAllowConditionUpdates?: boolean | null;
|
|
330
|
+
/**
|
|
331
|
+
* Output only. The effective value of allow_price_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. The default value is true if no settings are present. Read-only.
|
|
332
|
+
*/
|
|
333
|
+
effectiveAllowPriceUpdates?: boolean | null;
|
|
334
|
+
/**
|
|
335
|
+
* Output only. The effective value of allow_strict_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. The default value is true if no settings are present. Read-only.
|
|
336
|
+
*/
|
|
337
|
+
effectiveAllowStrictAvailabilityUpdates?: boolean | null;
|
|
338
|
+
}
|
|
339
|
+
/**
|
|
340
|
+
* Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: * Delivery address of an order * Current handling time and shipping time settings * Estimated weekdays or business days * Parcel tracking data
|
|
341
|
+
*/
|
|
342
|
+
export interface Schema$AutomaticShippingImprovements {
|
|
343
|
+
/**
|
|
344
|
+
* Enables automatic shipping improvements.
|
|
345
|
+
*/
|
|
346
|
+
allowShippingImprovements?: boolean | null;
|
|
347
|
+
}
|
|
267
348
|
/**
|
|
268
349
|
* Business days of the warehouse.
|
|
269
350
|
*/
|
|
@@ -388,6 +469,10 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
388
469
|
/**
|
|
389
470
|
* Optional. Users to be added to the account.
|
|
390
471
|
*/
|
|
472
|
+
user?: Schema$AddUser[];
|
|
473
|
+
/**
|
|
474
|
+
* Optional. Users to be added to the account. This field is deprecated and will not exist after the API evolves out of beta. Use the `user` field instead.
|
|
475
|
+
*/
|
|
391
476
|
users?: Schema$CreateUserRequest[];
|
|
392
477
|
}
|
|
393
478
|
/**
|
|
@@ -614,6 +699,15 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
614
699
|
*/
|
|
615
700
|
identityDeclaration?: string | null;
|
|
616
701
|
}
|
|
702
|
+
/**
|
|
703
|
+
* Settings for the Automatic Image Improvements.
|
|
704
|
+
*/
|
|
705
|
+
export interface Schema$ImageImprovementsAccountLevelSettings {
|
|
706
|
+
/**
|
|
707
|
+
* Enables automatic image improvements.
|
|
708
|
+
*/
|
|
709
|
+
allowAutomaticImageImprovements?: boolean | null;
|
|
710
|
+
}
|
|
617
711
|
/**
|
|
618
712
|
* The impact of the issue on a region.
|
|
619
713
|
*/
|
|
@@ -640,6 +734,27 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
640
734
|
*/
|
|
641
735
|
reportingContext?: string | null;
|
|
642
736
|
}
|
|
737
|
+
/**
|
|
738
|
+
* Settings for the Automatic Item Updates.
|
|
739
|
+
*/
|
|
740
|
+
export interface Schema$ItemUpdatesAccountLevelSettings {
|
|
741
|
+
/**
|
|
742
|
+
* If availability updates are enabled, any previous availability values get overwritten if Google finds an out-of-stock annotation on the offer's page. If additionally `allow_strict_availability_updates` field is set to true, values get overwritten if Google finds an in-stock annotation on the offer’s page.
|
|
743
|
+
*/
|
|
744
|
+
allowAvailabilityUpdates?: boolean | null;
|
|
745
|
+
/**
|
|
746
|
+
* If condition updates are enabled, Google always updates item condition with the condition detected from the details of your product.
|
|
747
|
+
*/
|
|
748
|
+
allowConditionUpdates?: boolean | null;
|
|
749
|
+
/**
|
|
750
|
+
* If price updates are enabled, Google always updates the active price with the crawled information.
|
|
751
|
+
*/
|
|
752
|
+
allowPriceUpdates?: boolean | null;
|
|
753
|
+
/**
|
|
754
|
+
* If `allow_availability_updates` is enabled, items are automatically updated in all your Shopping target countries. By default, availability updates will only be applied to items that are 'out of stock' on your website but 'in stock' on Shopping. Set this to true to also update items that are 'in stock' on your website, but 'out of stock' on Google Shopping. In order for this field to have an effect, you must also set `allow_availability_updates`.
|
|
755
|
+
*/
|
|
756
|
+
allowStrictAvailabilityUpdates?: boolean | null;
|
|
757
|
+
}
|
|
643
758
|
/**
|
|
644
759
|
* Response message for the `ListAccountIssues` method.
|
|
645
760
|
*/
|
|
@@ -801,7 +916,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
801
916
|
*/
|
|
802
917
|
countries?: string[] | null;
|
|
803
918
|
/**
|
|
804
|
-
* The item conditions accepted for returns must not be empty unless the type of return policy is 'noReturns'.
|
|
919
|
+
* Optional. The item conditions accepted for returns must not be empty unless the type of return policy is 'noReturns'.
|
|
805
920
|
*/
|
|
806
921
|
itemConditions?: string[] | null;
|
|
807
922
|
/**
|
|
@@ -813,7 +928,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
813
928
|
*/
|
|
814
929
|
name?: string | null;
|
|
815
930
|
/**
|
|
816
|
-
* The return policy.
|
|
931
|
+
* Optional. The return policy.
|
|
817
932
|
*/
|
|
818
933
|
policy?: Schema$Policy;
|
|
819
934
|
/**
|
|
@@ -821,11 +936,11 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
821
936
|
*/
|
|
822
937
|
processRefundDays?: number | null;
|
|
823
938
|
/**
|
|
824
|
-
* The restocking fee that applies to all return reason categories. This would be treated as a free restocking fee if the value is not set.
|
|
939
|
+
* Optional. The restocking fee that applies to all return reason categories. This would be treated as a free restocking fee if the value is not set.
|
|
825
940
|
*/
|
|
826
941
|
restockingFee?: Schema$RestockingFee;
|
|
827
942
|
/**
|
|
828
|
-
* The return methods of how customers can return an item. This value is required to not be empty unless the type of return policy is noReturns.
|
|
943
|
+
* Optional. The return methods of how customers can return an item. This value is required to not be empty unless the type of return policy is noReturns.
|
|
829
944
|
*/
|
|
830
945
|
returnMethods?: string[] | null;
|
|
831
946
|
/**
|
|
@@ -837,7 +952,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
837
952
|
*/
|
|
838
953
|
returnPolicyUri?: string | null;
|
|
839
954
|
/**
|
|
840
|
-
* The return shipping fee. Should be set only when customer need to download and print the return label.
|
|
955
|
+
* Optional. The return shipping fee. Should be set only when customer need to download and print the return label.
|
|
841
956
|
*/
|
|
842
957
|
returnShippingFee?: Schema$ReturnShippingFee;
|
|
843
958
|
/**
|
|
@@ -968,19 +1083,19 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
968
1083
|
*/
|
|
969
1084
|
export interface Schema$ProductChange {
|
|
970
1085
|
/**
|
|
971
|
-
* The new value of the changed resource or attribute.
|
|
1086
|
+
* The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)
|
|
972
1087
|
*/
|
|
973
1088
|
newValue?: string | null;
|
|
974
1089
|
/**
|
|
975
|
-
* The old value of the changed resource or attribute.
|
|
1090
|
+
* The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)
|
|
976
1091
|
*/
|
|
977
1092
|
oldValue?: string | null;
|
|
978
1093
|
/**
|
|
979
|
-
* Countries that have the change (if applicable)
|
|
1094
|
+
* Countries that have the change (if applicable). Represented in the ISO 3166 format.
|
|
980
1095
|
*/
|
|
981
1096
|
regionCode?: string | null;
|
|
982
1097
|
/**
|
|
983
|
-
* Reporting contexts that have the change (if applicable)
|
|
1098
|
+
* Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum)
|
|
984
1099
|
*/
|
|
985
1100
|
reportingContext?: string | null;
|
|
986
1101
|
}
|
|
@@ -1001,7 +1116,11 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1001
1116
|
*/
|
|
1002
1117
|
changes?: Schema$ProductChange[];
|
|
1003
1118
|
/**
|
|
1004
|
-
* The
|
|
1119
|
+
* The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications.
|
|
1120
|
+
*/
|
|
1121
|
+
eventTime?: string | null;
|
|
1122
|
+
/**
|
|
1123
|
+
* Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event.
|
|
1005
1124
|
*/
|
|
1006
1125
|
expirationTime?: string | null;
|
|
1007
1126
|
/**
|
|
@@ -1009,7 +1128,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1009
1128
|
*/
|
|
1010
1129
|
managingAccount?: string | null;
|
|
1011
1130
|
/**
|
|
1012
|
-
* The product name. Format: `
|
|
1131
|
+
* The product name. Format: `accounts/{account\}/products/{product\}`
|
|
1013
1132
|
*/
|
|
1014
1133
|
resource?: string | null;
|
|
1015
1134
|
/**
|
|
@@ -1022,7 +1141,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1022
1141
|
resourceType?: string | null;
|
|
1023
1142
|
}
|
|
1024
1143
|
/**
|
|
1025
|
-
* Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/topic/9240261?ref_topic=7257954,7259405,&sjid=796648681813264022-EU) program, which enables products from a merchant's store to be shown across Google for free.
|
|
1144
|
+
* Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/topic/9240261?ref_topic=7257954,7259405,&sjid=796648681813264022-EU) program, which enables products from a merchant's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `free-listings` * `shopping-ads` * `youtube-shopping-checkout`
|
|
1026
1145
|
*/
|
|
1027
1146
|
export interface Schema$Program {
|
|
1028
1147
|
/**
|
|
@@ -1169,26 +1288,27 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1169
1288
|
*/
|
|
1170
1289
|
cells?: Schema$Value[];
|
|
1171
1290
|
}
|
|
1172
|
-
/**
|
|
1173
|
-
* Next: 5
|
|
1174
|
-
*/
|
|
1175
1291
|
export interface Schema$SeasonalOverride {
|
|
1176
|
-
/**
|
|
1177
|
-
* Required. Defines the date range when this seasonal override applies. Both begin and end are inclusive and should be in date decimal format, example 20250115. The dates of the seasonal overrides should not overlap.
|
|
1178
|
-
*/
|
|
1179
|
-
begin?: Schema$Date;
|
|
1180
1292
|
/**
|
|
1181
1293
|
* Required. seasonal override end date (inclusive).
|
|
1182
1294
|
*/
|
|
1183
|
-
|
|
1295
|
+
endDate?: Schema$Date;
|
|
1184
1296
|
/**
|
|
1185
1297
|
* Required. Display name of this seasonal override in Merchant Center.
|
|
1186
1298
|
*/
|
|
1187
1299
|
label?: string | null;
|
|
1188
1300
|
/**
|
|
1189
|
-
*
|
|
1301
|
+
* Number of days (from the delivery date) that the product can be returned.
|
|
1190
1302
|
*/
|
|
1191
|
-
|
|
1303
|
+
returnDays?: number | null;
|
|
1304
|
+
/**
|
|
1305
|
+
* Fixed end date until which the product can be returned.
|
|
1306
|
+
*/
|
|
1307
|
+
returnUntilDate?: Schema$Date;
|
|
1308
|
+
/**
|
|
1309
|
+
* Required. Defines the date range when this seasonal override applies. Both start_date and end_date are inclusive. The dates of the seasonal overrides should not overlap.
|
|
1310
|
+
*/
|
|
1311
|
+
startDate?: Schema$Date;
|
|
1192
1312
|
}
|
|
1193
1313
|
/**
|
|
1194
1314
|
* Shipping service.
|
|
@@ -1439,7 +1559,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1439
1559
|
*/
|
|
1440
1560
|
export interface Schema$User {
|
|
1441
1561
|
/**
|
|
1442
|
-
*
|
|
1562
|
+
* Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has.
|
|
1443
1563
|
*/
|
|
1444
1564
|
accessRights?: string[] | null;
|
|
1445
1565
|
/**
|
|
@@ -1848,7 +1968,102 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1848
1968
|
}
|
|
1849
1969
|
|
|
1850
1970
|
/**
|
|
1851
|
-
*
|
|
1971
|
+
* Retrieves the automatic improvements of an account.
|
|
1972
|
+
*
|
|
1973
|
+
* @param params - Parameters for request
|
|
1974
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
1975
|
+
* @param callback - Optional callback that handles the response.
|
|
1976
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
1977
|
+
*/
|
|
1978
|
+
getAutomaticImprovements(
|
|
1979
|
+
params: Params$Resource$Accounts$Getautomaticimprovements,
|
|
1980
|
+
options: StreamMethodOptions
|
|
1981
|
+
): GaxiosPromise<Readable>;
|
|
1982
|
+
getAutomaticImprovements(
|
|
1983
|
+
params?: Params$Resource$Accounts$Getautomaticimprovements,
|
|
1984
|
+
options?: MethodOptions
|
|
1985
|
+
): GaxiosPromise<Schema$AutomaticImprovements>;
|
|
1986
|
+
getAutomaticImprovements(
|
|
1987
|
+
params: Params$Resource$Accounts$Getautomaticimprovements,
|
|
1988
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
1989
|
+
callback: BodyResponseCallback<Readable>
|
|
1990
|
+
): void;
|
|
1991
|
+
getAutomaticImprovements(
|
|
1992
|
+
params: Params$Resource$Accounts$Getautomaticimprovements,
|
|
1993
|
+
options:
|
|
1994
|
+
| MethodOptions
|
|
1995
|
+
| BodyResponseCallback<Schema$AutomaticImprovements>,
|
|
1996
|
+
callback: BodyResponseCallback<Schema$AutomaticImprovements>
|
|
1997
|
+
): void;
|
|
1998
|
+
getAutomaticImprovements(
|
|
1999
|
+
params: Params$Resource$Accounts$Getautomaticimprovements,
|
|
2000
|
+
callback: BodyResponseCallback<Schema$AutomaticImprovements>
|
|
2001
|
+
): void;
|
|
2002
|
+
getAutomaticImprovements(
|
|
2003
|
+
callback: BodyResponseCallback<Schema$AutomaticImprovements>
|
|
2004
|
+
): void;
|
|
2005
|
+
getAutomaticImprovements(
|
|
2006
|
+
paramsOrCallback?:
|
|
2007
|
+
| Params$Resource$Accounts$Getautomaticimprovements
|
|
2008
|
+
| BodyResponseCallback<Schema$AutomaticImprovements>
|
|
2009
|
+
| BodyResponseCallback<Readable>,
|
|
2010
|
+
optionsOrCallback?:
|
|
2011
|
+
| MethodOptions
|
|
2012
|
+
| StreamMethodOptions
|
|
2013
|
+
| BodyResponseCallback<Schema$AutomaticImprovements>
|
|
2014
|
+
| BodyResponseCallback<Readable>,
|
|
2015
|
+
callback?:
|
|
2016
|
+
| BodyResponseCallback<Schema$AutomaticImprovements>
|
|
2017
|
+
| BodyResponseCallback<Readable>
|
|
2018
|
+
):
|
|
2019
|
+
| void
|
|
2020
|
+
| GaxiosPromise<Schema$AutomaticImprovements>
|
|
2021
|
+
| GaxiosPromise<Readable> {
|
|
2022
|
+
let params = (paramsOrCallback ||
|
|
2023
|
+
{}) as Params$Resource$Accounts$Getautomaticimprovements;
|
|
2024
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
2025
|
+
|
|
2026
|
+
if (typeof paramsOrCallback === 'function') {
|
|
2027
|
+
callback = paramsOrCallback;
|
|
2028
|
+
params = {} as Params$Resource$Accounts$Getautomaticimprovements;
|
|
2029
|
+
options = {};
|
|
2030
|
+
}
|
|
2031
|
+
|
|
2032
|
+
if (typeof optionsOrCallback === 'function') {
|
|
2033
|
+
callback = optionsOrCallback;
|
|
2034
|
+
options = {};
|
|
2035
|
+
}
|
|
2036
|
+
|
|
2037
|
+
const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/';
|
|
2038
|
+
const parameters = {
|
|
2039
|
+
options: Object.assign(
|
|
2040
|
+
{
|
|
2041
|
+
url: (rootUrl + '/accounts/v1beta/{+name}').replace(
|
|
2042
|
+
/([^:]\/)\/+/g,
|
|
2043
|
+
'$1'
|
|
2044
|
+
),
|
|
2045
|
+
method: 'GET',
|
|
2046
|
+
apiVersion: '',
|
|
2047
|
+
},
|
|
2048
|
+
options
|
|
2049
|
+
),
|
|
2050
|
+
params,
|
|
2051
|
+
requiredParams: ['name'],
|
|
2052
|
+
pathParams: ['name'],
|
|
2053
|
+
context: this.context,
|
|
2054
|
+
};
|
|
2055
|
+
if (callback) {
|
|
2056
|
+
createAPIRequest<Schema$AutomaticImprovements>(
|
|
2057
|
+
parameters,
|
|
2058
|
+
callback as BodyResponseCallback<unknown>
|
|
2059
|
+
);
|
|
2060
|
+
} else {
|
|
2061
|
+
return createAPIRequest<Schema$AutomaticImprovements>(parameters);
|
|
2062
|
+
}
|
|
2063
|
+
}
|
|
2064
|
+
|
|
2065
|
+
/**
|
|
2066
|
+
* Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on. If no filter is provided, then it returns all the accounts the user has access to. This method is eventually consistent, meaning changes such as creating, updating an account or a change of relationships between accounts may not show up in the results immediately. Instead, these changes propagate over a short period, after which the updated information can match the associated predicates. That means, that searching by account name might not return a recently changed account even though it satisfies the predicate.
|
|
1852
2067
|
*
|
|
1853
2068
|
* @param params - Parameters for request
|
|
1854
2069
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -2119,6 +2334,101 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
2119
2334
|
return createAPIRequest<Schema$Account>(parameters);
|
|
2120
2335
|
}
|
|
2121
2336
|
}
|
|
2337
|
+
|
|
2338
|
+
/**
|
|
2339
|
+
* Updates the automatic improvements of an account.
|
|
2340
|
+
*
|
|
2341
|
+
* @param params - Parameters for request
|
|
2342
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2343
|
+
* @param callback - Optional callback that handles the response.
|
|
2344
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2345
|
+
*/
|
|
2346
|
+
updateAutomaticImprovements(
|
|
2347
|
+
params: Params$Resource$Accounts$Updateautomaticimprovements,
|
|
2348
|
+
options: StreamMethodOptions
|
|
2349
|
+
): GaxiosPromise<Readable>;
|
|
2350
|
+
updateAutomaticImprovements(
|
|
2351
|
+
params?: Params$Resource$Accounts$Updateautomaticimprovements,
|
|
2352
|
+
options?: MethodOptions
|
|
2353
|
+
): GaxiosPromise<Schema$AutomaticImprovements>;
|
|
2354
|
+
updateAutomaticImprovements(
|
|
2355
|
+
params: Params$Resource$Accounts$Updateautomaticimprovements,
|
|
2356
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
2357
|
+
callback: BodyResponseCallback<Readable>
|
|
2358
|
+
): void;
|
|
2359
|
+
updateAutomaticImprovements(
|
|
2360
|
+
params: Params$Resource$Accounts$Updateautomaticimprovements,
|
|
2361
|
+
options:
|
|
2362
|
+
| MethodOptions
|
|
2363
|
+
| BodyResponseCallback<Schema$AutomaticImprovements>,
|
|
2364
|
+
callback: BodyResponseCallback<Schema$AutomaticImprovements>
|
|
2365
|
+
): void;
|
|
2366
|
+
updateAutomaticImprovements(
|
|
2367
|
+
params: Params$Resource$Accounts$Updateautomaticimprovements,
|
|
2368
|
+
callback: BodyResponseCallback<Schema$AutomaticImprovements>
|
|
2369
|
+
): void;
|
|
2370
|
+
updateAutomaticImprovements(
|
|
2371
|
+
callback: BodyResponseCallback<Schema$AutomaticImprovements>
|
|
2372
|
+
): void;
|
|
2373
|
+
updateAutomaticImprovements(
|
|
2374
|
+
paramsOrCallback?:
|
|
2375
|
+
| Params$Resource$Accounts$Updateautomaticimprovements
|
|
2376
|
+
| BodyResponseCallback<Schema$AutomaticImprovements>
|
|
2377
|
+
| BodyResponseCallback<Readable>,
|
|
2378
|
+
optionsOrCallback?:
|
|
2379
|
+
| MethodOptions
|
|
2380
|
+
| StreamMethodOptions
|
|
2381
|
+
| BodyResponseCallback<Schema$AutomaticImprovements>
|
|
2382
|
+
| BodyResponseCallback<Readable>,
|
|
2383
|
+
callback?:
|
|
2384
|
+
| BodyResponseCallback<Schema$AutomaticImprovements>
|
|
2385
|
+
| BodyResponseCallback<Readable>
|
|
2386
|
+
):
|
|
2387
|
+
| void
|
|
2388
|
+
| GaxiosPromise<Schema$AutomaticImprovements>
|
|
2389
|
+
| GaxiosPromise<Readable> {
|
|
2390
|
+
let params = (paramsOrCallback ||
|
|
2391
|
+
{}) as Params$Resource$Accounts$Updateautomaticimprovements;
|
|
2392
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
2393
|
+
|
|
2394
|
+
if (typeof paramsOrCallback === 'function') {
|
|
2395
|
+
callback = paramsOrCallback;
|
|
2396
|
+
params = {} as Params$Resource$Accounts$Updateautomaticimprovements;
|
|
2397
|
+
options = {};
|
|
2398
|
+
}
|
|
2399
|
+
|
|
2400
|
+
if (typeof optionsOrCallback === 'function') {
|
|
2401
|
+
callback = optionsOrCallback;
|
|
2402
|
+
options = {};
|
|
2403
|
+
}
|
|
2404
|
+
|
|
2405
|
+
const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/';
|
|
2406
|
+
const parameters = {
|
|
2407
|
+
options: Object.assign(
|
|
2408
|
+
{
|
|
2409
|
+
url: (rootUrl + '/accounts/v1beta/{+name}').replace(
|
|
2410
|
+
/([^:]\/)\/+/g,
|
|
2411
|
+
'$1'
|
|
2412
|
+
),
|
|
2413
|
+
method: 'PATCH',
|
|
2414
|
+
apiVersion: '',
|
|
2415
|
+
},
|
|
2416
|
+
options
|
|
2417
|
+
),
|
|
2418
|
+
params,
|
|
2419
|
+
requiredParams: ['name'],
|
|
2420
|
+
pathParams: ['name'],
|
|
2421
|
+
context: this.context,
|
|
2422
|
+
};
|
|
2423
|
+
if (callback) {
|
|
2424
|
+
createAPIRequest<Schema$AutomaticImprovements>(
|
|
2425
|
+
parameters,
|
|
2426
|
+
callback as BodyResponseCallback<unknown>
|
|
2427
|
+
);
|
|
2428
|
+
} else {
|
|
2429
|
+
return createAPIRequest<Schema$AutomaticImprovements>(parameters);
|
|
2430
|
+
}
|
|
2431
|
+
}
|
|
2122
2432
|
}
|
|
2123
2433
|
|
|
2124
2434
|
export interface Params$Resource$Accounts$Createandconfigure
|
|
@@ -2144,9 +2454,16 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
2144
2454
|
*/
|
|
2145
2455
|
name?: string;
|
|
2146
2456
|
}
|
|
2457
|
+
export interface Params$Resource$Accounts$Getautomaticimprovements
|
|
2458
|
+
extends StandardParameters {
|
|
2459
|
+
/**
|
|
2460
|
+
* Required. The resource name of the automatic improvements. Format: `accounts/{account\}/automaticImprovements`
|
|
2461
|
+
*/
|
|
2462
|
+
name?: string;
|
|
2463
|
+
}
|
|
2147
2464
|
export interface Params$Resource$Accounts$List extends StandardParameters {
|
|
2148
2465
|
/**
|
|
2149
|
-
* Optional. Returns only accounts that match the [filter](/merchant/api/guides/accounts/filter). For more details, see the [filter syntax reference](/merchant/api/guides/accounts/filter-syntax).
|
|
2466
|
+
* Optional. Returns only accounts that match the [filter](https://developers.google.com/merchant/api/guides/accounts/filter). For more details, see the [filter syntax reference](https://developers.google.com/merchant/api/guides/accounts/filter-syntax).
|
|
2150
2467
|
*/
|
|
2151
2468
|
filter?: string;
|
|
2152
2469
|
/**
|
|
@@ -2188,6 +2505,22 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
2188
2505
|
*/
|
|
2189
2506
|
requestBody?: Schema$Account;
|
|
2190
2507
|
}
|
|
2508
|
+
export interface Params$Resource$Accounts$Updateautomaticimprovements
|
|
2509
|
+
extends StandardParameters {
|
|
2510
|
+
/**
|
|
2511
|
+
* Identifier. The resource name of the automatic improvements. Format: `accounts/{account\}/automaticImprovements`.
|
|
2512
|
+
*/
|
|
2513
|
+
name?: string;
|
|
2514
|
+
/**
|
|
2515
|
+
* Required. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `item_updates` - `item_updates.account_level_settings` - `image_improvements` - `image_improvements.account_level_settings` - `shipping_improvements` - `shipping_improvements.allow_shipping_improvements`
|
|
2516
|
+
*/
|
|
2517
|
+
updateMask?: string;
|
|
2518
|
+
|
|
2519
|
+
/**
|
|
2520
|
+
* Request body metadata
|
|
2521
|
+
*/
|
|
2522
|
+
requestBody?: Schema$AutomaticImprovements;
|
|
2523
|
+
}
|
|
2191
2524
|
|
|
2192
2525
|
export class Resource$Accounts$Autofeedsettings {
|
|
2193
2526
|
context: APIRequestContext;
|