InCost API：アドネットワーク向け

推奨
マーケター アドネットワーク
最終更新日：

概要：AppsFlyer の ROI360 の機能の一部である InCost API を使用することで、アドネットワークは広告のコストデータを AppsFlyer へ送信できるようになります。そうすることで、広告主に集計コストデータが提供され、あなたのアドネットワークの本当のパフォーマンスを理解してもらえるようになります。

InCost API について

InCost API は、アドネットワークが AppsFlyer へコストデータを送信するためのソリューションです。アドネットワークは、API を使用して広告の詳細なコストデータを AppsFlyer へ送信します。AppsFlyer がそのデータを取り込んで処理するので、管理画面やレポート上で広告主やパートナーが利用できるようになります。

メリット

  • スムーズなコストレポートにより、広告主があなたのアドネットワークの本当のパフォーマンスを理解するのを助けます。コストデータがなければ、広告主は計測データの重要な部分を見逃してしまい、ROAS を正確に計測することができません。そのため、誤って他のメディアソースに投資し、収益に悪影響を及ぼす可能性があります。
  • 正確でリアルタイムなコスト計測を担保するこのソリューションで、 ROI を証明してください。
  • InCost API は迅速かつ簡単に実装でき、利用開始までの期間も短いです。また、最大で過去90日間のコストデータを送り返す機能など、データをいつどのように送信するかを完全に制御できます。
  • InCost APIでは、CPI（クリックURL経由でコスト情報を共有する場合は唯一対応）だけでなく、すべてのコスト形式をサポートしています。
  • AppsFlyerのPartner Marketplace上でも、InCost APIの連携が完了すれば「コスト」のバッジが付与されます。

InCost API の実装

前提条件：InCost API の実装を行うには、以下の条件を満たす必要があります。

  • 計測しているキャンペーンの90%において、計測データにaf_c_id（キャンペーンID）が含まれていること。
  • データの鮮度向上のために、1日に6回以上コストデータを送信できること。（具体的な送信時間はアドネットワーク次第です。）
  • （コストデータを過去に遡って更新したい場合）データの完成度向上のため、過去7日間のコストデータを毎回送信できること

InCost API を実装して、コストデータの送信を始めるには：

  • 以下の手順に従ってください。
ステップ # 対応事項 
1 InCost API連携の申請：
  1. パートナーアカウントで管理画面に入り、上部メニューの［ヘルプ］>［チームへのお問い合わせ / サポートチケットの提出］を選択してください。
    パートナーアシスタントのウィジェットが開きます。
  2. [コスト計測を有効にする(Enabling cost measurement)] を選択して、各種情報を送信してください。
    フォーム送信後にチケットが作成され、AppsFlyerのパートナーソリューションエンジニアから連絡があります。
2 あなたのアドネットワークの90%以上のトラフィックにおいて、計測データにキャンペーン階層の情報（af_c_id（キャンペーン ID）は必須、af_adset_id（アドセットID）、af_ad_id（アドID）は任意です）の情報が含まれていることを確認してください。
3 AppsFlyerの管理画面から APIトークンを取得してください。
4 API 認証ヘッダーで使用する APIトークンを開発担当者に共有し、以下の3つの APIを各指示に従って実装するよう依頼してください。
  1. Get app list（アプリリストの取得）
  2. InCost upload（コスト情報のアップロード）： JSON にどの項目を入力するかを開発担当者に伝えてください：
    • 必須項目はすべて入力する必要があるので注意してください。(空の項目は送信できません。 ) 
    • メディアソースの項目は、そのアドネットワークアカウントに紐づけられているメディアソースのみに制限されます。自社のメディアソースIDが不明な場合は、担当PDMに確認してください。
    • コストデータの日付とアプリの日付を揃えるために、Get app permission APIで取得できるアプリ毎のタイムゾーンを考慮してください。
    • あなたのキャンペーントラフィックにおいてコスト計測の階層に含まれていない項目がある場合は、APIリクエストにも含めないでください。例：af_adset_id（広告セットID）/ af_adset（広告セット名）/ af_ad_id（広告ID） / af_ad（広告名）
  3. ジョブステータスの取得
