Reporting API 2.0 for Advertisers

目录

概览

Reporting API 为广告商提供程序化的方式来访问仪表板上的数据。对于您的所有应用程序,Reporting API 密钥都是一样的。每个应用程序都有一个唯一的 Reporting API ID,您可在其各自的应用页面上找到这个 ID。

主机

主机: https://report.api.vungle.com/ext/adv/reports/spend

认证

安全性在请求头中处理。您可以在 Vungle 仪表板上的报告页面找到您的 API 密钥。如果您还没有 API 密钥,请发送邮件至 tech-support@vungle.com 请求一个密钥!

请求头

密匙 说明
Authorization: Bearer [API Key] API 密匙
Vungle-Version: 1 API 版本
Accept: text/csvapplication/json 结果的可接受数据格式。默认为 text/csv

 

结果

  • 格式:我们支持请求头中指定的 JSON 和 CSV 输出。
  • 日期范围:提供长达六个月的历史信息。如要检查旧数据,请发送邮件给您的客户经理(tech-support@vungle.com)。
  • 如果没有数据:请注意,如果您的查询没有可用数据,Vungle 将会发回一个空白的 200 响应。这表明请求已成功,但没有可用数据返回。

资源:GET /报告/花费

过滤器参数

使用过滤器参数来将结果限制为您花费数据的一个子集。大多数过滤器是可选的,在此情况下,Vungle 将返回该过滤器的所有结果。

参数名称 格式 动作 如果不可用 示例
start ISO8601 日期 将结果集限制为不早于此日期的花费数据 拒绝请求 start=2017-01-01
end ISO8601 日期 将结果集限制为不晚于此日期的花费数据 拒绝请求 end=2017-01-02 
country  逗号隔开的 ISO 3166-1 二位字母国际代码列表 只返回匹配所列出的国家的花费数据 返回所有国家

country=US

country=US,CA

country=US,CA,AU
applicationId  逗号隔开的待返回 Vungle 应用程序 ID 列表 只返回所列出的应用程序的花费数据 返回所有应用程序

applicationId=586e201e242e3fd308000220

applicationId=586e201e242e3fd308000220,585849c3756684a50c0000a0
campaignId  逗号隔开的待返回 Vungle 活动 ID 列表 只返回所列出的活动的花费数据 返回所有活动

campaignId=586e201e242e3fd308000220

campaignId=586e201e242e3fd308000220,585849c3756684a50c0000a0

creativeId  逗号隔开的 Vungle 广告制作者 ID 列表 只返回所列出的广告制作者的花费数据 返回所有广告制作者

creativeId=586e201e242e3fd308000220

creativeId=586e201e242e3fd308000220,585849c3756684a50c0000a0

siteID 逗号隔开的发布商应用程序对象 ID 列表 只返回所列出的应用程序的花费数据 返回所有发布商

siteId=586e201e242e3fd308000220

siteId=586e201e242e3fd308000220,585849c3756684a50c0000a0

维度参数

使用维度来使您的报告呈现几分粒度。以逗号隔开的列表形式发送维度参数下的维度。如果您没有明确要求一个维度,Vungle 不会根据那个维度来分解报告。

使用维度参数

参数名称 格式 示例
dimensions 逗号隔开的特定字符串列表,列在下表中

dimensions=platform

dimensions=campaign,creative,date

 

可用维度

维度
名称
返回 返回示例
platform 按平台字符串分组
platform
iOS
campaign 按活动 ID 和活动名称分组
campaign id campaign name
58086457cdf5f9eb6d000060 Toy Blast iOS CA iPhone
date  按日期分组
date
2017-01-01
country 按国家分组
country
US
creative 按广告制作者 ID 和广告制作者姓名分组
creative id creative name
58086457cdf5f9eb6d000060 Toy Blast Landscape IEC
site 按发布商应用程序对象 ID 和发布商应用程序名称分组
site id site name
58086457cdf5f9eb6d000060 Sonic Dash iOS

 

对于需要名称查找(例如,站点名称)的维度,如果 Vungle 不能检索查找,我们将返回一个‘未知“字符串来代替名称。

总量参数

使用总量来定义哪种广告效果数据让您感兴趣。以逗号隔开的列表形式发送总量参数下的总量。如果一个总量不在列表中,Vungle 将认为您不想接收该数据。

使用总量参数

参数名称 格式 示例
aggregates 逗号隔开的特定字符串列表,列在下表中

aggregates=views

aggregates=views,installs,ecpm

 

可用总量

维度
名称
返回
views 整数
completes 整数
clicks  整数
installs  整数
spend  整数
ecpm (花费 * 1000 / 观看数)作为一个浮点数

 

查询和响应示例

示例 1:JSON 花费

请求

curl -i -H "Authorization: Bearer [API KEY]" -H "Vungle-Version:1" -H "Accept:application/json" -X GET "https://report.api.vungle.com/ext/adv/reports/spend?apiKey=987654321&dimensions=date,country,platform&aggregates=views,spend&start=2017-03-01&end=2017-03-05"

响应


[
    {
        "platform" : "iOS",
        "date": "2016-09-29",
        "country": "US",
        "views": 1234,
        "spend": 123.0
    },
    {
        "platform" : "Android",
        "date": "2016-09-29",
        "country": "CA",
        "view": 35,
        "spend": 2.0
    },
    ...
]

示例 2:CSV 花费

请求

curl -i -H "Authorization: Bearer [API KEY]" -H "Vungle-Version:1" -H "Accept:application/json" -X GET "https://report.api.vungle.com/ext/adv/reports/spend?dimensions=date,country,platform&aggregates=views,spend&start=2017-03-01&end=2017-03-05"

响应

Platform,date,country,views,spend
ios,2017-03-01,US,1234,123.0
ios,2017-03-01,CA,35,2.0

Example 3: ID/Name Expansion

请求

curl -i -H "Authorization: Bearer [API KEY]" -H "Vungle-Version:1" -H "Accept:application/json" -X GET "https://report.api.vungle.com/ext/adv/reports/spend?dimensions=campaign&aggregates=views,spend&start=2017-03-01&end=2017-03-05"

响应


[
    {
        "campaign id" : "12345678",
        "campaign name": "test campaign 1",
        "views": 1234,
        "spend": 123.0
    }
]
还有其它问题?提交请求

评论