Advertiser Reporting API 2.0

Vungle Agent

2022年11月09日 03:27

概览

Reporting API能够让广告主自行开发程序来获取买量相关数据。您的 Reporting API Key是账户层级的，您的每个应用都使用的同一个Key。

主机

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

安全认证

Security is handled in the request header. 请在您Liftoff Direct Dashboard2 Account 页面获取Reporting API Key。如果您没有找到，请发邮件给 tech-support@vungle.com 来获取。

Request Headers

Key	Value	描述
Authorization	Bearer [API Key]	API Key
Vungle-Version	1	API Version
Accept	text/csv or application/json	返回数据格式。默认为text/csv。

结果

格式：我们支持请求头中指定的 JSON 和 CSV 输出。
日期范围：提供长达六个月的历史信息。如要检查旧数据，请发送邮件给您的客户经理或联系tech-support@vungle.com。
时区：默认使用UTC时区，目前时区不可修改。
如果没有数据：请注意，如果您的查询没有可用数据，Liftoff 将会发回一个空白的 200 响应。这表明请求已成功，但没有可用数据返回。

Resource: GET /reports/spend

过滤器参数

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

参数名称	格式	Action	如果不可用	示例
`start`	ISO8601 日期	查询数据开始日期。	拒绝请求	`start=2019-01-01`
`end`	ISO8601 日期	查询数据结束日期。	拒绝请求	`end=2019-01-02`
`country`	逗号隔开的 ISO 3166-1 二位字母国际代码列表	只返回指定国家的花费数据。	返回所有国家	返回所有国家 Returns all countries `country=US,CA,AU`
`applicationId`	逗号隔开的待返回 Vungle 应用程序 ID 列表	返回指定应用花费数据	返回所有应用程序	`applicationId=586e201e242e3fd308000220` `applicationId=586e201e242e3fd308000220,585849c3756684a50c0000a0`
`campaignId`	逗号隔开Liftoff campaign IDs	返回指定campaigns的数据	返回所有campaigns	`campaignId=586e201e242e3fd308000220` `campaignId=586e201e242e3fd308000220,585849c3756684a50c0000a0`
`creativeId`	逗号隔开Liftoff creative IDs	返回指定creatives的花费数据	返回所有creatives	`creativeId=586e201e242e3fd308000220` `creativeId=586e201e242e3fd308000220,585849c3756684a50c0000a0`
`siteId`	逗号隔开site IDs	返回指定sites的花费数据	返回所有sites的数据	`siteId=586e201e242e3fd308000220` `siteId=586e201e242e3fd308000220,585849c3756684a50c0000a0`
`accountId`	逗号隔开account IDs	返回指定accounts的花费数据	返回所有accounts	`accountId=58e71dd7294039844b0001c7`
`placementId`	逗号隔开placement IDs	返回指定placements的花费数据	返回所有placements	`placementId=5bc9877224291f02aee8741c`
`adType`	逗号隔开ad types	返回指定ad types的花费数据	返回所有ad types	`adType=banner,mrec,video,fullscreen`
`adSize`	逗号隔开ad sizes	返回指定ad sizes的花费数据	返回所有ad sizes	`adsize=728x90,default,320x50,300x50`

维度参数

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

使用维度参数

参数名称	格式	示例
`dimensions`	逗号隔开的特定字符串列表，请查看下表示例	dimensions=platform `dimensions=campaign,creative,date`

可用维度

维度	返回	返回示例	Endpoints
`platform`	按platform分组	platform `iOS`	`spend`
`account`	Grouped by Liftoff Account ID	account `5808AA57cdf5f9eb6d000060`	`spend`
`application`	按application ID 和 application Name分组	application ID `58086457cdf5f9eb6d000060` application name `Toy Blast iOS`	`spend`
`campaign`	按campaign ID 和 campaign Name分组	campaign ID `58086457cdf5f9eb6d000060` campaign name `Toy Blast iOS CA iPhone`	`spend`
`date`	按date分组	date `2019-01-01`	`spend`
`country`	按country分组	country `US`	`spend`
`creative`	按 creative ID 和 creative name分组	creative ID `58086457cdf5f9eb6d000060` creative name `Toy Blast Landscape IEC`	`spend`
`site`	按 publisher app object ID 和 publisher app name分组	site ID `58086457cdf5f9eb6d000060` site name `Sonic Dash iOS`	`spend`
`展示位置`	按 `placement`分组	`placement_id 599306279c57ddf458005ee2`	`spend`
`adType`	按 `adType`分组	`banner`	`spend`
`adSize`	按 `adSize`分组	`728x90`	`spend`

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

总量参数

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

总量参数

参数名称	格式	示例
`aggregates`	逗号隔开的特定字符串列表，请查看下表示例	`aggregates=views` `aggregates=views,installs,ecpm`

可用总量

维度	返回	Endpoints
`views`	integer	`spend`
`completes`	integer	`spend`
`clicks`	integer	`spend`
`installs`	integer	`spend`
`spend`	integer	`spend`
`ecpm`	(spend * 1000 / views) as a float	`spend`
`eCPI`	(spend /install ) as a float	`spend`
`CTR`	(clicks/impressions) as a float	`spend`
`IR`	(installs/clicks) as a float	`spend`
`IPM`	(installs/impressions) *1000 as a float	`spend`

Example 1: JSON Spend


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=2019-01-01&end=2019-01-01"

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

Example 2: CSV Spend

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

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=2019-01-01&end=2019-01-01"

[
 {
  "campaign id" : "12345678",
  "campaign name": "test campaign 1",
  "views": 1234,
  "spend": 123.0       
 }
]

概览

主机

安全认证

Request Headers

结果

Resource: GET /reports/spend

过滤器参数

维度参数

使用维度参数

可用维度

总量参数

总量参数

可用总量

Example 1: JSON Spend

Example 2: CSV Spend

Example 3: ID/Name Expansion

Questions?