Chartboost API —アナリティクスメソッド

最終更新:

 

キャンペーンアナリティクスのエンドポイントは、アプリまたはクリエイティブ別の詳細レポートを返します。groupByフィールドを指定すると、キュードアナリティクス(待ち行列型アナリティクス)によりジョブIDが返されます。詳しくはこちらをご覧ください。


HTTPメソッド GET
エンドポイント https://analytics.chartboost.com/v3/metrics/campaign
リクエスト例 https://analytics.chartboost.com/v3/metrics/campaign?dateMin={{Minimum date}}&dateMax={{Maximum date}}&userId={{Chartboost customer's user ID}}&userSignature={{CB customer's user signature}}

パラメータ
パラメータ リクエストの種類 必要? 説明 デフォルト
aggregate 文字列 オプション 期間別に結果を集計する(毎日、毎週、毎月) 毎日
campaignId 文字列 オプション キャンペーンID(groupBまたはroleに基づくTo Campaign IDFrom Campaign IDのいずれか) 該当なし
campaignType 文字列 オプション network, cross_promo, direct_deal network, direct_deal
dateMin 文字列 必須 日付の下限 (YYYY-MM-DD) 該当なし
dateMax 文字列 必須 日付の上限 (YYYY-MM-DD) 該当なし
groupBy 文字列 オプション 'country' 'app' 'app,creative' 'target_creative' 'date' 'campaign' 'campaign_target' 'campaign_type'のいずれか なし
platform 文字列 オプション プラットフォーム別にフィルタリング(iOS、Google Play、Amazon) すべて
role 文字列 オプション advertiserまたはpublisher 両方

応答フィールド
パラメータ 説明 戻り先
adTypeId 1 = interstitial
2 = more_apps
3 = in_play
4 = rewarded_video
5 = video_interstitial
全員
app アプリ名 全員
campaign キャンペーン名 全員
campaignId キャンペーンID(groupBまたはroleに基づくTo Campaign IDFrom Campaign IDのいずれか) 全員
campaignTarget キャンペーンターゲット名(campaign_target別の場合のみ返す) 広告主
campaignSubType user_acquisitionまたはretargeting 全員
clicksDelivered 発生したクリック数 パブリッシャー
clicksReceived 獲得したクリック数 広告主
cpcvEarned 視聴完了数に対する視聴完了の収益率  パブリッシャー
cpcvSpent 視聴完了数に対する視聴完了のコスト率 広告主
creative アドバタイジング用のクリエイティブ名(creative別の場合のみ返す) 広告主
ctrDelivered 発生したインプレッションのクリックスルー率 パブリッシャー
ctrReceived 獲得したインプレッションのクリックスルー率 広告主
dt 日付 (YYYY-MM-DD) 全員
ecpmEarned 1,000インプレッションあたりの収益 パブリッシャー
ecpmSpent 1,000インプレッションあたりのコスト 広告主
impressionsDelivered パブリッシングにより発生したインプレッション数 パブリッシャー
impressionsReceived アドバタイジングにより獲得したインプレッション数 広告主
installDelivered 発生したインストール数 パブリッシャー
installRateDelivered インストール率 パブリッシャー
installRateReceived インストール率 広告主
installReceived インストール数 広告主
moneyEarned 収益額 パブリッシャー
moneySpent 支出額 広告主
videoCompletedDelivered 発生したビデオ視聴完了数 パブリッシャー
videoCompletedReceived 獲得したビデオ視聴完了数 広告主

▲ TOPへ戻る

 

アプリアナリティクスのエンドポイントは、アプリ、広告タイプまたは場所別の詳細レポートを返します。


HTTPメソッド GET
エンドポイント https://analytics.chartboost.com/v3/metrics/app
リクエスト例 https://analytics.chartboost.com/v3/metrics/app?dateMin={{Minimum date}}&dateMax={{Maximum date}}&userId={{Chartboost customer's user ID}}&userSignature={{CB customer's user signature}}

パラメータ
パラメータ リクエストの種類 必要? 説明 デフォルト
aggregate 文字列 オプション 期間別に結果を集計する(毎日、毎週、毎月) 毎日
appId 文字列 オプション 1つ以上のアプリID(複数の場合はコンマで区切る) すべて
dateMax 文字列 必須 日付の上限 (YYYY-MM-DD) 該当なし
dateMin 文字列 必須 日付の下限 (YYYY-MM-DD) 該当なし
groupBy 文字列 オプション app, ad_type,app, date, ad_location(パブリッシャーのみ), platform, campaign_typeのいずれか なし
platform 文字列 オプション iOS、Google Play、Amazonのいずれか すべて
role 文字列 オプション advertiserまたはpublisher 両方

