跳到主要内容

事件埋点接入指南

最后更新：2023/10/10

📘 事件埋点说明

事件埋点作用于跟踪应用程序中的所有转化。通过事件埋点，您将能够关联有关商务、生命周期及自定义的详细数据，更好的了解用户行为和正在进行的营销活动。
事件根据功能被划分为默认事件和自定义事件。

API埋点事件需要AppKey和AppSecret

接入概述​

为了顺利接入事件埋点，你需要完成以下步骤：

  1. 确保能在智链Dashboard后台的项目管理页中获取到项目ID。
  2. 对于事件API的调用要求你的每个请求带上安全密钥（ACCESS TOKEN）,你可以通过智链Dashboard后台获取访问密钥。
  3. 接入事件上报API接口。

事件上报API​

调用方式​

  • 请求方式: POST
  • 请求地址: https://www.allapp.link/v2/event

请求头参数（Header）​

参数必须值说明
Content-Type是application/json声明json格式
Authorization是Bearer AppKeyAppKey 获取方式：访问密钥

请求内容参数（Body）​

请求示例​

{
    "project": "项目ID",
    "request_id": "uuid",
    "timestamp": 1696867200000,
    "msg_signature": "hash id",
    "event": "open",
    "user_data": {
        "native_msg":"粘贴板内容",
        "deep_link_url": "跳转链接地址",
        "os": "Android",
        "os_version": "11",
        "device_model": "Pixel 5",
        "device_id": "device00",
        "user_id": "user00",
        "brand": "",
        "country": "",
        "language": "",
        "screen_height": 0,
        "screen_width": 0,
        "dpi": 326,
        "ipv4": "",
        "local_ip": ""
    }
}

请求参数说明​

参数必须类型说明
project是string智链Dashboard后台项目管理页中获取到的项目ID
request_id是string请求唯一id,需要每次请求都唯一(可以是UUID，也可以是自己的请求序号，主要是跟踪这次请求的上下文的)
timestamp是int64当前时间戳(毫秒)
msg_signature是stringsha1(project+"_"+request_id+"_"+timestamp+"_"+AppSecret)
AppSecret获取方法：AppSecret
sha1是编码算法
event是string默认事件或者自定义事件名称
user_data.native_msg否string粘贴板内容，粘贴板内容限制1000个字符长度，过长将被截取
对于Google Play的Android,我们建议您采取以下两种方案其一：
1）根据GP的指引完成粘贴板的信息披露并获得用户授权：https://support.google.com/googleplay/android-developer/answer/10144311?visit_id=638320928049656842-850101537&rd=1
2）这个字段为空，不会影响整个流程和归因准确度
(iOS正常使用)
user_data.deep_link_url否string外部链接跳转至app地址
如：Android的IntentURL, iOS的OpenURL
user_data.os是string设备操作系统，包括以下系统类型：Android、iOS、Windows、macOS、Linux等
user_data.os_version是string设备操作系统版本，如：11.1.1
user_data.device_model是string设备型号
user_data.device_id是string设备唯一标识
user_data.user_id否string用户的唯一标识
user_data.brand否string设备品牌
user_data.country否string用户的国家/地区代码,通常基于设备设置或用户代理字符串。如:CN
user_data.language否string用户的语言代码，通常基于设备设置或用户代理字符串。如:zh
user_data.screen_height否int32屏幕高度
user_data.screen_width否int32屏幕宽度
user_data.dpi否int32设备dpi
user_data.ipv4否stringipv4地址，app客户端ip，如APP上报为""
user_data.local_ip否string局域网ip

返回示例​

{
    "code": 200,
    "msg": "请求成功",
    "data": {
        "link_hash_id": "MtwUCV4LxYd7L7V5EUkVom", 
        "link_click_time": 1695693901,
        "blackbox": "cob6i06rdj7vtortk6o0743701",
        "device_status": 1,
        "link_data": [
            {
                "key": "自定义key1",
                "value": "38194"
            },
            {
                "key": "自定义key2",
                "value": "38421"
            },
            {
                "key": "$campaign_reward_url",
                "value": "https://user1.c.allapp.link/c?l=ckr2dd1rogtshgsvf6l0&wid=ckt1dlnm8ngtn4r313dg&user_id=user_01"
            },
            {
                "key": "$campaign_code_url",
                "value": "https://user1.c.allapp.link/c?l=ckr2dd1rogtshgsvf6l0&c=QW&cw=Rt"
            }
        ],
        "campaign_data": {
            "campaign_id": "cqvctoerdj7ooqepo1f0",
            "title": "活动标题",
            "start": 1723694325,
            "end": 1727668731,
            "status": 2
        }
    }
}

返回参数说明​

参数类型说明
codeint32返回状态码 200为成功返回
msgstring返回状态码信息
dataobject返回内容
data.link_hash_idstring归因中的所属链接hash
data.link_click_timeint32归因中的链接被点击时间，如果是粘贴板和intent_url归因的，返回0
data.blackboxstringblackbox, TurboLink定义的终端编码
data.device_statusint32设备状态,1-新设备，2-老设备
data.link_data[]object归因中的所属链接相关LinkData数据，该数据为创建深度链接时提供的LinkData数据
data.link_data.keystring1.自定义参数键 查看返回说明
2.对于参与APP外的活动下发的key为：$campaign_reward_url 查看返回说明
3.口令下发key为：$campaign_code_url 查看返回说明
data.link_data.valuestring自定义值
data.campaign_dataobject如果归因中的是活动，则返回活动的信息
data.campaign_data.campaign_idstring活动HashID
data.campaign_data.titlestring活动标题
data.campaign_data.startint32活动开始时间
data.campaign_data.endint32活动结束时间
data.campaign_data.statusint32活动状态:1-待发布，2-已发布，3-已下线，4-预发布

返回编码(code)说明​

API返回编码说明

每种返回的情况​

  1. 深度链接或活动自定义的key和value 
{
    "code": 200,
    "msg": "请求成功",
    "data": {
        "link_hash_id": "ckr6kd90b4mkak8lj680",
        "link_click_time": 0,
        "link_data": [
            {
                "key": "自定义key1",
                "value": "1023-2"
            },
            {
                "key": "自定义key2",
                "value": "1023-2"
            }
        ]
    }
}

2.APP外活动下发的活动领奖参与URL: 

{
    "code": 200,
    "msg": "请求成功",
    "data": {
        "link_hash_id": "c-ckr2dd1rogtl5hi35mfg",
        "link_click_time": 0,
        "link_data": [
            {
                "key": "$campaign_reward_url",
                "value": "https://user1.c.allapp.link/c?l=ckr2dd1rogtshgsvf6l0&wid=ckt1dlnm8ngtn4r313dg&user_id=user_01"
            }
        ]
    }
}

3.归因中活动口令下发的link_data: 

{
    "code": 200,
    "msg": "请求成功",
    "data": {
        "link_hash_id": "c-ckr2dd1rogtl5hi35mfg",
        "link_click_time": 0,
        "link_data": [
            {
                "key": "$campaign_code_url",
                "value": "https://user1.c.allapp.link/c?l=ckr2dd1rogtshgsvf6l0&c=QW&cw=Rt"
            }
        ]
    }
}