@gscdump/engine-gsc-api

中文文档
7.15.0发布于 2026/11/16MITTypeScriptES Module构建来源已验证近 30 天下载 9266

GSC live-API engine adapter — wraps the Search Analytics REST API as an AnalysisQuerySource for typed analyzer dispatch.

原始使用文档
文档目录7 节
  1. Install
  2. Query live rows
  3. Deferred authentication
  4. Exports
  5. Plan stored Sync work
  6. Limits and fallback
  7. License

@gscdump/engine-gsc-api

npm version npm downloads license

Use Google Search Console as an AnalysisQuerySource. This adapter runs Analyzers with row plans without a local Store.

Install

npm install @gscdump/engine-gsc-api @gscdump/analysis gscdump

Query live rows

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)

See @gscdump/analysis for Analyzer dispatch.

Deferred authentication

createLiveGscSource({ siteUrl, getAccessToken }) calls your token function on the first query. It reuses the resulting client for that Source's lifetime. Create a Source per request if your host manages token refresh between requests.

Exports

ExportPurpose
createGscApiQuerySourceWrap a Google client as a Source
createLiveGscSourceCreate a Source with deferred token lookup
canProxyToGscCheck whether query inputs support live routing
fetchGscTopNRead top rows for a dimension and date range
fetchGscDailyRead daily metrics
runGscSyncSliceRead a bounded Search Analytics sync slice
runGscSearchAppearanceContextSliceRead a Search Appearance context slice
planGscSyncWorkFind ledger gaps and size Sync windows
gscSyncFanoutBuild the standard Search Analytics table fanout
tablesCoveredByGscSyncList the tables a Sync slice must write
ledgerTablesForGscSyncList the ledger tables needed for one fanout
planGscBackfillDatesSelect interior repair or backward Backfill dates

Plan stored Sync work

Pass the dates you want to cover, the planned (table, searchType) fanout, and the dates already committed to your ledger. The plan returns only missing windows. Record zero-row slices in the ledger too, so they do not repeat.

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)
}

The defaults match the hosted Worker's tested window budget. Set rowBudget, maxSpanDays, and maxWindowsPerRun for your own runtime. The window count limit can widen a span beyond maxSpanDays during a long catch-up.

Limits and fallback

The Source supports row queries and regex filters. It has no SQL execution, comparison joins, or Engine-derived dimensions such as queryCanonical. canProxyToGsc rejects malformed inputs, prefilters, and Engine-derived dimensions in selections or filters. Metric filters remain supported after row collection.

createCompositeSource from @gscdump/analysis/source accepts { engine, live, site }. It sends supported queries to Google when stored coverage or dimensions cannot answer them. The site input supplies sync bounds and optional covered date spans. SQL execution uses the Engine.

Google's Search Analytics limits still apply.

License

MIT

版本与发布记录

@gscdump/engine-gsc-api 共发布 262 个版本,首次发布于 2026/04/28;过去 12 个月发布了 262 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
7.15.0latest2026/11/16今天
7.14.02026/11/16今天
7.13.22026/11/151 天前
7.13.12026/11/152 天前
7.13.02026/11/124 天前
7.12.12026/11/116 天前

关于 @gscdump/engine-gsc-api 的常见问题

@gscdump/engine-gsc-api 是什么?

GSC live-API engine adapter — wraps the Search Analytics REST API as an AnalysisQuerySource for typed analyzer dispatch.

如何安装 @gscdump/engine-gsc-api?

在项目目录运行 npm install @gscdump/engine-gsc-api,或使用 pnpm add / yarn add / bun add。

@gscdump/engine-gsc-api 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@gscdump/engine-gsc-api 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@gscdump/engine-gsc-api 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22.13.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@gscdump/engine-gsc-api 可以商用吗?

@gscdump/engine-gsc-api 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@gscdump/engine-gsc-api 的下载量有多少?

根据 npm 官方下载统计,@gscdump/engine-gsc-api 在 2026/10/17 – 2026/11/15 这 30 天内被下载 9,266 次,日均约 309 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gscdump/engine-gsc-api 还在维护吗?

最新版本 7.15.0 发布于 2026/11/16(今天);至今共发布 262 个版本,其中过去 12 个月发布了 262 个;首次发布于 2026/04/28。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。