@maxim_mazurok/gapi.client.merchantapi-accounts_v1beta 0.0.20251111 → 0.0.20251115
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/index.d.ts +90 -1
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://merchantapi.googleapis.com/$discovery/rest?version=accounts_v1beta
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20251115
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -95,6 +95,8 @@ declare namespace gapi.client {
|
|
|
95
95
|
accountManagement?: any;
|
|
96
96
|
/** Service type for managing advertising campaigns. Grants the provider access to create and manage the business's ad campaigns, including setting up campaigns, adjusting bids, and optimizing performance. */
|
|
97
97
|
campaignsManagement?: any;
|
|
98
|
+
/** Service type for comparison shopping. The provider is a CSS (Comparison Shopping Service) managing the account. See https://support.google.com/merchants/answer/12653197 */
|
|
99
|
+
comparisonShopping?: any;
|
|
98
100
|
/** 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. */
|
|
99
101
|
externalAccountId?: string;
|
|
100
102
|
/** Output only. Information about the state of the service in terms of establishing it (e.g. is it pending approval or approved). */
|
|
@@ -115,6 +117,16 @@ declare namespace gapi.client {
|
|
|
115
117
|
interface AddAccountService {
|
|
116
118
|
/** The provider is an [aggregator](https://support.google.com/merchants/answer/188487) for the account. Payload for service type Account Aggregation. */
|
|
117
119
|
accountAggregation?: any;
|
|
120
|
+
/** The provider manages this account. Payload for service type Account Management. */
|
|
121
|
+
accountManagement?: any;
|
|
122
|
+
/** The provider manages campaigns for this account. Payload for service type campaigns management. */
|
|
123
|
+
campaignsManagement?: any;
|
|
124
|
+
/** The provider is a CSS (Comparison Shopping Service) of this account. Payload for service type Comparison Shopping. */
|
|
125
|
+
comparisonShopping?: any;
|
|
126
|
+
/** 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. The external account ID must be specified for the campaigns management service type. The external account ID must not be specified for the account aggregation service type. The external account ID is optional / may be specified for all other service types. */
|
|
127
|
+
externalAccountId?: string;
|
|
128
|
+
/** The provider manages products for this account. Payload for service type products management. */
|
|
129
|
+
productsManagement?: any;
|
|
118
130
|
/** 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`). */
|
|
119
131
|
provider?: string;
|
|
120
132
|
}
|
|
@@ -135,6 +147,8 @@ declare namespace gapi.client {
|
|
|
135
147
|
user?: User;
|
|
136
148
|
/** Required. The email address of the user (for example, `john.doe@gmail.com`). */
|
|
137
149
|
userId?: string;
|
|
150
|
+
/** Optional. Settings related to configuring the verification email that is sent after adding a user. */
|
|
151
|
+
verificationMailSettings?: VerificationMailSettings;
|
|
138
152
|
}
|
|
139
153
|
interface ApproveAccountServiceRequest {}
|
|
140
154
|
interface AutofeedSettings {
|
|
@@ -248,11 +262,14 @@ declare namespace gapi.client {
|
|
|
248
262
|
/** Optional. When set to `true`, this option removes any existing claim on the requested website from any other account to the account making the request, effectively replacing the previous claim. */
|
|
249
263
|
overwrite?: boolean;
|
|
250
264
|
}
|
|
265
|
+
interface ComparisonShopping {}
|
|
251
266
|
interface CreateAndConfigureAccountRequest {
|
|
252
267
|
/** Required. The account to be created. */
|
|
253
268
|
account?: Account;
|
|
254
269
|
/** 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` and `accounts.createAndConfigure` method can be used to create a sub-account under an existing advanced account through this method. Additional `account_management` or `product_management` services may be provided. */
|
|
255
270
|
service?: AddAccountService[];
|
|
271
|
+
/** Optional. If a relationship is created with a provider, you can set an alias for it with this field. The calling user must be an admin on the provider to be able to set an alias. */
|
|
272
|
+
setAlias?: SetAliasForRelationship[];
|
|
256
273
|
/** Optional. Users to be added to the account. */
|
|
257
274
|
user?: AddUser[];
|
|
258
275
|
/** Optional. Users to be added to the account. This field is deprecated and will not exist after the API evolves out of beta. Use the `user` field instead. */
|
|
@@ -833,6 +850,12 @@ declare namespace gapi.client {
|
|
|
833
850
|
/** A list of stores your products are delivered from. This is only valid for the local delivery shipment type. */
|
|
834
851
|
storeConfig?: StoreConfig;
|
|
835
852
|
}
|
|
853
|
+
interface SetAliasForRelationship {
|
|
854
|
+
/** Required. The unique ID of this account in the provider's system. The value must be unique across all accounts on the platform for this provider. */
|
|
855
|
+
accountIdAlias?: string;
|
|
856
|
+
/** Required. The provider of the service. This is a reference to an account such as `providers/123` or `accounts/123`. The same provider must be specified in at least one of the `service` fields. */
|
|
857
|
+
provider?: string;
|
|
858
|
+
}
|
|
836
859
|
interface ShippingSettings {
|
|
837
860
|
/** Required. This field helps avoid async issues. It ensures that the shipping setting data doesn't change between the `get` call and the `insert` call. The user should follow these steps: 1. Set the etag field as an empty string for the initial shipping setting creation. 2. After the initial creation, call the `get` method to obtain an etag and the current shipping setting data before calling `insert`. 3. Modify the shipping setting information. 4. Call the `insert` method with the shipping setting information and the etag obtained in step 2. 5. If the shipping setting data changes between step 2 and step 4, the insert request will fail because the etag changes every time the shipping setting data changes. In this case, the user should repeat steps 2-4 with the new etag. */
|
|
838
861
|
etag?: string;
|
|
@@ -951,6 +974,11 @@ declare namespace gapi.client {
|
|
|
951
974
|
/** The name of a subtable. Can only be set in table cells (For example, not for single values), and only if all other fields are not set. */
|
|
952
975
|
subtable?: string;
|
|
953
976
|
}
|
|
977
|
+
interface VerificationMailSettings {
|
|
978
|
+
/** Optional. Mode of the verification mail. If not set, the default is `SEND_VERIFICATION_MAIL`. */
|
|
979
|
+
verificationMailMode?: string;
|
|
980
|
+
}
|
|
981
|
+
interface VerifySelfRequest {}
|
|
954
982
|
interface Warehouse {
|
|
955
983
|
/** Business days of the warehouse. If not set, will be Monday to Friday by default. */
|
|
956
984
|
businessDayConfig?: BusinessDayConfig;
|
|
@@ -3543,6 +3571,66 @@ declare namespace gapi.client {
|
|
|
3543
3571
|
uploadType?: string;
|
|
3544
3572
|
}): Request<TermsOfServiceAgreementState>;
|
|
3545
3573
|
}
|
|
3574
|
+
interface MeResource {
|
|
3575
|
+
/** Updates the user that is represented by the caller from pending to verified. */
|
|
3576
|
+
verifySelf(request: {
|
|
3577
|
+
/** V1 error format. */
|
|
3578
|
+
'$.xgafv'?: string;
|
|
3579
|
+
/** OAuth access token. */
|
|
3580
|
+
access_token?: string;
|
|
3581
|
+
/** Required. The name of the account under which the caller is a user. Format: `accounts/{account}` */
|
|
3582
|
+
account: string;
|
|
3583
|
+
/** Data format for response. */
|
|
3584
|
+
alt?: string;
|
|
3585
|
+
/** JSONP */
|
|
3586
|
+
callback?: string;
|
|
3587
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3588
|
+
fields?: string;
|
|
3589
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3590
|
+
key?: string;
|
|
3591
|
+
/** OAuth 2.0 token for the current user. */
|
|
3592
|
+
oauth_token?: string;
|
|
3593
|
+
/** Returns response with indentations and line breaks. */
|
|
3594
|
+
prettyPrint?: boolean;
|
|
3595
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3596
|
+
quotaUser?: string;
|
|
3597
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3598
|
+
upload_protocol?: string;
|
|
3599
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3600
|
+
uploadType?: string;
|
|
3601
|
+
/** Request body */
|
|
3602
|
+
resource: VerifySelfRequest;
|
|
3603
|
+
}): Request<User>;
|
|
3604
|
+
verifySelf(
|
|
3605
|
+
request: {
|
|
3606
|
+
/** V1 error format. */
|
|
3607
|
+
'$.xgafv'?: string;
|
|
3608
|
+
/** OAuth access token. */
|
|
3609
|
+
access_token?: string;
|
|
3610
|
+
/** Required. The name of the account under which the caller is a user. Format: `accounts/{account}` */
|
|
3611
|
+
account: string;
|
|
3612
|
+
/** Data format for response. */
|
|
3613
|
+
alt?: string;
|
|
3614
|
+
/** JSONP */
|
|
3615
|
+
callback?: string;
|
|
3616
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3617
|
+
fields?: string;
|
|
3618
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3619
|
+
key?: string;
|
|
3620
|
+
/** OAuth 2.0 token for the current user. */
|
|
3621
|
+
oauth_token?: string;
|
|
3622
|
+
/** Returns response with indentations and line breaks. */
|
|
3623
|
+
prettyPrint?: boolean;
|
|
3624
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3625
|
+
quotaUser?: string;
|
|
3626
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3627
|
+
upload_protocol?: string;
|
|
3628
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3629
|
+
uploadType?: string;
|
|
3630
|
+
},
|
|
3631
|
+
body: VerifySelfRequest,
|
|
3632
|
+
): Request<User>;
|
|
3633
|
+
}
|
|
3546
3634
|
interface UsersResource {
|
|
3547
3635
|
/** Creates a Merchant Center account user. Executing this method requires admin access. */
|
|
3548
3636
|
create(request: {
|
|
@@ -3753,6 +3841,7 @@ declare namespace gapi.client {
|
|
|
3753
3841
|
},
|
|
3754
3842
|
body: User,
|
|
3755
3843
|
): Request<User>;
|
|
3844
|
+
me: MeResource;
|
|
3756
3845
|
}
|
|
3757
3846
|
interface AccountsResource {
|
|
3758
3847
|
/** Creates a Merchant Center account with additional configuration. Adds the user that makes the request as an admin for the new account. */
|