English
Log In
You can then view all documents
增长参谋/数据接入文档/自建归因
自建归因
Last updated 2022-09-07 18:21:35

重点提示

  1. 请求签名signature:需要根据分配的secretKey对参数计算,然后添加到url地址后面
  2. 回调地址:一个应用对应一个独立的回调地址,切勿用同一个回调地址,会对应401002的报错错误码
  3. ad_platform 的枚举值:不可自定义,详细请参考附件:(注意:自建归因-渠道映射关系 )
  4. content-type 使用的方式:application/json,使用错误会导致接口回调报错
  5. 归因渠道需按标准回传映射 自建归因-渠道映射关系
  6. 同时支持服务端SDK和API接入

快捷接入

服务端SDK

pangle_growth_dispatcher_sdk-v1.4.zippangle_growth_dispatcher_sdk-v1.4.zip
80.15 KB

接口简介

该接口用于自建归因的开发者将归因后的分渠道数据回传给增长参谋,以实现细分查看全渠道ROI报表。

接入操作

第一步:获取回调地址和签名密钥

1. 回调地址

以下地址为增长参谋提供回调地址,您可以复制地址链接,并在地址后添加根据4.1.签名算法的指引生成signature使用,该回调地址将用于后续上报请求。

2. 签名密钥

下方为增长参谋为当前应用分配的secretKey(用于计算signature):

第二步:数据上报

请参照以下信息,按照请求信息,将需要的参数上报到对应的接口地址,同时,请参照签名计算生成对应的签名,并更新到回调地址中的signature,来保障安全鉴权要求。

1. 接口地址

请在上述步骤获取的回调地址{callback_url}

2. 请求信息

3. 请求上报参数

1. 所有的md5均采用32位小写

2. 必传字段说明:

①设备信息:安卓-若有andriod_id、imei、oaid, 请全部回传,以增加设备的拼接率 IOS-若有idfa、idfv、caid,请全部回传,以增加设备的拼接率

② 激活时间:time_ts参数类型是int,不是string

计划ID虽为非必传,但除自然量&厂商外,建议其他渠道均回传

分类

字段英文名

字段中文名

类型

会否必填

说明

通用信息

package

app安装包

string





























设备信息

unique_id

自归因平台设备唯一标识

string

否(开发者自己对设备标识的ID)


imei

安卓设备的设备标识

string

若有andriod_id、imei、oaid, 请全部回传,以增加设备的拼接率


oaid

安卓设备的设备标识

string

若有andriod_id、imei、oaid, 请全部回传,以增加设备的拼接率

如有取到,一定要传原值!否则会被过滤,影响指标计算,length(>=10 and <=64)

android_id

安卓设备的设备标识

string

若有andriod_id、imei、oaid, 请全部回传,以增加设备的拼接率


google_aid

google广告平台的用户标识

string

若有andriod_id、imei、oaid, 请全部回传,以增加设备的拼接率


imei_md5

md5加密后的imei

string

若有andriod_id、imei、oaid, 请全部回传,以增加设备的拼接率

md5转化前,不对原值进行大小写转变,转化后,不对MD5值截断

oaid_md5

md5加密后的oaid

string

若有andriod_id、imei、oaid, 请全部回传,以增加设备的拼接率

md5转化前,不对原值进行大小写转变,转化后,不对MD5值截断

android_id_md5

md5加密后的android_id

string

若有andriod_id、imei、oaid, 请全部回传,以增加设备的拼接率

md5转化前,不对原值进行大小写转变,转化后,不对MD5值截断

google_aid_md5

md5加密后的google_aid

string

若有andriod_id、imei、oaid, 请全部回传,以增加设备的拼接率

md5转化前,不对原值进行大小写转变,转化后,不对MD5值截断

idfa

ios设备的设备标识

string

若有idfa、idfv、caid,请全部回传,以增加设备的拼接率

无效字段示例:

idfv

ios设备的设备标识

string

若有idfa、idfv、caid,请全部回传,以增加设备的拼接率

idfv有可能存在获取失败的场景,注意获取时间和获取频率,增加获取率

zgx_caid

ios设备的设备标识,这里特指中广协的caid

string

若有idfa、idfv、caid,请全部回传,以增加设备的拼接率


idfa_md5

md5加密后的idfa

string

若有idfa、idfv、caid,请全部回传,以增加设备的拼接率

md5转化前,不对原值进行大小写转变,转化后,不对MD5值截断

idfv_md5

md5加密后的idfv

string

若有idfa、idfv、caid,请全部回传,以增加设备的拼接率

md5转化前,不对原值进行大小写转变,转化后,不对MD5值截断

zgx_caid_md5

md5加密后的caid

string

若有idfa、idfv、caid,请全部回传,以增加设备的拼接率

md5转化前,不对原值进行大小写转变,转化后,不对MD5值截断

zgx_pre_caid_md5

md5加密后的caid

string

若有idfa、idfv、caid,请全部回传,以增加设备的拼接率