5 連携テスト：
  1. ステップ1から続くチケットスレッド内で、APIの実装が完了したことをAppsFlyerへ連絡し、実データではなくAPIテストに使用できる以下アプリの権限を付与してもらってください。
    • com.cost.app
    • id888123456
  2. パートナーアカウントで管理画面に入り、左メニューの連携 > Partner Marketplaceを選択し、自社媒体を選択してください。
  3. 連携設定をクリックしてください。
  4. テストアプリを1つ選択してください。
  5. 連携画面のコストタブを開いてください。
  6. コストデータを取得のトグルをオンにしてください。
  7. コストを保存をクリックしてください。
  8. 接続テストをクリックします。
    これでAPIが有効になります。
6 チケットスレッドにて、連携が正しく機能しているかどうかをAppsFlyerへ確認してください。
7 連携完了後、広告主にAppsFlyer の連携ページのコストタブで、コストデータの取得を有効にしてもらってください。以降、コストデータの受信が開始されます。

InCost アップロード JSON の項目

項目 必須 備考
date 必須
  • コストの発生日
  • 形式：YYYY-MM-DD
  • 例：2019-12-30
app_id 必須
  • AppsFlyer プラットフォームに表示されてるアプリ ID
  • 形式：文字列250文字まで
  • 例： Android：com.app.name, iOS：id123456789
media_source 必須
  • AppsFlyer のアドネットワークパートナーアカウントが紐づいている、アドネットワークID（PID）
  • 形式：文字列50文字まで
  • 例：network_int
af_prt 任意*
  • 代理店アカウントが関係する成果とコストデータの場合は必須です。
  • 代理店識別子は計測URL内のaf_prtのパラメータへ渡されており、代理店アカウント毎に一意な値を所有しています。
  • 形式：文字列50文字まで
  • 例：agencya
campaign_id 必須
  • 計測リンクで送信されるaf_c_idパラメータと同じ値である必要があります。
  • 空 (empty) の文字列は送付しないでください。
  • 形式：文字列24文字まで
  • 例：123abc
campaign_name 必須
  • 形式：文字列100 文字まで
  • 例：my_campaign123
adset_id 任意*
  • adset_nameを送信する場合は必須です。
  • 計測リンクで送信されるaf_adset_idパラメータと同じ値である必要があります
  • あなたのコストレポート側でadset_idをサポートしていない場合には、送信しないでください。
  • 形式：文字列24文字まで
  • 例：123A
adset_name 任意
  • この項目を送信する場合は、adset_idも送信する必要があります。
  • 形式：文字列100 文字まで
  • 例：my_adset_name
ad_id 任意*
  • ad_nameを送信する場合は、この項目も必須です。
  • 計測リンクで送信しているaf_ad_id  パラメータと同じ値である必要があります。
  • あなたのコストレポート側でadset_idをサポートしていない場合には、送信しないでください。
  • 形式：文字列24文字まで
  • 例：123AB
site_id 任意
  • 広告を表示している配信面毎のID
  • 形式：文字列24文字まで
ad_name 任意
  • この項目を送信する場合は、ad_idも送信する必要があります。
  • 形式：文字列100 文字まで
  • 例：Ad-name
geo 任意
  • コストに関連付けて記録された国情報
  • 可能であれば、広告が表示された国情報の送付が推奨です。
  • 形式： ISO 3166の2文字の国コード
  • 例：US, CN, ZA
currency 必須
  • コストの通貨単位
  • 形式： ISO 4217の3文字の通貨コード
  • 例： USD, EUR, ZAR
spend 必須
  • 指定した通貨単位におけるコスト金額 
  • 小数点以下5桁まで入力可能です。
  • 0 (ゼロ)の値も入力可能です。
  • マイナスの値は入力できません。
  • ,(区切り文字)をつけて送信しないでください。
  • 引用符をつけて値を送信しないでください。 
  • 形式：10進数
  • 値の例：1 / 1.2 / 1234.20
channel 任意
  • 計測リンクで送信されるaf_channel パラメータと同じ値である必要があります。
  • 形式：文字列20文字まで
  • 例：my_channel
keywords 任意
  • 形式：文字列100 文字まで
  • 例：abc app
* この項目を送信する必要がある場合もあるので、必ず備考欄を参照してください。