Chartboost API

 

Chartboost APIを使うと 、キャンペーンやアプリのアナリティクスへのアクセス、アカウントおよび収益情報の取得、アップロード、キャンペーン入札価格の更新などができるようになります。

 

 

  • 認証: APIリクエストの認証には、お客様のアカウントのユーザーIDとユーザー署名が必要になります。ユーザーIDとユーザー署名はダッシュボードの [APIエクスプローラー] ページ上部にあります。
  • HTTPメソッド: GETPOSTPUTなどのどのHTTPメソッドが必要かはエンドポイントにより異なります。各リクエストのHTTPメソッドはダッシュボードの [APIエクスプローラー] で確認できます。リクエストはすべてHTTP経由で行います。アナリティクスのクエリの例を以下に2つ示します。ジョブのキュー登録リクエストと、ジョブ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');
// retrieve()関数で使うjobIdを取り込む
 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 /campaignGET /installクエリ受信後に、Chartboost APIはリクエストを受信し、処理のキュー登録をした確認のジョブIDを応答します。
  • 新しいエンドポイントでは、このIDで後続リクエストのジョブ ステータスを確認できます。 GET /v3/metrics/jobs/[job_id]?status=true
  • ジョブの結果を収集できるようになると、クエリは201 {status: "created"}を返します。システムがその応答を受信すれば、次のようにデータをプルできます。 GET /v3/metrics/jobs/[job_id]
  • ジョブ終了前にデータを取得しようとすると、空または不完全な応答を受信する場合があります。
  • クエリの結果は最長24時間保存されます。
  • 現在、サポートされている唯一のcontent-typeは、application/octet-streamです。結果は、TSV形式で返されます(TSVファイルの拡張子は .csvのままです)。
  • APIメソッド: Chartboost APIには アナリティクス、アプリ、キャンペーン、アカウントの4つのメソッドがあります。それぞれのメソッドに固有のエンドポイントがあります。ダッシュボードの [APIエクスプローラー] か以下のオプションを使ってお客様のリクエストに対応するエンドポイントをご確認ください。
  • パラメータ: テスト用にリクエストを作成するにはパラメータを追加します。各リクエストに必要なパラメータはダッシュボードで赤で示してあります。
  • Chartboost APIはほとんどのアナリティクスレポートをJSON形式で返しますが、TSV形式のものもあります。レポートの形式について ▶
  • 以下のChartboost API規約をご確認ください。

▲ TOPへ戻る

 

以下は、お客様のリクエストに迅速に対応できるよう定められたガイドラインです。規約を尊重しないお客様のAPIアクセスは制限されます。

すべてのお客様に快適にご利用いただけるよう、節度を持ってAPIをご利用ください
間隔をあけてリクエストを送ってください。例えば毎日5種のレポートが必要な場合、5つのリクエストすべてを同時に送らないようにしてください。リクエストの間隔は最低でも数分間あけていただけますようお願いいたします。1分間に1つ以上のクエリを送ると、APIアクセスが制限されます。
アプリが複数の場合、1つのリクエストにまとめて送ってください。アプリごとにAPIリクエストを送るのではなく、appIdパラメータをつけずにAPIがすべてのアプリのデータをまとめて返せるようにしてください。

▲ TOPへ戻る

 

アナリティクスメソッド アプリメソッド キャンペーンメソッド アカウントメソッド

 


関連項目

 

Chartboost API

 

Chartboost API предлагает доступ к аналитике кампаний и приложений, позволяет извлекать информацию об учетной записи и выручке, обновлять предложения цены для кампании и делать многое другое.

 

 

  • Проверка подлинности: Для проверки подлинности запросов API нужно указать ид. и подпись пользователя вашей учетной записи. Идентификатор и подпись пользователя можно увидеть в верхней части страницы «Проводник API» на панели пользователя.
  • Методы HTTP: Требуемые методы HTTP — GET, POST, PUT и т. д. — зависят от конечной точки. Метод HTTP каждого запроса можно увидеть в «Проводнике API» на панели пользователя. Все запросы следует делать через HTTPS. В примере аналитики ниже показаны два запроса: первый ставит задание в очередь, а последующий использует ид. задания для извлечения результатов.
