1 系统网络 SDK
薄载器 + CDN 主持调查引擎,用于1次系统产品调查、事件跟踪和 用户身份.
安装
无
npm install @1sygnal/onesygnal-web-sdk
import oneSygnal from '@1sygnal/onesygnal-web-sdk';
oneSygnal.init('your-api-key', { apiUrl: 'https://sdk-api.1sygnal.app' });
包裹有一个 只默认导出 没有 { init, track, identify } 名称
输出.
脚本标签( 自发- init)
<script
src="https://repo.1sygnal.app/js/1sygnal.js"
data-api-key="your-api-key"
data-api-url="https://sdk-api.1sygnal.app"
></script>
使用量
跟踪事件
oneSygnal.track('button_click', { id: 'cta' });
识别用户
oneSygnal.identify('user-123', { plan: 'pro' });
还提供: oneSygnal.logout() 清除会话/用户状态,以及
oneSygnal.setSurveysEnabled(enabled) 在运行时切换调查.
倾听调查活动
oneSygnal.on('survey:completed', (event) => {
// handle completion
});
其他活动: "survey:shown", (中文(简体) ), "survey:step", (中文(简体) ), "survey:dismissed"。取消订阅
与 oneSygnal.off(event, callback)。 。 。 .
如何运作
init() 返回时 void而不是承诺,它注入了 <script> 装入全部 SDK 的标签
从 1Sygnal 的 CDN 捆绑到队列 track编号 :identify编号 :on/etc. 呼叫直到捆绑
装载和信号准备。 没什么 await; 在捆绑准备好之前打过电话
排队并重放。 这使勘测-触发修正和特征船
每个嵌入的站点立即, 没有依赖性起伏和重新部署.
移动安全区设置
底部/顶部调查使用情况 env(safe-area-inset-*) 来清理鼻孔和家
电话指标。 这些 env() 仅当页面选择通过 :
<meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover">
init() 自动补丁( 待决) viewport-fit=cover 改为现有
<meta name="viewport">,或者如果页面没有,则添加一个),所以这是一个倒置,而不是
硬性要求——但将它设置在页面中 <head> 仍然建议,因为
在SDK负载前生效.
文档
全面整合指南: https://docs.1sygnal.app (英语)