応答フィールド
パラメータ 説明 戻り先
ad_type クリエイティブ広告のタイプ
広告タイプについて ▶
groupBy=ad_type,appの場合のみ全員
allInstalls ソースの別なく(Chartboost以外も含む)獲得した総インストール数 全員
app アプリ名 全員
appBundleId 送信されません。レポートにはDeprecated(使用中止)と記述されます。 全員
appId Chartboost アプリID 全員
bootups ユーザーがデバイス上でお客様のアプリを起動した回数 全員
campaignType network, cross_promo, direct_deal 全員
clicksDelivered 発生したクリック数 パブリッシャー
clicksReceived 獲得したクリック数 広告主
cpcvEarned 視聴完了数に対する視聴完了の収益率  パブリッシャー
cpcvSpent 視聴完了数に対する視聴完了のコスト率 広告主
ctrDelivered 発生したインプレッションのクリックスルー率 パブリッシャー
ctrReceived 獲得したインプレッションのクリックスルー率 広告主
dt 日付 (YYYY-MM-DD) 全員
ecpmEarned 1,000インプレッションあたりの収益 パブリッシャー
ecpmSpent 1,000インプレッションあたりのコスト 広告主
eventLocation アプリにパブリッシュしている広告のChartboost広告掲載場所を示します。広告主の場合は応答フィールドにdefaultと表示されます。 全員
impressionsDelivered パブリッシングにより発生したインプレッション数 パブリッシャー
impressionsReceived アドバタイジングにより獲得したインプレッション数 広告主
installDelivered 発生したインストール数 パブリッシャー
installRateDelivered インストール率 パブリッシャー
installRateReceived インストール率 広告主
installReceived インストール 広告主
moneyEarned 収益額 パブリッシャー
moneySpent 支出額 広告主
platform iOS, Google Play, Amazon 全員
uniques お客様のアプリを起動したユニークデバイスの数 全員
videoCompletedDelivered 発生したビデオ視聴完了数 パブリッシャー
videoCompletedReceived 獲得したビデオ視聴完了数 広告主

▲ TOPへ戻る

 

インストールデータエクスポートのエンドポイントは、発生/獲得したすべてのインストールのリストを返します。このエンドポイントではキュードアナリティクス(待ち行列型アナリティクス)によりジョブIDが返されます。詳しくはこちらをご覧ください。


HTTPメソッド GET
エンドポイント https://analytics.chartboost.com/v3/metrics/install
リクエスト例 https://analytics.chartboost.com/v3/metrics/install?dateMin={{Minimum date}}&dateMax={{Maximum date}}&userId={{Chartboost customer's user ID}}&userSignature={{CB customer's user signature}}

パラメータ
パラメータ リクエストの種類 必要? 説明 デフォルト
campaignIds 文字列 オプション 1つ以上のキャンペーンID(複数の場合はコンマで区切る) すべてのキャンペーン
campaignType 文字列 オプション network, cross_promo, direct_deal すべて
dateMax 文字列 必須 日付の上限 (YYYY-MM-DD) 該当なし
dateMin 文字列 必須 日付の下限 (YYYY-MM-DD) 該当なし
platform 文字列 オプション iOS、Google Play、Amazonのいずれか すべて
role 文字列 オプション advertiser または publisher 両方

応答フィールド
パラメータ 説明 戻り先
Ad Type クリエイティブ広告のタイプ
広告タイプについて ▶
全員
Click Timestamp 日付と時間(DD-MM-YYYY HH:MM:SS) 全員
Cost Type アドバタイジングの入札タイプ
入札タイプについて ▶
全員
Cost Value アドバタイジングの入札額 全員
Country デバイスの2文字の国コード 全員
Date 日付と時間(DD-MM-YYYY HH:MM:SS) 全員
From App Bundle パブリッシング用アプリのバンドルID 全員
From App ID パブリッシング用アプリのID 全員
From App Name パブリッシング用アプリの名前 全員
From Campaign ID パブリッシング・キャンペーンのID パブリッシャー
From Campaign Name パブリッシング・キャンペーンの名前 パブリッシャー
From Campaign Type networkcross_promodirect_deal パブリッシャー
GAID Google広告ID 全員(行動ターゲティングがオフの場合はパブリッシャーのみ)
IFA iOS広告識別子(iOS 10で「追跡型広告を制限(Limit Ad Tracking)」がオフの場合) 全員(行動ターゲティングがオフの場合はパブリッシャーのみ)
MAC MACアドレス(使用中止) 該当なし
Model デバイスのモデル 全員
OS デバイスのOS 全員
To App Bundle アドバタイジング用アプリのバンドルID 全員
To App ID アドバタイジング用アプリのID 全員
To App Name アドバタイジング用アプリの名前 全員
To Campaign ID アドバタイジング・キャンペーンのID 広告主
To Campaign Name アドバタイジング・キャンペーンの名前 広告主
To Campaign Target アドバタイジング・キャンペーンターゲットのID 全員
To Campaign Type networkcross_promodirect_deal 広告主
UUID デバイスのUUID(ある場合) 全員(行動ターゲティングがオフの場合はパブリッシャーのみ)

