用户注册(已归因用户上报)

约 1326 字大约 4 分钟

警告

请注意,一般情况下,您不需要接入此接口,如要接入,请联系引力技术同学核对一下,避免增加接入成本!

接口信息

请求地址

https://backend.gravity-engine.com/event_center/api/v1/user/register/attributed/open in new window

请求方法

POST

query 参数

参数名称必填参数类型
access_tokenY当前 App 的 access_token

body 参数

名称必填类型描述
client_idYstring用户在业务的唯一标识字符串(唯一 ID)
nameYstring用户名
channelYstring用户归因渠道
versionYnumber用户注册版本
turbo_promoted_object_idYstring引力引擎的推广活动 id(长度 16 位)
active_timeYnumber注册时间戳,毫秒
active_ipYstring注册 ip
click_timeYnumber点击广告时间戳,毫秒
click_ipYstring点击广告 ip
click_companyYstring用户归因的广告平台枚举,详情请参考: 广告平台枚举
ad_dataYstruct用户点击广告信息结构体,不同媒体加入不同结构体
os_typeYstring设备类型枚举: ios、android
device_infoNstruct设备信息结构体,(如果该处未上报,则需要在用户注册后,使用【设备信息上报】补报)

注意

如果获取不到对应的值,请传空字符串而不是 null。

ad_data 结构体

针对不同的媒体平台,详细取值信息如下

腾讯广告(广点通):tencent

参数名类型监测链接宏定义
对应含义
示例值
account_idstring__ACCOUNT_ID__广告主 id9471147
adgroup_idstring__ADGROUP_ID__广告组 id(实际为广告 id)228691429
ad_idstring__AD_ID__广告 id(实际为创意 id)251986746
campaign_idstring__CAMPAIGN_ID__计划 id102043154
callbackstring__CALLBACK__监测链接的回调信息http%3A%2F%2Ftracking.e.qq.comopen in new window%2Fconv%3Fcb%3DxXx%252BxXx%253D%26conv_id%3D123
req_idstring__REQUEST_ID__请求 idvqp7xdombqonw
click_idstring__CLICK_ID__点击 id24oi6xq2aaakvagnqu7a
site_set_namestring__SITE_SET_NAME__广告版位SITE_SET_MOMENTS

快手广告:kuaishou

参数名类型监测链接宏定义
对应含义
示例值
account_idstring__ACCOUNTID__广告账户 ID12345
aidstring__AID__广告组 ID2656338
cidstring__CID__广告创意 ID223372032123415808
didstring__DID__广告计划 ID223372036854775808
callbackstring__CALLBACK__监测链接的回调信息http%3a%2f%2fad.partner.gifshow.comopen in new window%2ftrack%2factivate%3fcallback%3dDHAJASALKFyk1uCKBYCyXp-iIDS-uHDd_a5SJ9Dbwkqv46dahahd87TW7hhkJkd

头条(巨量广告):bytedance

参数名类型监测链接宏定义
对应含义
示例值
advertiser_idstring__ADVERTISER_ID__广告账户 ID1631857582073864
aidstring__AID__广告计划 id(仅巨量广告 1.0)1645988237525045
cidstring__CID__广告创意 id(仅巨量广告 1.0)1650703686054530
campaign_idstring__CAMPAIGN_ID__广告组 id(仅巨量广告 1.0)1651688272934434
callbackstring__CALLBACK_PARAM__一些跟广告信息相关的回调参数EJiw267wvfQCGKf2g74ZIPD89-vIATAMOAFCIjIwMTkxMTI3MTQxMTEzMDEwMDI2MDc3MjE1MTUwNTczNTBIAQ==
csitestring__CSITE__广告投放位置38016
req_idstring__REQUEST_ID__请求下发的 id20191202180607010026077068090BA60A
promotion_idstring__PROMOTION_ID__广告 ID(仅巨量广告 2.0)7074140945750507528
project_idstring__PROJECT_ID__项目 ID(仅巨量广告 2.0)7074140945750507528
mid1string__MID1__图片素材 id(仅巨量广告 2.0)
mid2string__MID2__标题素材 id(仅巨量广告 2.0)
mid3string__MID3__视频素材 id(仅巨量广告 2.0)
mid4string__MID4__试玩素材 id(仅巨量广告 2.0)
mid5string__MID5__落地页素材 id(仅巨量广告 2.0)
mid6string__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

参数名类型示例值
attributionstringtrue
orgIdinteger40669820
campaignIdinteger542370539
conversionTypestring"Download"
clickDatestring"2020-04-08T17:17Z"
adGroupIdinteger542317095
countryOrRegionstring"US"
keywordIdinteger87675432
adIdinteger542317136

提示

ASA 指标具体含义,请参考苹果官方文档open in new window


device_info 结构体

安卓设备重点回传imeioaid,ios 设备则重点回传idfa

参数名必填类型描述举例
os_nameYstring可选值:ios、androidandroid
android_idNstring当为 android 设备时必填,默认空字符串6dec994473b81033
imeiNstring当为 android 设备时必填,默认空字符串864003048512155
oaidNstring当为 android 设备时必填,默认空字符串2bb77e2ec1fc6200
idfaNstring当为 ios 设备时必填,默认空字符串95955F33-BFBD-48BA-A630-866D2DAE482D
macYstringmac 地址原值,默认空字符串2E:53:CC:98:61:CD
android_versionNstringAndroid 版本(android.os.Build.VERSION.RELEASE9
api_versionNnumberAndroid API 版本(Build.VERSION.SDK_INT28
romNstring手机系统 ROM 名称miui
rom_versionNstring手机系统 ROM 版本v12
phone_brandNstring手机品牌(android.os.Build.BRANDxiaomi
phone_modelNstring手机型号(android.os.Build.MODELmi 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": "成功"
}