@gscdump/contracts 2.1.1 → 2.3.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/v1/http.d.mts +2 -2
- package/dist/v1/index.d.mts +2 -2
- package/dist/v1/operations.d.mts +353 -1
- package/dist/v1/operations.mjs +141 -0
- package/package.json +1 -1
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;
|
|
@@ -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,
|
|
@@ -1132,6 +1198,79 @@ function createGscdumpV1Protocol() {
|
|
|
1132
1198
|
}
|
|
1133
1199
|
}
|
|
1134
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
|
+
}),
|
|
1135
1274
|
listSiteIndexingTransitions: defineHttpOperation({
|
|
1136
1275
|
id: "partner.sites.indexing.transitions.list",
|
|
1137
1276
|
method: "GET",
|
|
@@ -4269,6 +4408,8 @@ function createGscdumpV1Protocol() {
|
|
|
4269
4408
|
indexingTransitionsResponse,
|
|
4270
4409
|
indexingUrlsQuery,
|
|
4271
4410
|
indexingUrlsResponse,
|
|
4411
|
+
bingIndexingEvidenceQuery,
|
|
4412
|
+
bingIndexingEvidenceResponse,
|
|
4272
4413
|
lifecycleResponse,
|
|
4273
4414
|
registerSiteRequest,
|
|
4274
4415
|
sitemapChangesQuery,
|