@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'),
})