@gscdump/ engine- gsc- api
使用 Google 搜索主控台作为 AnalysisQuerySource。 。 。 .
这个适配器在无本地 Store 的行图下运行分析器.
安装
npm install @gscdump/engine-gsc-api @gscdump/analysis gscdump
查询活行
import { createGscApiQuerySource } from '@gscdump/engine-gsc-api'
import { googleSearchConsole } from 'gscdump'
import { between, date, gsc, page } from 'gscdump/query'
const client = googleSearchConsole({ accessToken: process.env.GSC_ACCESS_TOKEN! })
const source = createGscApiQuerySource({ client, siteUrl: 'sc-domain:example.com' })
const state = gsc.select(page)
.where(between(date, '2026-08-01', '2026-08-28'))
.limit(100)
.getState()
const rows = await source.queryRows(state)
console.log(rows)
见 @gscdump/analysis 用于分析器调度.
推迟认证
createLiveGscSource({ siteUrl, getAccessToken }) 在第一个查询中调用您的符号函数.
它为源头的一生重用产生的客户端.
如果您的主机在请求之间管理着令牌刷新, 则每个请求创建源 .
出口
| 导出 | 目的 |
|---|---|
createGscApiQuerySource | 将 Google 客户端包成源 |
createLiveGscSource | 以延迟的符号查找创建源 |
canProxyToGsc | 检查查询输入是否支持实时路由 |
fetchGscTopN | 读取一个尺寸和日期范围的上行 |
fetchGscDaily | 每天阅读衡量标准 |
runGscSyncSlice | 读取边框搜索分析同步切片 |
runGscSearchAppearanceContextSlice | 读取搜索外观上下文切片 |
planGscSyncWork | 查找分类账缺口和大小 同步窗口 |
gscSyncFanout | 构建标准搜索分析表扇出 |
tablesCoveredByGscSync | 列出表格,同步切片必须写入 |
ledgerTablesForGscSync | 列出一个扇形图所需的分类表 |
planGscBackfillDates | 选择内部修复或后向填充日期 |
计划存储同步工作
传过去你想要覆盖的日期,计划 (table, searchType) 扇出,和
日期已经输入你的分类账。 计划只返回缺失
窗口。 在分类账中记录零行切片,所以不会重复.
import { gscSyncFanout, planGscSyncWork } from '@gscdump/engine-gsc-api'
const plan = planGscSyncWork({
dates: ['2026-09-01', '2026-09-02'],
fanout: gscSyncFanout(['web'], { omitWebDates: true }),
ledger: [{ table: 'pages', searchType: 'web', date: '2026-09-01' }],
pagesPerDayEstimate: 100,
})
for (const window of plan.windows) {
// Run runGscSyncSlice for this table and date range, then commit its ledger rows.
console.log(window)
}
默认匹配主机Worker测试的窗口预算. 设定 rowBudget, (中文(简体) ),
maxSpanDays,以及 maxWindowsPerRun 为你自己的运行时间。 窗口数
限制可以扩大范围 maxSpanDays 在长时间的追赶中.
限制和后退
源支持行查询和regex过滤.
它没有 SQL 执行、 比较连接或引擎衍生的维度, 例如 queryCanonical。 。 。 .
canProxyToGsc 在选择或过滤中拒绝错误的输入、预过滤和引擎衍生的维度.
收集行后仍然支持度量过滤器 .
createCompositeSource 从 @gscdump/analysis/source 接受 { engine, live, site }。 。 。 .
当存储覆盖或维度无法回答时,它会向谷歌发送支持的查询.
这个 site 输入供给同步约束和可选覆盖日期跨度.
SQL执行使用"引擎".
谷歌的音乐 搜索分析限制 仍然适用.