注意:接入Api前请先熟悉api签名机制(参考接口鉴权说明), 即Api请求样例中的一些http请求头的来源
1 请求URL
https://openapi.toponad.com/v3/report/creative_review
2 请求方式
POST
3 请求参数
字段 | 类型 | 是否必传 | 备注 | 样例 |
date | Int | Y | 日期 | 20221229 |
group_by | Array[String] | N | 维度分组 date_time(时间) offer_pkg(推广包名) offer_app_name(推广产品) platform(系统平台) offer_type(素材类型) offer_title(素材标题) offer_oss_url(素材内容) geo(地区) app(应用) placement(广告位) unit(广告源) nw_firm(广告平台) format(广告类型) |
["date_time","offer_oss_url"] |
offset | int | N | 偏移数,代表从第几条数据开始,默认为0 | 0 |
limit | int | N | 返回数量,上限1000 | 100 |
4 响应参数
字段 | 类型 | 是否必传 | 备注 | 样例 |
records | Array[Object] | Y | 记录,对象数组每个record结构见下面records元素结构 | |
count | Int | Y | 总条数 |
records元素结构如下:
字段 | 类型 | 是否必传 | 备注 | 样例 |
date_time | Int | N | 时间,group_by维度有选date_time才返回 | |
offer_pkg | String | N | 推广包名,group_by维度有选offer_pkg才返回 | |
offer_app_name | String | N | 推广产品,group_by维度有选offer_app_name才返回 | |
platform | String | N | 系统平台,group_by维度有选platform才返回 | |
offer_type | String | N |
素材类型,group_by维度有选offer_type才返回,枚举说明: Image: 图片 Video: 视频 |
|
offer_title | String | N | 素材标题,group_by维度有选offer_title才返回 | |
offer_oss_url | String | N | 素材内容,group_by维度有选offer_oss_url才返回 | |
geo | String | N | 地区(两字符短码),group_by维度有选geo才返回 | |
app | String | N | Taku应用名字,group_by维度有选app才返回 | |
placement | String | N | Taku广告位名字,group_by维度有选placement才返回 | |
unit | String | N | Taku广告源名字,group_by维度有选unit才返回 | |
nw_firm | String | N | 三方广告平台名字,group_by维度有选nw_firm才返回 | |
format | String | N | 广告类型,group_by维度有选format才返回 | Native |
impression | Int | Y | 展示 | |
click | Int | Y | 点击 | |
ctr | String | Y | 点击率 | |
currency | String | Y | 币种 | USD |
estimated_revenue | Double | Y | 预估收益,币种为返回参数的currency | |
estimated_ecpm | String | Y | 预估eCPM,币种为返回参数的currency |
5 样例
请求样例:
curl --location --request POST 'https://openapi.toponad.com/v3/report/creative_review' \
--header 'X-Up-Key: 877f8ae9c6e9ca82c0==5b5fff594c373axxx' \
--header 'X-Up-Signature: CE12B506DBCD868C2C6F09E08C139CBC' \
--header 'X-Up-Timestamp: 1626161553000' \
--header 'Content-Type: application/json' \
--data-raw '{
"date":20221227,
"group_by":["offer_oss_url","date_time","platform","app"],
"offset":0,
"limit":50
}'
响应样例:
{
"count": 19,
"data": [
{
"data_time": 20221227,
"offer_oss_url": "https://material-files.anythinktech.com/create/dt=20221013/hh=0/1665685821473074334",
"offer_type": "Image",
"platform": "Android",
"app": "Uparpu_Demo",
"format": "Native",
"impression": 40,
"click": 0,
"ctr": "0",
"estimated_revenue": 0.08,
"estimated_ecpm": "2.00"
},
{
"data_time": 20221227,
"offer_oss_url": "https://material-files.anythinktech.com/create/dt=20221022/hh=0/1666462984126232524",
"offer_type": "Image",
"platform": "Android",
"app": "Uparpu_Demo",
"format": "Native",
"impression": 36,
"click": 0,
"ctr": "0",
"estimated_revenue": 0.07,
"estimated_ecpm": "1.94"
},
{
"data_time": 20221228,
"offer_oss_url": "https://material-files.anythinktech.com/create/dt=20221228/hh=0/1672252656657306708.mp4",
"offer_pkg": "engine.tuibear2.com",
"offer_app_name": "领话费",
"offer_type": "Video",
"offer_title": "话费优惠券待领取",
"platform": "Android",
"app": "Uparpu_Demo",
"format": "Native",
"impression": 1,
"click": 1,
"ctr": "0.99",
"estimated_revenue": 1,
"estimated_ecpm": "1000.00"
}
]
}