@googleapis/merchantapi 1.1.0 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/CHANGELOG.md +27 -0
  2. package/accounts_v1beta.ts +328 -73
  3. package/build/accounts_v1beta.d.ts +162 -71
  4. package/build/accounts_v1beta.js +74 -1
  5. package/build/accounts_v1beta.js.map +1 -1
  6. package/build/conversions_v1beta.d.ts +6 -5
  7. package/build/conversions_v1beta.js.map +1 -1
  8. package/build/datasources_v1beta.d.ts +160 -13
  9. package/build/datasources_v1beta.js +39 -0
  10. package/build/datasources_v1beta.js.map +1 -1
  11. package/build/index.d.ts +5 -0
  12. package/build/index.js +4 -1
  13. package/build/index.js.map +1 -1
  14. package/build/inventories_v1beta.d.ts +4 -0
  15. package/build/inventories_v1beta.js.map +1 -1
  16. package/build/lfp_v1beta.d.ts +4 -0
  17. package/build/lfp_v1beta.js.map +1 -1
  18. package/build/notifications_v1beta.d.ts +5 -1
  19. package/build/notifications_v1beta.js.map +1 -1
  20. package/build/products_v1beta.d.ts +39 -10
  21. package/build/products_v1beta.js.map +1 -1
  22. package/build/promotions_v1beta.d.ts +5 -1
  23. package/build/promotions_v1beta.js.map +1 -1
  24. package/build/quota_v1beta.d.ts +5 -1
  25. package/build/quota_v1beta.js.map +1 -1
  26. package/build/reports_v1beta.d.ts +4 -0
  27. package/build/reports_v1beta.js.map +1 -1
  28. package/build/reviews_v1beta.d.ts +782 -0
  29. package/build/reviews_v1beta.js +322 -0
  30. package/build/reviews_v1beta.js.map +1 -0
  31. package/conversions_v1beta.ts +6 -5
  32. package/datasources_v1beta.ts +240 -13
  33. package/index.ts +13 -1
  34. package/inventories_v1beta.ts +4 -0
  35. package/lfp_v1beta.ts +4 -0
  36. package/notifications_v1beta.ts +5 -1
  37. package/package.json +1 -1
  38. package/products_v1beta.ts +39 -10
  39. package/promotions_v1beta.ts +5 -1
  40. package/quota_v1beta.ts +5 -1
  41. package/reports_v1beta.ts +4 -0
  42. package/reviews_v1beta.ts +1461 -0
@@ -144,20 +144,7 @@ export namespace merchantapi_accounts_v1beta {
144
144
  validUntil?: Schema$Date;
145
145
  }
146
146
  /**
147
- * Reference to a Terms of Service resource.
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
  /**
@@ -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$Empty;
219
+ accountAggregation?: Schema$AccountAggregation;
229
220
  /**
230
- * Optional. The provider of the service. Format: `accounts/{account\}`
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,23 @@ export namespace merchantapi_accounts_v1beta {
256
247
  */
257
248
  streetAddress?: string | null;
258
249
  }
250
+ /**
251
+ * Collection of information related to the [autofeed](https://support.google.com/merchants/answer/7538732) settings.
252
+ */
253
+ export interface Schema$AutofeedSettings {
254
+ /**
255
+ * Output only. Determines whether merchant is eligible for being enrolled into an autofeed.
256
+ */
257
+ eligible?: boolean | null;
258
+ /**
259
+ * 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.
260
+ */
261
+ enableProducts?: boolean | null;
262
+ /**
263
+ * Identifier. The resource name of the autofeed settings. Format: `accounts/{account\}/autofeedSettings`.
264
+ */
265
+ name?: string | null;
266
+ }
259
267
  /**
260
268
  * Business days of the warehouse.
261
269
  */
