@gscdump/contracts 0.38.2 → 0.40.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/_chunks/endpoints.d.mts +167 -29
- package/dist/_chunks/endpoints.mjs +2 -1
- package/dist/_chunks/routes.mjs +87 -0
- package/dist/_chunks/schemas.d.mts +617 -120
- package/dist/_chunks/schemas.mjs +195 -100
- package/dist/_chunks/types.d.mts +51 -159
- package/dist/analytics.d.mts +2 -2
- package/dist/analytics.mjs +2 -1
- package/dist/archetypes.d.mts +61 -1
- package/dist/archetypes.mjs +120 -1
- package/dist/index.d.mts +4 -4
- package/dist/index.mjs +4 -4
- package/dist/partner.d.mts +2 -2
- package/dist/partner.mjs +2 -2
- package/dist/v1/index.d.mts +4988 -410
- package/dist/v1/index.mjs +1319 -138
- package/package.json +1 -1
- package/dist/_chunks/onboarding.mjs +0 -130
package/dist/_chunks/types.d.mts
CHANGED
|
@@ -12,6 +12,12 @@ interface FileResolutionRequest {
|
|
|
12
12
|
* caller intends determines which tables it needs.
|
|
13
13
|
*/
|
|
14
14
|
tables?: FileResolutionTable[];
|
|
15
|
+
/** Client-derived browser attachment byte ceiling. */
|
|
16
|
+
maxBytes?: number;
|
|
17
|
+
/** Client-derived browser attachment row ceiling. */
|
|
18
|
+
maxRows?: number;
|
|
19
|
+
/** Client-derived per-table parquet file-count ceiling. */
|
|
20
|
+
maxFiles?: number;
|
|
15
21
|
/**
|
|
16
22
|
* The archetype the caller will run. Lets the endpoint route the 2
|
|
17
23
|
* window-function archetypes straight to the server tail even when the
|
|
@@ -120,6 +126,7 @@ interface FileResolutionResponse {
|
|
|
120
126
|
eligibilityCeiling: {
|
|
121
127
|
maxBytes: number;
|
|
122
128
|
maxRows: number;
|
|
129
|
+
maxFiles: number;
|
|
123
130
|
};
|
|
124
131
|
}
|
|
125
132
|
declare const GSCDUMP_ONBOARDING_CONTRACT_VERSION: "2026-05-11";
|
|
@@ -650,7 +657,7 @@ interface GscdumpMeta {
|
|
|
650
657
|
syncStatus: string;
|
|
651
658
|
newestDateSynced: string | null;
|
|
652
659
|
oldestDateSynced: string | null;
|
|
653
|
-
dataDelay
|
|
660
|
+
dataDelay?: string;
|
|
654
661
|
dataEndDate?: string | null;
|
|
655
662
|
warnings?: string[];
|
|
656
663
|
enrichment?: {
|
|
@@ -682,6 +689,13 @@ interface GscdumpDataDetailResponse {
|
|
|
682
689
|
ctr: number;
|
|
683
690
|
position: number;
|
|
684
691
|
}>;
|
|
692
|
+
previousDaily?: Array<{
|
|
693
|
+
date: string;
|
|
694
|
+
clicks: number;
|
|
695
|
+
impressions: number;
|
|
696
|
+
ctr: number;
|
|
697
|
+
position: number;
|
|
698
|
+
}>;
|
|
685
699
|
totals: GscdumpTotals;
|
|
686
700
|
previousTotals?: GscdumpTotals;
|
|
687
701
|
meta: GscdumpMeta;
|
|
@@ -715,7 +729,7 @@ interface GscdumpAvailableSite {
|
|
|
715
729
|
siteId?: string;
|
|
716
730
|
/** Integer alias (`user_sites.int_id`) — the int JOIN key partners denormalize into their own catalog namespaces. Present on registered sites. */
|
|
717
731
|
intId?: number | null;
|
|
718
|
-
syncStatus?: 'pending' | 'syncing' | 'synced' | 'error';
|
|
732
|
+
syncStatus?: 'pending' | 'syncing' | 'synced' | 'error' | null;
|
|
719
733
|
syncProgress?: {
|
|
720
734
|
completed: number;
|
|
721
735
|
failed?: number;
|
|
@@ -736,9 +750,10 @@ interface GscdumpSiteRegistration {
|
|
|
736
750
|
message?: string;
|
|
737
751
|
existing?: boolean;
|
|
738
752
|
indexingEligible?: boolean;
|
|
739
|
-
indexingIneligibleReason?: 'missing_indexing_scope' | 'insufficient_gsc_permission';
|
|
753
|
+
indexingIneligibleReason?: 'free_plan' | 'missing_indexing_scope' | 'insufficient_gsc_permission';
|
|
740
754
|
indexingPermissionLevel?: string | null;
|
|
741
755
|
grantedScopes?: string[];
|
|
756
|
+
site?: PartnerLifecycleSite | null;
|
|
742
757
|
}
|
|
743
758
|
interface GscdumpUserSite {
|
|
744
759
|
siteId: string;
|
|
@@ -758,7 +773,7 @@ interface GscdumpUserSite {
|
|
|
758
773
|
percent: number;
|
|
759
774
|
};
|
|
760
775
|
indexingEligible?: boolean;
|
|
761
|
-
indexingIneligibleReason?: 'missing_indexing_scope' | 'insufficient_gsc_permission';
|
|
776
|
+
indexingIneligibleReason?: 'free_plan' | 'missing_indexing_scope' | 'insufficient_gsc_permission';
|
|
762
777
|
indexingPermissionLevel?: string | null;
|
|
763
778
|
grantedScopes?: string[];
|
|
764
779
|
indexingStatus?: 'not_started' | 'indexing' | 'complete';
|
|
@@ -1026,8 +1041,30 @@ interface GscdumpAnalysisResponse {
|
|
|
1026
1041
|
preset: GscdumpAnalysisPreset;
|
|
1027
1042
|
keywords: Array<Record<string, unknown>>;
|
|
1028
1043
|
totalCount: number;
|
|
1029
|
-
summary?: Record<string, unknown
|
|
1030
|
-
meta:
|
|
1044
|
+
summary?: Record<string, unknown> | null;
|
|
1045
|
+
meta: {
|
|
1046
|
+
siteUrl: string;
|
|
1047
|
+
params: {
|
|
1048
|
+
brandTerms?: string[];
|
|
1049
|
+
startDate?: string;
|
|
1050
|
+
endDate?: string;
|
|
1051
|
+
prevStartDate?: string;
|
|
1052
|
+
prevEndDate?: string;
|
|
1053
|
+
};
|
|
1054
|
+
presetDescription?: string;
|
|
1055
|
+
};
|
|
1056
|
+
}
|
|
1057
|
+
interface GscdumpAnalysisBundleParams extends Omit<GscdumpAnalysisParams, 'preset'> {
|
|
1058
|
+
presets: GscdumpAnalysisPreset[];
|
|
1059
|
+
}
|
|
1060
|
+
interface GscdumpAnalysisBundleResponse {
|
|
1061
|
+
bundle: Record<string, {
|
|
1062
|
+
keywords: Array<Record<string, unknown>>;
|
|
1063
|
+
totalCount: number;
|
|
1064
|
+
summary?: Record<string, unknown> | null;
|
|
1065
|
+
presetDescription: string;
|
|
1066
|
+
}>;
|
|
1067
|
+
meta: GscdumpAnalysisResponse['meta'];
|
|
1031
1068
|
}
|
|
1032
1069
|
interface RegisterPartnerUserParams {
|
|
1033
1070
|
userGoogleId: string;
|
|
@@ -1076,7 +1113,7 @@ interface BulkRegisterPartnerSiteResult {
|
|
|
1076
1113
|
error?: string;
|
|
1077
1114
|
site?: PartnerLifecycleSite | null;
|
|
1078
1115
|
indexingEligible?: boolean;
|
|
1079
|
-
indexingIneligibleReason?: 'missing_indexing_scope' | 'insufficient_gsc_permission';
|
|
1116
|
+
indexingIneligibleReason?: 'free_plan' | 'missing_indexing_scope' | 'insufficient_gsc_permission';
|
|
1080
1117
|
indexingPermissionLevel?: string | null;
|
|
1081
1118
|
grantedScopes?: string[];
|
|
1082
1119
|
}
|
|
@@ -1111,6 +1148,12 @@ interface AnalysisSourcesOptions extends SearchTypeOptions {
|
|
|
1111
1148
|
end?: string;
|
|
1112
1149
|
startDate?: string;
|
|
1113
1150
|
endDate?: string;
|
|
1151
|
+
/** Client-derived browser attachment byte ceiling. */
|
|
1152
|
+
maxBytes?: number;
|
|
1153
|
+
/** Client-derived browser attachment row ceiling. */
|
|
1154
|
+
maxRows?: number;
|
|
1155
|
+
/** Client-derived per-table parquet file-count ceiling. */
|
|
1156
|
+
maxFiles?: number;
|
|
1114
1157
|
}
|
|
1115
1158
|
interface DataQueryOptions {
|
|
1116
1159
|
comparison?: BuilderState;
|
|
@@ -1555,157 +1598,6 @@ interface PartnerClient {
|
|
|
1555
1598
|
teamId: string | null;
|
|
1556
1599
|
}>;
|
|
1557
1600
|
}
|
|
1558
|
-
type PartnerRealtimeEventType = 'sync.progress' | 'sync.complete' | 'sync.job_complete' | 'sync.site_complete' | 'sync.failed' | 'job.failed' | 'auth.failed' | 'auth.needs_reauth' | 'site.added' | 'site.removed' | 'enrichment.complete' | 'sitemap.progress' | 'sitemap.complete' | 'indexing.progress' | 'indexing.complete';
|
|
1559
|
-
interface RealtimeSyncProgressEvent {
|
|
1560
|
-
event: 'sync.progress';
|
|
1561
|
-
siteId: string;
|
|
1562
|
-
siteUrl: string;
|
|
1563
|
-
table: string;
|
|
1564
|
-
date: string;
|
|
1565
|
-
progress: number;
|
|
1566
|
-
}
|
|
1567
|
-
interface RealtimeSyncCompleteEvent {
|
|
1568
|
-
event: 'sync.complete';
|
|
1569
|
-
userId: number;
|
|
1570
|
-
siteId: string;
|
|
1571
|
-
siteUrl: string;
|
|
1572
|
-
table: string;
|
|
1573
|
-
date: string;
|
|
1574
|
-
rowsFetched: number;
|
|
1575
|
-
rowsInserted: number;
|
|
1576
|
-
timestamp: number;
|
|
1577
|
-
}
|
|
1578
|
-
interface RealtimeSyncJobCompleteEvent {
|
|
1579
|
-
event: 'sync.job_complete';
|
|
1580
|
-
userId: number;
|
|
1581
|
-
siteId: string;
|
|
1582
|
-
siteUrl: string;
|
|
1583
|
-
table: string;
|
|
1584
|
-
date: string;
|
|
1585
|
-
rowsFetched: number;
|
|
1586
|
-
rowsInserted: number;
|
|
1587
|
-
syncStatus: string;
|
|
1588
|
-
timestamp: number;
|
|
1589
|
-
}
|
|
1590
|
-
interface RealtimeSyncSiteCompleteEvent {
|
|
1591
|
-
event: 'sync.site_complete';
|
|
1592
|
-
userId: number;
|
|
1593
|
-
siteId: string;
|
|
1594
|
-
siteUrl: string;
|
|
1595
|
-
syncStatus: string;
|
|
1596
|
-
timestamp: number;
|
|
1597
|
-
}
|
|
1598
|
-
interface RealtimeSyncFailedEvent {
|
|
1599
|
-
event: 'sync.failed';
|
|
1600
|
-
userId: number;
|
|
1601
|
-
siteId: string;
|
|
1602
|
-
siteUrl: string;
|
|
1603
|
-
table: string;
|
|
1604
|
-
date: string;
|
|
1605
|
-
error: string;
|
|
1606
|
-
timestamp: number;
|
|
1607
|
-
}
|
|
1608
|
-
interface RealtimeJobFailedEvent {
|
|
1609
|
-
event: 'job.failed';
|
|
1610
|
-
siteId: string;
|
|
1611
|
-
siteUrl: string;
|
|
1612
|
-
table: string;
|
|
1613
|
-
date: string;
|
|
1614
|
-
error: string;
|
|
1615
|
-
timestamp: number;
|
|
1616
|
-
}
|
|
1617
|
-
interface RealtimeSiteAddedEvent {
|
|
1618
|
-
event: 'site.added';
|
|
1619
|
-
userId: number;
|
|
1620
|
-
siteId: string;
|
|
1621
|
-
siteUrl: string;
|
|
1622
|
-
}
|
|
1623
|
-
interface RealtimeSiteRemovedEvent {
|
|
1624
|
-
event: 'site.removed';
|
|
1625
|
-
userId: number;
|
|
1626
|
-
siteId: string;
|
|
1627
|
-
siteUrl: string;
|
|
1628
|
-
}
|
|
1629
|
-
interface RealtimeAuthFailedEvent {
|
|
1630
|
-
event: 'auth.failed';
|
|
1631
|
-
userId: number;
|
|
1632
|
-
siteId: string;
|
|
1633
|
-
siteUrl: string;
|
|
1634
|
-
error: string;
|
|
1635
|
-
timestamp: number;
|
|
1636
|
-
}
|
|
1637
|
-
interface RealtimeNeedsReauthEvent {
|
|
1638
|
-
event: 'auth.needs_reauth';
|
|
1639
|
-
userId: number;
|
|
1640
|
-
failureCount: number;
|
|
1641
|
-
timestamp: number;
|
|
1642
|
-
}
|
|
1643
|
-
interface RealtimeEnrichmentCompleteEvent {
|
|
1644
|
-
event: 'enrichment.complete';
|
|
1645
|
-
siteId: string;
|
|
1646
|
-
userId: number;
|
|
1647
|
-
timestamp: number;
|
|
1648
|
-
}
|
|
1649
|
-
interface RealtimeSitemapProgressEvent {
|
|
1650
|
-
event: 'sitemap.progress';
|
|
1651
|
-
userId: number;
|
|
1652
|
-
siteId: string;
|
|
1653
|
-
siteUrl: string;
|
|
1654
|
-
discovered: number;
|
|
1655
|
-
total: number;
|
|
1656
|
-
progress: number;
|
|
1657
|
-
}
|
|
1658
|
-
interface RealtimeSitemapCompleteEvent {
|
|
1659
|
-
event: 'sitemap.complete';
|
|
1660
|
-
userId: number;
|
|
1661
|
-
siteId: string;
|
|
1662
|
-
siteUrl: string;
|
|
1663
|
-
discoveredCount: number;
|
|
1664
|
-
timestamp: number;
|
|
1665
|
-
}
|
|
1666
|
-
interface RealtimeIndexingProgressEvent {
|
|
1667
|
-
event: 'indexing.progress';
|
|
1668
|
-
userId: number;
|
|
1669
|
-
siteId: string;
|
|
1670
|
-
siteUrl: string;
|
|
1671
|
-
checked: number;
|
|
1672
|
-
total: number;
|
|
1673
|
-
progress: number;
|
|
1674
|
-
}
|
|
1675
|
-
interface RealtimeIndexingCompleteEvent {
|
|
1676
|
-
event: 'indexing.complete';
|
|
1677
|
-
userId: number;
|
|
1678
|
-
siteId: string;
|
|
1679
|
-
siteUrl: string;
|
|
1680
|
-
totalUrls: number;
|
|
1681
|
-
indexedCount: number;
|
|
1682
|
-
timestamp: number;
|
|
1683
|
-
}
|
|
1684
|
-
type PartnerRealtimeEvent = RealtimeSyncProgressEvent | RealtimeSyncCompleteEvent | RealtimeSyncJobCompleteEvent | RealtimeSyncSiteCompleteEvent | RealtimeSyncFailedEvent | RealtimeJobFailedEvent | RealtimeSiteAddedEvent | RealtimeSiteRemovedEvent | RealtimeAuthFailedEvent | RealtimeNeedsReauthEvent | RealtimeEnrichmentCompleteEvent | RealtimeSitemapProgressEvent | RealtimeSitemapCompleteEvent | RealtimeIndexingProgressEvent | RealtimeIndexingCompleteEvent;
|
|
1685
|
-
interface RealtimeAuthRequiredMessage {
|
|
1686
|
-
event: 'auth.required';
|
|
1687
|
-
message: string;
|
|
1688
|
-
}
|
|
1689
|
-
interface RealtimeConnectedMessage {
|
|
1690
|
-
event: 'connected';
|
|
1691
|
-
partnerId?: string;
|
|
1692
|
-
userId?: number;
|
|
1693
|
-
message: string;
|
|
1694
|
-
}
|
|
1695
|
-
interface RealtimeSubscribedMessage {
|
|
1696
|
-
type: 'subscribed';
|
|
1697
|
-
siteIds?: string[];
|
|
1698
|
-
partnerIds?: string[];
|
|
1699
|
-
}
|
|
1700
|
-
interface RealtimePongMessage {
|
|
1701
|
-
type: 'pong';
|
|
1702
|
-
timestamp: number;
|
|
1703
|
-
}
|
|
1704
|
-
interface RealtimeErrorMessage {
|
|
1705
|
-
type: 'error';
|
|
1706
|
-
message: string;
|
|
1707
|
-
}
|
|
1708
|
-
type PartnerRealtimeMessage = PartnerRealtimeEvent | RealtimeAuthRequiredMessage | RealtimeConnectedMessage | RealtimeSubscribedMessage | RealtimePongMessage | RealtimeErrorMessage;
|
|
1709
1601
|
type CanonicalWebhookEventType = 'user.lifecycle.changed' | 'site.lifecycle.changed' | 'site.analytics.ready' | 'site.indexing.ready' | 'site.auth.failed' | 'job.failed';
|
|
1710
1602
|
type WebhookEventType = CanonicalWebhookEventType;
|
|
1711
1603
|
interface WebhookEnvelope<TData extends Record<string, unknown> = Record<string, unknown>> {
|
|
@@ -1742,4 +1634,4 @@ interface PartnerWebhookHeaders {
|
|
|
1742
1634
|
timestamp?: string | null;
|
|
1743
1635
|
signature?: string | null;
|
|
1744
1636
|
}
|
|
1745
|
-
export { AccountNextAction, AccountStatus, AddPartnerTeamMemberParams, AnalysisSourcesOptions, AnalysisSourcesResponse, AnalyticsClient, AnalyticsNextAction, AnalyticsStatus, BackfillRange, BackfillResponse, BindPartnerSiteTeamParams, BuilderState, BulkRegisterPartnerSiteResult, BulkRegisterPartnerSitesParams, BulkRegisterPartnerSitesResponse, CanonicalWebhookEventType, ColumnDef, ColumnType, CountriesResponse, CountryRow, CreatePartnerTeamParams, CreateWebhookEnvelopeOptions, DataDetailOptions, DataQueryOptions, DeletePartnerUserResponse, Dimension, FileResolutionRequest, FileResolutionResponse, FileResolutionTable, Filter, GSCDUMP_ONBOARDING_CONTRACT_VERSION, GSCDUMP_OPTIONAL_INDEXING_SCOPE, GSCDUMP_REQUIRED_ANALYTICS_SCOPE, GSCDUMP_WRITE_ANALYTICS_SCOPE, Grain, GscApiRange, GscComparisonFilter, GscRowQueryMeta, GscRowQueryResponse, GscSearchType, GscdumpAnalysisParams, GscdumpAnalysisPreset, GscdumpAnalysisResponse, GscdumpAnalysisSourcesResponse, GscdumpAvailableSite, GscdumpCanonicalMismatchRow, GscdumpCanonicalMismatchesResponse, GscdumpDataDetailResponse, GscdumpDataResponse, GscdumpDataRow, GscdumpDateRangeParams, GscdumpHealthResponse, GscdumpIndexPercentResponse, GscdumpIndexPercentSitemap, GscdumpIndexPercentTrendPoint, GscdumpIndexingDiagnosticsResponse, GscdumpIndexingInspectRateLimited, GscdumpIndexingInspectRequest, GscdumpIndexingInspectResponse, GscdumpIndexingInspectResult, GscdumpIndexingIssueSeverity, GscdumpIndexingResponse, GscdumpIndexingTrendPoint, GscdumpIndexingUrl, GscdumpIndexingUrlStatus, GscdumpIndexingUrlsResponse, GscdumpInvisibleUrlRow, GscdumpKeywordSparklinesParams, GscdumpKeywordSparklinesResponse, GscdumpMeta, GscdumpOrphanPageRow, GscdumpPageTrendParams, GscdumpPageTrendResponse, GscdumpPerSitemapHistoryEntry, GscdumpPermissionRecovery, GscdumpQueryTrendParams, GscdumpQueryTrendResponse, GscdumpRichResultItem, GscdumpSiteRegistration, GscdumpSiteReportResponse, GscdumpSitemap, GscdumpSitemapChangesResponse, GscdumpSitemapHistory, GscdumpSitemapsResponse, GscdumpSyncJobItem, GscdumpSyncJobStatus, GscdumpSyncJobsQueueCounts, GscdumpSyncJobsResponse, GscdumpSyncProgressDateStatus, GscdumpSyncProgressPhaseCounts, GscdumpSyncProgressResponse, GscdumpSyncProgressSite, GscdumpSyncStatusResponse, GscdumpTeamMemberRow, GscdumpTeamRow, GscdumpTopAssociationParams, GscdumpTopAssociationResponse, GscdumpTotals, GscdumpUserMeResponse, GscdumpUserRegistration, GscdumpUserSettings, GscdumpUserSite, GscdumpUserStatus, GscdumpUserTokenUpdate, IndexingDiagnostics, IndexingDiagnosticsParams, IndexingInspectRateLimit, IndexingInspectRateLimited, IndexingInspectRequest, IndexingInspectResponse, IndexingInspectResult, IndexingIssue, IndexingIssueSeverity, IndexingNextAction, IndexingStatus, IndexingUrlRow, IndexingUrlStatus, IndexingUrlsParams, IndexingUrlsResponse, InspectionHistoryRecord, InspectionHistoryResponse, InspectionIndex, InspectionRecordRaw, LifecycleError, LifecycleErrorCode, LifecycleProgress, LifecycleWebhookEnvelope, LifecycleWebhookEvent, Metric, PartnerClient, PartnerLifecycleAccount, PartnerLifecycleResponse, PartnerLifecycleSite,
|
|
1637
|
+
export { AccountNextAction, AccountStatus, AddPartnerTeamMemberParams, AnalysisSourcesOptions, AnalysisSourcesResponse, AnalyticsClient, AnalyticsNextAction, AnalyticsStatus, BackfillRange, BackfillResponse, BindPartnerSiteTeamParams, BuilderState, BulkRegisterPartnerSiteResult, BulkRegisterPartnerSitesParams, BulkRegisterPartnerSitesResponse, CanonicalWebhookEventType, ColumnDef, ColumnType, CountriesResponse, CountryRow, CreatePartnerTeamParams, CreateWebhookEnvelopeOptions, DataDetailOptions, DataQueryOptions, DeletePartnerUserResponse, Dimension, FileResolutionRequest, FileResolutionResponse, FileResolutionTable, Filter, GSCDUMP_ONBOARDING_CONTRACT_VERSION, GSCDUMP_OPTIONAL_INDEXING_SCOPE, GSCDUMP_REQUIRED_ANALYTICS_SCOPE, GSCDUMP_WRITE_ANALYTICS_SCOPE, Grain, GscApiRange, GscComparisonFilter, GscRowQueryMeta, GscRowQueryResponse, GscSearchType, GscdumpAnalysisBundleParams, GscdumpAnalysisBundleResponse, GscdumpAnalysisParams, GscdumpAnalysisPreset, GscdumpAnalysisResponse, GscdumpAnalysisSourcesResponse, GscdumpAvailableSite, GscdumpCanonicalMismatchRow, GscdumpCanonicalMismatchesResponse, GscdumpDataDetailResponse, GscdumpDataResponse, GscdumpDataRow, GscdumpDateRangeParams, GscdumpHealthResponse, GscdumpIndexPercentResponse, GscdumpIndexPercentSitemap, GscdumpIndexPercentTrendPoint, GscdumpIndexingDiagnosticsResponse, GscdumpIndexingInspectRateLimited, GscdumpIndexingInspectRequest, GscdumpIndexingInspectResponse, GscdumpIndexingInspectResult, GscdumpIndexingIssueSeverity, GscdumpIndexingResponse, GscdumpIndexingTrendPoint, GscdumpIndexingUrl, GscdumpIndexingUrlStatus, GscdumpIndexingUrlsResponse, GscdumpInvisibleUrlRow, GscdumpKeywordSparklinesParams, GscdumpKeywordSparklinesResponse, GscdumpMeta, GscdumpOrphanPageRow, GscdumpPageTrendParams, GscdumpPageTrendResponse, GscdumpPerSitemapHistoryEntry, GscdumpPermissionRecovery, GscdumpQueryTrendParams, GscdumpQueryTrendResponse, GscdumpRichResultItem, GscdumpSiteRegistration, GscdumpSiteReportResponse, GscdumpSitemap, GscdumpSitemapChangesResponse, GscdumpSitemapHistory, GscdumpSitemapsResponse, GscdumpSyncJobItem, GscdumpSyncJobStatus, GscdumpSyncJobsQueueCounts, GscdumpSyncJobsResponse, GscdumpSyncProgressDateStatus, GscdumpSyncProgressPhaseCounts, GscdumpSyncProgressResponse, GscdumpSyncProgressSite, GscdumpSyncStatusResponse, GscdumpTeamMemberRow, GscdumpTeamRow, GscdumpTopAssociationParams, GscdumpTopAssociationResponse, GscdumpTotals, GscdumpUserMeResponse, GscdumpUserRegistration, GscdumpUserSettings, GscdumpUserSite, GscdumpUserStatus, GscdumpUserTokenUpdate, IndexingDiagnostics, IndexingDiagnosticsParams, IndexingInspectRateLimit, IndexingInspectRateLimited, IndexingInspectRequest, IndexingInspectResponse, IndexingInspectResult, IndexingIssue, IndexingIssueSeverity, IndexingNextAction, IndexingStatus, IndexingUrlRow, IndexingUrlStatus, IndexingUrlsParams, IndexingUrlsResponse, InspectionHistoryRecord, InspectionHistoryResponse, InspectionIndex, InspectionRecordRaw, LifecycleError, LifecycleErrorCode, LifecycleProgress, LifecycleWebhookEnvelope, LifecycleWebhookEvent, Metric, PartnerClient, PartnerLifecycleAccount, PartnerLifecycleResponse, PartnerLifecycleSite, PartnerWebhookData, PartnerWebhookHeaders, PropertyNextAction, PropertyStatus, QuerySourceMode, RegisterPartnerSiteParams, RegisterPartnerUserParams, ResolvedParquetFile, ResolvedTable, RollupEnvelope, Row, ScheduleState, SearchAppearanceResponse, SearchAppearanceRow, SearchTypeOptions, ServerTailDirective, SiteListItem, SitemapAddedRow, SitemapChangesResponse, SitemapHistoryRecord, SitemapHistoryResponse, SitemapIndex, SitemapNextAction, SitemapRemovedRow, SitemapStatus, SourceInfoOptions, SourceInfoResponse, TableName, TableSchema, TenantCtx, UpdatePartnerUserTokensParams, WebhookEnvelope, WebhookEventType, WhoamiResponse, accountNextActions, accountStatuses, analyticsNextActions, analyticsStatuses, hasOptionalIndexingScope, hasRequiredAnalyticsScope, indexingNextActions, indexingStatuses, lifecycleErrorCodes, lifecycleWebhookEvents, parseGrantedScopes, propertyNextActions, propertyStatuses, querySourceModes, sitemapNextActions, sitemapStatuses };
|
package/dist/analytics.d.mts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
import { analyticsEndpoints } from "./_chunks/endpoints.mjs";
|
|
2
2
|
import { analyticsEndpointSchemas, analyticsRoutes } from "./_chunks/schemas.mjs";
|
|
3
|
-
import { AddPartnerTeamMemberParams, AnalysisSourcesOptions, AnalysisSourcesResponse, AnalyticsClient, BackfillRange, BackfillResponse, BindPartnerSiteTeamParams, BuilderState, BulkRegisterPartnerSiteResult, BulkRegisterPartnerSitesParams, BulkRegisterPartnerSitesResponse, CanonicalWebhookEventType, ColumnDef, ColumnType, CountriesResponse, CountryRow, CreatePartnerTeamParams, CreateWebhookEnvelopeOptions, DataDetailOptions, DataQueryOptions, DeletePartnerUserResponse, Dimension, Filter, Grain, GscApiRange, GscComparisonFilter, GscRowQueryMeta, GscRowQueryResponse, GscSearchType, GscdumpAnalysisParams, GscdumpAnalysisPreset, GscdumpAnalysisResponse, GscdumpAnalysisSourcesResponse, GscdumpAvailableSite, GscdumpCanonicalMismatchRow, GscdumpCanonicalMismatchesResponse, GscdumpDataDetailResponse, GscdumpDataResponse, GscdumpDataRow, GscdumpDateRangeParams, GscdumpHealthResponse, GscdumpIndexPercentResponse, GscdumpIndexPercentSitemap, GscdumpIndexPercentTrendPoint, GscdumpIndexingDiagnosticsResponse, GscdumpIndexingInspectRateLimited, GscdumpIndexingInspectRequest, GscdumpIndexingInspectResponse, GscdumpIndexingInspectResult, GscdumpIndexingIssueSeverity, GscdumpIndexingResponse, GscdumpIndexingTrendPoint, GscdumpIndexingUrl, GscdumpIndexingUrlStatus, GscdumpIndexingUrlsResponse, GscdumpInvisibleUrlRow, GscdumpKeywordSparklinesParams, GscdumpKeywordSparklinesResponse, GscdumpMeta, GscdumpOrphanPageRow, GscdumpPageTrendParams, GscdumpPageTrendResponse, GscdumpPerSitemapHistoryEntry, GscdumpPermissionRecovery, GscdumpQueryTrendParams, GscdumpQueryTrendResponse, GscdumpRichResultItem, GscdumpSiteRegistration, GscdumpSiteReportResponse, GscdumpSitemap, GscdumpSitemapChangesResponse, GscdumpSitemapHistory, GscdumpSitemapsResponse, GscdumpSyncJobItem, GscdumpSyncJobStatus, GscdumpSyncJobsQueueCounts, GscdumpSyncJobsResponse, GscdumpSyncProgressDateStatus, GscdumpSyncProgressPhaseCounts, GscdumpSyncProgressResponse, GscdumpSyncProgressSite, GscdumpSyncStatusResponse, GscdumpTeamMemberRow, GscdumpTeamRow, GscdumpTopAssociationParams, GscdumpTopAssociationResponse, GscdumpTotals, GscdumpUserMeResponse, GscdumpUserRegistration, GscdumpUserSettings, GscdumpUserSite, GscdumpUserStatus, GscdumpUserTokenUpdate, IndexingDiagnostics, IndexingDiagnosticsParams, IndexingInspectRateLimit, IndexingInspectRateLimited, IndexingInspectRequest, IndexingInspectResponse, IndexingInspectResult, IndexingIssue, IndexingIssueSeverity, IndexingUrlRow, IndexingUrlStatus, IndexingUrlsParams, IndexingUrlsResponse, InspectionHistoryRecord, InspectionHistoryResponse, InspectionIndex, InspectionRecordRaw, Metric, PartnerClient, PartnerLifecycleAccount, PartnerLifecycleResponse, PartnerLifecycleSite,
|
|
4
|
-
export { type AddPartnerTeamMemberParams, type AnalysisSourcesOptions, type AnalysisSourcesResponse, type AnalyticsClient, type BackfillRange, type BackfillResponse, type BindPartnerSiteTeamParams, type BuilderState, type BulkRegisterPartnerSiteResult, type BulkRegisterPartnerSitesParams, type BulkRegisterPartnerSitesResponse, type CanonicalWebhookEventType, type ColumnDef, type ColumnType, type CountriesResponse, type CountryRow, type CreatePartnerTeamParams, type CreateWebhookEnvelopeOptions, type DataDetailOptions, type DataQueryOptions, type DeletePartnerUserResponse, type Dimension, type Filter, type Grain, type GscApiRange, type GscComparisonFilter, type GscRowQueryMeta, type GscRowQueryResponse, type GscSearchType, type GscdumpAnalysisParams, type GscdumpAnalysisPreset, type GscdumpAnalysisResponse, type GscdumpAnalysisSourcesResponse, type GscdumpAvailableSite, type GscdumpCanonicalMismatchRow, type GscdumpCanonicalMismatchesResponse, type GscdumpDataDetailResponse, type GscdumpDataResponse, type GscdumpDataRow, type GscdumpDateRangeParams, type GscdumpHealthResponse, type GscdumpIndexPercentResponse, type GscdumpIndexPercentSitemap, type GscdumpIndexPercentTrendPoint, type GscdumpIndexingDiagnosticsResponse, type GscdumpIndexingInspectRateLimited, type GscdumpIndexingInspectRequest, type GscdumpIndexingInspectResponse, type GscdumpIndexingInspectResult, type GscdumpIndexingIssueSeverity, type GscdumpIndexingResponse, type GscdumpIndexingTrendPoint, type GscdumpIndexingUrl, type GscdumpIndexingUrlStatus, type GscdumpIndexingUrlsResponse, type GscdumpInvisibleUrlRow, type GscdumpKeywordSparklinesParams, type GscdumpKeywordSparklinesResponse, type GscdumpMeta, type GscdumpOrphanPageRow, type GscdumpPageTrendParams, type GscdumpPageTrendResponse, type GscdumpPerSitemapHistoryEntry, type GscdumpPermissionRecovery, type GscdumpQueryTrendParams, type GscdumpQueryTrendResponse, type GscdumpRichResultItem, type GscdumpSiteRegistration, type GscdumpSiteReportResponse, type GscdumpSitemap, type GscdumpSitemapChangesResponse, type GscdumpSitemapHistory, type GscdumpSitemapsResponse, type GscdumpSyncJobItem, type GscdumpSyncJobStatus, type GscdumpSyncJobsQueueCounts, type GscdumpSyncJobsResponse, type GscdumpSyncProgressDateStatus, type GscdumpSyncProgressPhaseCounts, type GscdumpSyncProgressResponse, type GscdumpSyncProgressSite, type GscdumpSyncStatusResponse, type GscdumpTeamMemberRow, type GscdumpTeamRow, type GscdumpTopAssociationParams, type GscdumpTopAssociationResponse, type GscdumpTotals, type GscdumpUserMeResponse, type GscdumpUserRegistration, type GscdumpUserSettings, type GscdumpUserSite, type GscdumpUserStatus, type GscdumpUserTokenUpdate, type IndexingDiagnostics, type IndexingDiagnosticsParams, type IndexingInspectRateLimit, type IndexingInspectRateLimited, type IndexingInspectRequest, type IndexingInspectResponse, type IndexingInspectResult, type IndexingIssue, type IndexingIssueSeverity, type IndexingUrlRow, type IndexingUrlStatus, type IndexingUrlsParams, type IndexingUrlsResponse, type InspectionHistoryRecord, type InspectionHistoryResponse, type InspectionIndex, type InspectionRecordRaw, type Metric, type PartnerClient, type PartnerLifecycleAccount, type PartnerLifecycleResponse, type PartnerLifecycleSite, type
|
|
3
|
+
import { AddPartnerTeamMemberParams, AnalysisSourcesOptions, AnalysisSourcesResponse, AnalyticsClient, BackfillRange, BackfillResponse, BindPartnerSiteTeamParams, BuilderState, BulkRegisterPartnerSiteResult, BulkRegisterPartnerSitesParams, BulkRegisterPartnerSitesResponse, CanonicalWebhookEventType, ColumnDef, ColumnType, CountriesResponse, CountryRow, CreatePartnerTeamParams, CreateWebhookEnvelopeOptions, DataDetailOptions, DataQueryOptions, DeletePartnerUserResponse, Dimension, Filter, Grain, GscApiRange, GscComparisonFilter, GscRowQueryMeta, GscRowQueryResponse, GscSearchType, GscdumpAnalysisBundleParams, GscdumpAnalysisBundleResponse, GscdumpAnalysisParams, GscdumpAnalysisPreset, GscdumpAnalysisResponse, GscdumpAnalysisSourcesResponse, GscdumpAvailableSite, GscdumpCanonicalMismatchRow, GscdumpCanonicalMismatchesResponse, GscdumpDataDetailResponse, GscdumpDataResponse, GscdumpDataRow, GscdumpDateRangeParams, GscdumpHealthResponse, GscdumpIndexPercentResponse, GscdumpIndexPercentSitemap, GscdumpIndexPercentTrendPoint, GscdumpIndexingDiagnosticsResponse, GscdumpIndexingInspectRateLimited, GscdumpIndexingInspectRequest, GscdumpIndexingInspectResponse, GscdumpIndexingInspectResult, GscdumpIndexingIssueSeverity, GscdumpIndexingResponse, GscdumpIndexingTrendPoint, GscdumpIndexingUrl, GscdumpIndexingUrlStatus, GscdumpIndexingUrlsResponse, GscdumpInvisibleUrlRow, GscdumpKeywordSparklinesParams, GscdumpKeywordSparklinesResponse, GscdumpMeta, GscdumpOrphanPageRow, GscdumpPageTrendParams, GscdumpPageTrendResponse, GscdumpPerSitemapHistoryEntry, GscdumpPermissionRecovery, GscdumpQueryTrendParams, GscdumpQueryTrendResponse, GscdumpRichResultItem, GscdumpSiteRegistration, GscdumpSiteReportResponse, GscdumpSitemap, GscdumpSitemapChangesResponse, GscdumpSitemapHistory, GscdumpSitemapsResponse, GscdumpSyncJobItem, GscdumpSyncJobStatus, GscdumpSyncJobsQueueCounts, GscdumpSyncJobsResponse, GscdumpSyncProgressDateStatus, GscdumpSyncProgressPhaseCounts, GscdumpSyncProgressResponse, GscdumpSyncProgressSite, GscdumpSyncStatusResponse, GscdumpTeamMemberRow, GscdumpTeamRow, GscdumpTopAssociationParams, GscdumpTopAssociationResponse, GscdumpTotals, GscdumpUserMeResponse, GscdumpUserRegistration, GscdumpUserSettings, GscdumpUserSite, GscdumpUserStatus, GscdumpUserTokenUpdate, IndexingDiagnostics, IndexingDiagnosticsParams, IndexingInspectRateLimit, IndexingInspectRateLimited, IndexingInspectRequest, IndexingInspectResponse, IndexingInspectResult, IndexingIssue, IndexingIssueSeverity, IndexingUrlRow, IndexingUrlStatus, IndexingUrlsParams, IndexingUrlsResponse, InspectionHistoryRecord, InspectionHistoryResponse, InspectionIndex, InspectionRecordRaw, Metric, PartnerClient, PartnerLifecycleAccount, PartnerLifecycleResponse, PartnerLifecycleSite, PartnerWebhookData, PartnerWebhookHeaders, RegisterPartnerSiteParams, RegisterPartnerUserParams, RollupEnvelope, Row, ScheduleState, SearchAppearanceResponse, SearchAppearanceRow, SearchTypeOptions, SiteListItem, SitemapAddedRow, SitemapChangesResponse, SitemapHistoryRecord, SitemapHistoryResponse, SitemapIndex, SitemapRemovedRow, SourceInfoOptions, SourceInfoResponse, TableName, TableSchema, TenantCtx, UpdatePartnerUserTokensParams, WebhookEnvelope, WebhookEventType, WhoamiResponse } from "./_chunks/types.mjs";
|
|
4
|
+
export { type AddPartnerTeamMemberParams, type AnalysisSourcesOptions, type AnalysisSourcesResponse, type AnalyticsClient, type BackfillRange, type BackfillResponse, type BindPartnerSiteTeamParams, type BuilderState, type BulkRegisterPartnerSiteResult, type BulkRegisterPartnerSitesParams, type BulkRegisterPartnerSitesResponse, type CanonicalWebhookEventType, type ColumnDef, type ColumnType, type CountriesResponse, type CountryRow, type CreatePartnerTeamParams, type CreateWebhookEnvelopeOptions, type DataDetailOptions, type DataQueryOptions, type DeletePartnerUserResponse, type Dimension, type Filter, type Grain, type GscApiRange, type GscComparisonFilter, type GscRowQueryMeta, type GscRowQueryResponse, type GscSearchType, type GscdumpAnalysisBundleParams, type GscdumpAnalysisBundleResponse, type GscdumpAnalysisParams, type GscdumpAnalysisPreset, type GscdumpAnalysisResponse, type GscdumpAnalysisSourcesResponse, type GscdumpAvailableSite, type GscdumpCanonicalMismatchRow, type GscdumpCanonicalMismatchesResponse, type GscdumpDataDetailResponse, type GscdumpDataResponse, type GscdumpDataRow, type GscdumpDateRangeParams, type GscdumpHealthResponse, type GscdumpIndexPercentResponse, type GscdumpIndexPercentSitemap, type GscdumpIndexPercentTrendPoint, type GscdumpIndexingDiagnosticsResponse, type GscdumpIndexingInspectRateLimited, type GscdumpIndexingInspectRequest, type GscdumpIndexingInspectResponse, type GscdumpIndexingInspectResult, type GscdumpIndexingIssueSeverity, type GscdumpIndexingResponse, type GscdumpIndexingTrendPoint, type GscdumpIndexingUrl, type GscdumpIndexingUrlStatus, type GscdumpIndexingUrlsResponse, type GscdumpInvisibleUrlRow, type GscdumpKeywordSparklinesParams, type GscdumpKeywordSparklinesResponse, type GscdumpMeta, type GscdumpOrphanPageRow, type GscdumpPageTrendParams, type GscdumpPageTrendResponse, type GscdumpPerSitemapHistoryEntry, type GscdumpPermissionRecovery, type GscdumpQueryTrendParams, type GscdumpQueryTrendResponse, type GscdumpRichResultItem, type GscdumpSiteRegistration, type GscdumpSiteReportResponse, type GscdumpSitemap, type GscdumpSitemapChangesResponse, type GscdumpSitemapHistory, type GscdumpSitemapsResponse, type GscdumpSyncJobItem, type GscdumpSyncJobStatus, type GscdumpSyncJobsQueueCounts, type GscdumpSyncJobsResponse, type GscdumpSyncProgressDateStatus, type GscdumpSyncProgressPhaseCounts, type GscdumpSyncProgressResponse, type GscdumpSyncProgressSite, type GscdumpSyncStatusResponse, type GscdumpTeamMemberRow, type GscdumpTeamRow, type GscdumpTopAssociationParams, type GscdumpTopAssociationResponse, type GscdumpTotals, type GscdumpUserMeResponse, type GscdumpUserRegistration, type GscdumpUserSettings, type GscdumpUserSite, type GscdumpUserStatus, type GscdumpUserTokenUpdate, type IndexingDiagnostics, type IndexingDiagnosticsParams, type IndexingInspectRateLimit, type IndexingInspectRateLimited, type IndexingInspectRequest, type IndexingInspectResponse, type IndexingInspectResult, type IndexingIssue, type IndexingIssueSeverity, type IndexingUrlRow, type IndexingUrlStatus, type IndexingUrlsParams, type IndexingUrlsResponse, type InspectionHistoryRecord, type InspectionHistoryResponse, type InspectionIndex, type InspectionRecordRaw, type Metric, type PartnerClient, type PartnerLifecycleAccount, type PartnerLifecycleResponse, type PartnerLifecycleSite, type PartnerWebhookData, type PartnerWebhookHeaders, type RegisterPartnerSiteParams, type RegisterPartnerUserParams, type RollupEnvelope, type Row, type ScheduleState, type SearchAppearanceResponse, type SearchAppearanceRow, type SearchTypeOptions, type SiteListItem, type SitemapAddedRow, type SitemapChangesResponse, type SitemapHistoryRecord, type SitemapHistoryResponse, type SitemapIndex, type SitemapRemovedRow, type SourceInfoOptions, type SourceInfoResponse, type TableName, type TableSchema, type TenantCtx, type UpdatePartnerUserTokensParams, type WebhookEnvelope, type WebhookEventType, type WhoamiResponse, analyticsEndpointSchemas, analyticsEndpoints, analyticsRoutes };
|
package/dist/analytics.mjs
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
-
import { analyticsEndpointSchemas
|
|
1
|
+
import { analyticsEndpointSchemas } from "./_chunks/schemas.mjs";
|
|
2
|
+
import { analyticsRoutes } from "./_chunks/routes.mjs";
|
|
2
3
|
import { analyticsEndpoints } from "./_chunks/endpoints.mjs";
|
|
3
4
|
export { analyticsEndpointSchemas, analyticsEndpoints, analyticsRoutes };
|
package/dist/archetypes.d.mts
CHANGED
|
@@ -85,6 +85,66 @@ interface AuxCloudOnlyQuery {
|
|
|
85
85
|
params?: Record<string, unknown>;
|
|
86
86
|
}
|
|
87
87
|
type ArchetypeQuery = SiteDailyTimeseriesQuery | EntityDailyTimeseriesQuery | EntityDailySparklineQuery | TopNBreakdownQuery | SingleRowLookupQuery | MultiSeriesStackedDailyQuery | TwoDimensionDetailQuery | ArbitrarySqlQuery | AuxCloudOnlyQuery;
|
|
88
|
+
/** Date window accepted by the portable archetype constructors. */
|
|
89
|
+
interface WireDateRange {
|
|
90
|
+
start: string;
|
|
91
|
+
end: string;
|
|
92
|
+
}
|
|
93
|
+
/** Portable constructors for the canonical hosted/browser archetype wire shapes. */
|
|
94
|
+
declare function siteDailyTimeseries(siteId: string, range: WireDateRange, options?: {
|
|
95
|
+
searchType?: GscSearchType;
|
|
96
|
+
compareRange?: WireDateRange;
|
|
97
|
+
metrics?: readonly Metric[];
|
|
98
|
+
}): SiteDailyTimeseriesQuery;
|
|
99
|
+
declare function entityDailyTimeseries(siteId: string, range: WireDateRange, entity: EntityDailyTimeseriesQuery['entity'], options?: {
|
|
100
|
+
searchType?: GscSearchType;
|
|
101
|
+
compareRange?: WireDateRange;
|
|
102
|
+
metrics?: readonly Metric[];
|
|
103
|
+
}): EntityDailyTimeseriesQuery;
|
|
104
|
+
declare function entityDailySparkline(siteId: string, range: WireDateRange, dimension: EntityDailySparklineQuery['dimension'], entities: readonly string[], options?: {
|
|
105
|
+
searchType?: GscSearchType;
|
|
106
|
+
metric?: Metric;
|
|
107
|
+
}): EntityDailySparklineQuery;
|
|
108
|
+
interface TopNBreakdownOptions {
|
|
109
|
+
searchType?: GscSearchType;
|
|
110
|
+
compareRange?: WireDateRange;
|
|
111
|
+
metrics?: readonly Metric[];
|
|
112
|
+
orderBy?: TopNBreakdownQuery['orderBy'];
|
|
113
|
+
limit?: number;
|
|
114
|
+
offset?: number;
|
|
115
|
+
facets?: readonly ArchetypeFacet[];
|
|
116
|
+
includeTotal?: boolean;
|
|
117
|
+
movers?: NonNullable<TopNBreakdownQuery['movers']>;
|
|
118
|
+
}
|
|
119
|
+
declare function topNBreakdown(siteId: string, range: WireDateRange, dimension: Dimension, options?: TopNBreakdownOptions): TopNBreakdownQuery;
|
|
120
|
+
declare function singleRowLookup(siteId: string, range: WireDateRange, match: SingleRowLookupQuery['match'], options?: {
|
|
121
|
+
searchType?: GscSearchType;
|
|
122
|
+
compareRange?: WireDateRange;
|
|
123
|
+
metrics?: readonly Metric[];
|
|
124
|
+
}): SingleRowLookupQuery;
|
|
125
|
+
declare function multiSeriesStackedDaily(siteId: string, range: WireDateRange, seriesDimension: Dimension, options?: {
|
|
126
|
+
searchType?: GscSearchType;
|
|
127
|
+
compareRange?: WireDateRange;
|
|
128
|
+
metric?: Metric;
|
|
129
|
+
}): MultiSeriesStackedDailyQuery;
|
|
130
|
+
interface TwoDimensionDetailOptions {
|
|
131
|
+
searchType?: GscSearchType;
|
|
132
|
+
compareRange?: WireDateRange;
|
|
133
|
+
metrics?: readonly Metric[];
|
|
134
|
+
filter?: TwoDimensionDetailQuery['filter'];
|
|
135
|
+
orderBy?: TwoDimensionDetailQuery['orderBy'];
|
|
136
|
+
limit?: number;
|
|
137
|
+
facets?: readonly ArchetypeFacet[];
|
|
138
|
+
}
|
|
139
|
+
declare function twoDimensionDetail(siteId: string, range: WireDateRange, options?: TwoDimensionDetailOptions): TwoDimensionDetailQuery;
|
|
140
|
+
declare function arbitrarySql(siteId: string, range: WireDateRange, sql: string, options?: {
|
|
141
|
+
searchType?: GscSearchType;
|
|
142
|
+
params?: readonly unknown[];
|
|
143
|
+
cacheable?: boolean;
|
|
144
|
+
}): ArbitrarySqlQuery & {
|
|
145
|
+
cacheable?: true;
|
|
146
|
+
};
|
|
147
|
+
declare function auxCloudOnly(siteId: string, dataset: AuxCloudOnlyQuery['dataset'], params?: Record<string, unknown>): AuxCloudOnlyQuery;
|
|
88
148
|
type ArchetypeResultRow = Record<string, string | number | null>;
|
|
89
149
|
type ArchetypeResultSource = 'browser' | 'server-r2-sql' | 'server-duckdb' | 'cloud';
|
|
90
150
|
interface ArchetypeResult<R extends ArchetypeResultRow = ArchetypeResultRow> {
|
|
@@ -104,4 +164,4 @@ interface ResolvedArchetypeQuery {
|
|
|
104
164
|
builder?: BuilderState;
|
|
105
165
|
executionClass: ArchetypeExecutionClass;
|
|
106
166
|
}
|
|
107
|
-
export { ARCHETYPE_EXECUTION_CLASS, ArbitrarySqlQuery, ArchetypeExecutionClass, ArchetypeFacet, ArchetypeQuery, ArchetypeQueryBase, ArchetypeResult, ArchetypeResultRow, ArchetypeResultSource, AuxCloudOnlyQuery, DateRange, EntityDailySparklineQuery, EntityDailyTimeseriesQuery, MultiSeriesStackedDailyQuery, QueryArchetype, ResolvedArchetypeQuery, SingleRowLookupQuery, SiteDailyTimeseriesQuery, TopNBreakdownQuery, TwoDimensionDetailQuery };
|
|
167
|
+
export { ARCHETYPE_EXECUTION_CLASS, ArbitrarySqlQuery, ArchetypeExecutionClass, ArchetypeFacet, ArchetypeQuery, ArchetypeQueryBase, ArchetypeResult, ArchetypeResultRow, ArchetypeResultSource, AuxCloudOnlyQuery, DateRange, EntityDailySparklineQuery, EntityDailyTimeseriesQuery, MultiSeriesStackedDailyQuery, QueryArchetype, ResolvedArchetypeQuery, SingleRowLookupQuery, SiteDailyTimeseriesQuery, TopNBreakdownOptions, TopNBreakdownQuery, TwoDimensionDetailOptions, TwoDimensionDetailQuery, WireDateRange, arbitrarySql, auxCloudOnly, entityDailySparkline, entityDailyTimeseries, multiSeriesStackedDaily, singleRowLookup, siteDailyTimeseries, topNBreakdown, twoDimensionDetail };
|
package/dist/archetypes.mjs
CHANGED
|
@@ -9,4 +9,123 @@ const ARCHETYPE_EXECUTION_CLASS = {
|
|
|
9
9
|
"arbitrary-sql": "duckdb",
|
|
10
10
|
"aux-cloud-only": "cloud-only"
|
|
11
11
|
};
|
|
12
|
-
|
|
12
|
+
const ARCHETYPE_METRICS = [
|
|
13
|
+
"clicks",
|
|
14
|
+
"impressions",
|
|
15
|
+
"ctr",
|
|
16
|
+
"position"
|
|
17
|
+
];
|
|
18
|
+
function archetypeRange(range) {
|
|
19
|
+
return {
|
|
20
|
+
start: range.start,
|
|
21
|
+
end: range.end
|
|
22
|
+
};
|
|
23
|
+
}
|
|
24
|
+
function siteDailyTimeseries(siteId, range, options = {}) {
|
|
25
|
+
return {
|
|
26
|
+
archetype: "site-daily-timeseries",
|
|
27
|
+
siteId,
|
|
28
|
+
searchType: options.searchType ?? "web",
|
|
29
|
+
range: archetypeRange(range),
|
|
30
|
+
...options.compareRange ? { compareRange: archetypeRange(options.compareRange) } : {},
|
|
31
|
+
metrics: options.metrics ?? ARCHETYPE_METRICS
|
|
32
|
+
};
|
|
33
|
+
}
|
|
34
|
+
function entityDailyTimeseries(siteId, range, entity, options = {}) {
|
|
35
|
+
return {
|
|
36
|
+
archetype: "entity-daily-timeseries",
|
|
37
|
+
siteId,
|
|
38
|
+
searchType: options.searchType ?? "web",
|
|
39
|
+
range: archetypeRange(range),
|
|
40
|
+
...options.compareRange ? { compareRange: archetypeRange(options.compareRange) } : {},
|
|
41
|
+
entity,
|
|
42
|
+
metrics: options.metrics ?? ARCHETYPE_METRICS
|
|
43
|
+
};
|
|
44
|
+
}
|
|
45
|
+
function entityDailySparkline(siteId, range, dimension, entities, options = {}) {
|
|
46
|
+
return {
|
|
47
|
+
archetype: "entity-daily-sparkline",
|
|
48
|
+
siteId,
|
|
49
|
+
searchType: options.searchType ?? "web",
|
|
50
|
+
range: archetypeRange(range),
|
|
51
|
+
dimension,
|
|
52
|
+
entities: [...entities],
|
|
53
|
+
metric: options.metric ?? "clicks"
|
|
54
|
+
};
|
|
55
|
+
}
|
|
56
|
+
function topNBreakdown(siteId, range, dimension, options = {}) {
|
|
57
|
+
return {
|
|
58
|
+
archetype: "top-n-breakdown",
|
|
59
|
+
siteId,
|
|
60
|
+
searchType: options.searchType ?? "web",
|
|
61
|
+
range: archetypeRange(range),
|
|
62
|
+
...options.compareRange ? { compareRange: archetypeRange(options.compareRange) } : {},
|
|
63
|
+
dimension,
|
|
64
|
+
metrics: options.metrics ?? ARCHETYPE_METRICS,
|
|
65
|
+
orderBy: options.orderBy ?? {
|
|
66
|
+
metric: "clicks",
|
|
67
|
+
dir: "desc"
|
|
68
|
+
},
|
|
69
|
+
limit: options.limit ?? 50,
|
|
70
|
+
...options.offset ? { offset: options.offset } : {},
|
|
71
|
+
...options.facets?.length ? { facets: options.facets } : {},
|
|
72
|
+
...options.includeTotal ? { includeTotal: true } : {},
|
|
73
|
+
...options.movers ? { movers: options.movers } : {}
|
|
74
|
+
};
|
|
75
|
+
}
|
|
76
|
+
function singleRowLookup(siteId, range, match, options = {}) {
|
|
77
|
+
return {
|
|
78
|
+
archetype: "single-row-lookup",
|
|
79
|
+
siteId,
|
|
80
|
+
searchType: options.searchType ?? "web",
|
|
81
|
+
range: archetypeRange(range),
|
|
82
|
+
...options.compareRange ? { compareRange: archetypeRange(options.compareRange) } : {},
|
|
83
|
+
match,
|
|
84
|
+
metrics: options.metrics ?? ARCHETYPE_METRICS
|
|
85
|
+
};
|
|
86
|
+
}
|
|
87
|
+
function multiSeriesStackedDaily(siteId, range, seriesDimension, options = {}) {
|
|
88
|
+
return {
|
|
89
|
+
archetype: "multi-series-stacked-daily",
|
|
90
|
+
siteId,
|
|
91
|
+
searchType: options.searchType ?? "web",
|
|
92
|
+
range: archetypeRange(range),
|
|
93
|
+
...options.compareRange ? { compareRange: archetypeRange(options.compareRange) } : {},
|
|
94
|
+
seriesDimension,
|
|
95
|
+
metric: options.metric ?? "clicks"
|
|
96
|
+
};
|
|
97
|
+
}
|
|
98
|
+
function twoDimensionDetail(siteId, range, options = {}) {
|
|
99
|
+
return {
|
|
100
|
+
archetype: "two-dimension-detail",
|
|
101
|
+
siteId,
|
|
102
|
+
searchType: options.searchType ?? "web",
|
|
103
|
+
range: archetypeRange(range),
|
|
104
|
+
...options.compareRange ? { compareRange: archetypeRange(options.compareRange) } : {},
|
|
105
|
+
metrics: options.metrics ?? ARCHETYPE_METRICS,
|
|
106
|
+
...options.filter ? { filter: options.filter } : {},
|
|
107
|
+
...options.orderBy ? { orderBy: options.orderBy } : {},
|
|
108
|
+
...options.limit ? { limit: options.limit } : {},
|
|
109
|
+
...options.facets?.length ? { facets: options.facets } : {}
|
|
110
|
+
};
|
|
111
|
+
}
|
|
112
|
+
function arbitrarySql(siteId, range, sql, options = {}) {
|
|
113
|
+
return {
|
|
114
|
+
archetype: "arbitrary-sql",
|
|
115
|
+
siteId,
|
|
116
|
+
searchType: options.searchType ?? "web",
|
|
117
|
+
range: archetypeRange(range),
|
|
118
|
+
sql,
|
|
119
|
+
...options.params ? { params: options.params } : {},
|
|
120
|
+
...options.cacheable ? { cacheable: true } : {}
|
|
121
|
+
};
|
|
122
|
+
}
|
|
123
|
+
function auxCloudOnly(siteId, dataset, params) {
|
|
124
|
+
return {
|
|
125
|
+
archetype: "aux-cloud-only",
|
|
126
|
+
siteId,
|
|
127
|
+
dataset,
|
|
128
|
+
...params ? { params } : {}
|
|
129
|
+
};
|
|
130
|
+
}
|
|
131
|
+
export { ARCHETYPE_EXECUTION_CLASS, arbitrarySql, auxCloudOnly, entityDailySparkline, entityDailyTimeseries, multiSeriesStackedDaily, singleRowLookup, siteDailyTimeseries, topNBreakdown, twoDimensionDetail };
|
package/dist/index.d.mts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { addPartnerTeamMemberSchema, analyticsEndpointSchemas, analyticsRoutes, backfillRangeSchema, backfillResponseSchema, bindPartnerSiteTeamSchema, builderStateSchema, bulkRegisterPartnerSitesResponseSchema, bulkRegisterPartnerSitesSchema, canonicalWebhookEventTypeSchema, countriesResponseSchema, countryRowSchema, createPartnerTeamSchema, dataDetailOptionsSchema, dataQueryOptionsSchema, gscApiRangeSchema, gscComparisonFilterSchema, gscRowQueryMetaSchema, gscRowQueryResponseSchema, gscdumpAnalysisParamsSchema, gscdumpAnalysisPresetSchema, gscdumpAnalysisResponseSchema, gscdumpAnalysisSourcesResponseSchema, gscdumpAvailableSiteSchema, gscdumpCanonicalMismatchesResponseSchema, gscdumpDataDetailResponseSchema, gscdumpDataResponseSchema, gscdumpDataRowSchema, gscdumpDateRangeParamsSchema, gscdumpDeletePartnerUserResponseSchema, gscdumpHealthResponseSchema, gscdumpIndexPercentParamsSchema, gscdumpIndexPercentResponseSchema, gscdumpIndexingDiagnosticsResponseSchema, gscdumpIndexingResponseSchema, gscdumpIndexingUrlsResponseSchema, gscdumpKeywordSparklinesParamsSchema, gscdumpKeywordSparklinesResponseSchema, gscdumpMetaSchema, gscdumpPageTrendParamsSchema, gscdumpPageTrendResponseSchema, gscdumpPermissionRecoverySchema, gscdumpQueryTrendParamsSchema, gscdumpQueryTrendResponseSchema, gscdumpSiteRegistrationSchema, gscdumpSiteReportResponseSchema, gscdumpSitemapChangesResponseSchema, gscdumpSitemapsResponseSchema, gscdumpSyncJobsResponseSchema, gscdumpSyncProgressResponseSchema, gscdumpTeamMemberRowSchema, gscdumpTeamRoleSchema, gscdumpTeamRowSchema, gscdumpTopAssociationParamsSchema, gscdumpTopAssociationResponseSchema, gscdumpTotalsSchema, gscdumpUserMeResponseSchema, gscdumpUserRegistrationSchema, gscdumpUserSettingsSchema, gscdumpUserSiteSchema, gscdumpUserStatusSchema, indexingDiagnosticsParamsSchema, indexingDiagnosticsSchema, indexingInspectAnyResponseSchema, indexingInspectRateLimitedSchema, indexingInspectRequestSchema, indexingInspectResponseSchema, indexingInspectResultSchema, indexingIssueSchema, indexingUrlRowSchema, indexingUrlStatusSchema, indexingUrlsParamsSchema, indexingUrlsResponseSchema, inspectionHistoryRecordSchema, inspectionHistoryResponseSchema, inspectionIndexSchema, inspectionRecordRawSchema, jobFailedWebhookPayloadSchema, lifecycleErrorSchema, lifecycleProgressSchema, partnerControlEndpointSchemas, partnerEndpointSchemas, partnerLifecycleAccountSchema, partnerLifecycleResponseSchema, partnerLifecycleSiteSchema, partnerRealtimeEventSchema, partnerRoutes, partnerWebhookDataSchema, partnerWebhookEnvelopeSchema, registerPartnerSiteSchema, registerPartnerUserSchema, rollupEnvelopeSchema, scheduleStateSchema, searchAppearanceResponseSchema, searchAppearanceRowSchema, searchTypeSchema, siteListItemSchema, sitemapChangesResponseSchema, sitemapHistoryRecordSchema, sitemapHistoryResponseSchema, sitemapIndexSchema, sourceInfoResponseSchema, teamCatalogRefSchema, updatePartnerUserTokensSchema, webhookEventTypeSchema, whoamiResponseSchema } from "./_chunks/schemas.mjs";
|
|
2
|
-
import { AccountNextAction, AccountStatus, AddPartnerTeamMemberParams, AnalysisSourcesOptions, AnalysisSourcesResponse, AnalyticsClient, AnalyticsNextAction, AnalyticsStatus, BackfillRange, BackfillResponse, BindPartnerSiteTeamParams, BuilderState, BulkRegisterPartnerSiteResult, BulkRegisterPartnerSitesParams, BulkRegisterPartnerSitesResponse, CanonicalWebhookEventType, ColumnDef, ColumnType, CountriesResponse, CountryRow, CreatePartnerTeamParams, CreateWebhookEnvelopeOptions, DataDetailOptions, DataQueryOptions, DeletePartnerUserResponse, Dimension, FileResolutionRequest, FileResolutionResponse, FileResolutionTable, Filter, GSCDUMP_ONBOARDING_CONTRACT_VERSION, GSCDUMP_OPTIONAL_INDEXING_SCOPE, GSCDUMP_REQUIRED_ANALYTICS_SCOPE, GSCDUMP_WRITE_ANALYTICS_SCOPE, Grain, GscApiRange, GscComparisonFilter, GscRowQueryMeta, GscRowQueryResponse, GscSearchType, GscdumpAnalysisParams, GscdumpAnalysisPreset, GscdumpAnalysisResponse, GscdumpAnalysisSourcesResponse, GscdumpAvailableSite, GscdumpCanonicalMismatchRow, GscdumpCanonicalMismatchesResponse, GscdumpDataDetailResponse, GscdumpDataResponse, GscdumpDataRow, GscdumpDateRangeParams, GscdumpHealthResponse, GscdumpIndexPercentResponse, GscdumpIndexPercentSitemap, GscdumpIndexPercentTrendPoint, GscdumpIndexingDiagnosticsResponse, GscdumpIndexingInspectRateLimited, GscdumpIndexingInspectRequest, GscdumpIndexingInspectResponse, GscdumpIndexingInspectResult, GscdumpIndexingIssueSeverity, GscdumpIndexingResponse, GscdumpIndexingTrendPoint, GscdumpIndexingUrl, GscdumpIndexingUrlStatus, GscdumpIndexingUrlsResponse, GscdumpInvisibleUrlRow, GscdumpKeywordSparklinesParams, GscdumpKeywordSparklinesResponse, GscdumpMeta, GscdumpOrphanPageRow, GscdumpPageTrendParams, GscdumpPageTrendResponse, GscdumpPerSitemapHistoryEntry, GscdumpPermissionRecovery, GscdumpQueryTrendParams, GscdumpQueryTrendResponse, GscdumpRichResultItem, GscdumpSiteRegistration, GscdumpSiteReportResponse, GscdumpSitemap, GscdumpSitemapChangesResponse, GscdumpSitemapHistory, GscdumpSitemapsResponse, GscdumpSyncJobItem, GscdumpSyncJobStatus, GscdumpSyncJobsQueueCounts, GscdumpSyncJobsResponse, GscdumpSyncProgressDateStatus, GscdumpSyncProgressPhaseCounts, GscdumpSyncProgressResponse, GscdumpSyncProgressSite, GscdumpSyncStatusResponse, GscdumpTeamMemberRow, GscdumpTeamRow, GscdumpTopAssociationParams, GscdumpTopAssociationResponse, GscdumpTotals, GscdumpUserMeResponse, GscdumpUserRegistration, GscdumpUserSettings, GscdumpUserSite, GscdumpUserStatus, GscdumpUserTokenUpdate, IndexingDiagnostics, IndexingDiagnosticsParams, IndexingInspectRateLimit, IndexingInspectRateLimited, IndexingInspectRequest, IndexingInspectResponse, IndexingInspectResult, IndexingIssue, IndexingIssueSeverity, IndexingNextAction, IndexingStatus, IndexingUrlRow, IndexingUrlStatus, IndexingUrlsParams, IndexingUrlsResponse, InspectionHistoryRecord, InspectionHistoryResponse, InspectionIndex, InspectionRecordRaw, LifecycleError, LifecycleErrorCode, LifecycleProgress, LifecycleWebhookEnvelope, LifecycleWebhookEvent, Metric, PartnerClient, PartnerLifecycleAccount, PartnerLifecycleResponse, PartnerLifecycleSite,
|
|
3
|
-
import { ARCHETYPE_EXECUTION_CLASS, ArbitrarySqlQuery, ArchetypeExecutionClass, ArchetypeFacet, ArchetypeQuery, ArchetypeQueryBase, ArchetypeResult, ArchetypeResultRow, ArchetypeResultSource, AuxCloudOnlyQuery, DateRange, EntityDailySparklineQuery, EntityDailyTimeseriesQuery, MultiSeriesStackedDailyQuery, QueryArchetype, ResolvedArchetypeQuery, SingleRowLookupQuery, SiteDailyTimeseriesQuery, TopNBreakdownQuery, TwoDimensionDetailQuery } from "./archetypes.mjs";
|
|
1
|
+
import { addPartnerTeamMemberSchema, analyticsEndpointSchemas, analyticsRoutes, backfillRangeSchema, backfillResponseSchema, bindPartnerSiteTeamSchema, builderStateSchema, bulkRegisterPartnerSitesResponseSchema, bulkRegisterPartnerSitesSchema, canonicalWebhookEventTypeSchema, countriesResponseSchema, countryRowSchema, createPartnerTeamSchema, dataDetailOptionsSchema, dataQueryOptionsSchema, gscApiRangeSchema, gscComparisonFilterSchema, gscRowQueryMetaSchema, gscRowQueryResponseSchema, gscdumpAnalysisBaseParamsSchema, gscdumpAnalysisBundleParamsSchema, gscdumpAnalysisBundleResponseSchema, gscdumpAnalysisMetaSchema, gscdumpAnalysisParamsSchema, gscdumpAnalysisPresetSchema, gscdumpAnalysisResponseSchema, gscdumpAnalysisSourcesResponseSchema, gscdumpAvailableSiteSchema, gscdumpCanonicalMismatchesResponseSchema, gscdumpDataDetailResponseSchema, gscdumpDataResponseSchema, gscdumpDataRowSchema, gscdumpDateRangeParamsSchema, gscdumpDeletePartnerUserResponseSchema, gscdumpHealthResponseSchema, gscdumpIndexPercentParamsSchema, gscdumpIndexPercentResponseSchema, gscdumpIndexingDiagnosticsResponseSchema, gscdumpIndexingResponseSchema, gscdumpIndexingUrlsResponseSchema, gscdumpKeywordSparklinesParamsSchema, gscdumpKeywordSparklinesResponseSchema, gscdumpMetaSchema, gscdumpPageTrendParamsSchema, gscdumpPageTrendResponseSchema, gscdumpPermissionRecoverySchema, gscdumpQueryTrendParamsSchema, gscdumpQueryTrendResponseSchema, gscdumpSiteRegistrationSchema, gscdumpSiteReportResponseSchema, gscdumpSitemapChangesResponseSchema, gscdumpSitemapsResponseSchema, gscdumpSyncJobsResponseSchema, gscdumpSyncProgressResponseSchema, gscdumpTeamMemberRowSchema, gscdumpTeamRoleSchema, gscdumpTeamRowSchema, gscdumpTopAssociationParamsSchema, gscdumpTopAssociationResponseSchema, gscdumpTotalsSchema, gscdumpUserMeResponseSchema, gscdumpUserRegistrationSchema, gscdumpUserSettingsSchema, gscdumpUserSiteSchema, gscdumpUserStatusSchema, indexingDiagnosticsParamsSchema, indexingDiagnosticsSchema, indexingInspectAnyResponseSchema, indexingInspectRateLimitedSchema, indexingInspectRequestSchema, indexingInspectResponseSchema, indexingInspectResultSchema, indexingIssueSchema, indexingUrlRowSchema, indexingUrlStatusSchema, indexingUrlsParamsSchema, indexingUrlsResponseSchema, inspectionHistoryRecordSchema, inspectionHistoryResponseSchema, inspectionIndexSchema, inspectionRecordRawSchema, jobFailedWebhookPayloadSchema, lifecycleErrorSchema, lifecycleProgressSchema, partnerControlEndpointSchemas, partnerEndpointSchemas, partnerLifecycleAccountSchema, partnerLifecycleResponseSchema, partnerLifecycleSiteSchema, partnerRealtimeEventSchema, partnerRoutes, partnerWebhookDataSchema, partnerWebhookEnvelopeSchema, registerPartnerSiteSchema, registerPartnerUserSchema, rollupEnvelopeSchema, scheduleStateSchema, searchAppearanceResponseSchema, searchAppearanceRowSchema, searchTypeSchema, siteListItemSchema, sitemapChangesResponseSchema, sitemapHistoryRecordSchema, sitemapHistoryResponseSchema, sitemapIndexSchema, sourceInfoResponseSchema, teamCatalogRefSchema, updatePartnerUserTokensSchema, webhookEventTypeSchema, whoamiResponseSchema } from "./_chunks/schemas.mjs";
|
|
2
|
+
import { AccountNextAction, AccountStatus, AddPartnerTeamMemberParams, AnalysisSourcesOptions, AnalysisSourcesResponse, AnalyticsClient, AnalyticsNextAction, AnalyticsStatus, BackfillRange, BackfillResponse, BindPartnerSiteTeamParams, BuilderState, BulkRegisterPartnerSiteResult, BulkRegisterPartnerSitesParams, BulkRegisterPartnerSitesResponse, CanonicalWebhookEventType, ColumnDef, ColumnType, CountriesResponse, CountryRow, CreatePartnerTeamParams, CreateWebhookEnvelopeOptions, DataDetailOptions, DataQueryOptions, DeletePartnerUserResponse, Dimension, FileResolutionRequest, FileResolutionResponse, FileResolutionTable, Filter, GSCDUMP_ONBOARDING_CONTRACT_VERSION, GSCDUMP_OPTIONAL_INDEXING_SCOPE, GSCDUMP_REQUIRED_ANALYTICS_SCOPE, GSCDUMP_WRITE_ANALYTICS_SCOPE, Grain, GscApiRange, GscComparisonFilter, GscRowQueryMeta, GscRowQueryResponse, GscSearchType, GscdumpAnalysisBundleParams, GscdumpAnalysisBundleResponse, GscdumpAnalysisParams, GscdumpAnalysisPreset, GscdumpAnalysisResponse, GscdumpAnalysisSourcesResponse, GscdumpAvailableSite, GscdumpCanonicalMismatchRow, GscdumpCanonicalMismatchesResponse, GscdumpDataDetailResponse, GscdumpDataResponse, GscdumpDataRow, GscdumpDateRangeParams, GscdumpHealthResponse, GscdumpIndexPercentResponse, GscdumpIndexPercentSitemap, GscdumpIndexPercentTrendPoint, GscdumpIndexingDiagnosticsResponse, GscdumpIndexingInspectRateLimited, GscdumpIndexingInspectRequest, GscdumpIndexingInspectResponse, GscdumpIndexingInspectResult, GscdumpIndexingIssueSeverity, GscdumpIndexingResponse, GscdumpIndexingTrendPoint, GscdumpIndexingUrl, GscdumpIndexingUrlStatus, GscdumpIndexingUrlsResponse, GscdumpInvisibleUrlRow, GscdumpKeywordSparklinesParams, GscdumpKeywordSparklinesResponse, GscdumpMeta, GscdumpOrphanPageRow, GscdumpPageTrendParams, GscdumpPageTrendResponse, GscdumpPerSitemapHistoryEntry, GscdumpPermissionRecovery, GscdumpQueryTrendParams, GscdumpQueryTrendResponse, GscdumpRichResultItem, GscdumpSiteRegistration, GscdumpSiteReportResponse, GscdumpSitemap, GscdumpSitemapChangesResponse, GscdumpSitemapHistory, GscdumpSitemapsResponse, GscdumpSyncJobItem, GscdumpSyncJobStatus, GscdumpSyncJobsQueueCounts, GscdumpSyncJobsResponse, GscdumpSyncProgressDateStatus, GscdumpSyncProgressPhaseCounts, GscdumpSyncProgressResponse, GscdumpSyncProgressSite, GscdumpSyncStatusResponse, GscdumpTeamMemberRow, GscdumpTeamRow, GscdumpTopAssociationParams, GscdumpTopAssociationResponse, GscdumpTotals, GscdumpUserMeResponse, GscdumpUserRegistration, GscdumpUserSettings, GscdumpUserSite, GscdumpUserStatus, GscdumpUserTokenUpdate, IndexingDiagnostics, IndexingDiagnosticsParams, IndexingInspectRateLimit, IndexingInspectRateLimited, IndexingInspectRequest, IndexingInspectResponse, IndexingInspectResult, IndexingIssue, IndexingIssueSeverity, IndexingNextAction, IndexingStatus, IndexingUrlRow, IndexingUrlStatus, IndexingUrlsParams, IndexingUrlsResponse, InspectionHistoryRecord, InspectionHistoryResponse, InspectionIndex, InspectionRecordRaw, LifecycleError, LifecycleErrorCode, LifecycleProgress, LifecycleWebhookEnvelope, LifecycleWebhookEvent, Metric, PartnerClient, PartnerLifecycleAccount, PartnerLifecycleResponse, PartnerLifecycleSite, PartnerWebhookData, PartnerWebhookHeaders, PropertyNextAction, PropertyStatus, QuerySourceMode, RegisterPartnerSiteParams, RegisterPartnerUserParams, ResolvedParquetFile, ResolvedTable, RollupEnvelope, Row, ScheduleState, SearchAppearanceResponse, SearchAppearanceRow, SearchTypeOptions, ServerTailDirective, SiteListItem, SitemapAddedRow, SitemapChangesResponse, SitemapHistoryRecord, SitemapHistoryResponse, SitemapIndex, SitemapNextAction, SitemapRemovedRow, SitemapStatus, SourceInfoOptions, SourceInfoResponse, TableName, TableSchema, TenantCtx, UpdatePartnerUserTokensParams, WebhookEnvelope, WebhookEventType, WhoamiResponse, accountNextActions, accountStatuses, analyticsNextActions, analyticsStatuses, hasOptionalIndexingScope, hasRequiredAnalyticsScope, indexingNextActions, indexingStatuses, lifecycleErrorCodes, lifecycleWebhookEvents, parseGrantedScopes, propertyNextActions, propertyStatuses, querySourceModes, sitemapNextActions, sitemapStatuses } from "./_chunks/types.mjs";
|
|
3
|
+
import { ARCHETYPE_EXECUTION_CLASS, ArbitrarySqlQuery, ArchetypeExecutionClass, ArchetypeFacet, ArchetypeQuery, ArchetypeQueryBase, ArchetypeResult, ArchetypeResultRow, ArchetypeResultSource, AuxCloudOnlyQuery, DateRange, EntityDailySparklineQuery, EntityDailyTimeseriesQuery, MultiSeriesStackedDailyQuery, QueryArchetype, ResolvedArchetypeQuery, SingleRowLookupQuery, SiteDailyTimeseriesQuery, TopNBreakdownOptions, TopNBreakdownQuery, TwoDimensionDetailOptions, TwoDimensionDetailQuery, WireDateRange, arbitrarySql, auxCloudOnly, entityDailySparkline, entityDailyTimeseries, multiSeriesStackedDaily, singleRowLookup, siteDailyTimeseries, topNBreakdown, twoDimensionDetail } from "./archetypes.mjs";
|
|
4
4
|
import { CANONICAL_WEBHOOK_EVENTS, VALID_WEBHOOK_EVENTS, WEBHOOK_CONTRACT_VERSION, WEBHOOK_CONTRACT_VERSION_HEADER, WEBHOOK_DELIVERY_HEADER, WEBHOOK_EVENT_HEADER, WEBHOOK_SIGNATURE_HEADER, WEBHOOK_TIMESTAMP_HEADER } from "./_chunks/webhook-constants.mjs";
|
|
5
|
-
export { ARCHETYPE_EXECUTION_CLASS, AccountNextAction, AccountStatus, type AddPartnerTeamMemberParams, type AnalysisSourcesOptions, type AnalysisSourcesResponse, type AnalyticsClient, AnalyticsNextAction, AnalyticsStatus, ArbitrarySqlQuery, ArchetypeExecutionClass, ArchetypeFacet, ArchetypeQuery, ArchetypeQueryBase, ArchetypeResult, ArchetypeResultRow, ArchetypeResultSource, AuxCloudOnlyQuery, type BackfillRange, type BackfillResponse, type BindPartnerSiteTeamParams, type BuilderState, type BulkRegisterPartnerSiteResult, type BulkRegisterPartnerSitesParams, type BulkRegisterPartnerSitesResponse, CANONICAL_WEBHOOK_EVENTS, type CanonicalWebhookEventType, type ColumnDef, type ColumnType, type CountriesResponse, type CountryRow, type CreatePartnerTeamParams, type CreateWebhookEnvelopeOptions, type DataDetailOptions, type DataQueryOptions, DateRange, type DeletePartnerUserResponse, type Dimension, EntityDailySparklineQuery, EntityDailyTimeseriesQuery, type FileResolutionRequest, type FileResolutionResponse, type FileResolutionTable, type Filter, GSCDUMP_ONBOARDING_CONTRACT_VERSION, GSCDUMP_OPTIONAL_INDEXING_SCOPE, GSCDUMP_REQUIRED_ANALYTICS_SCOPE, GSCDUMP_WRITE_ANALYTICS_SCOPE, type Grain, type GscApiRange, type GscComparisonFilter, type GscRowQueryMeta, type GscRowQueryResponse, type GscSearchType, type GscdumpAnalysisParams, type GscdumpAnalysisPreset, type GscdumpAnalysisResponse, type GscdumpAnalysisSourcesResponse, type GscdumpAvailableSite, type GscdumpCanonicalMismatchRow, type GscdumpCanonicalMismatchesResponse, type GscdumpDataDetailResponse, type GscdumpDataResponse, type GscdumpDataRow, type GscdumpDateRangeParams, type GscdumpHealthResponse, type GscdumpIndexPercentResponse, type GscdumpIndexPercentSitemap, type GscdumpIndexPercentTrendPoint, type GscdumpIndexingDiagnosticsResponse, type GscdumpIndexingInspectRateLimited, type GscdumpIndexingInspectRequest, type GscdumpIndexingInspectResponse, type GscdumpIndexingInspectResult, type GscdumpIndexingIssueSeverity, type GscdumpIndexingResponse, type GscdumpIndexingTrendPoint, type GscdumpIndexingUrl, type GscdumpIndexingUrlStatus, type GscdumpIndexingUrlsResponse, type GscdumpInvisibleUrlRow, type GscdumpKeywordSparklinesParams, type GscdumpKeywordSparklinesResponse, type GscdumpMeta, type GscdumpOrphanPageRow, type GscdumpPageTrendParams, type GscdumpPageTrendResponse, type GscdumpPerSitemapHistoryEntry, type GscdumpPermissionRecovery, type GscdumpQueryTrendParams, type GscdumpQueryTrendResponse, type GscdumpRichResultItem, type GscdumpSiteRegistration, type GscdumpSiteReportResponse, type GscdumpSitemap, type GscdumpSitemapChangesResponse, type GscdumpSitemapHistory, type GscdumpSitemapsResponse, type GscdumpSyncJobItem, type GscdumpSyncJobStatus, type GscdumpSyncJobsQueueCounts, type GscdumpSyncJobsResponse, type GscdumpSyncProgressDateStatus, type GscdumpSyncProgressPhaseCounts, type GscdumpSyncProgressResponse, type GscdumpSyncProgressSite, type GscdumpSyncStatusResponse, type GscdumpTeamMemberRow, type GscdumpTeamRow, type GscdumpTopAssociationParams, type GscdumpTopAssociationResponse, type GscdumpTotals, type GscdumpUserMeResponse, type GscdumpUserRegistration, type GscdumpUserSettings, type GscdumpUserSite, type GscdumpUserStatus, type GscdumpUserTokenUpdate, type IndexingDiagnostics, type IndexingDiagnosticsParams, type IndexingInspectRateLimit, type IndexingInspectRateLimited, type IndexingInspectRequest, type IndexingInspectResponse, type IndexingInspectResult, type IndexingIssue, type IndexingIssueSeverity, IndexingNextAction, IndexingStatus, type IndexingUrlRow, type IndexingUrlStatus, type IndexingUrlsParams, type IndexingUrlsResponse, type InspectionHistoryRecord, type InspectionHistoryResponse, type InspectionIndex, type InspectionRecordRaw, LifecycleError, LifecycleErrorCode, LifecycleProgress, LifecycleWebhookEnvelope, LifecycleWebhookEvent, type Metric, MultiSeriesStackedDailyQuery, type PartnerClient, PartnerLifecycleAccount, PartnerLifecycleResponse, PartnerLifecycleSite, type
|
|
5
|
+
export { ARCHETYPE_EXECUTION_CLASS, AccountNextAction, AccountStatus, type AddPartnerTeamMemberParams, type AnalysisSourcesOptions, type AnalysisSourcesResponse, type AnalyticsClient, AnalyticsNextAction, AnalyticsStatus, ArbitrarySqlQuery, ArchetypeExecutionClass, ArchetypeFacet, ArchetypeQuery, ArchetypeQueryBase, ArchetypeResult, ArchetypeResultRow, ArchetypeResultSource, AuxCloudOnlyQuery, type BackfillRange, type BackfillResponse, type BindPartnerSiteTeamParams, type BuilderState, type BulkRegisterPartnerSiteResult, type BulkRegisterPartnerSitesParams, type BulkRegisterPartnerSitesResponse, CANONICAL_WEBHOOK_EVENTS, type CanonicalWebhookEventType, type ColumnDef, type ColumnType, type CountriesResponse, type CountryRow, type CreatePartnerTeamParams, type CreateWebhookEnvelopeOptions, type DataDetailOptions, type DataQueryOptions, DateRange, type DeletePartnerUserResponse, type Dimension, EntityDailySparklineQuery, EntityDailyTimeseriesQuery, type FileResolutionRequest, type FileResolutionResponse, type FileResolutionTable, type Filter, GSCDUMP_ONBOARDING_CONTRACT_VERSION, GSCDUMP_OPTIONAL_INDEXING_SCOPE, GSCDUMP_REQUIRED_ANALYTICS_SCOPE, GSCDUMP_WRITE_ANALYTICS_SCOPE, type Grain, type GscApiRange, type GscComparisonFilter, type GscRowQueryMeta, type GscRowQueryResponse, type GscSearchType, type GscdumpAnalysisBundleParams, type GscdumpAnalysisBundleResponse, type GscdumpAnalysisParams, type GscdumpAnalysisPreset, type GscdumpAnalysisResponse, type GscdumpAnalysisSourcesResponse, type GscdumpAvailableSite, type GscdumpCanonicalMismatchRow, type GscdumpCanonicalMismatchesResponse, type GscdumpDataDetailResponse, type GscdumpDataResponse, type GscdumpDataRow, type GscdumpDateRangeParams, type GscdumpHealthResponse, type GscdumpIndexPercentResponse, type GscdumpIndexPercentSitemap, type GscdumpIndexPercentTrendPoint, type GscdumpIndexingDiagnosticsResponse, type GscdumpIndexingInspectRateLimited, type GscdumpIndexingInspectRequest, type GscdumpIndexingInspectResponse, type GscdumpIndexingInspectResult, type GscdumpIndexingIssueSeverity, type GscdumpIndexingResponse, type GscdumpIndexingTrendPoint, type GscdumpIndexingUrl, type GscdumpIndexingUrlStatus, type GscdumpIndexingUrlsResponse, type GscdumpInvisibleUrlRow, type GscdumpKeywordSparklinesParams, type GscdumpKeywordSparklinesResponse, type GscdumpMeta, type GscdumpOrphanPageRow, type GscdumpPageTrendParams, type GscdumpPageTrendResponse, type GscdumpPerSitemapHistoryEntry, type GscdumpPermissionRecovery, type GscdumpQueryTrendParams, type GscdumpQueryTrendResponse, type GscdumpRichResultItem, type GscdumpSiteRegistration, type GscdumpSiteReportResponse, type GscdumpSitemap, type GscdumpSitemapChangesResponse, type GscdumpSitemapHistory, type GscdumpSitemapsResponse, type GscdumpSyncJobItem, type GscdumpSyncJobStatus, type GscdumpSyncJobsQueueCounts, type GscdumpSyncJobsResponse, type GscdumpSyncProgressDateStatus, type GscdumpSyncProgressPhaseCounts, type GscdumpSyncProgressResponse, type GscdumpSyncProgressSite, type GscdumpSyncStatusResponse, type GscdumpTeamMemberRow, type GscdumpTeamRow, type GscdumpTopAssociationParams, type GscdumpTopAssociationResponse, type GscdumpTotals, type GscdumpUserMeResponse, type GscdumpUserRegistration, type GscdumpUserSettings, type GscdumpUserSite, type GscdumpUserStatus, type GscdumpUserTokenUpdate, type IndexingDiagnostics, type IndexingDiagnosticsParams, type IndexingInspectRateLimit, type IndexingInspectRateLimited, type IndexingInspectRequest, type IndexingInspectResponse, type IndexingInspectResult, type IndexingIssue, type IndexingIssueSeverity, IndexingNextAction, IndexingStatus, type IndexingUrlRow, type IndexingUrlStatus, type IndexingUrlsParams, type IndexingUrlsResponse, type InspectionHistoryRecord, type InspectionHistoryResponse, type InspectionIndex, type InspectionRecordRaw, LifecycleError, LifecycleErrorCode, LifecycleProgress, LifecycleWebhookEnvelope, LifecycleWebhookEvent, type Metric, MultiSeriesStackedDailyQuery, type PartnerClient, PartnerLifecycleAccount, PartnerLifecycleResponse, PartnerLifecycleSite, type PartnerWebhookData, type PartnerWebhookHeaders, PropertyNextAction, PropertyStatus, QueryArchetype, QuerySourceMode, type RegisterPartnerSiteParams, type RegisterPartnerUserParams, ResolvedArchetypeQuery, type ResolvedParquetFile, type ResolvedTable, type RollupEnvelope, type Row, type ScheduleState, type SearchAppearanceResponse, type SearchAppearanceRow, type SearchTypeOptions, type ServerTailDirective, SingleRowLookupQuery, SiteDailyTimeseriesQuery, type SiteListItem, type SitemapAddedRow, type SitemapChangesResponse, type SitemapHistoryRecord, type SitemapHistoryResponse, type SitemapIndex, SitemapNextAction, type SitemapRemovedRow, SitemapStatus, type SourceInfoOptions, type SourceInfoResponse, type TableName, type TableSchema, type TenantCtx, TopNBreakdownOptions, TopNBreakdownQuery, TwoDimensionDetailOptions, TwoDimensionDetailQuery, type UpdatePartnerUserTokensParams, VALID_WEBHOOK_EVENTS, WEBHOOK_CONTRACT_VERSION, WEBHOOK_CONTRACT_VERSION_HEADER, WEBHOOK_DELIVERY_HEADER, WEBHOOK_EVENT_HEADER, WEBHOOK_SIGNATURE_HEADER, WEBHOOK_TIMESTAMP_HEADER, type WebhookEnvelope, type WebhookEventType, type WhoamiResponse, WireDateRange, accountNextActions, accountStatuses, addPartnerTeamMemberSchema, analyticsEndpointSchemas, analyticsNextActions, analyticsRoutes, analyticsStatuses, arbitrarySql, auxCloudOnly, backfillRangeSchema, backfillResponseSchema, bindPartnerSiteTeamSchema, builderStateSchema, bulkRegisterPartnerSitesResponseSchema, bulkRegisterPartnerSitesSchema, canonicalWebhookEventTypeSchema, countriesResponseSchema, countryRowSchema, createPartnerTeamSchema, dataDetailOptionsSchema, dataQueryOptionsSchema, entityDailySparkline, entityDailyTimeseries, gscApiRangeSchema, gscComparisonFilterSchema, gscRowQueryMetaSchema, gscRowQueryResponseSchema, gscdumpAnalysisBaseParamsSchema, gscdumpAnalysisBundleParamsSchema, gscdumpAnalysisBundleResponseSchema, gscdumpAnalysisMetaSchema, gscdumpAnalysisParamsSchema, gscdumpAnalysisPresetSchema, gscdumpAnalysisResponseSchema, gscdumpAnalysisSourcesResponseSchema, gscdumpAvailableSiteSchema, gscdumpCanonicalMismatchesResponseSchema, gscdumpDataDetailResponseSchema, gscdumpDataResponseSchema, gscdumpDataRowSchema, gscdumpDateRangeParamsSchema, gscdumpDeletePartnerUserResponseSchema, gscdumpHealthResponseSchema, gscdumpIndexPercentParamsSchema, gscdumpIndexPercentResponseSchema, gscdumpIndexingDiagnosticsResponseSchema, gscdumpIndexingResponseSchema, gscdumpIndexingUrlsResponseSchema, gscdumpKeywordSparklinesParamsSchema, gscdumpKeywordSparklinesResponseSchema, gscdumpMetaSchema, gscdumpPageTrendParamsSchema, gscdumpPageTrendResponseSchema, gscdumpPermissionRecoverySchema, gscdumpQueryTrendParamsSchema, gscdumpQueryTrendResponseSchema, gscdumpSiteRegistrationSchema, gscdumpSiteReportResponseSchema, gscdumpSitemapChangesResponseSchema, gscdumpSitemapsResponseSchema, gscdumpSyncJobsResponseSchema, gscdumpSyncProgressResponseSchema, gscdumpTeamMemberRowSchema, gscdumpTeamRoleSchema, gscdumpTeamRowSchema, gscdumpTopAssociationParamsSchema, gscdumpTopAssociationResponseSchema, gscdumpTotalsSchema, gscdumpUserMeResponseSchema, gscdumpUserRegistrationSchema, gscdumpUserSettingsSchema, gscdumpUserSiteSchema, gscdumpUserStatusSchema, hasOptionalIndexingScope, hasRequiredAnalyticsScope, indexingDiagnosticsParamsSchema, indexingDiagnosticsSchema, indexingInspectAnyResponseSchema, indexingInspectRateLimitedSchema, indexingInspectRequestSchema, indexingInspectResponseSchema, indexingInspectResultSchema, indexingIssueSchema, indexingNextActions, indexingStatuses, indexingUrlRowSchema, indexingUrlStatusSchema, indexingUrlsParamsSchema, indexingUrlsResponseSchema, inspectionHistoryRecordSchema, inspectionHistoryResponseSchema, inspectionIndexSchema, inspectionRecordRawSchema, jobFailedWebhookPayloadSchema, lifecycleErrorCodes, lifecycleErrorSchema, lifecycleProgressSchema, lifecycleWebhookEvents, multiSeriesStackedDaily, parseGrantedScopes, partnerControlEndpointSchemas, partnerEndpointSchemas, partnerLifecycleAccountSchema, partnerLifecycleResponseSchema, partnerLifecycleSiteSchema, partnerRealtimeEventSchema, partnerRoutes, partnerWebhookDataSchema, partnerWebhookEnvelopeSchema, propertyNextActions, propertyStatuses, querySourceModes, registerPartnerSiteSchema, registerPartnerUserSchema, rollupEnvelopeSchema, scheduleStateSchema, searchAppearanceResponseSchema, searchAppearanceRowSchema, searchTypeSchema, singleRowLookup, siteDailyTimeseries, siteListItemSchema, sitemapChangesResponseSchema, sitemapHistoryRecordSchema, sitemapHistoryResponseSchema, sitemapIndexSchema, sitemapNextActions, sitemapStatuses, sourceInfoResponseSchema, teamCatalogRefSchema, topNBreakdown, twoDimensionDetail, updatePartnerUserTokensSchema, webhookEventTypeSchema, whoamiResponseSchema };
|