数据拉取API

Avatar
Service

OpenMediation 向开发者提供API方式拉取广告变现数据，开发者可以自由地使用这部分数据，进行进一步分析。

可以按照如下截图方式获得数据拉取API需要用到的API密钥。对于数据有任何疑问，可以随时联系您的客户经理。

 

01_Reporting_API_Key_____.jpg02_Reporting_API_Key_____.jpg

 

认证

为了能够正确的拉取到数据，需要在请求参数中添加“token=”， 或者使用认证标头 "Authorization: Token ".

如果验证失败，将会返回如下信息：

401 “Access token required.”
401 “Invalid token.”

 

请求格式

请使用如下GET请求拉取数据：

https://sdk.adtimingapi.com/report/v2

 

请求参数

参数 类型 描述 是否必填
token String API认证密钥，可以在平台页面中获取 否（可以使用认证标头的方式）
format String 返回内容格式，CSV或JSON，默认为JSON 是
encoding String

编码格式，GBK或者UTF-8

默认不填写

 否
start String 起始日期，日期格式为 ‘yyyy-MM-dd’。

起始日期不得早于30天前

 是
end String 结束日期，日期格式为 ‘yyyy-MM-dd’。

请求数据的时间跨度不得大于7天

 是
appKey String

appKey列表，逗号分隔

默认不填写，拉取所有app的数据

 否
metrics String

请求数据的指标列表，逗号分隔

可以使用的指标包括：

  • availabilityCheck
  • availabilityResponse
  • requestCount
  • filledCount
  • apiRequest
  • apiFilled
  • imprCount
  • clickCount
  • apiImpr
  • apiClick
  • revenue
提示：

availabilityCheck 和 availabilityResponse 指标只在广告位以上层级的维度中有效

 否
breakdowns String

请求数据的维度列表，逗号分隔

可以使用的维度包括：

  • placement
  • country
  • instance
  • scene
  • adNetwork
  • app
提示：
  • Scene 和 adNetwork 维度不能同时使用。
  • Scene 和 instance 维度不能同时使用。
  • 当维度包括scene时，有效的数据指标只有 imprCount 和 clickCount
 否
timeDimension String

时间粒度

有效的粒度包括

  • hour（只有非api数据指标拥有该粒度的数据）
  • day
  • all
 是
adnId Integer

筛选某个Ad Network的数据

默认返回所有Ad Network数据

 否

 

Ad Network

Ad Network adnId
AdTiming 0
AdMob 1
FaceBook 2
UnityAds 3
Vungle 4
Tencent Ads 5
AdColony 6
AppLovin 7
MoPub 8
Tapjoy 10
Chartboost 11
Pangle 12
Mintegral 14
ironSource 15
Helium 17

请求举例：

  • 请求Instance 维度的数据指标
curl 'https://sdk.adtimingapi.com/report/v2?format=csv&appKey=REPLACE_WITH_YOUR_APPKEY&breakdowns=app,placement,country,adNetwork,instance&metrics=requestCount,filledCount,apiRequest,apiFilled,imprCount,clickCount,apiImpr,apiClick,revenue&start=2020-10-13&end=2020-10-13&timeDimension=day&token=REPLACE_WITH_YOUR_TOKEN' --output stats.csv
  • 请求Scene维度的数据指标
https://sdk.adtimingapi.com/report/v2?format=json&appKey=REPLACE_WITH_YOUR_APPKEY&breakdowns=app,placement,scene&metrics=imprCount,clickCount&start=2020-10-13&end=2020-10-13&timeDimension=day&token=REPLACE_WITH_YOUR_TOKEN

 

注意：

请求数据的维度过多可能会造成CSV大小呈指数级增长，可能会导致请求超时。如果任务处理时间超过60秒，则直接返回超时。

 

状态代码

服务器将使用如下代码，表示当前请求的结果：

