用户注册(已归因用户上报)
约 1326 字大约 4 分钟
警告
请注意,一般情况下,您不需要接入此接口,如要接入,请联系引力技术同学核对一下,避免增加接入成本!
接口信息
请求地址
https://backend.gravity-engine.com/event_center/api/v1/user/register/attributed/
请求方法
POST
query 参数
参数名称 | 必填 | 参数类型 |
---|---|---|
access_token | Y | 当前 App 的 access_token |
body 参数
名称 | 必填 | 类型 | 描述 |
---|---|---|---|
client_id | Y | string | 用户在业务的唯一标识字符串(唯一 ID) |
name | Y | string | 用户名 |
channel | Y | string | 用户归因渠道 |
version | Y | number | 用户注册版本 |
turbo_promoted_object_id | Y | string | 引力引擎的推广活动 id(长度 16 位) |
active_time | Y | number | 注册时间戳,毫秒 |
active_ip | Y | string | 注册 ip |
click_time | Y | number | 点击广告时间戳,毫秒 |
click_ip | Y | string | 点击广告 ip |
click_company | Y | string | 用户归因的广告平台枚举,详情请参考: 广告平台枚举 |
ad_data | Y | struct | 用户点击广告信息结构体,不同媒体加入不同结构体 |
os_type | Y | string | 设备类型枚举: ios、android |
device_info | N | struct | 设备信息结构体,(如果该处未上报,则需要在用户注册后,使用【设备信息上报】补报) |
注意
如果获取不到对应的值,请传空字符串而不是 null。
ad_data 结构体
针对不同的媒体平台,详细取值信息如下
腾讯广告(广点通):tencent
参数名 | 类型 | 监测链接宏定义 | 对应含义 | 示例值 |
---|---|---|---|---|
account_id | string | __ACCOUNT_ID__ | 广告主 id | 9471147 |
adgroup_id | string | __ADGROUP_ID__ | 广告组 id(实际为广告 id) | 228691429 |
ad_id | string | __AD_ID__ | 广告 id(实际为创意 id) | 251986746 |
campaign_id | string | __CAMPAIGN_ID__ | 计划 id | 102043154 |
callback | string | __CALLBACK__ | 监测链接的回调信息 | http%3A%2F%2Ftracking.e.qq.com%2Fconv%3Fcb%3DxXx%252BxXx%253D%26conv_id%3D123 |
req_id | string | __REQUEST_ID__ | 请求 id | vqp7xdombqonw |
click_id | string | __CLICK_ID__ | 点击 id | 24oi6xq2aaakvagnqu7a |
site_set_name | string | __SITE_SET_NAME__ | 广告版位 | SITE_SET_MOMENTS |
快手广告:kuaishou
参数名 | 类型 | 监测链接宏定义 | 对应含义 | 示例值 |
---|---|---|---|---|
account_id | string | __ACCOUNTID__ | 广告账户 ID | 12345 |
aid | string | __AID__ | 广告组 ID | 2656338 |
cid | string | __CID__ | 广告创意 ID | 223372032123415808 |
did | string | __DID__ | 广告计划 ID | 223372036854775808 |
callback | string | __CALLBACK__ | 监测链接的回调信息 | http%3a%2f%2fad.partner.gifshow.com%2ftrack%2factivate%3fcallback%3dDHAJASALKFyk1uCKBYCyXp-iIDS-uHDd_a5SJ9Dbwkqv46dahahd87TW7hhkJkd |
头条(巨量广告):bytedance
参数名 | 类型 | 监测链接宏定义 | 对应含义 | 示例值 |
---|---|---|---|---|
advertiser_id | string | __ADVERTISER_ID__ | 广告账户 ID | 1631857582073864 |
aid | string | __AID__ | 广告计划 id(仅巨量广告 1.0) | 1645988237525045 |
cid | string | __CID__ | 广告创意 id(仅巨量广告 1.0) | 1650703686054530 |
campaign_id | string | __CAMPAIGN_ID__ | 广告组 id(仅巨量广告 1.0) | 1651688272934434 |
callback | string | __CALLBACK_PARAM__ | 一些跟广告信息相关的回调参数 | EJiw267wvfQCGKf2g74ZIPD89-vIATAMOAFCIjIwMTkxMTI3MTQxMTEzMDEwMDI2MDc3MjE1MTUwNTczNTBIAQ== |
csite | string | __CSITE__ | 广告投放位置 | 38016 |
req_id | string | __REQUEST_ID__ | 请求下发的 id | 20191202180607010026077068090BA60A |
promotion_id | string | __PROMOTION_ID__ | 广告 ID(仅巨量广告 2.0) | 7074140945750507528 |
project_id | string | __PROJECT_ID__ | 项目 ID(仅巨量广告 2.0) | 7074140945750507528 |
mid1 | string | __MID1__ | 图片素材 id(仅巨量广告 2.0) | |
mid2 | string | __MID2__ | 标题素材 id(仅巨量广告 2.0) | |
mid3 | string | __MID3__ | 视频素材 id(仅巨量广告 2.0) | |
mid4 | string | __MID4__ | 试玩素材 id(仅巨量广告 2.0) | |
mid5 | string | __MID5__ | 落地页素材 id(仅巨量广告 2.0) | |
mid6 | string | __MID6__ | 安卓下载详情页 id(仅巨量广告 2.0) |
示例:
{
"bytedance": {
"advertiser_id": "12940274294275",
"project_id": "924563792",
"promotion_id": "93795753",
"mid1": "3256634642",
"mid2": "2353252367",
"mid3": "3245235236",
"mid4": "6346347623",
"mid5": "7345232424",
"csite": "38016",
"req_id": "20191202180607010026077068090BA60A",
"callback": "EJiw267wvfQCGKf2g74ZIPD89-vIATAMOAFCIjIwMTkxMTI3MTQxMTEzMDEwMDI2MDc3MjE1MTUwNTczNTBIAQ=="
}
}
Apple Search Ads:asa
参数名 | 类型 | 示例值 |
---|---|---|
attribution | string | true |
orgId | integer | 40669820 |
campaignId | integer | 542370539 |
conversionType | string | "Download" |
clickDate | string | "2020-04-08T17:17Z" |
adGroupId | integer | 542317095 |
countryOrRegion | string | "US" |
keywordId | integer | 87675432 |
adId | integer | 542317136 |
提示
ASA 指标具体含义,请参考苹果官方文档
device_info 结构体
安卓设备重点回传imei或oaid,ios 设备则重点回传idfa
参数名 | 必填 | 类型 | 描述 | 举例 |
---|---|---|---|---|
os_name | Y | string | 可选值:ios、android | android |
android_id | N | string | 当为 android 设备时必填,默认空字符串 | 6dec994473b81033 |
imei | N | string | 当为 android 设备时必填,默认空字符串 | 864003048512155 |
oaid | N | string | 当为 android 设备时必填,默认空字符串 | 2bb77e2ec1fc6200 |
idfa | N | string | 当为 ios 设备时必填,默认空字符串 | 95955F33-BFBD-48BA-A630-866D2DAE482D |
mac | Y | string | mac 地址原值,默认空字符串 | 2E:53:CC:98:61:CD |
android_version | N | string | Android 版本(android.os.Build.VERSION.RELEASE ) | 9 |
api_version | N | number | Android API 版本(Build.VERSION.SDK_INT ) | 28 |
rom | N | string | 手机系统 ROM 名称 | miui |
rom_version | N | string | 手机系统 ROM 版本 | v12 |
phone_brand | N | string | 手机品牌(android.os.Build.BRAND ) | xiaomi |
phone_model | N | string | 手机型号(android.os.Build.MODEL ) | mi 9 |
请求示例
curl 'https://backend.gravity-engine.com/event_center/api/v1/user/register/attributed/?access_token=<ACCESS_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
"client_id":"123413414",
"name":"default",
"channel":"v2",
"version":1001,
"turbo_promoted_object_id":"B1njyJ8Yx2Ua6oqm",
"active_time":1675924976162,
"active_ip": "127.0.0.1",
"click_time":1675924976162,
"click_ip":"127.0.0.1",
"click_company":"kuaishou",
"ad_data":{
"kuaishou":{
"account_id":"12345",
"aid":"2656338",
"cid":"223372032123415808",
"did":"223372036854775808",
"callback":"http%3a%2f%2fad.partner.gifshow.com%2ftrack%2factivate%3fcallback%3dDHAJASALKFyk1uCKBYCyXp-iIDS-uHDd_a5SJ9Dbwkqv46dahahd87TW7hhkJkd"
}
},
"os_type": "android",
"device_info":{
"os_name":"android",
"android_id":"6dec994473b81033",
"imei":"864003048512155",
"oaid":"2bb77e2ec1fc6200",
"idfa":"",
"mac":"2E:53:CC:98:61:CD",
"android_version":"9",
"api_version":28,
"rom":"miui",
"rom_version":"v12",
"phone_brand":"xiaomi",
"phone_model":"mi 9"
}
}'
应答示例
{
"data": {
"token": "*****"
},
"extra": {},
"code": 0,
"msg": "成功"
}