▲ TOPへ戻る

 

ダッシュボードの [APIエクスプローラー] ページのエンドポイントのほかに、クリーンなアナリティクスデータをアプリ、日付、国別に返すエンドポイントもご用意しました。これらのエンドポイントは、お客様がご使用のサードパーティ アトリビューションおよびメディエーションサービスが国レベルのデータを必要とする場合にもお使いいただけます。

メディエーションネットワークに関する注記: APIにより自動的にnetwork,direct_dealの結果が返されるのでcampaignTypeフィールドは省いてください。
MoreAppsのデータはこのAPIには含まれません。アプリ/キャンペーンのエンドポイントとダッシュボードのアナリティクスのデータは完全に一致しないことがあります。appcountryad_typeデータの取得にはキャンペーンのエンドポイントおよびcountry別をご使用ください。

HTTPメソッド GET
エンドポイント https://analytics.chartboost.com/v3/metrics/appcountry
リクエスト例 https://analytics.chartboost.com/v3/metrics/appcountry?dateMin={{Minimum date}}&dateMax={{Maximum date}}&userId={{Chartboost customer's user ID}}&userSignature={{CB customer's user signature}}

パラメータ
パラメータ リクエストの種類 必要? 説明 デフォルト
appIds 文字列 オプション 1つ以上のアプリID(複数の場合はコンマで区切る) すべてのアプリ
dateMin 文字列 必須 日付の下限 (YYYY-MM-DD) 該当なし
dateMax 文字列 必須 日付の上限 (YYYY-MM-DD) 該当なし
campaignType 文字列 オプション network, cross_promo, direct_deal network,direct_deal
adTypeIds 文字列 オプション 1つ以上の広告タイプID(複数の場合はコンマで区切る): 1 = interstitial, 3 = in_play, 4 = rewarded_video, 5 = video_interstitial 1,4,5
role 文字列 オプション advertiser または publisher publisher
adLocation 文字列 オプション 1つ以上のadLocation
(複数の場合はコンマで区切る)
  • ケース1: (adLocation=<value which is not 'all'>)は指定されたそれぞれのadLocationの集計結果のみを示します。複数の場合、パブリッシュ用アプリのadLocationの上位3つのデータのみとなります。それ以外のadLocationのデータは戻りません。
  • ケース2: (adLocation='all')はパブリッシュ用アプリのadLocationの上位3つまでの結果を分割して示します。残りのデータはadLocation = 'other'として集計されます。
  • ケース3: (adLocation= empty or not-passed)はすべてのデータをadLocation = 'overall'として集計します。adLocationごとのデータはありません。
ケース3参照

応答フィールド
パラメータ 説明 戻り先
adLocation アプリにパブリッシュしている広告のChartboost広告掲載場所を示します。広告主の場合は応答フィールドにdefaultと表示されます。 全員
adType interstitial, rewarded_video, video_interstitial 全員
app アプリ名 全員
campaignType network, cross_promo, direct_deal 全員
clicksDelivered クリック パブリッシャー
clicksReceived クリック 広告主
countryCode 2文字の国コード、または"unknown" 全員
cpcvEarned 視聴完了数に対する視聴完了の収益率  パブリッシャー
cpcvSpent 視聴完了数に対する視聴完了のコスト率 広告主
ctrDelivered クリック率(CTR) パブリッシャー
ctrReceived クリック率(CTR) 広告主
dt 日付 (YYYY-MM-DD) 全員
ecpmEarned 1000インプレッションあたりの収益 パブリッシャー
ecpmSpent 1000インプレッションあたりのコスト 広告主
impressionsDelivered インプレッション パブリッシャー
impressionsReceived インプレッション 広告主
installRateDelivered インストール率 パブリッシャー
installRateReceived インストール率 広告主
installsDelivered インストール パブリッシャー
installsReceived インストール 広告主
moneyEarned 収益額 パブリッシャー
moneySpent 支出額 広告主
platform iOS, Google Play, Amazon 全員
videoCompletedDelivered ビデオの視聴完了 パブリッシャー
videoCompletedReceived ビデオの視聴完了 広告主

▲ TOPへ戻る

 


関連項目