English
Log In
You can then view all documents
AdSpark(增长参谋)/技术接入文档/其他数据类型接入文档/运营成本&内购收益数据接入说明
运营成本&内购收益数据接入说明
Last updated 2024-07-19 09:53:25

接口介绍

该接口用于开发者将运营成本&内购收益数据回传给AdSpark。

重点提示

  1. 请求签名signature:需要根据分配的secret_key对参数计算,然后添加到请求body里
  1. 回调地址:一个应用对应一个独立的回调地址,切勿用同一个回调地址,会对应401002的错误码
  1. content-type 使用的方式:application/json,使用错误会导致接口报错
  2. 回传时机:产生提现行为回传即可,不限次数,不区分新老设备,建议实时回传(实时roi更准,为开发者投放提供参考),并在次日凌晨1点前完成前一天数据的上报(1点之后的数据不参与计算)
  3. 回传类型激活设备产生的变现或者运营成本,否则不会计入系统

自助接入入口

AdSpark -> 接入管理 -> 运营成本和内购收益数据 -> 立即接入

接入操作

第一步:获取运营成本&内购收益数据上报地址、签名秘钥

1. 回调地址

以下地址为AdSpark提供回调地址,您可以根据自助接入流程进行获取,复制地址链接,并在地址后添加根据31.签名算法指引生成的signature使用,该回调地址将用于后续上报请求。

复制

2. 签名密钥

您可以根据自助接入流程获取AdSpark分配的ecretKey(用于计算signature),根据3.1.签名算法的指引生成signature使用

复制

第二步:数据上报

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

1.请求信息

接口地址:根据自助接入流程获取数据上报地址

Method:Post

Content-Type:Application/json

2.请求上报参数

注意:所有的md5均采用32位小写



字段英文名

字段中文名

类型

是否必填

说明

通用信息

site_id

在穿山甲平台绑定的应用ID

long

根据上传的siteID自动绑定包名

设备信息

bd_did

非常重要,建议通过回调的方式获取,由于参数获取可能存在一定的延迟性,所以建议通过回调的方式获取,以及回调后,再通过Applog.getDid( )方法确保一定获取,详细可以参考>>>


附:Android和IOS获取did的方法

string

尽量回传,以提升设备的拼接率

若不回传did,内购事件无法匹配到对应激活归因,参谋会使用其他设备ID(imei、oaid、idfa等)兜底,建议开发者尽量回传bd_did

imei

安卓设备唯一标识:imei

string

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


imei_md5

安卓设备唯一标识:md5加密后的imei

string


oaid

安卓设备唯一标识:oaid

string


oaid_md5

安卓设备唯一标识:md5加密后的oaid

string


android_id

安卓设备唯一标识:android_id

string


android_id_md5

安卓设备唯一标识:md5加密后的android_id

string


google_aid

安卓设备唯一标识:google_aid

string


google_aid_md5

安卓设备唯一标识:md5加密后的google_aid_md5

string


idfa

IOS设备唯一标识:idfa

string

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


idfa_md5

IOS设备唯一标识:md5加密后的idfa

string


idfv

IOS设备唯一标识:idfv

string


idfv_md5

IOS设备唯一标识:md5加密后的idfv

string


ip

设备ip

string


ua

设备User-Agent

string


os_version

操作系统版本

string


model

设备机型

string


language

设备的系统语言

string


device_brand

设备品牌

string


region

设备所在地区

string


mac

设备mac地址

string


事件数据

unique_id

开发者侧,对数据的唯一标识符

string


时间戳

time_ts

发生时间戳,单位ms

long


事件类型

event_type

事件类型:
IAP=IAP变现收益
REWARD_COST=激励提现成本
OTHER_ADN_INCOME=其他ADN广告变现收益

string


数据类型

data_type

数据类型:0=全部

int


数据值

data_value

数据值(单位:分),当日IAP变现收益/当日用户提现成本/当日其他ADN IAA变现收益中的某一个值,基于event_type决定

long

是(两个字段二选一必传,且大于0)


data_value_thousandth_fen

数据值(单位:千分之一分),与data_value仅单位区别,1元=100000

long


3.签名计算

该步骤为了计算上报地址中的signature

3.1.签名算法

请用上面提供的secret_key按如下方式生成signature

复制
3.2.生成签名
3.2.1 golang
复制
3.2.2 Java
复制

4.请求示例

curl请求示例

数据接口
复制

curl响应结果:

复制

第三步:接入检测

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

第四步:接入成功

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

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

响应错误码

错误码

错误信息

建议操作

0

success

成功

400005

invalid or missing params

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

400008

failed to get CSJ site id

url中是否有site_id参数

400009

empty body

检查请求中的body是否为空

400010

invalid body

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

401002

user unauthorized

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

500000

unknown error

服务内部错误,联系AdSpark

500001

internal error

服务内部错误,联系AdSpark

500104

DB operation error

服务内部错误,联系AdSpark

500105

send data error

服务内部错误,联系AdSpark

500106

data serialization error

内部参数序列化错误,联系AdSpark

内购收益GAP常见问题

  1. 开发者使用内购收益APi回传内购收益时设备号缺失,导致和激活拼接失败,AdSpark平台不展示;
  2. 媒体传参错误,如 ① 传非当天数据, time_ts应该使用传数据时候的时间戳;② 4号激活 ,5号回传该用户内购数据(归在4号的T+1);③ 重复回传等;
  3. 若报表勾选广告计划名称后,累计内购收益没有数据,可以自查下广告状态是否是关停状态;
  4. 若开发者使用api接入内购数据,从取数的优先级上 api > 授权,即报表会展示通过api接口上传的内购收益;
  5. 和巨量平台的内购收益GAP:巨量接收数据单位目前只精确到元,AdSpark上报的数据部分会被巨量抹除;


Contents
Contact us