md5转化前,不对原值进行大小写转变,转化后,不对MD5值截断

mac

设备mac地址

string


device_brand

设备品牌

string


model

设备机型

string


os_version

操作系统版本

string


language

设备的系统语言

string


region

区域

string

md5转化前,不对原值进行大小写转变,转化后,不对MD5值截断

ip

设备ip

string

如果imei或imei_md5或idfa为空,该字段尽量上传,需要和ua一起上传

ua

设备User-Agent

string

如果imei或imei_md5或idfa为空,该字段尽量上传,需要和ua一起上传


































归因信息

time_ts

激活时间

bigint

设备激活的时间戳,定义为每个设备首次激活app的时间 兼容毫秒/秒级时间戳,不是click和show的时间戳。而且回传时间必须在次日凌晨1点之前,否则会有gap问题

click_id

点击id

string


ad_platform

广告投放平台

string

自建归因-渠道映射关系

ad_platform_sub

广告投放平台—自定义

string


ad_account_id

广告账户id

string

广点通:account_id;

巨量引擎:advertiser_id;

巨量广告体验版:advertiser_id;

磁力引擎:advertiser_id;

VIVO渠道:advertiserId

campaign_id

广告第一层级,广告组id

string

广点通:campaign_id;

巨量引擎:campaign_id;

巨量广告体验版:project_id;

磁力引擎:campaign_id;

VIVO渠道:campaignId

注意区分ad_id,上传之前核对下

campaign_name

广告第一层级,广告组名称

string

广点通:campaign_name;

巨量引擎:campaign_name;

巨量广告体验版:project_name;

磁力引擎:campaign_name;

VIVO渠道:campaignName

ad_id

广告第二层级,广告计划id

string

是(自然量、厂商渠道无计划id可不传)同一个设备的激活信息注意不要重复上传,多次上传容易引起数据GAP,去重规则(小时级别以当天最早的一次激活信息为准,天级别以当天最后一次激活信息为准

广点通:adgroup_id;

巨量引擎:ad_id;

巨量广告体验版:promotion_id;

磁力引擎:unit_id;

VIVO渠道:groupId

除了自然量、应用商店没有广告计划id可不传,其他投放渠道都必传广告计划id,否则会导致数据无法正常查看

ad_name

广告第二层级,广告计划名称

string

广点通:adgroup_name;

巨量引擎:ad_name;

巨量广告体验版:promotion_name;

磁力引擎:unit_name;

VIVO渠道:groupName

creative_id

广告第三层级,创意id

string

否(如果要使用增长参谋的素材效果分析功能,则本参数必传,详见 素材功能介绍

广点通:ad_id

巨量引擎:creative_id

磁力引擎:creative_id;

VIVO渠道:creativeId

mid1

针对巨量广告体验版,图片素材宏参数(下发原始素材id)

string













仅巨量广告体验版投放时需要回传的,根据素材类型,选择回传对应宏参

mid2

针对巨量广告体验版,标题素材宏参数(下发原始素材id)

string

mid3

针对巨量广告体验版,视频素材宏参数(下发原始素材id)

string

mid4

针对巨量广告体验版,搭配试玩素材宏参数(下发原始素材id)

string

mid5

针对巨量广告体验版,落地页素材宏参数(下发原始素材id)

string

mid6

针对巨量广告体验版,安卓下载详情页素材宏参数(下发原始素材id)

string

其他

touch_type

归因到的触点类型

string

click:点击

impression:展示

4. 签名计算

该步骤为了计算回调地址中的signature

4.1. 签名算法

请用上面提供的secretkey(PS:每次更新接入流程都会重新生成一个secretKey,注意要用最新生成的),结合对参数排序,以下面的方式生成signature,并更新到回调地址中的signature

4.2. 生成签名的示例代码
4.2.1 golang
4.2.2 Java

5. 请求示例

curl请求示例

第三步:接入检测

请在本页面(增长参谋)下方点击接入检测,一键检测数据接入结果。

第四步:接入成功

当您完成接入检测,且返回接入成功信息时,

请点击确认接入并进入【接入成功页面】,正式完成接入。

备注:联调期间的数据认为是测试数据,不会被使用,只有完成接入后,数据才会被计算。

响应错误码

错误码

错误信息

建议操作

0

success

成功

400005

invalid or missing params

检查必填参数是否丢失(具体参数请参考第二步第3点-请求参数上报)

400008

failed to get CSJ site id

url中是否有pg_site_id参数

400009

empty body

检查请求中的body是否为空

400010

invalid body

检查请求中的body是否为json格式

401002

user unauthorized

url中是否有signature参数,若有,请核查signature计算方式是否正确

500000

unknown error

服务内部错误,联系增长参谋

500001

internal error

服务内部错误,联系增长参谋

500104

DB operation error

服务内部错误,联系增长参谋

500105

send data error

服务内部错误,联系增长参谋

500106

data serialization error

内部参数序列化错误,联系增长参谋


Contents
Contact us