Charboost API — キャンペーンメソッド

最終更新:
エンドポイントによってはお客様のキャンペーンIDが必要になります。キャンペーンIDはこちらで確認できます。

 

 

このエンドポイントは、キャンペーンが指定されている場合はそのキャンペーンの情報を、特に指定がない場合はステータスにかかわらずすべてのキャンペーンの情報を返します。

応答に含まれるbid_idは以下のエンドポイントに使えます。

HTTPメソッド GET
エンドポイント https://api.chartboost.com/campaigns
リクエスト例 https://api.chartboost.com/campaigns/?user_id={{Chartboost customer's user ID}}&user_signature={{CB customer's user signature}}

パラメータ
パラメータ リクエストの種類 必要? 説明 デフォルト
campaign_id 文字列 オプション 1つのキャンペーンID すべて

応答フィールド
パラメータ 説明 戻り先
app_id アドバタイジング用アプリのID 広告主
bids キャンペーンターゲットのID。以下のエンドポイントではbid_id 全員
campaign_type marketplace, directdeal, crosspromotion 全員
date_created キャンペーンの作成日(UNIXタイムスタンプ) 全員
date_max キャンペーン終了日(設定済みの場合。UNIXタイムスタンプ) 全員
date_min キャンペーン開始日(設定済みの場合。UNIXタイムスタンプ) 全員
date_modified キャンペーンの最終修正日(UNIXタイムスタンプ) 全員
id キャンペーンID 全員
name キャンペーン名 全員
platform ios, google_play, amazon 全員
priority 現在のキャンペーンの表示優先度 全員
promote_in パブリッシング用アプリのID パブリッシャー
status 現在のキャンペーンステータス。 active, paused, archived 全員

▲ TOPへ戻る

 

このエンドポイントは、キャンペーン内の特定の入札が指定されている場合はその詳細情報を、特に指定がない場合はそのキャンペーン内のすべての入札の情報を返します。/bidエンドポイントは入札情報の取得のほか、以下のすべてのメソッドに使えます。


HTTPメソッド GET
エンドポイント https://api.chartboost.com/campaigns/{{Campaign ID}}/bid/{{Bid ID}}
リクエスト例 https://api.chartboost.com/campaigns/?{{Campaign ID}}/bid/{{Bid ID}}?campaign_id={{Campaign ID}}&bid_id={{Bid ID}}&user_id={{Chartboost customer's user ID}}&user_signature={{CB customer's user signature}}


パラメータ
パラメータ リクエストの種類 必要? 説明 デフォルト
bid_id 文字列 オプション 1つの(ターゲット)入札ID すべて
campaign_id 文字列 必須 1つのキャンペーンID 該当なし

応答フィールド
パラメータ 説明 戻り先
app_filter 非推奨 全員
app_toggle 非推奨 全員
bid_amount $USDの入札価格 広告主
bid_id 入札ID 全員
bid_type アドバタイジングの入札タイプ
入札タイプについて ▶
広告主
budget 1日の総入札(ターゲット)予算 広告主
device_filter ターゲティングで選択したデバイスのシリーズまたはモデル 全員
device_toggle true = 包含; false = 除外 全員
expire_date ダイレクトディールで入札の期限が切れる日(UNIXタイムスタンプ) 全員
is_enabled 入札(ターゲット)をオンにするかどうかを決定する。 true, false 全員
location_filter ターゲティングで選択した国 全員
location_toggle true = 包含; false = 除外 全員
os_filter ターゲティングで選択したOS。 max = 最大バージョン; min = 最小バージョン 全員
title 入札(ターゲット)名 全員

▲ TOPへ戻る

 

このメソッドを使うと既存の入札を編集できます。1つのリクエストにつき編集できるのは1つの入札のみです。


HTTPメソッド PUT
エンドポイント https://api.chartboost.com/campaigns/{{Campaign ID}}/bid/{{Bid ID}}
リクエスト例 以下のコード参照

https://api.chartboost.com/campaigns/{{Campaign ID}}/bid/{{Bid ID}}