// пример кода для исходного запроса
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 {
// управление при сбое
}
};
  • Получив запрос GET /campaign или GET /install, использующий параметр groupBy, API Chartboost отвечает на них идентификатором задания, который служит подтверждением того, что запрос принят и поставлен в очередь на обработку.
  • Затем этот идентификатор можно использовать для проверки состояния задания в последующих запросах – с помощью новой конечной точки: GET /v3/metrics/jobs/[job_id]?status=true
  • Этот запрос вернет 201 {status: "created"}, если результаты задания можно забрать. Когда ваша система получает такой отклик, вы можете извлечь данные следующим образом: GET /v3/metrics/jobs/[job_id]
  • Если вы попытаетесь извлечь данные до завершения задания, то получите пустой или неполный отклик.
  • Результаты запроса сохраняются и остаются доступными на протяжении 24 часов, а затем удаляются.
  • В настоящее время единственный поддерживаемый content-type – это application/octet-stream, при котором результаты возвращаются в формате TSV (обратите внимание на то, что файлы TSV по-прежнему будут с расширением .CSV).
  • Методы API: У Chartboost API есть четыре разновидности методов: для аналитики, приложений, кампаний и учетной записи. У каждого метода уникальные конечные точки. Чтобы определить правильную конечную точку для своего запроса, откройте «Проводник API» на панели пользователя или воспользуйтесь одним из перечисленных ниже вариантов.
  • Параметры: Добавляйте параметры и стройте запросы для тестирования. Обязательные параметры помечены на панели пользователя красным цветом.
  • Большая часть аналитических отчетов, которые возвращает наш API, имеет формат JSON. Отчеты по специфическим запросам возвращаются в формате TSV (значения, разделенные табуляцией). Подробнее о форматах ▶
  • Соблюдайте приведенные ниже правила Chartboost API.

▲ К началу

 

Эти рекомендации гарантируют быструю обработку запросов всех наших клиентов. Если вы не станете им следовать, ваш доступ к API будет ограничен.

Работайте с API аккуратно – это нужно не только вам, но и другим пользователям Chartboost.
Разносите запросы во времени. Если вам нужно пять разных отчетов в день, не отправляйте все пять запросов одновременно. Подавайте запросы с промежутком хотя бы в несколько минут. Если запросы будут подаваться чаще одного раза в минуту, ваш доступ к API будет ограничен.
Группируйте свои приложения в один запрос. Вместо того, чтобы подавать отдельный запрос API для каждого приложения, опустите параметр appId – и API вернет вам данные сразу по всем приложениям.

▲ К началу

 

Методы для аналитики Методы для приложений Методы для кампаний Методы для учетной записи

 


Вам может быть интересно…

 

Chartboost API

 

使用 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 /campaignGET /install 查询后,Chartboost API 会返回作业 ID,确认请求已接受并加入处理队列。
  • 您可以再次发出请求,使用该 ID 来检查作业状态,使用新端点: GET /v3/metrics/jobs/[job_id]?status=true
  • 如果作业结果可供收集,则查询会返回 201 {状态: “已创建”}。当系统收到响应后,您可以使用如下方法抓取数据: GET /v3/metrics/jobs/[job_id]
  • 如果您试图在作业完成前取回数据,您收到的响应可能空白或不完整。
  • 查询结果会存储并可供下载长达 24 小时,过期自动删除。
  • 目前,唯一支持的 content-typeapplication/octet-stream,结果会以 TSV 表格形式返回 (注意,TSV 文件后缀仍为 CSV)。
  • API 方法: Chartboost API 提供 4 中不同方法类型 — 分析方法、应用方法、广告活动方法和帐户方法。每个方法类型均有独一无二的端点。使用后台 API 浏览器页面找到您的请求的正确端点。
  • 参数: 添加参数到生成请求用作测试。必填参数会在后台以红色显示。
  • 从我们的 API 返回的数据分析报告大多为 JSON 格式。特定查询会以 TSV (制表符分割值) 格式返回。了解格式详情 ▶
  • 请符合下方的 Chartboost API 规则。

▲ 返回顶部

 

以下准则帮助我们确保所有用户请求均得到快速回复。如果您不遵守限制,您的 API 访问会受到限制。

请妥善使用我们的 API,为了您也为了其他 Chartboost 客户。
请分开发送请求。如果您每天需要 5 份不同报告,请不要同时发送 5 个请求。请间隔几分钟来喘口气。如果您的查询频率超过每分钟一次,您的 API 访问将会受限。
将您的多个应用归到一个请求中。请勿为每个应用发送单独 API 请求,去掉 appId 参数,让 API 返回所有数据。

▲ 返回顶部

 

数据分析方法 应用方法 广告活动方法 帐户方法

 


您可能还希望…