Publisher Reporting API 2.0

目录

概览

Reporting API能够让开发者自行开发程序来获取变现相关数据。您的 Reporting API Key是账户层级的,您的每个应用都使用的同一个Key。

主机

主机: https://report.api.vungle.com/ext/pub/reports/performance

认证

请在Vungle Dashboard此处Reports page 寻找您的API Key。如果您找不到您的API Key,请邮件联系tech-support@vungle.com

请求头

密匙 说明
Authorization: Bearer [API Key] API 密匙
Vungle-Version: 1 API 版本
Accept: text/csv or application/json Accepted data format for results.Default is text/csv.

 

结果

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

资源:GET /报告/广告效果

过滤器参数

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

请注意日期格式请使用如下2017-01-01格式。任何其他日期格式都是非法的。

参数名称 格式 动作 如果不可用 示例
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
incentivized ‘true’/’false’ or 1/0

只返回奖励或非奖励流量的广告效果数据

须知: Rewarded ads在某些时候也被称为incentivized ads。这两者名字不同,但是指的是同一种广告形式。在SDK代码中,我们使用incentivized。

返回奖励和非奖励流量的广告效果数据

incentivized=true

incentivized=false
adType 用逗号形式,返回所有广告类型

返回指定广告类型。

返回所有广告类型。 adType=video
adSize 用逗号形式,返回广告尺寸。 返回所有广告尺寸的数据。 返回所有广告尺寸。 adSize=320x50

维度参数

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

使用维度参数

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

dimensions=platform

dimensions=application,date,country

 

可用维度

维度 返回 返回示例
platform 按平台字符串分组
platform
iOS
application 按 Vungle 应用程序 ID 和名称分组
application id application name
58086457cdf5f9eb6d000060 Sonic Dash
展示位置

按广告位置 ID 和名称分组。

对于那些仍在使用不支持广告位置的 Vungle SDK v. 4.1 和更低版本的应用程序,广告位置 id 和广告位置名称将在我们的报告中显示为空,但诸如观看数和发布商收入等聚合值仍是准确的。也就是说,未更新的设备仍将显示在报告中,但广告位置分解部分将是空的。

placement id placement name
12345678 Level 3
date  按日期分组。
date
2020-01-01
country 按国家分组。
country
US
incentivized

按是否为奖励广告分组

须知: Rewarded在某些时候也被称为incentivizedads。这两者名字不同,但是指的是同一种广告形式。在SDK代码中,我们使用 'incentivized'。

incentivized
true
false
adType 按类型分组。
adType
video
adSize 按尺寸分组。
adSize
320x50

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

总量参数

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

使用总量参数

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

aggregates=views

aggregates=views,ecpm

 

可用总量参数

维度 返回
impressions integer
views integer
completes integer
clicks  整数
revenue  float
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/pub/reports/performance?dimensions=date,country,platform&aggregates=views,revenue&start=2020-03-01&end=2020-03-05"

响应


[
    {
        "platform" : "iOS",
        "date": "2020-03-01",
        "country": "US",
        "views": 1234,
        "revenue": 123.0,
        "ecpm": 99.67,       
    },
    {
        "platform" : "iOS",
        "date": "2020-03-01",
        "country": "CA",
        "view": 35,
        "revenue": 2.0,
        "ecpm": 57.14,
    },
    ...
]

示例 2:CSV 收入

请求


curl -i \
-H "Authorization: Bearer [API KEY]" \
-H "Vungle-Version:1" \
-H "Accept:text/csv" \
-X GET "https://report.api.vungle.com/ext/pub/reports/performance?dimensions=date,country,platform&aggregates=views,revenue&start=2020-03-01&end=2020-03-05" 

响应

 
Platform,date,country,views,revenue 
ios,2020-03-01,US,1234,123.0 
ios,2020-03-01,CA,35,2.0
... 

Example 3: Placement

请求

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

响应


[
    {
        "placement id" : "12345678",
        "placement name": "level 3",
        "views": 1234,
        "revenue": 123.0
    }
]

Questions?

Need further assistance, feel free to reach out to us, we’re here to help!

这篇文章有帮助吗?