开放平台Turbo RewardConversions API

Conversions API

Conversions API将广告主的营销数据(如网站事件、应用程序事件、业务消息传递事件和离线转换)从广告主的服务器、网站平台、APP、CRM和Turbo Reward建立连接,从而优化广告定位、降低成本和衡量结果。

广告主可以利用Conversions API发送多种事件类型和Turbo Reward的Conversions API之间建立连接。

步骤

  1. 获取Turbo Reward的tlclid,在Trubo Reward的每次点击我们都会Landing Page附带上点击ID标识tlclid, 我们可以通过三方归因平台或TurboLink SDK获取到tlclid。
  2. App或网站端绑定用户和tlclid的关系,在事件发生时(Purchase、Sign-up、Add to Cart、Page View、Subscribe…)通过Conversions API发送事件相关信息和tlclid到Turbo Reward。
  3. 通过TurboLink Dashboard -> Integration -> 事件日志 查看是否接收到您的事件以及是否正确。

调用方式

  • 请求方式: POST
  • 请求地址: https://tls2s.allapp.link/manage/event_tracking/conversions?project_id=你的ProjectId

请求头参数(Header)

参数必须说明
Content-Typeapplication/json声明json格式
AuthorizationBearer md5(OpenSecret+(空格)+md5(请求body))OpenSecret 获取方式:Dashboard > 开发配置 > 开放平台秘钥 获取OpenSecret

请求内容参数(Body)

请求示例:

{
    "request_id": "xxx",
    "user_id": "user_12345",
    "event": "button_click",
    "user_data": {
        "tlclid": "tl.1.1770590941321.dd3Idk3jKlMnOpQrStUvWxYz1234567890"
    },
    "custom_data": [
        { "key": "key1", "value": "value1"},
        { "key": "key2", "value": "value2"}
    ]
}

参数说明

参数必须类型说明
project_idstring智链Dashboard后台项目管理页中获取到的项目ID
request_idstring请求id,需要请求幂等校验使用
user_idstring用户id
eventstring事件名称
user_data[]object用户数据
user_data.tlclidstringTurbo Reward Click ID, 点击Turbo Reward广告附加在落地页URL上的参数
custom_data[]object自定义事件数据参数键值对
custom_data.keystring自定义事件参数键
custom_data.valuestring自定义事件参数值

返回示例

{
    "code": 200,
    "msg": "请求成功",
    "data": {
        "link_hash_id": "MtwUCV4LxYd7L7V5EUkVom"
    }
}

返回参数说明

参数类型说明
codeint32返回状态码 200为成功返回
msgstring返回状态码信息
dataobject返回内容
data.link_hash_idstring归因中的所属链接hash

返回编码(code)说明

返回编码说明
200成功
20000服务器繁忙,请稍后重试
10205自定义事件不存在