You need to enable JavaScript to run this app.
导航
快速入门:研发
最近更新时间:2024.11.08 16:00:14首次发布时间:2023.06.09 16:02:36

1.概述

1.1 为什么需要接入数据

当要进行实验的时候,就需要集成SDK和上报指标事件,数据接入也是开启实验的前置条件。
DataTester提供了客户端、Web端、服务端等多种接入方式以满足各类需求,数据接入工作主要由研发人员完成。

1.2 接入说明

接入支持方式

(1)客户端SDK:Android SDK、iOS SDK、各种框架的SDK(RN、flutter、uni-app)、小程序(微信、支付宝、字节等),JS SDK
(2)服务端SDK:java,go等
说明:如果需要服务端上报指标数据,也可以通过httpapi方式做事件上报

客户端SDK采集数据分类

  1. 第一类,设备数据,用以唯一识别一个设备,尤其当用户未登录App时,我们通过设备来区分用户;
  2. 第二类,行为数据,也就是埋点数据,应用在用户交互的操作流中,找到关键事件进行埋点,当用户触发关键事件,应用就会将事件埋点交给AppLog,AppLog采集到埋点,上报给后台;
  3. 第三类,用户数据,当用户登陆账号,或账号切换时,或App收集到用户的其他信息时,可以将用户信息交给AppLog,AppLog上报到后台,做统一处理。

2.集成准备及相关文档说明

2.1 系统信息准备

2.1.1 地址及账号信息

私有部署
(1)系统登录地址
(2)SDK上报地址
(3)各角色的账号密码
SaaS
(1)系统登录地址
(2)各角色的账号密码

2.1.2 应用信息

点击应用后的详情获取到分配应用的「appid」、「appkey」、「URL Scheme」以及列表中显示的「appname」;
Image

2.2 埋点及sdk准备

(1)设计好的业务埋点方案
(2)各端的sdk
全部使用远程集成可忽略,如需使用离线集成请联系字节相关同学。

2.3 集成相关文档说明

有关数据格式相关文档:数据格式 增长分析-火山引擎
有关预置事件和属性:预置属性总表--A/B测试-火山引擎
有关ssid、uuid和device_id:用户标识--A/B测试-火山引擎
易错点说明:
1.数据格式不符合规范
Image
2.如果需要上传数值类型属性,需要注意在代码中就需要做数值类型属性上传。

3.客户端SDK集成及验证

说明:SDK集成分为3步
(1)引入SDK
(2)初始化SDK
(3)调用SDK相关API实现相关功能

3.1 Web/JS SDK

集成文档参考:Web/JS SDK集成开发指南--A/B测试-火山引擎
集成验证参考:Web/JS SDK 调试及数据验证--A/B测试-火山引擎

3.2 Android SDK

集成文档参考:Android SDK集成开发指南--A/B测试-火山引擎
集成验证参考:Android SDK调试及数据验证--A/B测试-火山引擎

3.3 iOS SDK

集成文档参考:iOS SDK集成开发指南--A/B测试-火山引擎
集成验证参考:iOS SDK调试及数据验证--A/B测试-火山引擎

3.4 小程序 SDK

3.4.1 微信小程序

集成文档参考:微信小程序SDK--A/B测试-火山引擎

3.4.2 字节跳动小程序

集成文档参考:字节跳动小程序SDK--A/B测试-火山引擎

3.4.3 支付宝小程序

集成文档参考:支付宝小程序SDK--A/B测试-火山引擎

4.服务端集成及验证

4.1 Java 服务端sdk

集成文档参考:Java SDK--A/B测试-火山引擎
其它服务端SDK集成参考此文档:服务端SDK整体说明--A/B测试-火山引擎

4.2 HTTP API(只做数据上报)

集成文档参考:HTTP API--增长分析-火山引擎
list接口body体

[{
    "user": {
        "user_unique_id": "useid1"
    },
    "header": {
        "app_name": "test031701",
        "ab_sdk_version": "24",
        "app_version":"1.0.1.2",
        "custom": {
              "public_prop222": "22222" 
        }
    },
    "events": [
        {
            "ab_sdk_version": "24",
            "event": "track11",
            "params": "{\"pay_real\":\"2990\", \"pro_type\":\"4\"}",
            "local_time_ms": 1656582814712
        }
    ]
}]

json接口body体

{
    "user": {
        "user_unique_id": "useid1"
    },
    "header": {
        "app_name": "test031701",
        "ab_sdk_version": "24",
        "app_version":"1.0.1.2",
        "custom": {
              "public_prop222": "22222" 
        }
    },
    "events": [
        {
            "ab_sdk_version": "24",
            "event": "track11",
            "params": "{\"pay_real\":\"2990\", \"pro_type\":\"4\"}",
            "local_time_ms": 1656582814712
        }
    ]
}