接入责任与交付要求
接入前确认项目配置、SDK 包和数据处理责任。安装及示例见快速接入,功能差异见平台与兼容性。
项目配置
| 配置 | 接入要求 |
|---|---|
endpoint | 使用对应测试或正式环境的事件接收地址 |
projectKey | 使用绑定单一项目环境的公开凭据 |
| 授权状态 | 根据业务授权流程选择初始化状态;自动采集满足插件所需 Consent 后才启用 |
| 存储范围 | Web 默认按 endpoint/projectKey 隔离;额外 namespace 应稳定且不包含敏感信息 |
| 事件规则 | 先确定事件、属性及类型;需要客户端校验时才配置本地 Tracking Plan |
责任划分
| 责任方 | 负责内容 |
|---|---|
| SDK 提供方 | SDK 包、版本说明、公开 API、事件封装、队列及重试机制 |
| 租户接入开发者 | 宿主安装、事件调用、身份来源、授权配置、敏感信息审查及集成验证 |
| 接收服务负责人 | 项目授权、网关协议、幂等、接收记录和下游存储;提供相应验收渠道 |
| 业务与测试负责人 | 事件口径、代表性操作路径及最终数据验收 |
按数据校验核对目标服务的响应和接收记录。
版本与模块
Android Core 与其可选模块按一个 Android 版本交付,iOS Core 与其可选模块按一个 iOS 版本交付;完整跨端验收仍由 Suite 固定两端及 Web/Hybrid 的组合。服务端 SDK 按语言独立发版。固定版本并检查下载页提供的校验信息,再在租户宿主中完成依赖解析、编译和运行验证。
- Web 插件随 Web 包提供,按需显式注册。
- Android 的 Compose、Activity 生命周期与 View 自动采集扩展按场景选择,具体安装见 Android API。
- iOS 核心二进制模块为
TrackBusinessSDKKit,Swift Package 模块为TrackBusinessSDK;SwiftUI、UIKit、位置模块按需引入,见 iOS 接入。 - React Native、Flutter 须使用包中配套的 Android、iOS SDK 版本,并满足宿主框架依赖要求。升级时请使用对应版本的完整交付包,不要单独替换其中的原生依赖。
采集与投递
仅启用业务所需的自动采集,使用稳定、非敏感的页面名和交互标识。启用页面或生命周期适配器后,避免重复手工记录同一事件。Web、Android、iOS 的集成方式不同,分别参照对应平台指南。
客户端存储和后台发送受运行环境限制,详见可靠投递。服务端默认使用有界内存队列;需事务一致性的订单、支付事件使用宿主事务 Outbox。
可选原生队列加密须显式配置,并确定密钥备份、恢复和丢失后的处理方式,见环境与安全。
上线与支持
按上线验收验证事件、身份、授权、断网和恢复。保留 SDK/应用版本、测试环境、测试时间及结果;未执行的项目记录为待验证。
出现问题时按常见问题定位失败阶段。提交诊断前检查并移除凭据、原始事件属性和个人信息。