@gscdump/contracts 3.5.0 → 3.6.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/README.md +16 -26
- package/dist/archetypes.d.mts +32 -33
- package/dist/endpoints.d.mts +3 -4
- package/dist/file-resolution.d.mts +11 -12
- package/dist/onboarding.d.mts +38 -39
- package/dist/routes.d.mts +3 -4
- package/dist/schemas.d.mts +139 -140
- package/dist/search-types.d.mts +2 -3
- package/dist/types.d.mts +155 -155
- package/dist/v1/bing-data.d.mts +4 -5
- package/dist/v1/bing.d.mts +4 -5
- package/dist/v1/browser.d.mts +4 -5
- package/dist/v1/documents.d.mts +3 -4
- package/dist/v1/http-core.d.mts +39 -39
- package/dist/v1/http-operation-error.d.mts +2 -3
- package/dist/v1/operations.d.mts +138 -139
- package/dist/v1/paths.d.mts +7 -7
- package/dist/v1/realtime.d.mts +30 -31
- package/dist/v1/route-catalog.d.mts +5 -6
- package/dist/v1/route-surfaces.d.mts +2 -3
- package/dist/v1/version.d.mts +1 -2
- package/dist/webhook-constants.d.mts +8 -9
- package/package.json +4 -4
package/dist/types.d.mts
CHANGED
|
@@ -1,35 +1,35 @@
|
|
|
1
1
|
import { GscSearchType } from "./search-types.mjs";
|
|
2
2
|
import { FileResolutionResponse } from "./file-resolution.mjs";
|
|
3
3
|
import { AccountNextAction, AccountStatus, PartnerLifecycleAccount, PartnerLifecycleResponse, PartnerLifecycleSite } from "./onboarding.mjs";
|
|
4
|
-
type TableName = 'pages' | 'queries' | 'countries' | 'page_queries' | 'dates' | 'search_appearance' | 'search_appearance_pages' | 'search_appearance_queries' | 'search_appearance_page_queries' | 'hourly_pages';
|
|
4
|
+
export type TableName = 'pages' | 'queries' | 'countries' | 'page_queries' | 'dates' | 'search_appearance' | 'search_appearance_pages' | 'search_appearance_queries' | 'search_appearance_page_queries' | 'hourly_pages';
|
|
5
5
|
/**
|
|
6
6
|
* Temporal granularity axis. Daily callers (`'day'`, default) read/write rows
|
|
7
7
|
* keyed by `date`; hourly callers (`'hour'`) read/write rows that additionally
|
|
8
8
|
* carry a `hour` field. Composes with `searchType` — hourly is only meaningful
|
|
9
9
|
* for Discover at the moment but the engine is generic.
|
|
10
10
|
*/
|
|
11
|
-
type Grain = 'day' | 'hour';
|
|
12
|
-
type Row = Record<string, unknown>;
|
|
13
|
-
type ColumnType = 'DATE' | 'VARCHAR' | 'INTEGER' | 'BIGINT' | 'DOUBLE';
|
|
14
|
-
interface ColumnDef {
|
|
11
|
+
export type Grain = 'day' | 'hour';
|
|
12
|
+
export type Row = Record<string, unknown>;
|
|
13
|
+
export type ColumnType = 'DATE' | 'VARCHAR' | 'INTEGER' | 'BIGINT' | 'DOUBLE';
|
|
14
|
+
export interface ColumnDef {
|
|
15
15
|
name: string;
|
|
16
16
|
type: ColumnType;
|
|
17
17
|
nullable: boolean;
|
|
18
18
|
}
|
|
19
|
-
interface TableSchema {
|
|
19
|
+
export interface TableSchema {
|
|
20
20
|
name: TableName;
|
|
21
21
|
columns: ColumnDef[];
|
|
22
22
|
sortKey: string[];
|
|
23
23
|
version: number;
|
|
24
24
|
}
|
|
25
|
-
interface TenantCtx {
|
|
25
|
+
export interface TenantCtx {
|
|
26
26
|
userId: string;
|
|
27
27
|
siteId?: string;
|
|
28
28
|
}
|
|
29
|
-
type Dimension = 'page' | 'query' | 'queryCanonical' | 'country' | 'device' | 'date' | 'searchAppearance' | 'hour';
|
|
30
|
-
type Metric = 'clicks' | 'impressions' | 'ctr' | 'position';
|
|
31
|
-
type Filter = unknown;
|
|
32
|
-
interface BuilderStateWire {
|
|
29
|
+
export type Dimension = 'page' | 'query' | 'queryCanonical' | 'country' | 'device' | 'date' | 'searchAppearance' | 'hour';
|
|
30
|
+
export type Metric = 'clicks' | 'impressions' | 'ctr' | 'position';
|
|
31
|
+
export type Filter = unknown;
|
|
32
|
+
export interface BuilderStateWire {
|
|
33
33
|
dimensions: Dimension[];
|
|
34
34
|
metrics?: Metric[];
|
|
35
35
|
filter?: Filter;
|
|
@@ -41,42 +41,42 @@ interface BuilderStateWire {
|
|
|
41
41
|
startRow?: number;
|
|
42
42
|
searchType?: GscSearchType;
|
|
43
43
|
}
|
|
44
|
-
interface GscApiRange {
|
|
44
|
+
export interface GscApiRange {
|
|
45
45
|
start: string;
|
|
46
46
|
end: string;
|
|
47
47
|
}
|
|
48
|
-
interface CountryRow {
|
|
48
|
+
export interface CountryRow {
|
|
49
49
|
country: string;
|
|
50
50
|
clicks: number;
|
|
51
51
|
impressions: number;
|
|
52
52
|
sum_position: number;
|
|
53
53
|
}
|
|
54
|
-
interface CountriesResponse {
|
|
54
|
+
export interface CountriesResponse {
|
|
55
55
|
rows: CountryRow[];
|
|
56
56
|
range: GscApiRange;
|
|
57
57
|
generatedAt: string;
|
|
58
58
|
source: 'gsc-api' | 'engine';
|
|
59
59
|
}
|
|
60
|
-
interface SearchAppearanceRow {
|
|
60
|
+
export interface SearchAppearanceRow {
|
|
61
61
|
searchAppearance: string;
|
|
62
62
|
clicks: number;
|
|
63
63
|
impressions: number;
|
|
64
64
|
sum_position: number;
|
|
65
65
|
}
|
|
66
|
-
interface SearchAppearanceResponse {
|
|
66
|
+
export interface SearchAppearanceResponse {
|
|
67
67
|
rows: SearchAppearanceRow[];
|
|
68
68
|
range: GscApiRange;
|
|
69
69
|
generatedAt: string;
|
|
70
70
|
source: 'gsc-api' | 'engine';
|
|
71
71
|
}
|
|
72
|
-
interface SiteListItem {
|
|
72
|
+
export interface SiteListItem {
|
|
73
73
|
id: string;
|
|
74
74
|
label: string;
|
|
75
75
|
hostname: string;
|
|
76
76
|
propertyType: 'domain' | 'url-prefix';
|
|
77
77
|
readBackend?: 'd1' | 'r2';
|
|
78
78
|
}
|
|
79
|
-
interface ScheduleState {
|
|
79
|
+
export interface ScheduleState {
|
|
80
80
|
nextAt: number;
|
|
81
81
|
consecutiveUnchanged: number;
|
|
82
82
|
policyVersion: number;
|
|
@@ -91,7 +91,7 @@ interface ScheduleState {
|
|
|
91
91
|
* Additional keys are tolerated (`[key: string]: unknown`) for
|
|
92
92
|
* forward-compatibility — new fields can ship without a contract bump.
|
|
93
93
|
*/
|
|
94
|
-
interface InspectionRecordRaw {
|
|
94
|
+
export interface InspectionRecordRaw {
|
|
95
95
|
/** Adaptive recheck schedule owned by `inspectionPolicy.observe`. */
|
|
96
96
|
schedule?: ScheduleState;
|
|
97
97
|
/** Unix seconds. Mirrors the `next_check_after` column. */
|
|
@@ -112,7 +112,7 @@ interface InspectionRecordRaw {
|
|
|
112
112
|
inspectionResultLink?: string | null;
|
|
113
113
|
[key: string]: unknown;
|
|
114
114
|
}
|
|
115
|
-
interface InspectionHistoryRecord {
|
|
115
|
+
export interface InspectionHistoryRecord {
|
|
116
116
|
url: string;
|
|
117
117
|
inspectedAt: string;
|
|
118
118
|
indexStatus?: string;
|
|
@@ -127,32 +127,32 @@ interface InspectionHistoryRecord {
|
|
|
127
127
|
richResultsVerdict?: string;
|
|
128
128
|
raw?: InspectionRecordRaw;
|
|
129
129
|
}
|
|
130
|
-
interface InspectionHistoryResponse {
|
|
130
|
+
export interface InspectionHistoryResponse {
|
|
131
131
|
url: string | null;
|
|
132
132
|
records: InspectionHistoryRecord[];
|
|
133
133
|
}
|
|
134
|
-
interface InspectionIndex {
|
|
134
|
+
export interface InspectionIndex {
|
|
135
135
|
version: 1;
|
|
136
136
|
records: Record<string, InspectionHistoryRecord>;
|
|
137
137
|
}
|
|
138
|
-
interface RollupEnvelope<T = unknown> {
|
|
138
|
+
export interface RollupEnvelope<T = unknown> {
|
|
139
139
|
version: 1;
|
|
140
140
|
id: string;
|
|
141
141
|
builtAt: number;
|
|
142
142
|
windowDays: number | null;
|
|
143
143
|
payload: T;
|
|
144
144
|
}
|
|
145
|
-
interface GscRowQueryMeta {
|
|
145
|
+
export interface GscRowQueryMeta {
|
|
146
146
|
sourceName: string;
|
|
147
147
|
sourceKind: 'row' | 'sql';
|
|
148
148
|
queryMs: number;
|
|
149
149
|
}
|
|
150
|
-
interface GscRowQueryResponse<T = Record<string, unknown>> {
|
|
150
|
+
export interface GscRowQueryResponse<T = Record<string, unknown>> {
|
|
151
151
|
rows: T[];
|
|
152
152
|
meta: GscRowQueryMeta;
|
|
153
153
|
}
|
|
154
|
-
type IndexingUrlStatus = 'indexed' | 'not_indexed' | 'pending';
|
|
155
|
-
interface IndexingUrlRow {
|
|
154
|
+
export type IndexingUrlStatus = 'indexed' | 'not_indexed' | 'pending';
|
|
155
|
+
export interface IndexingUrlRow {
|
|
156
156
|
url: string;
|
|
157
157
|
issueType?: string | null;
|
|
158
158
|
verdict: string | null;
|
|
@@ -175,7 +175,7 @@ interface IndexingUrlRow {
|
|
|
175
175
|
lastCheckedAt: string;
|
|
176
176
|
checkCount: number;
|
|
177
177
|
}
|
|
178
|
-
interface IndexingUrlsResponse {
|
|
178
|
+
export interface IndexingUrlsResponse {
|
|
179
179
|
urls: IndexingUrlRow[];
|
|
180
180
|
pagination: {
|
|
181
181
|
total: number;
|
|
@@ -189,8 +189,8 @@ interface IndexingUrlsResponse {
|
|
|
189
189
|
issue: string | null;
|
|
190
190
|
};
|
|
191
191
|
}
|
|
192
|
-
type IndexingIssueSeverity = 'error' | 'warning' | 'info';
|
|
193
|
-
interface IndexingIssue {
|
|
192
|
+
export type IndexingIssueSeverity = 'error' | 'warning' | 'info';
|
|
193
|
+
export interface IndexingIssue {
|
|
194
194
|
type: string;
|
|
195
195
|
label: string;
|
|
196
196
|
severity: IndexingIssueSeverity;
|
|
@@ -198,7 +198,7 @@ interface IndexingIssue {
|
|
|
198
198
|
description: string;
|
|
199
199
|
fix: string;
|
|
200
200
|
}
|
|
201
|
-
interface IndexingDiagnostics {
|
|
201
|
+
export interface IndexingDiagnostics {
|
|
202
202
|
summary: {
|
|
203
203
|
totalUrls: number;
|
|
204
204
|
indexed: number;
|
|
@@ -215,14 +215,14 @@ interface IndexingDiagnostics {
|
|
|
215
215
|
rollupBuiltAt?: number;
|
|
216
216
|
};
|
|
217
217
|
}
|
|
218
|
-
interface IndexingDiagnosticsParams {
|
|
218
|
+
export interface IndexingDiagnosticsParams {
|
|
219
219
|
sampleIssues?: string[] | string;
|
|
220
220
|
sampleLimit?: number;
|
|
221
221
|
}
|
|
222
|
-
interface IndexingInspectRequest {
|
|
222
|
+
export interface IndexingInspectRequest {
|
|
223
223
|
urls: string[];
|
|
224
224
|
}
|
|
225
|
-
interface IndexingInspectResult {
|
|
225
|
+
export interface IndexingInspectResult {
|
|
226
226
|
url: string;
|
|
227
227
|
verdict: string | null;
|
|
228
228
|
coverageState: string | null;
|
|
@@ -241,12 +241,12 @@ interface IndexingInspectResult {
|
|
|
241
241
|
richResultsItems: string | null;
|
|
242
242
|
inspectionResultLink: string | null;
|
|
243
243
|
}
|
|
244
|
-
interface IndexingInspectRateLimit {
|
|
244
|
+
export interface IndexingInspectRateLimit {
|
|
245
245
|
reserved: number;
|
|
246
246
|
remaining: number;
|
|
247
247
|
limit: number;
|
|
248
248
|
}
|
|
249
|
-
interface IndexingInspectResponse {
|
|
249
|
+
export interface IndexingInspectResponse {
|
|
250
250
|
siteId: string;
|
|
251
251
|
rateLimit: IndexingInspectRateLimit;
|
|
252
252
|
results: IndexingInspectResult[];
|
|
@@ -259,7 +259,7 @@ interface IndexingInspectResponse {
|
|
|
259
259
|
reason: string;
|
|
260
260
|
}>;
|
|
261
261
|
}
|
|
262
|
-
interface IndexingInspectRateLimited {
|
|
262
|
+
export interface IndexingInspectRateLimited {
|
|
263
263
|
error: 'rate_limited';
|
|
264
264
|
message: string;
|
|
265
265
|
rateLimit: {
|
|
@@ -269,17 +269,17 @@ interface IndexingInspectRateLimited {
|
|
|
269
269
|
};
|
|
270
270
|
retryAfterSeconds: number;
|
|
271
271
|
}
|
|
272
|
-
interface SitemapAddedRow {
|
|
272
|
+
export interface SitemapAddedRow {
|
|
273
273
|
url: string;
|
|
274
274
|
sitemap: string;
|
|
275
275
|
firstSeenAt: number;
|
|
276
276
|
}
|
|
277
|
-
interface SitemapRemovedRow {
|
|
277
|
+
export interface SitemapRemovedRow {
|
|
278
278
|
url: string;
|
|
279
279
|
sitemap: string;
|
|
280
280
|
removedAt: number;
|
|
281
281
|
}
|
|
282
|
-
type SitemapChangesCompleteness = {
|
|
282
|
+
export type SitemapChangesCompleteness = {
|
|
283
283
|
_tag: 'complete';
|
|
284
284
|
scannedUrls: number;
|
|
285
285
|
} | {
|
|
@@ -294,7 +294,7 @@ type SitemapChangesCompleteness = {
|
|
|
294
294
|
updated: number;
|
|
295
295
|
};
|
|
296
296
|
};
|
|
297
|
-
interface SitemapChangesResponse {
|
|
297
|
+
export interface SitemapChangesResponse {
|
|
298
298
|
added: SitemapAddedRow[];
|
|
299
299
|
removed: SitemapRemovedRow[];
|
|
300
300
|
summary: {
|
|
@@ -307,8 +307,8 @@ interface SitemapChangesResponse {
|
|
|
307
307
|
};
|
|
308
308
|
completeness: SitemapChangesCompleteness;
|
|
309
309
|
}
|
|
310
|
-
type AnalysisSourcesResponse = GscdumpAnalysisSourcesResponse;
|
|
311
|
-
interface SourceInfoResponse {
|
|
310
|
+
export type AnalysisSourcesResponse = GscdumpAnalysisSourcesResponse;
|
|
311
|
+
export interface SourceInfoResponse {
|
|
312
312
|
name: string;
|
|
313
313
|
kind: 'row' | 'sql';
|
|
314
314
|
capabilities: {
|
|
@@ -319,22 +319,22 @@ interface SourceInfoResponse {
|
|
|
319
319
|
browserAttachEligible: boolean;
|
|
320
320
|
identityAttrs?: Record<string, unknown> | null;
|
|
321
321
|
}
|
|
322
|
-
interface WhoamiResponse {
|
|
322
|
+
export interface WhoamiResponse {
|
|
323
323
|
userId?: string | null;
|
|
324
324
|
plan?: string | null;
|
|
325
325
|
attrs?: Record<string, unknown>;
|
|
326
326
|
}
|
|
327
|
-
interface BackfillRange {
|
|
327
|
+
export interface BackfillRange {
|
|
328
328
|
startDate: string;
|
|
329
329
|
endDate: string;
|
|
330
330
|
}
|
|
331
|
-
interface BackfillResponse {
|
|
331
|
+
export interface BackfillResponse {
|
|
332
332
|
ok?: boolean;
|
|
333
333
|
queued?: boolean;
|
|
334
334
|
[key: string]: unknown;
|
|
335
335
|
}
|
|
336
|
-
type GscComparisonFilter = 'new' | 'lost' | 'improving' | 'declining';
|
|
337
|
-
interface GscdumpDataRow {
|
|
336
|
+
export type GscComparisonFilter = 'new' | 'lost' | 'improving' | 'declining';
|
|
337
|
+
export interface GscdumpDataRow {
|
|
338
338
|
page?: string;
|
|
339
339
|
query?: string;
|
|
340
340
|
queryCanonical?: string;
|
|
@@ -364,7 +364,7 @@ interface GscdumpDataRow {
|
|
|
364
364
|
firstDate?: string;
|
|
365
365
|
lastDate?: string;
|
|
366
366
|
}
|
|
367
|
-
interface GscdumpMeta {
|
|
367
|
+
export interface GscdumpMeta {
|
|
368
368
|
siteUrl: string;
|
|
369
369
|
syncStatus: string;
|
|
370
370
|
newestDateSynced: string | null;
|
|
@@ -381,19 +381,19 @@ interface GscdumpMeta {
|
|
|
381
381
|
daysRemaining?: number;
|
|
382
382
|
};
|
|
383
383
|
}
|
|
384
|
-
interface GscdumpTotals {
|
|
384
|
+
export interface GscdumpTotals {
|
|
385
385
|
clicks: number;
|
|
386
386
|
impressions: number;
|
|
387
387
|
ctr: number;
|
|
388
388
|
position: number;
|
|
389
389
|
}
|
|
390
|
-
interface GscdumpDataResponse {
|
|
390
|
+
export interface GscdumpDataResponse {
|
|
391
391
|
rows: GscdumpDataRow[];
|
|
392
392
|
totalCount: number;
|
|
393
393
|
totals: GscdumpTotals;
|
|
394
394
|
meta: GscdumpMeta;
|
|
395
395
|
}
|
|
396
|
-
interface GscdumpDataDetailResponse {
|
|
396
|
+
export interface GscdumpDataDetailResponse {
|
|
397
397
|
daily: Array<{
|
|
398
398
|
date: string;
|
|
399
399
|
clicks: number;
|
|
@@ -412,13 +412,13 @@ interface GscdumpDataDetailResponse {
|
|
|
412
412
|
previousTotals?: GscdumpTotals;
|
|
413
413
|
meta: GscdumpMeta;
|
|
414
414
|
}
|
|
415
|
-
interface GscdumpUserRegistration {
|
|
415
|
+
export interface GscdumpUserRegistration {
|
|
416
416
|
userId: string;
|
|
417
417
|
apiKey?: string;
|
|
418
418
|
isNew?: boolean;
|
|
419
419
|
status?: 'provisioning' | 'ready';
|
|
420
420
|
}
|
|
421
|
-
interface GscdumpUserStatus {
|
|
421
|
+
export interface GscdumpUserStatus {
|
|
422
422
|
userId: string;
|
|
423
423
|
status: 'provisioning' | 'ready' | 'reauth_required';
|
|
424
424
|
databaseReady?: boolean;
|
|
@@ -429,12 +429,12 @@ interface GscdumpUserStatus {
|
|
|
429
429
|
nextAction?: 'reconnect_google' | 'none';
|
|
430
430
|
grantedScopes?: string | null;
|
|
431
431
|
}
|
|
432
|
-
interface GscdumpUserTokenUpdate {
|
|
432
|
+
export interface GscdumpUserTokenUpdate {
|
|
433
433
|
userId: string;
|
|
434
434
|
updated: boolean;
|
|
435
435
|
sites: GscdumpAvailableSite[];
|
|
436
436
|
}
|
|
437
|
-
interface GscdumpAvailableSite {
|
|
437
|
+
export interface GscdumpAvailableSite {
|
|
438
438
|
siteUrl: string;
|
|
439
439
|
permissionLevel: string;
|
|
440
440
|
registered: boolean;
|
|
@@ -452,16 +452,16 @@ interface GscdumpAvailableSite {
|
|
|
452
452
|
newestDateSynced?: string | null;
|
|
453
453
|
oldestDateSynced?: string | null;
|
|
454
454
|
}
|
|
455
|
-
interface GscdumpSiteIntIdCrosswalkEntry {
|
|
455
|
+
export interface GscdumpSiteIntIdCrosswalkEntry {
|
|
456
456
|
siteId: string;
|
|
457
457
|
intId: number;
|
|
458
458
|
siteUrl: string;
|
|
459
459
|
}
|
|
460
|
-
interface GscdumpSiteIntIdCrosswalkResponse {
|
|
460
|
+
export interface GscdumpSiteIntIdCrosswalkResponse {
|
|
461
461
|
crosswalk: Record<string, number>;
|
|
462
462
|
sites: GscdumpSiteIntIdCrosswalkEntry[];
|
|
463
463
|
}
|
|
464
|
-
interface GscdumpSiteRegistration {
|
|
464
|
+
export interface GscdumpSiteRegistration {
|
|
465
465
|
siteId: string;
|
|
466
466
|
/** Integer alias (`user_sites.int_id`) — the int JOIN key partners denormalize into their own catalog namespaces. */
|
|
467
467
|
intId?: number | null;
|
|
@@ -476,22 +476,22 @@ interface GscdumpSiteRegistration {
|
|
|
476
476
|
grantedScopes?: string[];
|
|
477
477
|
site?: PartnerLifecycleSite | null;
|
|
478
478
|
}
|
|
479
|
-
type GscVerificationMethod = 'META' | 'FILE' | 'DNS_TXT' | 'DNS_CNAME' | 'ANALYTICS' | 'TAG_MANAGER';
|
|
480
|
-
interface GscVerificationSite {
|
|
479
|
+
export type GscVerificationMethod = 'META' | 'FILE' | 'DNS_TXT' | 'DNS_CNAME' | 'ANALYTICS' | 'TAG_MANAGER';
|
|
480
|
+
export interface GscVerificationSite {
|
|
481
481
|
type: 'SITE' | 'INET_DOMAIN';
|
|
482
482
|
identifier: string;
|
|
483
483
|
}
|
|
484
|
-
interface GscVerificationDnsRecord {
|
|
484
|
+
export interface GscVerificationDnsRecord {
|
|
485
485
|
type: 'TXT' | 'CNAME';
|
|
486
486
|
host: string;
|
|
487
487
|
value: string;
|
|
488
488
|
}
|
|
489
|
-
interface GscVerificationRequest {
|
|
489
|
+
export interface GscVerificationRequest {
|
|
490
490
|
userId?: string;
|
|
491
491
|
siteUrl: string;
|
|
492
492
|
method?: GscVerificationMethod;
|
|
493
493
|
}
|
|
494
|
-
interface GscVerificationTokenResponse {
|
|
494
|
+
export interface GscVerificationTokenResponse {
|
|
495
495
|
siteUrl: string;
|
|
496
496
|
site: GscVerificationSite;
|
|
497
497
|
method: GscVerificationMethod;
|
|
@@ -499,14 +499,14 @@ interface GscVerificationTokenResponse {
|
|
|
499
499
|
metaContent: string | null;
|
|
500
500
|
dnsRecord: GscVerificationDnsRecord | null;
|
|
501
501
|
}
|
|
502
|
-
interface GscAddAndVerifyResponse {
|
|
502
|
+
export interface GscAddAndVerifyResponse {
|
|
503
503
|
siteUrl: string;
|
|
504
504
|
site: GscVerificationSite;
|
|
505
505
|
method: GscVerificationMethod;
|
|
506
506
|
verified: true;
|
|
507
507
|
owners: string[];
|
|
508
508
|
}
|
|
509
|
-
interface GscdumpUserSite {
|
|
509
|
+
export interface GscdumpUserSite {
|
|
510
510
|
siteId: string;
|
|
511
511
|
siteUrl: string;
|
|
512
512
|
analyticsSyncStatus?: 'idle' | 'pending' | 'syncing' | 'synced' | 'error';
|
|
@@ -539,7 +539,7 @@ interface GscdumpUserSite {
|
|
|
539
539
|
newestDateSynced: string | null;
|
|
540
540
|
oldestDateSynced: string | null;
|
|
541
541
|
}
|
|
542
|
-
interface GscdumpSyncStatusResponse {
|
|
542
|
+
export interface GscdumpSyncStatusResponse {
|
|
543
543
|
siteUrl: string;
|
|
544
544
|
syncStatus: 'pending' | 'syncing' | 'synced' | 'error';
|
|
545
545
|
oldestDateAvailable: string | null;
|
|
@@ -582,7 +582,7 @@ interface GscdumpSyncStatusResponse {
|
|
|
582
582
|
retryCount: number;
|
|
583
583
|
}>;
|
|
584
584
|
}
|
|
585
|
-
interface GscdumpSitemap {
|
|
585
|
+
export interface GscdumpSitemap {
|
|
586
586
|
path: string;
|
|
587
587
|
errors: number;
|
|
588
588
|
warnings: number;
|
|
@@ -594,20 +594,20 @@ interface GscdumpSitemap {
|
|
|
594
594
|
isPending: boolean;
|
|
595
595
|
fetchedAt: number;
|
|
596
596
|
}
|
|
597
|
-
interface GscdumpSitemapHistory {
|
|
597
|
+
export interface GscdumpSitemapHistory {
|
|
598
598
|
date: string;
|
|
599
599
|
errors: number;
|
|
600
600
|
warnings: number;
|
|
601
601
|
urlCount: number;
|
|
602
602
|
urlDelta: number;
|
|
603
603
|
}
|
|
604
|
-
interface GscdumpPerSitemapHistoryEntry {
|
|
604
|
+
export interface GscdumpPerSitemapHistoryEntry {
|
|
605
605
|
date: string;
|
|
606
606
|
urlCount: number;
|
|
607
607
|
changed: boolean;
|
|
608
608
|
urlDelta: number;
|
|
609
609
|
}
|
|
610
|
-
interface GscdumpSitemapsResponse {
|
|
610
|
+
export interface GscdumpSitemapsResponse {
|
|
611
611
|
sitemaps: GscdumpSitemap[];
|
|
612
612
|
history: GscdumpSitemapHistory[];
|
|
613
613
|
perSitemapHistory: Record<string, GscdumpPerSitemapHistoryEntry[]>;
|
|
@@ -622,7 +622,7 @@ interface GscdumpSitemapsResponse {
|
|
|
622
622
|
};
|
|
623
623
|
generation: GscdumpSitemapGeneration | null;
|
|
624
624
|
}
|
|
625
|
-
interface GscdumpSitemapChangesResponse {
|
|
625
|
+
export interface GscdumpSitemapChangesResponse {
|
|
626
626
|
added: {
|
|
627
627
|
url: string;
|
|
628
628
|
sitemap: string;
|
|
@@ -651,7 +651,7 @@ interface GscdumpSitemapChangesResponse {
|
|
|
651
651
|
completeness: SitemapChangesCompleteness;
|
|
652
652
|
generation: GscdumpSitemapGeneration | null;
|
|
653
653
|
}
|
|
654
|
-
interface GscdumpSitemapGeneration {
|
|
654
|
+
export interface GscdumpSitemapGeneration {
|
|
655
655
|
id: string;
|
|
656
656
|
observedAt: number;
|
|
657
657
|
publishedAt: number;
|
|
@@ -668,13 +668,13 @@ interface GscdumpSitemapGeneration {
|
|
|
668
668
|
source: 'gsc_sitemaps';
|
|
669
669
|
};
|
|
670
670
|
}
|
|
671
|
-
type PartnerSitemapAction = {
|
|
671
|
+
export type PartnerSitemapAction = {
|
|
672
672
|
action: 'submit' | 'delete';
|
|
673
673
|
sitemapUrl: string;
|
|
674
674
|
} | {
|
|
675
675
|
action: 'refresh' | 'auto-discover';
|
|
676
676
|
};
|
|
677
|
-
type PartnerSitemapActionResponse = {
|
|
677
|
+
export type PartnerSitemapActionResponse = {
|
|
678
678
|
success: boolean;
|
|
679
679
|
action: 'submitted' | 'deleted';
|
|
680
680
|
sitemapUrl: string;
|
|
@@ -692,11 +692,11 @@ type PartnerSitemapActionResponse = {
|
|
|
692
692
|
submitError?: string | null;
|
|
693
693
|
sitemapCount: number;
|
|
694
694
|
};
|
|
695
|
-
interface GscdumpSitemapMembershipParams {
|
|
695
|
+
export interface GscdumpSitemapMembershipParams {
|
|
696
696
|
urls: string[];
|
|
697
697
|
generationId?: string;
|
|
698
698
|
}
|
|
699
|
-
type GscdumpSitemapMembershipEvidence = {
|
|
699
|
+
export type GscdumpSitemapMembershipEvidence = {
|
|
700
700
|
_tag: 'present';
|
|
701
701
|
url: string;
|
|
702
702
|
feedpath: string;
|
|
@@ -712,7 +712,7 @@ type GscdumpSitemapMembershipEvidence = {
|
|
|
712
712
|
url: string;
|
|
713
713
|
reason: 'no_generation' | 'generation_not_found' | 'generation_incomplete' | 'history_pruned' | 'invalid_url';
|
|
714
714
|
};
|
|
715
|
-
interface GscdumpSitemapMembershipResponse {
|
|
715
|
+
export interface GscdumpSitemapMembershipResponse {
|
|
716
716
|
generation: GscdumpSitemapGeneration | null;
|
|
717
717
|
evidence: GscdumpSitemapMembershipEvidence[];
|
|
718
718
|
meta: {
|
|
@@ -721,7 +721,7 @@ interface GscdumpSitemapMembershipResponse {
|
|
|
721
721
|
matched: number;
|
|
722
722
|
};
|
|
723
723
|
}
|
|
724
|
-
interface GscdumpSitemapUrlsResponse {
|
|
724
|
+
export interface GscdumpSitemapUrlsResponse {
|
|
725
725
|
generation: GscdumpSitemapGeneration;
|
|
726
726
|
items: Array<{
|
|
727
727
|
url: string;
|
|
@@ -735,7 +735,7 @@ interface GscdumpSitemapUrlsResponse {
|
|
|
735
735
|
limit: number;
|
|
736
736
|
};
|
|
737
737
|
}
|
|
738
|
-
interface GscdumpSitemapExportResponse {
|
|
738
|
+
export interface GscdumpSitemapExportResponse {
|
|
739
739
|
generation: GscdumpSitemapGeneration;
|
|
740
740
|
export: {
|
|
741
741
|
_tag: 'url';
|
|
@@ -748,7 +748,7 @@ interface GscdumpSitemapExportResponse {
|
|
|
748
748
|
reason: 'generation_not_found' | 'export_unavailable';
|
|
749
749
|
};
|
|
750
750
|
}
|
|
751
|
-
interface GscdumpIndexingTrendPoint {
|
|
751
|
+
export interface GscdumpIndexingTrendPoint {
|
|
752
752
|
date: string;
|
|
753
753
|
totalUrls: number;
|
|
754
754
|
indexedCount: number | null;
|
|
@@ -775,7 +775,7 @@ interface GscdumpIndexingTrendPoint {
|
|
|
775
775
|
richResultsFail: number;
|
|
776
776
|
};
|
|
777
777
|
}
|
|
778
|
-
interface GscdumpIndexingResponse {
|
|
778
|
+
export interface GscdumpIndexingResponse {
|
|
779
779
|
trend: GscdumpIndexingTrendPoint[];
|
|
780
780
|
summary: {
|
|
781
781
|
totalUrls: number;
|
|
@@ -813,14 +813,14 @@ interface GscdumpIndexingResponse {
|
|
|
813
813
|
rollupBuiltAt?: number;
|
|
814
814
|
};
|
|
815
815
|
}
|
|
816
|
-
type GscdumpIndexingUrlStatus = 'indexed' | 'not_indexed' | 'pending';
|
|
817
|
-
type GscdumpIndexingIssueSeverity = 'error' | 'warning' | 'info';
|
|
818
|
-
type GscdumpCanonicalDifferenceKind = 'none' | 'formatting' | 'path' | 'cross_domain';
|
|
819
|
-
interface GscdumpRichResultItem {
|
|
816
|
+
export type GscdumpIndexingUrlStatus = 'indexed' | 'not_indexed' | 'pending';
|
|
817
|
+
export type GscdumpIndexingIssueSeverity = 'error' | 'warning' | 'info';
|
|
818
|
+
export type GscdumpCanonicalDifferenceKind = 'none' | 'formatting' | 'path' | 'cross_domain';
|
|
819
|
+
export interface GscdumpRichResultItem {
|
|
820
820
|
richResultType: string;
|
|
821
821
|
items?: unknown[];
|
|
822
822
|
}
|
|
823
|
-
interface GscdumpIndexingUrl {
|
|
823
|
+
export interface GscdumpIndexingUrl {
|
|
824
824
|
url: string;
|
|
825
825
|
issueType?: string | null;
|
|
826
826
|
verdict: string | null;
|
|
@@ -844,7 +844,7 @@ interface GscdumpIndexingUrl {
|
|
|
844
844
|
lastCheckedAt: string;
|
|
845
845
|
checkCount?: number;
|
|
846
846
|
}
|
|
847
|
-
interface GscdumpIndexingUrlsResponse {
|
|
847
|
+
export interface GscdumpIndexingUrlsResponse {
|
|
848
848
|
urls: GscdumpIndexingUrl[];
|
|
849
849
|
pagination: {
|
|
850
850
|
total: number;
|
|
@@ -859,7 +859,7 @@ interface GscdumpIndexingUrlsResponse {
|
|
|
859
859
|
issue: string | null;
|
|
860
860
|
};
|
|
861
861
|
}
|
|
862
|
-
interface GscdumpIndexingDiagnosticsResponse {
|
|
862
|
+
export interface GscdumpIndexingDiagnosticsResponse {
|
|
863
863
|
summary: {
|
|
864
864
|
totalUrls: number;
|
|
865
865
|
indexed: number;
|
|
@@ -883,12 +883,12 @@ interface GscdumpIndexingDiagnosticsResponse {
|
|
|
883
883
|
rollupBuiltAt?: number;
|
|
884
884
|
};
|
|
885
885
|
}
|
|
886
|
-
type GscdumpIndexingInspectRequest = IndexingInspectRequest;
|
|
887
|
-
type GscdumpIndexingInspectResult = IndexingInspectResult;
|
|
888
|
-
type GscdumpIndexingInspectResponse = IndexingInspectResponse;
|
|
889
|
-
type GscdumpIndexingInspectRateLimited = IndexingInspectRateLimited;
|
|
890
|
-
type GscdumpAnalysisPreset = 'striking-distance' | 'opportunity' | 'decay' | 'zero-click' | 'non-brand' | 'brand-only' | 'movers-rising' | 'movers-declining';
|
|
891
|
-
interface GscdumpAnalysisParams {
|
|
886
|
+
export type GscdumpIndexingInspectRequest = IndexingInspectRequest;
|
|
887
|
+
export type GscdumpIndexingInspectResult = IndexingInspectResult;
|
|
888
|
+
export type GscdumpIndexingInspectResponse = IndexingInspectResponse;
|
|
889
|
+
export type GscdumpIndexingInspectRateLimited = IndexingInspectRateLimited;
|
|
890
|
+
export type GscdumpAnalysisPreset = 'striking-distance' | 'opportunity' | 'decay' | 'zero-click' | 'non-brand' | 'brand-only' | 'movers-rising' | 'movers-declining';
|
|
891
|
+
export interface GscdumpAnalysisParams {
|
|
892
892
|
preset: GscdumpAnalysisPreset;
|
|
893
893
|
startDate: string;
|
|
894
894
|
endDate: string;
|
|
@@ -904,7 +904,7 @@ interface GscdumpAnalysisParams {
|
|
|
904
904
|
maxCtr?: number;
|
|
905
905
|
searchType?: GscSearchType;
|
|
906
906
|
}
|
|
907
|
-
interface GscdumpAnalysisResponse {
|
|
907
|
+
export interface GscdumpAnalysisResponse {
|
|
908
908
|
preset: GscdumpAnalysisPreset;
|
|
909
909
|
keywords: Array<Record<string, unknown>>;
|
|
910
910
|
totalCount: number;
|
|
@@ -921,10 +921,10 @@ interface GscdumpAnalysisResponse {
|
|
|
921
921
|
presetDescription?: string;
|
|
922
922
|
};
|
|
923
923
|
}
|
|
924
|
-
interface GscdumpAnalysisBundleParams extends Omit<GscdumpAnalysisParams, 'preset'> {
|
|
924
|
+
export interface GscdumpAnalysisBundleParams extends Omit<GscdumpAnalysisParams, 'preset'> {
|
|
925
925
|
presets: GscdumpAnalysisPreset[];
|
|
926
926
|
}
|
|
927
|
-
interface GscdumpAnalysisBundleResponse {
|
|
927
|
+
export interface GscdumpAnalysisBundleResponse {
|
|
928
928
|
bundle: Record<string, {
|
|
929
929
|
keywords: Array<Record<string, unknown>>;
|
|
930
930
|
totalCount: number;
|
|
@@ -933,7 +933,7 @@ interface GscdumpAnalysisBundleResponse {
|
|
|
933
933
|
}>;
|
|
934
934
|
meta: GscdumpAnalysisResponse['meta'];
|
|
935
935
|
}
|
|
936
|
-
interface RegisterPartnerUserParams {
|
|
936
|
+
export interface RegisterPartnerUserParams {
|
|
937
937
|
userGoogleId: string;
|
|
938
938
|
userEmail: string;
|
|
939
939
|
userName?: string;
|
|
@@ -941,12 +941,12 @@ interface RegisterPartnerUserParams {
|
|
|
941
941
|
refreshToken: string;
|
|
942
942
|
tokenExpiresAt?: number;
|
|
943
943
|
}
|
|
944
|
-
interface UpdatePartnerUserTokensParams {
|
|
944
|
+
export interface UpdatePartnerUserTokensParams {
|
|
945
945
|
accessToken: string;
|
|
946
946
|
refreshToken: string;
|
|
947
947
|
tokenExpiresAt?: number;
|
|
948
948
|
}
|
|
949
|
-
interface RegisterPartnerSiteParams {
|
|
949
|
+
export interface RegisterPartnerSiteParams {
|
|
950
950
|
userId: string;
|
|
951
951
|
siteUrl: string;
|
|
952
952
|
requestedUrl?: string;
|
|
@@ -959,7 +959,7 @@ interface RegisterPartnerSiteParams {
|
|
|
959
959
|
enabledSearchTypes?: GscSearchType[];
|
|
960
960
|
catalogSiteId?: number;
|
|
961
961
|
}
|
|
962
|
-
interface BulkRegisterPartnerSitesParams {
|
|
962
|
+
export interface BulkRegisterPartnerSitesParams {
|
|
963
963
|
userId?: string;
|
|
964
964
|
siteUrls?: string[];
|
|
965
965
|
sites?: Array<{
|
|
@@ -973,7 +973,7 @@ interface BulkRegisterPartnerSitesParams {
|
|
|
973
973
|
enabledSearchTypes?: GscSearchType[];
|
|
974
974
|
}>;
|
|
975
975
|
}
|
|
976
|
-
interface BulkRegisterPartnerSiteResult {
|
|
976
|
+
export interface BulkRegisterPartnerSiteResult {
|
|
977
977
|
siteUrl: string;
|
|
978
978
|
siteId?: string;
|
|
979
979
|
status: 'registered' | 'already_exists' | 'not_found' | 'error';
|
|
@@ -984,7 +984,7 @@ interface BulkRegisterPartnerSiteResult {
|
|
|
984
984
|
indexingPermissionLevel?: string | null;
|
|
985
985
|
grantedScopes?: string[];
|
|
986
986
|
}
|
|
987
|
-
interface BulkRegisterPartnerSitesResponse {
|
|
987
|
+
export interface BulkRegisterPartnerSitesResponse {
|
|
988
988
|
results: BulkRegisterPartnerSiteResult[];
|
|
989
989
|
summary: {
|
|
990
990
|
registered: number;
|
|
@@ -993,23 +993,23 @@ interface BulkRegisterPartnerSitesResponse {
|
|
|
993
993
|
errors: number;
|
|
994
994
|
};
|
|
995
995
|
}
|
|
996
|
-
interface DeletePartnerUserResponse {
|
|
996
|
+
export interface DeletePartnerUserResponse {
|
|
997
997
|
ok: true;
|
|
998
998
|
queued: true;
|
|
999
999
|
userId: number;
|
|
1000
1000
|
publicId: string;
|
|
1001
1001
|
}
|
|
1002
|
-
type GscdumpAnalysisSourcesResponse = FileResolutionResponse;
|
|
1003
|
-
interface SearchTypeOptions {
|
|
1002
|
+
export type GscdumpAnalysisSourcesResponse = FileResolutionResponse;
|
|
1003
|
+
export interface SearchTypeOptions {
|
|
1004
1004
|
searchType?: GscSearchType;
|
|
1005
1005
|
}
|
|
1006
|
-
interface SourceInfoOptions extends SearchTypeOptions {
|
|
1006
|
+
export interface SourceInfoOptions extends SearchTypeOptions {
|
|
1007
1007
|
start?: string;
|
|
1008
1008
|
end?: string;
|
|
1009
1009
|
startDate?: string;
|
|
1010
1010
|
endDate?: string;
|
|
1011
1011
|
}
|
|
1012
|
-
interface AnalysisSourcesOptions extends SearchTypeOptions {
|
|
1012
|
+
export interface AnalysisSourcesOptions extends SearchTypeOptions {
|
|
1013
1013
|
tables?: string[] | string;
|
|
1014
1014
|
start?: string;
|
|
1015
1015
|
end?: string;
|
|
@@ -1022,16 +1022,16 @@ interface AnalysisSourcesOptions extends SearchTypeOptions {
|
|
|
1022
1022
|
/** Client-derived per-table parquet file-count ceiling. */
|
|
1023
1023
|
maxFiles?: number;
|
|
1024
1024
|
}
|
|
1025
|
-
interface DataQueryOptions {
|
|
1025
|
+
export interface DataQueryOptions {
|
|
1026
1026
|
comparison?: BuilderStateWire;
|
|
1027
1027
|
filter?: GscComparisonFilter;
|
|
1028
1028
|
searchType?: GscSearchType;
|
|
1029
1029
|
}
|
|
1030
|
-
interface DataDetailOptions {
|
|
1030
|
+
export interface DataDetailOptions {
|
|
1031
1031
|
comparison?: BuilderStateWire;
|
|
1032
1032
|
searchType?: GscSearchType;
|
|
1033
1033
|
}
|
|
1034
|
-
interface IndexingUrlsParams {
|
|
1034
|
+
export interface IndexingUrlsParams {
|
|
1035
1035
|
limit?: number;
|
|
1036
1036
|
offset?: number;
|
|
1037
1037
|
status?: GscdumpIndexingUrlStatus;
|
|
@@ -1045,41 +1045,41 @@ interface IndexingUrlsParams {
|
|
|
1045
1045
|
*/
|
|
1046
1046
|
count?: 0 | false;
|
|
1047
1047
|
}
|
|
1048
|
-
interface GscdumpUserSettings {
|
|
1048
|
+
export interface GscdumpUserSettings {
|
|
1049
1049
|
browserAnalyzerEnabled: boolean;
|
|
1050
1050
|
}
|
|
1051
|
-
interface GscdumpPermissionRecovery {
|
|
1051
|
+
export interface GscdumpPermissionRecovery {
|
|
1052
1052
|
success: boolean;
|
|
1053
1053
|
permissionLevel: string | null;
|
|
1054
1054
|
jobsQueued: number;
|
|
1055
1055
|
message: string;
|
|
1056
1056
|
}
|
|
1057
|
-
interface GscdumpTopAssociationParams {
|
|
1057
|
+
export interface GscdumpTopAssociationParams {
|
|
1058
1058
|
type: 'topPage' | 'topKeyword';
|
|
1059
1059
|
identifier: string;
|
|
1060
1060
|
startDate: string;
|
|
1061
1061
|
endDate: string;
|
|
1062
1062
|
}
|
|
1063
|
-
interface GscdumpTopAssociationResponse {
|
|
1063
|
+
export interface GscdumpTopAssociationResponse {
|
|
1064
1064
|
value: string | null;
|
|
1065
1065
|
}
|
|
1066
|
-
interface GscdumpKeywordSparklinesParams {
|
|
1066
|
+
export interface GscdumpKeywordSparklinesParams {
|
|
1067
1067
|
keywords: string[];
|
|
1068
1068
|
startDate: string;
|
|
1069
1069
|
endDate: string;
|
|
1070
1070
|
searchType?: GscSearchType;
|
|
1071
1071
|
}
|
|
1072
|
-
interface GscdumpKeywordSparklinesResponse {
|
|
1072
|
+
export interface GscdumpKeywordSparklinesResponse {
|
|
1073
1073
|
sparklines: Record<string, number[]>;
|
|
1074
1074
|
}
|
|
1075
|
-
interface GscdumpQueryTrendParams {
|
|
1075
|
+
export interface GscdumpQueryTrendParams {
|
|
1076
1076
|
startDate: string;
|
|
1077
1077
|
endDate: string;
|
|
1078
1078
|
prevStartDate?: string;
|
|
1079
1079
|
prevEndDate?: string;
|
|
1080
1080
|
searchType?: GscSearchType;
|
|
1081
1081
|
}
|
|
1082
|
-
interface GscdumpQueryTrendResponse {
|
|
1082
|
+
export interface GscdumpQueryTrendResponse {
|
|
1083
1083
|
daily: Array<{
|
|
1084
1084
|
date: string;
|
|
1085
1085
|
queryCount: number;
|
|
@@ -1091,14 +1091,14 @@ interface GscdumpQueryTrendResponse {
|
|
|
1091
1091
|
syncStatus: string | null;
|
|
1092
1092
|
};
|
|
1093
1093
|
}
|
|
1094
|
-
interface GscdumpPageTrendParams {
|
|
1094
|
+
export interface GscdumpPageTrendParams {
|
|
1095
1095
|
startDate: string;
|
|
1096
1096
|
endDate: string;
|
|
1097
1097
|
prevStartDate?: string;
|
|
1098
1098
|
prevEndDate?: string;
|
|
1099
1099
|
searchType?: GscSearchType;
|
|
1100
1100
|
}
|
|
1101
|
-
interface GscdumpPageTrendResponse {
|
|
1101
|
+
export interface GscdumpPageTrendResponse {
|
|
1102
1102
|
daily: Array<{
|
|
1103
1103
|
date: string;
|
|
1104
1104
|
pageCount: number;
|
|
@@ -1110,7 +1110,7 @@ interface GscdumpPageTrendResponse {
|
|
|
1110
1110
|
syncStatus: string | null;
|
|
1111
1111
|
};
|
|
1112
1112
|
}
|
|
1113
|
-
interface GscdumpCanonicalMismatchRow {
|
|
1113
|
+
export interface GscdumpCanonicalMismatchRow {
|
|
1114
1114
|
url: string;
|
|
1115
1115
|
userCanonical: string;
|
|
1116
1116
|
googleCanonical: string;
|
|
@@ -1120,7 +1120,7 @@ interface GscdumpCanonicalMismatchRow {
|
|
|
1120
1120
|
lastCheckedAt: string | null;
|
|
1121
1121
|
kind: Extract<GscdumpCanonicalDifferenceKind, 'path' | 'cross_domain'>;
|
|
1122
1122
|
}
|
|
1123
|
-
interface GscdumpCanonicalMismatchesResponse {
|
|
1123
|
+
export interface GscdumpCanonicalMismatchesResponse {
|
|
1124
1124
|
mismatches: GscdumpCanonicalMismatchRow[];
|
|
1125
1125
|
totalCount: number;
|
|
1126
1126
|
consolidationTargets: Array<{
|
|
@@ -1136,7 +1136,7 @@ interface GscdumpCanonicalMismatchesResponse {
|
|
|
1136
1136
|
syncStatus: string | null;
|
|
1137
1137
|
};
|
|
1138
1138
|
}
|
|
1139
|
-
interface GscdumpIndexPercentTrendPoint {
|
|
1139
|
+
export interface GscdumpIndexPercentTrendPoint {
|
|
1140
1140
|
date: string;
|
|
1141
1141
|
percent: number;
|
|
1142
1142
|
total: number;
|
|
@@ -1144,22 +1144,22 @@ interface GscdumpIndexPercentTrendPoint {
|
|
|
1144
1144
|
added: number | null;
|
|
1145
1145
|
removed: number | null;
|
|
1146
1146
|
}
|
|
1147
|
-
interface GscdumpInvisibleUrlRow {
|
|
1147
|
+
export interface GscdumpInvisibleUrlRow {
|
|
1148
1148
|
url: string;
|
|
1149
1149
|
firstSeen?: string;
|
|
1150
1150
|
lastmod: string | null;
|
|
1151
1151
|
}
|
|
1152
|
-
interface GscdumpOrphanPageRow {
|
|
1152
|
+
export interface GscdumpOrphanPageRow {
|
|
1153
1153
|
url: string;
|
|
1154
1154
|
impressions: number | null;
|
|
1155
1155
|
clicks: number | null;
|
|
1156
1156
|
}
|
|
1157
|
-
interface GscdumpIndexPercentSitemap {
|
|
1157
|
+
export interface GscdumpIndexPercentSitemap {
|
|
1158
1158
|
path: string;
|
|
1159
1159
|
urlCount: number;
|
|
1160
1160
|
isIndex: boolean;
|
|
1161
1161
|
}
|
|
1162
|
-
interface GscdumpIndexPercentResponse {
|
|
1162
|
+
export interface GscdumpIndexPercentResponse {
|
|
1163
1163
|
trend: GscdumpIndexPercentTrendPoint[];
|
|
1164
1164
|
invisibleUrls: GscdumpInvisibleUrlRow[];
|
|
1165
1165
|
invisibleCount: number;
|
|
@@ -1180,7 +1180,7 @@ interface GscdumpIndexPercentResponse {
|
|
|
1180
1180
|
newestDateSynced: string | null;
|
|
1181
1181
|
};
|
|
1182
1182
|
}
|
|
1183
|
-
interface GscdumpUserMeResponse {
|
|
1183
|
+
export interface GscdumpUserMeResponse {
|
|
1184
1184
|
id: string;
|
|
1185
1185
|
name?: string;
|
|
1186
1186
|
email: string;
|
|
@@ -1198,7 +1198,7 @@ interface GscdumpUserMeResponse {
|
|
|
1198
1198
|
lastUsed: number | null;
|
|
1199
1199
|
} | null;
|
|
1200
1200
|
}
|
|
1201
|
-
interface GscdumpHealthResponse {
|
|
1201
|
+
export interface GscdumpHealthResponse {
|
|
1202
1202
|
timestamp: number;
|
|
1203
1203
|
jobs: {
|
|
1204
1204
|
byStatus: Record<string, number>;
|
|
@@ -1221,11 +1221,11 @@ interface GscdumpHealthResponse {
|
|
|
1221
1221
|
byPlan: Record<string, number>;
|
|
1222
1222
|
};
|
|
1223
1223
|
}
|
|
1224
|
-
interface GscdumpSyncProgressDateStatus {
|
|
1224
|
+
export interface GscdumpSyncProgressDateStatus {
|
|
1225
1225
|
date: string;
|
|
1226
1226
|
status: 'completed' | 'queued' | 'processing' | 'failed';
|
|
1227
1227
|
}
|
|
1228
|
-
interface GscdumpSyncProgressPhaseCounts {
|
|
1228
|
+
export interface GscdumpSyncProgressPhaseCounts {
|
|
1229
1229
|
total: number;
|
|
1230
1230
|
done: number;
|
|
1231
1231
|
pending: number;
|
|
@@ -1234,7 +1234,7 @@ interface GscdumpSyncProgressPhaseCounts {
|
|
|
1234
1234
|
percent: number;
|
|
1235
1235
|
rows: number;
|
|
1236
1236
|
}
|
|
1237
|
-
interface GscdumpSyncProgressSite {
|
|
1237
|
+
export interface GscdumpSyncProgressSite {
|
|
1238
1238
|
id: string;
|
|
1239
1239
|
userId: number;
|
|
1240
1240
|
partnerId: string | null;
|
|
@@ -1268,7 +1268,7 @@ interface GscdumpSyncProgressSite {
|
|
|
1268
1268
|
totalRows: number;
|
|
1269
1269
|
dateStatuses: GscdumpSyncProgressDateStatus[];
|
|
1270
1270
|
}
|
|
1271
|
-
interface GscdumpSyncProgressResponse {
|
|
1271
|
+
export interface GscdumpSyncProgressResponse {
|
|
1272
1272
|
summary: {
|
|
1273
1273
|
total: number;
|
|
1274
1274
|
inInitial: number;
|
|
@@ -1289,8 +1289,8 @@ interface GscdumpSyncProgressResponse {
|
|
|
1289
1289
|
};
|
|
1290
1290
|
hasD1Stats: boolean;
|
|
1291
1291
|
}
|
|
1292
|
-
type GscdumpSyncJobStatus = 'queued' | 'processing' | 'completed' | 'failed' | 'scheduled';
|
|
1293
|
-
interface GscdumpSyncJobItem {
|
|
1292
|
+
export type GscdumpSyncJobStatus = 'queued' | 'processing' | 'completed' | 'failed' | 'scheduled';
|
|
1293
|
+
export interface GscdumpSyncJobItem {
|
|
1294
1294
|
id: number;
|
|
1295
1295
|
userSiteId: string | null;
|
|
1296
1296
|
tableName?: string;
|
|
@@ -1308,11 +1308,11 @@ interface GscdumpSyncJobItem {
|
|
|
1308
1308
|
startedAt: number | null;
|
|
1309
1309
|
completedAt: number | null;
|
|
1310
1310
|
}
|
|
1311
|
-
interface GscdumpSyncJobsQueueCounts {
|
|
1311
|
+
export interface GscdumpSyncJobsQueueCounts {
|
|
1312
1312
|
queued: number;
|
|
1313
1313
|
processing: number;
|
|
1314
1314
|
}
|
|
1315
|
-
interface GscdumpSyncJobsResponse {
|
|
1315
|
+
export interface GscdumpSyncJobsResponse {
|
|
1316
1316
|
jobs: GscdumpSyncJobItem[];
|
|
1317
1317
|
summary: {
|
|
1318
1318
|
queued: number;
|
|
@@ -1327,13 +1327,13 @@ interface GscdumpSyncJobsResponse {
|
|
|
1327
1327
|
extended: GscdumpSyncJobsQueueCounts | undefined;
|
|
1328
1328
|
};
|
|
1329
1329
|
}
|
|
1330
|
-
interface GscdumpSiteReportResponse<TResult = unknown> {
|
|
1330
|
+
export interface GscdumpSiteReportResponse<TResult = unknown> {
|
|
1331
1331
|
status: 'done' | 'error';
|
|
1332
1332
|
cached: boolean;
|
|
1333
1333
|
result?: TResult;
|
|
1334
1334
|
error?: string;
|
|
1335
1335
|
}
|
|
1336
|
-
interface GscdumpTeamRow {
|
|
1336
|
+
export interface GscdumpTeamRow {
|
|
1337
1337
|
id: string;
|
|
1338
1338
|
ownerId: number;
|
|
1339
1339
|
name: string;
|
|
@@ -1341,7 +1341,7 @@ interface GscdumpTeamRow {
|
|
|
1341
1341
|
createdAt: number;
|
|
1342
1342
|
updatedAt: number;
|
|
1343
1343
|
}
|
|
1344
|
-
interface GscdumpTeamMemberRow {
|
|
1344
|
+
export interface GscdumpTeamMemberRow {
|
|
1345
1345
|
userId: number;
|
|
1346
1346
|
publicId: string;
|
|
1347
1347
|
name: string | null;
|
|
@@ -1350,19 +1350,19 @@ interface GscdumpTeamMemberRow {
|
|
|
1350
1350
|
role: 'admin' | 'editor' | 'viewer';
|
|
1351
1351
|
joinedAt: number;
|
|
1352
1352
|
}
|
|
1353
|
-
interface CreatePartnerTeamParams {
|
|
1353
|
+
export interface CreatePartnerTeamParams {
|
|
1354
1354
|
ownerUserId: string;
|
|
1355
1355
|
name: string;
|
|
1356
1356
|
personalTeam?: boolean;
|
|
1357
1357
|
}
|
|
1358
|
-
interface AddPartnerTeamMemberParams {
|
|
1358
|
+
export interface AddPartnerTeamMemberParams {
|
|
1359
1359
|
userId: string;
|
|
1360
1360
|
role: GscdumpTeamMemberRow['role'];
|
|
1361
1361
|
}
|
|
1362
|
-
interface BindPartnerSiteTeamParams {
|
|
1362
|
+
export interface BindPartnerSiteTeamParams {
|
|
1363
1363
|
teamId: string | null;
|
|
1364
1364
|
}
|
|
1365
|
-
interface GscdumpTeamCatalogRef {
|
|
1365
|
+
export interface GscdumpTeamCatalogRef {
|
|
1366
1366
|
teamId: string;
|
|
1367
1367
|
catalogUri: string | null;
|
|
1368
1368
|
warehouse: string | null;
|
|
@@ -1373,13 +1373,13 @@ interface GscdumpTeamCatalogRef {
|
|
|
1373
1373
|
catalogTablesReady: boolean;
|
|
1374
1374
|
readsEnabled: boolean;
|
|
1375
1375
|
}
|
|
1376
|
-
interface BindPartnerTeamCatalogParams {
|
|
1376
|
+
export interface BindPartnerTeamCatalogParams {
|
|
1377
1377
|
catalogUri: string;
|
|
1378
1378
|
warehouse: string;
|
|
1379
1379
|
namespace?: string;
|
|
1380
1380
|
bucket?: string;
|
|
1381
1381
|
}
|
|
1382
|
-
interface BindPartnerTeamCatalogResponse {
|
|
1382
|
+
export interface BindPartnerTeamCatalogResponse {
|
|
1383
1383
|
teamId: string;
|
|
1384
1384
|
status: 'ready';
|
|
1385
1385
|
catalogUri: string;
|
|
@@ -1387,9 +1387,9 @@ interface BindPartnerTeamCatalogResponse {
|
|
|
1387
1387
|
bucket: string;
|
|
1388
1388
|
namespace: string;
|
|
1389
1389
|
}
|
|
1390
|
-
type CanonicalWebhookEventType = 'user.lifecycle.changed' | 'site.lifecycle.changed' | 'site.analytics.ready' | 'site.indexing.ready' | 'site.auth.failed' | 'job.failed';
|
|
1391
|
-
type WebhookEventType = CanonicalWebhookEventType;
|
|
1392
|
-
interface WebhookEnvelope<TData extends Record<string, unknown> = Record<string, unknown>> {
|
|
1390
|
+
export type CanonicalWebhookEventType = 'user.lifecycle.changed' | 'site.lifecycle.changed' | 'site.analytics.ready' | 'site.indexing.ready' | 'site.auth.failed' | 'job.failed';
|
|
1391
|
+
export type WebhookEventType = CanonicalWebhookEventType;
|
|
1392
|
+
export interface WebhookEnvelope<TData extends Record<string, unknown> = Record<string, unknown>> {
|
|
1393
1393
|
contractVersion: string;
|
|
1394
1394
|
deliveryId: string;
|
|
1395
1395
|
event: CanonicalWebhookEventType;
|
|
@@ -1402,8 +1402,8 @@ interface WebhookEnvelope<TData extends Record<string, unknown> = Record<string,
|
|
|
1402
1402
|
occurredAt: string;
|
|
1403
1403
|
data: TData;
|
|
1404
1404
|
}
|
|
1405
|
-
type PartnerWebhookData = Record<string, unknown>;
|
|
1406
|
-
interface CreateWebhookEnvelopeOptions<TData extends Record<string, unknown> = Record<string, unknown>> {
|
|
1405
|
+
export type PartnerWebhookData = Record<string, unknown>;
|
|
1406
|
+
export interface CreateWebhookEnvelopeOptions<TData extends Record<string, unknown> = Record<string, unknown>> {
|
|
1407
1407
|
event: CanonicalWebhookEventType;
|
|
1408
1408
|
partnerId: string;
|
|
1409
1409
|
userId: string | null;
|
|
@@ -1416,11 +1416,11 @@ interface CreateWebhookEnvelopeOptions<TData extends Record<string, unknown> = R
|
|
|
1416
1416
|
occurredAt?: string | Date;
|
|
1417
1417
|
contractVersion?: string;
|
|
1418
1418
|
}
|
|
1419
|
-
interface PartnerWebhookHeaders {
|
|
1419
|
+
export interface PartnerWebhookHeaders {
|
|
1420
1420
|
event?: string | null;
|
|
1421
1421
|
delivery?: string | null;
|
|
1422
1422
|
contractVersion?: string | null;
|
|
1423
1423
|
timestamp?: string | null;
|
|
1424
1424
|
signature?: string | null;
|
|
1425
1425
|
}
|
|
1426
|
-
export {
|
|
1426
|
+
export type { PartnerLifecycleAccount, PartnerLifecycleResponse, PartnerLifecycleSite };
|