@gscdump/contracts 2.1.0 → 2.2.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/dist/endpoints.d.mts +4 -4
- package/dist/onboarding.d.mts +1 -1
- package/dist/onboarding.mjs +1 -1
- package/dist/schemas.d.mts +14 -14
- package/dist/schemas.mjs +2 -2
- package/dist/types.d.mts +3 -3
- package/dist/v1/browser.d.mts +2 -2
- package/dist/v1/browser.mjs +47 -44
- package/dist/v1/http.d.mts +2 -2
- package/dist/v1/index.d.mts +2 -2
- package/dist/v1/operations.d.mts +365 -13
- package/dist/v1/operations.mjs +143 -1
- package/package.json +1 -1
package/dist/endpoints.d.mts
CHANGED
|
@@ -732,7 +732,7 @@ declare const partnerEndpoints: {
|
|
|
732
732
|
code: import("zod").ZodEnum<{
|
|
733
733
|
missing_refresh_token: "missing_refresh_token";
|
|
734
734
|
missing_analytics_scope: "missing_analytics_scope";
|
|
735
|
-
|
|
735
|
+
missing_gsc_read_scope: "missing_gsc_read_scope";
|
|
736
736
|
token_refresh_failed: "token_refresh_failed";
|
|
737
737
|
permission_lost: "permission_lost";
|
|
738
738
|
insufficient_gsc_permission: "insufficient_gsc_permission";
|
|
@@ -851,7 +851,7 @@ declare const partnerEndpoints: {
|
|
|
851
851
|
existing: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
852
852
|
indexingEligible: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
853
853
|
indexingIneligibleReason: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
854
|
-
|
|
854
|
+
missing_gsc_read_scope: "missing_gsc_read_scope";
|
|
855
855
|
insufficient_gsc_permission: "insufficient_gsc_permission";
|
|
856
856
|
free_plan: "free_plan";
|
|
857
857
|
}>>;
|
|
@@ -969,7 +969,7 @@ declare const partnerEndpoints: {
|
|
|
969
969
|
code: import("zod").ZodEnum<{
|
|
970
970
|
missing_refresh_token: "missing_refresh_token";
|
|
971
971
|
missing_analytics_scope: "missing_analytics_scope";
|
|
972
|
-
|
|
972
|
+
missing_gsc_read_scope: "missing_gsc_read_scope";
|
|
973
973
|
token_refresh_failed: "token_refresh_failed";
|
|
974
974
|
permission_lost: "permission_lost";
|
|
975
975
|
insufficient_gsc_permission: "insufficient_gsc_permission";
|
|
@@ -1034,7 +1034,7 @@ declare const partnerEndpoints: {
|
|
|
1034
1034
|
site: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>>>;
|
|
1035
1035
|
indexingEligible: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
1036
1036
|
indexingIneligibleReason: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
1037
|
-
|
|
1037
|
+
missing_gsc_read_scope: "missing_gsc_read_scope";
|
|
1038
1038
|
insufficient_gsc_permission: "insufficient_gsc_permission";
|
|
1039
1039
|
free_plan: "free_plan";
|
|
1040
1040
|
}>>;
|
package/dist/onboarding.d.mts
CHANGED
|
@@ -14,7 +14,7 @@ declare const sitemapStatuses: readonly ["unknown", "discovering", "none_found",
|
|
|
14
14
|
declare const sitemapNextActions: readonly ["submit_sitemap", "wait_for_sitemaps", "retry_sitemaps", "none"];
|
|
15
15
|
declare const indexingStatuses: readonly ["not_requested", "missing_scope", "insufficient_permission", "waiting_for_sitemaps", "discovering", "checking", "ready", "budget_exhausted", "no_urls", "failed"];
|
|
16
16
|
declare const indexingNextActions: readonly ["reconnect_google", "fix_gsc_permission", "wait_for_sitemaps", "wait_for_indexing", "retry_indexing", "none"];
|
|
17
|
-
declare const lifecycleErrorCodes: readonly ["missing_refresh_token", "missing_analytics_scope", "
|
|
17
|
+
declare const lifecycleErrorCodes: readonly ["missing_refresh_token", "missing_analytics_scope", "missing_gsc_read_scope", "token_refresh_failed", "permission_lost", "insufficient_gsc_permission", "gsc_property_not_found", "gsc_property_unverified", "user_database_not_provisioned", "sync_failed", "sitemap_sync_failed", "indexing_failed"];
|
|
18
18
|
type AccountStatus = typeof accountStatuses[number];
|
|
19
19
|
type AccountNextAction = typeof accountNextActions[number];
|
|
20
20
|
type PropertyStatus = typeof propertyStatuses[number];
|
package/dist/onboarding.mjs
CHANGED
|
@@ -92,7 +92,7 @@ const indexingNextActions = [
|
|
|
92
92
|
const lifecycleErrorCodes = [
|
|
93
93
|
"missing_refresh_token",
|
|
94
94
|
"missing_analytics_scope",
|
|
95
|
-
"
|
|
95
|
+
"missing_gsc_read_scope",
|
|
96
96
|
"token_refresh_failed",
|
|
97
97
|
"permission_lost",
|
|
98
98
|
"insufficient_gsc_permission",
|
package/dist/schemas.d.mts
CHANGED
|
@@ -786,7 +786,7 @@ declare const lifecycleErrorSchema: z.ZodObject<{
|
|
|
786
786
|
code: z.ZodEnum<{
|
|
787
787
|
missing_refresh_token: "missing_refresh_token";
|
|
788
788
|
missing_analytics_scope: "missing_analytics_scope";
|
|
789
|
-
|
|
789
|
+
missing_gsc_read_scope: "missing_gsc_read_scope";
|
|
790
790
|
token_refresh_failed: "token_refresh_failed";
|
|
791
791
|
permission_lost: "permission_lost";
|
|
792
792
|
insufficient_gsc_permission: "insufficient_gsc_permission";
|
|
@@ -931,7 +931,7 @@ declare const partnerLifecycleSiteSchema: z.ZodObject<{
|
|
|
931
931
|
code: z.ZodEnum<{
|
|
932
932
|
missing_refresh_token: "missing_refresh_token";
|
|
933
933
|
missing_analytics_scope: "missing_analytics_scope";
|
|
934
|
-
|
|
934
|
+
missing_gsc_read_scope: "missing_gsc_read_scope";
|
|
935
935
|
token_refresh_failed: "token_refresh_failed";
|
|
936
936
|
permission_lost: "permission_lost";
|
|
937
937
|
insufficient_gsc_permission: "insufficient_gsc_permission";
|
|
@@ -1084,7 +1084,7 @@ declare const partnerLifecycleResponseSchema: z.ZodObject<{
|
|
|
1084
1084
|
code: z.ZodEnum<{
|
|
1085
1085
|
missing_refresh_token: "missing_refresh_token";
|
|
1086
1086
|
missing_analytics_scope: "missing_analytics_scope";
|
|
1087
|
-
|
|
1087
|
+
missing_gsc_read_scope: "missing_gsc_read_scope";
|
|
1088
1088
|
token_refresh_failed: "token_refresh_failed";
|
|
1089
1089
|
permission_lost: "permission_lost";
|
|
1090
1090
|
insufficient_gsc_permission: "insufficient_gsc_permission";
|
|
@@ -1153,7 +1153,7 @@ declare const gscdumpSiteRegistrationSchema: z.ZodObject<{
|
|
|
1153
1153
|
existing: z.ZodOptional<z.ZodBoolean>;
|
|
1154
1154
|
indexingEligible: z.ZodOptional<z.ZodBoolean>;
|
|
1155
1155
|
indexingIneligibleReason: z.ZodOptional<z.ZodEnum<{
|
|
1156
|
-
|
|
1156
|
+
missing_gsc_read_scope: "missing_gsc_read_scope";
|
|
1157
1157
|
insufficient_gsc_permission: "insufficient_gsc_permission";
|
|
1158
1158
|
free_plan: "free_plan";
|
|
1159
1159
|
}>>;
|
|
@@ -1271,7 +1271,7 @@ declare const gscdumpSiteRegistrationSchema: z.ZodObject<{
|
|
|
1271
1271
|
code: z.ZodEnum<{
|
|
1272
1272
|
missing_refresh_token: "missing_refresh_token";
|
|
1273
1273
|
missing_analytics_scope: "missing_analytics_scope";
|
|
1274
|
-
|
|
1274
|
+
missing_gsc_read_scope: "missing_gsc_read_scope";
|
|
1275
1275
|
token_refresh_failed: "token_refresh_failed";
|
|
1276
1276
|
permission_lost: "permission_lost";
|
|
1277
1277
|
insufficient_gsc_permission: "insufficient_gsc_permission";
|
|
@@ -1358,7 +1358,7 @@ declare const bulkRegisterPartnerSitesResponseSchema: z.ZodObject<{
|
|
|
1358
1358
|
site: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
|
|
1359
1359
|
indexingEligible: z.ZodOptional<z.ZodBoolean>;
|
|
1360
1360
|
indexingIneligibleReason: z.ZodOptional<z.ZodEnum<{
|
|
1361
|
-
|
|
1361
|
+
missing_gsc_read_scope: "missing_gsc_read_scope";
|
|
1362
1362
|
insufficient_gsc_permission: "insufficient_gsc_permission";
|
|
1363
1363
|
free_plan: "free_plan";
|
|
1364
1364
|
}>>;
|
|
@@ -3748,7 +3748,7 @@ declare const partnerControlEndpointSchemas: {
|
|
|
3748
3748
|
code: z.ZodEnum<{
|
|
3749
3749
|
missing_refresh_token: "missing_refresh_token";
|
|
3750
3750
|
missing_analytics_scope: "missing_analytics_scope";
|
|
3751
|
-
|
|
3751
|
+
missing_gsc_read_scope: "missing_gsc_read_scope";
|
|
3752
3752
|
token_refresh_failed: "token_refresh_failed";
|
|
3753
3753
|
permission_lost: "permission_lost";
|
|
3754
3754
|
insufficient_gsc_permission: "insufficient_gsc_permission";
|
|
@@ -3854,7 +3854,7 @@ declare const partnerControlEndpointSchemas: {
|
|
|
3854
3854
|
existing: z.ZodOptional<z.ZodBoolean>;
|
|
3855
3855
|
indexingEligible: z.ZodOptional<z.ZodBoolean>;
|
|
3856
3856
|
indexingIneligibleReason: z.ZodOptional<z.ZodEnum<{
|
|
3857
|
-
|
|
3857
|
+
missing_gsc_read_scope: "missing_gsc_read_scope";
|
|
3858
3858
|
insufficient_gsc_permission: "insufficient_gsc_permission";
|
|
3859
3859
|
free_plan: "free_plan";
|
|
3860
3860
|
}>>;
|
|
@@ -3972,7 +3972,7 @@ declare const partnerControlEndpointSchemas: {
|
|
|
3972
3972
|
code: z.ZodEnum<{
|
|
3973
3973
|
missing_refresh_token: "missing_refresh_token";
|
|
3974
3974
|
missing_analytics_scope: "missing_analytics_scope";
|
|
3975
|
-
|
|
3975
|
+
missing_gsc_read_scope: "missing_gsc_read_scope";
|
|
3976
3976
|
token_refresh_failed: "token_refresh_failed";
|
|
3977
3977
|
permission_lost: "permission_lost";
|
|
3978
3978
|
insufficient_gsc_permission: "insufficient_gsc_permission";
|
|
@@ -4034,7 +4034,7 @@ declare const partnerControlEndpointSchemas: {
|
|
|
4034
4034
|
site: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
|
|
4035
4035
|
indexingEligible: z.ZodOptional<z.ZodBoolean>;
|
|
4036
4036
|
indexingIneligibleReason: z.ZodOptional<z.ZodEnum<{
|
|
4037
|
-
|
|
4037
|
+
missing_gsc_read_scope: "missing_gsc_read_scope";
|
|
4038
4038
|
insufficient_gsc_permission: "insufficient_gsc_permission";
|
|
4039
4039
|
free_plan: "free_plan";
|
|
4040
4040
|
}>>;
|
|
@@ -5447,7 +5447,7 @@ declare const partnerEndpointSchemas: {
|
|
|
5447
5447
|
code: z.ZodEnum<{
|
|
5448
5448
|
missing_refresh_token: "missing_refresh_token";
|
|
5449
5449
|
missing_analytics_scope: "missing_analytics_scope";
|
|
5450
|
-
|
|
5450
|
+
missing_gsc_read_scope: "missing_gsc_read_scope";
|
|
5451
5451
|
token_refresh_failed: "token_refresh_failed";
|
|
5452
5452
|
permission_lost: "permission_lost";
|
|
5453
5453
|
insufficient_gsc_permission: "insufficient_gsc_permission";
|
|
@@ -5553,7 +5553,7 @@ declare const partnerEndpointSchemas: {
|
|
|
5553
5553
|
existing: z.ZodOptional<z.ZodBoolean>;
|
|
5554
5554
|
indexingEligible: z.ZodOptional<z.ZodBoolean>;
|
|
5555
5555
|
indexingIneligibleReason: z.ZodOptional<z.ZodEnum<{
|
|
5556
|
-
|
|
5556
|
+
missing_gsc_read_scope: "missing_gsc_read_scope";
|
|
5557
5557
|
insufficient_gsc_permission: "insufficient_gsc_permission";
|
|
5558
5558
|
free_plan: "free_plan";
|
|
5559
5559
|
}>>;
|
|
@@ -5671,7 +5671,7 @@ declare const partnerEndpointSchemas: {
|
|
|
5671
5671
|
code: z.ZodEnum<{
|
|
5672
5672
|
missing_refresh_token: "missing_refresh_token";
|
|
5673
5673
|
missing_analytics_scope: "missing_analytics_scope";
|
|
5674
|
-
|
|
5674
|
+
missing_gsc_read_scope: "missing_gsc_read_scope";
|
|
5675
5675
|
token_refresh_failed: "token_refresh_failed";
|
|
5676
5676
|
permission_lost: "permission_lost";
|
|
5677
5677
|
insufficient_gsc_permission: "insufficient_gsc_permission";
|
|
@@ -5733,7 +5733,7 @@ declare const partnerEndpointSchemas: {
|
|
|
5733
5733
|
site: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
|
|
5734
5734
|
indexingEligible: z.ZodOptional<z.ZodBoolean>;
|
|
5735
5735
|
indexingIneligibleReason: z.ZodOptional<z.ZodEnum<{
|
|
5736
|
-
|
|
5736
|
+
missing_gsc_read_scope: "missing_gsc_read_scope";
|
|
5737
5737
|
insufficient_gsc_permission: "insufficient_gsc_permission";
|
|
5738
5738
|
free_plan: "free_plan";
|
|
5739
5739
|
}>>;
|
package/dist/schemas.mjs
CHANGED
|
@@ -533,7 +533,7 @@ const gscdumpSiteRegistrationSchema = z.object({
|
|
|
533
533
|
indexingEligible: z.boolean().optional(),
|
|
534
534
|
indexingIneligibleReason: z.enum([
|
|
535
535
|
"free_plan",
|
|
536
|
-
"
|
|
536
|
+
"missing_gsc_read_scope",
|
|
537
537
|
"insufficient_gsc_permission"
|
|
538
538
|
]).optional(),
|
|
539
539
|
indexingPermissionLevel: z.string().nullable().optional(),
|
|
@@ -582,7 +582,7 @@ const bulkRegisterPartnerSitesResponseSchema = z.object({
|
|
|
582
582
|
indexingEligible: z.boolean().optional(),
|
|
583
583
|
indexingIneligibleReason: z.enum([
|
|
584
584
|
"free_plan",
|
|
585
|
-
"
|
|
585
|
+
"missing_gsc_read_scope",
|
|
586
586
|
"insufficient_gsc_permission"
|
|
587
587
|
]).optional(),
|
|
588
588
|
indexingPermissionLevel: z.string().nullable().optional(),
|
package/dist/types.d.mts
CHANGED
|
@@ -471,7 +471,7 @@ interface GscdumpSiteRegistration {
|
|
|
471
471
|
message?: string;
|
|
472
472
|
existing?: boolean;
|
|
473
473
|
indexingEligible?: boolean;
|
|
474
|
-
indexingIneligibleReason?: 'free_plan' | '
|
|
474
|
+
indexingIneligibleReason?: 'free_plan' | 'missing_gsc_read_scope' | 'insufficient_gsc_permission';
|
|
475
475
|
indexingPermissionLevel?: string | null;
|
|
476
476
|
grantedScopes?: string[];
|
|
477
477
|
site?: PartnerLifecycleSite | null;
|
|
@@ -524,7 +524,7 @@ interface GscdumpUserSite {
|
|
|
524
524
|
percent: number;
|
|
525
525
|
};
|
|
526
526
|
indexingEligible?: boolean;
|
|
527
|
-
indexingIneligibleReason?: 'free_plan' | '
|
|
527
|
+
indexingIneligibleReason?: 'free_plan' | 'missing_gsc_read_scope' | 'insufficient_gsc_permission';
|
|
528
528
|
indexingPermissionLevel?: string | null;
|
|
529
529
|
grantedScopes?: string[];
|
|
530
530
|
indexingStatus?: 'not_started' | 'indexing' | 'complete';
|
|
@@ -980,7 +980,7 @@ interface BulkRegisterPartnerSiteResult {
|
|
|
980
980
|
error?: string;
|
|
981
981
|
site?: PartnerLifecycleSite | null;
|
|
982
982
|
indexingEligible?: boolean;
|
|
983
|
-
indexingIneligibleReason?: 'free_plan' | '
|
|
983
|
+
indexingIneligibleReason?: 'free_plan' | 'missing_gsc_read_scope' | 'insufficient_gsc_permission';
|
|
984
984
|
indexingPermissionLevel?: string | null;
|
|
985
985
|
grantedScopes?: string[];
|
|
986
986
|
}
|
package/dist/v1/browser.d.mts
CHANGED
|
@@ -262,7 +262,7 @@ declare function createGscdumpV1BrowserSchemas(realtimeSchemas?: RealtimeV1Schem
|
|
|
262
262
|
readonly code: z.ZodEnum<{
|
|
263
263
|
missing_refresh_token: "missing_refresh_token";
|
|
264
264
|
missing_analytics_scope: "missing_analytics_scope";
|
|
265
|
-
|
|
265
|
+
missing_gsc_read_scope: "missing_gsc_read_scope";
|
|
266
266
|
token_refresh_failed: "token_refresh_failed";
|
|
267
267
|
permission_lost: "permission_lost";
|
|
268
268
|
insufficient_gsc_permission: "insufficient_gsc_permission";
|
|
@@ -418,7 +418,7 @@ declare function createGscdumpV1BrowserSchemas(realtimeSchemas?: RealtimeV1Schem
|
|
|
418
418
|
readonly code: z.ZodEnum<{
|
|
419
419
|
missing_refresh_token: "missing_refresh_token";
|
|
420
420
|
missing_analytics_scope: "missing_analytics_scope";
|
|
421
|
-
|
|
421
|
+
missing_gsc_read_scope: "missing_gsc_read_scope";
|
|
422
422
|
token_refresh_failed: "token_refresh_failed";
|
|
423
423
|
permission_lost: "permission_lost";
|
|
424
424
|
insufficient_gsc_permission: "insufficient_gsc_permission";
|
package/dist/v1/browser.mjs
CHANGED
|
@@ -171,51 +171,54 @@ function createGscdumpV1BrowserSchemas(realtimeSchemas = createRealtimeV1Schemas
|
|
|
171
171
|
_nestedGroups: z.array(normalizedFilter).min(1),
|
|
172
172
|
_groupType: z.enum(["and", "or"]).optional()
|
|
173
173
|
})]));
|
|
174
|
+
const analyticsRowsRequest = z.strictObject({
|
|
175
|
+
dimensions: z.array(z.enum(dimensions)).min(1),
|
|
176
|
+
metrics: z.array(z.enum(metrics)).optional(),
|
|
177
|
+
filter: normalizedFilter.optional(),
|
|
178
|
+
prefilter: normalizedFilter.optional(),
|
|
179
|
+
orderBy: z.strictObject({
|
|
180
|
+
column: z.enum([...metrics, "date"]),
|
|
181
|
+
dir: z.enum(["asc", "desc"])
|
|
182
|
+
}).optional(),
|
|
183
|
+
rowLimit: z.number().int().positive().max(25e3).optional(),
|
|
184
|
+
startRow: z.number().int().nonnegative().optional(),
|
|
185
|
+
dataState: z.enum([
|
|
186
|
+
"final",
|
|
187
|
+
"all",
|
|
188
|
+
"hourly_all"
|
|
189
|
+
]).optional(),
|
|
190
|
+
aggregationType: z.enum([
|
|
191
|
+
"auto",
|
|
192
|
+
"byPage",
|
|
193
|
+
"byProperty",
|
|
194
|
+
"byNewsShowcasePanel"
|
|
195
|
+
]).optional(),
|
|
196
|
+
searchType: z.enum([
|
|
197
|
+
"web",
|
|
198
|
+
"image",
|
|
199
|
+
"video",
|
|
200
|
+
"news",
|
|
201
|
+
"discover",
|
|
202
|
+
"googleNews"
|
|
203
|
+
]).optional()
|
|
204
|
+
});
|
|
205
|
+
const analyticsRowData = defineResponseObject({ rows: z.array(z.record(z.string(), z.union([
|
|
206
|
+
z.string(),
|
|
207
|
+
z.number(),
|
|
208
|
+
z.boolean(),
|
|
209
|
+
z.null()
|
|
210
|
+
]))) });
|
|
211
|
+
const analyticsMeta = defineResponseObject({
|
|
212
|
+
requestId: realtimeSchemas.publicRequestId,
|
|
213
|
+
surface: z.literal("analytics"),
|
|
214
|
+
version: z.literal("1.0"),
|
|
215
|
+
sourceName: z.string().min(1),
|
|
216
|
+
sourceKind: z.enum(["row", "sql"]),
|
|
217
|
+
queryMs: z.number().nonnegative()
|
|
218
|
+
});
|
|
174
219
|
return {
|
|
175
|
-
analyticsRowsRequest
|
|
176
|
-
|
|
177
|
-
metrics: z.array(z.enum(metrics)).optional(),
|
|
178
|
-
filter: normalizedFilter.optional(),
|
|
179
|
-
prefilter: normalizedFilter.optional(),
|
|
180
|
-
orderBy: z.strictObject({
|
|
181
|
-
column: z.enum([...metrics, "date"]),
|
|
182
|
-
dir: z.enum(["asc", "desc"])
|
|
183
|
-
}).optional(),
|
|
184
|
-
rowLimit: z.number().int().positive().max(25e3).optional(),
|
|
185
|
-
startRow: z.number().int().nonnegative().optional(),
|
|
186
|
-
dataState: z.enum([
|
|
187
|
-
"final",
|
|
188
|
-
"all",
|
|
189
|
-
"hourly_all"
|
|
190
|
-
]).optional(),
|
|
191
|
-
aggregationType: z.enum([
|
|
192
|
-
"auto",
|
|
193
|
-
"byPage",
|
|
194
|
-
"byProperty",
|
|
195
|
-
"byNewsShowcasePanel"
|
|
196
|
-
]).optional(),
|
|
197
|
-
searchType: z.enum([
|
|
198
|
-
"web",
|
|
199
|
-
"image",
|
|
200
|
-
"video",
|
|
201
|
-
"news",
|
|
202
|
-
"discover",
|
|
203
|
-
"googleNews"
|
|
204
|
-
]).optional()
|
|
205
|
-
}),
|
|
206
|
-
analyticsRowsResponse: defineSuccessResponse(defineResponseObject({ rows: z.array(z.record(z.string(), z.union([
|
|
207
|
-
z.string(),
|
|
208
|
-
z.number(),
|
|
209
|
-
z.boolean(),
|
|
210
|
-
z.null()
|
|
211
|
-
]))) }), defineResponseObject({
|
|
212
|
-
requestId: realtimeSchemas.publicRequestId,
|
|
213
|
-
surface: z.literal("analytics"),
|
|
214
|
-
version: z.literal("1.0"),
|
|
215
|
-
sourceName: z.string().min(1),
|
|
216
|
-
sourceKind: z.enum(["row", "sql"]),
|
|
217
|
-
queryMs: z.number().nonnegative()
|
|
218
|
-
})),
|
|
220
|
+
analyticsRowsRequest,
|
|
221
|
+
analyticsRowsResponse: defineSuccessResponse(analyticsRowData, analyticsMeta),
|
|
219
222
|
keywordEnrichmentRequest,
|
|
220
223
|
keywordEnrichmentResponse,
|
|
221
224
|
lifecycleResponse,
|
package/dist/v1/http.d.mts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
import { GSCDUMP_HTTP_V1_VERSION } from "./version.mjs";
|
|
2
2
|
import { CompatibleResponseSchema, HTTP_V1_CREDENTIALS, HTTP_V1_CREDENTIAL_SCOPES, HTTP_V1_ERROR_CODES, HTTP_V1_METHODS, HTTP_V1_SCOPES, HTTP_V1_SURFACES, HttpV1Credential, HttpV1ErrorCode, HttpV1Method, HttpV1OperationDefinition, HttpV1OperationEntry, HttpV1OperationRequest, HttpV1OwnershipRule, HttpV1ProtocolLike, HttpV1ProtocolOperation, HttpV1RequestSchemas, HttpV1ResourceReference, HttpV1ResourceType, HttpV1Scope, HttpV1Semantics, HttpV1Surface, HttpV1SurfaceName, HttpV1Visibility, ResolvedHttpV1Operation, buildHttpOperationPath, defineHttpOperation, defineHttpSurface, defineResponseObject, defineSuccessResponse, listHttpOperations, resolveHttpOperation } from "./http-core.mjs";
|
|
3
|
-
import { AnalyticsReportDetailV1Request, AnalyticsReportDetailV1Response, AnalyticsReportV1Request, AnalyticsReportV1Response, AnalyticsRowsV1Request, AnalyticsRowsV1Response, GscdumpV1ErrorEnvelope, GscdumpV1Operation, GscdumpV1OperationId, GscdumpV1Protocol, GscdumpV1RequestMetadata, PartnerAnalysisBundleV1Response, PartnerAnalysisV1Response, PartnerAvailableSitesV1Response, PartnerIndexingDiagnosticsV1Response, PartnerIndexingTransitionsV1Response, PartnerIndexingUrlsV1Response, PartnerIndexingV1Response, PartnerSiteDeletionV1Response, PartnerSiteRegistrationV1Response, PartnerSitemapChangesV1Response, PartnerSitemapsV1Response, PartnerUserLifecycleV1Response, createGscdumpV1Protocol } from "./operations.mjs";
|
|
4
|
-
export { AnalyticsReportDetailV1Request, AnalyticsReportDetailV1Response, AnalyticsReportV1Request, AnalyticsReportV1Response, AnalyticsRowsV1Request, AnalyticsRowsV1Response, CompatibleResponseSchema, GSCDUMP_HTTP_V1_VERSION, GscdumpV1ErrorEnvelope, GscdumpV1Operation, GscdumpV1OperationId, GscdumpV1Protocol, GscdumpV1RequestMetadata, HTTP_V1_CREDENTIALS, HTTP_V1_CREDENTIAL_SCOPES, HTTP_V1_ERROR_CODES, HTTP_V1_METHODS, HTTP_V1_SCOPES, HTTP_V1_SURFACES, HttpV1Credential, HttpV1ErrorCode, HttpV1Method, HttpV1OperationDefinition, HttpV1OperationEntry, HttpV1OperationRequest, HttpV1OwnershipRule, HttpV1ProtocolLike, HttpV1ProtocolOperation, HttpV1RequestSchemas, HttpV1ResourceReference, HttpV1ResourceType, HttpV1Scope, HttpV1Semantics, HttpV1Surface, HttpV1SurfaceName, HttpV1Visibility, PartnerAnalysisBundleV1Response, PartnerAnalysisV1Response, PartnerAvailableSitesV1Response, PartnerIndexingDiagnosticsV1Response, PartnerIndexingTransitionsV1Response, PartnerIndexingUrlsV1Response, PartnerIndexingV1Response, PartnerSiteDeletionV1Response, PartnerSiteRegistrationV1Response, PartnerSitemapChangesV1Response, PartnerSitemapsV1Response, PartnerUserLifecycleV1Response, ResolvedHttpV1Operation, buildHttpOperationPath, createGscdumpV1Protocol, defineHttpOperation, defineHttpSurface, defineResponseObject, defineSuccessResponse, listHttpOperations, resolveHttpOperation };
|
|
3
|
+
import { AnalyticsReportDetailV1Request, AnalyticsReportDetailV1Response, AnalyticsReportV1Request, AnalyticsReportV1Response, AnalyticsRowsV1Request, AnalyticsRowsV1Response, GscdumpV1ErrorEnvelope, GscdumpV1Operation, GscdumpV1OperationId, GscdumpV1Protocol, GscdumpV1RequestMetadata, PartnerAnalysisBundleV1Response, PartnerAnalysisV1Response, PartnerAvailableSitesV1Response, PartnerBingIndexingEvidenceV1Response, PartnerIndexingDiagnosticsV1Response, PartnerIndexingTransitionsV1Response, PartnerIndexingUrlsV1Response, PartnerIndexingV1Response, PartnerSiteDeletionV1Response, PartnerSiteRegistrationV1Response, PartnerSitemapChangesV1Response, PartnerSitemapsV1Response, PartnerUserLifecycleV1Response, createGscdumpV1Protocol } from "./operations.mjs";
|
|
4
|
+
export { AnalyticsReportDetailV1Request, AnalyticsReportDetailV1Response, AnalyticsReportV1Request, AnalyticsReportV1Response, AnalyticsRowsV1Request, AnalyticsRowsV1Response, CompatibleResponseSchema, GSCDUMP_HTTP_V1_VERSION, GscdumpV1ErrorEnvelope, GscdumpV1Operation, GscdumpV1OperationId, GscdumpV1Protocol, GscdumpV1RequestMetadata, HTTP_V1_CREDENTIALS, HTTP_V1_CREDENTIAL_SCOPES, HTTP_V1_ERROR_CODES, HTTP_V1_METHODS, HTTP_V1_SCOPES, HTTP_V1_SURFACES, HttpV1Credential, HttpV1ErrorCode, HttpV1Method, HttpV1OperationDefinition, HttpV1OperationEntry, HttpV1OperationRequest, HttpV1OwnershipRule, HttpV1ProtocolLike, HttpV1ProtocolOperation, HttpV1RequestSchemas, HttpV1ResourceReference, HttpV1ResourceType, HttpV1Scope, HttpV1Semantics, HttpV1Surface, HttpV1SurfaceName, HttpV1Visibility, PartnerAnalysisBundleV1Response, PartnerAnalysisV1Response, PartnerAvailableSitesV1Response, PartnerBingIndexingEvidenceV1Response, PartnerIndexingDiagnosticsV1Response, PartnerIndexingTransitionsV1Response, PartnerIndexingUrlsV1Response, PartnerIndexingV1Response, PartnerSiteDeletionV1Response, PartnerSiteRegistrationV1Response, PartnerSitemapChangesV1Response, PartnerSitemapsV1Response, PartnerUserLifecycleV1Response, ResolvedHttpV1Operation, buildHttpOperationPath, createGscdumpV1Protocol, defineHttpOperation, defineHttpSurface, defineResponseObject, defineSuccessResponse, listHttpOperations, resolveHttpOperation };
|
package/dist/v1/index.d.mts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { GSCDUMP_HTTP_V1_VERSION } from "./version.mjs";
|
|
2
2
|
import { CompatibleResponseSchema, HTTP_V1_CREDENTIALS, HTTP_V1_CREDENTIAL_SCOPES, HTTP_V1_ERROR_CODES, HTTP_V1_METHODS, HTTP_V1_SCOPES, HTTP_V1_SURFACES, HttpV1Credential, HttpV1ErrorCode, HttpV1Method, HttpV1OperationDefinition, HttpV1OperationEntry, HttpV1OperationRequest, HttpV1OwnershipRule, HttpV1ProtocolLike, HttpV1ProtocolOperation, HttpV1RequestSchemas, HttpV1ResourceReference, HttpV1ResourceType, HttpV1Scope, HttpV1Semantics, HttpV1Surface, HttpV1SurfaceName, HttpV1Visibility, ResolvedHttpV1Operation, buildHttpOperationPath, defineHttpOperation, defineHttpSurface, defineResponseObject, defineSuccessResponse, listHttpOperations, resolveHttpOperation } from "./http-core.mjs";
|
|
3
3
|
import { GSCDUMP_REALTIME_ACK_POLICY, GSCDUMP_REALTIME_CLOSE_CODES, GSCDUMP_REALTIME_CONNECTION_POLICY, GSCDUMP_REALTIME_LIMITS, GSCDUMP_REALTIME_MAX_CONNECTION_SECONDS, GSCDUMP_REALTIME_PING, GSCDUMP_REALTIME_PONG, GSCDUMP_REALTIME_PROTOCOL_VERSION, GSCDUMP_REALTIME_REPLAY_POLICY, GSCDUMP_REALTIME_SUBPROTOCOL, GSCDUMP_REALTIME_TICKET_AUDIENCE, GSCDUMP_REALTIME_TICKET_ISSUER, GSCDUMP_REALTIME_TICKET_POLICY, GSCDUMP_REALTIME_TICKET_PREFIX, GSCDUMP_REALTIME_TICKET_TTL_SECONDS, REALTIME_V1_EVENT_NAMES, REALTIME_V1_EVENT_SEMANTICS, REALTIME_V1_RESOURCE_TYPES, RealtimeTicketV1Response, RealtimeV1ClientFrame, RealtimeV1Cursor, RealtimeV1Event, RealtimeV1ResourceChange, RealtimeV1Schemas, RealtimeV1ServerFrame, RealtimeV1StreamHead, RealtimeV1StreamId, RealtimeV1TicketClaims, RealtimeV1TicketRequest, createRealtimeV1Schemas } from "./realtime.mjs";
|
|
4
|
-
import { AnalyticsReportDetailV1Request, AnalyticsReportDetailV1Response, AnalyticsReportV1Request, AnalyticsReportV1Response, AnalyticsRowsV1Request, AnalyticsRowsV1Response, GscdumpV1ErrorEnvelope, GscdumpV1Operation, GscdumpV1OperationId, GscdumpV1Protocol, GscdumpV1RequestMetadata, PartnerAnalysisBundleV1Response, PartnerAnalysisV1Response, PartnerAvailableSitesV1Response, PartnerIndexingDiagnosticsV1Response, PartnerIndexingTransitionsV1Response, PartnerIndexingUrlsV1Response, PartnerIndexingV1Response, PartnerSiteDeletionV1Response, PartnerSiteRegistrationV1Response, PartnerSitemapChangesV1Response, PartnerSitemapsV1Response, PartnerUserLifecycleV1Response, createGscdumpV1Protocol } from "./operations.mjs";
|
|
4
|
+
import { AnalyticsReportDetailV1Request, AnalyticsReportDetailV1Response, AnalyticsReportV1Request, AnalyticsReportV1Response, AnalyticsRowsV1Request, AnalyticsRowsV1Response, GscdumpV1ErrorEnvelope, GscdumpV1Operation, GscdumpV1OperationId, GscdumpV1Protocol, GscdumpV1RequestMetadata, PartnerAnalysisBundleV1Response, PartnerAnalysisV1Response, PartnerAvailableSitesV1Response, PartnerBingIndexingEvidenceV1Response, PartnerIndexingDiagnosticsV1Response, PartnerIndexingTransitionsV1Response, PartnerIndexingUrlsV1Response, PartnerIndexingV1Response, PartnerSiteDeletionV1Response, PartnerSiteRegistrationV1Response, PartnerSitemapChangesV1Response, PartnerSitemapsV1Response, PartnerUserLifecycleV1Response, createGscdumpV1Protocol } from "./operations.mjs";
|
|
5
5
|
import "./http.mjs";
|
|
6
6
|
import { ContractDocument, createGscdumpV1Documents, serializeContractDocument } from "./documents.mjs";
|
|
7
|
-
export { AnalyticsReportDetailV1Request, AnalyticsReportDetailV1Response, AnalyticsReportV1Request, AnalyticsReportV1Response, AnalyticsRowsV1Request, AnalyticsRowsV1Response, CompatibleResponseSchema, ContractDocument, GSCDUMP_HTTP_V1_VERSION, GSCDUMP_REALTIME_ACK_POLICY, GSCDUMP_REALTIME_CLOSE_CODES, GSCDUMP_REALTIME_CONNECTION_POLICY, GSCDUMP_REALTIME_LIMITS, GSCDUMP_REALTIME_MAX_CONNECTION_SECONDS, GSCDUMP_REALTIME_PING, GSCDUMP_REALTIME_PONG, GSCDUMP_REALTIME_PROTOCOL_VERSION, GSCDUMP_REALTIME_REPLAY_POLICY, GSCDUMP_REALTIME_SUBPROTOCOL, GSCDUMP_REALTIME_TICKET_AUDIENCE, GSCDUMP_REALTIME_TICKET_ISSUER, GSCDUMP_REALTIME_TICKET_POLICY, GSCDUMP_REALTIME_TICKET_PREFIX, GSCDUMP_REALTIME_TICKET_TTL_SECONDS, GscdumpV1ErrorEnvelope, GscdumpV1Operation, GscdumpV1OperationId, GscdumpV1Protocol, GscdumpV1RequestMetadata, HTTP_V1_CREDENTIALS, HTTP_V1_CREDENTIAL_SCOPES, HTTP_V1_ERROR_CODES, HTTP_V1_METHODS, HTTP_V1_SCOPES, HTTP_V1_SURFACES, HttpV1Credential, HttpV1ErrorCode, HttpV1Method, HttpV1OperationDefinition, HttpV1OperationEntry, HttpV1OperationRequest, HttpV1OwnershipRule, HttpV1ProtocolLike, HttpV1ProtocolOperation, HttpV1RequestSchemas, HttpV1ResourceReference, HttpV1ResourceType, HttpV1Scope, HttpV1Semantics, HttpV1Surface, HttpV1SurfaceName, HttpV1Visibility, PartnerAnalysisBundleV1Response, PartnerAnalysisV1Response, PartnerAvailableSitesV1Response, PartnerIndexingDiagnosticsV1Response, PartnerIndexingTransitionsV1Response, PartnerIndexingUrlsV1Response, PartnerIndexingV1Response, PartnerSiteDeletionV1Response, PartnerSiteRegistrationV1Response, PartnerSitemapChangesV1Response, PartnerSitemapsV1Response, PartnerUserLifecycleV1Response, REALTIME_V1_EVENT_NAMES, REALTIME_V1_EVENT_SEMANTICS, REALTIME_V1_RESOURCE_TYPES, RealtimeTicketV1Response, RealtimeV1ClientFrame, RealtimeV1Cursor, RealtimeV1Event, RealtimeV1ResourceChange, RealtimeV1Schemas, RealtimeV1ServerFrame, RealtimeV1StreamHead, RealtimeV1StreamId, RealtimeV1TicketClaims, RealtimeV1TicketRequest, ResolvedHttpV1Operation, buildHttpOperationPath, createGscdumpV1Documents, createGscdumpV1Protocol, createRealtimeV1Schemas, defineHttpOperation, defineHttpSurface, defineResponseObject, defineSuccessResponse, listHttpOperations, resolveHttpOperation, serializeContractDocument };
|
|
7
|
+
export { AnalyticsReportDetailV1Request, AnalyticsReportDetailV1Response, AnalyticsReportV1Request, AnalyticsReportV1Response, AnalyticsRowsV1Request, AnalyticsRowsV1Response, CompatibleResponseSchema, ContractDocument, GSCDUMP_HTTP_V1_VERSION, GSCDUMP_REALTIME_ACK_POLICY, GSCDUMP_REALTIME_CLOSE_CODES, GSCDUMP_REALTIME_CONNECTION_POLICY, GSCDUMP_REALTIME_LIMITS, GSCDUMP_REALTIME_MAX_CONNECTION_SECONDS, GSCDUMP_REALTIME_PING, GSCDUMP_REALTIME_PONG, GSCDUMP_REALTIME_PROTOCOL_VERSION, GSCDUMP_REALTIME_REPLAY_POLICY, GSCDUMP_REALTIME_SUBPROTOCOL, GSCDUMP_REALTIME_TICKET_AUDIENCE, GSCDUMP_REALTIME_TICKET_ISSUER, GSCDUMP_REALTIME_TICKET_POLICY, GSCDUMP_REALTIME_TICKET_PREFIX, GSCDUMP_REALTIME_TICKET_TTL_SECONDS, GscdumpV1ErrorEnvelope, GscdumpV1Operation, GscdumpV1OperationId, GscdumpV1Protocol, GscdumpV1RequestMetadata, HTTP_V1_CREDENTIALS, HTTP_V1_CREDENTIAL_SCOPES, HTTP_V1_ERROR_CODES, HTTP_V1_METHODS, HTTP_V1_SCOPES, HTTP_V1_SURFACES, HttpV1Credential, HttpV1ErrorCode, HttpV1Method, HttpV1OperationDefinition, HttpV1OperationEntry, HttpV1OperationRequest, HttpV1OwnershipRule, HttpV1ProtocolLike, HttpV1ProtocolOperation, HttpV1RequestSchemas, HttpV1ResourceReference, HttpV1ResourceType, HttpV1Scope, HttpV1Semantics, HttpV1Surface, HttpV1SurfaceName, HttpV1Visibility, PartnerAnalysisBundleV1Response, PartnerAnalysisV1Response, PartnerAvailableSitesV1Response, PartnerBingIndexingEvidenceV1Response, PartnerIndexingDiagnosticsV1Response, PartnerIndexingTransitionsV1Response, PartnerIndexingUrlsV1Response, PartnerIndexingV1Response, PartnerSiteDeletionV1Response, PartnerSiteRegistrationV1Response, PartnerSitemapChangesV1Response, PartnerSitemapsV1Response, PartnerUserLifecycleV1Response, REALTIME_V1_EVENT_NAMES, REALTIME_V1_EVENT_SEMANTICS, REALTIME_V1_RESOURCE_TYPES, RealtimeTicketV1Response, RealtimeV1ClientFrame, RealtimeV1Cursor, RealtimeV1Event, RealtimeV1ResourceChange, RealtimeV1Schemas, RealtimeV1ServerFrame, RealtimeV1StreamHead, RealtimeV1StreamId, RealtimeV1TicketClaims, RealtimeV1TicketRequest, ResolvedHttpV1Operation, buildHttpOperationPath, createGscdumpV1Documents, createGscdumpV1Protocol, createRealtimeV1Schemas, defineHttpOperation, defineHttpSurface, defineResponseObject, defineSuccessResponse, listHttpOperations, resolveHttpOperation, serializeContractDocument };
|
package/dist/v1/operations.d.mts
CHANGED
|
@@ -1841,6 +1841,125 @@ declare function createGscdumpV1Protocol(): {
|
|
|
1841
1841
|
readonly version: z.ZodLiteral<"1.0">;
|
|
1842
1842
|
}, z.core.$strip>;
|
|
1843
1843
|
}, z.core.$strip>>;
|
|
1844
|
+
bingIndexingEvidenceQuery: z.ZodObject<{
|
|
1845
|
+
limit: z.ZodOptional<z.ZodType<string | number, unknown, z.core.$ZodTypeInternals<string | number, unknown>>>;
|
|
1846
|
+
offset: z.ZodOptional<z.ZodType<string | number, unknown, z.core.$ZodTypeInternals<string | number, unknown>>>;
|
|
1847
|
+
}, z.core.$strict>;
|
|
1848
|
+
bingIndexingEvidenceResponse: CompatibleResponseSchema<z.ZodObject<{
|
|
1849
|
+
data: z.ZodObject<{
|
|
1850
|
+
readonly searchEngine: z.ZodLiteral<"bing">;
|
|
1851
|
+
readonly siteUrl: z.ZodURL;
|
|
1852
|
+
readonly indexingEvidence: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
1853
|
+
readonly _tag: z.ZodLiteral<"observed">;
|
|
1854
|
+
readonly searchEngine: z.ZodLiteral<"bing">;
|
|
1855
|
+
readonly url: z.ZodURL;
|
|
1856
|
+
readonly observedAt: z.ZodISODateTime;
|
|
1857
|
+
readonly providerEvidenceAt: z.ZodISODateTime;
|
|
1858
|
+
readonly freshness: z.ZodEnum<{
|
|
1859
|
+
current: "current";
|
|
1860
|
+
stale: "stale";
|
|
1861
|
+
}>;
|
|
1862
|
+
readonly discoveryTime: z.ZodNullable<z.ZodISODateTime>;
|
|
1863
|
+
readonly lastCrawlTime: z.ZodNullable<z.ZodISODateTime>;
|
|
1864
|
+
readonly originHttpStatus: z.ZodNullable<z.ZodNumber>;
|
|
1865
|
+
readonly documentSize: z.ZodNumber;
|
|
1866
|
+
readonly anchorCount: z.ZodNumber;
|
|
1867
|
+
readonly totalChildUrlCount: z.ZodNumber;
|
|
1868
|
+
readonly uncertaintyReason: z.ZodLiteral<"indexed-verdict-unavailable">;
|
|
1869
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
1870
|
+
readonly _tag: z.ZodLiteral<"unknown">;
|
|
1871
|
+
readonly searchEngine: z.ZodLiteral<"bing">;
|
|
1872
|
+
readonly url: z.ZodURL;
|
|
1873
|
+
readonly observedAt: z.ZodISODateTime;
|
|
1874
|
+
readonly reason: z.ZodEnum<{
|
|
1875
|
+
"not-discovered": "not-discovered";
|
|
1876
|
+
"not-observed": "not-observed";
|
|
1877
|
+
}>;
|
|
1878
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
1879
|
+
readonly _tag: z.ZodLiteral<"unavailable">;
|
|
1880
|
+
readonly searchEngine: z.ZodLiteral<"bing">;
|
|
1881
|
+
readonly url: z.ZodURL;
|
|
1882
|
+
readonly observedAt: z.ZodISODateTime;
|
|
1883
|
+
readonly reason: z.ZodEnum<{
|
|
1884
|
+
"authentication-required": "authentication-required";
|
|
1885
|
+
"permission-denied": "permission-denied";
|
|
1886
|
+
"site-unverified": "site-unverified";
|
|
1887
|
+
throttled: "throttled";
|
|
1888
|
+
"quota-unavailable": "quota-unavailable";
|
|
1889
|
+
"provider-error": "provider-error";
|
|
1890
|
+
}>;
|
|
1891
|
+
readonly retryAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1892
|
+
}, z.core.$strip>], "_tag">>;
|
|
1893
|
+
readonly pagination: z.ZodObject<{
|
|
1894
|
+
readonly total: z.ZodNumber;
|
|
1895
|
+
readonly limit: z.ZodNumber;
|
|
1896
|
+
readonly offset: z.ZodNumber;
|
|
1897
|
+
readonly hasMore: z.ZodBoolean;
|
|
1898
|
+
}, z.core.$strip>;
|
|
1899
|
+
}, z.core.$strip>;
|
|
1900
|
+
meta: z.ZodObject<{
|
|
1901
|
+
readonly requestId: z.ZodString;
|
|
1902
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
1903
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
1904
|
+
}, z.core.$strip>;
|
|
1905
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
1906
|
+
data: z.ZodObject<{
|
|
1907
|
+
readonly searchEngine: z.ZodLiteral<"bing">;
|
|
1908
|
+
readonly siteUrl: z.ZodURL;
|
|
1909
|
+
readonly indexingEvidence: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
1910
|
+
readonly _tag: z.ZodLiteral<"observed">;
|
|
1911
|
+
readonly searchEngine: z.ZodLiteral<"bing">;
|
|
1912
|
+
readonly url: z.ZodURL;
|
|
1913
|
+
readonly observedAt: z.ZodISODateTime;
|
|
1914
|
+
readonly providerEvidenceAt: z.ZodISODateTime;
|
|
1915
|
+
readonly freshness: z.ZodEnum<{
|
|
1916
|
+
current: "current";
|
|
1917
|
+
stale: "stale";
|
|
1918
|
+
}>;
|
|
1919
|
+
readonly discoveryTime: z.ZodNullable<z.ZodISODateTime>;
|
|
1920
|
+
readonly lastCrawlTime: z.ZodNullable<z.ZodISODateTime>;
|
|
1921
|
+
readonly originHttpStatus: z.ZodNullable<z.ZodNumber>;
|
|
1922
|
+
readonly documentSize: z.ZodNumber;
|
|
1923
|
+
readonly anchorCount: z.ZodNumber;
|
|
1924
|
+
readonly totalChildUrlCount: z.ZodNumber;
|
|
1925
|
+
readonly uncertaintyReason: z.ZodLiteral<"indexed-verdict-unavailable">;
|
|
1926
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
1927
|
+
readonly _tag: z.ZodLiteral<"unknown">;
|
|
1928
|
+
readonly searchEngine: z.ZodLiteral<"bing">;
|
|
1929
|
+
readonly url: z.ZodURL;
|
|
1930
|
+
readonly observedAt: z.ZodISODateTime;
|
|
1931
|
+
readonly reason: z.ZodEnum<{
|
|
1932
|
+
"not-discovered": "not-discovered";
|
|
1933
|
+
"not-observed": "not-observed";
|
|
1934
|
+
}>;
|
|
1935
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
1936
|
+
readonly _tag: z.ZodLiteral<"unavailable">;
|
|
1937
|
+
readonly searchEngine: z.ZodLiteral<"bing">;
|
|
1938
|
+
readonly url: z.ZodURL;
|
|
1939
|
+
readonly observedAt: z.ZodISODateTime;
|
|
1940
|
+
readonly reason: z.ZodEnum<{
|
|
1941
|
+
"authentication-required": "authentication-required";
|
|
1942
|
+
"permission-denied": "permission-denied";
|
|
1943
|
+
"site-unverified": "site-unverified";
|
|
1944
|
+
throttled: "throttled";
|
|
1945
|
+
"quota-unavailable": "quota-unavailable";
|
|
1946
|
+
"provider-error": "provider-error";
|
|
1947
|
+
}>;
|
|
1948
|
+
readonly retryAt: z.ZodNullable<z.ZodISODateTime>;
|
|
1949
|
+
}, z.core.$strip>], "_tag">>;
|
|
1950
|
+
readonly pagination: z.ZodObject<{
|
|
1951
|
+
readonly total: z.ZodNumber;
|
|
1952
|
+
readonly limit: z.ZodNumber;
|
|
1953
|
+
readonly offset: z.ZodNumber;
|
|
1954
|
+
readonly hasMore: z.ZodBoolean;
|
|
1955
|
+
}, z.core.$strip>;
|
|
1956
|
+
}, z.core.$strip>;
|
|
1957
|
+
meta: z.ZodObject<{
|
|
1958
|
+
readonly requestId: z.ZodString;
|
|
1959
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
1960
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
1961
|
+
}, z.core.$strip>;
|
|
1962
|
+
}, z.core.$strip>>;
|
|
1844
1963
|
lifecycleResponse: CompatibleResponseSchema<z.ZodObject<{
|
|
1845
1964
|
data: z.ZodObject<{
|
|
1846
1965
|
readonly userId: z.ZodString;
|
|
@@ -1975,7 +2094,7 @@ declare function createGscdumpV1Protocol(): {
|
|
|
1975
2094
|
readonly code: z.ZodEnum<{
|
|
1976
2095
|
missing_refresh_token: "missing_refresh_token";
|
|
1977
2096
|
missing_analytics_scope: "missing_analytics_scope";
|
|
1978
|
-
|
|
2097
|
+
missing_gsc_read_scope: "missing_gsc_read_scope";
|
|
1979
2098
|
token_refresh_failed: "token_refresh_failed";
|
|
1980
2099
|
permission_lost: "permission_lost";
|
|
1981
2100
|
insufficient_gsc_permission: "insufficient_gsc_permission";
|
|
@@ -2131,7 +2250,7 @@ declare function createGscdumpV1Protocol(): {
|
|
|
2131
2250
|
readonly code: z.ZodEnum<{
|
|
2132
2251
|
missing_refresh_token: "missing_refresh_token";
|
|
2133
2252
|
missing_analytics_scope: "missing_analytics_scope";
|
|
2134
|
-
|
|
2253
|
+
missing_gsc_read_scope: "missing_gsc_read_scope";
|
|
2135
2254
|
token_refresh_failed: "token_refresh_failed";
|
|
2136
2255
|
permission_lost: "permission_lost";
|
|
2137
2256
|
insufficient_gsc_permission: "insufficient_gsc_permission";
|
|
@@ -2483,7 +2602,7 @@ declare function createGscdumpV1Protocol(): {
|
|
|
2483
2602
|
existing: z.ZodOptional<z.ZodBoolean>;
|
|
2484
2603
|
indexingEligible: z.ZodOptional<z.ZodBoolean>;
|
|
2485
2604
|
indexingIneligibleReason: z.ZodOptional<z.ZodEnum<{
|
|
2486
|
-
|
|
2605
|
+
missing_gsc_read_scope: "missing_gsc_read_scope";
|
|
2487
2606
|
insufficient_gsc_permission: "insufficient_gsc_permission";
|
|
2488
2607
|
free_plan: "free_plan";
|
|
2489
2608
|
}>>;
|
|
@@ -2601,7 +2720,7 @@ declare function createGscdumpV1Protocol(): {
|
|
|
2601
2720
|
code: z.ZodEnum<{
|
|
2602
2721
|
missing_refresh_token: "missing_refresh_token";
|
|
2603
2722
|
missing_analytics_scope: "missing_analytics_scope";
|
|
2604
|
-
|
|
2723
|
+
missing_gsc_read_scope: "missing_gsc_read_scope";
|
|
2605
2724
|
token_refresh_failed: "token_refresh_failed";
|
|
2606
2725
|
permission_lost: "permission_lost";
|
|
2607
2726
|
insufficient_gsc_permission: "insufficient_gsc_permission";
|
|
@@ -2640,7 +2759,7 @@ declare function createGscdumpV1Protocol(): {
|
|
|
2640
2759
|
existing: z.ZodOptional<z.ZodBoolean>;
|
|
2641
2760
|
indexingEligible: z.ZodOptional<z.ZodBoolean>;
|
|
2642
2761
|
indexingIneligibleReason: z.ZodOptional<z.ZodEnum<{
|
|
2643
|
-
|
|
2762
|
+
missing_gsc_read_scope: "missing_gsc_read_scope";
|
|
2644
2763
|
insufficient_gsc_permission: "insufficient_gsc_permission";
|
|
2645
2764
|
free_plan: "free_plan";
|
|
2646
2765
|
}>>;
|
|
@@ -2758,7 +2877,7 @@ declare function createGscdumpV1Protocol(): {
|
|
|
2758
2877
|
code: z.ZodEnum<{
|
|
2759
2878
|
missing_refresh_token: "missing_refresh_token";
|
|
2760
2879
|
missing_analytics_scope: "missing_analytics_scope";
|
|
2761
|
-
|
|
2880
|
+
missing_gsc_read_scope: "missing_gsc_read_scope";
|
|
2762
2881
|
token_refresh_failed: "token_refresh_failed";
|
|
2763
2882
|
permission_lost: "permission_lost";
|
|
2764
2883
|
insufficient_gsc_permission: "insufficient_gsc_permission";
|
|
@@ -3114,7 +3233,7 @@ declare function createGscdumpV1Protocol(): {
|
|
|
3114
3233
|
readonly code: z.ZodEnum<{
|
|
3115
3234
|
missing_refresh_token: "missing_refresh_token";
|
|
3116
3235
|
missing_analytics_scope: "missing_analytics_scope";
|
|
3117
|
-
|
|
3236
|
+
missing_gsc_read_scope: "missing_gsc_read_scope";
|
|
3118
3237
|
token_refresh_failed: "token_refresh_failed";
|
|
3119
3238
|
permission_lost: "permission_lost";
|
|
3120
3239
|
insufficient_gsc_permission: "insufficient_gsc_permission";
|
|
@@ -3270,7 +3389,7 @@ declare function createGscdumpV1Protocol(): {
|
|
|
3270
3389
|
readonly code: z.ZodEnum<{
|
|
3271
3390
|
missing_refresh_token: "missing_refresh_token";
|
|
3272
3391
|
missing_analytics_scope: "missing_analytics_scope";
|
|
3273
|
-
|
|
3392
|
+
missing_gsc_read_scope: "missing_gsc_read_scope";
|
|
3274
3393
|
token_refresh_failed: "token_refresh_failed";
|
|
3275
3394
|
permission_lost: "permission_lost";
|
|
3276
3395
|
insufficient_gsc_permission: "insufficient_gsc_permission";
|
|
@@ -3616,7 +3735,7 @@ declare function createGscdumpV1Protocol(): {
|
|
|
3616
3735
|
existing: z.ZodOptional<z.ZodBoolean>;
|
|
3617
3736
|
indexingEligible: z.ZodOptional<z.ZodBoolean>;
|
|
3618
3737
|
indexingIneligibleReason: z.ZodOptional<z.ZodEnum<{
|
|
3619
|
-
|
|
3738
|
+
missing_gsc_read_scope: "missing_gsc_read_scope";
|
|
3620
3739
|
insufficient_gsc_permission: "insufficient_gsc_permission";
|
|
3621
3740
|
free_plan: "free_plan";
|
|
3622
3741
|
}>>;
|
|
@@ -3734,7 +3853,7 @@ declare function createGscdumpV1Protocol(): {
|
|
|
3734
3853
|
code: z.ZodEnum<{
|
|
3735
3854
|
missing_refresh_token: "missing_refresh_token";
|
|
3736
3855
|
missing_analytics_scope: "missing_analytics_scope";
|
|
3737
|
-
|
|
3856
|
+
missing_gsc_read_scope: "missing_gsc_read_scope";
|
|
3738
3857
|
token_refresh_failed: "token_refresh_failed";
|
|
3739
3858
|
permission_lost: "permission_lost";
|
|
3740
3859
|
insufficient_gsc_permission: "insufficient_gsc_permission";
|
|
@@ -3773,7 +3892,7 @@ declare function createGscdumpV1Protocol(): {
|
|
|
3773
3892
|
existing: z.ZodOptional<z.ZodBoolean>;
|
|
3774
3893
|
indexingEligible: z.ZodOptional<z.ZodBoolean>;
|
|
3775
3894
|
indexingIneligibleReason: z.ZodOptional<z.ZodEnum<{
|
|
3776
|
-
|
|
3895
|
+
missing_gsc_read_scope: "missing_gsc_read_scope";
|
|
3777
3896
|
insufficient_gsc_permission: "insufficient_gsc_permission";
|
|
3778
3897
|
free_plan: "free_plan";
|
|
3779
3898
|
}>>;
|
|
@@ -3891,7 +4010,7 @@ declare function createGscdumpV1Protocol(): {
|
|
|
3891
4010
|
code: z.ZodEnum<{
|
|
3892
4011
|
missing_refresh_token: "missing_refresh_token";
|
|
3893
4012
|
missing_analytics_scope: "missing_analytics_scope";
|
|
3894
|
-
|
|
4013
|
+
missing_gsc_read_scope: "missing_gsc_read_scope";
|
|
3895
4014
|
token_refresh_failed: "token_refresh_failed";
|
|
3896
4015
|
permission_lost: "permission_lost";
|
|
3897
4016
|
insufficient_gsc_permission: "insufficient_gsc_permission";
|
|
@@ -4820,6 +4939,238 @@ declare function createGscdumpV1Protocol(): {
|
|
|
4820
4939
|
};
|
|
4821
4940
|
};
|
|
4822
4941
|
};
|
|
4942
|
+
readonly listSiteBingIndexingEvidence: {
|
|
4943
|
+
readonly id: "partner.sites.indexing.bing.evidence.list";
|
|
4944
|
+
readonly method: "GET";
|
|
4945
|
+
readonly path: "/sites/{siteId}/indexing/bing/evidence";
|
|
4946
|
+
readonly visibility: "public";
|
|
4947
|
+
readonly semantics: {
|
|
4948
|
+
readonly kind: "query";
|
|
4949
|
+
readonly sideEffects: "none";
|
|
4950
|
+
readonly idempotent: true;
|
|
4951
|
+
readonly retry: "idempotent";
|
|
4952
|
+
readonly readConsistency: "primary";
|
|
4953
|
+
};
|
|
4954
|
+
readonly auth: {
|
|
4955
|
+
readonly credentials: readonly ["user_key", "partner_key"];
|
|
4956
|
+
readonly scopes: readonly ["indexing:read"];
|
|
4957
|
+
readonly ownership: readonly [{
|
|
4958
|
+
readonly credential: "user_key";
|
|
4959
|
+
readonly rule: "authorized_site";
|
|
4960
|
+
}, {
|
|
4961
|
+
readonly credential: "partner_key";
|
|
4962
|
+
readonly rule: "authorized_site";
|
|
4963
|
+
}];
|
|
4964
|
+
};
|
|
4965
|
+
readonly request: {
|
|
4966
|
+
readonly params: z.ZodObject<{
|
|
4967
|
+
siteId: z.ZodString;
|
|
4968
|
+
}, z.core.$strict>;
|
|
4969
|
+
readonly query: z.ZodObject<{
|
|
4970
|
+
limit: z.ZodOptional<z.ZodType<string | number, unknown, z.core.$ZodTypeInternals<string | number, unknown>>>;
|
|
4971
|
+
offset: z.ZodOptional<z.ZodType<string | number, unknown, z.core.$ZodTypeInternals<string | number, unknown>>>;
|
|
4972
|
+
}, z.core.$strict>;
|
|
4973
|
+
readonly headers: z.ZodObject<{
|
|
4974
|
+
'x-request-id': z.ZodOptional<z.ZodString>;
|
|
4975
|
+
}, z.core.$strict>;
|
|
4976
|
+
readonly body: null;
|
|
4977
|
+
};
|
|
4978
|
+
readonly responses: {
|
|
4979
|
+
readonly 200: CompatibleResponseSchema<z.ZodObject<{
|
|
4980
|
+
data: z.ZodObject<{
|
|
4981
|
+
readonly searchEngine: z.ZodLiteral<"bing">;
|
|
4982
|
+
readonly siteUrl: z.ZodURL;
|
|
4983
|
+
readonly indexingEvidence: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
4984
|
+
readonly _tag: z.ZodLiteral<"observed">;
|
|
4985
|
+
readonly searchEngine: z.ZodLiteral<"bing">;
|
|
4986
|
+
readonly url: z.ZodURL;
|
|
4987
|
+
readonly observedAt: z.ZodISODateTime;
|
|
4988
|
+
readonly providerEvidenceAt: z.ZodISODateTime;
|
|
4989
|
+
readonly freshness: z.ZodEnum<{
|
|
4990
|
+
current: "current";
|
|
4991
|
+
stale: "stale";
|
|
4992
|
+
}>;
|
|
4993
|
+
readonly discoveryTime: z.ZodNullable<z.ZodISODateTime>;
|
|
4994
|
+
readonly lastCrawlTime: z.ZodNullable<z.ZodISODateTime>;
|
|
4995
|
+
readonly originHttpStatus: z.ZodNullable<z.ZodNumber>;
|
|
4996
|
+
readonly documentSize: z.ZodNumber;
|
|
4997
|
+
readonly anchorCount: z.ZodNumber;
|
|
4998
|
+
readonly totalChildUrlCount: z.ZodNumber;
|
|
4999
|
+
readonly uncertaintyReason: z.ZodLiteral<"indexed-verdict-unavailable">;
|
|
5000
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
5001
|
+
readonly _tag: z.ZodLiteral<"unknown">;
|
|
5002
|
+
readonly searchEngine: z.ZodLiteral<"bing">;
|
|
5003
|
+
readonly url: z.ZodURL;
|
|
5004
|
+
readonly observedAt: z.ZodISODateTime;
|
|
5005
|
+
readonly reason: z.ZodEnum<{
|
|
5006
|
+
"not-discovered": "not-discovered";
|
|
5007
|
+
"not-observed": "not-observed";
|
|
5008
|
+
}>;
|
|
5009
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
5010
|
+
readonly _tag: z.ZodLiteral<"unavailable">;
|
|
5011
|
+
readonly searchEngine: z.ZodLiteral<"bing">;
|
|
5012
|
+
readonly url: z.ZodURL;
|
|
5013
|
+
readonly observedAt: z.ZodISODateTime;
|
|
5014
|
+
readonly reason: z.ZodEnum<{
|
|
5015
|
+
"authentication-required": "authentication-required";
|
|
5016
|
+
"permission-denied": "permission-denied";
|
|
5017
|
+
"site-unverified": "site-unverified";
|
|
5018
|
+
throttled: "throttled";
|
|
5019
|
+
"quota-unavailable": "quota-unavailable";
|
|
5020
|
+
"provider-error": "provider-error";
|
|
5021
|
+
}>;
|
|
5022
|
+
readonly retryAt: z.ZodNullable<z.ZodISODateTime>;
|
|
5023
|
+
}, z.core.$strip>], "_tag">>;
|
|
5024
|
+
readonly pagination: z.ZodObject<{
|
|
5025
|
+
readonly total: z.ZodNumber;
|
|
5026
|
+
readonly limit: z.ZodNumber;
|
|
5027
|
+
readonly offset: z.ZodNumber;
|
|
5028
|
+
readonly hasMore: z.ZodBoolean;
|
|
5029
|
+
}, z.core.$strip>;
|
|
5030
|
+
}, z.core.$strip>;
|
|
5031
|
+
meta: z.ZodObject<{
|
|
5032
|
+
readonly requestId: z.ZodString;
|
|
5033
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
5034
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
5035
|
+
}, z.core.$strip>;
|
|
5036
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
5037
|
+
data: z.ZodObject<{
|
|
5038
|
+
readonly searchEngine: z.ZodLiteral<"bing">;
|
|
5039
|
+
readonly siteUrl: z.ZodURL;
|
|
5040
|
+
readonly indexingEvidence: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
5041
|
+
readonly _tag: z.ZodLiteral<"observed">;
|
|
5042
|
+
readonly searchEngine: z.ZodLiteral<"bing">;
|
|
5043
|
+
readonly url: z.ZodURL;
|
|
5044
|
+
readonly observedAt: z.ZodISODateTime;
|
|
5045
|
+
readonly providerEvidenceAt: z.ZodISODateTime;
|
|
5046
|
+
readonly freshness: z.ZodEnum<{
|
|
5047
|
+
current: "current";
|
|
5048
|
+
stale: "stale";
|
|
5049
|
+
}>;
|
|
5050
|
+
readonly discoveryTime: z.ZodNullable<z.ZodISODateTime>;
|
|
5051
|
+
readonly lastCrawlTime: z.ZodNullable<z.ZodISODateTime>;
|
|
5052
|
+
readonly originHttpStatus: z.ZodNullable<z.ZodNumber>;
|
|
5053
|
+
readonly documentSize: z.ZodNumber;
|
|
5054
|
+
readonly anchorCount: z.ZodNumber;
|
|
5055
|
+
readonly totalChildUrlCount: z.ZodNumber;
|
|
5056
|
+
readonly uncertaintyReason: z.ZodLiteral<"indexed-verdict-unavailable">;
|
|
5057
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
5058
|
+
readonly _tag: z.ZodLiteral<"unknown">;
|
|
5059
|
+
readonly searchEngine: z.ZodLiteral<"bing">;
|
|
5060
|
+
readonly url: z.ZodURL;
|
|
5061
|
+
readonly observedAt: z.ZodISODateTime;
|
|
5062
|
+
readonly reason: z.ZodEnum<{
|
|
5063
|
+
"not-discovered": "not-discovered";
|
|
5064
|
+
"not-observed": "not-observed";
|
|
5065
|
+
}>;
|
|
5066
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
5067
|
+
readonly _tag: z.ZodLiteral<"unavailable">;
|
|
5068
|
+
readonly searchEngine: z.ZodLiteral<"bing">;
|
|
5069
|
+
readonly url: z.ZodURL;
|
|
5070
|
+
readonly observedAt: z.ZodISODateTime;
|
|
5071
|
+
readonly reason: z.ZodEnum<{
|
|
5072
|
+
"authentication-required": "authentication-required";
|
|
5073
|
+
"permission-denied": "permission-denied";
|
|
5074
|
+
"site-unverified": "site-unverified";
|
|
5075
|
+
throttled: "throttled";
|
|
5076
|
+
"quota-unavailable": "quota-unavailable";
|
|
5077
|
+
"provider-error": "provider-error";
|
|
5078
|
+
}>;
|
|
5079
|
+
readonly retryAt: z.ZodNullable<z.ZodISODateTime>;
|
|
5080
|
+
}, z.core.$strip>], "_tag">>;
|
|
5081
|
+
readonly pagination: z.ZodObject<{
|
|
5082
|
+
readonly total: z.ZodNumber;
|
|
5083
|
+
readonly limit: z.ZodNumber;
|
|
5084
|
+
readonly offset: z.ZodNumber;
|
|
5085
|
+
readonly hasMore: z.ZodBoolean;
|
|
5086
|
+
}, z.core.$strip>;
|
|
5087
|
+
}, z.core.$strip>;
|
|
5088
|
+
meta: z.ZodObject<{
|
|
5089
|
+
readonly requestId: z.ZodString;
|
|
5090
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
5091
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
5092
|
+
}, z.core.$strip>;
|
|
5093
|
+
}, z.core.$strip>>;
|
|
5094
|
+
};
|
|
5095
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "forbidden", "site_not_found", "rate_limited", "internal_error", "contract_violation"];
|
|
5096
|
+
readonly errorResponse: CompatibleResponseSchema<z.ZodObject<{
|
|
5097
|
+
readonly error: z.ZodObject<{
|
|
5098
|
+
code: z.ZodEnum<{
|
|
5099
|
+
internal_error: "internal_error";
|
|
5100
|
+
invalid_request: "invalid_request";
|
|
5101
|
+
unauthorized: "unauthorized";
|
|
5102
|
+
forbidden: "forbidden";
|
|
5103
|
+
site_not_found: "site_not_found";
|
|
5104
|
+
rate_limited: "rate_limited";
|
|
5105
|
+
contract_violation: "contract_violation";
|
|
5106
|
+
}>;
|
|
5107
|
+
message: z.ZodString;
|
|
5108
|
+
requestId: z.ZodString;
|
|
5109
|
+
retryable: z.ZodBoolean;
|
|
5110
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
5111
|
+
}, z.core.$strict>;
|
|
5112
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
5113
|
+
readonly error: z.ZodObject<{
|
|
5114
|
+
code: z.ZodEnum<{
|
|
5115
|
+
internal_error: "internal_error";
|
|
5116
|
+
invalid_request: "invalid_request";
|
|
5117
|
+
unauthorized: "unauthorized";
|
|
5118
|
+
forbidden: "forbidden";
|
|
5119
|
+
site_not_found: "site_not_found";
|
|
5120
|
+
rate_limited: "rate_limited";
|
|
5121
|
+
contract_violation: "contract_violation";
|
|
5122
|
+
}>;
|
|
5123
|
+
message: z.ZodString;
|
|
5124
|
+
requestId: z.ZodString;
|
|
5125
|
+
retryable: z.ZodBoolean;
|
|
5126
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
5127
|
+
}, z.core.$loose>;
|
|
5128
|
+
}, z.core.$strip>>;
|
|
5129
|
+
readonly resources: {
|
|
5130
|
+
readonly reads: readonly [{
|
|
5131
|
+
readonly type: "site.indexing";
|
|
5132
|
+
readonly idFrom: "params.siteId";
|
|
5133
|
+
}];
|
|
5134
|
+
readonly changes: readonly [];
|
|
5135
|
+
};
|
|
5136
|
+
readonly lifecycle: {
|
|
5137
|
+
readonly introduced: "1.5.0";
|
|
5138
|
+
};
|
|
5139
|
+
readonly docs: {
|
|
5140
|
+
readonly summary: "List Bing Indexing Evidence";
|
|
5141
|
+
readonly description: "Returns dated Bing discovery and crawl observations. It does not return an indexed verdict.";
|
|
5142
|
+
readonly tags: readonly ["Indexing"];
|
|
5143
|
+
readonly examples: {
|
|
5144
|
+
readonly request: {
|
|
5145
|
+
readonly params: {
|
|
5146
|
+
readonly siteId: "s_01";
|
|
5147
|
+
};
|
|
5148
|
+
readonly query: {
|
|
5149
|
+
readonly limit: 100;
|
|
5150
|
+
readonly offset: 0;
|
|
5151
|
+
};
|
|
5152
|
+
};
|
|
5153
|
+
readonly response: {
|
|
5154
|
+
readonly data: {
|
|
5155
|
+
readonly searchEngine: "bing";
|
|
5156
|
+
readonly siteUrl: "https://example.com/";
|
|
5157
|
+
readonly indexingEvidence: readonly [];
|
|
5158
|
+
readonly pagination: {
|
|
5159
|
+
readonly total: 0;
|
|
5160
|
+
readonly limit: 100;
|
|
5161
|
+
readonly offset: 0;
|
|
5162
|
+
readonly hasMore: false;
|
|
5163
|
+
};
|
|
5164
|
+
};
|
|
5165
|
+
readonly meta: {
|
|
5166
|
+
readonly requestId: "req_01";
|
|
5167
|
+
readonly surface: "partner";
|
|
5168
|
+
readonly version: "1.0";
|
|
5169
|
+
};
|
|
5170
|
+
};
|
|
5171
|
+
};
|
|
5172
|
+
};
|
|
5173
|
+
};
|
|
4823
5174
|
readonly listSiteIndexingTransitions: {
|
|
4824
5175
|
readonly id: "partner.sites.indexing.transitions.list";
|
|
4825
5176
|
readonly method: "GET";
|
|
@@ -12575,6 +12926,7 @@ type PartnerAnalysisBundleV1Response = z.infer<GscdumpV1Protocol['schemas']['ana
|
|
|
12575
12926
|
type PartnerAvailableSitesV1Response = z.infer<GscdumpV1Protocol['schemas']['availableSitesResponse']['client']>;
|
|
12576
12927
|
type PartnerIndexingV1Response = z.infer<GscdumpV1Protocol['schemas']['indexingSummaryResponse']['client']>;
|
|
12577
12928
|
type PartnerIndexingUrlsV1Response = z.infer<GscdumpV1Protocol['schemas']['indexingUrlsResponse']['client']>;
|
|
12929
|
+
type PartnerBingIndexingEvidenceV1Response = z.infer<GscdumpV1Protocol['schemas']['bingIndexingEvidenceResponse']['client']>;
|
|
12578
12930
|
type PartnerIndexingTransitionsV1Response = z.infer<GscdumpV1Protocol['schemas']['indexingTransitionsResponse']['client']>;
|
|
12579
12931
|
type PartnerIndexingDiagnosticsV1Response = z.infer<GscdumpV1Protocol['schemas']['indexingDiagnosticsResponse']['client']>;
|
|
12580
12932
|
type PartnerSitemapsV1Response = z.infer<GscdumpV1Protocol['schemas']['sitemapsResponse']['client']>;
|
|
@@ -12582,4 +12934,4 @@ type PartnerSitemapChangesV1Response = z.infer<GscdumpV1Protocol['schemas']['sit
|
|
|
12582
12934
|
type PartnerSiteRegistrationV1Response = z.infer<GscdumpV1Protocol['schemas']['siteRegistrationResponse']['client']>;
|
|
12583
12935
|
type PartnerSiteDeletionV1Response = z.infer<GscdumpV1Protocol['schemas']['siteDeletionResponse']['client']>;
|
|
12584
12936
|
type PartnerUserLifecycleV1Response = z.infer<GscdumpV1Protocol['schemas']['lifecycleResponse']['client']>;
|
|
12585
|
-
export { AnalyticsReportDetailV1Request, AnalyticsReportDetailV1Response, AnalyticsReportV1Request, AnalyticsReportV1Response, AnalyticsRowsV1Request, AnalyticsRowsV1Response, GscdumpV1ErrorEnvelope, GscdumpV1Operation, GscdumpV1OperationId, GscdumpV1Protocol, GscdumpV1RequestMetadata, PartnerAnalysisBundleV1Response, PartnerAnalysisV1Response, PartnerAvailableSitesV1Response, PartnerIndexingDiagnosticsV1Response, PartnerIndexingTransitionsV1Response, PartnerIndexingUrlsV1Response, PartnerIndexingV1Response, PartnerSiteDeletionV1Response, PartnerSiteRegistrationV1Response, PartnerSitemapChangesV1Response, PartnerSitemapsV1Response, PartnerUserLifecycleV1Response, createGscdumpV1Protocol };
|
|
12937
|
+
export { AnalyticsReportDetailV1Request, AnalyticsReportDetailV1Response, AnalyticsReportV1Request, AnalyticsReportV1Response, AnalyticsRowsV1Request, AnalyticsRowsV1Response, GscdumpV1ErrorEnvelope, GscdumpV1Operation, GscdumpV1OperationId, GscdumpV1Protocol, GscdumpV1RequestMetadata, PartnerAnalysisBundleV1Response, PartnerAnalysisV1Response, PartnerAvailableSitesV1Response, PartnerBingIndexingEvidenceV1Response, PartnerIndexingDiagnosticsV1Response, PartnerIndexingTransitionsV1Response, PartnerIndexingUrlsV1Response, PartnerIndexingV1Response, PartnerSiteDeletionV1Response, PartnerSiteRegistrationV1Response, PartnerSitemapChangesV1Response, PartnerSitemapsV1Response, PartnerUserLifecycleV1Response, createGscdumpV1Protocol };
|
package/dist/v1/operations.mjs
CHANGED
|
@@ -106,6 +106,10 @@ function createGscdumpV1Protocol() {
|
|
|
106
106
|
z.literal("false")
|
|
107
107
|
]).optional()
|
|
108
108
|
});
|
|
109
|
+
const bingIndexingEvidenceQuery = z.strictObject({
|
|
110
|
+
limit: integerQuery(z.number().int().min(1).max(500), /^(?:[1-9]|[1-9]\d|[1-4]\d{2}|500)$/).optional(),
|
|
111
|
+
offset: integerQuery(z.number().int().min(0), /^(?:0|[1-9]\d*)$/).optional()
|
|
112
|
+
});
|
|
109
113
|
const indexingTransitionsQuery = z.strictObject({
|
|
110
114
|
startDate: calendarDate.optional(),
|
|
111
115
|
endDate: calendarDate.optional(),
|
|
@@ -189,6 +193,68 @@ function createGscdumpV1Protocol() {
|
|
|
189
193
|
}).strict();
|
|
190
194
|
const indexingSummaryResponse = defineSuccessResponse(defineResponseObject(gscdumpIndexingResponseSchema.shape), partnerResponseMeta);
|
|
191
195
|
const indexingUrlsResponse = defineSuccessResponse(defineResponseObject(indexingUrlsResponseSchema.shape), partnerResponseMeta);
|
|
196
|
+
const observedBingIndexingEvidence = defineResponseObject({
|
|
197
|
+
_tag: z.literal("observed"),
|
|
198
|
+
searchEngine: z.literal("bing"),
|
|
199
|
+
url: z.url(),
|
|
200
|
+
observedAt: z.iso.datetime(),
|
|
201
|
+
providerEvidenceAt: z.iso.datetime(),
|
|
202
|
+
freshness: z.enum(["current", "stale"]),
|
|
203
|
+
discoveryTime: z.iso.datetime().nullable(),
|
|
204
|
+
lastCrawlTime: z.iso.datetime().nullable(),
|
|
205
|
+
originHttpStatus: z.number().int().min(100).max(599).nullable(),
|
|
206
|
+
documentSize: z.number().int().nonnegative(),
|
|
207
|
+
anchorCount: z.number().int().nonnegative(),
|
|
208
|
+
totalChildUrlCount: z.number().int().nonnegative(),
|
|
209
|
+
uncertaintyReason: z.literal("indexed-verdict-unavailable")
|
|
210
|
+
});
|
|
211
|
+
const unknownBingIndexingEvidence = defineResponseObject({
|
|
212
|
+
_tag: z.literal("unknown"),
|
|
213
|
+
searchEngine: z.literal("bing"),
|
|
214
|
+
url: z.url(),
|
|
215
|
+
observedAt: z.iso.datetime(),
|
|
216
|
+
reason: z.enum(["not-discovered", "not-observed"])
|
|
217
|
+
});
|
|
218
|
+
const unavailableBingIndexingEvidence = defineResponseObject({
|
|
219
|
+
_tag: z.literal("unavailable"),
|
|
220
|
+
searchEngine: z.literal("bing"),
|
|
221
|
+
url: z.url(),
|
|
222
|
+
observedAt: z.iso.datetime(),
|
|
223
|
+
reason: z.enum([
|
|
224
|
+
"authentication-required",
|
|
225
|
+
"permission-denied",
|
|
226
|
+
"site-unverified",
|
|
227
|
+
"throttled",
|
|
228
|
+
"quota-unavailable",
|
|
229
|
+
"provider-error"
|
|
230
|
+
]),
|
|
231
|
+
retryAt: z.iso.datetime().nullable()
|
|
232
|
+
});
|
|
233
|
+
const bingIndexingEvidencePagination = defineResponseObject({
|
|
234
|
+
total: z.number().int().nonnegative(),
|
|
235
|
+
limit: z.number().int().positive(),
|
|
236
|
+
offset: z.number().int().nonnegative(),
|
|
237
|
+
hasMore: z.boolean()
|
|
238
|
+
});
|
|
239
|
+
const bingIndexingEvidenceResponse = defineSuccessResponse(defineResponseObject({
|
|
240
|
+
searchEngine: z.literal("bing"),
|
|
241
|
+
siteUrl: z.url(),
|
|
242
|
+
indexingEvidence: z.array(z.discriminatedUnion("_tag", [
|
|
243
|
+
observedBingIndexingEvidence.producer,
|
|
244
|
+
unknownBingIndexingEvidence.producer,
|
|
245
|
+
unavailableBingIndexingEvidence.producer
|
|
246
|
+
])),
|
|
247
|
+
pagination: bingIndexingEvidencePagination.producer
|
|
248
|
+
}, {
|
|
249
|
+
searchEngine: z.literal("bing"),
|
|
250
|
+
siteUrl: z.url(),
|
|
251
|
+
indexingEvidence: z.array(z.discriminatedUnion("_tag", [
|
|
252
|
+
observedBingIndexingEvidence.client,
|
|
253
|
+
unknownBingIndexingEvidence.client,
|
|
254
|
+
unavailableBingIndexingEvidence.client
|
|
255
|
+
])),
|
|
256
|
+
pagination: bingIndexingEvidencePagination.client
|
|
257
|
+
}), partnerResponseMeta);
|
|
192
258
|
const indexingTransition = defineResponseObject({
|
|
193
259
|
url: z.string(),
|
|
194
260
|
field: gscdumpIndexingTransitionFieldSchema,
|
|
@@ -566,7 +632,8 @@ function createGscdumpV1Protocol() {
|
|
|
566
632
|
streamId: realtimeSchemas.streamId,
|
|
567
633
|
sequence: realtimeSchemas.sequence
|
|
568
634
|
});
|
|
569
|
-
const
|
|
635
|
+
const headData = defineResponseObject({ head: responseStreamHead.producer }, { head: responseStreamHead.client });
|
|
636
|
+
const headResponse = defineSuccessResponse(headData, realtimeResponseMeta);
|
|
570
637
|
const ticketDataProducerShape = {
|
|
571
638
|
socketUrl: z.url().refine((value) => value.startsWith("wss://"), "socketUrl must use wss."),
|
|
572
639
|
protocol: z.literal(GSCDUMP_REALTIME_SUBPROTOCOL),
|
|
@@ -1131,6 +1198,79 @@ function createGscdumpV1Protocol() {
|
|
|
1131
1198
|
}
|
|
1132
1199
|
}
|
|
1133
1200
|
}),
|
|
1201
|
+
listSiteBingIndexingEvidence: defineHttpOperation({
|
|
1202
|
+
id: "partner.sites.indexing.bing.evidence.list",
|
|
1203
|
+
method: "GET",
|
|
1204
|
+
path: "/sites/{siteId}/indexing/bing/evidence",
|
|
1205
|
+
visibility: "public",
|
|
1206
|
+
semantics: {
|
|
1207
|
+
kind: "query",
|
|
1208
|
+
sideEffects: "none",
|
|
1209
|
+
idempotent: true,
|
|
1210
|
+
retry: "idempotent",
|
|
1211
|
+
readConsistency: "primary"
|
|
1212
|
+
},
|
|
1213
|
+
auth: {
|
|
1214
|
+
credentials: ["user_key", "partner_key"],
|
|
1215
|
+
scopes: ["indexing:read"],
|
|
1216
|
+
ownership: [{
|
|
1217
|
+
credential: "user_key",
|
|
1218
|
+
rule: "authorized_site"
|
|
1219
|
+
}, {
|
|
1220
|
+
credential: "partner_key",
|
|
1221
|
+
rule: "authorized_site"
|
|
1222
|
+
}]
|
|
1223
|
+
},
|
|
1224
|
+
request: {
|
|
1225
|
+
params: z.strictObject({ siteId: realtimeSchemas.publicSiteId }),
|
|
1226
|
+
query: bingIndexingEvidenceQuery,
|
|
1227
|
+
headers: requestHeaders,
|
|
1228
|
+
body: null
|
|
1229
|
+
},
|
|
1230
|
+
responses: { 200: bingIndexingEvidenceResponse },
|
|
1231
|
+
errors: partnerSiteErrors,
|
|
1232
|
+
errorResponse: errorEnvelopeSchemas(partnerSiteErrors, realtimeSchemas.publicRequestId),
|
|
1233
|
+
resources: {
|
|
1234
|
+
reads: [{
|
|
1235
|
+
type: "site.indexing",
|
|
1236
|
+
idFrom: "params.siteId"
|
|
1237
|
+
}],
|
|
1238
|
+
changes: []
|
|
1239
|
+
},
|
|
1240
|
+
lifecycle: { introduced: "1.5.0" },
|
|
1241
|
+
docs: {
|
|
1242
|
+
summary: "List Bing Indexing Evidence",
|
|
1243
|
+
description: "Returns dated Bing discovery and crawl observations. It does not return an indexed verdict.",
|
|
1244
|
+
tags: ["Indexing"],
|
|
1245
|
+
examples: {
|
|
1246
|
+
request: {
|
|
1247
|
+
params: { siteId: "s_01" },
|
|
1248
|
+
query: {
|
|
1249
|
+
limit: 100,
|
|
1250
|
+
offset: 0
|
|
1251
|
+
}
|
|
1252
|
+
},
|
|
1253
|
+
response: {
|
|
1254
|
+
data: {
|
|
1255
|
+
searchEngine: "bing",
|
|
1256
|
+
siteUrl: "https://example.com/",
|
|
1257
|
+
indexingEvidence: [],
|
|
1258
|
+
pagination: {
|
|
1259
|
+
total: 0,
|
|
1260
|
+
limit: 100,
|
|
1261
|
+
offset: 0,
|
|
1262
|
+
hasMore: false
|
|
1263
|
+
}
|
|
1264
|
+
},
|
|
1265
|
+
meta: {
|
|
1266
|
+
requestId: "req_01",
|
|
1267
|
+
surface: "partner",
|
|
1268
|
+
version: "1.0"
|
|
1269
|
+
}
|
|
1270
|
+
}
|
|
1271
|
+
}
|
|
1272
|
+
}
|
|
1273
|
+
}),
|
|
1134
1274
|
listSiteIndexingTransitions: defineHttpOperation({
|
|
1135
1275
|
id: "partner.sites.indexing.transitions.list",
|
|
1136
1276
|
method: "GET",
|
|
@@ -4268,6 +4408,8 @@ function createGscdumpV1Protocol() {
|
|
|
4268
4408
|
indexingTransitionsResponse,
|
|
4269
4409
|
indexingUrlsQuery,
|
|
4270
4410
|
indexingUrlsResponse,
|
|
4411
|
+
bingIndexingEvidenceQuery,
|
|
4412
|
+
bingIndexingEvidenceResponse,
|
|
4271
4413
|
lifecycleResponse,
|
|
4272
4414
|
registerSiteRequest,
|
|
4273
4415
|
sitemapChangesQuery,
|