广告投放报表_进阶版
需要携带 Token,详情看 Token
拉取报表数据时机说明: 数据会在当天过后 3 小时左右可以拉取。建议第二天凌晨 3 点后拉取。举例说明:假设拉取东八区 8 月 1 日的数据,需要在东八区 8 月 2 日凌晨 3 点后才能拉取。
本章节文档将介绍广告投放报表_进阶版接口。你可以调整 dimension_option 参数进行查询特定的维度。调用该接口需分成两个步骤:
首先需要设置参数 type=1 并调用接口,系统会在服务端异步生成好数据。当接口返回码 code=200,说明数据已经成功生成。
数据生成后,设置参数 type=2 再次调用接口即可直接下载数据。
若数据还没生成完,调用 type=2 接口会返回非 200 的 code。 若数据已经生成,使用 type=2 接口会直接返回文件字节流(Content-Type: application/octet-stream)。
请求地址
https://ss-api.mintegral.com/api/v2/reports/data
请求方法
GET
请求示例
json
GET /api/v2/reports/data
HTTP/1.1 Host: ss-api.mintegral.com
Content-Type: application/json
// 异步生成数据
{
"start_time":"2020-02-01",
"end_time":"2020-02-03",
"timezone":"+8",
"type":1,
"dimension_option": "Offer"
}
// 异步生成数据接口返回成功后,可以请求type=2来获取文件字节流
{
"start_time":"2020-02-01",
"end_time":"2020-02-03",
"timezone":"+8",
"type":2,
"dimension_option": "Offer"
}
请求参数
字段 | 类型 | 说明 | 默认值 | 例子 |
---|---|---|---|---|
timezone 选填 | string | 数据对应的时区 | "+8" | "+8" |
start_time | string | 请求数据的开始时间, 格式为 YYYY-mm-dd 。只支持查询最近半年的数据。 | — | "2020-02-01" |
end_time | string | 请求数据的结束时间, 格式为 YYYY-mm-dd 。结束时间和开始时间的时间跨度不超过 7 天。 | — | "2020-02-03" |
dimension_option | string | 可选的字段名: "Offer" , "Campaign" , "Creative" , "AdType" , "Sub" , "Package" , "Location" . 多个字段用,分隔.dimension_option=> "Offer" ,按 Offer ID, Offer Name, UUID 细分数据;dimension_option=> "Campaign" , 按 Campaign ID 细分数据;dimension_option=> "Creative" , 按 Creative ID, Creative Name 细分数据;dimension_option=> "AdType" , 按 Ad Type 细分数据;dimension_option=> "Sub" , 按 Sub ID 细分数据;dimension_option=> "Package" , 按 Package Name 细分数据;dimension_option=> "Location" ,按 国家/地区 细分数据;不支持请求的组合里同时具有下列枚举值组合: Creative & Sub Creative & Package Creative & time_granularity = hourly | - | "Offer,Location" |
time_granularity 选填 | string | 按 小时/天 细分数据. 枚举值: "hourly" , "daily" . | "daily" | "hourly" |
type 选填 | int | type => 1, 拉取数据请求获取当前请求条件的数据状态。 type => 2, 下载数据。 | 1 | 1 |
type=1 的响应结果
字段 | 类型 | 说明 |
---|---|---|
code | int | 200 => 生成数据完成,可使用 type=2 获取数据。201 => 接收请求成功,等待生成数据。202 => 数据正在生成中。207 => 结束日期和开始日期不得相差超过8天, 并且结束日期需要早于今天。 |
msg | string | 成功,返回相应的成功信息,失败返回相应的错误信息 |
data | json | 成功,返回 null,失败返回具体的错误信息 |
type=2 的响应结果(code 不是 200)
字段 | 类型 | 说明 |
---|---|---|
code | int | 203 => 没有接收到相同条件请求,请先使用 type=1 发起请求生成数据。204 => 数据还没生成,请等待生成数据。205 => 数据已经过期(生成的数据保留 1 个月),正在重新生成中。207 => 结束日期和开始日期不得相差超过8天, 并且结束日期需要早于今天。 |
msg | string | 失败返回相应的错误信息 |
data | json | 失败返回具体的错误信息 |
应答示例
json
{
"code": 200,
"msg": "success",
"data": null
}