小部件集成

快速开始

<script
  src="https://widget.guidme.ai/v1/loader.js"
  data-key="gm_live_xxxxxxxxxxxx"
  data-app-id="11111111-1111-4111-8111-111111111111"
  data-locale="auto"
></script>

小部件会以浮动按钮显示在右下角。data-locale="auto" 使用页面声明的语言;不支持该语言时会回退到英语。

隐私边界仍只使用这一行 script 标签,不需要为应用编写专用遮罩代码。如果应用会在标准 HTML 元素上创建 closed shadow root,请将此标签放在应用主 bundle 之前,以便加载器在本地保留对它们的引用。

启动器图片

Pro 和 Enterprise 客户可以在控制台 > 小部件中上传可选的启动器图片。该图片会替代启动器图标。请使用不超过 5 MB 的 JPEG、PNG、WebP 或 AVIF 文件。GuidMe 会验证并裁剪图片,然后将其发布为托管的方形 WebP。在同一编辑器中删除图片即可恢复所选图标。

生产版小部件使用 GuidMe 品牌标记。除非服务器下发的套餐配置禁用品牌显示,否则 Powered by GuidMe 会在新标签页中打开 https://www.guidme.ai/

权限

语音输入需要麦克风权限,关闭面板时麦克风会停止。只有用户选择共享受保护的屏幕并共享此应用的浏览器标签页后,受保护的屏幕共享才会开始。GuidMe 会在设备上遮盖检测到的敏感区域,保留非敏感文本和元素作为有用的上下文,并保留第一张准确的受保护图像供用户确认。确认前不会发送任何内容;确认后每张图像仍会重新清理,只有受保护的 JPEG 会发送给 Google Gemini。加载器向 iframe 委派 microphone,并且仅在启用屏幕共享时委派 display-capture。浏览器仍会要求用户确认授权。

拒绝、取消或停止屏幕共享后,语音和文字支持仍可继续使用。共享受保护的屏幕会保留,供用户稍后主动重试;它不会自动再次请求授权。

应用管理员可以在小部件 > 规则 > 屏幕隐私中控制每个项目的配置。**平衡(推荐)**会选择性地遮盖检测到的敏感内容,同时保留普通上下文。严格还会遮盖所有可见的表单控件和可编辑字段。门户会警告这可能隐藏控件、文本或更大的页面区域,使指导不够具体或需要更多澄清。嵌入标签无法选择或削弱这个由服务器下发的配置。

安全与完整性

  • 只使用以 gm_live_ 开头的小部件密钥,不要在客户端公开管理员密钥。
  • 将宿主域名加入应用的允许来源列表。
  • 在宿主页面 CSP 中允许 script-src https://widget.guidme.aiframe-src https://widget.guidme.aiconnect-src https://api.guidme.ai。iframe 会应用自身的限制性 CSP。
  • Sentry/OpenTelemetry 运行遥测默认关闭。只有组织批准此项处理后,才设置 data-operational-telemetry="true"
  • /v1/loader.js 是每次使用都会重新验证的频道别名。iframe 别名不会存储在浏览器或 CDN 缓存中,并与加载器的确切隐私构建版本绑定。/v1/integrity.json 提供 SHA-384 值和带内容哈希的不可变路径,可在部署时固定版本。

公开的小部件构建产物不包含源映射文件。