どのようにお手伝いできますか?

検索

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

  • 更新

概要：AppsFlyer ROI360の機能であるInCost APIを使うと、アドネットワークからAppsFlyerに広告費データをプログラムで送信できます。広告主は集計されたコストデータを確認し、アドネットワークの実際の貢献度を把握できます。

InCost APIについて

InCost APIは、アドネットワークからAppsFlyerにコストデータを送信するための最適なソリューションです。アドネットワークパートナーは、APIを使って詳細な広告費データをAppsFlyerに送信します。 AppsFlyerはデータを取り込んで処理し、管理画面やレポートを通じて広告主とパートナーに提供します。

メリット

  • コストをスムーズに共有することで、広告主が自社のアドネットワークの実際の貢献度を把握しやすくなります。コストデータがなければ、広告主は計測に欠かせない情報を得られず、ROASを正確に評価できません。その結果、広告主がほかのメディアソースに投資してしまい、アドネットワークの収益に悪影響が及ぶ可能性があります。
  • 正確で網羅的なコストのリアルタイム計測を保証するソリューションにより、自社のROIを示せます。
  • InCost APIは短時間で簡単に導入でき、効果もほぼすぐに現れます。データの送信方法とタイミングを自由に管理でき、最大90日前までさかのぼってコストデータを送信することもできます。
  • クリック時のコスト送信で対応しているのはCPIのみですが、InCost APIは、キャンペーンのすべての課金方式に対応しています。
  • AppsFlyerのPartner Marketplaceでは、コスト共有に対応していることを示す「Cost」バッジが表示され、広告主の目に留まりやすくなります。

InCost APIの実装

前提条件：InCost APIを利用するには、アドネットワークが以下の条件を満たす必要があります。

  • キャンペーンの90%で、アトリビューションにキャンペーンIDが含まれていること。
  • データの鮮度を高めるため、1日に少なくとも6回データを送信できること。具体的な送信時刻は、アドネットワーク側で決められます。
  • ［アドネットワークが過去のデータを更新する場合］データの網羅性を高めるため、毎回、直近7日分のデータを送信できること。

InCost APIを実装し、AppsFlyerへのコストデータの送信を開始する手順：

  • 以下の表に沿って進めてください。
手順 対応内容 
1

InCostの利用を申請します。

  1. AppsFlyerの上部メニューで、［ヘルプ］ > ［サポートに問い合わせる］を選択します。
    Partner Assistantウィジェットが開きます。
  2. ［コスト計測の有効化］を選択し、必要な情報を送信します。
    送信すると問い合わせチケットが作成され、AppsFlyerのパートナーソリューションエンジニアから連絡が届きます。
2 トラフィックの90%超で、アトリビューションリンクにキャンペーン階層の情報（キャンペーンID、および任意で広告セットIDと広告ID）が含まれていることを確認します。
3 AppsFlyer管理画面から、AppsFlyerのAPIトークンを取得します。
4

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

  1. アプリ一覧の取得（Get app list）。
  2. InCostへのアップロード（InCost upload）：JSONに含めるフィールドを開発者に伝えてください。
    • 必須フィールドには、必ず値を設定します。空欄のフィールドは送信しないでください。 
    • 指定できるメディアソースは、自社のアドネットワークアカウントに関連付けられている、または登録されているものに限られます。対象のメディアソースの一覧は、AppsFlyerの担当者（PDM）に確認してください。
    • コストデータの日付をアプリ側の日付と合わせるため、アプリのタイムゾーンを考慮してください。タイムゾーンは、Get app permission list APIで確認できます。
    • キャンペーンのコストレポートで使用していない階層のフィールドは、送信しないでください。たとえば、広告セットID、アセット名、広告ID、広告名などです。
  3. ジョブのステータスの取得（Get job status）。
5

連携をテストします。

  1. 手順1で作成したチケットのスレッドで、APIの実装が完了したことをAppsFlyerに伝え、以下のアプリの権限を取得します。これらのアプリを使うと、実際のデータを使わずにAPIをテストできます。
    • com.cost.app
    • id888123456
  2. AppsFlyerのサイドメニューで、［連携］ > Partner Marketplaceを開き、対象のパートナーを選択します。
  3. ［連携の設定］をクリックします。
  4. テストアプリを1つ選択します。
  5. 連携済みパートナーの［コスト］タブを開きます。
  6. ［コストデータを取得］をオンにします。
  7. ［コスト設定を保存］をクリックします。
  8. ［接続をテスト］をクリックします。
    APIが有効になります。
6 手順1で作成したチケットのスレッドで、連携が正常に動作していることをAppsFlyerと確認します。
7 広告主がAppsFlyerの連携済みパートナーページの［コスト］タブで、［コストデータを取得］を有効にしていることを確認します。有効にすると、広告主がコストデータを受信できるようになります。

注意

推奨：特定の日付のデータを再送するのは、その日のコストが変更された場合のみにしてください。毎回、直近7日分のデータを送信することもできますが、変更のないレコードを再送する必要はありません。

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 
  • 同じ日付のコストデータを再送する際、最初のAPI呼び出しには含まれていなかったaf_prtを後の呼び出しで追加すると、コストデータが重複します。
campaign_id はい
  • アトリビューションリンクで送信したaf_c_idパラメータと同じ値である必要があります。
  • 空文字列は使用できません。
  • 形式：文字列（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も指定できます。
  • 負の値は指定できません。
  • 桁区切りのカンマ（,）は含めないでください。
  • 値を引用符で囲まないでください。 
  • 形式：数値（小数可）
  • 値の例：1、1.2、1234.20
channel いいえ
  • アトリビューションリンクで送信したaf_channelパラメータと同じ値である必要があります。
  • 形式：文字列（20文字）
  • 例：my_channel
keywords いいえ
  • 形式：文字列（100文字）
  • 例：abc app
reported_clicks いいえ
  • このレコードについて、アドネットワークが報告したクリック数。
  • 形式：0以上の整数。
  • 例：150
  • 任意。空欄または省略された場合は、0として報告されます。
  • 小数や負の値は受け付けられません（エラー422：Reported clicks can be positive integer）。
reported_impressions いいえ
  • このレコードについて、アドネットワークが報告したインプレッション数。
  • 形式：0以上の整数。
  • 例：1000
  • 任意。空欄または省略された場合は、0として報告されます。
  • 小数や負の値は受け付けられません（エラー422：Reported impression can be positive integer）。
* 条件によっては必須になるため、「説明」列を確認してください。

Tags