@maxim_mazurok/gapi.client.merchantapi-issueresolution_v1beta 0.1.20260315 → 0.1.20260318
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 +102 -29
- 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=issueresolution_v1beta
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260318
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -81,7 +81,27 @@ declare namespace gapi.client {
|
|
|
81
81
|
/** Identifier. The name of the `AggregateProductStatuses` resource. Format: `accounts/{account}/aggregateProductStatuses/{aggregateProductStatuses}` */
|
|
82
82
|
name?: string;
|
|
83
83
|
/** The reporting context of the aggregate product statuses. */
|
|
84
|
-
reportingContext?:
|
|
84
|
+
reportingContext?:
|
|
85
|
+
| 'REPORTING_CONTEXT_ENUM_UNSPECIFIED'
|
|
86
|
+
| 'SHOPPING_ADS'
|
|
87
|
+
| 'DISCOVERY_ADS'
|
|
88
|
+
| 'DEMAND_GEN_ADS'
|
|
89
|
+
| 'DEMAND_GEN_ADS_DISCOVER_SURFACE'
|
|
90
|
+
| 'VIDEO_ADS'
|
|
91
|
+
| 'DISPLAY_ADS'
|
|
92
|
+
| 'LOCAL_INVENTORY_ADS'
|
|
93
|
+
| 'VEHICLE_INVENTORY_ADS'
|
|
94
|
+
| 'FREE_LISTINGS'
|
|
95
|
+
| 'FREE_LISTINGS_UCP_CHECKOUT'
|
|
96
|
+
| 'FREE_LOCAL_LISTINGS'
|
|
97
|
+
| 'FREE_LOCAL_VEHICLE_LISTINGS'
|
|
98
|
+
| 'YOUTUBE_AFFILIATE'
|
|
99
|
+
| 'YOUTUBE_SHOPPING'
|
|
100
|
+
| 'CLOUD_RETAIL'
|
|
101
|
+
| 'LOCAL_CLOUD_RETAIL'
|
|
102
|
+
| 'PRODUCT_REVIEWS'
|
|
103
|
+
| 'MERCHANT_REVIEWS'
|
|
104
|
+
| 'YOUTUBE_CHECKOUT';
|
|
85
105
|
/** Products statistics for the given reporting context and country. */
|
|
86
106
|
stats?: Stats;
|
|
87
107
|
}
|
|
@@ -97,7 +117,17 @@ declare namespace gapi.client {
|
|
|
97
117
|
/** The attribute that needs to be updated. Present when the type is `EDIT_ITEM_ATTRIBUTE`. This field contains a code for attribute, represented in snake_case. You can find a list of product's attributes, with their codes [here](https://support.google.com/merchants/answer/7052112). */
|
|
98
118
|
attributeCode?: string;
|
|
99
119
|
/** The type of action that represents a functionality that is expected to be available in third-party application. */
|
|
100
|
-
type?:
|
|
120
|
+
type?:
|
|
121
|
+
| 'BUILT_IN_SIMPLE_ACTION_TYPE_UNSPECIFIED'
|
|
122
|
+
| 'VERIFY_PHONE'
|
|
123
|
+
| 'CLAIM_WEBSITE'
|
|
124
|
+
| 'ADD_PRODUCTS'
|
|
125
|
+
| 'ADD_CONTACT_INFO'
|
|
126
|
+
| 'LINK_ADS_ACCOUNT'
|
|
127
|
+
| 'ADD_BUSINESS_REGISTRATION_NUMBER'
|
|
128
|
+
| 'EDIT_ITEM_ATTRIBUTE'
|
|
129
|
+
| 'FIX_ACCOUNT_ISSUE'
|
|
130
|
+
| 'SHOW_ADDITIONAL_CONTENT';
|
|
101
131
|
}
|
|
102
132
|
interface BuiltInUserInputAction {
|
|
103
133
|
/** Contains the action's context that must be included as part of the TriggerActionPayload.action_context in TriggerActionRequest.payload to call the `triggeraction` method. The content should be treated as opaque and must not be modified. */
|
|
@@ -109,7 +139,11 @@ declare namespace gapi.client {
|
|
|
109
139
|
/** A full message that needs to be shown to the business. */
|
|
110
140
|
fullMessage?: TextWithTooltip;
|
|
111
141
|
/** Can be used to render messages with different severity in different styles. Snippets off all types contain important information that should be displayed to the business. */
|
|
112
|
-
styleHint?:
|
|
142
|
+
styleHint?:
|
|
143
|
+
| 'CALLOUT_STYLE_HINT_UNSPECIFIED'
|
|
144
|
+
| 'ERROR'
|
|
145
|
+
| 'WARNING'
|
|
146
|
+
| 'INFO';
|
|
113
147
|
}
|
|
114
148
|
interface CheckboxInput {}
|
|
115
149
|
interface CheckboxInputValue {
|
|
@@ -134,7 +168,13 @@ declare namespace gapi.client {
|
|
|
134
168
|
}
|
|
135
169
|
interface ExternalAction {
|
|
136
170
|
/** The type of external action. */
|
|
137
|
-
type?:
|
|
171
|
+
type?:
|
|
172
|
+
| 'EXTERNAL_ACTION_TYPE_UNSPECIFIED'
|
|
173
|
+
| 'REVIEW_PRODUCT_ISSUE_IN_MERCHANT_CENTER'
|
|
174
|
+
| 'REVIEW_ACCOUNT_ISSUE_IN_MERCHANT_CENTER'
|
|
175
|
+
| 'LEGAL_APPEAL_IN_HELP_CENTER'
|
|
176
|
+
| 'VERIFY_IDENTITY_IN_MERCHANT_CENTER'
|
|
177
|
+
| 'VERIFY_BUSINESS_VIDEO_IN_MERCHANT_CENTER';
|
|
138
178
|
/** URL to external system, for example Merchant Center, where the business can perform the action. */
|
|
139
179
|
uri?: string;
|
|
140
180
|
}
|
|
@@ -144,7 +184,7 @@ declare namespace gapi.client {
|
|
|
144
184
|
/** Optional. Message summarizing the overall impact of the issue. If present, it should be rendered to the business. For example: "Disapproves 90k offers in 25 countries" */
|
|
145
185
|
message?: string;
|
|
146
186
|
/** The severity of the issue. */
|
|
147
|
-
severity?:
|
|
187
|
+
severity?: 'SEVERITY_UNSPECIFIED' | 'ERROR' | 'WARNING' | 'INFO';
|
|
148
188
|
}
|
|
149
189
|
interface InputField {
|
|
150
190
|
/** Input field to provide a boolean value. Corresponds to the [html input type=checkbox](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.checkbox.html#input.checkbox). */
|
|
@@ -184,9 +224,16 @@ declare namespace gapi.client {
|
|
|
184
224
|
/** The number of products affected by this issue. */
|
|
185
225
|
productCount?: string;
|
|
186
226
|
/** Whether the issue can be resolved by the merchant. */
|
|
187
|
-
resolution?:
|
|
227
|
+
resolution?:
|
|
228
|
+
| 'RESOLUTION_UNSPECIFIED'
|
|
229
|
+
| 'MERCHANT_ACTION'
|
|
230
|
+
| 'PENDING_PROCESSING';
|
|
188
231
|
/** How this issue affects serving of the offer. */
|
|
189
|
-
severity?:
|
|
232
|
+
severity?:
|
|
233
|
+
| 'SEVERITY_UNSPECIFIED'
|
|
234
|
+
| 'NOT_IMPACTED'
|
|
235
|
+
| 'DEMOTED'
|
|
236
|
+
| 'DISAPPROVED';
|
|
190
237
|
}
|
|
191
238
|
interface ListAggregateProductStatusesResponse {
|
|
192
239
|
/** The `AggregateProductStatuses` resources for the given account. */
|
|
@@ -202,13 +249,33 @@ declare namespace gapi.client {
|
|
|
202
249
|
/** Countries that have the change (if applicable). Represented in the ISO 3166 format. */
|
|
203
250
|
regionCode?: string;
|
|
204
251
|
/** 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) */
|
|
205
|
-
reportingContext?:
|
|
252
|
+
reportingContext?:
|
|
253
|
+
| 'REPORTING_CONTEXT_ENUM_UNSPECIFIED'
|
|
254
|
+
| 'SHOPPING_ADS'
|
|
255
|
+
| 'DISCOVERY_ADS'
|
|
256
|
+
| 'DEMAND_GEN_ADS'
|
|
257
|
+
| 'DEMAND_GEN_ADS_DISCOVER_SURFACE'
|
|
258
|
+
| 'VIDEO_ADS'
|
|
259
|
+
| 'DISPLAY_ADS'
|
|
260
|
+
| 'LOCAL_INVENTORY_ADS'
|
|
261
|
+
| 'VEHICLE_INVENTORY_ADS'
|
|
262
|
+
| 'FREE_LISTINGS'
|
|
263
|
+
| 'FREE_LISTINGS_UCP_CHECKOUT'
|
|
264
|
+
| 'FREE_LOCAL_LISTINGS'
|
|
265
|
+
| 'FREE_LOCAL_VEHICLE_LISTINGS'
|
|
266
|
+
| 'YOUTUBE_AFFILIATE'
|
|
267
|
+
| 'YOUTUBE_SHOPPING'
|
|
268
|
+
| 'CLOUD_RETAIL'
|
|
269
|
+
| 'LOCAL_CLOUD_RETAIL'
|
|
270
|
+
| 'PRODUCT_REVIEWS'
|
|
271
|
+
| 'MERCHANT_REVIEWS'
|
|
272
|
+
| 'YOUTUBE_CHECKOUT';
|
|
206
273
|
}
|
|
207
274
|
interface ProductStatusChangeMessage {
|
|
208
275
|
/** The target account that owns the entity that changed. Format : `accounts/{merchant_id}` */
|
|
209
276
|
account?: string;
|
|
210
277
|
/** The attribute in the resource that changed, in this case it will be always `Status`. */
|
|
211
|
-
attribute?:
|
|
278
|
+
attribute?: 'ATTRIBUTE_UNSPECIFIED' | 'STATUS';
|
|
212
279
|
/** A message to describe the change that happened to the product */
|
|
213
280
|
changes?: ProductChange[];
|
|
214
281
|
/** The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications. */
|
|
@@ -222,7 +289,7 @@ declare namespace gapi.client {
|
|
|
222
289
|
/** The product id. */
|
|
223
290
|
resourceId?: string;
|
|
224
291
|
/** The resource that changed, in this case it will always be `Product`. */
|
|
225
|
-
resourceType?:
|
|
292
|
+
resourceType?: 'RESOURCE_UNSPECIFIED' | 'PRODUCT';
|
|
226
293
|
}
|
|
227
294
|
interface Reason {
|
|
228
295
|
/** Optional. An action that needs to be performed to solve the problem represented by this reason. This action will always be available. Should be rendered as a link or button next to the summarizing message. For example, the review may be available only once the business configure all required attributes. In such a situation this action can be a link to the form, where they can fill the missing attribute to unblock the main action. */
|
|
@@ -256,9 +323,12 @@ declare namespace gapi.client {
|
|
|
256
323
|
}
|
|
257
324
|
interface RenderIssuesRequestPayload {
|
|
258
325
|
/** Optional. How the detailed content should be returned. Default option is to return the content as a pre-rendered HTML text. */
|
|
259
|
-
contentOption?:
|
|
326
|
+
contentOption?: 'CONTENT_OPTION_UNSPECIFIED' | 'PRE_RENDERED_HTML';
|
|
260
327
|
/** Optional. How actions with user input form should be handled. If not provided, actions will be returned as links that points the business to Merchant Center where they can request the action. */
|
|
261
|
-
userInputActionOption?:
|
|
328
|
+
userInputActionOption?:
|
|
329
|
+
| 'USER_INPUT_ACTION_RENDERING_OPTION_UNSPECIFIED'
|
|
330
|
+
| 'REDIRECT_TO_MERCHANT_CENTER'
|
|
331
|
+
| 'BUILT_IN_USER_INPUT_ACTIONS';
|
|
262
332
|
}
|
|
263
333
|
interface RenderProductIssuesResponse {
|
|
264
334
|
/** List of issues for a given product. This list can be shown with compressed, expandable items. In the compressed form, the title and impact should be shown for each issue. Once the issue is expanded, the detailed content and available actions should be rendered. */
|
|
@@ -282,7 +352,10 @@ declare namespace gapi.client {
|
|
|
282
352
|
/** Information about the required format. If present, it should be shown close to the input field to help the business to provide a correct value. For example: "VAT numbers should be in a format similar to SK9999999999" */
|
|
283
353
|
formatInfo?: string;
|
|
284
354
|
/** Type of the text input */
|
|
285
|
-
type?:
|
|
355
|
+
type?:
|
|
356
|
+
| 'TEXT_INPUT_TYPE_UNSPECIFIED'
|
|
357
|
+
| 'GENERIC_SHORT_TEXT'
|
|
358
|
+
| 'GENERIC_LONG_TEXT';
|
|
286
359
|
}
|
|
287
360
|
interface TextInputValue {
|
|
288
361
|
/** Required. Text provided by the business. */
|
|
@@ -294,7 +367,7 @@ declare namespace gapi.client {
|
|
|
294
367
|
/** Value of the message as a simple text. */
|
|
295
368
|
simpleValue?: string;
|
|
296
369
|
/** The suggested type of an icon for tooltip, if a tooltip is present. */
|
|
297
|
-
tooltipIconStyle?:
|
|
370
|
+
tooltipIconStyle?: 'TOOLTIP_ICON_STYLE_UNSPECIFIED' | 'INFO' | 'QUESTION';
|
|
298
371
|
}
|
|
299
372
|
interface TriggerActionPayload {
|
|
300
373
|
/** Required. The context from the selected action. The value is obtained from rendered issues and needs to be sent back to identify the action that is being triggered. */
|
|
@@ -310,11 +383,11 @@ declare namespace gapi.client {
|
|
|
310
383
|
/** Lists the `AggregateProductStatuses` resources for your merchant account. The response might contain fewer items than specified by `pageSize`. If `pageToken` was returned in previous request, it can be used to obtain additional results. */
|
|
311
384
|
list(request?: {
|
|
312
385
|
/** V1 error format. */
|
|
313
|
-
'$.xgafv'?:
|
|
386
|
+
'$.xgafv'?: '1' | '2';
|
|
314
387
|
/** OAuth access token. */
|
|
315
388
|
access_token?: string;
|
|
316
389
|
/** Data format for response. */
|
|
317
|
-
alt?:
|
|
390
|
+
alt?: 'json' | 'media' | 'proto';
|
|
318
391
|
/** JSONP */
|
|
319
392
|
callback?: string;
|
|
320
393
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -348,11 +421,11 @@ declare namespace gapi.client {
|
|
|
348
421
|
/** Provide a list of business's account issues with an issue resolution content and available actions. This content and actions are meant to be rendered and shown in third-party applications. */
|
|
349
422
|
renderaccountissues(request: {
|
|
350
423
|
/** V1 error format. */
|
|
351
|
-
'$.xgafv'?:
|
|
424
|
+
'$.xgafv'?: '1' | '2';
|
|
352
425
|
/** OAuth access token. */
|
|
353
426
|
access_token?: string;
|
|
354
427
|
/** Data format for response. */
|
|
355
|
-
alt?:
|
|
428
|
+
alt?: 'json' | 'media' | 'proto';
|
|
356
429
|
/** JSONP */
|
|
357
430
|
callback?: string;
|
|
358
431
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -381,11 +454,11 @@ declare namespace gapi.client {
|
|
|
381
454
|
renderaccountissues(
|
|
382
455
|
request: {
|
|
383
456
|
/** V1 error format. */
|
|
384
|
-
'$.xgafv'?:
|
|
457
|
+
'$.xgafv'?: '1' | '2';
|
|
385
458
|
/** OAuth access token. */
|
|
386
459
|
access_token?: string;
|
|
387
460
|
/** Data format for response. */
|
|
388
|
-
alt?:
|
|
461
|
+
alt?: 'json' | 'media' | 'proto';
|
|
389
462
|
/** JSONP */
|
|
390
463
|
callback?: string;
|
|
391
464
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -414,11 +487,11 @@ declare namespace gapi.client {
|
|
|
414
487
|
/** Provide a list of issues for business's product with an issue resolution content and available actions. This content and actions are meant to be rendered and shown in third-party applications. */
|
|
415
488
|
renderproductissues(request: {
|
|
416
489
|
/** V1 error format. */
|
|
417
|
-
'$.xgafv'?:
|
|
490
|
+
'$.xgafv'?: '1' | '2';
|
|
418
491
|
/** OAuth access token. */
|
|
419
492
|
access_token?: string;
|
|
420
493
|
/** Data format for response. */
|
|
421
|
-
alt?:
|
|
494
|
+
alt?: 'json' | 'media' | 'proto';
|
|
422
495
|
/** JSONP */
|
|
423
496
|
callback?: string;
|
|
424
497
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -447,11 +520,11 @@ declare namespace gapi.client {
|
|
|
447
520
|
renderproductissues(
|
|
448
521
|
request: {
|
|
449
522
|
/** V1 error format. */
|
|
450
|
-
'$.xgafv'?:
|
|
523
|
+
'$.xgafv'?: '1' | '2';
|
|
451
524
|
/** OAuth access token. */
|
|
452
525
|
access_token?: string;
|
|
453
526
|
/** Data format for response. */
|
|
454
|
-
alt?:
|
|
527
|
+
alt?: 'json' | 'media' | 'proto';
|
|
455
528
|
/** JSONP */
|
|
456
529
|
callback?: string;
|
|
457
530
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -480,11 +553,11 @@ declare namespace gapi.client {
|
|
|
480
553
|
/** Start an action. The action can be requested by a business in third-party application. Before the business can request the action, the third-party application needs to show them action specific content and display a user input form. Access to the `triggeraction` method is restricted to an allowlist. You can request access using [Trigger action allowlist form](https://docs.google.com/forms/d/e/1FAIpQLSfeV_sBW9MBQv9BMTV6JZ1g11PGHLdHsrefca-9h0LmpU7CUg/viewform?usp=sharing). The action can be successfully started only once all `required` inputs are provided. If any `required` input is missing, or invalid value was provided, the service will return 400 error. Validation errors will contain Ids for all problematic field together with translated, human readable error messages that can be shown to the user. */
|
|
481
554
|
triggeraction(request: {
|
|
482
555
|
/** V1 error format. */
|
|
483
|
-
'$.xgafv'?:
|
|
556
|
+
'$.xgafv'?: '1' | '2';
|
|
484
557
|
/** OAuth access token. */
|
|
485
558
|
access_token?: string;
|
|
486
559
|
/** Data format for response. */
|
|
487
|
-
alt?:
|
|
560
|
+
alt?: 'json' | 'media' | 'proto';
|
|
488
561
|
/** JSONP */
|
|
489
562
|
callback?: string;
|
|
490
563
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -511,11 +584,11 @@ declare namespace gapi.client {
|
|
|
511
584
|
triggeraction(
|
|
512
585
|
request: {
|
|
513
586
|
/** V1 error format. */
|
|
514
|
-
'$.xgafv'?:
|
|
587
|
+
'$.xgafv'?: '1' | '2';
|
|
515
588
|
/** OAuth access token. */
|
|
516
589
|
access_token?: string;
|
|
517
590
|
/** Data format for response. */
|
|
518
|
-
alt?:
|
|
591
|
+
alt?: 'json' | 'media' | 'proto';
|
|
519
592
|
/** JSONP */
|
|
520
593
|
callback?: string;
|
|
521
594
|
/** Selector specifying which fields to include in a partial response. */
|
package/package.json
CHANGED