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へ戻る

 

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

 


関連項目