@googleapis/merchantapi 1.0.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.
- package/CHANGELOG.md +34 -0
- package/accounts_v1beta.ts +332 -73
- package/build/accounts_v1beta.d.ts +166 -71
- package/build/accounts_v1beta.js +74 -1
- package/build/accounts_v1beta.js.map +1 -1
- package/build/conversions_v1beta.d.ts +6 -5
- package/build/conversions_v1beta.js.map +1 -1
- package/build/datasources_v1beta.d.ts +160 -13
- 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 +4 -0
- package/build/inventories_v1beta.js.map +1 -1
- package/build/lfp_v1beta.d.ts +4 -0
- package/build/lfp_v1beta.js.map +1 -1
- package/build/notifications_v1beta.d.ts +5 -1
- package/build/notifications_v1beta.js.map +1 -1
- package/build/products_v1beta.d.ts +39 -10
- package/build/products_v1beta.js.map +1 -1
- package/build/promotions_v1beta.d.ts +5 -1
- package/build/promotions_v1beta.js.map +1 -1
- package/build/quota_v1beta.d.ts +5 -1
- package/build/quota_v1beta.js.map +1 -1
- package/build/reports_v1beta.d.ts +4 -0
- package/build/reports_v1beta.js.map +1 -1
- package/build/reviews_v1beta.d.ts +782 -0
- package/build/reviews_v1beta.js +322 -0
- package/build/reviews_v1beta.js.map +1 -0
- package/conversions_v1beta.ts +6 -5
- package/datasources_v1beta.ts +240 -13
- package/index.ts +13 -1
- package/inventories_v1beta.ts +4 -0
- package/lfp_v1beta.ts +4 -0
- package/notifications_v1beta.ts +5 -1
- package/package.json +1 -1
- package/products_v1beta.ts +39 -10
- package/promotions_v1beta.ts +5 -1
- package/quota_v1beta.ts +5 -1
- package/reports_v1beta.ts +4 -0
- package/reviews_v1beta.ts +1461 -0
|
@@ -90,20 +90,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
90
90
|
validUntil?: Schema$Date;
|
|
91
91
|
}
|
|
92
92
|
/**
|
|
93
|
-
*
|
|
94
|
-
*/
|
|
95
|
-
export interface Schema$AcceptTermsOfService {
|
|
96
|
-
/**
|
|
97
|
-
* Required. The resource name of the terms of service version.
|
|
98
|
-
*/
|
|
99
|
-
name?: string | null;
|
|
100
|
-
/**
|
|
101
|
-
* 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.
|
|
102
|
-
*/
|
|
103
|
-
regionCode?: string | null;
|
|
104
|
-
}
|
|
105
|
-
/**
|
|
106
|
-
* An account.
|
|
93
|
+
* 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.
|
|
107
94
|
*/
|
|
108
95
|
export interface Schema$Account {
|
|
109
96
|
/**
|
|
@@ -135,6 +122,11 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
135
122
|
*/
|
|
136
123
|
timeZone?: Schema$TimeZone;
|
|
137
124
|
}
|
|
125
|
+
/**
|
|
126
|
+
* `AccountAggregation` payload.
|
|
127
|
+
*/
|
|
128
|
+
export interface Schema$AccountAggregation {
|
|
129
|
+
}
|
|
138
130
|
/**
|
|
139
131
|
* An [`AccountIssue`](https://support.google.com/merchants/answer/12153802?sjid=17798438912526418908-EU#account).
|
|
140
132
|
*/
|
|
@@ -169,11 +161,11 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
169
161
|
*/
|
|
170
162
|
export interface Schema$AddAccountService {
|
|
171
163
|
/**
|
|
172
|
-
* The provider is an aggregator for the account.
|
|
164
|
+
* The provider is an [aggregator](https://support.google.com/merchants/answer/188487) for the account. Payload for service type Account Aggregation.
|
|
173
165
|
*/
|
|
174
|
-
accountAggregation?: Schema$
|
|
166
|
+
accountAggregation?: Schema$AccountAggregation;
|
|
175
167
|
/**
|
|
176
|
-
*
|
|
168
|
+
* 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`).
|
|
177
169
|
*/
|
|
178
170
|
provider?: string | null;
|
|
179
171
|
}
|
|
@@ -202,6 +194,23 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
202
194
|
*/
|
|
203
195
|
streetAddress?: string | null;
|
|
204
196
|
}
|
|
197
|
+
/**
|
|
198
|
+
* Collection of information related to the [autofeed](https://support.google.com/merchants/answer/7538732) settings.
|
|
199
|
+
*/
|
|
200
|
+
export interface Schema$AutofeedSettings {
|
|
201
|
+
/**
|
|
202
|
+
* Output only. Determines whether merchant is eligible for being enrolled into an autofeed.
|
|
203
|
+
*/
|
|
204
|
+
eligible?: boolean | null;
|
|
205
|
+
/**
|
|
206
|
+
* 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.
|
|
207
|
+
*/
|
|
208
|
+
enableProducts?: boolean | null;
|
|
209
|
+
/**
|
|
210
|
+
* Identifier. The resource name of the autofeed settings. Format: `accounts/{account\}/autofeedSettings`.
|
|
211
|
+
*/
|
|
212
|
+
name?: string | null;
|
|
213
|
+
}
|
|
205
214
|
/**
|
|
206
215
|
* Business days of the warehouse.
|
|
207
216
|
*/
|
|
@@ -228,7 +237,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
228
237
|
*/
|
|
229
238
|
name?: string | null;
|
|
230
239
|
/**
|
|
231
|
-
*
|
|
240
|
+
* Required. Whether the identity attributes may be used for promotions.
|
|
232
241
|
*/
|
|
233
242
|
promotionsConsent?: string | null;
|
|
234
243
|
/**
|
|
@@ -245,17 +254,21 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
245
254
|
womenOwned?: Schema$IdentityAttribute;
|
|
246
255
|
}
|
|
247
256
|
/**
|
|
248
|
-
*
|
|
257
|
+
* 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.
|
|
249
258
|
*/
|
|
250
259
|
export interface Schema$BusinessInfo {
|
|
251
260
|
/**
|
|
252
|
-
* Optional. The address of the business.
|
|
261
|
+
* 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.
|
|
253
262
|
*/
|
|
254
263
|
address?: Schema$PostalAddress;
|
|
255
264
|
/**
|
|
256
265
|
* Optional. The customer service of the business.
|
|
257
266
|
*/
|
|
258
267
|
customerService?: Schema$CustomerService;
|
|
268
|
+
/**
|
|
269
|
+
* Optional. The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX.
|
|
270
|
+
*/
|
|
271
|
+
koreanBusinessRegistrationNumber?: string | null;
|
|
259
272
|
/**
|
|
260
273
|
* Identifier. The resource name of the business info. Format: `accounts/{account\}/businessInfo`
|
|
261
274
|
*/
|
|
@@ -270,7 +283,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
270
283
|
phoneVerificationState?: string | null;
|
|
271
284
|
}
|
|
272
285
|
/**
|
|
273
|
-
* A list of carrier rates that can be referred to by `main_table` or `single_value`.
|
|
286
|
+
* 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.
|
|
274
287
|
*/
|
|
275
288
|
export interface Schema$CarrierRate {
|
|
276
289
|
/**
|
|
@@ -302,21 +315,21 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
302
315
|
* Request message for the `ClaimHomepage` method.
|
|
303
316
|
*/
|
|
304
317
|
export interface Schema$ClaimHomepageRequest {
|
|
318
|
+
/**
|
|
319
|
+
* 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.
|
|
320
|
+
*/
|
|
321
|
+
overwrite?: boolean | null;
|
|
305
322
|
}
|
|
306
323
|
/**
|
|
307
324
|
* Request message for the `CreateAndConfigureAccount` method.
|
|
308
325
|
*/
|
|
309
326
|
export interface Schema$CreateAndConfigureAccountRequest {
|
|
310
|
-
/**
|
|
311
|
-
* Optional. The Terms of Service (ToS) to be accepted immediately upon account creation.
|
|
312
|
-
*/
|
|
313
|
-
acceptTermsOfService?: Schema$AcceptTermsOfService;
|
|
314
327
|
/**
|
|
315
328
|
* Required. The account to be created.
|
|
316
329
|
*/
|
|
317
330
|
account?: Schema$Account;
|
|
318
331
|
/**
|
|
319
|
-
* 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
|
|
332
|
+
* 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.
|
|
320
333
|
*/
|
|
321
334
|
service?: Schema$AddAccountService[];
|
|
322
335
|
/**
|
|
@@ -333,7 +346,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
333
346
|
*/
|
|
334
347
|
parent?: string | null;
|
|
335
348
|
/**
|
|
336
|
-
*
|
|
349
|
+
* Optional. The user to create.
|
|
337
350
|
*/
|
|
338
351
|
user?: Schema$User;
|
|
339
352
|
/**
|
|
@@ -422,7 +435,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
422
435
|
*/
|
|
423
436
|
handlingBusinessDayConfig?: Schema$BusinessDayConfig;
|
|
424
437
|
/**
|
|
425
|
-
* 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`.
|
|
438
|
+
* 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.
|
|
426
439
|
*/
|
|
427
440
|
maxHandlingDays?: number | null;
|
|
428
441
|
/**
|
|
@@ -430,7 +443,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
430
443
|
*/
|
|
431
444
|
maxTransitDays?: number | null;
|
|
432
445
|
/**
|
|
433
|
-
* Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped.
|
|
446
|
+
* 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.
|
|
434
447
|
*/
|
|
435
448
|
minHandlingDays?: number | null;
|
|
436
449
|
/**
|
|
@@ -526,7 +539,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
526
539
|
weights?: Schema$Weight[];
|
|
527
540
|
}
|
|
528
541
|
/**
|
|
529
|
-
* A
|
|
542
|
+
* 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).
|
|
530
543
|
*/
|
|
531
544
|
export interface Schema$Homepage {
|
|
532
545
|
/**
|
|
@@ -734,7 +747,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
734
747
|
*/
|
|
735
748
|
acceptExchange?: boolean | null;
|
|
736
749
|
/**
|
|
737
|
-
* The countries of sale where the return policy applies. The values must be a valid 2 letter ISO 3166 code.
|
|
750
|
+
* Required. Immutable. The countries of sale where the return policy applies. The values must be a valid 2 letter ISO 3166 code.
|
|
738
751
|
*/
|
|
739
752
|
countries?: string[] | null;
|
|
740
753
|
/**
|
|
@@ -742,7 +755,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
742
755
|
*/
|
|
743
756
|
itemConditions?: string[] | null;
|
|
744
757
|
/**
|
|
745
|
-
* 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.
|
|
758
|
+
* 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.
|
|
746
759
|
*/
|
|
747
760
|
label?: string | null;
|
|
748
761
|
/**
|
|
@@ -770,20 +783,24 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
770
783
|
*/
|
|
771
784
|
returnPolicyId?: string | null;
|
|
772
785
|
/**
|
|
773
|
-
* The return policy uri. This can used by Google to do a sanity check for the policy. It must be a valid URL.
|
|
786
|
+
* Required. The return policy uri. This can used by Google to do a sanity check for the policy. It must be a valid URL.
|
|
774
787
|
*/
|
|
775
788
|
returnPolicyUri?: string | null;
|
|
776
789
|
/**
|
|
777
790
|
* The return shipping fee. Should be set only when customer need to download and print the return label.
|
|
778
791
|
*/
|
|
779
792
|
returnShippingFee?: Schema$ReturnShippingFee;
|
|
793
|
+
/**
|
|
794
|
+
* Optional. Overrides to the general policy for orders placed during a specific set of time intervals.
|
|
795
|
+
*/
|
|
796
|
+
seasonalOverrides?: Schema$SeasonalOverride[];
|
|
780
797
|
}
|
|
781
798
|
/**
|
|
782
799
|
* 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
|
|
783
800
|
*/
|
|
784
801
|
export interface Schema$PhoneNumber {
|
|
785
802
|
/**
|
|
786
|
-
* 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
|
|
803
|
+
* 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
|
|
787
804
|
*/
|
|
788
805
|
e164Number?: string | null;
|
|
789
806
|
/**
|
|
@@ -809,15 +826,15 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
809
826
|
type?: string | null;
|
|
810
827
|
}
|
|
811
828
|
/**
|
|
812
|
-
* Represents a postal address
|
|
829
|
+
* 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
|
|
813
830
|
*/
|
|
814
831
|
export interface Schema$PostalAddress {
|
|
815
832
|
/**
|
|
816
|
-
* 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 (
|
|
833
|
+
* 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).
|
|
817
834
|
*/
|
|
818
835
|
addressLines?: string[] | null;
|
|
819
836
|
/**
|
|
820
|
-
* 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 (
|
|
837
|
+
* 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.
|
|
821
838
|
*/
|
|
822
839
|
administrativeArea?: string | null;
|
|
823
840
|
/**
|
|
@@ -833,7 +850,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
833
850
|
*/
|
|
834
851
|
organization?: string | null;
|
|
835
852
|
/**
|
|
836
|
-
* 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 (
|
|
853
|
+
* 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.).
|
|
837
854
|
*/
|
|
838
855
|
postalCode?: string | null;
|
|
839
856
|
/**
|
|
@@ -849,7 +866,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
849
866
|
*/
|
|
850
867
|
revision?: number | null;
|
|
851
868
|
/**
|
|
852
|
-
* 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 (
|
|
869
|
+
* 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).
|
|
853
870
|
*/
|
|
854
871
|
sortingCode?: string | null;
|
|
855
872
|
/**
|
|
@@ -933,6 +950,10 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
933
950
|
* A message to describe the change that happened to the product
|
|
934
951
|
*/
|
|
935
952
|
changes?: Schema$ProductChange[];
|
|
953
|
+
/**
|
|
954
|
+
* The product expiration time. This field will not bet set if the notification is sent for a product deletion event.
|
|
955
|
+
*/
|
|
956
|
+
expirationTime?: string | null;
|
|
936
957
|
/**
|
|
937
958
|
* 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\}`
|
|
938
959
|
*/
|
|
@@ -1085,7 +1106,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1085
1106
|
*/
|
|
1086
1107
|
fixedFee?: Schema$Price;
|
|
1087
1108
|
/**
|
|
1088
|
-
* Type of return shipping fee.
|
|
1109
|
+
* Required. Type of return shipping fee.
|
|
1089
1110
|
*/
|
|
1090
1111
|
type?: string | null;
|
|
1091
1112
|
}
|
|
@@ -1098,6 +1119,27 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1098
1119
|
*/
|
|
1099
1120
|
cells?: Schema$Value[];
|
|
1100
1121
|
}
|
|
1122
|
+
/**
|
|
1123
|
+
* Next: 5
|
|
1124
|
+
*/
|
|
1125
|
+
export interface Schema$SeasonalOverride {
|
|
1126
|
+
/**
|
|
1127
|
+
* 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.
|
|
1128
|
+
*/
|
|
1129
|
+
begin?: Schema$Date;
|
|
1130
|
+
/**
|
|
1131
|
+
* Required. seasonal override end date (inclusive).
|
|
1132
|
+
*/
|
|
1133
|
+
end?: Schema$Date;
|
|
1134
|
+
/**
|
|
1135
|
+
* Required. Display name of this seasonal override in Merchant Center.
|
|
1136
|
+
*/
|
|
1137
|
+
label?: string | null;
|
|
1138
|
+
/**
|
|
1139
|
+
* Required. The return policy for the given date range.
|
|
1140
|
+
*/
|
|
1141
|
+
policy?: Schema$Policy;
|
|
1142
|
+
}
|
|
1101
1143
|
/**
|
|
1102
1144
|
* Shipping service.
|
|
1103
1145
|
*/
|
|
@@ -1148,7 +1190,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1148
1190
|
storeConfig?: Schema$StoreConfig;
|
|
1149
1191
|
}
|
|
1150
1192
|
/**
|
|
1151
|
-
* The merchant account's [shipping setting](
|
|
1193
|
+
* The merchant account's [shipping setting](https://support.google.com/merchants/answer/6069284).
|
|
1152
1194
|
*/
|
|
1153
1195
|
export interface Schema$ShippingSettings {
|
|
1154
1196
|
/**
|
|
@@ -1169,11 +1211,11 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1169
1211
|
warehouses?: Schema$Warehouse[];
|
|
1170
1212
|
}
|
|
1171
1213
|
/**
|
|
1172
|
-
* 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 (
|
|
1214
|
+
* 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).
|
|
1173
1215
|
*/
|
|
1174
1216
|
export interface Schema$ShortCode {
|
|
1175
1217
|
/**
|
|
1176
|
-
* Required. The short code digits, without a leading plus ('+') or country calling code
|
|
1218
|
+
* Required. The short code digits, without a leading plus ('+') or country calling code. For example "611".
|
|
1177
1219
|
*/
|
|
1178
1220
|
number?: string | null;
|
|
1179
1221
|
/**
|
|
@@ -1237,7 +1279,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1237
1279
|
rows?: Schema$Row[];
|
|
1238
1280
|
}
|
|
1239
1281
|
/**
|
|
1240
|
-
*
|
|
1282
|
+
* 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`.
|
|
1241
1283
|
*/
|
|
1242
1284
|
export interface Schema$TermsOfService {
|
|
1243
1285
|
/**
|
|
@@ -1291,11 +1333,11 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1291
1333
|
*/
|
|
1292
1334
|
export interface Schema$TimeZone {
|
|
1293
1335
|
/**
|
|
1294
|
-
* IANA Time Zone Database time zone
|
|
1336
|
+
* IANA Time Zone Database time zone. For example "America/New_York".
|
|
1295
1337
|
*/
|
|
1296
1338
|
id?: string | null;
|
|
1297
1339
|
/**
|
|
1298
|
-
* Optional. IANA Time Zone Database version number
|
|
1340
|
+
* Optional. IANA Time Zone Database version number. For example "2019a".
|
|
1299
1341
|
*/
|
|
1300
1342
|
version?: string | null;
|
|
1301
1343
|
}
|
|
@@ -1344,7 +1386,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1344
1386
|
export interface Schema$UnclaimHomepageRequest {
|
|
1345
1387
|
}
|
|
1346
1388
|
/**
|
|
1347
|
-
*
|
|
1389
|
+
* 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).
|
|
1348
1390
|
*/
|
|
1349
1391
|
export interface Schema$User {
|
|
1350
1392
|
/**
|
|
@@ -1386,7 +1428,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1386
1428
|
subtable?: string | null;
|
|
1387
1429
|
}
|
|
1388
1430
|
/**
|
|
1389
|
-
* A fulfillment warehouse, which stores and handles inventory.
|
|
1431
|
+
* A fulfillment warehouse, which stores and handles inventory.
|
|
1390
1432
|
*/
|
|
1391
1433
|
export interface Schema$Warehouse {
|
|
1392
1434
|
/**
|
|
@@ -1415,7 +1457,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1415
1457
|
*/
|
|
1416
1458
|
export interface Schema$WarehouseBasedDeliveryTime {
|
|
1417
1459
|
/**
|
|
1418
|
-
* Required. Carrier, such as `"UPS"` or `"Fedex"`.
|
|
1460
|
+
* 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)
|
|
1419
1461
|
*/
|
|
1420
1462
|
carrier?: string | null;
|
|
1421
1463
|
/**
|
|
@@ -1455,9 +1497,10 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1455
1497
|
}
|
|
1456
1498
|
export class Resource$Accounts {
|
|
1457
1499
|
context: APIRequestContext;
|
|
1500
|
+
autofeedSettings: Resource$Accounts$Autofeedsettings;
|
|
1458
1501
|
businessIdentity: Resource$Accounts$Businessidentity;
|
|
1459
1502
|
businessInfo: Resource$Accounts$Businessinfo;
|
|
1460
|
-
|
|
1503
|
+
emailPreferences: Resource$Accounts$Emailpreferences;
|
|
1461
1504
|
homepage: Resource$Accounts$Homepage;
|
|
1462
1505
|
issues: Resource$Accounts$Issues;
|
|
1463
1506
|
onlineReturnPolicies: Resource$Accounts$Onlinereturnpolicies;
|
|
@@ -1482,7 +1525,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1482
1525
|
createAndConfigure(params: Params$Resource$Accounts$Createandconfigure, callback: BodyResponseCallback<Schema$Account>): void;
|
|
1483
1526
|
createAndConfigure(callback: BodyResponseCallback<Schema$Account>): void;
|
|
1484
1527
|
/**
|
|
1485
|
-
* 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.
|
|
1528
|
+
* 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.
|
|
1486
1529
|
*
|
|
1487
1530
|
* @param params - Parameters for request
|
|
1488
1531
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1510,7 +1553,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1510
1553
|
get(params: Params$Resource$Accounts$Get, callback: BodyResponseCallback<Schema$Account>): void;
|
|
1511
1554
|
get(callback: BodyResponseCallback<Schema$Account>): void;
|
|
1512
1555
|
/**
|
|
1513
|
-
* 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.
|
|
1556
|
+
* 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.
|
|
1514
1557
|
*
|
|
1515
1558
|
* @param params - Parameters for request
|
|
1516
1559
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1559,6 +1602,10 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1559
1602
|
requestBody?: Schema$CreateAndConfigureAccountRequest;
|
|
1560
1603
|
}
|
|
1561
1604
|
export interface Params$Resource$Accounts$Delete extends StandardParameters {
|
|
1605
|
+
/**
|
|
1606
|
+
* Optional. If set to `true`, the account is deleted even if it provides services to other accounts or has processed offers.
|
|
1607
|
+
*/
|
|
1608
|
+
force?: boolean;
|
|
1562
1609
|
/**
|
|
1563
1610
|
* Required. The name of the account to delete. Format: `accounts/{account\}`
|
|
1564
1611
|
*/
|
|
@@ -1594,7 +1641,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1594
1641
|
*/
|
|
1595
1642
|
pageToken?: string;
|
|
1596
1643
|
/**
|
|
1597
|
-
* Required. The
|
|
1644
|
+
* Required. The aggregation service provider. Format: `providers/{providerId\}`
|
|
1598
1645
|
*/
|
|
1599
1646
|
provider?: string;
|
|
1600
1647
|
}
|
|
@@ -1604,7 +1651,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1604
1651
|
*/
|
|
1605
1652
|
name?: string;
|
|
1606
1653
|
/**
|
|
1607
|
-
*
|
|
1654
|
+
* 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`
|
|
1608
1655
|
*/
|
|
1609
1656
|
updateMask?: string;
|
|
1610
1657
|
/**
|
|
@@ -1612,6 +1659,58 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1612
1659
|
*/
|
|
1613
1660
|
requestBody?: Schema$Account;
|
|
1614
1661
|
}
|
|
1662
|
+
export class Resource$Accounts$Autofeedsettings {
|
|
1663
|
+
context: APIRequestContext;
|
|
1664
|
+
constructor(context: APIRequestContext);
|
|
1665
|
+
/**
|
|
1666
|
+
* Retrieves the autofeed settings of an account.
|
|
1667
|
+
*
|
|
1668
|
+
* @param params - Parameters for request
|
|
1669
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
1670
|
+
* @param callback - Optional callback that handles the response.
|
|
1671
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
1672
|
+
*/
|
|
1673
|
+
getAutofeedSettings(params: Params$Resource$Accounts$Autofeedsettings$Getautofeedsettings, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
1674
|
+
getAutofeedSettings(params?: Params$Resource$Accounts$Autofeedsettings$Getautofeedsettings, options?: MethodOptions): GaxiosPromise<Schema$AutofeedSettings>;
|
|
1675
|
+
getAutofeedSettings(params: Params$Resource$Accounts$Autofeedsettings$Getautofeedsettings, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
1676
|
+
getAutofeedSettings(params: Params$Resource$Accounts$Autofeedsettings$Getautofeedsettings, options: MethodOptions | BodyResponseCallback<Schema$AutofeedSettings>, callback: BodyResponseCallback<Schema$AutofeedSettings>): void;
|
|
1677
|
+
getAutofeedSettings(params: Params$Resource$Accounts$Autofeedsettings$Getautofeedsettings, callback: BodyResponseCallback<Schema$AutofeedSettings>): void;
|
|
1678
|
+
getAutofeedSettings(callback: BodyResponseCallback<Schema$AutofeedSettings>): void;
|
|
1679
|
+
/**
|
|
1680
|
+
* Updates the autofeed settings of an account.
|
|
1681
|
+
*
|
|
1682
|
+
* @param params - Parameters for request
|
|
1683
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
1684
|
+
* @param callback - Optional callback that handles the response.
|
|
1685
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
1686
|
+
*/
|
|
1687
|
+
updateAutofeedSettings(params: Params$Resource$Accounts$Autofeedsettings$Updateautofeedsettings, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
1688
|
+
updateAutofeedSettings(params?: Params$Resource$Accounts$Autofeedsettings$Updateautofeedsettings, options?: MethodOptions): GaxiosPromise<Schema$AutofeedSettings>;
|
|
1689
|
+
updateAutofeedSettings(params: Params$Resource$Accounts$Autofeedsettings$Updateautofeedsettings, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
1690
|
+
updateAutofeedSettings(params: Params$Resource$Accounts$Autofeedsettings$Updateautofeedsettings, options: MethodOptions | BodyResponseCallback<Schema$AutofeedSettings>, callback: BodyResponseCallback<Schema$AutofeedSettings>): void;
|
|
1691
|
+
updateAutofeedSettings(params: Params$Resource$Accounts$Autofeedsettings$Updateautofeedsettings, callback: BodyResponseCallback<Schema$AutofeedSettings>): void;
|
|
1692
|
+
updateAutofeedSettings(callback: BodyResponseCallback<Schema$AutofeedSettings>): void;
|
|
1693
|
+
}
|
|
1694
|
+
export interface Params$Resource$Accounts$Autofeedsettings$Getautofeedsettings extends StandardParameters {
|
|
1695
|
+
/**
|
|
1696
|
+
* Required. The resource name of the autofeed settings. Format: `accounts/{account\}/autofeedSettings`
|
|
1697
|
+
*/
|
|
1698
|
+
name?: string;
|
|
1699
|
+
}
|
|
1700
|
+
export interface Params$Resource$Accounts$Autofeedsettings$Updateautofeedsettings extends StandardParameters {
|
|
1701
|
+
/**
|
|
1702
|
+
* Identifier. The resource name of the autofeed settings. Format: `accounts/{account\}/autofeedSettings`.
|
|
1703
|
+
*/
|
|
1704
|
+
name?: string;
|
|
1705
|
+
/**
|
|
1706
|
+
* Required. List of fields being updated.
|
|
1707
|
+
*/
|
|
1708
|
+
updateMask?: string;
|
|
1709
|
+
/**
|
|
1710
|
+
* Request body metadata
|
|
1711
|
+
*/
|
|
1712
|
+
requestBody?: Schema$AutofeedSettings;
|
|
1713
|
+
}
|
|
1615
1714
|
export class Resource$Accounts$Businessidentity {
|
|
1616
1715
|
context: APIRequestContext;
|
|
1617
1716
|
constructor(context: APIRequestContext);
|
|
@@ -1656,7 +1755,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1656
1755
|
*/
|
|
1657
1756
|
name?: string;
|
|
1658
1757
|
/**
|
|
1659
|
-
*
|
|
1758
|
+
* 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`
|
|
1660
1759
|
*/
|
|
1661
1760
|
updateMask?: string;
|
|
1662
1761
|
/**
|
|
@@ -1708,7 +1807,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1708
1807
|
*/
|
|
1709
1808
|
name?: string;
|
|
1710
1809
|
/**
|
|
1711
|
-
*
|
|
1810
|
+
* Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `address` - `customer_service` - `korean_business_registration_number`
|
|
1712
1811
|
*/
|
|
1713
1812
|
updateMask?: string;
|
|
1714
1813
|
/**
|
|
@@ -1720,7 +1819,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1720
1819
|
context: APIRequestContext;
|
|
1721
1820
|
constructor(context: APIRequestContext);
|
|
1722
1821
|
/**
|
|
1723
|
-
* 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.
|
|
1822
|
+
* 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.
|
|
1724
1823
|
*
|
|
1725
1824
|
* @param params - Parameters for request
|
|
1726
1825
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1760,7 +1859,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1760
1859
|
*/
|
|
1761
1860
|
name?: string;
|
|
1762
1861
|
/**
|
|
1763
|
-
* Required. List of fields being updated.
|
|
1862
|
+
* Required. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `news_and_tips`
|
|
1764
1863
|
*/
|
|
1765
1864
|
updateMask?: string;
|
|
1766
1865
|
/**
|
|
@@ -1860,7 +1959,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1860
1959
|
*/
|
|
1861
1960
|
name?: string;
|
|
1862
1961
|
/**
|
|
1863
|
-
*
|
|
1962
|
+
* Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `uri`
|
|
1864
1963
|
*/
|
|
1865
1964
|
updateMask?: string;
|
|
1866
1965
|
/**
|
|
@@ -1904,19 +2003,15 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1904
2003
|
*/
|
|
1905
2004
|
parent?: string;
|
|
1906
2005
|
/**
|
|
1907
|
-
* IANA
|
|
2006
|
+
* 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.
|
|
1908
2007
|
*/
|
|
1909
|
-
|
|
1910
|
-
/**
|
|
1911
|
-
* Optional. IANA Time Zone Database version number, e.g. "2019a".
|
|
1912
|
-
*/
|
|
1913
|
-
'timeZone.version'?: string;
|
|
2008
|
+
timeZone?: string;
|
|
1914
2009
|
}
|
|
1915
2010
|
export class Resource$Accounts$Onlinereturnpolicies {
|
|
1916
2011
|
context: APIRequestContext;
|
|
1917
2012
|
constructor(context: APIRequestContext);
|
|
1918
2013
|
/**
|
|
1919
|
-
* Gets an existing return policy.
|
|
2014
|
+
* Gets an existing return policy for a given merchant.
|
|
1920
2015
|
*
|
|
1921
2016
|
* @param params - Parameters for request
|
|
1922
2017
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1930,7 +2025,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1930
2025
|
get(params: Params$Resource$Accounts$Onlinereturnpolicies$Get, callback: BodyResponseCallback<Schema$OnlineReturnPolicy>): void;
|
|
1931
2026
|
get(callback: BodyResponseCallback<Schema$OnlineReturnPolicy>): void;
|
|
1932
2027
|
/**
|
|
1933
|
-
* Lists all existing return policies.
|
|
2028
|
+
* Lists all existing return policies for a given merchant.
|
|
1934
2029
|
*
|
|
1935
2030
|
* @param params - Parameters for request
|
|
1936
2031
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -2302,7 +2397,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
2302
2397
|
create(params: Params$Resource$Accounts$Users$Create, callback: BodyResponseCallback<Schema$User>): void;
|
|
2303
2398
|
create(callback: BodyResponseCallback<Schema$User>): void;
|
|
2304
2399
|
/**
|
|
2305
|
-
* Deletes a Merchant Center account user. Executing this method requires admin access.
|
|
2400
|
+
* 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"
|
|
2306
2401
|
*
|
|
2307
2402
|
* @param params - Parameters for request
|
|
2308
2403
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -2404,7 +2499,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
2404
2499
|
*/
|
|
2405
2500
|
name?: string;
|
|
2406
2501
|
/**
|
|
2407
|
-
*
|
|
2502
|
+
* Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `access_rights`
|
|
2408
2503
|
*/
|
|
2409
2504
|
updateMask?: string;
|
|
2410
2505
|
/**
|
|
@@ -2480,11 +2575,11 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
2480
2575
|
}
|
|
2481
2576
|
export interface Params$Resource$Termsofservice$Retrievelatest extends StandardParameters {
|
|
2482
2577
|
/**
|
|
2483
|
-
* The Kind this terms of service version applies to.
|
|
2578
|
+
* Required. The Kind this terms of service version applies to.
|
|
2484
2579
|
*/
|
|
2485
2580
|
kind?: string;
|
|
2486
2581
|
/**
|
|
2487
|
-
* 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.
|
|
2582
|
+
* 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.
|
|
2488
2583
|
*/
|
|
2489
2584
|
regionCode?: string;
|
|
2490
2585
|
}
|