SuperAPI AI 工具集

webflow-browser-api

前端与建站

查看项目

更新于 10-15 10:43

技能介绍

Webflow Browser API 是 Webflow 提供的 JavaScript 接口,通过全局 wf 对象在所有启用了 Analyze 或 Optimize 的 Webflow 网站上自动暴露,无需手动安装。它用于管理跟踪同意、跟踪实验变体以及个性化用户体验。

用途 该 API 主要面向需要在 Webflow 站点上以编程方式控制跟踪行为、集成同意管理平台(CMP)以及对接分析工具的开发者。它允许在浏览器端管理访客的跟踪选择,并捕获实验变体结果。

主要能力

  • 全局 wf 对象:在所有启用了 Analyze 或 Optimize 的站点上自动可用。
  • wf.ready(callback):所有 Browser API 调用都必须包裹在此就绪回调中,以防止在初始化之前调用。
  • 同意管理:提供三个方法管理跟踪同意——getUserTrackingChoice() 返回 "allow"、"deny" 或 "none";allowUserTracking(options?) 让用户选择加入跟踪;denyUserTracking(options?) 让用户选择退出跟踪。
  • 变体跟踪:通过 onVariationRecorded(callback) 注册变体事件的回调,可将实验结果转发到分析工具。
  • 自定义属性:通过 setAttributes(scope, attributes) 设置访客自定义属性,用于受众定向和结果筛选(仅限 Enterprise 站点)。

使用方式 所有 API 调用必须包裹在 wf.ready() 回调中,以确保在 Browser API 加载后执行。建议将脚本放置在 <head> 自定义代码中,以便尽早执行。API 方法包括:wf.ready(callback)、wf.getUserTrackingChoice()、wf.allowUserTracking(options?)、wf.denyUserTracking(options?)、wf.onVariationRecorded(callback)、wf.setAttributes(scope, attributes)。

参考文档与脚本 项目提供多个参考文件,每个文件包含 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、自定义同意方案)、references/optimize-overview.md(Optimize 概述与快速入门)、references/variations.md(变体概念与 onVariationRecorded() API 参考)、references/attributes.md(自定义属性与 setAttributes() API 参考)。

搜索脚本用法:

列出所有参考及其元数据

python scripts/search_references.py --list

按标签搜索(精确匹配)

python scripts/search_references.py --tag <tag>

按关键词搜索(跨名称、描述、标签和内容)

python scripts/search_references.py --search <query>

适用场景 适用于需要在 Webflow 站点上管理用户跟踪同意、集成 OneTrust 或 TrustArc 等 CMP、跟踪 Optimize 实验变体并将结果转发到分析工具,以及(Enterprise 站点)设置自定义访客属性进行受众定向的场景。

限制

  • Browser API 仅在启用了 Webflow Analyze 或 Optimize 的站点上可用。
  • 自定义 JavaScript 属性(setAttributes)仅在 Enterprise 站点上可用。
  • 所有 API 调用必须包裹在 wf.ready() 中,否则可能在初始化前调用。
  • 关于收费、价格、平台支持范围等更多信息暂未提供。