@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.
- package/CHANGELOG.md +27 -0
- package/accounts_v1beta.ts +328 -73
- package/build/accounts_v1beta.d.ts +162 -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,11 +254,11 @@ 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
|
/**
|
|
@@ -274,7 +283,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
274
283
|
phoneVerificationState?: string | null;
|
|
275
284
|
}
|
|
276
285
|
/**
|
|
277
|
-
* 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.
|
|
278
287
|
*/
|
|
279
288
|
export interface Schema$CarrierRate {
|
|
280
289
|
/**
|
|
@@ -306,21 +315,21 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
306
315
|
* Request message for the `ClaimHomepage` method.
|
|
307
316
|
*/
|
|
308
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;
|
|
309
322
|
}
|
|
310
323
|
/**
|
|
311
324
|
* Request message for the `CreateAndConfigureAccount` method.
|
|
312
325
|
*/
|
|
313
326
|
export interface Schema$CreateAndConfigureAccountRequest {
|
|
314
|
-
/**
|
|
315
|
-
* Optional. The Terms of Service (ToS) to be accepted immediately upon account creation.
|
|
316
|
-
*/
|
|
317
|
-
acceptTermsOfService?: Schema$AcceptTermsOfService;
|
|
318
327
|
/**
|
|
319
328
|
* Required. The account to be created.
|
|
320
329
|
*/
|
|
321
330
|
account?: Schema$Account;
|
|
322
331
|
/**
|
|
323
|
-
* 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.
|
|
324
333
|
*/
|
|
325
334
|
service?: Schema$AddAccountService[];
|
|
326
335
|
/**
|
|
@@ -337,7 +346,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
337
346
|
*/
|
|
338
347
|
parent?: string | null;
|
|
339
348
|
/**
|
|
340
|
-
*
|
|
349
|
+
* Optional. The user to create.
|
|
341
350
|
*/
|
|
342
351
|
user?: Schema$User;
|
|
343
352
|
/**
|
|
@@ -426,7 +435,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
426
435
|
*/
|
|
427
436
|
handlingBusinessDayConfig?: Schema$BusinessDayConfig;
|
|
428
437
|
/**
|
|
429
|
-
* 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.
|
|
430
439
|
*/
|
|
431
440
|
maxHandlingDays?: number | null;
|
|
432
441
|
/**
|
|
@@ -434,7 +443,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
434
443
|
*/
|
|
435
444
|
maxTransitDays?: number | null;
|
|
436
445
|
/**
|
|
437
|
-
* 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.
|
|
438
447
|
*/
|
|
439
448
|
minHandlingDays?: number | null;
|
|
440
449
|
/**
|
|
@@ -530,7 +539,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
530
539
|
weights?: Schema$Weight[];
|
|
531
540
|
}
|
|
532
541
|
/**
|
|
533
|
-
* 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).
|
|
534
543
|
*/
|
|
535
544
|
export interface Schema$Homepage {
|
|
536
545
|
/**
|
|
@@ -738,7 +747,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
738
747
|
*/
|
|
739
748
|
acceptExchange?: boolean | null;
|
|
740
749
|
/**
|
|
741
|
-
* 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.
|
|
742
751
|
*/
|
|
743
752
|
countries?: string[] | null;
|
|
744
753
|
/**
|
|
@@ -746,7 +755,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
746
755
|
*/
|
|
747
756
|
itemConditions?: string[] | null;
|
|
748
757
|
/**
|
|
749
|
-
* 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.
|
|
750
759
|
*/
|
|
751
760
|
label?: string | null;
|
|
752
761
|
/**
|
|
@@ -774,20 +783,24 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
774
783
|
*/
|
|
775
784
|
returnPolicyId?: string | null;
|
|
776
785
|
/**
|
|
777
|
-
* 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.
|
|
778
787
|
*/
|
|
779
788
|
returnPolicyUri?: string | null;
|
|
780
789
|
/**
|
|
781
790
|
* The return shipping fee. Should be set only when customer need to download and print the return label.
|
|
782
791
|
*/
|
|
783
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[];
|
|
784
797
|
}
|
|
785
798
|
/**
|
|
786
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
|
|
787
800
|
*/
|
|
788
801
|
export interface Schema$PhoneNumber {
|
|
789
802
|
/**
|
|
790
|
-
* 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
|
|
791
804
|
*/
|
|
792
805
|
e164Number?: string | null;
|
|
793
806
|
/**
|
|
@@ -813,15 +826,15 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
813
826
|
type?: string | null;
|
|
814
827
|
}
|
|
815
828
|
/**
|
|
816
|
-
* 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
|
|
817
830
|
*/
|
|
818
831
|
export interface Schema$PostalAddress {
|
|
819
832
|
/**
|
|
820
|
-
* 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).
|
|
821
834
|
*/
|
|
822
835
|
addressLines?: string[] | null;
|
|
823
836
|
/**
|
|
824
|
-
* 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.
|
|
825
838
|
*/
|
|
826
839
|
administrativeArea?: string | null;
|
|
827
840
|
/**
|
|
@@ -837,7 +850,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
837
850
|
*/
|
|
838
851
|
organization?: string | null;
|
|
839
852
|
/**
|
|
840
|
-
* 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.).
|
|
841
854
|
*/
|
|
842
855
|
postalCode?: string | null;
|
|
843
856
|
/**
|
|
@@ -853,7 +866,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
853
866
|
*/
|
|
854
867
|
revision?: number | null;
|
|
855
868
|
/**
|
|
856
|
-
* 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).
|
|
857
870
|
*/
|
|
858
871
|
sortingCode?: string | null;
|
|
859
872
|
/**
|
|
@@ -937,6 +950,10 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
937
950
|
* A message to describe the change that happened to the product
|
|
938
951
|
*/
|
|
939
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;
|
|
940
957
|
/**
|
|
941
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\}`
|
|
942
959
|
*/
|
|
@@ -1089,7 +1106,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1089
1106
|
*/
|
|
1090
1107
|
fixedFee?: Schema$Price;
|
|
1091
1108
|
/**
|
|
1092
|
-
* Type of return shipping fee.
|
|
1109
|
+
* Required. Type of return shipping fee.
|
|
1093
1110
|
*/
|
|
1094
1111
|
type?: string | null;
|
|
1095
1112
|
}
|
|
@@ -1102,6 +1119,27 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1102
1119
|
*/
|
|
1103
1120
|
cells?: Schema$Value[];
|
|
1104
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
|
+
}
|
|
1105
1143
|
/**
|
|
1106
1144
|
* Shipping service.
|
|
1107
1145
|
*/
|
|
@@ -1152,7 +1190,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1152
1190
|
storeConfig?: Schema$StoreConfig;
|
|
1153
1191
|
}
|
|
1154
1192
|
/**
|
|
1155
|
-
* The merchant account's [shipping setting](
|
|
1193
|
+
* The merchant account's [shipping setting](https://support.google.com/merchants/answer/6069284).
|
|
1156
1194
|
*/
|
|
1157
1195
|
export interface Schema$ShippingSettings {
|
|
1158
1196
|
/**
|
|
@@ -1173,11 +1211,11 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1173
1211
|
warehouses?: Schema$Warehouse[];
|
|
1174
1212
|
}
|
|
1175
1213
|
/**
|
|
1176
|
-
* 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).
|
|
1177
1215
|
*/
|
|
1178
1216
|
export interface Schema$ShortCode {
|
|
1179
1217
|
/**
|
|
1180
|
-
* 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".
|
|
1181
1219
|
*/
|
|
1182
1220
|
number?: string | null;
|
|
1183
1221
|
/**
|
|
@@ -1241,7 +1279,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1241
1279
|
rows?: Schema$Row[];
|
|
1242
1280
|
}
|
|
1243
1281
|
/**
|
|
1244
|
-
*
|
|
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`.
|
|
1245
1283
|
*/
|
|
1246
1284
|
export interface Schema$TermsOfService {
|
|
1247
1285
|
/**
|
|
@@ -1295,11 +1333,11 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1295
1333
|
*/
|
|
1296
1334
|
export interface Schema$TimeZone {
|
|
1297
1335
|
/**
|
|
1298
|
-
* IANA Time Zone Database time zone
|
|
1336
|
+
* IANA Time Zone Database time zone. For example "America/New_York".
|
|
1299
1337
|
*/
|
|
1300
1338
|
id?: string | null;
|
|
1301
1339
|
/**
|
|
1302
|
-
* Optional. IANA Time Zone Database version number
|
|
1340
|
+
* Optional. IANA Time Zone Database version number. For example "2019a".
|
|
1303
1341
|
*/
|
|
1304
1342
|
version?: string | null;
|
|
1305
1343
|
}
|
|
@@ -1348,7 +1386,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1348
1386
|
export interface Schema$UnclaimHomepageRequest {
|
|
1349
1387
|
}
|
|
1350
1388
|
/**
|
|
1351
|
-
*
|
|
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).
|
|
1352
1390
|
*/
|
|
1353
1391
|
export interface Schema$User {
|
|
1354
1392
|
/**
|
|
@@ -1390,7 +1428,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1390
1428
|
subtable?: string | null;
|
|
1391
1429
|
}
|
|
1392
1430
|
/**
|
|
1393
|
-
* A fulfillment warehouse, which stores and handles inventory.
|
|
1431
|
+
* A fulfillment warehouse, which stores and handles inventory.
|
|
1394
1432
|
*/
|
|
1395
1433
|
export interface Schema$Warehouse {
|
|
1396
1434
|
/**
|
|
@@ -1419,7 +1457,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1419
1457
|
*/
|
|
1420
1458
|
export interface Schema$WarehouseBasedDeliveryTime {
|
|
1421
1459
|
/**
|
|
1422
|
-
* 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)
|
|
1423
1461
|
*/
|
|
1424
1462
|
carrier?: string | null;
|
|
1425
1463
|
/**
|
|
@@ -1459,9 +1497,10 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1459
1497
|
}
|
|
1460
1498
|
export class Resource$Accounts {
|
|
1461
1499
|
context: APIRequestContext;
|
|
1500
|
+
autofeedSettings: Resource$Accounts$Autofeedsettings;
|
|
1462
1501
|
businessIdentity: Resource$Accounts$Businessidentity;
|
|
1463
1502
|
businessInfo: Resource$Accounts$Businessinfo;
|
|
1464
|
-
|
|
1503
|
+
emailPreferences: Resource$Accounts$Emailpreferences;
|
|
1465
1504
|
homepage: Resource$Accounts$Homepage;
|
|
1466
1505
|
issues: Resource$Accounts$Issues;
|
|
1467
1506
|
onlineReturnPolicies: Resource$Accounts$Onlinereturnpolicies;
|
|
@@ -1486,7 +1525,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1486
1525
|
createAndConfigure(params: Params$Resource$Accounts$Createandconfigure, callback: BodyResponseCallback<Schema$Account>): void;
|
|
1487
1526
|
createAndConfigure(callback: BodyResponseCallback<Schema$Account>): void;
|
|
1488
1527
|
/**
|
|
1489
|
-
* 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.
|
|
1490
1529
|
*
|
|
1491
1530
|
* @param params - Parameters for request
|
|
1492
1531
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1514,7 +1553,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1514
1553
|
get(params: Params$Resource$Accounts$Get, callback: BodyResponseCallback<Schema$Account>): void;
|
|
1515
1554
|
get(callback: BodyResponseCallback<Schema$Account>): void;
|
|
1516
1555
|
/**
|
|
1517
|
-
* 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.
|
|
1518
1557
|
*
|
|
1519
1558
|
* @param params - Parameters for request
|
|
1520
1559
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1563,6 +1602,10 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1563
1602
|
requestBody?: Schema$CreateAndConfigureAccountRequest;
|
|
1564
1603
|
}
|
|
1565
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;
|
|
1566
1609
|
/**
|
|
1567
1610
|
* Required. The name of the account to delete. Format: `accounts/{account\}`
|
|
1568
1611
|
*/
|
|
@@ -1598,7 +1641,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1598
1641
|
*/
|
|
1599
1642
|
pageToken?: string;
|
|
1600
1643
|
/**
|
|
1601
|
-
* Required. The
|
|
1644
|
+
* Required. The aggregation service provider. Format: `providers/{providerId\}`
|
|
1602
1645
|
*/
|
|
1603
1646
|
provider?: string;
|
|
1604
1647
|
}
|
|
@@ -1608,7 +1651,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1608
1651
|
*/
|
|
1609
1652
|
name?: string;
|
|
1610
1653
|
/**
|
|
1611
|
-
*
|
|
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`
|
|
1612
1655
|
*/
|
|
1613
1656
|
updateMask?: string;
|
|
1614
1657
|
/**
|
|
@@ -1616,6 +1659,58 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1616
1659
|
*/
|
|
1617
1660
|
requestBody?: Schema$Account;
|
|
1618
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
|
+
}
|
|
1619
1714
|
export class Resource$Accounts$Businessidentity {
|
|
1620
1715
|
context: APIRequestContext;
|
|
1621
1716
|
constructor(context: APIRequestContext);
|
|
@@ -1660,7 +1755,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1660
1755
|
*/
|
|
1661
1756
|
name?: string;
|
|
1662
1757
|
/**
|
|
1663
|
-
*
|
|
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`
|
|
1664
1759
|
*/
|
|
1665
1760
|
updateMask?: string;
|
|
1666
1761
|
/**
|
|
@@ -1712,7 +1807,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1712
1807
|
*/
|
|
1713
1808
|
name?: string;
|
|
1714
1809
|
/**
|
|
1715
|
-
*
|
|
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`
|
|
1716
1811
|
*/
|
|
1717
1812
|
updateMask?: string;
|
|
1718
1813
|
/**
|
|
@@ -1724,7 +1819,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1724
1819
|
context: APIRequestContext;
|
|
1725
1820
|
constructor(context: APIRequestContext);
|
|
1726
1821
|
/**
|
|
1727
|
-
* 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.
|
|
1728
1823
|
*
|
|
1729
1824
|
* @param params - Parameters for request
|
|
1730
1825
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1764,7 +1859,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1764
1859
|
*/
|
|
1765
1860
|
name?: string;
|
|
1766
1861
|
/**
|
|
1767
|
-
* 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`
|
|
1768
1863
|
*/
|
|
1769
1864
|
updateMask?: string;
|
|
1770
1865
|
/**
|
|
@@ -1864,7 +1959,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1864
1959
|
*/
|
|
1865
1960
|
name?: string;
|
|
1866
1961
|
/**
|
|
1867
|
-
*
|
|
1962
|
+
* Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `uri`
|
|
1868
1963
|
*/
|
|
1869
1964
|
updateMask?: string;
|
|
1870
1965
|
/**
|
|
@@ -1908,19 +2003,15 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1908
2003
|
*/
|
|
1909
2004
|
parent?: string;
|
|
1910
2005
|
/**
|
|
1911
|
-
* 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.
|
|
1912
2007
|
*/
|
|
1913
|
-
|
|
1914
|
-
/**
|
|
1915
|
-
* Optional. IANA Time Zone Database version number, e.g. "2019a".
|
|
1916
|
-
*/
|
|
1917
|
-
'timeZone.version'?: string;
|
|
2008
|
+
timeZone?: string;
|
|
1918
2009
|
}
|
|
1919
2010
|
export class Resource$Accounts$Onlinereturnpolicies {
|
|
1920
2011
|
context: APIRequestContext;
|
|
1921
2012
|
constructor(context: APIRequestContext);
|
|
1922
2013
|
/**
|
|
1923
|
-
* Gets an existing return policy.
|
|
2014
|
+
* Gets an existing return policy for a given merchant.
|
|
1924
2015
|
*
|
|
1925
2016
|
* @param params - Parameters for request
|
|
1926
2017
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1934,7 +2025,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1934
2025
|
get(params: Params$Resource$Accounts$Onlinereturnpolicies$Get, callback: BodyResponseCallback<Schema$OnlineReturnPolicy>): void;
|
|
1935
2026
|
get(callback: BodyResponseCallback<Schema$OnlineReturnPolicy>): void;
|
|
1936
2027
|
/**
|
|
1937
|
-
* Lists all existing return policies.
|
|
2028
|
+
* Lists all existing return policies for a given merchant.
|
|
1938
2029
|
*
|
|
1939
2030
|
* @param params - Parameters for request
|
|
1940
2031
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -2306,7 +2397,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
2306
2397
|
create(params: Params$Resource$Accounts$Users$Create, callback: BodyResponseCallback<Schema$User>): void;
|
|
2307
2398
|
create(callback: BodyResponseCallback<Schema$User>): void;
|
|
2308
2399
|
/**
|
|
2309
|
-
* 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"
|
|
2310
2401
|
*
|
|
2311
2402
|
* @param params - Parameters for request
|
|
2312
2403
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -2408,7 +2499,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
2408
2499
|
*/
|
|
2409
2500
|
name?: string;
|
|
2410
2501
|
/**
|
|
2411
|
-
*
|
|
2502
|
+
* Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `access_rights`
|
|
2412
2503
|
*/
|
|
2413
2504
|
updateMask?: string;
|
|
2414
2505
|
/**
|
|
@@ -2484,11 +2575,11 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
2484
2575
|
}
|
|
2485
2576
|
export interface Params$Resource$Termsofservice$Retrievelatest extends StandardParameters {
|
|
2486
2577
|
/**
|
|
2487
|
-
* The Kind this terms of service version applies to.
|
|
2578
|
+
* Required. The Kind this terms of service version applies to.
|
|
2488
2579
|
*/
|
|
2489
2580
|
kind?: string;
|
|
2490
2581
|
/**
|
|
2491
|
-
* 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.
|
|
2492
2583
|
*/
|
|
2493
2584
|
regionCode?: string;
|
|
2494
2585
|
}
|