事件名：code_search
接口说明
APP通过口令参与活动时使用，通过口令获取到要参与的活动URL
此 API 需要访问密钥
使用场景
活动口令
调用方式
对接口传参
- 请求方式：POST(HTTPS)
- 请求地址：https://www.allapp.link/event/
参数解释
请求包体:
{
"project": "X5c6Zz8CeUcwim82YXteh9",
"event": "code_search",
"link_hash_id": "¥3mUGKB2sHC¥",
"user_id": "hash_user_01",
"intent_url": "",
"operating_system": "Mac OS X",
"operating_system_version": "10.15.7",
"device_model": "Mac",
"device_id": "34LL9A5VseZi"
}参数说明:
| 参数 | 必须 | 类型 | 说明 |
|---|---|---|---|
| project | 是 | string | 您的 Project ID 查看 |
| event | 是 | string | 您的事件名称，此处为：code_search |
| link_hash_id | 是 | string | 口令 |
| user_id | 否 | string | APP 加密处理后的用户 ID，只要是唯一用户标识即可 |
| intent_url | 否 | string | 唤起您 APP 的深度链接，此值 Android 可以从 SDK 获取，iOS 则可以不传或者忽略 示例: Android 获取方法：activity.getIntent().getData().toString() |
| operating_system | 是 | string | 设备的操作系统 示例: Android填写：Android iOS 获取方法: UIDevice.current.systemName |
| operating_system_version | 是 | string | 设备操作系统的版本号 示例: Android 获取方法：Build.VERSION.RELEASE iOS 获取方法: UIDevice.current.systemVersion |
| device_model | 是 | string | 移动设备的型号 示例: Android 获取方法：Build.MODEL iOS 获取方法: UIDevice.current.model |
| device_id | 是 | string | 移动设备标识，只要是唯一设备标识即可 |
返回结果
{
"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"
}
]
},
"link_hash_id": "c-ckr2dd1rogtl5hi35mfg",
"link_data": {
"$campaign_code_url": "https://user1.c.allapp.link/c?l=ckr2dd1rogtshgsvf6l0&c=QW&cw=Rt"
}
}参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| code | int32 | 返回码， 200 - 成功 |
| msg | string | 对返回码的文本描述内容 |
| data | obj | 事件返回 |
| data.link_hash_id | string | 归因中的链接 ID |
| data.link_click_time | int32 | 归因中的链接被点击时间，如果是粘贴板和intent_url归因的，返回0 |
| data.link_data | array(object) | 归因中的键值对，通过键值对参数可跳转到APP内的指定View,这里的key有3种类型： 1.深度链接或活动自定义的key和value 2.APP外活动下发的活动领奖参与URL 3.通过活动口令参与活动URL |
| data.link_data.key | string | 1.自定义参数键 2.对于参与APP外的活动下发的key为：$campaign_reward_url 3.口令下发key为：$campaign_code_url |
| data.link_data.value | string | 自定义参数值 |