@nuxtseo/protocol 0.5.3 → 0.5.5
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 +611 -0
- package/dist/v1/gsc.js +26 -1
- package/dist/v1/performance.d.ts +50 -18
- package/dist/v1/performance.js +7 -4
- package/dist/v1/research.d.ts +2004 -765
- package/dist/v1/research.js +119 -2
- package/generated/openapi.v1.json +1 -1
- package/package.json +2 -2
package/dist/v1/gsc.d.ts
CHANGED
|
@@ -4257,6 +4257,392 @@ export declare const urlInspectionReadOperation: {
|
|
|
4257
4257
|
}];
|
|
4258
4258
|
};
|
|
4259
4259
|
};
|
|
4260
|
+
export declare const urlInspectionRefreshBodySchema: z.ZodObject<{
|
|
4261
|
+
url: z.ZodString;
|
|
4262
|
+
}, z.core.$strict>;
|
|
4263
|
+
export declare const urlInspectionRefreshDataSchema: {
|
|
4264
|
+
producer: z.ZodObject<{
|
|
4265
|
+
siteId: z.ZodString;
|
|
4266
|
+
rateLimit: z.ZodObject<{
|
|
4267
|
+
reserved: z.ZodNumber;
|
|
4268
|
+
remaining: z.ZodNumber;
|
|
4269
|
+
limit: z.ZodNumber;
|
|
4270
|
+
}, z.core.$loose>;
|
|
4271
|
+
results: z.ZodArray<z.ZodObject<{
|
|
4272
|
+
url: z.ZodString;
|
|
4273
|
+
verdict: z.ZodNullable<z.ZodString>;
|
|
4274
|
+
coverageState: z.ZodNullable<z.ZodString>;
|
|
4275
|
+
indexingState: z.ZodNullable<z.ZodString>;
|
|
4276
|
+
robotsTxtState: z.ZodNullable<z.ZodString>;
|
|
4277
|
+
pageFetchState: z.ZodNullable<z.ZodString>;
|
|
4278
|
+
lastCrawlTime: z.ZodNullable<z.ZodString>;
|
|
4279
|
+
crawlingUserAgent: z.ZodNullable<z.ZodString>;
|
|
4280
|
+
userCanonical: z.ZodNullable<z.ZodString>;
|
|
4281
|
+
googleCanonical: z.ZodNullable<z.ZodString>;
|
|
4282
|
+
sitemaps: z.ZodNullable<z.ZodString>;
|
|
4283
|
+
referringUrls: z.ZodNullable<z.ZodString>;
|
|
4284
|
+
mobileVerdict: z.ZodNullable<z.ZodString>;
|
|
4285
|
+
mobileIssues: z.ZodNullable<z.ZodString>;
|
|
4286
|
+
richResultsVerdict: z.ZodNullable<z.ZodString>;
|
|
4287
|
+
richResultsItems: z.ZodNullable<z.ZodString>;
|
|
4288
|
+
inspectionResultLink: z.ZodNullable<z.ZodString>;
|
|
4289
|
+
}, z.core.$loose>>;
|
|
4290
|
+
errors: z.ZodArray<z.ZodObject<{
|
|
4291
|
+
url: z.ZodString;
|
|
4292
|
+
error: z.ZodString;
|
|
4293
|
+
}, z.core.$loose>>;
|
|
4294
|
+
skipped: z.ZodArray<z.ZodObject<{
|
|
4295
|
+
url: z.ZodString;
|
|
4296
|
+
reason: z.ZodString;
|
|
4297
|
+
}, z.core.$loose>>;
|
|
4298
|
+
checkedAt: z.ZodISODateTime;
|
|
4299
|
+
}, z.core.$strict>;
|
|
4300
|
+
client: z.ZodObject<{
|
|
4301
|
+
siteId: z.ZodString;
|
|
4302
|
+
rateLimit: z.ZodObject<{
|
|
4303
|
+
reserved: z.ZodNumber;
|
|
4304
|
+
remaining: z.ZodNumber;
|
|
4305
|
+
limit: z.ZodNumber;
|
|
4306
|
+
}, z.core.$loose>;
|
|
4307
|
+
results: z.ZodArray<z.ZodObject<{
|
|
4308
|
+
url: z.ZodString;
|
|
4309
|
+
verdict: z.ZodNullable<z.ZodString>;
|
|
4310
|
+
coverageState: z.ZodNullable<z.ZodString>;
|
|
4311
|
+
indexingState: z.ZodNullable<z.ZodString>;
|
|
4312
|
+
robotsTxtState: z.ZodNullable<z.ZodString>;
|
|
4313
|
+
pageFetchState: z.ZodNullable<z.ZodString>;
|
|
4314
|
+
lastCrawlTime: z.ZodNullable<z.ZodString>;
|
|
4315
|
+
crawlingUserAgent: z.ZodNullable<z.ZodString>;
|
|
4316
|
+
userCanonical: z.ZodNullable<z.ZodString>;
|
|
4317
|
+
googleCanonical: z.ZodNullable<z.ZodString>;
|
|
4318
|
+
sitemaps: z.ZodNullable<z.ZodString>;
|
|
4319
|
+
referringUrls: z.ZodNullable<z.ZodString>;
|
|
4320
|
+
mobileVerdict: z.ZodNullable<z.ZodString>;
|
|
4321
|
+
mobileIssues: z.ZodNullable<z.ZodString>;
|
|
4322
|
+
richResultsVerdict: z.ZodNullable<z.ZodString>;
|
|
4323
|
+
richResultsItems: z.ZodNullable<z.ZodString>;
|
|
4324
|
+
inspectionResultLink: z.ZodNullable<z.ZodString>;
|
|
4325
|
+
}, z.core.$loose>>;
|
|
4326
|
+
errors: z.ZodArray<z.ZodObject<{
|
|
4327
|
+
url: z.ZodString;
|
|
4328
|
+
error: z.ZodString;
|
|
4329
|
+
}, z.core.$loose>>;
|
|
4330
|
+
skipped: z.ZodArray<z.ZodObject<{
|
|
4331
|
+
url: z.ZodString;
|
|
4332
|
+
reason: z.ZodString;
|
|
4333
|
+
}, z.core.$loose>>;
|
|
4334
|
+
checkedAt: z.ZodISODateTime;
|
|
4335
|
+
}, z.core.$loose>;
|
|
4336
|
+
};
|
|
4337
|
+
export declare const urlInspectionRefreshResponseSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
4338
|
+
data: z.ZodObject<{
|
|
4339
|
+
siteId: z.ZodString;
|
|
4340
|
+
rateLimit: z.ZodObject<{
|
|
4341
|
+
reserved: z.ZodNumber;
|
|
4342
|
+
remaining: z.ZodNumber;
|
|
4343
|
+
limit: z.ZodNumber;
|
|
4344
|
+
}, z.core.$loose>;
|
|
4345
|
+
results: z.ZodArray<z.ZodObject<{
|
|
4346
|
+
url: z.ZodString;
|
|
4347
|
+
verdict: z.ZodNullable<z.ZodString>;
|
|
4348
|
+
coverageState: z.ZodNullable<z.ZodString>;
|
|
4349
|
+
indexingState: z.ZodNullable<z.ZodString>;
|
|
4350
|
+
robotsTxtState: z.ZodNullable<z.ZodString>;
|
|
4351
|
+
pageFetchState: z.ZodNullable<z.ZodString>;
|
|
4352
|
+
lastCrawlTime: z.ZodNullable<z.ZodString>;
|
|
4353
|
+
crawlingUserAgent: z.ZodNullable<z.ZodString>;
|
|
4354
|
+
userCanonical: z.ZodNullable<z.ZodString>;
|
|
4355
|
+
googleCanonical: z.ZodNullable<z.ZodString>;
|
|
4356
|
+
sitemaps: z.ZodNullable<z.ZodString>;
|
|
4357
|
+
referringUrls: z.ZodNullable<z.ZodString>;
|
|
4358
|
+
mobileVerdict: z.ZodNullable<z.ZodString>;
|
|
4359
|
+
mobileIssues: z.ZodNullable<z.ZodString>;
|
|
4360
|
+
richResultsVerdict: z.ZodNullable<z.ZodString>;
|
|
4361
|
+
richResultsItems: z.ZodNullable<z.ZodString>;
|
|
4362
|
+
inspectionResultLink: z.ZodNullable<z.ZodString>;
|
|
4363
|
+
}, z.core.$loose>>;
|
|
4364
|
+
errors: z.ZodArray<z.ZodObject<{
|
|
4365
|
+
url: z.ZodString;
|
|
4366
|
+
error: z.ZodString;
|
|
4367
|
+
}, z.core.$loose>>;
|
|
4368
|
+
skipped: z.ZodArray<z.ZodObject<{
|
|
4369
|
+
url: z.ZodString;
|
|
4370
|
+
reason: z.ZodString;
|
|
4371
|
+
}, z.core.$loose>>;
|
|
4372
|
+
checkedAt: z.ZodISODateTime;
|
|
4373
|
+
}, z.core.$strict>;
|
|
4374
|
+
meta: z.ZodObject<{
|
|
4375
|
+
requestId: z.ZodString;
|
|
4376
|
+
version: z.ZodLiteral<"1.0">;
|
|
4377
|
+
}, z.core.$strict>;
|
|
4378
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
4379
|
+
data: z.ZodObject<{
|
|
4380
|
+
siteId: z.ZodString;
|
|
4381
|
+
rateLimit: z.ZodObject<{
|
|
4382
|
+
reserved: z.ZodNumber;
|
|
4383
|
+
remaining: z.ZodNumber;
|
|
4384
|
+
limit: z.ZodNumber;
|
|
4385
|
+
}, z.core.$loose>;
|
|
4386
|
+
results: z.ZodArray<z.ZodObject<{
|
|
4387
|
+
url: z.ZodString;
|
|
4388
|
+
verdict: z.ZodNullable<z.ZodString>;
|
|
4389
|
+
coverageState: z.ZodNullable<z.ZodString>;
|
|
4390
|
+
indexingState: z.ZodNullable<z.ZodString>;
|
|
4391
|
+
robotsTxtState: z.ZodNullable<z.ZodString>;
|
|
4392
|
+
pageFetchState: z.ZodNullable<z.ZodString>;
|
|
4393
|
+
lastCrawlTime: z.ZodNullable<z.ZodString>;
|
|
4394
|
+
crawlingUserAgent: z.ZodNullable<z.ZodString>;
|
|
4395
|
+
userCanonical: z.ZodNullable<z.ZodString>;
|
|
4396
|
+
googleCanonical: z.ZodNullable<z.ZodString>;
|
|
4397
|
+
sitemaps: z.ZodNullable<z.ZodString>;
|
|
4398
|
+
referringUrls: z.ZodNullable<z.ZodString>;
|
|
4399
|
+
mobileVerdict: z.ZodNullable<z.ZodString>;
|
|
4400
|
+
mobileIssues: z.ZodNullable<z.ZodString>;
|
|
4401
|
+
richResultsVerdict: z.ZodNullable<z.ZodString>;
|
|
4402
|
+
richResultsItems: z.ZodNullable<z.ZodString>;
|
|
4403
|
+
inspectionResultLink: z.ZodNullable<z.ZodString>;
|
|
4404
|
+
}, z.core.$loose>>;
|
|
4405
|
+
errors: z.ZodArray<z.ZodObject<{
|
|
4406
|
+
url: z.ZodString;
|
|
4407
|
+
error: z.ZodString;
|
|
4408
|
+
}, z.core.$loose>>;
|
|
4409
|
+
skipped: z.ZodArray<z.ZodObject<{
|
|
4410
|
+
url: z.ZodString;
|
|
4411
|
+
reason: z.ZodString;
|
|
4412
|
+
}, z.core.$loose>>;
|
|
4413
|
+
checkedAt: z.ZodISODateTime;
|
|
4414
|
+
}, z.core.$loose>;
|
|
4415
|
+
meta: z.ZodObject<{
|
|
4416
|
+
requestId: z.ZodString;
|
|
4417
|
+
version: z.ZodLiteral<"1.0">;
|
|
4418
|
+
}, z.core.$loose>;
|
|
4419
|
+
}, z.core.$strip>>;
|
|
4420
|
+
export type UrlInspectionRefreshData = z.output<typeof urlInspectionRefreshDataSchema.client>;
|
|
4421
|
+
export declare const urlInspectionRefreshOperation: {
|
|
4422
|
+
readonly visibility: 'public';
|
|
4423
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "auth_expired", "forbidden", "not_found", "entitlement_required", "stale_evidence", "rate_limited", "provider_unavailable", "conflict", "contract_violation", "internal_error"];
|
|
4424
|
+
readonly errorResponse: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
4425
|
+
readonly error: z.ZodObject<{
|
|
4426
|
+
code: z.ZodEnum<{
|
|
4427
|
+
auth_expired: "auth_expired";
|
|
4428
|
+
conflict: "conflict";
|
|
4429
|
+
contract_violation: "contract_violation";
|
|
4430
|
+
entitlement_required: "entitlement_required";
|
|
4431
|
+
forbidden: "forbidden";
|
|
4432
|
+
internal_error: "internal_error";
|
|
4433
|
+
invalid_request: "invalid_request";
|
|
4434
|
+
not_found: "not_found";
|
|
4435
|
+
provider_unavailable: "provider_unavailable";
|
|
4436
|
+
quota_exhausted: "quota_exhausted";
|
|
4437
|
+
rate_limited: "rate_limited";
|
|
4438
|
+
site_ambiguous: "site_ambiguous";
|
|
4439
|
+
stale_evidence: "stale_evidence";
|
|
4440
|
+
unauthorized: "unauthorized";
|
|
4441
|
+
}>;
|
|
4442
|
+
message: z.ZodString;
|
|
4443
|
+
requestId: z.ZodString;
|
|
4444
|
+
retryable: z.ZodBoolean;
|
|
4445
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
4446
|
+
}, z.core.$strict>;
|
|
4447
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
4448
|
+
readonly error: z.ZodObject<{
|
|
4449
|
+
code: z.ZodEnum<{
|
|
4450
|
+
auth_expired: "auth_expired";
|
|
4451
|
+
conflict: "conflict";
|
|
4452
|
+
contract_violation: "contract_violation";
|
|
4453
|
+
entitlement_required: "entitlement_required";
|
|
4454
|
+
forbidden: "forbidden";
|
|
4455
|
+
internal_error: "internal_error";
|
|
4456
|
+
invalid_request: "invalid_request";
|
|
4457
|
+
not_found: "not_found";
|
|
4458
|
+
provider_unavailable: "provider_unavailable";
|
|
4459
|
+
quota_exhausted: "quota_exhausted";
|
|
4460
|
+
rate_limited: "rate_limited";
|
|
4461
|
+
site_ambiguous: "site_ambiguous";
|
|
4462
|
+
stale_evidence: "stale_evidence";
|
|
4463
|
+
unauthorized: "unauthorized";
|
|
4464
|
+
}>;
|
|
4465
|
+
message: z.ZodString;
|
|
4466
|
+
requestId: z.ZodString;
|
|
4467
|
+
retryable: z.ZodBoolean;
|
|
4468
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
4469
|
+
}, z.core.$loose>;
|
|
4470
|
+
}, z.core.$strip>>;
|
|
4471
|
+
readonly policy: {
|
|
4472
|
+
readonly rate: {
|
|
4473
|
+
readonly name: 'public-v1-fixed-window';
|
|
4474
|
+
readonly limit: 50;
|
|
4475
|
+
readonly windowSeconds: 60;
|
|
4476
|
+
};
|
|
4477
|
+
readonly idempotency: {
|
|
4478
|
+
readonly _tag: 'none';
|
|
4479
|
+
};
|
|
4480
|
+
readonly entitlement: null;
|
|
4481
|
+
readonly meter: null;
|
|
4482
|
+
};
|
|
4483
|
+
readonly id: 'sites.search.indexing.inspection.refresh';
|
|
4484
|
+
readonly method: 'POST';
|
|
4485
|
+
readonly path: '/api/v1/sites/{siteId}/search/indexing/inspection';
|
|
4486
|
+
readonly semantics: {
|
|
4487
|
+
readonly kind: 'mutation';
|
|
4488
|
+
readonly sideEffects: 'state';
|
|
4489
|
+
readonly retry: 'never';
|
|
4490
|
+
readonly readConsistency: null;
|
|
4491
|
+
};
|
|
4492
|
+
readonly auth: {
|
|
4493
|
+
readonly credentials: readonly ["session", "api_token"];
|
|
4494
|
+
readonly scopes: readonly ["sites:write"];
|
|
4495
|
+
readonly minimumRole: 'member';
|
|
4496
|
+
readonly ownership: 'site';
|
|
4497
|
+
};
|
|
4498
|
+
readonly request: {
|
|
4499
|
+
readonly params: z.ZodObject<{
|
|
4500
|
+
siteId: z.ZodString;
|
|
4501
|
+
}, z.core.$strict>;
|
|
4502
|
+
readonly query: null;
|
|
4503
|
+
readonly headers: null;
|
|
4504
|
+
readonly body: z.ZodObject<{
|
|
4505
|
+
url: z.ZodString;
|
|
4506
|
+
}, z.core.$strict>;
|
|
4507
|
+
};
|
|
4508
|
+
readonly responses: {
|
|
4509
|
+
readonly 200: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
4510
|
+
data: z.ZodObject<{
|
|
4511
|
+
siteId: z.ZodString;
|
|
4512
|
+
rateLimit: z.ZodObject<{
|
|
4513
|
+
reserved: z.ZodNumber;
|
|
4514
|
+
remaining: z.ZodNumber;
|
|
4515
|
+
limit: z.ZodNumber;
|
|
4516
|
+
}, z.core.$loose>;
|
|
4517
|
+
results: z.ZodArray<z.ZodObject<{
|
|
4518
|
+
url: z.ZodString;
|
|
4519
|
+
verdict: z.ZodNullable<z.ZodString>;
|
|
4520
|
+
coverageState: z.ZodNullable<z.ZodString>;
|
|
4521
|
+
indexingState: z.ZodNullable<z.ZodString>;
|
|
4522
|
+
robotsTxtState: z.ZodNullable<z.ZodString>;
|
|
4523
|
+
pageFetchState: z.ZodNullable<z.ZodString>;
|
|
4524
|
+
lastCrawlTime: z.ZodNullable<z.ZodString>;
|
|
4525
|
+
crawlingUserAgent: z.ZodNullable<z.ZodString>;
|
|
4526
|
+
userCanonical: z.ZodNullable<z.ZodString>;
|
|
4527
|
+
googleCanonical: z.ZodNullable<z.ZodString>;
|
|
4528
|
+
sitemaps: z.ZodNullable<z.ZodString>;
|
|
4529
|
+
referringUrls: z.ZodNullable<z.ZodString>;
|
|
4530
|
+
mobileVerdict: z.ZodNullable<z.ZodString>;
|
|
4531
|
+
mobileIssues: z.ZodNullable<z.ZodString>;
|
|
4532
|
+
richResultsVerdict: z.ZodNullable<z.ZodString>;
|
|
4533
|
+
richResultsItems: z.ZodNullable<z.ZodString>;
|
|
4534
|
+
inspectionResultLink: z.ZodNullable<z.ZodString>;
|
|
4535
|
+
}, z.core.$loose>>;
|
|
4536
|
+
errors: z.ZodArray<z.ZodObject<{
|
|
4537
|
+
url: z.ZodString;
|
|
4538
|
+
error: z.ZodString;
|
|
4539
|
+
}, z.core.$loose>>;
|
|
4540
|
+
skipped: z.ZodArray<z.ZodObject<{
|
|
4541
|
+
url: z.ZodString;
|
|
4542
|
+
reason: z.ZodString;
|
|
4543
|
+
}, z.core.$loose>>;
|
|
4544
|
+
checkedAt: z.ZodISODateTime;
|
|
4545
|
+
}, z.core.$strict>;
|
|
4546
|
+
meta: z.ZodObject<{
|
|
4547
|
+
requestId: z.ZodString;
|
|
4548
|
+
version: z.ZodLiteral<"1.0">;
|
|
4549
|
+
}, z.core.$strict>;
|
|
4550
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
4551
|
+
data: z.ZodObject<{
|
|
4552
|
+
siteId: z.ZodString;
|
|
4553
|
+
rateLimit: z.ZodObject<{
|
|
4554
|
+
reserved: z.ZodNumber;
|
|
4555
|
+
remaining: z.ZodNumber;
|
|
4556
|
+
limit: z.ZodNumber;
|
|
4557
|
+
}, z.core.$loose>;
|
|
4558
|
+
results: z.ZodArray<z.ZodObject<{
|
|
4559
|
+
url: z.ZodString;
|
|
4560
|
+
verdict: z.ZodNullable<z.ZodString>;
|
|
4561
|
+
coverageState: z.ZodNullable<z.ZodString>;
|
|
4562
|
+
indexingState: z.ZodNullable<z.ZodString>;
|
|
4563
|
+
robotsTxtState: z.ZodNullable<z.ZodString>;
|
|
4564
|
+
pageFetchState: z.ZodNullable<z.ZodString>;
|
|
4565
|
+
lastCrawlTime: z.ZodNullable<z.ZodString>;
|
|
4566
|
+
crawlingUserAgent: z.ZodNullable<z.ZodString>;
|
|
4567
|
+
userCanonical: z.ZodNullable<z.ZodString>;
|
|
4568
|
+
googleCanonical: z.ZodNullable<z.ZodString>;
|
|
4569
|
+
sitemaps: z.ZodNullable<z.ZodString>;
|
|
4570
|
+
referringUrls: z.ZodNullable<z.ZodString>;
|
|
4571
|
+
mobileVerdict: z.ZodNullable<z.ZodString>;
|
|
4572
|
+
mobileIssues: z.ZodNullable<z.ZodString>;
|
|
4573
|
+
richResultsVerdict: z.ZodNullable<z.ZodString>;
|
|
4574
|
+
richResultsItems: z.ZodNullable<z.ZodString>;
|
|
4575
|
+
inspectionResultLink: z.ZodNullable<z.ZodString>;
|
|
4576
|
+
}, z.core.$loose>>;
|
|
4577
|
+
errors: z.ZodArray<z.ZodObject<{
|
|
4578
|
+
url: z.ZodString;
|
|
4579
|
+
error: z.ZodString;
|
|
4580
|
+
}, z.core.$loose>>;
|
|
4581
|
+
skipped: z.ZodArray<z.ZodObject<{
|
|
4582
|
+
url: z.ZodString;
|
|
4583
|
+
reason: z.ZodString;
|
|
4584
|
+
}, z.core.$loose>>;
|
|
4585
|
+
checkedAt: z.ZodISODateTime;
|
|
4586
|
+
}, z.core.$loose>;
|
|
4587
|
+
meta: z.ZodObject<{
|
|
4588
|
+
requestId: z.ZodString;
|
|
4589
|
+
version: z.ZodLiteral<"1.0">;
|
|
4590
|
+
}, z.core.$loose>;
|
|
4591
|
+
}, z.core.$strip>>;
|
|
4592
|
+
};
|
|
4593
|
+
readonly resources: {
|
|
4594
|
+
readonly reads: readonly [{
|
|
4595
|
+
readonly type: 'site.page';
|
|
4596
|
+
readonly idFrom: 'params.siteId';
|
|
4597
|
+
}];
|
|
4598
|
+
readonly changes: readonly [{
|
|
4599
|
+
readonly type: 'site.page';
|
|
4600
|
+
readonly idFrom: 'params.siteId';
|
|
4601
|
+
}];
|
|
4602
|
+
};
|
|
4603
|
+
readonly lifecycle: {
|
|
4604
|
+
readonly introduced: '1.3.0';
|
|
4605
|
+
};
|
|
4606
|
+
readonly docs: {
|
|
4607
|
+
readonly summary: 'Request a fresh URL Inspection';
|
|
4608
|
+
readonly description: 'Requests Google URL Inspection through the Site connection. Uses inspection quota and retains the result. Errors and skipped URLs remain explicit.';
|
|
4609
|
+
readonly tags: readonly ["Sites", "Search", "Indexing"];
|
|
4610
|
+
readonly examples: readonly [{
|
|
4611
|
+
readonly request: {
|
|
4612
|
+
readonly params: {
|
|
4613
|
+
readonly siteId: 'site_01JXYZ';
|
|
4614
|
+
};
|
|
4615
|
+
readonly body: {
|
|
4616
|
+
readonly url: '/docs';
|
|
4617
|
+
};
|
|
4618
|
+
};
|
|
4619
|
+
readonly response: {
|
|
4620
|
+
readonly status: 200;
|
|
4621
|
+
readonly body: {
|
|
4622
|
+
readonly data: {
|
|
4623
|
+
readonly siteId: 'site_01JXYZ';
|
|
4624
|
+
readonly checkedAt: '2026-10-05T00:00:00.000Z';
|
|
4625
|
+
readonly rateLimit: {
|
|
4626
|
+
readonly reserved: 1;
|
|
4627
|
+
readonly remaining: 9;
|
|
4628
|
+
readonly limit: 10;
|
|
4629
|
+
};
|
|
4630
|
+
readonly results: readonly [];
|
|
4631
|
+
readonly errors: readonly [{
|
|
4632
|
+
readonly url: 'https://example.com/docs';
|
|
4633
|
+
readonly error: 'Inspection failed';
|
|
4634
|
+
}];
|
|
4635
|
+
readonly skipped: readonly [];
|
|
4636
|
+
};
|
|
4637
|
+
readonly meta: {
|
|
4638
|
+
readonly requestId: 'req_01JXYZ';
|
|
4639
|
+
readonly version: '1.0';
|
|
4640
|
+
};
|
|
4641
|
+
};
|
|
4642
|
+
};
|
|
4643
|
+
}];
|
|
4644
|
+
};
|
|
4645
|
+
};
|
|
4260
4646
|
export declare const indexCohortsQuerySchema: z.ZodObject<{
|
|
4261
4647
|
limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
4262
4648
|
minSectionPages: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
@@ -6687,6 +7073,231 @@ export declare const searchV1Registry: import("./core.js").PublicV1Registry<{
|
|
|
6687
7073
|
}];
|
|
6688
7074
|
};
|
|
6689
7075
|
};
|
|
7076
|
+
readonly refreshUrlInspection: {
|
|
7077
|
+
readonly visibility: 'public';
|
|
7078
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "auth_expired", "forbidden", "not_found", "entitlement_required", "stale_evidence", "rate_limited", "provider_unavailable", "conflict", "contract_violation", "internal_error"];
|
|
7079
|
+
readonly errorResponse: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
7080
|
+
readonly error: z.ZodObject<{
|
|
7081
|
+
code: z.ZodEnum<{
|
|
7082
|
+
auth_expired: "auth_expired";
|
|
7083
|
+
conflict: "conflict";
|
|
7084
|
+
contract_violation: "contract_violation";
|
|
7085
|
+
entitlement_required: "entitlement_required";
|
|
7086
|
+
forbidden: "forbidden";
|
|
7087
|
+
internal_error: "internal_error";
|
|
7088
|
+
invalid_request: "invalid_request";
|
|
7089
|
+
not_found: "not_found";
|
|
7090
|
+
provider_unavailable: "provider_unavailable";
|
|
7091
|
+
quota_exhausted: "quota_exhausted";
|
|
7092
|
+
rate_limited: "rate_limited";
|
|
7093
|
+
site_ambiguous: "site_ambiguous";
|
|
7094
|
+
stale_evidence: "stale_evidence";
|
|
7095
|
+
unauthorized: "unauthorized";
|
|
7096
|
+
}>;
|
|
7097
|
+
message: z.ZodString;
|
|
7098
|
+
requestId: z.ZodString;
|
|
7099
|
+
retryable: z.ZodBoolean;
|
|
7100
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
7101
|
+
}, z.core.$strict>;
|
|
7102
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
7103
|
+
readonly error: z.ZodObject<{
|
|
7104
|
+
code: z.ZodEnum<{
|
|
7105
|
+
auth_expired: "auth_expired";
|
|
7106
|
+
conflict: "conflict";
|
|
7107
|
+
contract_violation: "contract_violation";
|
|
7108
|
+
entitlement_required: "entitlement_required";
|
|
7109
|
+
forbidden: "forbidden";
|
|
7110
|
+
internal_error: "internal_error";
|
|
7111
|
+
invalid_request: "invalid_request";
|
|
7112
|
+
not_found: "not_found";
|
|
7113
|
+
provider_unavailable: "provider_unavailable";
|
|
7114
|
+
quota_exhausted: "quota_exhausted";
|
|
7115
|
+
rate_limited: "rate_limited";
|
|
7116
|
+
site_ambiguous: "site_ambiguous";
|
|
7117
|
+
stale_evidence: "stale_evidence";
|
|
7118
|
+
unauthorized: "unauthorized";
|
|
7119
|
+
}>;
|
|
7120
|
+
message: z.ZodString;
|
|
7121
|
+
requestId: z.ZodString;
|
|
7122
|
+
retryable: z.ZodBoolean;
|
|
7123
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
7124
|
+
}, z.core.$loose>;
|
|
7125
|
+
}, z.core.$strip>>;
|
|
7126
|
+
readonly policy: {
|
|
7127
|
+
readonly rate: {
|
|
7128
|
+
readonly name: 'public-v1-fixed-window';
|
|
7129
|
+
readonly limit: 50;
|
|
7130
|
+
readonly windowSeconds: 60;
|
|
7131
|
+
};
|
|
7132
|
+
readonly idempotency: {
|
|
7133
|
+
readonly _tag: 'none';
|
|
7134
|
+
};
|
|
7135
|
+
readonly entitlement: null;
|
|
7136
|
+
readonly meter: null;
|
|
7137
|
+
};
|
|
7138
|
+
readonly id: 'sites.search.indexing.inspection.refresh';
|
|
7139
|
+
readonly method: 'POST';
|
|
7140
|
+
readonly path: '/api/v1/sites/{siteId}/search/indexing/inspection';
|
|
7141
|
+
readonly semantics: {
|
|
7142
|
+
readonly kind: 'mutation';
|
|
7143
|
+
readonly sideEffects: 'state';
|
|
7144
|
+
readonly retry: 'never';
|
|
7145
|
+
readonly readConsistency: null;
|
|
7146
|
+
};
|
|
7147
|
+
readonly auth: {
|
|
7148
|
+
readonly credentials: readonly ["session", "api_token"];
|
|
7149
|
+
readonly scopes: readonly ["sites:write"];
|
|
7150
|
+
readonly minimumRole: 'member';
|
|
7151
|
+
readonly ownership: 'site';
|
|
7152
|
+
};
|
|
7153
|
+
readonly request: {
|
|
7154
|
+
readonly params: z.ZodObject<{
|
|
7155
|
+
siteId: z.ZodString;
|
|
7156
|
+
}, z.core.$strict>;
|
|
7157
|
+
readonly query: null;
|
|
7158
|
+
readonly headers: null;
|
|
7159
|
+
readonly body: z.ZodObject<{
|
|
7160
|
+
url: z.ZodString;
|
|
7161
|
+
}, z.core.$strict>;
|
|
7162
|
+
};
|
|
7163
|
+
readonly responses: {
|
|
7164
|
+
readonly 200: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
7165
|
+
data: z.ZodObject<{
|
|
7166
|
+
siteId: z.ZodString;
|
|
7167
|
+
rateLimit: z.ZodObject<{
|
|
7168
|
+
reserved: z.ZodNumber;
|
|
7169
|
+
remaining: z.ZodNumber;
|
|
7170
|
+
limit: z.ZodNumber;
|
|
7171
|
+
}, z.core.$loose>;
|
|
7172
|
+
results: z.ZodArray<z.ZodObject<{
|
|
7173
|
+
url: z.ZodString;
|
|
7174
|
+
verdict: z.ZodNullable<z.ZodString>;
|
|
7175
|
+
coverageState: z.ZodNullable<z.ZodString>;
|
|
7176
|
+
indexingState: z.ZodNullable<z.ZodString>;
|
|
7177
|
+
robotsTxtState: z.ZodNullable<z.ZodString>;
|
|
7178
|
+
pageFetchState: z.ZodNullable<z.ZodString>;
|
|
7179
|
+
lastCrawlTime: z.ZodNullable<z.ZodString>;
|
|
7180
|
+
crawlingUserAgent: z.ZodNullable<z.ZodString>;
|
|
7181
|
+
userCanonical: z.ZodNullable<z.ZodString>;
|
|
7182
|
+
googleCanonical: z.ZodNullable<z.ZodString>;
|
|
7183
|
+
sitemaps: z.ZodNullable<z.ZodString>;
|
|
7184
|
+
referringUrls: z.ZodNullable<z.ZodString>;
|
|
7185
|
+
mobileVerdict: z.ZodNullable<z.ZodString>;
|
|
7186
|
+
mobileIssues: z.ZodNullable<z.ZodString>;
|
|
7187
|
+
richResultsVerdict: z.ZodNullable<z.ZodString>;
|
|
7188
|
+
richResultsItems: z.ZodNullable<z.ZodString>;
|
|
7189
|
+
inspectionResultLink: z.ZodNullable<z.ZodString>;
|
|
7190
|
+
}, z.core.$loose>>;
|
|
7191
|
+
errors: z.ZodArray<z.ZodObject<{
|
|
7192
|
+
url: z.ZodString;
|
|
7193
|
+
error: z.ZodString;
|
|
7194
|
+
}, z.core.$loose>>;
|
|
7195
|
+
skipped: z.ZodArray<z.ZodObject<{
|
|
7196
|
+
url: z.ZodString;
|
|
7197
|
+
reason: z.ZodString;
|
|
7198
|
+
}, z.core.$loose>>;
|
|
7199
|
+
checkedAt: z.ZodISODateTime;
|
|
7200
|
+
}, z.core.$strict>;
|
|
7201
|
+
meta: z.ZodObject<{
|
|
7202
|
+
requestId: z.ZodString;
|
|
7203
|
+
version: z.ZodLiteral<"1.0">;
|
|
7204
|
+
}, z.core.$strict>;
|
|
7205
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
7206
|
+
data: z.ZodObject<{
|
|
7207
|
+
siteId: z.ZodString;
|
|
7208
|
+
rateLimit: z.ZodObject<{
|
|
7209
|
+
reserved: z.ZodNumber;
|
|
7210
|
+
remaining: z.ZodNumber;
|
|
7211
|
+
limit: z.ZodNumber;
|
|
7212
|
+
}, z.core.$loose>;
|
|
7213
|
+
results: z.ZodArray<z.ZodObject<{
|
|
7214
|
+
url: z.ZodString;
|
|
7215
|
+
verdict: z.ZodNullable<z.ZodString>;
|
|
7216
|
+
coverageState: z.ZodNullable<z.ZodString>;
|
|
7217
|
+
indexingState: z.ZodNullable<z.ZodString>;
|
|
7218
|
+
robotsTxtState: z.ZodNullable<z.ZodString>;
|
|
7219
|
+
pageFetchState: z.ZodNullable<z.ZodString>;
|
|
7220
|
+
lastCrawlTime: z.ZodNullable<z.ZodString>;
|
|
7221
|
+
crawlingUserAgent: z.ZodNullable<z.ZodString>;
|
|
7222
|
+
userCanonical: z.ZodNullable<z.ZodString>;
|
|
7223
|
+
googleCanonical: z.ZodNullable<z.ZodString>;
|
|
7224
|
+
sitemaps: z.ZodNullable<z.ZodString>;
|
|
7225
|
+
referringUrls: z.ZodNullable<z.ZodString>;
|
|
7226
|
+
mobileVerdict: z.ZodNullable<z.ZodString>;
|
|
7227
|
+
mobileIssues: z.ZodNullable<z.ZodString>;
|
|
7228
|
+
richResultsVerdict: z.ZodNullable<z.ZodString>;
|
|
7229
|
+
richResultsItems: z.ZodNullable<z.ZodString>;
|
|
7230
|
+
inspectionResultLink: z.ZodNullable<z.ZodString>;
|
|
7231
|
+
}, z.core.$loose>>;
|
|
7232
|
+
errors: z.ZodArray<z.ZodObject<{
|
|
7233
|
+
url: z.ZodString;
|
|
7234
|
+
error: z.ZodString;
|
|
7235
|
+
}, z.core.$loose>>;
|
|
7236
|
+
skipped: z.ZodArray<z.ZodObject<{
|
|
7237
|
+
url: z.ZodString;
|
|
7238
|
+
reason: z.ZodString;
|
|
7239
|
+
}, z.core.$loose>>;
|
|
7240
|
+
checkedAt: z.ZodISODateTime;
|
|
7241
|
+
}, z.core.$loose>;
|
|
7242
|
+
meta: z.ZodObject<{
|
|
7243
|
+
requestId: z.ZodString;
|
|
7244
|
+
version: z.ZodLiteral<"1.0">;
|
|
7245
|
+
}, z.core.$loose>;
|
|
7246
|
+
}, z.core.$strip>>;
|
|
7247
|
+
};
|
|
7248
|
+
readonly resources: {
|
|
7249
|
+
readonly reads: readonly [{
|
|
7250
|
+
readonly type: 'site.page';
|
|
7251
|
+
readonly idFrom: 'params.siteId';
|
|
7252
|
+
}];
|
|
7253
|
+
readonly changes: readonly [{
|
|
7254
|
+
readonly type: 'site.page';
|
|
7255
|
+
readonly idFrom: 'params.siteId';
|
|
7256
|
+
}];
|
|
7257
|
+
};
|
|
7258
|
+
readonly lifecycle: {
|
|
7259
|
+
readonly introduced: '1.3.0';
|
|
7260
|
+
};
|
|
7261
|
+
readonly docs: {
|
|
7262
|
+
readonly summary: 'Request a fresh URL Inspection';
|
|
7263
|
+
readonly description: 'Requests Google URL Inspection through the Site connection. Uses inspection quota and retains the result. Errors and skipped URLs remain explicit.';
|
|
7264
|
+
readonly tags: readonly ["Sites", "Search", "Indexing"];
|
|
7265
|
+
readonly examples: readonly [{
|
|
7266
|
+
readonly request: {
|
|
7267
|
+
readonly params: {
|
|
7268
|
+
readonly siteId: 'site_01JXYZ';
|
|
7269
|
+
};
|
|
7270
|
+
readonly body: {
|
|
7271
|
+
readonly url: '/docs';
|
|
7272
|
+
};
|
|
7273
|
+
};
|
|
7274
|
+
readonly response: {
|
|
7275
|
+
readonly status: 200;
|
|
7276
|
+
readonly body: {
|
|
7277
|
+
readonly data: {
|
|
7278
|
+
readonly siteId: 'site_01JXYZ';
|
|
7279
|
+
readonly checkedAt: '2026-10-05T00:00:00.000Z';
|
|
7280
|
+
readonly rateLimit: {
|
|
7281
|
+
readonly reserved: 1;
|
|
7282
|
+
readonly remaining: 9;
|
|
7283
|
+
readonly limit: 10;
|
|
7284
|
+
};
|
|
7285
|
+
readonly results: readonly [];
|
|
7286
|
+
readonly errors: readonly [{
|
|
7287
|
+
readonly url: 'https://example.com/docs';
|
|
7288
|
+
readonly error: 'Inspection failed';
|
|
7289
|
+
}];
|
|
7290
|
+
readonly skipped: readonly [];
|
|
7291
|
+
};
|
|
7292
|
+
readonly meta: {
|
|
7293
|
+
readonly requestId: 'req_01JXYZ';
|
|
7294
|
+
readonly version: '1.0';
|
|
7295
|
+
};
|
|
7296
|
+
};
|
|
7297
|
+
};
|
|
7298
|
+
}];
|
|
7299
|
+
};
|
|
7300
|
+
};
|
|
6690
7301
|
readonly readIndexingCohorts: {
|
|
6691
7302
|
readonly id: 'sites.search.indexing.cohorts.read';
|
|
6692
7303
|
readonly method: 'GET';
|
package/dist/v1/gsc.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { canonicalDifferenceKindSchema, gscdumpAnalysisPresetSchema, gscdumpIndexingTransitionFieldSchema, gscdumpTotalsSchema, indexingIssueSchema, } from '@gscdump/contracts';
|
|
1
|
+
import { canonicalDifferenceKindSchema, gscdumpAnalysisPresetSchema, gscdumpIndexingTransitionFieldSchema, gscdumpTotalsSchema, indexingInspectResponseSchema, indexingIssueSchema, } 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({
|
|
@@ -620,6 +620,30 @@ export const urlInspectionReadOperation = defineOperation({
|
|
|
620
620
|
examples: [{ request: { params: { siteId: 'site_01JXYZ' }, query: { url: '/docs' } }, response: { status: 200, body: { data: { _tag: 'no-inspection-data', requestedUrl: 'https://example.com/docs' }, meta: { requestId: 'req_01JXYZ', version: '1.0' } } } }],
|
|
621
621
|
},
|
|
622
622
|
});
|
|
623
|
+
export const urlInspectionRefreshBodySchema = schema.strictObject({ url: pageUrlSchema });
|
|
624
|
+
export const urlInspectionRefreshDataSchema = {
|
|
625
|
+
producer: indexingInspectResponseSchema.extend({ checkedAt: schema.iso.datetime() }).strict(),
|
|
626
|
+
client: indexingInspectResponseSchema.extend({ checkedAt: schema.iso.datetime() }).loose(),
|
|
627
|
+
};
|
|
628
|
+
export const urlInspectionRefreshResponseSchema = defineSuccessEnvelope(urlInspectionRefreshDataSchema);
|
|
629
|
+
export const urlInspectionRefreshOperation = defineOperation({
|
|
630
|
+
...common,
|
|
631
|
+
id: 'sites.search.indexing.inspection.refresh',
|
|
632
|
+
method: 'POST',
|
|
633
|
+
path: '/api/v1/sites/{siteId}/search/indexing/inspection',
|
|
634
|
+
semantics: { kind: 'mutation', sideEffects: 'state', retry: 'never', readConsistency: null },
|
|
635
|
+
auth: { credentials: ['session', 'api_token'], scopes: ['sites:write'], minimumRole: 'member', ownership: 'site' },
|
|
636
|
+
request: { params: searchConsoleSiteParamsSchema, query: null, headers: null, body: urlInspectionRefreshBodySchema },
|
|
637
|
+
responses: { 200: urlInspectionRefreshResponseSchema },
|
|
638
|
+
resources: { reads: [{ type: 'site.page', idFrom: 'params.siteId' }], changes: [{ type: 'site.page', idFrom: 'params.siteId' }] },
|
|
639
|
+
lifecycle: { introduced: '1.3.0' },
|
|
640
|
+
docs: {
|
|
641
|
+
summary: 'Request a fresh URL Inspection',
|
|
642
|
+
description: 'Requests Google URL Inspection through the Site connection. Uses inspection quota and retains the result. Errors and skipped URLs remain explicit.',
|
|
643
|
+
tags: ['Sites', 'Search', 'Indexing'],
|
|
644
|
+
examples: [{ request: { params: { siteId: 'site_01JXYZ' }, body: { url: '/docs' } }, response: { status: 200, body: { data: { siteId: 'site_01JXYZ', checkedAt: '2026-10-05T00:00:00.000Z', rateLimit: { reserved: 1, remaining: 9, limit: 10 }, results: [], errors: [{ url: 'https://example.com/docs', error: 'Inspection failed' }], skipped: [] }, meta: { requestId: 'req_01JXYZ', version: '1.0' } } } }],
|
|
645
|
+
},
|
|
646
|
+
});
|
|
623
647
|
export const indexCohortsQuerySchema = schema.strictObject({
|
|
624
648
|
limit: schema.coerce.number().int().min(1).max(50).default(12),
|
|
625
649
|
minSectionPages: schema.coerce.number().int().min(1).max(500).default(5),
|
|
@@ -816,6 +840,7 @@ export const searchV1Registry = defineRegistry({
|
|
|
816
840
|
readIndexingDiagnostics: indexingDiagnosticsReadOperation,
|
|
817
841
|
readIndexingHistory: indexingHistoryReadOperation,
|
|
818
842
|
readUrlInspection: urlInspectionReadOperation,
|
|
843
|
+
refreshUrlInspection: urlInspectionRefreshOperation,
|
|
819
844
|
readIndexingCohorts: indexCohortsReadOperation,
|
|
820
845
|
},
|
|
821
846
|
});
|