Request Body:
{
    "campaign_id": {{Campaign ID}},
    "bid_id": {{Bid ID}},
    "user_id": {{Chartboost customer's user ID}},
    "user_signature": {{CB customer's user signature}}
}
				

パラメータ
パラメータ リクエストの種類 必要? 説明 デフォルト
bid_amount 数値 オプション $USDの入札価格("0.55"など)
注: bid_typeも価格更新時には必要です。
該当なし
bid_id 文字列 必須 1つの(ターゲット)入札ID 該当なし
bid_type 文字列 オプションですが、bid_amountがある時は必要 入札タイプ (CPCまたはCPI) 該当なし
budget 数値 オプション この入札の1日の予算 ($USD) 該当なし
campaign_id 文字列 必須 1つのキャンペーンID 該当なし
device_filter 文字列 オプション コンマで区切ったデバイス タイプのリスト (例: "iphone,ipod touch,ipad") 該当なし
device_toggle ブール値 オプション device_filterリストの演算子
true(除外)
falseまたはabsent(包含)
false(包含)
is_enabled ブール値 オプション 入札オン/オフのトグル
true = オン; false = オフ
該当なし
location_filter 文字列 オプション コンマで区切った2文字の国コード(例: "US,CA")。空欄の場合はすべての国
注: location_toggleも国フィルター更新時には必要です。
該当なし
location_toggle ブール値 オプションですが、location_filterがある時は必要 location_filterがホワイトリストならtrue(このリストの国をターゲットにする)、location_filterがブラックリストなら
false(このリストの国以外のすべての国をターゲットにする)
該当なし
os_filter_max 数値 オプション 最大OSバージョン (例: 8.0) 該当なし
os_filter_min 数値 オプション 最小OSバージョン (例: 4.3) 該当なし

応答フィールド
パラメータ 説明 戻り先
app_filter 非推奨 全員
app_toggle 非推奨 全員
bid_amount $USDの入札価格 広告主
bid_id 入札ID 全員
bid_type 入札タイプ(CPCまたはCPI)
入札タイプについて ▶
広告主
budget この入札の1日の予算 ($USD) 広告主
device_filter デバイスタイプのリスト 全員
device_toggle true = 除外; false = 包含 全員
expire_date ダイレクトディールで入札の期限が切れる日(UNIXタイムスタンプ) 全員
is_enabled 入札がアクティブかどうかを決定する
true = オン
false = オフ
全員
location_filter 国リスト 全員
location_toggle true = 包含; false = 除外 全員
os_filter min = 最小OSバージョン; max = 最大OSバージョン 全員
title ターゲット(入札)名 全員

▲ TOPへ戻る

 

アドバタイジング・キャンペーン専用のメソッドです。キャンペーンで新しい入札を作成する際に使用します。新しい入札のタイトルは入札IDと同一のものになりますが、ダッシュボードで変更できます。


HTTPメソッド POST
エンドポイント https://api.chartboost.com/campaigns/{{Campaign ID}}/bid
リクエスト例 以下のコード参照

https://api.chartboost.com/campaigns/{{Campaign ID}}/bid

Request Body:
{
 "campaign_id": {{Campaign ID}},
 "bid_amount": {{Bid Amount}},
 "bid_type": {{Bid Type}},
 "user_id": {{Chartboost customer's user ID}},
 "user_signature": {{CB customer's user signature}}
}

パラメータ
パラメータ リクエストの種類 必要? 説明 デフォルト
bid_amount 数値 必須 $USDの入札価格("0.55"など)
注: bid_typeも価格更新時には必要です。
該当なし
bid_type 文字列 必須 入札タイプ (CPCまたはCPI) 該当なし
budget 数値 必須 この入札の1日の予算 ($USD) 該当なし
campaign_id 文字列 必須 1つのキャンペーンID 該当なし
device_filter 文字列 オプション コンマで区切ったデバイス タイプのリスト (例: "iphone,ipod touch,ipad") 該当なし
device_toggle ブール値 オプション device_filterリストの演算子
true(除外)
falseまたはabsent(包含)
false(包含)
is_enabled ブール値 オプション 入札オン/オフのトグル
true = オン; false = オフ
該当なし
location_filter 文字列 オプション コンマで区切った2文字の国コード(例: "US,CA")。空欄の場合はすべての国
注: location_toggleも国フィルター更新時には必要です。
該当なし
location_toggle ブール値 オプションですが、location_filterがある時は必要 location_filterがホワイトリストならtrue(このリストの国をターゲットにする)、location_filterがブラックリストなら
false(このリストの国以外のすべての国をターゲットにする)
該当なし
os_filter_max 数値 オプション 最大OSバージョン (例: 8.0) 該当なし
os_filter_min 数値 オプション 最小OSバージョン (例: 4.3) 該当なし

応答フィールド
パラメータ 説明 戻り先
app_filter 非推奨 全員
app_toggle 非推奨 全員
bid_amount $USDの入札価格 広告主
bid_id 入札ID 全員
bid_type 入札タイプ(CPCまたはCPI)
入札タイプについて ▶
広告主
budget この入札の1日の予算 ($USD) 広告主
device_filter デバイスタイプのリスト 全員
device_toggle true = 除外; false = 包含 全員
expire_date ダイレクトディールで入札の期限が切れる日(UNIXタイムスタンプ) 全員
is_enabled 入札がアクティブかどうかを決定する
true = オン
false = オフ
全員
location_filter 国リスト 全員
location_toggle true = 包含; false = 除外 全員
os_filter min = 最小OSバージョン; max = 最大OSバージョン 全員
title ターゲット(入札)名 全員

▲ TOPへ戻る

 


関連項目