@googleapis/merchantapi 1.1.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 +45 -0
- package/accounts_v1beta.ts +675 -87
- package/build/accounts_v1beta.d.ts +344 -85
- package/build/accounts_v1beta.js +138 -1
- package/build/accounts_v1beta.js.map +1 -1
- package/build/conversions_v1beta.d.ts +15 -10
- package/build/conversions_v1beta.js.map +1 -1
- package/build/datasources_v1beta.d.ts +187 -19
- package/build/datasources_v1beta.js +39 -0
- package/build/datasources_v1beta.js.map +1 -1
- package/build/index.d.ts +5 -0
- package/build/index.js +4 -1
- package/build/index.js.map +1 -1
- package/build/inventories_v1beta.d.ts +13 -5
- package/build/inventories_v1beta.js.map +1 -1
- package/build/lfp_v1beta.d.ts +13 -5
- package/build/lfp_v1beta.js.map +1 -1
- package/build/notifications_v1beta.d.ts +14 -6
- package/build/notifications_v1beta.js.map +1 -1
- package/build/products_v1beta.d.ts +81 -16
- package/build/products_v1beta.js +32 -0
- package/build/products_v1beta.js.map +1 -1
- package/build/promotions_v1beta.d.ts +14 -6
- package/build/promotions_v1beta.js.map +1 -1
- package/build/quota_v1beta.d.ts +14 -6
- package/build/quota_v1beta.js.map +1 -1
- package/build/reports_v1beta.d.ts +13 -5
- package/build/reports_v1beta.js.map +1 -1
- package/build/reviews_v1beta.d.ts +786 -0
- package/build/reviews_v1beta.js +322 -0
- package/build/reviews_v1beta.js.map +1 -0
- package/conversions_v1beta.ts +15 -10
- package/datasources_v1beta.ts +267 -19
- package/index.ts +13 -1
- package/inventories_v1beta.ts +13 -5
- package/lfp_v1beta.ts +13 -5
- package/notifications_v1beta.ts +14 -6
- package/package.json +1 -1
- package/products_v1beta.ts +157 -16
- package/promotions_v1beta.ts +14 -6
- package/quota_v1beta.ts +14 -6
- package/reports_v1beta.ts +13 -5
- package/reviews_v1beta.ts +1465 -0
package/accounts_v1beta.ts
CHANGED
|
@@ -144,20 +144,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
144
144
|
validUntil?: Schema$Date;
|
|
145
145
|
}
|
|
146
146
|
/**
|
|
147
|
-
*
|
|
148
|
-
*/
|
|
149
|
-
export interface Schema$AcceptTermsOfService {
|
|
150
|
-
/**
|
|
151
|
-
* Required. The resource name of the terms of service version.
|
|
152
|
-
*/
|
|
153
|
-
name?: string | null;
|
|
154
|
-
/**
|
|
155
|
-
* Required. Region code as defined by [CLDR](https://cldr.unicode.org/). This is either a country when the ToS applies specifically to that country or `001` when it applies globally.
|
|
156
|
-
*/
|
|
157
|
-
regionCode?: string | null;
|
|
158
|
-
}
|
|
159
|
-
/**
|
|
160
|
-
* An account.
|
|
147
|
+
* The `Account` message represents a merchant's account within Shopping Ads. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a multi-client account (MCA) structure. In an MCA setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on.
|
|
161
148
|
*/
|
|
162
149
|
export interface Schema$Account {
|
|
163
150
|
/**
|
|
@@ -169,7 +156,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
169
156
|
*/
|
|
170
157
|
accountName?: string | null;
|
|
171
158
|
/**
|
|
172
|
-
* Whether this account contains adult content.
|
|
159
|
+
* Optional. Whether this account contains adult content.
|
|
173
160
|
*/
|
|
174
161
|
adultContent?: boolean | null;
|
|
175
162
|
/**
|
|
@@ -189,6 +176,10 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
189
176
|
*/
|
|
190
177
|
timeZone?: Schema$TimeZone;
|
|
191
178
|
}
|
|
179
|
+
/**
|
|
180
|
+
* `AccountAggregation` payload.
|
|
181
|
+
*/
|
|
182
|
+
export interface Schema$AccountAggregation {}
|
|
192
183
|
/**
|
|
193
184
|
* An [`AccountIssue`](https://support.google.com/merchants/answer/12153802?sjid=17798438912526418908-EU#account).
|
|
194
185
|
*/
|
|
@@ -223,11 +214,11 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
223
214
|
*/
|
|
224
215
|
export interface Schema$AddAccountService {
|
|
225
216
|
/**
|
|
226
|
-
* The provider is an aggregator for the account.
|
|
217
|
+
* The provider is an [aggregator](https://support.google.com/merchants/answer/188487) for the account. Payload for service type Account Aggregation.
|
|
227
218
|
*/
|
|
228
|
-
accountAggregation?: Schema$
|
|
219
|
+
accountAggregation?: Schema$AccountAggregation;
|
|
229
220
|
/**
|
|
230
|
-
*
|
|
221
|
+
* Required. The provider of the service. Either the reference to an account such as `providers/123` or a well-known service provider (one of `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`).
|
|
231
222
|
*/
|
|
232
223
|
provider?: string | null;
|
|
233
224
|
}
|
|
@@ -256,6 +247,104 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
256
247
|
*/
|
|
257
248
|
streetAddress?: string | null;
|
|
258
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
|
+
}
|
|
263
|
+
/**
|
|
264
|
+
* Collection of information related to the [autofeed](https://support.google.com/merchants/answer/7538732) settings.
|
|
265
|
+
*/
|
|
266
|
+
export interface Schema$AutofeedSettings {
|
|
267
|
+
/**
|
|
268
|
+
* Output only. Determines whether merchant is eligible for being enrolled into an autofeed.
|
|
269
|
+
*/
|
|
270
|
+
eligible?: boolean | null;
|
|
271
|
+
/**
|
|
272
|
+
* Required. Enables or disables product crawling through the autofeed for the given account. Autofeed accounts must meet [certain conditions](https://support.google.com/merchants/answer/7538732#Configure_automated_feeds_Standard_Experience), which can be checked through the `eligible` field. The account must **not** be a marketplace. When the autofeed is enabled for the first time, the products usually appear instantly. When re-enabling, it might take up to 24 hours for products to appear.
|
|
273
|
+
*/
|
|
274
|
+
enableProducts?: boolean | null;
|
|
275
|
+
/**
|
|
276
|
+
* Identifier. The resource name of the autofeed settings. Format: `accounts/{account\}/autofeedSettings`.
|
|
277
|
+
*/
|
|
278
|
+
name?: string | null;
|
|
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
|
+
}
|
|
259
348
|
/**
|
|
260
349
|
* Business days of the warehouse.
|
|
261
350
|
*/
|
|
@@ -282,7 +371,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
282
371
|
*/
|
|
283
372
|
name?: string | null;
|
|
284
373
|
/**
|
|
285
|
-
*
|
|
374
|
+
* Required. Whether the identity attributes may be used for promotions.
|
|
286
375
|
*/
|
|
287
376
|
promotionsConsent?: string | null;
|
|
288
377
|
/**
|
|
@@ -299,11 +388,11 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
299
388
|
womenOwned?: Schema$IdentityAttribute;
|
|
300
389
|
}
|
|
301
390
|
/**
|
|
302
|
-
*
|
|
391
|
+
* The `BusinessInfo` message contains essential information about a merchant's business. This message captures key business details such as physical address, customer service contacts, and region-specific identifiers.
|
|
303
392
|
*/
|
|
304
393
|
export interface Schema$BusinessInfo {
|
|
305
394
|
/**
|
|
306
|
-
* Optional. The address of the business.
|
|
395
|
+
* Optional. The address of the business. Only `region_code`, `address_lines`, `postal_code`, `administrative_area` and `locality` fields are supported. All other fields are ignored.
|
|
307
396
|
*/
|
|
308
397
|
address?: Schema$PostalAddress;
|
|
309
398
|
/**
|
|
@@ -328,7 +417,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
328
417
|
phoneVerificationState?: string | null;
|
|
329
418
|
}
|
|
330
419
|
/**
|
|
331
|
-
* A list of carrier rates that can be referred to by `main_table` or `single_value`.
|
|
420
|
+
* A list of carrier rates that can be referred to by `main_table` or `single_value`. Supported carrier services are defined in https://support.google.com/merchants/answer/12577710?ref_topic=12570808&sjid=10662598224319463032-NC#zippy=%2Cdelivery-cost-rate-type%2Ccarrier-rate-au-de-uk-and-us-only.
|
|
332
421
|
*/
|
|
333
422
|
export interface Schema$CarrierRate {
|
|
334
423
|
/**
|
|
@@ -359,26 +448,31 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
359
448
|
/**
|
|
360
449
|
* Request message for the `ClaimHomepage` method.
|
|
361
450
|
*/
|
|
362
|
-
export interface Schema$ClaimHomepageRequest {
|
|
451
|
+
export interface Schema$ClaimHomepageRequest {
|
|
452
|
+
/**
|
|
453
|
+
* Optional. When set to `true`, this option removes any existing claim on the requested website and replaces it with a claim from the account that makes the request.
|
|
454
|
+
*/
|
|
455
|
+
overwrite?: boolean | null;
|
|
456
|
+
}
|
|
363
457
|
/**
|
|
364
458
|
* Request message for the `CreateAndConfigureAccount` method.
|
|
365
459
|
*/
|
|
366
460
|
export interface Schema$CreateAndConfigureAccountRequest {
|
|
367
|
-
/**
|
|
368
|
-
* Optional. The Terms of Service (ToS) to be accepted immediately upon account creation.
|
|
369
|
-
*/
|
|
370
|
-
acceptTermsOfService?: Schema$AcceptTermsOfService;
|
|
371
461
|
/**
|
|
372
462
|
* Required. The account to be created.
|
|
373
463
|
*/
|
|
374
464
|
account?: Schema$Account;
|
|
375
465
|
/**
|
|
376
|
-
* Required. An account service between the account to be created and the provider account is initialized as part of the creation. At least one such service needs to be provided. Currently
|
|
466
|
+
* Required. An account service between the account to be created and the provider account is initialized as part of the creation. At least one such service needs to be provided. Currently exactly one of these needs to be `account_aggregation`, which means you can only create sub accounts, not standalone account through this method. Additional `account_management` or `product_management` services may be provided.
|
|
377
467
|
*/
|
|
378
468
|
service?: Schema$AddAccountService[];
|
|
379
469
|
/**
|
|
380
470
|
* Optional. Users to be added to the account.
|
|
381
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
|
+
*/
|
|
382
476
|
users?: Schema$CreateUserRequest[];
|
|
383
477
|
}
|
|
384
478
|
/**
|
|
@@ -390,7 +484,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
390
484
|
*/
|
|
391
485
|
parent?: string | null;
|
|
392
486
|
/**
|
|
393
|
-
*
|
|
487
|
+
* Optional. The user to create.
|
|
394
488
|
*/
|
|
395
489
|
user?: Schema$User;
|
|
396
490
|
/**
|
|
@@ -479,7 +573,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
479
573
|
*/
|
|
480
574
|
handlingBusinessDayConfig?: Schema$BusinessDayConfig;
|
|
481
575
|
/**
|
|
482
|
-
* Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to `min_handling_days`.
|
|
576
|
+
* Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to `min_handling_days`. 'min_handling_days' and 'max_handling_days' should be either set or not set at the same time.
|
|
483
577
|
*/
|
|
484
578
|
maxHandlingDays?: number | null;
|
|
485
579
|
/**
|
|
@@ -487,7 +581,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
487
581
|
*/
|
|
488
582
|
maxTransitDays?: number | null;
|
|
489
583
|
/**
|
|
490
|
-
* Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped.
|
|
584
|
+
* Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. 'min_handling_days' and 'max_handling_days' should be either set or not set at the same time.
|
|
491
585
|
*/
|
|
492
586
|
minHandlingDays?: number | null;
|
|
493
587
|
/**
|
|
@@ -580,7 +674,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
580
674
|
weights?: Schema$Weight[];
|
|
581
675
|
}
|
|
582
676
|
/**
|
|
583
|
-
* A
|
|
677
|
+
* The `Homepage` message represents a merchant's store homepage within the system. A merchant's homepage is the primary domain where customers interact with their store. The homepage can be claimed and verified as a proof of ownership and allows the merchant to unlock features that require a verified website. For more information, see [Understanding online store URL verification](//support.google.com/merchants/answer/176793).
|
|
584
678
|
*/
|
|
585
679
|
export interface Schema$Homepage {
|
|
586
680
|
/**
|
|
@@ -605,6 +699,15 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
605
699
|
*/
|
|
606
700
|
identityDeclaration?: string | null;
|
|
607
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
|
+
}
|
|
608
711
|
/**
|
|
609
712
|
* The impact of the issue on a region.
|
|
610
713
|
*/
|
|
@@ -631,6 +734,27 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
631
734
|
*/
|
|
632
735
|
reportingContext?: string | null;
|
|
633
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
|
+
}
|
|
634
758
|
/**
|
|
635
759
|
* Response message for the `ListAccountIssues` method.
|
|
636
760
|
*/
|
|
@@ -788,15 +912,15 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
788
912
|
*/
|
|
789
913
|
acceptExchange?: boolean | null;
|
|
790
914
|
/**
|
|
791
|
-
* The countries of sale where the return policy applies. The values must be a valid 2 letter ISO 3166 code.
|
|
915
|
+
* Required. Immutable. The countries of sale where the return policy applies. The values must be a valid 2 letter ISO 3166 code.
|
|
792
916
|
*/
|
|
793
917
|
countries?: string[] | null;
|
|
794
918
|
/**
|
|
795
|
-
* 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'.
|
|
796
920
|
*/
|
|
797
921
|
itemConditions?: string[] | null;
|
|
798
922
|
/**
|
|
799
|
-
* This field represents the unique user-defined label of the return policy. It is important to note that the same label cannot be used in different return policies for the same country. Unless a product specifies a specific label attribute, policies will be automatically labeled as 'default'. To assign a custom return policy to certain product groups, follow the instructions provided in the [Return policy label] (https://support.google.com/merchants/answer/9445425). The label can contain up to 50 characters.
|
|
923
|
+
* Required. Immutable. This field represents the unique user-defined label of the return policy. It is important to note that the same label cannot be used in different return policies for the same country. Unless a product specifies a specific label attribute, policies will be automatically labeled as 'default'. To assign a custom return policy to certain product groups, follow the instructions provided in the [Return policy label] (https://support.google.com/merchants/answer/9445425). The label can contain up to 50 characters.
|
|
800
924
|
*/
|
|
801
925
|
label?: string | null;
|
|
802
926
|
/**
|
|
@@ -804,7 +928,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
804
928
|
*/
|
|
805
929
|
name?: string | null;
|
|
806
930
|
/**
|
|
807
|
-
* The return policy.
|
|
931
|
+
* Optional. The return policy.
|
|
808
932
|
*/
|
|
809
933
|
policy?: Schema$Policy;
|
|
810
934
|
/**
|
|
@@ -812,11 +936,11 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
812
936
|
*/
|
|
813
937
|
processRefundDays?: number | null;
|
|
814
938
|
/**
|
|
815
|
-
* 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.
|
|
816
940
|
*/
|
|
817
941
|
restockingFee?: Schema$RestockingFee;
|
|
818
942
|
/**
|
|
819
|
-
* 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.
|
|
820
944
|
*/
|
|
821
945
|
returnMethods?: string[] | null;
|
|
822
946
|
/**
|
|
@@ -824,20 +948,24 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
824
948
|
*/
|
|
825
949
|
returnPolicyId?: string | null;
|
|
826
950
|
/**
|
|
827
|
-
* The return policy uri. This can used by Google to do a sanity check for the policy. It must be a valid URL.
|
|
951
|
+
* Required. The return policy uri. This can used by Google to do a sanity check for the policy. It must be a valid URL.
|
|
828
952
|
*/
|
|
829
953
|
returnPolicyUri?: string | null;
|
|
830
954
|
/**
|
|
831
|
-
* 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.
|
|
832
956
|
*/
|
|
833
957
|
returnShippingFee?: Schema$ReturnShippingFee;
|
|
958
|
+
/**
|
|
959
|
+
* Optional. Overrides to the general policy for orders placed during a specific set of time intervals.
|
|
960
|
+
*/
|
|
961
|
+
seasonalOverrides?: Schema$SeasonalOverride[];
|
|
834
962
|
}
|
|
835
963
|
/**
|
|
836
964
|
* An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); \} Reference(s): - https://github.com/google/libphonenumber
|
|
837
965
|
*/
|
|
838
966
|
export interface Schema$PhoneNumber {
|
|
839
967
|
/**
|
|
840
|
-
* The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting
|
|
968
|
+
* The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting. For example: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes
|
|
841
969
|
*/
|
|
842
970
|
e164Number?: string | null;
|
|
843
971
|
/**
|
|
@@ -863,15 +991,15 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
863
991
|
type?: string | null;
|
|
864
992
|
}
|
|
865
993
|
/**
|
|
866
|
-
* Represents a postal address
|
|
994
|
+
* Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478
|
|
867
995
|
*/
|
|
868
996
|
export interface Schema$PostalAddress {
|
|
869
997
|
/**
|
|
870
|
-
* Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (
|
|
998
|
+
* Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
|
|
871
999
|
*/
|
|
872
1000
|
addressLines?: string[] | null;
|
|
873
1001
|
/**
|
|
874
|
-
* Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (
|
|
1002
|
+
* Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
|
|
875
1003
|
*/
|
|
876
1004
|
administrativeArea?: string | null;
|
|
877
1005
|
/**
|
|
@@ -887,7 +1015,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
887
1015
|
*/
|
|
888
1016
|
organization?: string | null;
|
|
889
1017
|
/**
|
|
890
|
-
* Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (
|
|
1018
|
+
* Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
|
|
891
1019
|
*/
|
|
892
1020
|
postalCode?: string | null;
|
|
893
1021
|
/**
|
|
@@ -903,7 +1031,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
903
1031
|
*/
|
|
904
1032
|
revision?: number | null;
|
|
905
1033
|
/**
|
|
906
|
-
* Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (
|
|
1034
|
+
* Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
|
|
907
1035
|
*/
|
|
908
1036
|
sortingCode?: string | null;
|
|
909
1037
|
/**
|
|
@@ -955,19 +1083,19 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
955
1083
|
*/
|
|
956
1084
|
export interface Schema$ProductChange {
|
|
957
1085
|
/**
|
|
958
|
-
* 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`, ``)
|
|
959
1087
|
*/
|
|
960
1088
|
newValue?: string | null;
|
|
961
1089
|
/**
|
|
962
|
-
* 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`, ``)
|
|
963
1091
|
*/
|
|
964
1092
|
oldValue?: string | null;
|
|
965
1093
|
/**
|
|
966
|
-
* Countries that have the change (if applicable)
|
|
1094
|
+
* Countries that have the change (if applicable). Represented in the ISO 3166 format.
|
|
967
1095
|
*/
|
|
968
1096
|
regionCode?: string | null;
|
|
969
1097
|
/**
|
|
970
|
-
* 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)
|
|
971
1099
|
*/
|
|
972
1100
|
reportingContext?: string | null;
|
|
973
1101
|
}
|
|
@@ -987,12 +1115,20 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
987
1115
|
* A message to describe the change that happened to the product
|
|
988
1116
|
*/
|
|
989
1117
|
changes?: Schema$ProductChange[];
|
|
1118
|
+
/**
|
|
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.
|
|
1124
|
+
*/
|
|
1125
|
+
expirationTime?: string | null;
|
|
990
1126
|
/**
|
|
991
1127
|
* The account that manages the merchant's account. can be the same as merchant id if it is standalone account. Format : `accounts/{service_provider_id\}`
|
|
992
1128
|
*/
|
|
993
1129
|
managingAccount?: string | null;
|
|
994
1130
|
/**
|
|
995
|
-
* The product name. Format: `
|
|
1131
|
+
* The product name. Format: `accounts/{account\}/products/{product\}`
|
|
996
1132
|
*/
|
|
997
1133
|
resource?: string | null;
|
|
998
1134
|
/**
|
|
@@ -1005,7 +1141,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1005
1141
|
resourceType?: string | null;
|
|
1006
1142
|
}
|
|
1007
1143
|
/**
|
|
1008
|
-
* 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`
|
|
1009
1145
|
*/
|
|
1010
1146
|
export interface Schema$Program {
|
|
1011
1147
|
/**
|
|
@@ -1139,7 +1275,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1139
1275
|
*/
|
|
1140
1276
|
fixedFee?: Schema$Price;
|
|
1141
1277
|
/**
|
|
1142
|
-
* Type of return shipping fee.
|
|
1278
|
+
* Required. Type of return shipping fee.
|
|
1143
1279
|
*/
|
|
1144
1280
|
type?: string | null;
|
|
1145
1281
|
}
|
|
@@ -1152,6 +1288,28 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1152
1288
|
*/
|
|
1153
1289
|
cells?: Schema$Value[];
|
|
1154
1290
|
}
|
|
1291
|
+
export interface Schema$SeasonalOverride {
|
|
1292
|
+
/**
|
|
1293
|
+
* Required. seasonal override end date (inclusive).
|
|
1294
|
+
*/
|
|
1295
|
+
endDate?: Schema$Date;
|
|
1296
|
+
/**
|
|
1297
|
+
* Required. Display name of this seasonal override in Merchant Center.
|
|
1298
|
+
*/
|
|
1299
|
+
label?: string | null;
|
|
1300
|
+
/**
|
|
1301
|
+
* Number of days (from the delivery date) that the product can be returned.
|
|
1302
|
+
*/
|
|
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;
|
|
1312
|
+
}
|
|
1155
1313
|
/**
|
|
1156
1314
|
* Shipping service.
|
|
1157
1315
|
*/
|
|
@@ -1202,7 +1360,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1202
1360
|
storeConfig?: Schema$StoreConfig;
|
|
1203
1361
|
}
|
|
1204
1362
|
/**
|
|
1205
|
-
* The merchant account's [shipping setting](
|
|
1363
|
+
* The merchant account's [shipping setting](https://support.google.com/merchants/answer/6069284).
|
|
1206
1364
|
*/
|
|
1207
1365
|
export interface Schema$ShippingSettings {
|
|
1208
1366
|
/**
|
|
@@ -1223,11 +1381,11 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1223
1381
|
warehouses?: Schema$Warehouse[];
|
|
1224
1382
|
}
|
|
1225
1383
|
/**
|
|
1226
|
-
* An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (
|
|
1384
|
+
* An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (For example "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (For example: US and CA).
|
|
1227
1385
|
*/
|
|
1228
1386
|
export interface Schema$ShortCode {
|
|
1229
1387
|
/**
|
|
1230
|
-
* Required. The short code digits, without a leading plus ('+') or country calling code
|
|
1388
|
+
* Required. The short code digits, without a leading plus ('+') or country calling code. For example "611".
|
|
1231
1389
|
*/
|
|
1232
1390
|
number?: string | null;
|
|
1233
1391
|
/**
|
|
@@ -1291,7 +1449,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1291
1449
|
rows?: Schema$Row[];
|
|
1292
1450
|
}
|
|
1293
1451
|
/**
|
|
1294
|
-
*
|
|
1452
|
+
* The `TermsOfService` message represents a specific version of the terms of service that merchants must accept to access certain features or services (see https://support.google.com/merchants/answer/160173). This message is important for the onboarding process, ensuring that merchants agree to the necessary legal agreements for using the service. Merchants can retrieve the latest terms of service for a given `kind` and `region` through `RetrieveLatestTermsOfService`, and accept them as required through `AcceptTermsOfService`.
|
|
1295
1453
|
*/
|
|
1296
1454
|
export interface Schema$TermsOfService {
|
|
1297
1455
|
/**
|
|
@@ -1345,11 +1503,11 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1345
1503
|
*/
|
|
1346
1504
|
export interface Schema$TimeZone {
|
|
1347
1505
|
/**
|
|
1348
|
-
* IANA Time Zone Database time zone
|
|
1506
|
+
* IANA Time Zone Database time zone. For example "America/New_York".
|
|
1349
1507
|
*/
|
|
1350
1508
|
id?: string | null;
|
|
1351
1509
|
/**
|
|
1352
|
-
* Optional. IANA Time Zone Database version number
|
|
1510
|
+
* Optional. IANA Time Zone Database version number. For example "2019a".
|
|
1353
1511
|
*/
|
|
1354
1512
|
version?: string | null;
|
|
1355
1513
|
}
|
|
@@ -1397,11 +1555,11 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1397
1555
|
*/
|
|
1398
1556
|
export interface Schema$UnclaimHomepageRequest {}
|
|
1399
1557
|
/**
|
|
1400
|
-
*
|
|
1558
|
+
* The `User` message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).
|
|
1401
1559
|
*/
|
|
1402
1560
|
export interface Schema$User {
|
|
1403
1561
|
/**
|
|
1404
|
-
*
|
|
1562
|
+
* Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has.
|
|
1405
1563
|
*/
|
|
1406
1564
|
accessRights?: string[] | null;
|
|
1407
1565
|
/**
|
|
@@ -1439,7 +1597,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1439
1597
|
subtable?: string | null;
|
|
1440
1598
|
}
|
|
1441
1599
|
/**
|
|
1442
|
-
* A fulfillment warehouse, which stores and handles inventory.
|
|
1600
|
+
* A fulfillment warehouse, which stores and handles inventory.
|
|
1443
1601
|
*/
|
|
1444
1602
|
export interface Schema$Warehouse {
|
|
1445
1603
|
/**
|
|
@@ -1468,7 +1626,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1468
1626
|
*/
|
|
1469
1627
|
export interface Schema$WarehouseBasedDeliveryTime {
|
|
1470
1628
|
/**
|
|
1471
|
-
* Required. Carrier, such as `"UPS"` or `"Fedex"`.
|
|
1629
|
+
* Required. Carrier, such as `"UPS"` or `"Fedex"`. [supported carriers](https://support.google.com/merchants/answer/7050921#zippy=%2Ccarrier-rates-au-de-uk-and-us-only)
|
|
1472
1630
|
*/
|
|
1473
1631
|
carrier?: string | null;
|
|
1474
1632
|
/**
|
|
@@ -1509,9 +1667,10 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1509
1667
|
|
|
1510
1668
|
export class Resource$Accounts {
|
|
1511
1669
|
context: APIRequestContext;
|
|
1670
|
+
autofeedSettings: Resource$Accounts$Autofeedsettings;
|
|
1512
1671
|
businessIdentity: Resource$Accounts$Businessidentity;
|
|
1513
1672
|
businessInfo: Resource$Accounts$Businessinfo;
|
|
1514
|
-
|
|
1673
|
+
emailPreferences: Resource$Accounts$Emailpreferences;
|
|
1515
1674
|
homepage: Resource$Accounts$Homepage;
|
|
1516
1675
|
issues: Resource$Accounts$Issues;
|
|
1517
1676
|
onlineReturnPolicies: Resource$Accounts$Onlinereturnpolicies;
|
|
@@ -1522,11 +1681,14 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1522
1681
|
users: Resource$Accounts$Users;
|
|
1523
1682
|
constructor(context: APIRequestContext) {
|
|
1524
1683
|
this.context = context;
|
|
1684
|
+
this.autofeedSettings = new Resource$Accounts$Autofeedsettings(
|
|
1685
|
+
this.context
|
|
1686
|
+
);
|
|
1525
1687
|
this.businessIdentity = new Resource$Accounts$Businessidentity(
|
|
1526
1688
|
this.context
|
|
1527
1689
|
);
|
|
1528
1690
|
this.businessInfo = new Resource$Accounts$Businessinfo(this.context);
|
|
1529
|
-
this.
|
|
1691
|
+
this.emailPreferences = new Resource$Accounts$Emailpreferences(
|
|
1530
1692
|
this.context
|
|
1531
1693
|
);
|
|
1532
1694
|
this.homepage = new Resource$Accounts$Homepage(this.context);
|
|
@@ -1632,7 +1794,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1632
1794
|
}
|
|
1633
1795
|
|
|
1634
1796
|
/**
|
|
1635
|
-
* Deletes the specified account regardless of its type: standalone, MCA or sub-account. Deleting an MCA leads to the deletion of all of its sub-accounts. Executing this method requires admin access.
|
|
1797
|
+
* Deletes the specified account regardless of its type: standalone, MCA or sub-account. Deleting an MCA leads to the deletion of all of its sub-accounts. Executing this method requires admin access. The deletion succeeds only if the account does not provide services to any other account and has no processed offers. You can use the `force` parameter to override this.
|
|
1636
1798
|
*
|
|
1637
1799
|
* @param params - Parameters for request
|
|
1638
1800
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1806,7 +1968,102 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
1806
1968
|
}
|
|
1807
1969
|
|
|
1808
1970
|
/**
|
|
1809
|
-
*
|
|
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.
|
|
1810
2067
|
*
|
|
1811
2068
|
* @param params - Parameters for request
|
|
1812
2069
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -2077,6 +2334,101 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
2077
2334
|
return createAPIRequest<Schema$Account>(parameters);
|
|
2078
2335
|
}
|
|
2079
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
|
+
}
|
|
2080
2432
|
}
|
|
2081
2433
|
|
|
2082
2434
|
export interface Params$Resource$Accounts$Createandconfigure
|
|
@@ -2087,6 +2439,10 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
2087
2439
|
requestBody?: Schema$CreateAndConfigureAccountRequest;
|
|
2088
2440
|
}
|
|
2089
2441
|
export interface Params$Resource$Accounts$Delete extends StandardParameters {
|
|
2442
|
+
/**
|
|
2443
|
+
* Optional. If set to `true`, the account is deleted even if it provides services to other accounts or has processed offers.
|
|
2444
|
+
*/
|
|
2445
|
+
force?: boolean;
|
|
2090
2446
|
/**
|
|
2091
2447
|
* Required. The name of the account to delete. Format: `accounts/{account\}`
|
|
2092
2448
|
*/
|
|
@@ -2098,9 +2454,16 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
2098
2454
|
*/
|
|
2099
2455
|
name?: string;
|
|
2100
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
|
+
}
|
|
2101
2464
|
export interface Params$Resource$Accounts$List extends StandardParameters {
|
|
2102
2465
|
/**
|
|
2103
|
-
* 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).
|
|
2104
2467
|
*/
|
|
2105
2468
|
filter?: string;
|
|
2106
2469
|
/**
|
|
@@ -2123,7 +2486,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
2123
2486
|
*/
|
|
2124
2487
|
pageToken?: string;
|
|
2125
2488
|
/**
|
|
2126
|
-
* Required. The
|
|
2489
|
+
* Required. The aggregation service provider. Format: `providers/{providerId\}`
|
|
2127
2490
|
*/
|
|
2128
2491
|
provider?: string;
|
|
2129
2492
|
}
|
|
@@ -2133,7 +2496,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
2133
2496
|
*/
|
|
2134
2497
|
name?: string;
|
|
2135
2498
|
/**
|
|
2136
|
-
*
|
|
2499
|
+
* Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `account_name` - `adult_content` - `language_code` - `time_zone`
|
|
2137
2500
|
*/
|
|
2138
2501
|
updateMask?: string;
|
|
2139
2502
|
|
|
@@ -2142,6 +2505,235 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
2142
2505
|
*/
|
|
2143
2506
|
requestBody?: Schema$Account;
|
|
2144
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
|
+
}
|
|
2524
|
+
|
|
2525
|
+
export class Resource$Accounts$Autofeedsettings {
|
|
2526
|
+
context: APIRequestContext;
|
|
2527
|
+
constructor(context: APIRequestContext) {
|
|
2528
|
+
this.context = context;
|
|
2529
|
+
}
|
|
2530
|
+
|
|
2531
|
+
/**
|
|
2532
|
+
* Retrieves the autofeed settings of an account.
|
|
2533
|
+
*
|
|
2534
|
+
* @param params - Parameters for request
|
|
2535
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2536
|
+
* @param callback - Optional callback that handles the response.
|
|
2537
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2538
|
+
*/
|
|
2539
|
+
getAutofeedSettings(
|
|
2540
|
+
params: Params$Resource$Accounts$Autofeedsettings$Getautofeedsettings,
|
|
2541
|
+
options: StreamMethodOptions
|
|
2542
|
+
): GaxiosPromise<Readable>;
|
|
2543
|
+
getAutofeedSettings(
|
|
2544
|
+
params?: Params$Resource$Accounts$Autofeedsettings$Getautofeedsettings,
|
|
2545
|
+
options?: MethodOptions
|
|
2546
|
+
): GaxiosPromise<Schema$AutofeedSettings>;
|
|
2547
|
+
getAutofeedSettings(
|
|
2548
|
+
params: Params$Resource$Accounts$Autofeedsettings$Getautofeedsettings,
|
|
2549
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
2550
|
+
callback: BodyResponseCallback<Readable>
|
|
2551
|
+
): void;
|
|
2552
|
+
getAutofeedSettings(
|
|
2553
|
+
params: Params$Resource$Accounts$Autofeedsettings$Getautofeedsettings,
|
|
2554
|
+
options: MethodOptions | BodyResponseCallback<Schema$AutofeedSettings>,
|
|
2555
|
+
callback: BodyResponseCallback<Schema$AutofeedSettings>
|
|
2556
|
+
): void;
|
|
2557
|
+
getAutofeedSettings(
|
|
2558
|
+
params: Params$Resource$Accounts$Autofeedsettings$Getautofeedsettings,
|
|
2559
|
+
callback: BodyResponseCallback<Schema$AutofeedSettings>
|
|
2560
|
+
): void;
|
|
2561
|
+
getAutofeedSettings(
|
|
2562
|
+
callback: BodyResponseCallback<Schema$AutofeedSettings>
|
|
2563
|
+
): void;
|
|
2564
|
+
getAutofeedSettings(
|
|
2565
|
+
paramsOrCallback?:
|
|
2566
|
+
| Params$Resource$Accounts$Autofeedsettings$Getautofeedsettings
|
|
2567
|
+
| BodyResponseCallback<Schema$AutofeedSettings>
|
|
2568
|
+
| BodyResponseCallback<Readable>,
|
|
2569
|
+
optionsOrCallback?:
|
|
2570
|
+
| MethodOptions
|
|
2571
|
+
| StreamMethodOptions
|
|
2572
|
+
| BodyResponseCallback<Schema$AutofeedSettings>
|
|
2573
|
+
| BodyResponseCallback<Readable>,
|
|
2574
|
+
callback?:
|
|
2575
|
+
| BodyResponseCallback<Schema$AutofeedSettings>
|
|
2576
|
+
| BodyResponseCallback<Readable>
|
|
2577
|
+
): void | GaxiosPromise<Schema$AutofeedSettings> | GaxiosPromise<Readable> {
|
|
2578
|
+
let params = (paramsOrCallback ||
|
|
2579
|
+
{}) as Params$Resource$Accounts$Autofeedsettings$Getautofeedsettings;
|
|
2580
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
2581
|
+
|
|
2582
|
+
if (typeof paramsOrCallback === 'function') {
|
|
2583
|
+
callback = paramsOrCallback;
|
|
2584
|
+
params =
|
|
2585
|
+
{} as Params$Resource$Accounts$Autofeedsettings$Getautofeedsettings;
|
|
2586
|
+
options = {};
|
|
2587
|
+
}
|
|
2588
|
+
|
|
2589
|
+
if (typeof optionsOrCallback === 'function') {
|
|
2590
|
+
callback = optionsOrCallback;
|
|
2591
|
+
options = {};
|
|
2592
|
+
}
|
|
2593
|
+
|
|
2594
|
+
const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/';
|
|
2595
|
+
const parameters = {
|
|
2596
|
+
options: Object.assign(
|
|
2597
|
+
{
|
|
2598
|
+
url: (rootUrl + '/accounts/v1beta/{+name}').replace(
|
|
2599
|
+
/([^:]\/)\/+/g,
|
|
2600
|
+
'$1'
|
|
2601
|
+
),
|
|
2602
|
+
method: 'GET',
|
|
2603
|
+
apiVersion: '',
|
|
2604
|
+
},
|
|
2605
|
+
options
|
|
2606
|
+
),
|
|
2607
|
+
params,
|
|
2608
|
+
requiredParams: ['name'],
|
|
2609
|
+
pathParams: ['name'],
|
|
2610
|
+
context: this.context,
|
|
2611
|
+
};
|
|
2612
|
+
if (callback) {
|
|
2613
|
+
createAPIRequest<Schema$AutofeedSettings>(
|
|
2614
|
+
parameters,
|
|
2615
|
+
callback as BodyResponseCallback<unknown>
|
|
2616
|
+
);
|
|
2617
|
+
} else {
|
|
2618
|
+
return createAPIRequest<Schema$AutofeedSettings>(parameters);
|
|
2619
|
+
}
|
|
2620
|
+
}
|
|
2621
|
+
|
|
2622
|
+
/**
|
|
2623
|
+
* Updates the autofeed settings of an account.
|
|
2624
|
+
*
|
|
2625
|
+
* @param params - Parameters for request
|
|
2626
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2627
|
+
* @param callback - Optional callback that handles the response.
|
|
2628
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2629
|
+
*/
|
|
2630
|
+
updateAutofeedSettings(
|
|
2631
|
+
params: Params$Resource$Accounts$Autofeedsettings$Updateautofeedsettings,
|
|
2632
|
+
options: StreamMethodOptions
|
|
2633
|
+
): GaxiosPromise<Readable>;
|
|
2634
|
+
updateAutofeedSettings(
|
|
2635
|
+
params?: Params$Resource$Accounts$Autofeedsettings$Updateautofeedsettings,
|
|
2636
|
+
options?: MethodOptions
|
|
2637
|
+
): GaxiosPromise<Schema$AutofeedSettings>;
|
|
2638
|
+
updateAutofeedSettings(
|
|
2639
|
+
params: Params$Resource$Accounts$Autofeedsettings$Updateautofeedsettings,
|
|
2640
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
2641
|
+
callback: BodyResponseCallback<Readable>
|
|
2642
|
+
): void;
|
|
2643
|
+
updateAutofeedSettings(
|
|
2644
|
+
params: Params$Resource$Accounts$Autofeedsettings$Updateautofeedsettings,
|
|
2645
|
+
options: MethodOptions | BodyResponseCallback<Schema$AutofeedSettings>,
|
|
2646
|
+
callback: BodyResponseCallback<Schema$AutofeedSettings>
|
|
2647
|
+
): void;
|
|
2648
|
+
updateAutofeedSettings(
|
|
2649
|
+
params: Params$Resource$Accounts$Autofeedsettings$Updateautofeedsettings,
|
|
2650
|
+
callback: BodyResponseCallback<Schema$AutofeedSettings>
|
|
2651
|
+
): void;
|
|
2652
|
+
updateAutofeedSettings(
|
|
2653
|
+
callback: BodyResponseCallback<Schema$AutofeedSettings>
|
|
2654
|
+
): void;
|
|
2655
|
+
updateAutofeedSettings(
|
|
2656
|
+
paramsOrCallback?:
|
|
2657
|
+
| Params$Resource$Accounts$Autofeedsettings$Updateautofeedsettings
|
|
2658
|
+
| BodyResponseCallback<Schema$AutofeedSettings>
|
|
2659
|
+
| BodyResponseCallback<Readable>,
|
|
2660
|
+
optionsOrCallback?:
|
|
2661
|
+
| MethodOptions
|
|
2662
|
+
| StreamMethodOptions
|
|
2663
|
+
| BodyResponseCallback<Schema$AutofeedSettings>
|
|
2664
|
+
| BodyResponseCallback<Readable>,
|
|
2665
|
+
callback?:
|
|
2666
|
+
| BodyResponseCallback<Schema$AutofeedSettings>
|
|
2667
|
+
| BodyResponseCallback<Readable>
|
|
2668
|
+
): void | GaxiosPromise<Schema$AutofeedSettings> | GaxiosPromise<Readable> {
|
|
2669
|
+
let params = (paramsOrCallback ||
|
|
2670
|
+
{}) as Params$Resource$Accounts$Autofeedsettings$Updateautofeedsettings;
|
|
2671
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
2672
|
+
|
|
2673
|
+
if (typeof paramsOrCallback === 'function') {
|
|
2674
|
+
callback = paramsOrCallback;
|
|
2675
|
+
params =
|
|
2676
|
+
{} as Params$Resource$Accounts$Autofeedsettings$Updateautofeedsettings;
|
|
2677
|
+
options = {};
|
|
2678
|
+
}
|
|
2679
|
+
|
|
2680
|
+
if (typeof optionsOrCallback === 'function') {
|
|
2681
|
+
callback = optionsOrCallback;
|
|
2682
|
+
options = {};
|
|
2683
|
+
}
|
|
2684
|
+
|
|
2685
|
+
const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/';
|
|
2686
|
+
const parameters = {
|
|
2687
|
+
options: Object.assign(
|
|
2688
|
+
{
|
|
2689
|
+
url: (rootUrl + '/accounts/v1beta/{+name}').replace(
|
|
2690
|
+
/([^:]\/)\/+/g,
|
|
2691
|
+
'$1'
|
|
2692
|
+
),
|
|
2693
|
+
method: 'PATCH',
|
|
2694
|
+
apiVersion: '',
|
|
2695
|
+
},
|
|
2696
|
+
options
|
|
2697
|
+
),
|
|
2698
|
+
params,
|
|
2699
|
+
requiredParams: ['name'],
|
|
2700
|
+
pathParams: ['name'],
|
|
2701
|
+
context: this.context,
|
|
2702
|
+
};
|
|
2703
|
+
if (callback) {
|
|
2704
|
+
createAPIRequest<Schema$AutofeedSettings>(
|
|
2705
|
+
parameters,
|
|
2706
|
+
callback as BodyResponseCallback<unknown>
|
|
2707
|
+
);
|
|
2708
|
+
} else {
|
|
2709
|
+
return createAPIRequest<Schema$AutofeedSettings>(parameters);
|
|
2710
|
+
}
|
|
2711
|
+
}
|
|
2712
|
+
}
|
|
2713
|
+
|
|
2714
|
+
export interface Params$Resource$Accounts$Autofeedsettings$Getautofeedsettings
|
|
2715
|
+
extends StandardParameters {
|
|
2716
|
+
/**
|
|
2717
|
+
* Required. The resource name of the autofeed settings. Format: `accounts/{account\}/autofeedSettings`
|
|
2718
|
+
*/
|
|
2719
|
+
name?: string;
|
|
2720
|
+
}
|
|
2721
|
+
export interface Params$Resource$Accounts$Autofeedsettings$Updateautofeedsettings
|
|
2722
|
+
extends StandardParameters {
|
|
2723
|
+
/**
|
|
2724
|
+
* Identifier. The resource name of the autofeed settings. Format: `accounts/{account\}/autofeedSettings`.
|
|
2725
|
+
*/
|
|
2726
|
+
name?: string;
|
|
2727
|
+
/**
|
|
2728
|
+
* Required. List of fields being updated.
|
|
2729
|
+
*/
|
|
2730
|
+
updateMask?: string;
|
|
2731
|
+
|
|
2732
|
+
/**
|
|
2733
|
+
* Request body metadata
|
|
2734
|
+
*/
|
|
2735
|
+
requestBody?: Schema$AutofeedSettings;
|
|
2736
|
+
}
|
|
2145
2737
|
|
|
2146
2738
|
export class Resource$Accounts$Businessidentity {
|
|
2147
2739
|
context: APIRequestContext;
|
|
@@ -2346,7 +2938,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
2346
2938
|
*/
|
|
2347
2939
|
name?: string;
|
|
2348
2940
|
/**
|
|
2349
|
-
*
|
|
2941
|
+
* Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `black_owned` - `latino_owned` - `promotions_consent` - `small_business` - `veteran_owned` - `women_owned`
|
|
2350
2942
|
*/
|
|
2351
2943
|
updateMask?: string;
|
|
2352
2944
|
|
|
@@ -2555,7 +3147,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
2555
3147
|
*/
|
|
2556
3148
|
name?: string;
|
|
2557
3149
|
/**
|
|
2558
|
-
*
|
|
3150
|
+
* Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `address` - `customer_service` - `korean_business_registration_number`
|
|
2559
3151
|
*/
|
|
2560
3152
|
updateMask?: string;
|
|
2561
3153
|
|
|
@@ -2572,7 +3164,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
2572
3164
|
}
|
|
2573
3165
|
|
|
2574
3166
|
/**
|
|
2575
|
-
* Returns the email preferences for a Merchant Center account user. Use the name=accounts/x/users/me/emailPreferences alias to get preferences for the authenticated user.
|
|
3167
|
+
* Returns the email preferences for a Merchant Center account user. This service only permits retrieving and updating email preferences for the authenticated user. Use the name=accounts/x/users/me/emailPreferences alias to get preferences for the authenticated user.
|
|
2576
3168
|
*
|
|
2577
3169
|
* @param params - Parameters for request
|
|
2578
3170
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -2768,7 +3360,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
2768
3360
|
*/
|
|
2769
3361
|
name?: string;
|
|
2770
3362
|
/**
|
|
2771
|
-
* Required. List of fields being updated.
|
|
3363
|
+
* Required. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `news_and_tips`
|
|
2772
3364
|
*/
|
|
2773
3365
|
updateMask?: string;
|
|
2774
3366
|
|
|
@@ -3175,7 +3767,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
3175
3767
|
*/
|
|
3176
3768
|
name?: string;
|
|
3177
3769
|
/**
|
|
3178
|
-
*
|
|
3770
|
+
* Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `uri`
|
|
3179
3771
|
*/
|
|
3180
3772
|
updateMask?: string;
|
|
3181
3773
|
|
|
@@ -3306,13 +3898,9 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
3306
3898
|
*/
|
|
3307
3899
|
parent?: string;
|
|
3308
3900
|
/**
|
|
3309
|
-
* IANA
|
|
3310
|
-
*/
|
|
3311
|
-
'timeZone.id'?: string;
|
|
3312
|
-
/**
|
|
3313
|
-
* Optional. IANA Time Zone Database version number, e.g. "2019a".
|
|
3901
|
+
* Optional. The [IANA](https://www.iana.org/time-zones) timezone used to localize times in human-readable fields. For example 'America/Los_Angeles'. If not set, 'America/Los_Angeles' will be used.
|
|
3314
3902
|
*/
|
|
3315
|
-
|
|
3903
|
+
timeZone?: string;
|
|
3316
3904
|
}
|
|
3317
3905
|
|
|
3318
3906
|
export class Resource$Accounts$Onlinereturnpolicies {
|
|
@@ -3322,7 +3910,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
3322
3910
|
}
|
|
3323
3911
|
|
|
3324
3912
|
/**
|
|
3325
|
-
* Gets an existing return policy.
|
|
3913
|
+
* Gets an existing return policy for a given merchant.
|
|
3326
3914
|
*
|
|
3327
3915
|
* @param params - Parameters for request
|
|
3328
3916
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -3413,7 +4001,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
3413
4001
|
}
|
|
3414
4002
|
|
|
3415
4003
|
/**
|
|
3416
|
-
* Lists all existing return policies.
|
|
4004
|
+
* Lists all existing return policies for a given merchant.
|
|
3417
4005
|
*
|
|
3418
4006
|
* @param params - Parameters for request
|
|
3419
4007
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -4973,7 +5561,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
4973
5561
|
}
|
|
4974
5562
|
|
|
4975
5563
|
/**
|
|
4976
|
-
* Deletes a Merchant Center account user. Executing this method requires admin access.
|
|
5564
|
+
* Deletes a Merchant Center account user. Executing this method requires admin access. The user to be deleted can't be the last admin user of that account. Also a user is protected from deletion if it is managed by Business Manager"
|
|
4977
5565
|
*
|
|
4978
5566
|
* @param params - Parameters for request
|
|
4979
5567
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -5380,7 +5968,7 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
5380
5968
|
*/
|
|
5381
5969
|
name?: string;
|
|
5382
5970
|
/**
|
|
5383
|
-
*
|
|
5971
|
+
* Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `access_rights`
|
|
5384
5972
|
*/
|
|
5385
5973
|
updateMask?: string;
|
|
5386
5974
|
|
|
@@ -5685,11 +6273,11 @@ export namespace merchantapi_accounts_v1beta {
|
|
|
5685
6273
|
export interface Params$Resource$Termsofservice$Retrievelatest
|
|
5686
6274
|
extends StandardParameters {
|
|
5687
6275
|
/**
|
|
5688
|
-
* The Kind this terms of service version applies to.
|
|
6276
|
+
* Required. The Kind this terms of service version applies to.
|
|
5689
6277
|
*/
|
|
5690
6278
|
kind?: string;
|
|
5691
6279
|
/**
|
|
5692
|
-
* Region code as defined by [CLDR](https://cldr.unicode.org/). This is either a country when the ToS applies specifically to that country or 001 when it applies globally.
|
|
6280
|
+
* Required. Region code as defined by [CLDR](https://cldr.unicode.org/). This is either a country when the ToS applies specifically to that country or 001 when it applies globally.
|
|
5693
6281
|
*/
|
|
5694
6282
|
regionCode?: string;
|
|
5695
6283
|
}
|