@gscdump/sdk

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

消费者SDK为主机gscdump.com集成.

中文使用文档

@gscdump/ sdk (英语)

消费者SDK为主机gscdump.com集成.

使用 @gscdump/sdk/v1 hTTP 和实时客户端. 包根没有导出 . 在您的服务器上保留长寿证书 .

npm install @gscdump/sdk
import { createGscdumpV1Client } from '@gscdump/sdk/v1'

const gscdump = createGscdumpV1Client({
  credential: () => process.env.GSCDUMP_API_KEY!,
  fetch,
})

const lifecycle = await gscdump.getUserLifecycle({
  params: { userId: 'u_01' },
})

V1 表面使用服务器持有的 Bearer 证书并曝光通用 操作执行器加所有55个注册的HTTP的打出方便方法 跨伙伴、分析以及实时操作.

重点指南:

createPartnerClient 现为 @gscdump/sdk/partner 仅用于业务 仍在兼容目录中。 已经不用了 可从 @gscdump/sdk/v1。 。 。 .

对纯助推器使用焦点子路径, 包括 period, (中文(简体) ), period-presets, (中文(简体) ), site-triage, (中文(简体) ), site-baseline, (中文(简体) ), search-console-stage, (中文(简体) ), indexing-issues, (中文(简体) ), analytics, (中文(简体) ), partner, (中文(简体) ), partner-errors, (中文(简体) ), lifecycle, (中文(简体) ), webhook,以及 gsc-console-url。 。 。 .

例如,一个输入主机报告查询是:

const report = await gscdump.queryAnalyticsReport({
  params: { siteId: 's_01' },
  body: { state: { dimensions: ['query'], searchType: 'web' } },
})

@gscdump/sdk/indexing 持有纯索引仪表板数学:组合 堆栈和发行数、索引窗口、索引概览、信托 门,索引组, 后退铅, 和组合马克下输出. 每个函数都采集数据并返回数据. 一个今天需要的功能 now。 。 。 .

import { indexingWindow, portfolioIssueCounts, readSiteIndexing } from '@gscdump/sdk/indexing'

const window = indexingWindow('28d', true, new Date())
const sites = reads.map(read => ({ id: read.siteId, label: read.name, trend: readSiteIndexing(read.response).trend }))
const issues = portfolioIssueCounts(sites, window)

浏览器集成

保留 user_key 财务报告和审定财务报表 partner_key 证书在您的服务器上 . 曝光一个保留上游地表和主要版本的同源代用,例如 /api/gscdump/analytics/v1/...。 。 。 . 浏览器收到单用实时票.

 applyEvent 在SDK推进光标或发送ACK之前,必须等待每次缓存更改.  resync 回调必须清除受影响的缓存范围并重新装入权威状态. 见 实时指南 为客户钩.

SDK提供HTTP运输,实时状态,和Webhook接收器帮助器. 您的应用程序拥有认证、 缓存和用户界面整合 . gscdump.com拥有webhook发送,队列和存储.

网络呼号

@gscdump/contracts 拥有 webhook 有效载荷计划及事件常数. @gscdump/sdk 提供接收方助手,以解析有效载荷,验证 签名,并规范事件名称。 gscdump.com 拥有网络呼克制作和 交货.

import { parseWebhookPayload } from '@gscdump/sdk/webhook'

const envelope = await parseWebhookPayload(await request.text(), {
  secret: webhookSecret,
  signature: request.headers.get('x-gscdump-signature'),
})

版本与发布记录

@gscdump/sdk 共发布 249 个版本,首次发布于 2026/05/11;过去 12 个月发布了 249 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

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

关于 @gscdump/sdk 的常见问题

@gscdump/sdk 是什么?

消费者SDK为主机gscdump.com集成.

如何安装 @gscdump/sdk?

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

@gscdump/sdk 支持 TypeScript 吗?

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

@gscdump/sdk 支持 ESM 还是 CommonJS?

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

@gscdump/sdk 需要什么版本的 Node.js?

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

@gscdump/sdk 可以商用吗?

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

@gscdump/sdk 的下载量有多少?

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

@gscdump/sdk 还在维护吗?

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