@maxim_mazurok/gapi.client.merchantapi-accounts_v1 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 +171 -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_v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20251115
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -77,6 +77,12 @@ declare namespace gapi.client {
|
|
|
77
77
|
/** The localized title of the issue. */
|
|
78
78
|
title?: string;
|
|
79
79
|
}
|
|
80
|
+
interface AccountLimit {
|
|
81
|
+
/** Identifier. The limit part of the name will be a combination of the type and the scope. For example: `accounts/123/limits/products~ADS_NON_EEA` Format: `accounts/{account}/limits/{limit}` */
|
|
82
|
+
name?: string;
|
|
83
|
+
/** The limit for products. */
|
|
84
|
+
products?: ProductLimit;
|
|
85
|
+
}
|
|
80
86
|
interface AccountManagement {}
|
|
81
87
|
interface AccountRelationship {
|
|
82
88
|
/** 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. */
|
|
@@ -95,6 +101,8 @@ declare namespace gapi.client {
|
|
|
95
101
|
accountManagement?: any;
|
|
96
102
|
/** 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
103
|
campaignsManagement?: any;
|
|
104
|
+
/** Service type for comparison shopping. The provider is a CSS (Comparison Shopping Service) managing the account. See https://support.google.com/merchants/answer/12653197 */
|
|
105
|
+
comparisonShopping?: any;
|
|
98
106
|
/** 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
107
|
externalAccountId?: string;
|
|
100
108
|
/** Output only. Information about the state of the service in terms of establishing it (e.g. is it pending approval or approved). */
|
|
@@ -115,6 +123,16 @@ declare namespace gapi.client {
|
|
|
115
123
|
interface AddAccountService {
|
|
116
124
|
/** The provider is an [aggregator](https://support.google.com/merchants/answer/188487) for the account. Payload for service type Account Aggregation. */
|
|
117
125
|
accountAggregation?: any;
|
|
126
|
+
/** The provider manages this account. Payload for service type Account Management. */
|
|
127
|
+
accountManagement?: any;
|
|
128
|
+
/** The provider manages campaigns for this account. Payload for service type campaigns management. */
|
|
129
|
+
campaignsManagement?: any;
|
|
130
|
+
/** The provider is a CSS (Comparison Shopping Service) of this account. Payload for service type Comparison Shopping. */
|
|
131
|
+
comparisonShopping?: any;
|
|
132
|
+
/** 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. */
|
|
133
|
+
externalAccountId?: string;
|
|
134
|
+
/** The provider manages products for this account. Payload for service type products management. */
|
|
135
|
+
productsManagement?: any;
|
|
118
136
|
/** 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
137
|
provider?: string;
|
|
120
138
|
}
|
|
@@ -135,6 +153,8 @@ declare namespace gapi.client {
|
|
|
135
153
|
user?: User;
|
|
136
154
|
/** Required. The email address of the user (for example, `john.doe@gmail.com`). */
|
|
137
155
|
userId?: string;
|
|
156
|
+
/** Optional. Settings related to configuring the verification email that is sent after adding a user. */
|
|
157
|
+
verificationMailSettings?: VerificationMailSettings;
|
|
138
158
|
}
|
|
139
159
|
interface ApproveAccountServiceRequest {}
|
|
140
160
|
interface AutofeedSettings {
|
|
@@ -268,11 +288,14 @@ declare namespace gapi.client {
|
|
|
268
288
|
/** 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. */
|
|
269
289
|
overwrite?: boolean;
|
|
270
290
|
}
|
|
291
|
+
interface ComparisonShopping {}
|
|
271
292
|
interface CreateAndConfigureAccountRequest {
|
|
272
293
|
/** Required. The account to be created. */
|
|
273
294
|
account?: Account;
|
|
274
295
|
/** 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. */
|
|
275
296
|
service?: AddAccountService[];
|
|
297
|
+
/** 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. */
|
|
298
|
+
setAlias?: SetAliasForRelationship[];
|
|
276
299
|
/** Optional. Users to be added to the account. */
|
|
277
300
|
user?: AddUser[];
|
|
278
301
|
}
|
|
@@ -497,6 +520,12 @@ declare namespace gapi.client {
|
|
|
497
520
|
/** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
498
521
|
nextPageToken?: string;
|
|
499
522
|
}
|
|
523
|
+
interface ListAccountLimitsResponse {
|
|
524
|
+
/** The limits for the given account. */
|
|
525
|
+
accountLimits?: AccountLimit[];
|
|
526
|
+
/** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
527
|
+
nextPageToken?: string;
|
|
528
|
+
}
|
|
500
529
|
interface ListAccountRelationshipsResponse {
|
|
501
530
|
/** The account relationships that match your filter. */
|
|
502
531
|
accountRelationships?: AccountRelationship[];
|
|
@@ -712,6 +741,12 @@ declare namespace gapi.client {
|
|
|
712
741
|
/** Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum) */
|
|
713
742
|
reportingContext?: string;
|
|
714
743
|
}
|
|
744
|
+
interface ProductLimit {
|
|
745
|
+
/** Required. The maximum number of products that are allowed in the account in the given scope. */
|
|
746
|
+
limit?: string;
|
|
747
|
+
/** Required. The scope of the product limit. */
|
|
748
|
+
scope?: string;
|
|
749
|
+
}
|
|
715
750
|
interface ProductsManagement {}
|
|
716
751
|
interface ProductStatusChangeMessage {
|
|
717
752
|
/** The target account that owns the entity that changed. Format : `accounts/{merchant_id}` */
|
|
@@ -855,6 +890,12 @@ declare namespace gapi.client {
|
|
|
855
890
|
/** A list of stores your products are delivered from. This is only valid for the local delivery shipment type. */
|
|
856
891
|
storeConfig?: StoreConfig;
|
|
857
892
|
}
|
|
893
|
+
interface SetAliasForRelationship {
|
|
894
|
+
/** 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. */
|
|
895
|
+
accountIdAlias?: string;
|
|
896
|
+
/** 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. */
|
|
897
|
+
provider?: string;
|
|
898
|
+
}
|
|
858
899
|
interface ShippingSettings {
|
|
859
900
|
/** 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. */
|
|
860
901
|
etag?: string;
|
|
@@ -979,6 +1020,11 @@ declare namespace gapi.client {
|
|
|
979
1020
|
/** 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. */
|
|
980
1021
|
subtable?: string;
|
|
981
1022
|
}
|
|
1023
|
+
interface VerificationMailSettings {
|
|
1024
|
+
/** Optional. Mode of the verification mail. If not set, the default is `SEND_VERIFICATION_MAIL`. */
|
|
1025
|
+
verificationMailMode?: string;
|
|
1026
|
+
}
|
|
1027
|
+
interface VerifySelfRequest {}
|
|
982
1028
|
interface Warehouse {
|
|
983
1029
|
/** Business days of the warehouse. If not set, will be Monday to Friday by default. */
|
|
984
1030
|
businessDayConfig?: BusinessDayConfig;
|
|
@@ -1971,6 +2017,68 @@ declare namespace gapi.client {
|
|
|
1971
2017
|
uploadType?: string;
|
|
1972
2018
|
}): Request<ListAccountIssuesResponse>;
|
|
1973
2019
|
}
|
|
2020
|
+
interface LimitsResource {
|
|
2021
|
+
/** Retrieves an account limit. */
|
|
2022
|
+
get(request?: {
|
|
2023
|
+
/** V1 error format. */
|
|
2024
|
+
'$.xgafv'?: string;
|
|
2025
|
+
/** OAuth access token. */
|
|
2026
|
+
access_token?: string;
|
|
2027
|
+
/** Data format for response. */
|
|
2028
|
+
alt?: string;
|
|
2029
|
+
/** JSONP */
|
|
2030
|
+
callback?: string;
|
|
2031
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2032
|
+
fields?: string;
|
|
2033
|
+
/** 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. */
|
|
2034
|
+
key?: string;
|
|
2035
|
+
/** Required. The name of the limit to retrieve. Format: `accounts/{account}/limits/{limit}` For example: `accounts/123/limits/products~ADS_NON_EEA` */
|
|
2036
|
+
name: string;
|
|
2037
|
+
/** OAuth 2.0 token for the current user. */
|
|
2038
|
+
oauth_token?: string;
|
|
2039
|
+
/** Returns response with indentations and line breaks. */
|
|
2040
|
+
prettyPrint?: boolean;
|
|
2041
|
+
/** 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. */
|
|
2042
|
+
quotaUser?: string;
|
|
2043
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2044
|
+
upload_protocol?: string;
|
|
2045
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2046
|
+
uploadType?: string;
|
|
2047
|
+
}): Request<AccountLimit>;
|
|
2048
|
+
/** Lists the limits of an account. */
|
|
2049
|
+
list(request?: {
|
|
2050
|
+
/** V1 error format. */
|
|
2051
|
+
'$.xgafv'?: string;
|
|
2052
|
+
/** OAuth access token. */
|
|
2053
|
+
access_token?: string;
|
|
2054
|
+
/** Data format for response. */
|
|
2055
|
+
alt?: string;
|
|
2056
|
+
/** JSONP */
|
|
2057
|
+
callback?: string;
|
|
2058
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2059
|
+
fields?: string;
|
|
2060
|
+
/** Required. A filter on the limit `type` is required, for example, `type = "products"`. */
|
|
2061
|
+
filter?: string;
|
|
2062
|
+
/** 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. */
|
|
2063
|
+
key?: string;
|
|
2064
|
+
/** OAuth 2.0 token for the current user. */
|
|
2065
|
+
oauth_token?: string;
|
|
2066
|
+
/** Optional. The maximum number of limits to return. The service may return fewer than this value. If unspecified, at most 100 limits will be returned. The maximum value is 100; values above 100 will be coerced to 100. */
|
|
2067
|
+
pageSize?: number;
|
|
2068
|
+
/** Optional. A page token, received from a previous `ListAccountLimits` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountLimits` must match the call that provided the page token. */
|
|
2069
|
+
pageToken?: string;
|
|
2070
|
+
/** Required. The parent account. Format: `accounts/{account}` */
|
|
2071
|
+
parent: string;
|
|
2072
|
+
/** Returns response with indentations and line breaks. */
|
|
2073
|
+
prettyPrint?: boolean;
|
|
2074
|
+
/** 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. */
|
|
2075
|
+
quotaUser?: string;
|
|
2076
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2077
|
+
upload_protocol?: string;
|
|
2078
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2079
|
+
uploadType?: string;
|
|
2080
|
+
}): Request<ListAccountLimitsResponse>;
|
|
2081
|
+
}
|
|
1974
2082
|
interface LfpProvidersResource {
|
|
1975
2083
|
/** Find the LFP provider candidates in a given country. */
|
|
1976
2084
|
find(request?: {
|
|
@@ -3683,6 +3791,66 @@ declare namespace gapi.client {
|
|
|
3683
3791
|
uploadType?: string;
|
|
3684
3792
|
}): Request<TermsOfServiceAgreementState>;
|
|
3685
3793
|
}
|
|
3794
|
+
interface MeResource {
|
|
3795
|
+
/** Updates the user that is represented by the caller from pending to verified. */
|
|
3796
|
+
verifySelf(request: {
|
|
3797
|
+
/** V1 error format. */
|
|
3798
|
+
'$.xgafv'?: string;
|
|
3799
|
+
/** OAuth access token. */
|
|
3800
|
+
access_token?: string;
|
|
3801
|
+
/** Required. The name of the account under which the caller is a user. Format: `accounts/{account}` */
|
|
3802
|
+
account: string;
|
|
3803
|
+
/** Data format for response. */
|
|
3804
|
+
alt?: string;
|
|
3805
|
+
/** JSONP */
|
|
3806
|
+
callback?: string;
|
|
3807
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3808
|
+
fields?: string;
|
|
3809
|
+
/** 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. */
|
|
3810
|
+
key?: string;
|
|
3811
|
+
/** OAuth 2.0 token for the current user. */
|
|
3812
|
+
oauth_token?: string;
|
|
3813
|
+
/** Returns response with indentations and line breaks. */
|
|
3814
|
+
prettyPrint?: boolean;
|
|
3815
|
+
/** 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. */
|
|
3816
|
+
quotaUser?: string;
|
|
3817
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3818
|
+
upload_protocol?: string;
|
|
3819
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3820
|
+
uploadType?: string;
|
|
3821
|
+
/** Request body */
|
|
3822
|
+
resource: VerifySelfRequest;
|
|
3823
|
+
}): Request<User>;
|
|
3824
|
+
verifySelf(
|
|
3825
|
+
request: {
|
|
3826
|
+
/** V1 error format. */
|
|
3827
|
+
'$.xgafv'?: string;
|
|
3828
|
+
/** OAuth access token. */
|
|
3829
|
+
access_token?: string;
|
|
3830
|
+
/** Required. The name of the account under which the caller is a user. Format: `accounts/{account}` */
|
|
3831
|
+
account: string;
|
|
3832
|
+
/** Data format for response. */
|
|
3833
|
+
alt?: string;
|
|
3834
|
+
/** JSONP */
|
|
3835
|
+
callback?: string;
|
|
3836
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3837
|
+
fields?: string;
|
|
3838
|
+
/** 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. */
|
|
3839
|
+
key?: string;
|
|
3840
|
+
/** OAuth 2.0 token for the current user. */
|
|
3841
|
+
oauth_token?: string;
|
|
3842
|
+
/** Returns response with indentations and line breaks. */
|
|
3843
|
+
prettyPrint?: boolean;
|
|
3844
|
+
/** 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. */
|
|
3845
|
+
quotaUser?: string;
|
|
3846
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3847
|
+
upload_protocol?: string;
|
|
3848
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3849
|
+
uploadType?: string;
|
|
3850
|
+
},
|
|
3851
|
+
body: VerifySelfRequest,
|
|
3852
|
+
): Request<User>;
|
|
3853
|
+
}
|
|
3686
3854
|
interface UsersResource {
|
|
3687
3855
|
/** Creates a Merchant Center account user. Executing this method requires admin access. */
|
|
3688
3856
|
create(request: {
|
|
@@ -3893,6 +4061,7 @@ declare namespace gapi.client {
|
|
|
3893
4061
|
},
|
|
3894
4062
|
body: User,
|
|
3895
4063
|
): Request<User>;
|
|
4064
|
+
me: MeResource;
|
|
3896
4065
|
}
|
|
3897
4066
|
interface AccountsResource {
|
|
3898
4067
|
/** Creates a Merchant Center account with additional configuration. Adds the user that makes the request as an admin for the new account. */
|
|
@@ -4138,6 +4307,7 @@ declare namespace gapi.client {
|
|
|
4138
4307
|
gbpAccounts: GbpAccountsResource;
|
|
4139
4308
|
homepage: HomepageResource;
|
|
4140
4309
|
issues: IssuesResource;
|
|
4310
|
+
limits: LimitsResource;
|
|
4141
4311
|
omnichannelSettings: OmnichannelSettingsResource;
|
|
4142
4312
|
onlineReturnPolicies: OnlineReturnPoliciesResource;
|
|
4143
4313
|
programs: ProgramsResource;
|