webflow-browser-api

Webflow Browser API

Browser API 是一个 JavaScript 接口，可通过全局 wf 对象在所有启用了 Analyze 和 Optimize 的 Webflow 站点上使用。无需手动安装。可用它管理同意、跟踪实验并个性化用户体验。

核心概念

• 全局 wf 对象 — 在所有启用了 Analyze 或 Optimize 的站点上自动提供
• wf.ready() — 所有 Browser API 调用都必须封装在此就绪回调中。参见 references/wf-ready.md
• 同意管理 — 使用三种方法管理跟踪同意：getUserTrackingChoice()、allowUserTracking()、denyUserTracking()
• 变体 — 通过 onVariationRecorded() 跟踪实验结果，并转发到分析工具
• 自定义属性 — 通过 setAttributes() 设置访客属性，用于受众定位和结果筛选（仅限 Enterprise）

API 方法

方法	说明
wf.ready(callback)	在 Browser API 加载后执行代码
wf.getUserTrackingChoice()	返回 "allow"、"deny" 或 "none"
wf.allowUserTracking(options?)	让用户选择同意跟踪
wf.denyUserTracking(options?)	让用户选择退出跟踪
wf.onVariationRecorded(callback)	注册变体事件的回调
wf.setAttributes(scope, attributes)	设置自定义访客属性

重要说明

• Browser API 仅适用于启用了 Webflow Analyze 或 Optimize 的站点
• 自定义 JavaScript 属性（setAttributes）仅适用于 Enterprise 站点
• 始终将所有 API 调用封装在 wf.ready() 中，以防在初始化前调用
• 将脚本放在 <head> 自定义代码中，以尽早执行

参考文档

每个参考文件都包含 YAML frontmatter，其中有 name、description 和 tags，便于搜索。使用 scripts/search_references.py 中的搜索脚本查找相关参考资料。

入门

• references/introduction.md：概览、功能、放置选项和入门指南
• references/wf-ready.md：wf.ready() API 参考

同意管理

• references/consent-management.md：同意 API、CMP 集成（OneTrust、TrustArc、CookieYes）和自定义同意解决方案

Optimize

• references/optimize-overview.md：Optimize 概览和快速入门
• references/variations.md：变体概念和 onVariationRecorded() API 参考
• references/attributes.md：自定义属性和 setAttributes() API 参考

搜索参考资料

# List all references with metadata
python scripts/search_references.py --list

# Search by tag (exact match)
python scripts/search_references.py --tag <tag>

# Search by keyword (across name, description, tags, and content)
python scripts/search_references.py --search <query>

脚本

• scripts/search_references.py：按标签或关键词搜索参考文件，或列出所有文件及其元数据