@nuxtseo/protocol 0.5.7 → 0.5.8
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/dist/v1/gsc.d.ts +529 -0
- package/dist/v1/gsc.js +21 -1
- package/dist/v1/sitemaps.d.ts +1756 -160
- package/dist/v1/sitemaps.js +45 -0
- package/generated/openapi.v1.json +1 -1
- package/package.json +2 -2
package/dist/v1/gsc.d.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import type { z } from 'zod';
|
|
2
|
+
import { watchedUrlsResponseSchema } from '@gscdump/contracts';
|
|
2
3
|
export declare const searchConsoleSiteParamsSchema: z.ZodObject<{
|
|
3
4
|
siteId: z.ZodString;
|
|
4
5
|
}, z.core.$strict>;
|
|
@@ -5165,6 +5166,316 @@ export declare const indexCohortsReadOperation: {
|
|
|
5165
5166
|
}];
|
|
5166
5167
|
};
|
|
5167
5168
|
};
|
|
5169
|
+
export declare const indexingWatchesResponseSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
5170
|
+
data: z.ZodObject<{
|
|
5171
|
+
watched: z.ZodArray<z.ZodObject<{
|
|
5172
|
+
url: z.ZodString;
|
|
5173
|
+
addedAt: z.ZodString;
|
|
5174
|
+
dueAt: z.ZodString;
|
|
5175
|
+
checkpoints: z.ZodArray<z.ZodObject<{
|
|
5176
|
+
checkedAt: z.ZodString;
|
|
5177
|
+
coverageState: z.ZodCatch<z.ZodEnum<{
|
|
5178
|
+
unknown_to_google: "unknown_to_google";
|
|
5179
|
+
discovered_not_indexed: "discovered_not_indexed";
|
|
5180
|
+
crawled_not_indexed: "crawled_not_indexed";
|
|
5181
|
+
indexed: "indexed";
|
|
5182
|
+
noindex: "noindex";
|
|
5183
|
+
blocked_robots: "blocked_robots";
|
|
5184
|
+
soft_404: "soft_404";
|
|
5185
|
+
not_found: "not_found";
|
|
5186
|
+
server_error: "server_error";
|
|
5187
|
+
access_denied: "access_denied";
|
|
5188
|
+
access_forbidden: "access_forbidden";
|
|
5189
|
+
blocked_4xx: "blocked_4xx";
|
|
5190
|
+
redirect: "redirect";
|
|
5191
|
+
redirect_error: "redirect_error";
|
|
5192
|
+
alternate_canonical: "alternate_canonical";
|
|
5193
|
+
duplicate_no_canonical: "duplicate_no_canonical";
|
|
5194
|
+
duplicate_google_canonical: "duplicate_google_canonical";
|
|
5195
|
+
page_removed: "page_removed";
|
|
5196
|
+
unrecognized: "unrecognized";
|
|
5197
|
+
not_reported: "not_reported";
|
|
5198
|
+
}>>;
|
|
5199
|
+
googleCoverageState: z.ZodNullable<z.ZodString>;
|
|
5200
|
+
verdict: z.ZodNullable<z.ZodString>;
|
|
5201
|
+
lastCrawlTime: z.ZodNullable<z.ZodString>;
|
|
5202
|
+
}, z.core.$loose>>;
|
|
5203
|
+
}, z.core.$loose>>;
|
|
5204
|
+
limit: z.ZodNumber;
|
|
5205
|
+
cadenceDays: z.ZodNumber;
|
|
5206
|
+
meta: z.ZodObject<{
|
|
5207
|
+
siteUrl: z.ZodString;
|
|
5208
|
+
}, z.core.$loose>;
|
|
5209
|
+
}, z.core.$strict>;
|
|
5210
|
+
meta: z.ZodObject<{
|
|
5211
|
+
requestId: z.ZodString;
|
|
5212
|
+
version: z.ZodLiteral<"1.0">;
|
|
5213
|
+
}, z.core.$strict>;
|
|
5214
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
5215
|
+
data: z.ZodObject<{
|
|
5216
|
+
watched: z.ZodArray<z.ZodObject<{
|
|
5217
|
+
url: z.ZodString;
|
|
5218
|
+
addedAt: z.ZodString;
|
|
5219
|
+
dueAt: z.ZodString;
|
|
5220
|
+
checkpoints: z.ZodArray<z.ZodObject<{
|
|
5221
|
+
checkedAt: z.ZodString;
|
|
5222
|
+
coverageState: z.ZodCatch<z.ZodEnum<{
|
|
5223
|
+
unknown_to_google: "unknown_to_google";
|
|
5224
|
+
discovered_not_indexed: "discovered_not_indexed";
|
|
5225
|
+
crawled_not_indexed: "crawled_not_indexed";
|
|
5226
|
+
indexed: "indexed";
|
|
5227
|
+
noindex: "noindex";
|
|
5228
|
+
blocked_robots: "blocked_robots";
|
|
5229
|
+
soft_404: "soft_404";
|
|
5230
|
+
not_found: "not_found";
|
|
5231
|
+
server_error: "server_error";
|
|
5232
|
+
access_denied: "access_denied";
|
|
5233
|
+
access_forbidden: "access_forbidden";
|
|
5234
|
+
blocked_4xx: "blocked_4xx";
|
|
5235
|
+
redirect: "redirect";
|
|
5236
|
+
redirect_error: "redirect_error";
|
|
5237
|
+
alternate_canonical: "alternate_canonical";
|
|
5238
|
+
duplicate_no_canonical: "duplicate_no_canonical";
|
|
5239
|
+
duplicate_google_canonical: "duplicate_google_canonical";
|
|
5240
|
+
page_removed: "page_removed";
|
|
5241
|
+
unrecognized: "unrecognized";
|
|
5242
|
+
not_reported: "not_reported";
|
|
5243
|
+
}>>;
|
|
5244
|
+
googleCoverageState: z.ZodNullable<z.ZodString>;
|
|
5245
|
+
verdict: z.ZodNullable<z.ZodString>;
|
|
5246
|
+
lastCrawlTime: z.ZodNullable<z.ZodString>;
|
|
5247
|
+
}, z.core.$loose>>;
|
|
5248
|
+
}, z.core.$loose>>;
|
|
5249
|
+
limit: z.ZodNumber;
|
|
5250
|
+
cadenceDays: z.ZodNumber;
|
|
5251
|
+
meta: z.ZodObject<{
|
|
5252
|
+
siteUrl: z.ZodString;
|
|
5253
|
+
}, z.core.$loose>;
|
|
5254
|
+
}, z.core.$loose>;
|
|
5255
|
+
meta: z.ZodObject<{
|
|
5256
|
+
requestId: z.ZodString;
|
|
5257
|
+
version: z.ZodLiteral<"1.0">;
|
|
5258
|
+
}, z.core.$loose>;
|
|
5259
|
+
}, z.core.$strip>>;
|
|
5260
|
+
export type IndexingWatchesData = z.output<typeof watchedUrlsResponseSchema>;
|
|
5261
|
+
export declare const indexingWatchesListOperation: {
|
|
5262
|
+
readonly visibility: 'public';
|
|
5263
|
+
readonly semantics: {
|
|
5264
|
+
readonly kind: 'query';
|
|
5265
|
+
readonly sideEffects: 'none';
|
|
5266
|
+
readonly retry: 'idempotent';
|
|
5267
|
+
readonly readConsistency: 'replica-ok';
|
|
5268
|
+
};
|
|
5269
|
+
readonly auth: {
|
|
5270
|
+
readonly credentials: readonly ['session', 'api_token'];
|
|
5271
|
+
readonly scopes: readonly ['sites:read'];
|
|
5272
|
+
readonly minimumRole: 'viewer';
|
|
5273
|
+
readonly ownership: 'site';
|
|
5274
|
+
};
|
|
5275
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "auth_expired", "forbidden", "not_found", "entitlement_required", "stale_evidence", "rate_limited", "provider_unavailable", "conflict", "contract_violation", "internal_error"];
|
|
5276
|
+
readonly errorResponse: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
5277
|
+
readonly error: z.ZodObject<{
|
|
5278
|
+
code: z.ZodEnum<{
|
|
5279
|
+
auth_expired: "auth_expired";
|
|
5280
|
+
conflict: "conflict";
|
|
5281
|
+
contract_violation: "contract_violation";
|
|
5282
|
+
entitlement_required: "entitlement_required";
|
|
5283
|
+
forbidden: "forbidden";
|
|
5284
|
+
internal_error: "internal_error";
|
|
5285
|
+
invalid_request: "invalid_request";
|
|
5286
|
+
not_found: "not_found";
|
|
5287
|
+
provider_unavailable: "provider_unavailable";
|
|
5288
|
+
quota_exhausted: "quota_exhausted";
|
|
5289
|
+
rate_limited: "rate_limited";
|
|
5290
|
+
site_ambiguous: "site_ambiguous";
|
|
5291
|
+
stale_evidence: "stale_evidence";
|
|
5292
|
+
unauthorized: "unauthorized";
|
|
5293
|
+
}>;
|
|
5294
|
+
message: z.ZodString;
|
|
5295
|
+
requestId: z.ZodString;
|
|
5296
|
+
retryable: z.ZodBoolean;
|
|
5297
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
5298
|
+
}, z.core.$strict>;
|
|
5299
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
5300
|
+
readonly error: z.ZodObject<{
|
|
5301
|
+
code: z.ZodEnum<{
|
|
5302
|
+
auth_expired: "auth_expired";
|
|
5303
|
+
conflict: "conflict";
|
|
5304
|
+
contract_violation: "contract_violation";
|
|
5305
|
+
entitlement_required: "entitlement_required";
|
|
5306
|
+
forbidden: "forbidden";
|
|
5307
|
+
internal_error: "internal_error";
|
|
5308
|
+
invalid_request: "invalid_request";
|
|
5309
|
+
not_found: "not_found";
|
|
5310
|
+
provider_unavailable: "provider_unavailable";
|
|
5311
|
+
quota_exhausted: "quota_exhausted";
|
|
5312
|
+
rate_limited: "rate_limited";
|
|
5313
|
+
site_ambiguous: "site_ambiguous";
|
|
5314
|
+
stale_evidence: "stale_evidence";
|
|
5315
|
+
unauthorized: "unauthorized";
|
|
5316
|
+
}>;
|
|
5317
|
+
message: z.ZodString;
|
|
5318
|
+
requestId: z.ZodString;
|
|
5319
|
+
retryable: z.ZodBoolean;
|
|
5320
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
5321
|
+
}, z.core.$loose>;
|
|
5322
|
+
}, z.core.$strip>>;
|
|
5323
|
+
readonly policy: {
|
|
5324
|
+
readonly rate: {
|
|
5325
|
+
readonly name: 'public-v1-fixed-window';
|
|
5326
|
+
readonly limit: 50;
|
|
5327
|
+
readonly windowSeconds: 60;
|
|
5328
|
+
};
|
|
5329
|
+
readonly idempotency: {
|
|
5330
|
+
readonly _tag: 'none';
|
|
5331
|
+
};
|
|
5332
|
+
readonly entitlement: null;
|
|
5333
|
+
readonly meter: null;
|
|
5334
|
+
};
|
|
5335
|
+
readonly lifecycle: {
|
|
5336
|
+
readonly introduced: '1.0.0';
|
|
5337
|
+
};
|
|
5338
|
+
readonly id: 'sites.search.indexing.watches.list';
|
|
5339
|
+
readonly method: 'GET';
|
|
5340
|
+
readonly path: '/api/v1/sites/{siteId}/search/indexing/watches';
|
|
5341
|
+
readonly request: {
|
|
5342
|
+
readonly params: z.ZodObject<{
|
|
5343
|
+
siteId: z.ZodString;
|
|
5344
|
+
}, z.core.$strict>;
|
|
5345
|
+
readonly query: null;
|
|
5346
|
+
readonly headers: null;
|
|
5347
|
+
readonly body: null;
|
|
5348
|
+
};
|
|
5349
|
+
readonly responses: {
|
|
5350
|
+
readonly 200: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
5351
|
+
data: z.ZodObject<{
|
|
5352
|
+
watched: z.ZodArray<z.ZodObject<{
|
|
5353
|
+
url: z.ZodString;
|
|
5354
|
+
addedAt: z.ZodString;
|
|
5355
|
+
dueAt: z.ZodString;
|
|
5356
|
+
checkpoints: z.ZodArray<z.ZodObject<{
|
|
5357
|
+
checkedAt: z.ZodString;
|
|
5358
|
+
coverageState: z.ZodCatch<z.ZodEnum<{
|
|
5359
|
+
unknown_to_google: "unknown_to_google";
|
|
5360
|
+
discovered_not_indexed: "discovered_not_indexed";
|
|
5361
|
+
crawled_not_indexed: "crawled_not_indexed";
|
|
5362
|
+
indexed: "indexed";
|
|
5363
|
+
noindex: "noindex";
|
|
5364
|
+
blocked_robots: "blocked_robots";
|
|
5365
|
+
soft_404: "soft_404";
|
|
5366
|
+
not_found: "not_found";
|
|
5367
|
+
server_error: "server_error";
|
|
5368
|
+
access_denied: "access_denied";
|
|
5369
|
+
access_forbidden: "access_forbidden";
|
|
5370
|
+
blocked_4xx: "blocked_4xx";
|
|
5371
|
+
redirect: "redirect";
|
|
5372
|
+
redirect_error: "redirect_error";
|
|
5373
|
+
alternate_canonical: "alternate_canonical";
|
|
5374
|
+
duplicate_no_canonical: "duplicate_no_canonical";
|
|
5375
|
+
duplicate_google_canonical: "duplicate_google_canonical";
|
|
5376
|
+
page_removed: "page_removed";
|
|
5377
|
+
unrecognized: "unrecognized";
|
|
5378
|
+
not_reported: "not_reported";
|
|
5379
|
+
}>>;
|
|
5380
|
+
googleCoverageState: z.ZodNullable<z.ZodString>;
|
|
5381
|
+
verdict: z.ZodNullable<z.ZodString>;
|
|
5382
|
+
lastCrawlTime: z.ZodNullable<z.ZodString>;
|
|
5383
|
+
}, z.core.$loose>>;
|
|
5384
|
+
}, z.core.$loose>>;
|
|
5385
|
+
limit: z.ZodNumber;
|
|
5386
|
+
cadenceDays: z.ZodNumber;
|
|
5387
|
+
meta: z.ZodObject<{
|
|
5388
|
+
siteUrl: z.ZodString;
|
|
5389
|
+
}, z.core.$loose>;
|
|
5390
|
+
}, z.core.$strict>;
|
|
5391
|
+
meta: z.ZodObject<{
|
|
5392
|
+
requestId: z.ZodString;
|
|
5393
|
+
version: z.ZodLiteral<"1.0">;
|
|
5394
|
+
}, z.core.$strict>;
|
|
5395
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
5396
|
+
data: z.ZodObject<{
|
|
5397
|
+
watched: z.ZodArray<z.ZodObject<{
|
|
5398
|
+
url: z.ZodString;
|
|
5399
|
+
addedAt: z.ZodString;
|
|
5400
|
+
dueAt: z.ZodString;
|
|
5401
|
+
checkpoints: z.ZodArray<z.ZodObject<{
|
|
5402
|
+
checkedAt: z.ZodString;
|
|
5403
|
+
coverageState: z.ZodCatch<z.ZodEnum<{
|
|
5404
|
+
unknown_to_google: "unknown_to_google";
|
|
5405
|
+
discovered_not_indexed: "discovered_not_indexed";
|
|
5406
|
+
crawled_not_indexed: "crawled_not_indexed";
|
|
5407
|
+
indexed: "indexed";
|
|
5408
|
+
noindex: "noindex";
|
|
5409
|
+
blocked_robots: "blocked_robots";
|
|
5410
|
+
soft_404: "soft_404";
|
|
5411
|
+
not_found: "not_found";
|
|
5412
|
+
server_error: "server_error";
|
|
5413
|
+
access_denied: "access_denied";
|
|
5414
|
+
access_forbidden: "access_forbidden";
|
|
5415
|
+
blocked_4xx: "blocked_4xx";
|
|
5416
|
+
redirect: "redirect";
|
|
5417
|
+
redirect_error: "redirect_error";
|
|
5418
|
+
alternate_canonical: "alternate_canonical";
|
|
5419
|
+
duplicate_no_canonical: "duplicate_no_canonical";
|
|
5420
|
+
duplicate_google_canonical: "duplicate_google_canonical";
|
|
5421
|
+
page_removed: "page_removed";
|
|
5422
|
+
unrecognized: "unrecognized";
|
|
5423
|
+
not_reported: "not_reported";
|
|
5424
|
+
}>>;
|
|
5425
|
+
googleCoverageState: z.ZodNullable<z.ZodString>;
|
|
5426
|
+
verdict: z.ZodNullable<z.ZodString>;
|
|
5427
|
+
lastCrawlTime: z.ZodNullable<z.ZodString>;
|
|
5428
|
+
}, z.core.$loose>>;
|
|
5429
|
+
}, z.core.$loose>>;
|
|
5430
|
+
limit: z.ZodNumber;
|
|
5431
|
+
cadenceDays: z.ZodNumber;
|
|
5432
|
+
meta: z.ZodObject<{
|
|
5433
|
+
siteUrl: z.ZodString;
|
|
5434
|
+
}, z.core.$loose>;
|
|
5435
|
+
}, z.core.$loose>;
|
|
5436
|
+
meta: z.ZodObject<{
|
|
5437
|
+
requestId: z.ZodString;
|
|
5438
|
+
version: z.ZodLiteral<"1.0">;
|
|
5439
|
+
}, z.core.$loose>;
|
|
5440
|
+
}, z.core.$strip>>;
|
|
5441
|
+
};
|
|
5442
|
+
readonly resources: {
|
|
5443
|
+
readonly reads: readonly [{
|
|
5444
|
+
readonly type: 'site.page';
|
|
5445
|
+
readonly idFrom: 'params.siteId';
|
|
5446
|
+
}];
|
|
5447
|
+
readonly changes: readonly [];
|
|
5448
|
+
};
|
|
5449
|
+
readonly docs: {
|
|
5450
|
+
readonly summary: 'List Site Watched URLs';
|
|
5451
|
+
readonly description: 'Returns retained Watched URLs, scheduled due times, and Checkpoints. An empty list means no retained Checkpoint for this watch.';
|
|
5452
|
+
readonly tags: readonly ["Sites", "Search", "Indexing"];
|
|
5453
|
+
readonly examples: readonly [{
|
|
5454
|
+
readonly request: {
|
|
5455
|
+
readonly params: {
|
|
5456
|
+
readonly siteId: 'site_01JXYZ';
|
|
5457
|
+
};
|
|
5458
|
+
};
|
|
5459
|
+
readonly response: {
|
|
5460
|
+
readonly status: 200;
|
|
5461
|
+
readonly body: {
|
|
5462
|
+
readonly data: {
|
|
5463
|
+
readonly watched: readonly [];
|
|
5464
|
+
readonly limit: 20;
|
|
5465
|
+
readonly cadenceDays: 7;
|
|
5466
|
+
readonly meta: {
|
|
5467
|
+
readonly siteUrl: 'https://example.com';
|
|
5468
|
+
};
|
|
5469
|
+
};
|
|
5470
|
+
readonly meta: {
|
|
5471
|
+
readonly requestId: 'req_01JXYZ';
|
|
5472
|
+
readonly version: '1.0';
|
|
5473
|
+
};
|
|
5474
|
+
};
|
|
5475
|
+
};
|
|
5476
|
+
}];
|
|
5477
|
+
};
|
|
5478
|
+
};
|
|
5168
5479
|
export declare const searchV1Registry: import("./core.js").PublicV1Registry<{
|
|
5169
5480
|
readonly queryAnalytics: {
|
|
5170
5481
|
readonly visibility: 'public';
|
|
@@ -7568,6 +7879,224 @@ export declare const searchV1Registry: import("./core.js").PublicV1Registry<{
|
|
|
7568
7879
|
}];
|
|
7569
7880
|
};
|
|
7570
7881
|
};
|
|
7882
|
+
readonly listWatches: {
|
|
7883
|
+
readonly visibility: 'public';
|
|
7884
|
+
readonly semantics: {
|
|
7885
|
+
readonly kind: 'query';
|
|
7886
|
+
readonly sideEffects: 'none';
|
|
7887
|
+
readonly retry: 'idempotent';
|
|
7888
|
+
readonly readConsistency: 'replica-ok';
|
|
7889
|
+
};
|
|
7890
|
+
readonly auth: {
|
|
7891
|
+
readonly credentials: readonly ['session', 'api_token'];
|
|
7892
|
+
readonly scopes: readonly ['sites:read'];
|
|
7893
|
+
readonly minimumRole: 'viewer';
|
|
7894
|
+
readonly ownership: 'site';
|
|
7895
|
+
};
|
|
7896
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "auth_expired", "forbidden", "not_found", "entitlement_required", "stale_evidence", "rate_limited", "provider_unavailable", "conflict", "contract_violation", "internal_error"];
|
|
7897
|
+
readonly errorResponse: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
7898
|
+
readonly error: z.ZodObject<{
|
|
7899
|
+
code: z.ZodEnum<{
|
|
7900
|
+
auth_expired: "auth_expired";
|
|
7901
|
+
conflict: "conflict";
|
|
7902
|
+
contract_violation: "contract_violation";
|
|
7903
|
+
entitlement_required: "entitlement_required";
|
|
7904
|
+
forbidden: "forbidden";
|
|
7905
|
+
internal_error: "internal_error";
|
|
7906
|
+
invalid_request: "invalid_request";
|
|
7907
|
+
not_found: "not_found";
|
|
7908
|
+
provider_unavailable: "provider_unavailable";
|
|
7909
|
+
quota_exhausted: "quota_exhausted";
|
|
7910
|
+
rate_limited: "rate_limited";
|
|
7911
|
+
site_ambiguous: "site_ambiguous";
|
|
7912
|
+
stale_evidence: "stale_evidence";
|
|
7913
|
+
unauthorized: "unauthorized";
|
|
7914
|
+
}>;
|
|
7915
|
+
message: z.ZodString;
|
|
7916
|
+
requestId: z.ZodString;
|
|
7917
|
+
retryable: z.ZodBoolean;
|
|
7918
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
7919
|
+
}, z.core.$strict>;
|
|
7920
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
7921
|
+
readonly error: z.ZodObject<{
|
|
7922
|
+
code: z.ZodEnum<{
|
|
7923
|
+
auth_expired: "auth_expired";
|
|
7924
|
+
conflict: "conflict";
|
|
7925
|
+
contract_violation: "contract_violation";
|
|
7926
|
+
entitlement_required: "entitlement_required";
|
|
7927
|
+
forbidden: "forbidden";
|
|
7928
|
+
internal_error: "internal_error";
|
|
7929
|
+
invalid_request: "invalid_request";
|
|
7930
|
+
not_found: "not_found";
|
|
7931
|
+
provider_unavailable: "provider_unavailable";
|
|
7932
|
+
quota_exhausted: "quota_exhausted";
|
|
7933
|
+
rate_limited: "rate_limited";
|
|
7934
|
+
site_ambiguous: "site_ambiguous";
|
|
7935
|
+
stale_evidence: "stale_evidence";
|
|
7936
|
+
unauthorized: "unauthorized";
|
|
7937
|
+
}>;
|
|
7938
|
+
message: z.ZodString;
|
|
7939
|
+
requestId: z.ZodString;
|
|
7940
|
+
retryable: z.ZodBoolean;
|
|
7941
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
7942
|
+
}, z.core.$loose>;
|
|
7943
|
+
}, z.core.$strip>>;
|
|
7944
|
+
readonly policy: {
|
|
7945
|
+
readonly rate: {
|
|
7946
|
+
readonly name: 'public-v1-fixed-window';
|
|
7947
|
+
readonly limit: 50;
|
|
7948
|
+
readonly windowSeconds: 60;
|
|
7949
|
+
};
|
|
7950
|
+
readonly idempotency: {
|
|
7951
|
+
readonly _tag: 'none';
|
|
7952
|
+
};
|
|
7953
|
+
readonly entitlement: null;
|
|
7954
|
+
readonly meter: null;
|
|
7955
|
+
};
|
|
7956
|
+
readonly lifecycle: {
|
|
7957
|
+
readonly introduced: '1.0.0';
|
|
7958
|
+
};
|
|
7959
|
+
readonly id: 'sites.search.indexing.watches.list';
|
|
7960
|
+
readonly method: 'GET';
|
|
7961
|
+
readonly path: '/api/v1/sites/{siteId}/search/indexing/watches';
|
|
7962
|
+
readonly request: {
|
|
7963
|
+
readonly params: z.ZodObject<{
|
|
7964
|
+
siteId: z.ZodString;
|
|
7965
|
+
}, z.core.$strict>;
|
|
7966
|
+
readonly query: null;
|
|
7967
|
+
readonly headers: null;
|
|
7968
|
+
readonly body: null;
|
|
7969
|
+
};
|
|
7970
|
+
readonly responses: {
|
|
7971
|
+
readonly 200: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
7972
|
+
data: z.ZodObject<{
|
|
7973
|
+
watched: z.ZodArray<z.ZodObject<{
|
|
7974
|
+
url: z.ZodString;
|
|
7975
|
+
addedAt: z.ZodString;
|
|
7976
|
+
dueAt: z.ZodString;
|
|
7977
|
+
checkpoints: z.ZodArray<z.ZodObject<{
|
|
7978
|
+
checkedAt: z.ZodString;
|
|
7979
|
+
coverageState: z.ZodCatch<z.ZodEnum<{
|
|
7980
|
+
unknown_to_google: "unknown_to_google";
|
|
7981
|
+
discovered_not_indexed: "discovered_not_indexed";
|
|
7982
|
+
crawled_not_indexed: "crawled_not_indexed";
|
|
7983
|
+
indexed: "indexed";
|
|
7984
|
+
noindex: "noindex";
|
|
7985
|
+
blocked_robots: "blocked_robots";
|
|
7986
|
+
soft_404: "soft_404";
|
|
7987
|
+
not_found: "not_found";
|
|
7988
|
+
server_error: "server_error";
|
|
7989
|
+
access_denied: "access_denied";
|
|
7990
|
+
access_forbidden: "access_forbidden";
|
|
7991
|
+
blocked_4xx: "blocked_4xx";
|
|
7992
|
+
redirect: "redirect";
|
|
7993
|
+
redirect_error: "redirect_error";
|
|
7994
|
+
alternate_canonical: "alternate_canonical";
|
|
7995
|
+
duplicate_no_canonical: "duplicate_no_canonical";
|
|
7996
|
+
duplicate_google_canonical: "duplicate_google_canonical";
|
|
7997
|
+
page_removed: "page_removed";
|
|
7998
|
+
unrecognized: "unrecognized";
|
|
7999
|
+
not_reported: "not_reported";
|
|
8000
|
+
}>>;
|
|
8001
|
+
googleCoverageState: z.ZodNullable<z.ZodString>;
|
|
8002
|
+
verdict: z.ZodNullable<z.ZodString>;
|
|
8003
|
+
lastCrawlTime: z.ZodNullable<z.ZodString>;
|
|
8004
|
+
}, z.core.$loose>>;
|
|
8005
|
+
}, z.core.$loose>>;
|
|
8006
|
+
limit: z.ZodNumber;
|
|
8007
|
+
cadenceDays: z.ZodNumber;
|
|
8008
|
+
meta: z.ZodObject<{
|
|
8009
|
+
siteUrl: z.ZodString;
|
|
8010
|
+
}, z.core.$loose>;
|
|
8011
|
+
}, z.core.$strict>;
|
|
8012
|
+
meta: z.ZodObject<{
|
|
8013
|
+
requestId: z.ZodString;
|
|
8014
|
+
version: z.ZodLiteral<"1.0">;
|
|
8015
|
+
}, z.core.$strict>;
|
|
8016
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
8017
|
+
data: z.ZodObject<{
|
|
8018
|
+
watched: z.ZodArray<z.ZodObject<{
|
|
8019
|
+
url: z.ZodString;
|
|
8020
|
+
addedAt: z.ZodString;
|
|
8021
|
+
dueAt: z.ZodString;
|
|
8022
|
+
checkpoints: z.ZodArray<z.ZodObject<{
|
|
8023
|
+
checkedAt: z.ZodString;
|
|
8024
|
+
coverageState: z.ZodCatch<z.ZodEnum<{
|
|
8025
|
+
unknown_to_google: "unknown_to_google";
|
|
8026
|
+
discovered_not_indexed: "discovered_not_indexed";
|
|
8027
|
+
crawled_not_indexed: "crawled_not_indexed";
|
|
8028
|
+
indexed: "indexed";
|
|
8029
|
+
noindex: "noindex";
|
|
8030
|
+
blocked_robots: "blocked_robots";
|
|
8031
|
+
soft_404: "soft_404";
|
|
8032
|
+
not_found: "not_found";
|
|
8033
|
+
server_error: "server_error";
|
|
8034
|
+
access_denied: "access_denied";
|
|
8035
|
+
access_forbidden: "access_forbidden";
|
|
8036
|
+
blocked_4xx: "blocked_4xx";
|
|
8037
|
+
redirect: "redirect";
|
|
8038
|
+
redirect_error: "redirect_error";
|
|
8039
|
+
alternate_canonical: "alternate_canonical";
|
|
8040
|
+
duplicate_no_canonical: "duplicate_no_canonical";
|
|
8041
|
+
duplicate_google_canonical: "duplicate_google_canonical";
|
|
8042
|
+
page_removed: "page_removed";
|
|
8043
|
+
unrecognized: "unrecognized";
|
|
8044
|
+
not_reported: "not_reported";
|
|
8045
|
+
}>>;
|
|
8046
|
+
googleCoverageState: z.ZodNullable<z.ZodString>;
|
|
8047
|
+
verdict: z.ZodNullable<z.ZodString>;
|
|
8048
|
+
lastCrawlTime: z.ZodNullable<z.ZodString>;
|
|
8049
|
+
}, z.core.$loose>>;
|
|
8050
|
+
}, z.core.$loose>>;
|
|
8051
|
+
limit: z.ZodNumber;
|
|
8052
|
+
cadenceDays: z.ZodNumber;
|
|
8053
|
+
meta: z.ZodObject<{
|
|
8054
|
+
siteUrl: z.ZodString;
|
|
8055
|
+
}, z.core.$loose>;
|
|
8056
|
+
}, z.core.$loose>;
|
|
8057
|
+
meta: z.ZodObject<{
|
|
8058
|
+
requestId: z.ZodString;
|
|
8059
|
+
version: z.ZodLiteral<"1.0">;
|
|
8060
|
+
}, z.core.$loose>;
|
|
8061
|
+
}, z.core.$strip>>;
|
|
8062
|
+
};
|
|
8063
|
+
readonly resources: {
|
|
8064
|
+
readonly reads: readonly [{
|
|
8065
|
+
readonly type: 'site.page';
|
|
8066
|
+
readonly idFrom: 'params.siteId';
|
|
8067
|
+
}];
|
|
8068
|
+
readonly changes: readonly [];
|
|
8069
|
+
};
|
|
8070
|
+
readonly docs: {
|
|
8071
|
+
readonly summary: 'List Site Watched URLs';
|
|
8072
|
+
readonly description: 'Returns retained Watched URLs, scheduled due times, and Checkpoints. An empty list means no retained Checkpoint for this watch.';
|
|
8073
|
+
readonly tags: readonly ["Sites", "Search", "Indexing"];
|
|
8074
|
+
readonly examples: readonly [{
|
|
8075
|
+
readonly request: {
|
|
8076
|
+
readonly params: {
|
|
8077
|
+
readonly siteId: 'site_01JXYZ';
|
|
8078
|
+
};
|
|
8079
|
+
};
|
|
8080
|
+
readonly response: {
|
|
8081
|
+
readonly status: 200;
|
|
8082
|
+
readonly body: {
|
|
8083
|
+
readonly data: {
|
|
8084
|
+
readonly watched: readonly [];
|
|
8085
|
+
readonly limit: 20;
|
|
8086
|
+
readonly cadenceDays: 7;
|
|
8087
|
+
readonly meta: {
|
|
8088
|
+
readonly siteUrl: 'https://example.com';
|
|
8089
|
+
};
|
|
8090
|
+
};
|
|
8091
|
+
readonly meta: {
|
|
8092
|
+
readonly requestId: 'req_01JXYZ';
|
|
8093
|
+
readonly version: '1.0';
|
|
8094
|
+
};
|
|
8095
|
+
};
|
|
8096
|
+
};
|
|
8097
|
+
}];
|
|
8098
|
+
};
|
|
8099
|
+
};
|
|
7571
8100
|
}>;
|
|
7572
8101
|
export type SearchAnalyticsQuery = z.input<typeof searchAnalyticsQuerySchema>;
|
|
7573
8102
|
export type SearchAnalyticsData = z.output<typeof searchAnalyticsDataSchema.client>;
|
package/dist/v1/gsc.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { canonicalDifferenceKindSchema, gscdumpAnalysisPresetSchema, gscdumpIndexingTransitionFieldSchema, gscdumpTotalsSchema, indexingInspectResponseSchema, indexingIssueSchema, } from '@gscdump/contracts';
|
|
1
|
+
import { canonicalDifferenceKindSchema, gscdumpAnalysisPresetSchema, gscdumpIndexingTransitionFieldSchema, gscdumpTotalsSchema, indexingInspectResponseSchema, indexingIssueSchema, watchedUrlsResponseSchema, } from '@gscdump/contracts';
|
|
2
2
|
import { z as schema } from 'zod';
|
|
3
3
|
import { defineOperation, defineRegistry, defineResponseObject, defineSuccessEnvelope, publicV1ErrorEnvelope, publicV1PageSchema, publicV1StandardRatePolicy, } from './core.js';
|
|
4
4
|
export const searchConsoleSiteParamsSchema = schema.strictObject({
|
|
@@ -832,6 +832,25 @@ export const indexCohortsReadOperation = defineOperation({
|
|
|
832
832
|
}],
|
|
833
833
|
},
|
|
834
834
|
});
|
|
835
|
+
export const indexingWatchesResponseSchema = defineSuccessEnvelope({
|
|
836
|
+
producer: watchedUrlsResponseSchema.strict(),
|
|
837
|
+
client: watchedUrlsResponseSchema.loose(),
|
|
838
|
+
});
|
|
839
|
+
export const indexingWatchesListOperation = defineOperation({
|
|
840
|
+
...common,
|
|
841
|
+
id: 'sites.search.indexing.watches.list',
|
|
842
|
+
method: 'GET',
|
|
843
|
+
path: '/api/v1/sites/{siteId}/search/indexing/watches',
|
|
844
|
+
request: { params: searchConsoleSiteParamsSchema, query: null, headers: null, body: null },
|
|
845
|
+
responses: { 200: indexingWatchesResponseSchema },
|
|
846
|
+
resources: { reads: [{ type: 'site.page', idFrom: 'params.siteId' }], changes: [] },
|
|
847
|
+
docs: {
|
|
848
|
+
summary: 'List Site Watched URLs',
|
|
849
|
+
description: 'Returns retained Watched URLs, scheduled due times, and Checkpoints. An empty list means no retained Checkpoint for this watch.',
|
|
850
|
+
tags: ['Sites', 'Search', 'Indexing'],
|
|
851
|
+
examples: [{ request: { params: { siteId: 'site_01JXYZ' } }, response: { status: 200, body: { data: { watched: [], limit: 20, cadenceDays: 7, meta: { siteUrl: 'https://example.com' } }, meta: { requestId: 'req_01JXYZ', version: '1.0' } } } }],
|
|
852
|
+
},
|
|
853
|
+
});
|
|
835
854
|
export const searchV1Registry = defineRegistry({
|
|
836
855
|
feature: 'sites',
|
|
837
856
|
operations: {
|
|
@@ -842,5 +861,6 @@ export const searchV1Registry = defineRegistry({
|
|
|
842
861
|
readUrlInspection: urlInspectionReadOperation,
|
|
843
862
|
refreshUrlInspection: urlInspectionRefreshOperation,
|
|
844
863
|
readIndexingCohorts: indexCohortsReadOperation,
|
|
864
|
+
listWatches: indexingWatchesListOperation,
|
|
845
865
|
},
|
|
846
866
|
});
|