@@ -282,7 +290,7 @@ export namespace merchantapi_accounts_v1beta {
282
290
  */
283
291
  name?: string | null;
284
292
  /**
285
- * Optional. Whether the identity attributes may be used for promotions.
293
+ * Required. Whether the identity attributes may be used for promotions.
286
294
  */
287
295
  promotionsConsent?: string | null;
288
296
  /**
@@ -299,11 +307,11 @@ export namespace merchantapi_accounts_v1beta {
299
307
  womenOwned?: Schema$IdentityAttribute;
300
308
  }
301
309
  /**
302
- * Collection of information related to a business.
310
+ * 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
311
  */
304
312
  export interface Schema$BusinessInfo {
305
313
  /**
306
- * Optional. The address of the business.
314
+ * 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
315
  */
308
316
  address?: Schema$PostalAddress;
309
317
  /**
@@ -328,7 +336,7 @@ export namespace merchantapi_accounts_v1beta {
328
336
  phoneVerificationState?: string | null;
329
337
  }
330
338
  /**
331
- * A list of carrier rates that can be referred to by `main_table` or `single_value`.
339
+ * 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
340
  */
333
341
  export interface Schema$CarrierRate {
334
342
  /**
@@ -359,21 +367,22 @@ export namespace merchantapi_accounts_v1beta {
359
367
  /**
360
368
  * Request message for the `ClaimHomepage` method.
361
369
  */
362
- export interface Schema$ClaimHomepageRequest {}
370
+ export interface Schema$ClaimHomepageRequest {
371
+ /**
372
+ * 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.
373
+ */
374
+ overwrite?: boolean | null;
375
+ }
363
376
  /**
364
377
  * Request message for the `CreateAndConfigureAccount` method.
365
378
  */
366
379
  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
380
  /**
372
381
  * Required. The account to be created.
373
382
  */
374
383
  account?: Schema$Account;
375
384
  /**
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 only `account_aggregation` is supported which means the newly created account will be a subaccount of the provider defined in the `account_aggregation` service.
385
+ * 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
386
  */
378
387
  service?: Schema$AddAccountService[];
379
388
  /**
@@ -390,7 +399,7 @@ export namespace merchantapi_accounts_v1beta {
390
399
  */
391
400
  parent?: string | null;
392
401
  /**
393
- * Required. The user to create.
402
+ * Optional. The user to create.
394
403
  */
395
404
  user?: Schema$User;
396
405
  /**
@@ -479,7 +488,7 @@ export namespace merchantapi_accounts_v1beta {
479
488
  */
480
489
  handlingBusinessDayConfig?: Schema$BusinessDayConfig;
481
490
  /**
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`.
491
+ * 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
492
  */
484
493
  maxHandlingDays?: number | null;
485
494
  /**
@@ -487,7 +496,7 @@ export namespace merchantapi_accounts_v1beta {
487
496
  */
488
497
  maxTransitDays?: number | null;
489
498
  /**
490
- * Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped.
499
+ * 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
500
  */
492
501
  minHandlingDays?: number | null;
493
502
  /**
@@ -580,7 +589,7 @@ export namespace merchantapi_accounts_v1beta {
580
589
  weights?: Schema$Weight[];
581
590
  }
582
591
  /**
583
- * A store's homepage.
592
+ * 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
593
  */
585
594
  export interface Schema$Homepage {
586
595
  /**
@@ -788,7 +797,7 @@ export namespace merchantapi_accounts_v1beta {
788
797
  */
789
798
  acceptExchange?: boolean | null;
790
799
  /**
791
- * The countries of sale where the return policy applies. The values must be a valid 2 letter ISO 3166 code.
800
+ * Required. Immutable. The countries of sale where the return policy applies. The values must be a valid 2 letter ISO 3166 code.
792
801
  */
793
802
  countries?: string[] | null;
794
803
  /**
@@ -796,7 +805,7 @@ export namespace merchantapi_accounts_v1beta {
796
805
  */
797
806
  itemConditions?: string[] | null;
798
807
  /**
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.
808
+ * 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
809
  */
801
810
  label?: string | null;
802
811
  /**
@@ -824,20 +833,24 @@ export namespace merchantapi_accounts_v1beta {
824
833
  */
825
834
  returnPolicyId?: string | null;
826
835
  /**
827
- * The return policy uri. This can used by Google to do a sanity check for the policy. It must be a valid URL.
836
+ * 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
837
  */
829
838
  returnPolicyUri?: string | null;
830
839
  /**
831
840
  * The return shipping fee. Should be set only when customer need to download and print the return label.
832
841
  */
833
842
  returnShippingFee?: Schema$ReturnShippingFee;
843
+ /**
844
+ * Optional. Overrides to the general policy for orders placed during a specific set of time intervals.
845
+ */
846
+ seasonalOverrides?: Schema$SeasonalOverride[];
834
847
  }
835
848
  /**
836
849
  * 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
850
  */
838
851
  export interface Schema$PhoneNumber {
839
852
  /**
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, e.g.: - 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
853
+ * 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
854
  */
842
855
  e164Number?: string | null;
843
856
  /**
@@ -863,15 +876,15 @@ export namespace merchantapi_accounts_v1beta {
863
876
  type?: string | null;
864
877
  }
865
878
  /**
866
- * Represents a postal address, e.g. 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 via 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, please see: https://support.google.com/business/answer/6397478
879
+ * 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
880
  */
868
881
  export interface Schema$PostalAddress {
869
882
  /**
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 (e.g. "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 (e.g. Japan), address_language is used to make it explicit (e.g. "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).
883
+ * 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
884
  */
872
885
  addressLines?: string[] | null;
873
886
  /**
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 (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
887
+ * 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
888
  */
876
889
  administrativeArea?: string | null;
877
890
  /**
@@ -887,7 +900,7 @@ export namespace merchantapi_accounts_v1beta {
887
900
  */
888
901
  organization?: string | null;
889
902
  /**
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 (e.g. state/zip validation in the U.S.A.).
903
+ * 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
904
  */
892
905
  postalCode?: string | null;
893
906
  /**
@@ -903,7 +916,7 @@ export namespace merchantapi_accounts_v1beta {
903
916
  */
904
917
  revision?: number | null;
905
918
  /**
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 (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
919
+ * 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
920
  */
908
921
  sortingCode?: string | null;
909
922
  /**
@@ -987,6 +1000,10 @@ export namespace merchantapi_accounts_v1beta {
987
1000
  * A message to describe the change that happened to the product
988
1001
  */
989
1002
  changes?: Schema$ProductChange[];
1003
+ /**
1004
+ * The product expiration time. This field will not bet set if the notification is sent for a product deletion event.
1005
+ */
1006
+ expirationTime?: string | null;
990
1007
  /**
991
1008
  * 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
1009
  */
@@ -1139,7 +1156,7 @@ export namespace merchantapi_accounts_v1beta {
1139
1156
  */
1140
1157
  fixedFee?: Schema$Price;
1141
1158
  /**
1142
- * Type of return shipping fee.
1159
+ * Required. Type of return shipping fee.
1143
1160
  */
1144
1161
  type?: string | null;
1145
1162
  }
@@ -1152,6 +1169,27 @@ export namespace merchantapi_accounts_v1beta {
1152
1169
  */
1153
1170
  cells?: Schema$Value[];
1154
1171
  }
1172
+ /**
1173
+ * Next: 5
1174
+ */
1175
+ 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
+ /**
1181
+ * Required. seasonal override end date (inclusive).
1182
+ */
1183
+ end?: Schema$Date;
1184
+ /**
1185
+ * Required. Display name of this seasonal override in Merchant Center.
1186
+ */
1187
+ label?: string | null;
1188
+ /**
1189
+ * Required. The return policy for the given date range.
1190
+ */
1191
+ policy?: Schema$Policy;
1192
+ }
1155
1193
  /**
1156
1194
  * Shipping service.
1157
1195
  */
@@ -1202,7 +1240,7 @@ export namespace merchantapi_accounts_v1beta {
1202
1240
  storeConfig?: Schema$StoreConfig;
1203
1241
  }
1204
1242
  /**
1205
- * The merchant account's [shipping setting]((https://support.google.com/merchants/answer/6069284).
1243
+ * The merchant account's [shipping setting](https://support.google.com/merchants/answer/6069284).
1206
1244
  */
1207
1245
  export interface Schema$ShippingSettings {
1208
1246
  /**
@@ -1223,11 +1261,11 @@ export namespace merchantapi_accounts_v1beta {
1223
1261
  warehouses?: Schema$Warehouse[];
1224
1262
  }
1225
1263
  /**
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 (e.g. "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 (e.g. US and CA).
1264
+ * 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
1265
  */
1228
1266
  export interface Schema$ShortCode {
1229
1267
  /**
1230
- * Required. The short code digits, without a leading plus ('+') or country calling code, e.g. "611".
1268
+ * Required. The short code digits, without a leading plus ('+') or country calling code. For example "611".
1231
1269
  */
1232
1270
  number?: string | null;
1233
1271
  /**
@@ -1291,7 +1329,7 @@ export namespace merchantapi_accounts_v1beta {
1291
1329
  rows?: Schema$Row[];
1292
1330
  }
1293
1331
  /**
1294
- * A `TermsOfService`.
1332
+ * 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
1333
  */
1296
1334
  export interface Schema$TermsOfService {
1297
1335
  /**
@@ -1345,11 +1383,11 @@ export namespace merchantapi_accounts_v1beta {
1345
1383
  */
1346
1384
  export interface Schema$TimeZone {
1347
1385
  /**
1348
- * IANA Time Zone Database time zone, e.g. "America/New_York".
1386
+ * IANA Time Zone Database time zone. For example "America/New_York".
1349
1387
  */
1350
1388
  id?: string | null;
1351
1389
  /**
1352
- * Optional. IANA Time Zone Database version number, e.g. "2019a".
1390
+ * Optional. IANA Time Zone Database version number. For example "2019a".
1353
1391
  */
1354
1392
  version?: string | null;
1355
1393
  }
@@ -1397,7 +1435,7 @@ export namespace merchantapi_accounts_v1beta {
1397
1435
  */
1398
1436
  export interface Schema$UnclaimHomepageRequest {}
1399
1437
  /**
1400
- * A [user](https://support.google.com/merchants/answer/12160472).
1438
+ * 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
1439
  */
1402
1440
  export interface Schema$User {
1403
1441
  /**
@@ -1439,7 +1477,7 @@ export namespace merchantapi_accounts_v1beta {
1439
1477
  subtable?: string | null;
1440
1478
  }
1441
1479
  /**
1442
- * A fulfillment warehouse, which stores and handles inventory. Next tag: 7
1480
+ * A fulfillment warehouse, which stores and handles inventory.
1443
1481
  */
1444
1482
  export interface Schema$Warehouse {
1445
1483
  /**
@@ -1468,7 +1506,7 @@ export namespace merchantapi_accounts_v1beta {
1468
1506
  */
1469
1507
  export interface Schema$WarehouseBasedDeliveryTime {
1470
1508
  /**
1471
- * Required. Carrier, such as `"UPS"` or `"Fedex"`.
1509
+ * 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
1510
  */
1473
1511
  carrier?: string | null;
1474
1512
  /**
@@ -1509,9 +1547,10 @@ export namespace merchantapi_accounts_v1beta {
1509
1547
 
1510
1548
  export class Resource$Accounts {
1511
1549
  context: APIRequestContext;
1550
+ autofeedSettings: Resource$Accounts$Autofeedsettings;
1512
1551
  businessIdentity: Resource$Accounts$Businessidentity;
1513
1552
  businessInfo: Resource$Accounts$Businessinfo;
1514
- emailpreferences: Resource$Accounts$Emailpreferences;
1553
+ emailPreferences: Resource$Accounts$Emailpreferences;
1515
1554
  homepage: Resource$Accounts$Homepage;
1516
1555
  issues: Resource$Accounts$Issues;
1517
1556
  onlineReturnPolicies: Resource$Accounts$Onlinereturnpolicies;
@@ -1522,11 +1561,14 @@ export namespace merchantapi_accounts_v1beta {
1522
1561
  users: Resource$Accounts$Users;
1523
1562
  constructor(context: APIRequestContext) {
1524
1563
  this.context = context;
1564
+ this.autofeedSettings = new Resource$Accounts$Autofeedsettings(
1565
+ this.context
1566
+ );
1525
1567
  this.businessIdentity = new Resource$Accounts$Businessidentity(
1526
1568
  this.context
1527
1569
  );
1528
1570
  this.businessInfo = new Resource$Accounts$Businessinfo(this.context);
1529
- this.emailpreferences = new Resource$Accounts$Emailpreferences(
1571
+ this.emailPreferences = new Resource$Accounts$Emailpreferences(
1530
1572
  this.context
1531
1573
  );
1532
1574
  this.homepage = new Resource$Accounts$Homepage(this.context);
@@ -1632,7 +1674,7 @@ export namespace merchantapi_accounts_v1beta {
1632
1674
  }
1633
1675
 
1634
1676
  /**
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.
1677
+ * 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
1678
  *
1637
1679
  * @param params - Parameters for request
1638
1680
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1806,7 +1848,7 @@ export namespace merchantapi_accounts_v1beta {
1806
1848
  }
1807
1849
 
1808
1850
  /**
1809
- * 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.
1851
+ * 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 accounts the user is directly added to.
1810
1852
  *
1811
1853
  * @param params - Parameters for request
1812
1854
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2087,6 +2129,10 @@ export namespace merchantapi_accounts_v1beta {
2087
2129
  requestBody?: Schema$CreateAndConfigureAccountRequest;
2088
2130
  }
2089
2131
  export interface Params$Resource$Accounts$Delete extends StandardParameters {
2132
+ /**
2133
+ * Optional. If set to `true`, the account is deleted even if it provides services to other accounts or has processed offers.
2134
+ */
2135
+ force?: boolean;
2090
2136
  /**
2091
2137
  * Required. The name of the account to delete. Format: `accounts/{account\}`
2092
2138
  */
@@ -2123,7 +2169,7 @@ export namespace merchantapi_accounts_v1beta {
2123
2169
  */
2124
2170
  pageToken?: string;
2125
2171
  /**
2126
- * Required. The parent account. Format: `accounts/{account\}`
2172
+ * Required. The aggregation service provider. Format: `providers/{providerId\}`
2127
2173
  */
2128
2174
  provider?: string;
2129
2175
  }
@@ -2133,7 +2179,7 @@ export namespace merchantapi_accounts_v1beta {
2133
2179
  */
2134
2180
  name?: string;
2135
2181
  /**
2136
- * Required. List of fields being updated.
2182
+ * 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
2183
  */
2138
2184
  updateMask?: string;
2139
2185
 
@@ -2143,6 +2189,219 @@ export namespace merchantapi_accounts_v1beta {
2143
2189
  requestBody?: Schema$Account;
2144
2190
  }
2145
2191
 
2192
+ export class Resource$Accounts$Autofeedsettings {
2193
+ context: APIRequestContext;
2194
+ constructor(context: APIRequestContext) {
2195
+ this.context = context;
2196
+ }
2197
+
2198
+ /**
2199
+ * Retrieves the autofeed settings of an account.
2200
+ *
2201
+ * @param params - Parameters for request
2202
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
2203
+ * @param callback - Optional callback that handles the response.
2204
+ * @returns A promise if used with async/await, or void if used with a callback.
2205
+ */
2206
+ getAutofeedSettings(
2207
+ params: Params$Resource$Accounts$Autofeedsettings$Getautofeedsettings,
2208
+ options: StreamMethodOptions
2209
+ ): GaxiosPromise<Readable>;
2210
+ getAutofeedSettings(
2211
+ params?: Params$Resource$Accounts$Autofeedsettings$Getautofeedsettings,
2212
+ options?: MethodOptions
2213
+ ): GaxiosPromise<Schema$AutofeedSettings>;
2214
+ getAutofeedSettings(
2215
+ params: Params$Resource$Accounts$Autofeedsettings$Getautofeedsettings,
2216
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
2217
+ callback: BodyResponseCallback<Readable>
2218
+ ): void;
2219
+ getAutofeedSettings(
2220
+ params: Params$Resource$Accounts$Autofeedsettings$Getautofeedsettings,
2221
+ options: MethodOptions | BodyResponseCallback<Schema$AutofeedSettings>,
2222
+ callback: BodyResponseCallback<Schema$AutofeedSettings>
2223
+ ): void;
2224
+ getAutofeedSettings(
2225
+ params: Params$Resource$Accounts$Autofeedsettings$Getautofeedsettings,
2226
+ callback: BodyResponseCallback<Schema$AutofeedSettings>
2227
+ ): void;
2228
+ getAutofeedSettings(
2229
+ callback: BodyResponseCallback<Schema$AutofeedSettings>
2230
+ ): void;
2231
+ getAutofeedSettings(
2232
+ paramsOrCallback?:
2233
+ | Params$Resource$Accounts$Autofeedsettings$Getautofeedsettings
2234
+ | BodyResponseCallback<Schema$AutofeedSettings>
2235
+ | BodyResponseCallback<Readable>,
2236
+ optionsOrCallback?:
2237
+ | MethodOptions
2238
+ | StreamMethodOptions
2239
+ | BodyResponseCallback<Schema$AutofeedSettings>
2240
+ | BodyResponseCallback<Readable>,
2241
+ callback?:
2242
+ | BodyResponseCallback<Schema$AutofeedSettings>
2243
+ | BodyResponseCallback<Readable>
2244
+ ): void | GaxiosPromise<Schema$AutofeedSettings> | GaxiosPromise<Readable> {
2245
+ let params = (paramsOrCallback ||
2246
+ {}) as Params$Resource$Accounts$Autofeedsettings$Getautofeedsettings;
2247
+ let options = (optionsOrCallback || {}) as MethodOptions;
2248
+
2249
+ if (typeof paramsOrCallback === 'function') {
2250
+ callback = paramsOrCallback;
2251
+ params =
2252
+ {} as Params$Resource$Accounts$Autofeedsettings$Getautofeedsettings;
2253
+ options = {};
2254
+ }
2255
+
2256
+ if (typeof optionsOrCallback === 'function') {
2257
+ callback = optionsOrCallback;
2258
+ options = {};
2259
+ }
2260
+
2261
+ const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/';
2262
+ const parameters = {
2263
+ options: Object.assign(
2264
+ {
2265
+ url: (rootUrl + '/accounts/v1beta/{+name}').replace(
2266
+ /([^:]\/)\/+/g,
2267
+ '$1'
2268
+ ),
2269
+ method: 'GET',
2270
+ apiVersion: '',
2271
+ },
2272
+ options
2273
+ ),
2274
+ params,
2275
+ requiredParams: ['name'],
2276
+ pathParams: ['name'],
2277
+ context: this.context,
2278
+ };
2279
+ if (callback) {
2280
+ createAPIRequest<Schema$AutofeedSettings>(
2281
+ parameters,
2282
+ callback as BodyResponseCallback<unknown>
2283
+ );
2284
+ } else {
2285
+ return createAPIRequest<Schema$AutofeedSettings>(parameters);
2286
+ }
2287
+ }
2288
+
2289
+ /**
2290
+ * Updates the autofeed settings of an account.
2291
+ *
2292
+ * @param params - Parameters for request
2293
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
2294
+ * @param callback - Optional callback that handles the response.
2295
+ * @returns A promise if used with async/await, or void if used with a callback.
2296
+ */
2297
+ updateAutofeedSettings(
2298
+ params: Params$Resource$Accounts$Autofeedsettings$Updateautofeedsettings,
2299
+ options: StreamMethodOptions
2300
+ ): GaxiosPromise<Readable>;
2301
+ updateAutofeedSettings(
2302
+ params?: Params$Resource$Accounts$Autofeedsettings$Updateautofeedsettings,
2303
+ options?: MethodOptions
2304
+ ): GaxiosPromise<Schema$AutofeedSettings>;
2305
+ updateAutofeedSettings(
2306
+ params: Params$Resource$Accounts$Autofeedsettings$Updateautofeedsettings,
2307
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
2308
+ callback: BodyResponseCallback<Readable>
2309
+ ): void;
2310
+ updateAutofeedSettings(
2311
+ params: Params$Resource$Accounts$Autofeedsettings$Updateautofeedsettings,
2312
+ options: MethodOptions | BodyResponseCallback<Schema$AutofeedSettings>,
2313
+ callback: BodyResponseCallback<Schema$AutofeedSettings>
2314
+ ): void;
2315
+ updateAutofeedSettings(
2316
+ params: Params$Resource$Accounts$Autofeedsettings$Updateautofeedsettings,
2317
+ callback: BodyResponseCallback<Schema$AutofeedSettings>
2318
+ ): void;
2319
+ updateAutofeedSettings(
2320
+ callback: BodyResponseCallback<Schema$AutofeedSettings>
2321
+ ): void;
2322
+ updateAutofeedSettings(
2323
+ paramsOrCallback?:
2324
+ | Params$Resource$Accounts$Autofeedsettings$Updateautofeedsettings
2325
+ | BodyResponseCallback<Schema$AutofeedSettings>
2326
+ | BodyResponseCallback<Readable>,
2327
+ optionsOrCallback?:
2328
+ | MethodOptions
2329
+ | StreamMethodOptions
2330
+ | BodyResponseCallback<Schema$AutofeedSettings>
2331
+ | BodyResponseCallback<Readable>,
2332
+ callback?:
2333
+ | BodyResponseCallback<Schema$AutofeedSettings>
2334
+ | BodyResponseCallback<Readable>
2335
+ ): void | GaxiosPromise<Schema$AutofeedSettings> | GaxiosPromise<Readable> {
2336
+ let params = (paramsOrCallback ||
2337
+ {}) as Params$Resource$Accounts$Autofeedsettings$Updateautofeedsettings;
2338
+ let options = (optionsOrCallback || {}) as MethodOptions;
2339
+
2340
+ if (typeof paramsOrCallback === 'function') {
2341
+ callback = paramsOrCallback;
2342
+ params =
2343
+ {} as Params$Resource$Accounts$Autofeedsettings$Updateautofeedsettings;
2344
+ options = {};
2345
+ }
2346
+
2347
+ if (typeof optionsOrCallback === 'function') {
2348
+ callback = optionsOrCallback;
2349
+ options = {};
2350
+ }
2351
+
2352
+ const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/';
2353
+ const parameters = {
2354
+ options: Object.assign(
2355
+ {
2356
+ url: (rootUrl + '/accounts/v1beta/{+name}').replace(
2357
+ /([^:]\/)\/+/g,
2358
+ '$1'
2359
+ ),
2360
+ method: 'PATCH',
2361
+ apiVersion: '',
2362
+ },
2363
+ options
2364
+ ),
2365
+ params,
2366
+ requiredParams: ['name'],
2367
+ pathParams: ['name'],
2368
+ context: this.context,
2369
+ };
2370
+ if (callback) {
2371
+ createAPIRequest<Schema$AutofeedSettings>(
2372
+ parameters,
2373
+ callback as BodyResponseCallback<unknown>
2374
+ );
2375
+ } else {
2376
+ return createAPIRequest<Schema$AutofeedSettings>(parameters);
2377
+ }
2378
+ }
2379
+ }
2380
+
2381
+ export interface Params$Resource$Accounts$Autofeedsettings$Getautofeedsettings
2382
+ extends StandardParameters {
2383
+ /**
2384
+ * Required. The resource name of the autofeed settings. Format: `accounts/{account\}/autofeedSettings`
2385
+ */
2386
+ name?: string;
2387
+ }
2388
+ export interface Params$Resource$Accounts$Autofeedsettings$Updateautofeedsettings
2389
+ extends StandardParameters {
2390
+ /**
2391
+ * Identifier. The resource name of the autofeed settings. Format: `accounts/{account\}/autofeedSettings`.
2392
+ */
2393
+ name?: string;
2394
+ /**
2395
+ * Required. List of fields being updated.
2396
+ */
2397
+ updateMask?: string;
2398
+
2399
+ /**
2400
+ * Request body metadata
2401
+ */
2402
+ requestBody?: Schema$AutofeedSettings;
2403
+ }
2404
+
2146
2405
  export class Resource$Accounts$Businessidentity {
2147
2406
  context: APIRequestContext;
2148
2407
  constructor(context: APIRequestContext) {
@@ -2346,7 +2605,7 @@ export namespace merchantapi_accounts_v1beta {
2346
2605
  */
2347
2606
  name?: string;
2348
2607
  /**
2349
- * Required. List of fields being updated.
2608
+ * 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
2609
  */
2351
2610
  updateMask?: string;
2352
2611
 
@@ -2555,7 +2814,7 @@ export namespace merchantapi_accounts_v1beta {
2555
2814
  */
2556
2815
  name?: string;
2557
2816
  /**
2558
- * Required. List of fields being updated.
2817
+ * 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
2818
  */
2560
2819
  updateMask?: string;
2561
2820
 
@@ -2572,7 +2831,7 @@ export namespace merchantapi_accounts_v1beta {
2572
2831
  }
2573
2832
 
2574
2833
  /**
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.
2834
+ * 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
2835
  *
2577
2836
  * @param params - Parameters for request
2578
2837
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2768,7 +3027,7 @@ export namespace merchantapi_accounts_v1beta {
2768
3027
  */
2769
3028
  name?: string;
2770
3029
  /**
2771
- * Required. List of fields being updated.
3030
+ * Required. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `news_and_tips`
2772
3031
  */
2773
3032
  updateMask?: string;
2774
3033
 
@@ -3175,7 +3434,7 @@ export namespace merchantapi_accounts_v1beta {
3175
3434
  */
3176
3435
  name?: string;
3177
3436
  /**
3178
- * Required. List of fields being updated.
3437
+ * Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `uri`
3179
3438
  */
3180
3439
  updateMask?: string;
3181
3440
 
@@ -3306,13 +3565,9 @@ export namespace merchantapi_accounts_v1beta {
3306
3565
  */
3307
3566
  parent?: string;
3308
3567
  /**
3309
- * IANA Time Zone Database time zone, e.g. "America/New_York".
3310
- */
3311
- 'timeZone.id'?: string;
3312
- /**
3313
- * Optional. IANA Time Zone Database version number, e.g. "2019a".
3568
+ * 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
3569
  */
3315
- 'timeZone.version'?: string;
3570
+ timeZone?: string;
3316
3571
  }
3317
3572
 
3318
3573
  export class Resource$Accounts$Onlinereturnpolicies {
@@ -3322,7 +3577,7 @@ export namespace merchantapi_accounts_v1beta {
3322
3577
  }
3323
3578
 
3324
3579
  /**
3325
- * Gets an existing return policy.
3580
+ * Gets an existing return policy for a given merchant.
3326
3581
  *
3327
3582
  * @param params - Parameters for request
3328
3583
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3413,7 +3668,7 @@ export namespace merchantapi_accounts_v1beta {
3413
3668
  }
3414
3669
 
3415
3670
  /**
3416
- * Lists all existing return policies.
3671
+ * Lists all existing return policies for a given merchant.
3417
3672
  *
3418
3673
  * @param params - Parameters for request
3419
3674
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4973,7 +5228,7 @@ export namespace merchantapi_accounts_v1beta {
4973
5228
  }
4974
5229
 
4975
5230
  /**
4976
- * Deletes a Merchant Center account user. Executing this method requires admin access.
5231
+ * 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
5232
  *
4978
5233
  * @param params - Parameters for request
4979
5234
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5380,7 +5635,7 @@ export namespace merchantapi_accounts_v1beta {
5380
5635
  */
5381
5636
  name?: string;
5382
5637
  /**
5383
- * Required. List of fields being updated.
5638
+ * Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `access_rights`
5384
5639
  */
5385
5640
  updateMask?: string;
5386
5641
 
@@ -5685,11 +5940,11 @@ export namespace merchantapi_accounts_v1beta {
5685
5940
  export interface Params$Resource$Termsofservice$Retrievelatest
5686
5941
  extends StandardParameters {
5687
5942
  /**
5688
- * The Kind this terms of service version applies to.
5943
+ * Required. The Kind this terms of service version applies to.
5689
5944
  */
5690
5945
  kind?: string;
5691
5946
  /**
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.
5947
+ * 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
5948
  */
5694
5949
  regionCode?: string;
5695
5950
  }