English
Log In
You can then view all documents
GroMore/GroMore SDK与API接入/API上传三方数据使用说明文档
API上传三方数据使用说明文档
Last updated 2022-05-12 14:42:47

1.文档说明

通常情况下,开发者可在穿山甲后台【广告网络】模块下,配置ADN API参数即可自动拉取API数据,但部分广告网络平台未全部开放report api权限,且支持自动拉数的广告平台数量有限,这时就需要开发者自行将三方数据下载后,手动上传至GroMore,提高您的看数效率。

GroMore提供专门的接口,用户可以先行对数据处理后通过接口回传给GroMore,GroMore将数据匹配后披露至相关数据报表中。

2.注意事项

1) T日仅支持T-1~T-7日数据上传

2)已在【广告网络】中配置自动拉取API数据的ADN暂不支持通过该接口回传数据

3)目前支持上传请求量、返回量、展示量、点击量与收入,其余数据如填充率、展示率、eCPM等数据,GroMore会根据您上传的值计算得到

4)本次需求也支持自定义ADN数据上传

5)成功上传后会在5min内生效

3. 权限认证

若您已经接入GroMore管理API,则权限认证方式相同,您可跳过该部分,直接查看下一部分:三方数据回传接口

校验说明

  1. 客户端逻辑:生成签名字符串:客户端将 API 请求参数根据字典序排序后再通过 = 和 & 拼接好参数名和对应的值(比如a=1&b=2),最后在加上 security_key 得到一个签名字符串。生成签名:客户端使用 MD5 哈希算法对第一步生成的签名字符串进行签名,得到数字签名。
  1. 服务端逻辑:生成签名:在接到请求后会重复上面客户端的两个步骤得到当前请求期望的数字签名。验证签名:用期望的数字签名和客户端发送过来的数字签名做比对,如果完全一致则认为该请求通过安全验证,否则直接拒绝该请求。

Python程序示例

Java程序示例

4. 三方数据回传接口

请求url:https://www.csjplatform.com/union_media/open/api/mediation/upload_report_data

4.1 请求参数

名称

类型

描述

校验规则

是否必填

user_id

integer

媒体账号id

对应账号必须存在且状态为"运行中"

role_id

integer

子账号id,若使用主账号,则此处填写主账号ID

对应子账号必须存在且从属于主账号;子账号拥有聚合权限;

timestamp

integer

时间戳(毫秒)

请求提交时间的十分钟内

sign

string

通过指定哈算算法生成的签名,用于校验token

存在且不为空;使用指定算法验签

sign_type

string

哈希算法(取值MD5)

只能使用已支持的算法(MD5)

version

string

API版本号

固定版本号:"2.0"

network_id

integer

广告网络id,固定ADN见映射表,自定义ADN的id在平台查看

只能是目前已支持/已配置的广告网络

注意:已在【广告网络】中配置自动自动拉取API数据的ADN暂不支持通过该接口回传数据

report_data

map<string, list<CustomReportData>>

报表数据:key:日期(格式为yyyy-MM-dd); value: 当前日期的收益数据

注意:该参数不用于签名字符串的生成,请勿将该参数拼接至签名字符串

日期必须合法,且不能超过7天,T日只支持上传(T-1~(T-7)日数据。

CustomReportData

名称

类型

描述

校验规则

是否必填

app_id

string

adn对应的app id(非穿山甲appid)

已在平台上配置

ad_slot_id

string

adn对应的代码位ID

已在平台上配置

request_count

integer

请求量

>= 0

return_count

integer

返回量

>= 0

show_count

integer

展示量

>= 0

click_count

integer

点击量

>= 0

revenue

double

收入,单位:元

>= 0

4.2 响应参数

名称

类型

描述

code

string

返回错误码。100为成功

message

string

错误信息。详细的错误信息会体现在这里。

4.3 请求示例

请求url:https://www.csjplatform.com/union_media/open/api/mediation/upload_report_data

请求method: POST

请求body:

响应示例:

附录

错误码

响应错误码

错误码

描述

解决方案

100

成功

-

115

参数错误。具体的错误信息披露在message中,其中包含了服务内部的code和msg。例如:"GM1903: 上传的数据含有非法的值"

请根据报错信息检查参数后重新上传;请注意,若在report_data中所传非法数据,那么该条数据会被过滤,其余数据会上传成功

116

服务内部错误

请根据具体报错信息处理

内部错误码

错误码

描述

解决方案

GM1305

广告网络非法

请检查广告网络ID是否填写正确,只能是目前已支持/已配置的广告网络

GM1901

日期与指定的格式不符

格式为yyyy-MM-dd

GM1902

您上传的数据均未匹配到对应的代码位,请检查数据是否上传正确

-

GM1903

您上传的数据存在非法字符,非法数据将被过滤,其余数据将会正常上传

-

GM1904

仅支持上传(T-1)~(T-7)日内的数据,您上传的数据中存在超出时间范围内的数据,该部分数据会被过滤,其余数据将会正常上传

-

GM1905

您已配置通过自动拉取该广告网络API数据,无需手动回传数据

已在【广告网络】中配置自动自动拉取API数据的ADN暂不支持通过该接口回传数据,自动拉取API数据更方便。

固定ADN映射表:

广告平台ID

广告平台名称

币种

1

穿山甲

使用当前账号的币种

2

Admob

usd

3

优量汇

cny

4

Mintegral

usd

5

百度

cny

6

Unity

usd

7

快手

cny

8

Sigmob

cny

9

游可盈

cny

自定义ADN的广告网络ID请至【GroMore】-【广告网络】-【自定义广网络】处查看


Contents
Contact us