使用 Chartboost API，您可以访问广告活动和应用数据分析，获取帐户和收益信息、上传、更新广告活动投标及其他 。
在您开始前
- 验证: 您需要包括您的帐户的用户 ID 和用户签名以验证您的 API 请求。您可以在后台 API 浏览器页面顶部找到您的用户 ID 和用户签名。
- HTTP 方法: 必要的 HTTP 方法 — GET, POST, PUT 等 — 各端点均有不同。在您的后台的 API 浏览器页面查看每个请求的 HTTP 方法。所有请求均应通过 HTTPS 完成。下面以显示两项数据分析查询为例: 列队作业初始化请求和使用作业 ID 进行后续请求以取回结果。
// 用于初始化查询请求的伪代码示例
query_url = "http://analytics.chartboost.com/v3/metrics/campaign?" + query_params
query_params = "... groupBy=app,creative ..."
response = get(query_url);
if (response.status = 202) {
jobId = response.parse('jobId');
// 捕获 jobId 用于 retrieve() 函数
file.write(jobId);
}
else {
// 处理失败
};
// 用于通过 jobId 取回结果的伪代码示例
query_url = "http://analytics.chartboost.com/v3/metrics/jobs/" + jobId
query_params = ""
created = get(query_url + "?status=true");
if (created.status == 201) {
response = get(query_url);
if (response.status == 200) {
// 一头扎进数据里
}
else {
// 处理失败
}
};'
- 接收到使用 groupBy 参数的 GET /campaign 和 GET /install 查询后，Chartboost API 会返回作业ID(job ID)，确认请求已接受并加入处理队列。
- 您可以再次发出请求，使用该 ID 来检查作业状态，使用新端点: GET /v3/metrics/jobs/[job_id]?status=true
- 如果作业结果可供收集，则查询会返回 201 {状态: “已创建”}。当系统收到响应后，您可以使用如下方法抓取数据: GET /v3/metrics/jobs/[job_id]
- 如果您试图在作业完成前取回数据，您收到的响应可能空白或不完整。
- 查询结果会存储并可供下载长达 24 小时，过期自动删除。
- （从2022年5月22日起 生效日期已推迟，将另行通知），唯一支持的 content-type 为text/comma-separated-values;charset=UTF-8，结果会以 CSV 表格形式返回。
- API 方法: Chartboost API 提供 4 中不同方法类型 — 分析方法、应用方法、广告活动方法和帐户方法。每个方法类型均有独一无二的端点。使用后台 API 浏览器页面找到您的请求的正确端点。
- 参数: 添加参数到生成请求用作测试。必填参数会在后台以红色显示。
- 从我们的 API 返回的数据分析报告大多为 JSON 格式。特定查询会以 CSV (逗号分割值) 格式返回。了解格式详情
- 请符合下方的 Chartboost API 规则。
▲ 返回顶部
Chartboost API 规则
以下准则帮助我们确保所有用户请求均得到快速回复。如果您不遵守限制，您的 API 访问会受到限制。请妥善使用我们的 API，为了您也为了其他 Chartboost 客户。
请分开发送请求。如果您每天需要 5 份不同报告，请不要同时发送 5 个请求。请间隔几分钟来喘口气。如果您的查询频率超过每分钟一次，您的 API 访问将会受限。
将您的多个应用归到一个请求中。请勿为每个应用发送单独 API 请求，去掉 appId 参数，让 API 返回所有数据。
▲ 返回顶部
