path 和 locale 查询 overlay,并在页面渲染或缓存刷新时注入到页面 head。
该接口只读取已经发布的 overlay。没有 overlay 时,客户站点应保持原页面 head 不变。
接口总览
| 能力 | 方法 | 路径 | 调用方 |
|---|---|---|---|
| 查询已发布 overlay | GET | /seo/overlays | 插件或客户站点服务端 |
通用请求头
| Header | 必填 | 说明 |
|---|---|---|
Authorization: Bearer <site_token> | 是 | 站点服务端 token |
GET /seo/overlays
查询可注入到页面 head 的 SEO/GEO 数据。Query 参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
path | string | 否 | 页面路径;传入后只返回匹配路径的 overlay |
locale | string | 否 | 语种;传入后只返回匹配语种的 overlay |
limit | integer | 否 | 返回数量,1-200 |
请求示例
成功响应
Overlay 字段
| 字段 | 说明 |
|---|---|
path | 匹配页面路径 |
locale | 匹配语种 |
title | 建议注入到 <title> |
description | 建议注入到 meta description |
canonical | canonical URL |
robots | robots meta |
aiSummary | AI 摘要,可用于页面摘要或内部展示 |
openGraph | Open Graph 标签数据 |
twitter | Twitter Card 标签数据 |
faq | FAQ 内容,可用于页面展示或 Schema |
schemaGraph | Schema graph 原始结构 |
schemaJsonLd | JSON-LD 数组,可注入为 application/ld+json |
internalLinks | 建议内链 |
entities | 实体覆盖信息 |
updatedAt | overlay 更新时间 |
注入规则
| 内容 | 推荐处理 |
|---|---|
title | 替换当前页面 <title> |
description | 替换或创建 meta[name="description"] |
canonical | 替换或创建 link[rel="canonical"] |
robots | 替换或创建 meta[name="robots"] |
openGraph | 替换对应 og:* meta |
twitter | 替换对应 twitter:* meta |
schemaJsonLd | 注入 JSON-LD script,避免重复注入旧 GrowthOS script |
常见错误
| HTTP | 错误码 | 说明 | 处理建议 |
|---|---|---|---|
401 | INVALID_TOKEN | token 无效 | 检查站点 token |
429 | RATE_LIMITED | 请求过快 | 按 Retry-After 退避重试 |
实现要点
- 按标准化后的
path + locale匹配,不要跨语种复用 overlay。 - 没有 overlay 时保持页面原始 head。
- 注入前先移除或替换旧的 GrowthOS 标签,避免重复 title、description 或 JSON-LD。
- 正文内容不由 overlay 接口替换。
- 高流量页面建议短缓存 overlay,并在插件任务完成后刷新缓存。