@maxim_mazurok/gapi.client.searchconsole-v1 0.2.20260628 → 0.3.20260629
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 +13 -51
- 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://searchconsole.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260629
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -31,11 +31,7 @@ declare namespace gapi.client {
|
|
|
31
31
|
interface AmpInspectionResult {
|
|
32
32
|
/** Index status of the AMP URL. */
|
|
33
33
|
ampIndexStatusVerdict?:
|
|
34
|
-
| '
|
|
35
|
-
| 'PASS'
|
|
36
|
-
| 'PARTIAL'
|
|
37
|
-
| 'FAIL'
|
|
38
|
-
| 'NEUTRAL';
|
|
34
|
+
'VERDICT_UNSPECIFIED' | 'PASS' | 'PARTIAL' | 'FAIL' | 'NEUTRAL';
|
|
39
35
|
/** URL of the AMP that was inspected. If the submitted URL is a desktop page that refers to an AMP version, the AMP version will be inspected. */
|
|
40
36
|
ampUrl?: string;
|
|
41
37
|
/** Whether or not the page blocks indexing through a noindex rule. */
|
|
@@ -64,9 +60,7 @@ declare namespace gapi.client {
|
|
|
64
60
|
| 'INVALID_URL';
|
|
65
61
|
/** Whether or not the page is blocked to Google by a robots.txt rule. */
|
|
66
62
|
robotsTxtState?:
|
|
67
|
-
| '
|
|
68
|
-
| 'ALLOWED'
|
|
69
|
-
| 'DISALLOWED';
|
|
63
|
+
'ROBOTS_TXT_STATE_UNSPECIFIED' | 'ALLOWED' | 'DISALLOWED';
|
|
70
64
|
/** The status of the most severe error on the page. If a page has both warnings and errors, the page status is error. Error status means the page cannot be shown in Search results. */
|
|
71
65
|
verdict?: 'VERDICT_UNSPECIFIED' | 'PASS' | 'PARTIAL' | 'FAIL' | 'NEUTRAL';
|
|
72
66
|
}
|
|
@@ -148,9 +142,7 @@ declare namespace gapi.client {
|
|
|
148
142
|
referringUrls?: string[];
|
|
149
143
|
/** Whether or not the page is blocked to Google by a robots.txt rule. */
|
|
150
144
|
robotsTxtState?:
|
|
151
|
-
| '
|
|
152
|
-
| 'ALLOWED'
|
|
153
|
-
| 'DISALLOWED';
|
|
145
|
+
'ROBOTS_TXT_STATE_UNSPECIFIED' | 'ALLOWED' | 'DISALLOWED';
|
|
154
146
|
/** Any sitemaps that this URL was listed in, as known by Google. Not guaranteed to be an exhaustive list, especially if Google did not discover this URL through a sitemap. Absent if no sitemaps were found. */
|
|
155
147
|
sitemap?: string[];
|
|
156
148
|
/** The URL that your page or site [declares as canonical](https://developers.google.com/search/docs/advanced/crawling/consolidate-duplicate-urls?#define-canonical). If you did not declare a canonical URL, this field is absent. */
|
|
@@ -254,10 +246,7 @@ declare namespace gapi.client {
|
|
|
254
246
|
interface SearchAnalyticsQueryRequest {
|
|
255
247
|
/** [Optional; Default is \"auto\"] How data is aggregated. If aggregated by property, all data for the same property is aggregated; if aggregated by page, all data is aggregated by canonical URI. If you filter or group by page, choose AUTO; otherwise you can aggregate either by property or by page, depending on how you want your data calculated; see the help documentation to learn how data is calculated differently by site versus by page. **Note:** If you group or filter by page, you cannot aggregate by property. If you specify any value other than AUTO, the aggregation type in the result will match the requested type, or if you request an invalid type, you will get an error. The API will never change your aggregation type if the requested type is invalid. */
|
|
256
248
|
aggregationType?:
|
|
257
|
-
| '
|
|
258
|
-
| 'BY_PROPERTY'
|
|
259
|
-
| 'BY_PAGE'
|
|
260
|
-
| 'BY_NEWS_SHOWCASE_PANEL';
|
|
249
|
+
'AUTO' | 'BY_PROPERTY' | 'BY_PAGE' | 'BY_NEWS_SHOWCASE_PANEL';
|
|
261
250
|
/** The data state to be fetched, can be full or all, the latter including full and partial data. */
|
|
262
251
|
dataState?: 'DATA_STATE_UNSPECIFIED' | 'FINAL' | 'ALL' | 'HOURLY_ALL';
|
|
263
252
|
/** [Optional] Zero or more filters to apply to the dimension grouping values; for example, 'query contains \"buy\"' to see only data where the query string contains the substring \"buy\" (not case-sensitive). You can filter by a dimension without grouping by it. */
|
|
@@ -277,12 +266,7 @@ declare namespace gapi.client {
|
|
|
277
266
|
rowLimit?: number;
|
|
278
267
|
/** [Optional; Default is \"web\"] The search type to filter for. */
|
|
279
268
|
searchType?:
|
|
280
|
-
| '
|
|
281
|
-
| 'IMAGE'
|
|
282
|
-
| 'VIDEO'
|
|
283
|
-
| 'NEWS'
|
|
284
|
-
| 'DISCOVER'
|
|
285
|
-
| 'GOOGLE_NEWS';
|
|
269
|
+
'WEB' | 'IMAGE' | 'VIDEO' | 'NEWS' | 'DISCOVER' | 'GOOGLE_NEWS';
|
|
286
270
|
/** [Required] Start date of the requested date range, in YYYY-MM-DD format, in PST time (UTC - 8:00). Must be less than or equal to the end date. This value is included in the range. */
|
|
287
271
|
startDate?: string;
|
|
288
272
|
/** [Optional; Default is 0] Zero-based index of the first row in the response. Must be a non-negative number. */
|
|
@@ -295,10 +279,7 @@ declare namespace gapi.client {
|
|
|
295
279
|
metadata?: Metadata;
|
|
296
280
|
/** How the results were aggregated. */
|
|
297
281
|
responseAggregationType?:
|
|
298
|
-
| '
|
|
299
|
-
| 'BY_PROPERTY'
|
|
300
|
-
| 'BY_PAGE'
|
|
301
|
-
| 'BY_NEWS_SHOWCASE_PANEL';
|
|
282
|
+
'AUTO' | 'BY_PROPERTY' | 'BY_PAGE' | 'BY_NEWS_SHOWCASE_PANEL';
|
|
302
283
|
/** A list of rows grouped by the key values in the order given in the query. */
|
|
303
284
|
rows?: ApiDataRow[];
|
|
304
285
|
}
|
|
@@ -514,11 +495,7 @@ declare namespace gapi.client {
|
|
|
514
495
|
interface AmpInspectionResult {
|
|
515
496
|
/** Index status of the AMP URL. */
|
|
516
497
|
ampIndexStatusVerdict?:
|
|
517
|
-
| '
|
|
518
|
-
| 'PASS'
|
|
519
|
-
| 'PARTIAL'
|
|
520
|
-
| 'FAIL'
|
|
521
|
-
| 'NEUTRAL';
|
|
498
|
+
'VERDICT_UNSPECIFIED' | 'PASS' | 'PARTIAL' | 'FAIL' | 'NEUTRAL';
|
|
522
499
|
/** URL of the AMP that was inspected. If the submitted URL is a desktop page that refers to an AMP version, the AMP version will be inspected. */
|
|
523
500
|
ampUrl?: string;
|
|
524
501
|
/** Whether or not the page blocks indexing through a noindex rule. */
|
|
@@ -547,9 +524,7 @@ declare namespace gapi.client {
|
|
|
547
524
|
| 'INVALID_URL';
|
|
548
525
|
/** Whether or not the page is blocked to Google by a robots.txt rule. */
|
|
549
526
|
robotsTxtState?:
|
|
550
|
-
| '
|
|
551
|
-
| 'ALLOWED'
|
|
552
|
-
| 'DISALLOWED';
|
|
527
|
+
'ROBOTS_TXT_STATE_UNSPECIFIED' | 'ALLOWED' | 'DISALLOWED';
|
|
553
528
|
/** The status of the most severe error on the page. If a page has both warnings and errors, the page status is error. Error status means the page cannot be shown in Search results. */
|
|
554
529
|
verdict?: 'VERDICT_UNSPECIFIED' | 'PASS' | 'PARTIAL' | 'FAIL' | 'NEUTRAL';
|
|
555
530
|
}
|
|
@@ -631,9 +606,7 @@ declare namespace gapi.client {
|
|
|
631
606
|
referringUrls?: string[];
|
|
632
607
|
/** Whether or not the page is blocked to Google by a robots.txt rule. */
|
|
633
608
|
robotsTxtState?:
|
|
634
|
-
| '
|
|
635
|
-
| 'ALLOWED'
|
|
636
|
-
| 'DISALLOWED';
|
|
609
|
+
'ROBOTS_TXT_STATE_UNSPECIFIED' | 'ALLOWED' | 'DISALLOWED';
|
|
637
610
|
/** Any sitemaps that this URL was listed in, as known by Google. Not guaranteed to be an exhaustive list, especially if Google did not discover this URL through a sitemap. Absent if no sitemaps were found. */
|
|
638
611
|
sitemap?: string[];
|
|
639
612
|
/** The URL that your page or site [declares as canonical](https://developers.google.com/search/docs/advanced/crawling/consolidate-duplicate-urls?#define-canonical). If you did not declare a canonical URL, this field is absent. */
|
|
@@ -737,10 +710,7 @@ declare namespace gapi.client {
|
|
|
737
710
|
interface SearchAnalyticsQueryRequest {
|
|
738
711
|
/** [Optional; Default is \"auto\"] How data is aggregated. If aggregated by property, all data for the same property is aggregated; if aggregated by page, all data is aggregated by canonical URI. If you filter or group by page, choose AUTO; otherwise you can aggregate either by property or by page, depending on how you want your data calculated; see the help documentation to learn how data is calculated differently by site versus by page. **Note:** If you group or filter by page, you cannot aggregate by property. If you specify any value other than AUTO, the aggregation type in the result will match the requested type, or if you request an invalid type, you will get an error. The API will never change your aggregation type if the requested type is invalid. */
|
|
739
712
|
aggregationType?:
|
|
740
|
-
| '
|
|
741
|
-
| 'BY_PROPERTY'
|
|
742
|
-
| 'BY_PAGE'
|
|
743
|
-
| 'BY_NEWS_SHOWCASE_PANEL';
|
|
713
|
+
'AUTO' | 'BY_PROPERTY' | 'BY_PAGE' | 'BY_NEWS_SHOWCASE_PANEL';
|
|
744
714
|
/** The data state to be fetched, can be full or all, the latter including full and partial data. */
|
|
745
715
|
dataState?: 'DATA_STATE_UNSPECIFIED' | 'FINAL' | 'ALL' | 'HOURLY_ALL';
|
|
746
716
|
/** [Optional] Zero or more filters to apply to the dimension grouping values; for example, 'query contains \"buy\"' to see only data where the query string contains the substring \"buy\" (not case-sensitive). You can filter by a dimension without grouping by it. */
|
|
@@ -760,12 +730,7 @@ declare namespace gapi.client {
|
|
|
760
730
|
rowLimit?: number;
|
|
761
731
|
/** [Optional; Default is \"web\"] The search type to filter for. */
|
|
762
732
|
searchType?:
|
|
763
|
-
| '
|
|
764
|
-
| 'IMAGE'
|
|
765
|
-
| 'VIDEO'
|
|
766
|
-
| 'NEWS'
|
|
767
|
-
| 'DISCOVER'
|
|
768
|
-
| 'GOOGLE_NEWS';
|
|
733
|
+
'WEB' | 'IMAGE' | 'VIDEO' | 'NEWS' | 'DISCOVER' | 'GOOGLE_NEWS';
|
|
769
734
|
/** [Required] Start date of the requested date range, in YYYY-MM-DD format, in PST time (UTC - 8:00). Must be less than or equal to the end date. This value is included in the range. */
|
|
770
735
|
startDate?: string;
|
|
771
736
|
/** [Optional; Default is 0] Zero-based index of the first row in the response. Must be a non-negative number. */
|
|
@@ -778,10 +743,7 @@ declare namespace gapi.client {
|
|
|
778
743
|
metadata?: Metadata;
|
|
779
744
|
/** How the results were aggregated. */
|
|
780
745
|
responseAggregationType?:
|
|
781
|
-
| '
|
|
782
|
-
| 'BY_PROPERTY'
|
|
783
|
-
| 'BY_PAGE'
|
|
784
|
-
| 'BY_NEWS_SHOWCASE_PANEL';
|
|
746
|
+
'AUTO' | 'BY_PROPERTY' | 'BY_PAGE' | 'BY_NEWS_SHOWCASE_PANEL';
|
|
785
747
|
/** A list of rows grouped by the key values in the order given in the query. */
|
|
786
748
|
rows?: ApiDataRow[];
|
|
787
749
|
}
|