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

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

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

InCost API について

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

メリット

  • 円滑なコストレポートにより、顧客がネットワークの真の影響を理解できるよう支援します。コストデータがなければ、顧客は計測パズルの重要な部分を見逃してしまい、ROAS を正確に測定することができません。そのため、誤って他のメディアソースに投資し、収益に悪影響を及ぼす可能性があります。
  • 正確で完全なリアルタイムのコスト計測を保証するソリューションで ROI を証明してください。
  • InCost API は迅速かつ簡単にデプロイでき、その影響はほとんどすぐに現れます。また、最大90日間のコストデータを送り返す機能など、データをいつどのように送信するかを完全に制御できます。
  • InCost API は、CPI（クリック単位で費用を送信する場合に使用できる唯一のモデル）だけでなく、すべてのキャンペーン価格モデルをサポートしています。
  • AppsFlyer パートナーマーケットプレイスで、サポートしている機能であることを示す「コスト」バッジで目立つようにしましょう。

InCost API の実装

前提条件：InCost API の利用資格を得るには、アドネットワークに以下が必要です。

  • キャンペーンの90%では、アトリビューションにキャンペーン ID が含まれています。
  • 1日に6回以上データを送信できるため、データの鮮度が向上します。具体的な時間はアドネットワーク次第です。
  • [アドネットワークがデータを遡及的に更新する場合] 過去7日間のデータを毎回送信できるため、データ完成度が向上します。

InCost API を実装して AppsFlyer へのコストデータの送信を開始するには：

  • 次の表の手順に従ってください。
ステップ # アクション 
1

InCost への適用：

  1. AppsFlyer のトップメニューから［ヘルプ］ > [チームへのお問い合わせ] を選択します。
    パートナーアシスタントウィジェットが開きます。
  2. [コスト計測を有効にする] を選択し、情報を送信します。
    送信後、チケットが開き、AppsFlyer パートナーのソリューションエンジニアから連絡があります。
2 あなたのアドネットワークの90%以上のトラフィックにおいて、アトリビューションリンクにキャンペーン階層(キャンペーン ID、 広告セットID、アド ID)の情報が含まれていることを確認してください。
3

AppsFlyer 管理画面から AppsFlyer の APIトークンを取得してください。
4

API 認証ヘッダーで使用する API トークンを開発者に渡し、指示に従って次の 3つの API メソッドを実装するよう開発者に依頼します。

  1. アプリリストの取得。
  2. InCost アップロード： JSON にどのフィールドを入力するかを開発者に伝えてください。
    • 必須のフィールドはすべて入力されている必要があります。(空のフィールドは送信しないでください。 ) 
    • メディアソースは、アドネットワークアカウントに関連付けられている（登録されている）メディアソースに制限されています。詳細は担当PDMに確認してください。
    • アプリのタイムゾーン (Get app 権限リスト API で報告されたもの) を考慮して、コストデータの日付をアプリのタイムゾーンに合わせてください。
    • キャンペーンのコストレポートの階層の一部ではないフィールドがある場合には、リクエスト内に含めないでください。例：広告セット ID / 広告セット名 / 広告 ID / 広告名
  3. ジョブステータスの取得。
6

チケットスレッド（ステップ1から）で、API の実装が完了したことを 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）
  • 形式：文字列50文字まで
  • 例：network_int

af_prt

いいえ*
  • 代理店のアトリビューションリとコストデータに必要です。
  • 代理店識別子はアトリビューションリンク内に含まれており、AppsFlyer の代理店アカウントに紐付けられています。
  • 形式：文字列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
通貨

はい
  • コストの通貨単位
  • 形式： ISO 4217の3文字の通貨コード
  • 例： USD, EUR, ZAR
広告費 はい
  • 指定された通貨での支出額 
  • 小数点以下5桁まで入力可能です。
  • 0 (ゼロ)の値も入力可能です。
  • 負の値は許可されていません
  • ,の区切り文字は送信禁止
  • 値を引用符をつけて送信しないでください。 
  • 形式：10進数
  • 値の例：1 1.2 1234.20
チャネル いいえ
  • アトリビューションリンクで送信される af_channel パラメータと同一である必要があります
  • 形式：文字列20文字まで
  • 例：my_channel
キーワード いいえ
  • 形式：文字列100 文字まで
  • 例：abc app

* このフィールドを送信する必要がある場合もあるので、備考欄を参照してください。