@googleapis/merchantapi 4.1.0 → 5.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 +16 -0
- package/accounts_v1beta.ts +1572 -557
- package/build/accounts_v1beta.d.ts +447 -80
- package/build/accounts_v1beta.js +309 -30
- package/build/accounts_v1beta.js.map +1 -1
- package/build/conversions_v1beta.d.ts +15 -12
- package/build/conversions_v1beta.js.map +1 -1
- package/build/datasources_v1beta.d.ts +3 -3
- package/build/inventories_v1beta.d.ts +1 -1
- package/build/lfp_v1beta.d.ts +121 -0
- package/build/lfp_v1beta.js +39 -0
- package/build/lfp_v1beta.js.map +1 -1
- package/build/products_v1beta.d.ts +34 -13
- package/build/products_v1beta.js.map +1 -1
- package/build/reports_v1beta.d.ts +1 -1
- package/conversions_v1beta.ts +15 -12
- package/datasources_v1beta.ts +3 -3
- package/inventories_v1beta.ts +1 -1
- package/lfp_v1beta.ts +203 -0
- package/package.json +1 -1
- package/products_v1beta.ts +34 -13
- package/reports_v1beta.ts +1 -1
|
@@ -81,14 +81,23 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
81
81
|
*/
|
|
82
82
|
acceptedBy?: string | null;
|
|
83
83
|
/**
|
|
84
|
-
* The accepted
|
|
84
|
+
* The accepted termsOfService.
|
|
85
85
|
*/
|
|
86
86
|
termsOfService?: string | null;
|
|
87
87
|
/**
|
|
88
|
-
* When set, it states that the accepted
|
|
88
|
+
* When set, it states that the accepted `TermsOfService` is only valid until the end of this date (in UTC). A new one must be accepted before then. The information of the required `TermsOfService` is found in the `Required` message.
|
|
89
89
|
*/
|
|
90
90
|
validUntil?: Schema$Date;
|
|
91
91
|
}
|
|
92
|
+
/**
|
|
93
|
+
* Response message for the `AcceptTermsOfService` method.
|
|
94
|
+
*/
|
|
95
|
+
export interface Schema$AcceptTermsOfServiceResponse {
|
|
96
|
+
/**
|
|
97
|
+
* The agreement state after accepting the ToS.
|
|
98
|
+
*/
|
|
99
|
+
termsOfServiceAgreementState?: Schema$TermsOfServiceAgreementState;
|
|
100
|
+
}
|
|
92
101
|
/**
|
|
93
102
|
* 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.
|
|
94
103
|
*/
|
|
@@ -118,7 +127,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
118
127
|
*/
|
|
119
128
|
testAccount?: boolean | null;
|
|
120
129
|
/**
|
|
121
|
-
* Required. The time zone of the account. On writes, `time_zone` sets both the `reporting_time_zone` and the `display_time_zone`. For reads, `time_zone` always returns the `display_time_zone`. If `display_time_zone` doesn't exist for your account, `time_zone` is empty.
|
|
130
|
+
* Required. The time zone of the account. On writes, `time_zone` sets both the `reporting_time_zone` and the `display_time_zone`. For reads, `time_zone` always returns the `display_time_zone`. If `display_time_zone` doesn't exist for your account, `time_zone` is empty. The `version` field is not supported, won't be set in responses and will be silently ignored if specified in requests.
|
|
122
131
|
*/
|
|
123
132
|
timeZone?: Schema$TimeZone;
|
|
124
133
|
}
|
|
@@ -156,6 +165,77 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
156
165
|
*/
|
|
157
166
|
title?: string | null;
|
|
158
167
|
}
|
|
168
|
+
/**
|
|
169
|
+
* `AccountManagement` payload.
|
|
170
|
+
*/
|
|
171
|
+
export interface Schema$AccountManagement {
|
|
172
|
+
}
|
|
173
|
+
/**
|
|
174
|
+
* The `AccountRelationship` message defines a formal connection between a merchant's account and a service provider's account. This relationship enables the provider to offer specific services to the merchant, such as product management or campaign management. It specifies the access rights and permissions to the merchant's data relevant to those services. Establishing an account relationship involves linking the merchant's account with a provider's account. The provider could be another Google account (like Google Ads or Google My Business) or a third-party platform (such as Shopify or WooCommerce).
|
|
175
|
+
*/
|
|
176
|
+
export interface Schema$AccountRelationship {
|
|
177
|
+
/**
|
|
178
|
+
* Optional. An optional alias you can assign to this account relationship. This alias acts as a convenient identifier for your own reference and management. It must be unique among all your account relationships with the same provider. For example, you might use `account_id_alias` to assign a friendly name to this relationship for easier identification in your systems.
|
|
179
|
+
*/
|
|
180
|
+
accountIdAlias?: string | null;
|
|
181
|
+
/**
|
|
182
|
+
* Identifier. The resource name of the account relationship.
|
|
183
|
+
*/
|
|
184
|
+
name?: string | null;
|
|
185
|
+
/**
|
|
186
|
+
* Immutable. 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`).
|
|
187
|
+
*/
|
|
188
|
+
provider?: string | null;
|
|
189
|
+
/**
|
|
190
|
+
* Output only. The human-readable display name of the provider account.
|
|
191
|
+
*/
|
|
192
|
+
providerDisplayName?: string | null;
|
|
193
|
+
}
|
|
194
|
+
/**
|
|
195
|
+
* The `AccountService` message represents a specific service that a provider account offers to a merchant account. `AccountService` defines the permissions and capabilities granted to the provider, allowing for operations such as product management or campaign management. The lifecycle of an `AccountService` involves a proposal phase, where one party suggests the service, and an approval phase, where the other party accepts or rejects it. This handshake mechanism ensures mutual consent before any access is granted. This mechanism safeguards both parties by ensuring that access rights are granted appropriately and that both the merchant and provider are aware of the services enabled. In scenarios where a user is an admin of both accounts, the approval can happen automatically. The mutability of a service is also managed through `AccountService`. Some services might be immutable, for example, if they were established through other systems or APIs, and you cannot alter them through this API.
|
|
196
|
+
*/
|
|
197
|
+
export interface Schema$AccountService {
|
|
198
|
+
/**
|
|
199
|
+
* Service type for account aggregation. This enables the provider, which is a Multi-Client Account (MCA), to manage multiple sub-accounts (client accounts). Through this service, the MCA provider can perform administrative and operational tasks across all linked sub-accounts. This is useful for agencies, aggregators, or large retailers that need centralized control over many merchant accounts.
|
|
200
|
+
*/
|
|
201
|
+
accountAggregation?: Schema$AccountAggregation;
|
|
202
|
+
/**
|
|
203
|
+
* Service type for account management. Enables the provider to perform administrative actions on the merchant's account, such as configuring account settings, managing users, or updating business information.
|
|
204
|
+
*/
|
|
205
|
+
accountManagement?: Schema$AccountManagement;
|
|
206
|
+
/**
|
|
207
|
+
* Service type for managing advertising campaigns. Grants the provider access to create and manage the merchant's ad campaigns, including setting up campaigns, adjusting bids, and optimizing performance.
|
|
208
|
+
*/
|
|
209
|
+
campaignsManagement?: Schema$CampaignsManagement;
|
|
210
|
+
/**
|
|
211
|
+
* Immutable. An optional, immutable identifier that Google uses to refer to this account when communicating with the provider. This should be the unique account ID within the provider's system (for example, your shop ID in Shopify). If you have multiple accounts with the same provider - for instance, different accounts for various regions — the `external_account_id` differentiates between them, ensuring accurate linking and integration between Google and the provider.
|
|
212
|
+
*/
|
|
213
|
+
externalAccountId?: string | null;
|
|
214
|
+
/**
|
|
215
|
+
* Output only. Information about the state of the service in terms of establishing it (e.g. is it pending approval or approved).
|
|
216
|
+
*/
|
|
217
|
+
handshake?: Schema$Handshake;
|
|
218
|
+
/**
|
|
219
|
+
* Output only. Whether the service is mutable (e.g. through Approve / Reject RPCs). A service that was created through another system or API might be immutable.
|
|
220
|
+
*/
|
|
221
|
+
mutability?: string | null;
|
|
222
|
+
/**
|
|
223
|
+
* Identifier. The resource name of the account service.
|
|
224
|
+
*/
|
|
225
|
+
name?: string | null;
|
|
226
|
+
/**
|
|
227
|
+
* Service type for managing products. This allows the provider to handle product data on behalf of the merchant, including reading and writing product listings. It's commonly used when the provider offers inventory management or catalog synchronization services to keep the merchant's product information up-to-date across platforms.
|
|
228
|
+
*/
|
|
229
|
+
productsManagement?: Schema$ProductsManagement;
|
|
230
|
+
/**
|
|
231
|
+
* Output only. 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`).
|
|
232
|
+
*/
|
|
233
|
+
provider?: string | null;
|
|
234
|
+
/**
|
|
235
|
+
* Output only. The human-readable display name of the provider account.
|
|
236
|
+
*/
|
|
237
|
+
providerDisplayName?: string | null;
|
|
238
|
+
}
|
|
159
239
|
/**
|
|
160
240
|
* Additional instructions to add account services during creation of the account.
|
|
161
241
|
*/
|
|
@@ -207,6 +287,11 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
207
287
|
*/
|
|
208
288
|
userId?: string | null;
|
|
209
289
|
}
|
|
290
|
+
/**
|
|
291
|
+
* Request to approve an account service.
|
|
292
|
+
*/
|
|
293
|
+
export interface Schema$ApproveAccountServiceRequest {
|
|
294
|
+
}
|
|
210
295
|
/**
|
|
211
296
|
* Collection of information related to the [autofeed](https://support.google.com/merchants/answer/7538732) settings.
|
|
212
297
|
*/
|
|
@@ -363,6 +448,11 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
363
448
|
*/
|
|
364
449
|
phoneVerificationState?: string | null;
|
|
365
450
|
}
|
|
451
|
+
/**
|
|
452
|
+
* `CampaignManagement` payload.
|
|
453
|
+
*/
|
|
454
|
+
export interface Schema$CampaignsManagement {
|
|
455
|
+
}
|
|
366
456
|
/**
|
|
367
457
|
* 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.
|
|
368
458
|
*/
|
|
@@ -598,6 +688,19 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
598
688
|
*/
|
|
599
689
|
geotargetCriteriaIds?: string[] | null;
|
|
600
690
|
}
|
|
691
|
+
/**
|
|
692
|
+
* The current status of establishing of the service. (for example, pending approval or approved).
|
|
693
|
+
*/
|
|
694
|
+
export interface Schema$Handshake {
|
|
695
|
+
/**
|
|
696
|
+
* Output only. The most recent account to modify the account service's `approval_status`.
|
|
697
|
+
*/
|
|
698
|
+
actor?: string | null;
|
|
699
|
+
/**
|
|
700
|
+
* Output only. The approval state of this handshake.
|
|
701
|
+
*/
|
|
702
|
+
approvalState?: string | null;
|
|
703
|
+
}
|
|
601
704
|
/**
|
|
602
705
|
* A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set.
|
|
603
706
|
*/
|
|
@@ -718,6 +821,32 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
718
821
|
*/
|
|
719
822
|
nextPageToken?: string | null;
|
|
720
823
|
}
|
|
824
|
+
/**
|
|
825
|
+
* Response after trying to list account relationships.
|
|
826
|
+
*/
|
|
827
|
+
export interface Schema$ListAccountRelationshipsResponse {
|
|
828
|
+
/**
|
|
829
|
+
* The account relationships that match your filter.
|
|
830
|
+
*/
|
|
831
|
+
accountRelationships?: Schema$AccountRelationship[];
|
|
832
|
+
/**
|
|
833
|
+
* A page token. You can send the `page_token` to get the next page. Only included in the `list` response if there are more pages.
|
|
834
|
+
*/
|
|
835
|
+
nextPageToken?: string | null;
|
|
836
|
+
}
|
|
837
|
+
/**
|
|
838
|
+
* Response after trying to list account services.
|
|
839
|
+
*/
|
|
840
|
+
export interface Schema$ListAccountServicesResponse {
|
|
841
|
+
/**
|
|
842
|
+
* The account services that match your filter.
|
|
843
|
+
*/
|
|
844
|
+
accountServices?: Schema$AccountService[];
|
|
845
|
+
/**
|
|
846
|
+
* A page token. You can send the `page_token` to get the next page. Only included in the `list` response if there are more pages.
|
|
847
|
+
*/
|
|
848
|
+
nextPageToken?: string | null;
|
|
849
|
+
}
|
|
721
850
|
/**
|
|
722
851
|
* Response message for the `ListAccounts` method.
|
|
723
852
|
*/
|
|
@@ -854,11 +983,11 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
854
983
|
*/
|
|
855
984
|
export interface Schema$OnlineReturnPolicy {
|
|
856
985
|
/**
|
|
857
|
-
* This field specifies if merchant only accepts defective products for returns
|
|
986
|
+
* Optional. This field specifies if merchant only accepts defective products for returns.
|
|
858
987
|
*/
|
|
859
988
|
acceptDefectiveOnly?: boolean | null;
|
|
860
989
|
/**
|
|
861
|
-
* This field specifies if merchant allows customers to exchange products
|
|
990
|
+
* Optional. This field specifies if merchant allows customers to exchange products.
|
|
862
991
|
*/
|
|
863
992
|
acceptExchange?: boolean | null;
|
|
864
993
|
/**
|
|
@@ -882,13 +1011,17 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
882
1011
|
*/
|
|
883
1012
|
policy?: Schema$Policy;
|
|
884
1013
|
/**
|
|
885
|
-
* The field specifies the number of days it takes for merchants to process refunds
|
|
1014
|
+
* Optional. The field specifies the number of days it takes for merchants to process refunds.
|
|
886
1015
|
*/
|
|
887
1016
|
processRefundDays?: number | null;
|
|
888
1017
|
/**
|
|
889
1018
|
* Optional. The restocking fee that applies to all return reason categories. This would be treated as a free restocking fee if the value is not set.
|
|
890
1019
|
*/
|
|
891
1020
|
restockingFee?: Schema$RestockingFee;
|
|
1021
|
+
/**
|
|
1022
|
+
* Optional. The field specifies the return label source.
|
|
1023
|
+
*/
|
|
1024
|
+
returnLabelSource?: string | null;
|
|
892
1025
|
/**
|
|
893
1026
|
* Optional. The return methods of how customers can return an item. This value is required to not be empty unless the type of return policy is noReturns.
|
|
894
1027
|
*/
|
|
@@ -941,15 +1074,15 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
941
1074
|
type?: string | null;
|
|
942
1075
|
}
|
|
943
1076
|
/**
|
|
944
|
-
* Represents a postal address
|
|
1077
|
+
* 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 or 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.
|
|
945
1078
|
*/
|
|
946
1079
|
export interface Schema$PostalAddress {
|
|
947
1080
|
/**
|
|
948
|
-
* 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 (
|
|
1081
|
+
* 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 or 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). In 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).
|
|
949
1082
|
*/
|
|
950
1083
|
addressLines?: string[] | null;
|
|
951
1084
|
/**
|
|
952
|
-
* 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.
|
|
1085
|
+
* 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. 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.
|
|
953
1086
|
*/
|
|
954
1087
|
administrativeArea?: string | null;
|
|
955
1088
|
/**
|
|
@@ -957,7 +1090,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
957
1090
|
*/
|
|
958
1091
|
languageCode?: string | null;
|
|
959
1092
|
/**
|
|
960
|
-
* Optional. Generally refers to the city
|
|
1093
|
+
* Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
|
|
961
1094
|
*/
|
|
962
1095
|
locality?: string | null;
|
|
963
1096
|
/**
|
|
@@ -965,7 +1098,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
965
1098
|
*/
|
|
966
1099
|
organization?: string | null;
|
|
967
1100
|
/**
|
|
968
|
-
* 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 (
|
|
1101
|
+
* 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 or zip code validation in the United States).
|
|
969
1102
|
*/
|
|
970
1103
|
postalCode?: string | null;
|
|
971
1104
|
/**
|
|
@@ -981,11 +1114,11 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
981
1114
|
*/
|
|
982
1115
|
revision?: number | null;
|
|
983
1116
|
/**
|
|
984
|
-
* 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 (
|
|
1117
|
+
* 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" (Côte d'Ivoire).
|
|
985
1118
|
*/
|
|
986
1119
|
sortingCode?: string | null;
|
|
987
1120
|
/**
|
|
988
|
-
* Optional. Sublocality of the address. For example, this can be
|
|
1121
|
+
* Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
|
|
989
1122
|
*/
|
|
990
1123
|
sublocality?: string | null;
|
|
991
1124
|
}
|
|
@@ -1049,6 +1182,11 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1049
1182
|
*/
|
|
1050
1183
|
reportingContext?: string | null;
|
|
1051
1184
|
}
|
|
1185
|
+
/**
|
|
1186
|
+
* `ProductsManagement` payload.
|
|
1187
|
+
*/
|
|
1188
|
+
export interface Schema$ProductsManagement {
|
|
1189
|
+
}
|
|
1052
1190
|
/**
|
|
1053
1191
|
* The message that the merchant will receive to notify about product status change event
|
|
1054
1192
|
*/
|
|
@@ -1115,6 +1253,19 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1115
1253
|
*/
|
|
1116
1254
|
unmetRequirements?: Schema$Requirement[];
|
|
1117
1255
|
}
|
|
1256
|
+
/**
|
|
1257
|
+
* Request to propose an account service.
|
|
1258
|
+
*/
|
|
1259
|
+
export interface Schema$ProposeAccountServiceRequest {
|
|
1260
|
+
/**
|
|
1261
|
+
* Required. The account service to propose.
|
|
1262
|
+
*/
|
|
1263
|
+
accountService?: Schema$AccountService;
|
|
1264
|
+
/**
|
|
1265
|
+
* 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`).
|
|
1266
|
+
*/
|
|
1267
|
+
provider?: string | null;
|
|
1268
|
+
}
|
|
1118
1269
|
/**
|
|
1119
1270
|
* Shipping rate group definitions. Only the last one is allowed to have an empty `applicable_shipping_labels`, which means "everything else". The other `applicable_shipping_labels` must not overlap.
|
|
1120
1271
|
*/
|
|
@@ -1173,16 +1324,21 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1173
1324
|
*/
|
|
1174
1325
|
shippingEligible?: boolean | null;
|
|
1175
1326
|
}
|
|
1327
|
+
/**
|
|
1328
|
+
* Request to reject an account service.
|
|
1329
|
+
*/
|
|
1330
|
+
export interface Schema$RejectAccountServiceRequest {
|
|
1331
|
+
}
|
|
1176
1332
|
/**
|
|
1177
1333
|
* Describes the terms of service which are required to be accepted.
|
|
1178
1334
|
*/
|
|
1179
1335
|
export interface Schema$Required {
|
|
1180
1336
|
/**
|
|
1181
|
-
* The
|
|
1337
|
+
* The `TermsOfService` that need to be accepted.
|
|
1182
1338
|
*/
|
|
1183
1339
|
termsOfService?: string | null;
|
|
1184
1340
|
/**
|
|
1185
|
-
* Full URL to the terms of service file. This field is the same as
|
|
1341
|
+
* Full URL to the terms of service file. This field is the same as `TermsOfService.file_uri`, it is added here for convenience only.
|
|
1186
1342
|
*/
|
|
1187
1343
|
tosFileUri?: string | null;
|
|
1188
1344
|
}
|
|
@@ -1269,7 +1425,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1269
1425
|
*/
|
|
1270
1426
|
active?: boolean | null;
|
|
1271
1427
|
/**
|
|
1272
|
-
* The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
|
|
1428
|
+
* Required. The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
|
|
1273
1429
|
*/
|
|
1274
1430
|
currencyCode?: string | null;
|
|
1275
1431
|
/**
|
|
@@ -1310,7 +1466,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1310
1466
|
storeConfig?: Schema$StoreConfig;
|
|
1311
1467
|
}
|
|
1312
1468
|
/**
|
|
1313
|
-
* The merchant account's [shipping
|
|
1469
|
+
* The merchant account's [shipping settings](https://support.google.com/merchants/answer/6069284).
|
|
1314
1470
|
*/
|
|
1315
1471
|
export interface Schema$ShippingSettings {
|
|
1316
1472
|
/**
|
|
@@ -1318,7 +1474,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1318
1474
|
*/
|
|
1319
1475
|
etag?: string | null;
|
|
1320
1476
|
/**
|
|
1321
|
-
* Identifier. The resource name of the shipping
|
|
1477
|
+
* Identifier. The resource name of the shipping settings. Format: `accounts/{account\}/shippingSettings`
|
|
1322
1478
|
*/
|
|
1323
1479
|
name?: string | null;
|
|
1324
1480
|
/**
|
|
@@ -1399,7 +1555,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1399
1555
|
rows?: Schema$Row[];
|
|
1400
1556
|
}
|
|
1401
1557
|
/**
|
|
1402
|
-
* The `TermsOfService` message represents a specific version of the terms of service that merchants must accept to access certain features or services
|
|
1558
|
+
* The `TermsOfService` message represents a specific version of the terms of service that merchants must accept to access certain features or services. For more information, see [Terms of Service](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`.
|
|
1403
1559
|
*/
|
|
1404
1560
|
export interface Schema$TermsOfService {
|
|
1405
1561
|
/**
|
|
@@ -1424,7 +1580,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1424
1580
|
regionCode?: string | null;
|
|
1425
1581
|
}
|
|
1426
1582
|
/**
|
|
1427
|
-
* This resource represents the agreement state for a given account and terms of service kind. The state is as follows: * If the merchant has accepted a terms of service
|
|
1583
|
+
* This resource represents the agreement state for a given account and terms of service kind. The state is as follows: * If the merchant has accepted a terms of service, `accepted` will be populated, otherwise it will be empty * If the merchant must sign a terms of service, `required` will be populated, otherwise it will be empty. Note that both `required` and `accepted` can be present. In this case the `accepted` terms of services will have an expiration date set in the `valid_until` field. The `required` terms of services need to be accepted before `valid_until` in order for the account to continue having a valid agreement. When accepting new terms of services we expect 3Ps to display the text associated with the given terms of service agreement (the url to the file containing the text is added in the Required message below as `tos_file_uri`). The actual acceptance of the terms of service is done by calling accept on the `TermsOfService` resource.
|
|
1428
1584
|
*/
|
|
1429
1585
|
export interface Schema$TermsOfServiceAgreementState {
|
|
1430
1586
|
/**
|
|
@@ -1618,6 +1774,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1618
1774
|
export class Resource$Accounts {
|
|
1619
1775
|
context: APIRequestContext;
|
|
1620
1776
|
autofeedSettings: Resource$Accounts$Autofeedsettings;
|
|
1777
|
+
automaticImprovements: Resource$Accounts$Automaticimprovements;
|
|
1621
1778
|
businessIdentity: Resource$Accounts$Businessidentity;
|
|
1622
1779
|
businessInfo: Resource$Accounts$Businessinfo;
|
|
1623
1780
|
emailPreferences: Resource$Accounts$Emailpreferences;
|
|
@@ -1626,12 +1783,14 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1626
1783
|
onlineReturnPolicies: Resource$Accounts$Onlinereturnpolicies;
|
|
1627
1784
|
programs: Resource$Accounts$Programs;
|
|
1628
1785
|
regions: Resource$Accounts$Regions;
|
|
1786
|
+
relationships: Resource$Accounts$Relationships;
|
|
1787
|
+
services: Resource$Accounts$Services;
|
|
1629
1788
|
shippingSettings: Resource$Accounts$Shippingsettings;
|
|
1630
1789
|
termsOfServiceAgreementStates: Resource$Accounts$Termsofserviceagreementstates;
|
|
1631
1790
|
users: Resource$Accounts$Users;
|
|
1632
1791
|
constructor(context: APIRequestContext);
|
|
1633
1792
|
/**
|
|
1634
|
-
* Creates a
|
|
1793
|
+
* Creates a Merchant Center account with additional configuration. Adds the user that makes the request as an admin for the new account.
|
|
1635
1794
|
*
|
|
1636
1795
|
* @param params - Parameters for request
|
|
1637
1796
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1672,20 +1831,6 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1672
1831
|
get(params: Params$Resource$Accounts$Get, options: MethodOptions | BodyResponseCallback<Schema$Account>, callback: BodyResponseCallback<Schema$Account>): void;
|
|
1673
1832
|
get(params: Params$Resource$Accounts$Get, callback: BodyResponseCallback<Schema$Account>): void;
|
|
1674
1833
|
get(callback: BodyResponseCallback<Schema$Account>): void;
|
|
1675
|
-
/**
|
|
1676
|
-
* Retrieves the automatic improvements of an account.
|
|
1677
|
-
*
|
|
1678
|
-
* @param params - Parameters for request
|
|
1679
|
-
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
1680
|
-
* @param callback - Optional callback that handles the response.
|
|
1681
|
-
* @returns A promise if used with async/await, or void if used with a callback.
|
|
1682
|
-
*/
|
|
1683
|
-
getAutomaticImprovements(params: Params$Resource$Accounts$Getautomaticimprovements, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
1684
|
-
getAutomaticImprovements(params?: Params$Resource$Accounts$Getautomaticimprovements, options?: MethodOptions): GaxiosPromise<Schema$AutomaticImprovements>;
|
|
1685
|
-
getAutomaticImprovements(params: Params$Resource$Accounts$Getautomaticimprovements, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
1686
|
-
getAutomaticImprovements(params: Params$Resource$Accounts$Getautomaticimprovements, options: MethodOptions | BodyResponseCallback<Schema$AutomaticImprovements>, callback: BodyResponseCallback<Schema$AutomaticImprovements>): void;
|
|
1687
|
-
getAutomaticImprovements(params: Params$Resource$Accounts$Getautomaticimprovements, callback: BodyResponseCallback<Schema$AutomaticImprovements>): void;
|
|
1688
|
-
getAutomaticImprovements(callback: BodyResponseCallback<Schema$AutomaticImprovements>): void;
|
|
1689
1834
|
/**
|
|
1690
1835
|
* Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on. If no filter is provided, then it returns all the accounts the user has access to. This method is eventually consistent, meaning changes such as creating, updating an account or a change of relationships between accounts may not show up in the results immediately. Instead, these changes propagate over a short period, after which the updated information can match the associated predicates. That means, that searching by account name might not return a recently changed account even though it satisfies the predicate.
|
|
1691
1836
|
*
|
|
@@ -1728,20 +1873,6 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1728
1873
|
patch(params: Params$Resource$Accounts$Patch, options: MethodOptions | BodyResponseCallback<Schema$Account>, callback: BodyResponseCallback<Schema$Account>): void;
|
|
1729
1874
|
patch(params: Params$Resource$Accounts$Patch, callback: BodyResponseCallback<Schema$Account>): void;
|
|
1730
1875
|
patch(callback: BodyResponseCallback<Schema$Account>): void;
|
|
1731
|
-
/**
|
|
1732
|
-
* Updates the automatic improvements of an account.
|
|
1733
|
-
*
|
|
1734
|
-
* @param params - Parameters for request
|
|
1735
|
-
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
1736
|
-
* @param callback - Optional callback that handles the response.
|
|
1737
|
-
* @returns A promise if used with async/await, or void if used with a callback.
|
|
1738
|
-
*/
|
|
1739
|
-
updateAutomaticImprovements(params: Params$Resource$Accounts$Updateautomaticimprovements, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
1740
|
-
updateAutomaticImprovements(params?: Params$Resource$Accounts$Updateautomaticimprovements, options?: MethodOptions): GaxiosPromise<Schema$AutomaticImprovements>;
|
|
1741
|
-
updateAutomaticImprovements(params: Params$Resource$Accounts$Updateautomaticimprovements, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
1742
|
-
updateAutomaticImprovements(params: Params$Resource$Accounts$Updateautomaticimprovements, options: MethodOptions | BodyResponseCallback<Schema$AutomaticImprovements>, callback: BodyResponseCallback<Schema$AutomaticImprovements>): void;
|
|
1743
|
-
updateAutomaticImprovements(params: Params$Resource$Accounts$Updateautomaticimprovements, callback: BodyResponseCallback<Schema$AutomaticImprovements>): void;
|
|
1744
|
-
updateAutomaticImprovements(callback: BodyResponseCallback<Schema$AutomaticImprovements>): void;
|
|
1745
1876
|
}
|
|
1746
1877
|
export interface Params$Resource$Accounts$Createandconfigure extends StandardParameters {
|
|
1747
1878
|
/**
|
|
@@ -1765,12 +1896,6 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1765
1896
|
*/
|
|
1766
1897
|
name?: string;
|
|
1767
1898
|
}
|
|
1768
|
-
export interface Params$Resource$Accounts$Getautomaticimprovements extends StandardParameters {
|
|
1769
|
-
/**
|
|
1770
|
-
* Required. The resource name of the automatic improvements. Format: `accounts/{account\}/automaticImprovements`
|
|
1771
|
-
*/
|
|
1772
|
-
name?: string;
|
|
1773
|
-
}
|
|
1774
1899
|
export interface Params$Resource$Accounts$List extends StandardParameters {
|
|
1775
1900
|
/**
|
|
1776
1901
|
* Optional. Returns only accounts that match the [filter](https://developers.google.com/merchant/api/guides/accounts/filter). For more details, see the [filter syntax reference](https://developers.google.com/merchant/api/guides/accounts/filter-syntax).
|
|
@@ -1795,7 +1920,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1795
1920
|
*/
|
|
1796
1921
|
pageToken?: string;
|
|
1797
1922
|
/**
|
|
1798
|
-
* Required. The aggregation service provider. Format: `
|
|
1923
|
+
* Required. The aggregation service provider. Format: `accounts/{accountId\}`
|
|
1799
1924
|
*/
|
|
1800
1925
|
provider?: string;
|
|
1801
1926
|
}
|
|
@@ -1813,20 +1938,6 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1813
1938
|
*/
|
|
1814
1939
|
requestBody?: Schema$Account;
|
|
1815
1940
|
}
|
|
1816
|
-
export interface Params$Resource$Accounts$Updateautomaticimprovements extends StandardParameters {
|
|
1817
|
-
/**
|
|
1818
|
-
* Identifier. The resource name of the automatic improvements. Format: `accounts/{account\}/automaticImprovements`.
|
|
1819
|
-
*/
|
|
1820
|
-
name?: string;
|
|
1821
|
-
/**
|
|
1822
|
-
* Required. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `item_updates` - `item_updates.account_level_settings` - `image_improvements` - `image_improvements.account_level_settings` - `shipping_improvements` - `shipping_improvements.allow_shipping_improvements`
|
|
1823
|
-
*/
|
|
1824
|
-
updateMask?: string;
|
|
1825
|
-
/**
|
|
1826
|
-
* Request body metadata
|
|
1827
|
-
*/
|
|
1828
|
-
requestBody?: Schema$AutomaticImprovements;
|
|
1829
|
-
}
|
|
1830
1941
|
export class Resource$Accounts$Autofeedsettings {
|
|
1831
1942
|
context: APIRequestContext;
|
|
1832
1943
|
constructor(context: APIRequestContext);
|
|
@@ -1879,6 +1990,58 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
1879
1990
|
*/
|
|
1880
1991
|
requestBody?: Schema$AutofeedSettings;
|
|
1881
1992
|
}
|
|
1993
|
+
export class Resource$Accounts$Automaticimprovements {
|
|
1994
|
+
context: APIRequestContext;
|
|
1995
|
+
constructor(context: APIRequestContext);
|
|
1996
|
+
/**
|
|
1997
|
+
* Retrieves the automatic improvements of an account.
|
|
1998
|
+
*
|
|
1999
|
+
* @param params - Parameters for request
|
|
2000
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2001
|
+
* @param callback - Optional callback that handles the response.
|
|
2002
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2003
|
+
*/
|
|
2004
|
+
getAutomaticImprovements(params: Params$Resource$Accounts$Automaticimprovements$Getautomaticimprovements, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
2005
|
+
getAutomaticImprovements(params?: Params$Resource$Accounts$Automaticimprovements$Getautomaticimprovements, options?: MethodOptions): GaxiosPromise<Schema$AutomaticImprovements>;
|
|
2006
|
+
getAutomaticImprovements(params: Params$Resource$Accounts$Automaticimprovements$Getautomaticimprovements, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2007
|
+
getAutomaticImprovements(params: Params$Resource$Accounts$Automaticimprovements$Getautomaticimprovements, options: MethodOptions | BodyResponseCallback<Schema$AutomaticImprovements>, callback: BodyResponseCallback<Schema$AutomaticImprovements>): void;
|
|
2008
|
+
getAutomaticImprovements(params: Params$Resource$Accounts$Automaticimprovements$Getautomaticimprovements, callback: BodyResponseCallback<Schema$AutomaticImprovements>): void;
|
|
2009
|
+
getAutomaticImprovements(callback: BodyResponseCallback<Schema$AutomaticImprovements>): void;
|
|
2010
|
+
/**
|
|
2011
|
+
* Updates the automatic improvements of an account.
|
|
2012
|
+
*
|
|
2013
|
+
* @param params - Parameters for request
|
|
2014
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2015
|
+
* @param callback - Optional callback that handles the response.
|
|
2016
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2017
|
+
*/
|
|
2018
|
+
updateAutomaticImprovements(params: Params$Resource$Accounts$Automaticimprovements$Updateautomaticimprovements, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
2019
|
+
updateAutomaticImprovements(params?: Params$Resource$Accounts$Automaticimprovements$Updateautomaticimprovements, options?: MethodOptions): GaxiosPromise<Schema$AutomaticImprovements>;
|
|
2020
|
+
updateAutomaticImprovements(params: Params$Resource$Accounts$Automaticimprovements$Updateautomaticimprovements, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2021
|
+
updateAutomaticImprovements(params: Params$Resource$Accounts$Automaticimprovements$Updateautomaticimprovements, options: MethodOptions | BodyResponseCallback<Schema$AutomaticImprovements>, callback: BodyResponseCallback<Schema$AutomaticImprovements>): void;
|
|
2022
|
+
updateAutomaticImprovements(params: Params$Resource$Accounts$Automaticimprovements$Updateautomaticimprovements, callback: BodyResponseCallback<Schema$AutomaticImprovements>): void;
|
|
2023
|
+
updateAutomaticImprovements(callback: BodyResponseCallback<Schema$AutomaticImprovements>): void;
|
|
2024
|
+
}
|
|
2025
|
+
export interface Params$Resource$Accounts$Automaticimprovements$Getautomaticimprovements extends StandardParameters {
|
|
2026
|
+
/**
|
|
2027
|
+
* Required. The resource name of the automatic improvements. Format: `accounts/{account\}/automaticImprovements`
|
|
2028
|
+
*/
|
|
2029
|
+
name?: string;
|
|
2030
|
+
}
|
|
2031
|
+
export interface Params$Resource$Accounts$Automaticimprovements$Updateautomaticimprovements extends StandardParameters {
|
|
2032
|
+
/**
|
|
2033
|
+
* Identifier. The resource name of the automatic improvements. Format: `accounts/{account\}/automaticImprovements`.
|
|
2034
|
+
*/
|
|
2035
|
+
name?: string;
|
|
2036
|
+
/**
|
|
2037
|
+
* Required. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `item_updates` - `item_updates.account_level_settings` - `image_improvements` - `image_improvements.account_level_settings` - `shipping_improvements` - `shipping_improvements.allow_shipping_improvements`
|
|
2038
|
+
*/
|
|
2039
|
+
updateMask?: string;
|
|
2040
|
+
/**
|
|
2041
|
+
* Request body metadata
|
|
2042
|
+
*/
|
|
2043
|
+
requestBody?: Schema$AutomaticImprovements;
|
|
2044
|
+
}
|
|
1882
2045
|
export class Resource$Accounts$Businessidentity {
|
|
1883
2046
|
context: APIRequestContext;
|
|
1884
2047
|
constructor(context: APIRequestContext);
|
|
@@ -2139,7 +2302,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
2139
2302
|
context: APIRequestContext;
|
|
2140
2303
|
constructor(context: APIRequestContext);
|
|
2141
2304
|
/**
|
|
2142
|
-
* Lists all account issues of a Merchant Center account.
|
|
2305
|
+
* Lists all account issues of a Merchant Center account. When called on a multi-client account, this method only returns issues belonging to that account, not its sub-accounts. To retrieve issues for sub-accounts, you must first call the accounts.listSubaccounts method to obtain a list of sub-accounts, and then call `accounts.issues.list` for each sub-account individually.
|
|
2143
2306
|
*
|
|
2144
2307
|
* @param params - Parameters for request
|
|
2145
2308
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -2159,7 +2322,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
2159
2322
|
*/
|
|
2160
2323
|
languageCode?: string;
|
|
2161
2324
|
/**
|
|
2162
|
-
* Optional. The maximum number of issues to return. The service may return fewer than this value. If unspecified, at most 50
|
|
2325
|
+
* Optional. The maximum number of issues to return. The service may return fewer than this value. If unspecified, at most 50 issues will be returned. The maximum value is 100; values above 100 will be coerced to 100
|
|
2163
2326
|
*/
|
|
2164
2327
|
pageSize?: number;
|
|
2165
2328
|
/**
|
|
@@ -2455,6 +2618,210 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
2455
2618
|
*/
|
|
2456
2619
|
requestBody?: Schema$Region;
|
|
2457
2620
|
}
|
|
2621
|
+
export class Resource$Accounts$Relationships {
|
|
2622
|
+
context: APIRequestContext;
|
|
2623
|
+
constructor(context: APIRequestContext);
|
|
2624
|
+
/**
|
|
2625
|
+
* Retrieve an account relationship.
|
|
2626
|
+
*
|
|
2627
|
+
* @param params - Parameters for request
|
|
2628
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2629
|
+
* @param callback - Optional callback that handles the response.
|
|
2630
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2631
|
+
*/
|
|
2632
|
+
get(params: Params$Resource$Accounts$Relationships$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
2633
|
+
get(params?: Params$Resource$Accounts$Relationships$Get, options?: MethodOptions): GaxiosPromise<Schema$AccountRelationship>;
|
|
2634
|
+
get(params: Params$Resource$Accounts$Relationships$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2635
|
+
get(params: Params$Resource$Accounts$Relationships$Get, options: MethodOptions | BodyResponseCallback<Schema$AccountRelationship>, callback: BodyResponseCallback<Schema$AccountRelationship>): void;
|
|
2636
|
+
get(params: Params$Resource$Accounts$Relationships$Get, callback: BodyResponseCallback<Schema$AccountRelationship>): void;
|
|
2637
|
+
get(callback: BodyResponseCallback<Schema$AccountRelationship>): void;
|
|
2638
|
+
/**
|
|
2639
|
+
* List account relationships for the specified account.
|
|
2640
|
+
*
|
|
2641
|
+
* @param params - Parameters for request
|
|
2642
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2643
|
+
* @param callback - Optional callback that handles the response.
|
|
2644
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2645
|
+
*/
|
|
2646
|
+
list(params: Params$Resource$Accounts$Relationships$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
2647
|
+
list(params?: Params$Resource$Accounts$Relationships$List, options?: MethodOptions): GaxiosPromise<Schema$ListAccountRelationshipsResponse>;
|
|
2648
|
+
list(params: Params$Resource$Accounts$Relationships$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2649
|
+
list(params: Params$Resource$Accounts$Relationships$List, options: MethodOptions | BodyResponseCallback<Schema$ListAccountRelationshipsResponse>, callback: BodyResponseCallback<Schema$ListAccountRelationshipsResponse>): void;
|
|
2650
|
+
list(params: Params$Resource$Accounts$Relationships$List, callback: BodyResponseCallback<Schema$ListAccountRelationshipsResponse>): void;
|
|
2651
|
+
list(callback: BodyResponseCallback<Schema$ListAccountRelationshipsResponse>): void;
|
|
2652
|
+
/**
|
|
2653
|
+
* Updates the account relationship. Executing this method requires admin access.
|
|
2654
|
+
*
|
|
2655
|
+
* @param params - Parameters for request
|
|
2656
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2657
|
+
* @param callback - Optional callback that handles the response.
|
|
2658
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2659
|
+
*/
|
|
2660
|
+
patch(params: Params$Resource$Accounts$Relationships$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
2661
|
+
patch(params?: Params$Resource$Accounts$Relationships$Patch, options?: MethodOptions): GaxiosPromise<Schema$AccountRelationship>;
|
|
2662
|
+
patch(params: Params$Resource$Accounts$Relationships$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2663
|
+
patch(params: Params$Resource$Accounts$Relationships$Patch, options: MethodOptions | BodyResponseCallback<Schema$AccountRelationship>, callback: BodyResponseCallback<Schema$AccountRelationship>): void;
|
|
2664
|
+
patch(params: Params$Resource$Accounts$Relationships$Patch, callback: BodyResponseCallback<Schema$AccountRelationship>): void;
|
|
2665
|
+
patch(callback: BodyResponseCallback<Schema$AccountRelationship>): void;
|
|
2666
|
+
}
|
|
2667
|
+
export interface Params$Resource$Accounts$Relationships$Get extends StandardParameters {
|
|
2668
|
+
/**
|
|
2669
|
+
* Required. The resource name of the account relationship to get.
|
|
2670
|
+
*/
|
|
2671
|
+
name?: string;
|
|
2672
|
+
}
|
|
2673
|
+
export interface Params$Resource$Accounts$Relationships$List extends StandardParameters {
|
|
2674
|
+
/**
|
|
2675
|
+
* Optional. The maximum number of elements to return in the response. Use for paging. If no `page_size` is specified, `100` is used as the default value. The maximum allowed value is `1000`.
|
|
2676
|
+
*/
|
|
2677
|
+
pageSize?: number;
|
|
2678
|
+
/**
|
|
2679
|
+
* Optional. The token returned by the previous `list` request.
|
|
2680
|
+
*/
|
|
2681
|
+
pageToken?: string;
|
|
2682
|
+
/**
|
|
2683
|
+
* Required. The parent account of the account relationship to filter by.
|
|
2684
|
+
*/
|
|
2685
|
+
parent?: string;
|
|
2686
|
+
}
|
|
2687
|
+
export interface Params$Resource$Accounts$Relationships$Patch extends StandardParameters {
|
|
2688
|
+
/**
|
|
2689
|
+
* Identifier. The resource name of the account relationship.
|
|
2690
|
+
*/
|
|
2691
|
+
name?: string;
|
|
2692
|
+
/**
|
|
2693
|
+
* Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `account_id_alias`
|
|
2694
|
+
*/
|
|
2695
|
+
updateMask?: string;
|
|
2696
|
+
/**
|
|
2697
|
+
* Request body metadata
|
|
2698
|
+
*/
|
|
2699
|
+
requestBody?: Schema$AccountRelationship;
|
|
2700
|
+
}
|
|
2701
|
+
export class Resource$Accounts$Services {
|
|
2702
|
+
context: APIRequestContext;
|
|
2703
|
+
constructor(context: APIRequestContext);
|
|
2704
|
+
/**
|
|
2705
|
+
* Approve an account service proposal.
|
|
2706
|
+
*
|
|
2707
|
+
* @param params - Parameters for request
|
|
2708
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2709
|
+
* @param callback - Optional callback that handles the response.
|
|
2710
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2711
|
+
*/
|
|
2712
|
+
approve(params: Params$Resource$Accounts$Services$Approve, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
2713
|
+
approve(params?: Params$Resource$Accounts$Services$Approve, options?: MethodOptions): GaxiosPromise<Schema$AccountService>;
|
|
2714
|
+
approve(params: Params$Resource$Accounts$Services$Approve, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2715
|
+
approve(params: Params$Resource$Accounts$Services$Approve, options: MethodOptions | BodyResponseCallback<Schema$AccountService>, callback: BodyResponseCallback<Schema$AccountService>): void;
|
|
2716
|
+
approve(params: Params$Resource$Accounts$Services$Approve, callback: BodyResponseCallback<Schema$AccountService>): void;
|
|
2717
|
+
approve(callback: BodyResponseCallback<Schema$AccountService>): void;
|
|
2718
|
+
/**
|
|
2719
|
+
* Retrieve an account service.
|
|
2720
|
+
*
|
|
2721
|
+
* @param params - Parameters for request
|
|
2722
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2723
|
+
* @param callback - Optional callback that handles the response.
|
|
2724
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2725
|
+
*/
|
|
2726
|
+
get(params: Params$Resource$Accounts$Services$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
2727
|
+
get(params?: Params$Resource$Accounts$Services$Get, options?: MethodOptions): GaxiosPromise<Schema$AccountService>;
|
|
2728
|
+
get(params: Params$Resource$Accounts$Services$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2729
|
+
get(params: Params$Resource$Accounts$Services$Get, options: MethodOptions | BodyResponseCallback<Schema$AccountService>, callback: BodyResponseCallback<Schema$AccountService>): void;
|
|
2730
|
+
get(params: Params$Resource$Accounts$Services$Get, callback: BodyResponseCallback<Schema$AccountService>): void;
|
|
2731
|
+
get(callback: BodyResponseCallback<Schema$AccountService>): void;
|
|
2732
|
+
/**
|
|
2733
|
+
* List account services for the specified accounts. Supports filtering.
|
|
2734
|
+
*
|
|
2735
|
+
* @param params - Parameters for request
|
|
2736
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2737
|
+
* @param callback - Optional callback that handles the response.
|
|
2738
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2739
|
+
*/
|
|
2740
|
+
list(params: Params$Resource$Accounts$Services$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
2741
|
+
list(params?: Params$Resource$Accounts$Services$List, options?: MethodOptions): GaxiosPromise<Schema$ListAccountServicesResponse>;
|
|
2742
|
+
list(params: Params$Resource$Accounts$Services$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2743
|
+
list(params: Params$Resource$Accounts$Services$List, options: MethodOptions | BodyResponseCallback<Schema$ListAccountServicesResponse>, callback: BodyResponseCallback<Schema$ListAccountServicesResponse>): void;
|
|
2744
|
+
list(params: Params$Resource$Accounts$Services$List, callback: BodyResponseCallback<Schema$ListAccountServicesResponse>): void;
|
|
2745
|
+
list(callback: BodyResponseCallback<Schema$ListAccountServicesResponse>): void;
|
|
2746
|
+
/**
|
|
2747
|
+
* Propose an account service.
|
|
2748
|
+
*
|
|
2749
|
+
* @param params - Parameters for request
|
|
2750
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2751
|
+
* @param callback - Optional callback that handles the response.
|
|
2752
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2753
|
+
*/
|
|
2754
|
+
propose(params: Params$Resource$Accounts$Services$Propose, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
2755
|
+
propose(params?: Params$Resource$Accounts$Services$Propose, options?: MethodOptions): GaxiosPromise<Schema$AccountService>;
|
|
2756
|
+
propose(params: Params$Resource$Accounts$Services$Propose, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2757
|
+
propose(params: Params$Resource$Accounts$Services$Propose, options: MethodOptions | BodyResponseCallback<Schema$AccountService>, callback: BodyResponseCallback<Schema$AccountService>): void;
|
|
2758
|
+
propose(params: Params$Resource$Accounts$Services$Propose, callback: BodyResponseCallback<Schema$AccountService>): void;
|
|
2759
|
+
propose(callback: BodyResponseCallback<Schema$AccountService>): void;
|
|
2760
|
+
/**
|
|
2761
|
+
* Reject an account service (both proposed and approve services can be rejected).
|
|
2762
|
+
*
|
|
2763
|
+
* @param params - Parameters for request
|
|
2764
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2765
|
+
* @param callback - Optional callback that handles the response.
|
|
2766
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2767
|
+
*/
|
|
2768
|
+
reject(params: Params$Resource$Accounts$Services$Reject, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
2769
|
+
reject(params?: Params$Resource$Accounts$Services$Reject, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
|
|
2770
|
+
reject(params: Params$Resource$Accounts$Services$Reject, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2771
|
+
reject(params: Params$Resource$Accounts$Services$Reject, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
|
|
2772
|
+
reject(params: Params$Resource$Accounts$Services$Reject, callback: BodyResponseCallback<Schema$Empty>): void;
|
|
2773
|
+
reject(callback: BodyResponseCallback<Schema$Empty>): void;
|
|
2774
|
+
}
|
|
2775
|
+
export interface Params$Resource$Accounts$Services$Approve extends StandardParameters {
|
|
2776
|
+
/**
|
|
2777
|
+
* Required. The resource name of the account service to approve.
|
|
2778
|
+
*/
|
|
2779
|
+
name?: string;
|
|
2780
|
+
/**
|
|
2781
|
+
* Request body metadata
|
|
2782
|
+
*/
|
|
2783
|
+
requestBody?: Schema$ApproveAccountServiceRequest;
|
|
2784
|
+
}
|
|
2785
|
+
export interface Params$Resource$Accounts$Services$Get extends StandardParameters {
|
|
2786
|
+
/**
|
|
2787
|
+
* Required. The resource name of the account service to get.
|
|
2788
|
+
*/
|
|
2789
|
+
name?: string;
|
|
2790
|
+
}
|
|
2791
|
+
export interface Params$Resource$Accounts$Services$List extends StandardParameters {
|
|
2792
|
+
/**
|
|
2793
|
+
* Optional. The maximum number of elements to return in the response. Use for paging. If no `page_size` is specified, `100` is used as the default value. The maximum allowed value is `1000`.
|
|
2794
|
+
*/
|
|
2795
|
+
pageSize?: number;
|
|
2796
|
+
/**
|
|
2797
|
+
* Optional. The token returned by the previous `list` request.
|
|
2798
|
+
*/
|
|
2799
|
+
pageToken?: string;
|
|
2800
|
+
/**
|
|
2801
|
+
* Required. The parent account of the account service to filter by.
|
|
2802
|
+
*/
|
|
2803
|
+
parent?: string;
|
|
2804
|
+
}
|
|
2805
|
+
export interface Params$Resource$Accounts$Services$Propose extends StandardParameters {
|
|
2806
|
+
/**
|
|
2807
|
+
* Required. The resource name of the parent account for the service.
|
|
2808
|
+
*/
|
|
2809
|
+
parent?: string;
|
|
2810
|
+
/**
|
|
2811
|
+
* Request body metadata
|
|
2812
|
+
*/
|
|
2813
|
+
requestBody?: Schema$ProposeAccountServiceRequest;
|
|
2814
|
+
}
|
|
2815
|
+
export interface Params$Resource$Accounts$Services$Reject extends StandardParameters {
|
|
2816
|
+
/**
|
|
2817
|
+
* Required. The resource name of the account service to reject.
|
|
2818
|
+
*/
|
|
2819
|
+
name?: string;
|
|
2820
|
+
/**
|
|
2821
|
+
* Request body metadata
|
|
2822
|
+
*/
|
|
2823
|
+
requestBody?: Schema$RejectAccountServiceRequest;
|
|
2824
|
+
}
|
|
2458
2825
|
export class Resource$Accounts$Shippingsettings {
|
|
2459
2826
|
context: APIRequestContext;
|
|
2460
2827
|
constructor(context: APIRequestContext);
|
|
@@ -2489,13 +2856,13 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
2489
2856
|
}
|
|
2490
2857
|
export interface Params$Resource$Accounts$Shippingsettings$Getshippingsettings extends StandardParameters {
|
|
2491
2858
|
/**
|
|
2492
|
-
* Required. The name of the shipping setting to retrieve. Format: `accounts/{account\}/
|
|
2859
|
+
* Required. The name of the shipping setting to retrieve. Format: `accounts/{account\}/shippingsettings`
|
|
2493
2860
|
*/
|
|
2494
2861
|
name?: string;
|
|
2495
2862
|
}
|
|
2496
2863
|
export interface Params$Resource$Accounts$Shippingsettings$Insert extends StandardParameters {
|
|
2497
2864
|
/**
|
|
2498
|
-
* Required. The account
|
|
2865
|
+
* Required. The account for which this shipping setting will be inserted. If you are using an advanced account, you must specify the unique identifier of the sub-account for which you want to insert the shipping setting. Format: `accounts/{ACCOUNT_ID\}`
|
|
2499
2866
|
*/
|
|
2500
2867
|
parent?: string;
|
|
2501
2868
|
/**
|
|
@@ -2537,7 +2904,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
2537
2904
|
}
|
|
2538
2905
|
export interface Params$Resource$Accounts$Termsofserviceagreementstates$Get extends StandardParameters {
|
|
2539
2906
|
/**
|
|
2540
|
-
* Required. The resource name of the terms of service version. Format: `accounts/{account\}/
|
|
2907
|
+
* Required. The resource name of the terms of service version. Format: `accounts/{account\}/termsOfServiceAgreementStates/{identifier\}` The identifier format is: `{TermsOfServiceKind\}-{country\}`
|
|
2541
2908
|
*/
|
|
2542
2909
|
name?: string;
|
|
2543
2910
|
}
|
|
@@ -2687,11 +3054,11 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
2687
3054
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2688
3055
|
*/
|
|
2689
3056
|
accept(params: Params$Resource$Termsofservice$Accept, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
2690
|
-
accept(params?: Params$Resource$Termsofservice$Accept, options?: MethodOptions): GaxiosPromise<Schema$
|
|
3057
|
+
accept(params?: Params$Resource$Termsofservice$Accept, options?: MethodOptions): GaxiosPromise<Schema$AcceptTermsOfServiceResponse>;
|
|
2691
3058
|
accept(params: Params$Resource$Termsofservice$Accept, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2692
|
-
accept(params: Params$Resource$Termsofservice$Accept, options: MethodOptions | BodyResponseCallback<Schema$
|
|
2693
|
-
accept(params: Params$Resource$Termsofservice$Accept, callback: BodyResponseCallback<Schema$
|
|
2694
|
-
accept(callback: BodyResponseCallback<Schema$
|
|
3059
|
+
accept(params: Params$Resource$Termsofservice$Accept, options: MethodOptions | BodyResponseCallback<Schema$AcceptTermsOfServiceResponse>, callback: BodyResponseCallback<Schema$AcceptTermsOfServiceResponse>): void;
|
|
3060
|
+
accept(params: Params$Resource$Termsofservice$Accept, callback: BodyResponseCallback<Schema$AcceptTermsOfServiceResponse>): void;
|
|
3061
|
+
accept(callback: BodyResponseCallback<Schema$AcceptTermsOfServiceResponse>): void;
|
|
2695
3062
|
/**
|
|
2696
3063
|
* Retrieves the `TermsOfService` associated with the provided version.
|
|
2697
3064
|
*
|
|
@@ -2723,7 +3090,7 @@ export declare namespace merchantapi_accounts_v1beta {
|
|
|
2723
3090
|
}
|
|
2724
3091
|
export interface Params$Resource$Termsofservice$Accept extends StandardParameters {
|
|
2725
3092
|
/**
|
|
2726
|
-
* Required. The account for which to accept the ToS.
|
|
3093
|
+
* Required. The account for which to accept the ToS. Format: `accounts/{account\}`
|
|
2727
3094
|
*/
|
|
2728
3095
|
account?: string;
|
|
2729
3096
|
/**
|