代码 描述
200 The request succeeded.
400 Param error
The start time format error, the date format like ‘yyyy-MM-dd’.
The end time format error, the date format like ‘yyyy-MM-dd’.
The end time cannot be less than the beginning time.
The query time range is over 7 days.
Unable to query data from a month ago.
Format required.
Invalid type.
timeDimension required.
Format is unsupported charset.
Invalid time dimension.
Scene and instance are mutually exclusive.
Invalid metric ‘%s’ in metrices.
Invalid breakdown ‘%s’ in breakdowns.
Invalid metric ‘%s’ in metrices.When breakdown contains the scene, the metrics can only be imprCount and clickCount.
Invalid metric ‘%s’ in metrices.AvailabilityCheck and AvailabilityResponse Only valid in placement and above dimensions
Invalid app key.
Invalid adnId.
401 The Token is missing from the request or invalid.
Access token required.
Invalid token.
403 Users account has been disapproved.
500 The request failed for an unknown reason.
503 The service is unavailable.

 

返回内容

参数 类型 描述
day String 日期格式 ‘yyyyMMdd’
hour String 小时格式 ‘HH’，24小时制
appKey String 平台分配的AppKey
appId String 平台分配的AppId
appName String App 名称
platform String 系统平台，例如‘iOS’ 或 ‘Android’
placementId Integer 广告位Id
placementName String 广告位名称
adNetwork Integer adNetwork ID
instanceId Integer 广告分层 ID
instanceName String 广告分层名称
sceneId Integer 广告场景 ID
sceneName String 广告场景名称
availabilityCheck Integer 库存检查次数
availabilityResponse Integer 库存检查成功次数
requestCount Integer SDK记录的请求次数
filledCount Integer SDK记录的填充次数
apiRequest Integer API记录的请求次数
apiFilled Integer API记录的填充次数
imprCount Integer SDK记录的广告展现次数
clickCount Integer SDK记录的广告点击次数
apiImpr Integer API记录的广告展现次数
apiClick Integer API记录的广告点击次数
revenue Double 广告收益
  • 返回数据示例 – 广告位维度数据 JSON 格式
[
    {
        "day": "2020-10-13", 
        "hour": "10", 
        "appKey": "dfsdjdfljalsdjf", 
        "appId": "WfCUt0HTIOzo4NRoJ8p37Rx2bo5nvRHl", 
        "appName": "test", 
        "platform": "iOS", 
        "placementId": 101, 
        "placementName": "test", 
        "availabilityCheck": 34543, 
        "availabilityResponse": 10000, 
        "requestCount": 34543, 
        "filledCount": 10000, 
        "apiRequest": 30000, 
        "apifilled": 8000, 
        "imprCount": 4500, 
        "clickCount": 1000, 
        "apiImpr": 4000, 
        "videoFinish": 2000, 
        "revenue": 1005.35 
    }, 
    ... 
]
  • 返回数据示例 – 广告分层维度数据 JSON 格式
[
    { 
        "day": "2020-10-13",
        "hour": "10",
        "appKey": "dfsdjdfljalsdjf",
        "appId": "WfCUt0HTIOzo4NRoJ8p37Rx2bo5nvRHl",
        "appName": "test",
        "platform": "iOS",
        "placementId": 101,
        "placementName": "test",
        "adNetwork": 0, /*Adtiming*/
        "instanceId": 12321,
        "instanceName": "test_instance",
        "requestCount": 34543,
        "filledCount": 10000,
        "apiRequest": 30000,
        "apifilled": 8000,
        "imprCount": 4500,
        "clickCount": 1000,
        "apiImpr": 4000,
        "apiClick": 900,
        "revenue": 1005.35
    },
    ...
]
  • 返回数据示例 – 广告场景维度数据 JSON 格式
[
    {
        "day": "2020-06-20",
        "hour": "10",
        "appKey": "dfsdjdfljalsdjf",
        "appId": "WfCUt0HTIOzo4NRoJ8p37Rx2bo5nvRHl",
        "appName": "test",
        "platform": "iOS",
        "placementId": 101,
        "placementName": "test",
        "sceneId": 123123,
        "sceneName": "Test-Scene",
        "imprCount": 4500,
        "clickCount": 1000
    },
    ...
]
这篇文章有帮助吗？
7 人中有 7 人觉得有帮助

评论

0 条评论

文章评论已关闭。