Push APIでのローデータストリーミング

プレミアム機能

概要:ローデータ計測イベントを自社サーバーのエンドポイントにストリーミングできます。

6970_Push_API_image.png

関連資料: ローデータ配信ツールの比較 | APIを使用したプッシュAPIの設定

Push API

Push APIは、AppsFlyer計測とSKAdNetwork(SKAN)計測により生成されたローデータを、広告主のサーバーにメッセージとしてストリーミングします。メッセージタイプとコンテンツを選択し、送信先のエンドポイントを設定できます。

利用できるメッセージタイプ、データ更新頻度および項目は、次のセクションで説明するとおり、計測を行うフレームワーク(AppsFlyerかSKAN)よって異なります。

AppsFlyer計測メッセージ

メッセージの特性
特性 詳細
メッセージタイプの分離
  • メッセージはエンドポイント別(アプリごとに最大6つのエンドポイント)に分けるか、リストされている項目の値を調べてメッセージタイプを判別することができます。
    • event_name
    • conversion_type
    • campaign_type 
  • メッセージタイプ別の項目の値は、次の表にて示しています。

例:

メッセージには次の項目が含まれています。

  • conversion_type=install
  • campaign_type=organic
  • event_name=install

この表を使用して、このイベントがオーガニックユーザーのインストールイベントであると判断してください。

データの更新頻度

メッセージは、AppsFlyerプラットフォームにイベントが記録された直後に送信されます。これは通常数分以内に行われます。

メッセージの内容(項目)
  • メッセージは、key:value 構成になっています。
  • AppsFlyer計測のPush API項目をご参照ください。
  • 各キーはローデータ項目を表しています。AppsFlyerのローデータ項目の説明を参照してください。
  • 空白または null キーは一切送信されません。
  • この例には、null フィールドと空のフィールドの両方が含まれています。実際のポストバックには、空白の項目も null も含まれません。提供されている例は JSON 形式です。
タイムスタンプ項目の形式
  • UTCタイムスタンプ:yyyy-mm-dd hh:mm:ss.sss。例えば、2019-09-17 00:09:00.123 のように表示されます。日本時間の18:00にイベントが発生したとします。イベント時刻は UTCの 09:00 に変換されます。記録された時刻は UTC での時間です。
  • 選択されたタイムゾーン(アプリ固有)のタイムスタンプ:yyyy-mm-dd hh:mm:ss.sss±th:tm。例えば、2019-09-17 18:00:16.000+0900です。日本時間の18:00にイベントが発生したとします。表示されるイベント時間は 18:00 + 09:00 として記録されます。09:00 は日本のタイムゾーンを表しています。
利用できるメッセージタイプ

 

計測

context

メッセージタイプ

conversion_type 項目

campaign_type 項目

event_name 項目

ユーザー獲得 インストール* インストール

非オーガニック:UA

オーガニック:organic

インストール

ユーザー獲得 インストール後のアプリ内イベント インストール

非オーガニック:UA

オーガニック:organic

広告主が定義したイベント名

リターゲティング

リエンゲージメント Re-engagement リターゲティング Re-engagement
リターゲティング  リエンゲージメントアプリ内イベント Re-engagement リターゲティング 広告主が定義したイベント名
リターゲティング  リアトリビューション reinstall リターゲティング re-attribution
ユーザー獲得 再インストール reinstall

非オーガニック:UA

オーガニック:organic

reinstall

リターゲティング リアトリビューションアプリ内イベント reinstall リターゲティング 広告主が定義したイベント名
* ビュースルー計測に紐づく一部のインストールは制限されたメディアソースに紐づいています。
固有の項目
表示名 Push APIの名前
Selected currency* selected_currency
Revenue in selected currency revenue_in_selected_
currency
Cost in selected currency cost_in_selected_
currency
Device download time selected timezone device_download_time_selected_timezone
Attributed touch time selected timezone attributed_touch_time_selected_timezone
Install time selected timezone install_time_selected_
timezone
Event time selected timezone event_time_selected_
timezone

Selected timezone(*)

selected_timezone
* これは、APIメッセージが送信される時点で有効なアプリレベルの設定です。

SKANアトリビューションメッセージ

このセクションでは、SKANで利用できるメッセージ(レポートタイプ)と、メッセージの識別方法について説明します。このセクションを読み、SKAN計測のエンドポイントを設定してください。

関連記事:SKAN ローデータ項目。Push APIメッセージには、同様の構造と項目があります。

メッセージの特性
特性 詳細
メッセージタイプの分離
  • 全てのメッセージは、設定した1つのエンドポイントに送信されます。
  • メッセージタイプを判別するためには、次の項目を使用してください。
    • event_name
    • skad_redownload
  • メッセージタイプ別の項目の値は、次の表にて示しています。

例:

メッセージには次の項目が含まれています。

  • event_name: af_skad_install
  • skad_redownload: true

「skad_redownload: true」であることから、再ダウンロードイベントであると判断します。

データの更新頻度
  • インストール、再ダウンロード、アプリ内イベント:
    • 毎日処理されます。
    • AppsFlyerが iOS ポストバックを受信した翌日にエンドポイントに送信されます。
    • 05:00–08:00 UTC(正確な時間は変動あり)にイベントメッセージを受け取ると予想されます。
    • 例:月曜に受信したポストバックは火曜日の05:00 UTC以降に送信されます。
  • iOSからのポストバックとポストバックのコピー:メッセージはAppsFlyerに到着した直後に送信されます。
メッセージの例 スプレッドシートには、メッセージの例が含まれています。提供されている例は JSON 形式です。SKANメッセージの例

 

SKANアトリビューションのメッセージタイプ
メッセージタイプ

event_name 項目

skad_redownload 項目

インストール af_skad_install
  • 入力される可能性がある値:false, blank, null。
  • この項目がメッセージにない場合、値は false であると考えてください。
Re-downloads  af_skad_install True
アプリ内イベント 

広告主が設定したイベント名

広告主が設定したイベント名
iOSからのポストバック

このメッセージでは利用できません

時々利用できます
ポストバックコピー

このメッセージでは利用できません

時々利用できます


SKANアトリビューションのメッセージタイプの決定

注:これは iOSから直接送信されるポストバックコピーのメッセージには適用されません。

PushAPI-2_en-us.png

Push APIエンドポイントの設定

注意

次の理由から、Push APIを使用して第三者にAppsFlyerの計測データを送信しないでください。

  • ユーザーが第三者へのデータ送信をオプトアウトした場合、CCPAなどのプライバシー規制に違反する可能性があります。
  • 一部のメディアソースは、それらによって提供されるユーザーレベルのデータの使用、第三者との共有、またはその両方を制限します。メディアソースの利用規約を遵守していることを確認してください。
    例えば、TwitterSnapchatPinterestなどです。

注:この注記はSKANデータには適用されません。Push APIを使用して、SKANデータをサードパーティエンドポイントに送信してください。

Push APIを設定するには、次のアクションリストを完了してください。

Push API設定チェックリスト
手順No. AppsFlyer計測 SKAdNetwork計測
1

既にアクティブなPush APIエンドポイントがある場合は、この手順をスキップしてください。

サーバー側の要件を完了してください。

2

AppsFlyer計測については、Push API計画チェックリストを使用してエンドポイントの設定を計画してください。

不適用

3

AppsFlyer計測エンドポイントの設定

SKAdNetwork計測エンドポイントの設定

サーバー要件(お客様のサーバー)

サーバーが次の要件に準拠していることを確認してください。

サーバー要件
エンドポイント URL
  • 有効なドメイン名
  • アプリごとの一意のエンドポイントの最大数:
    • AppsFlyer: 6 エンドポイント
    • SKAdNetwork: 3 エンドポイント
エンドポイントのリターンコード メッセージ受信の際に、御社のエンドポイントは HTTP 200 ステータスコードを返す必要があります。
AppsFlyerサーバーをホワイトリスト登録する

エンドポイントとの通信を確実にするために、自社のファイアウォールとセキュリティシステムにて、AppsFlyerサーバーのIPアドレスを許可リストに追加してください。

TLS バージョン
ポート

ポート:80、443

AppsFlyer計測用のPush API計画チェックリスト

  • このチェックリストを使用して、AppsFlyer計測のエンドポイント設定を進めてください。図の数字は、チェックリストの行番号を表しています。
  • このセクションはSKAdNetwork計測には関係ありません。SKAdNetwork計測の設定をご覧ください。

エンドポイント

PushAPI_us-en.png

エンドポイント計画テーブル

No.

設定

詳細 この列を使って計画した設定を記録してください。
1

メソッド

POST または GET

 

2

エンドポイント URL

-  
3 イベントメッセージタイプ
  • イベントメッセージタイプを少なくとも 1 つ選択します。
  • アプリ内イベントメッセージを選択するには、アプリ内イベントを記録する必要があります。これが完了するまではアプリ内イベントメッセージは選択できません。

InappSelectionDisabled_us-en.png

 

4

  • フィールド
  • フィールドのリストはすべてのメッセージタイプに共通です

必要なフィールドを選択します。

  • 最も一般的なフィールドは、デフォルトで選択されています。
  • 空白または null の項目は送信しません
 
5

アプリ内イベントの種類

 

アプリ内イベントでフィルタリングして、エンドポイントに送信されるトラフィックを減らします。

  • 1 つまたは複数のアプリ内イベントを選択します。注意:イベントが一覧に表示されない場合は、そのイベントを検索します。
  • 「すべて」を選択すると、新しいアプリ内イベントが自動的に追加されます。
  • アプリ内イベントは、少なくとも1回記録された後にのみ選択できるようになります。必要に応じて、S2S を使用してイベントを発生させます。
  • mceclip1.png
 

AppsFlyer計測エンドポイントの設定

注意: プッシュAPI設定を変更できるのは、AppsFlyerアカウント所有者のみです。他のアカウントユーザーは設定を表示できます。

AppsFlyer計測のエンドポイントを追加する方法:
  1. インテグレーション > APIアクセス を開いてください。Push APIセクションまでスクロールダウンしてください。
  2. エンドポイントを追加をクリックしてください。
  3. HTTPを選択してください:POST または GET
  4. Endpoint URL を入力してください。このURLは安全ではありません というメッセージが表示された場合は、AppsFlyerサポートにお問い合わせください。
  5. 1つまたは複数のイベントタイプを選択してください。:アプリ内イベントメッセージが無効になっている場合は、アプリ内イベントは記録されていないことを意味します。
  6. Push API メッセージを設定するフィールドを選択します。注意:
    • 常に送信される必須フィールド:App ID, Event name, Event time, IDFA (iOS) または Advertising ID (Android)
    • 次の図に示すコントロールを使用して、オプションのフィールドを選択します。

      PushAPIFieldSelect1.jpg

      • 最も一般的な項目は、デフォルトで選択されています。選択をキャンセルすることができます
      • 必要に応じて、オプションのフィールドを選択ください。
      • オプションの項目をすべて削除するには、すべてクリアを使用してください。
      • nullまたは空の項目と関連するキーは送信しません。インポート/解析プロセスを検討する際には、このことを考慮してください。
  7. 1つまたは複数のイベント(最大52イベント)またはすべてのアプリ内イベントを選択してください。
    • リストには、すでに記録されているイベントタイプが表示されます。イベントが見つからない場合は、テストデバイスを使用して、このタイプのイベントを送信します。
  8. 保存をクリックしてください。
    Push APIがアクティブになりました。コンバージョンデータはエンドポイントに送信されます。
  9. 次の手順を使用して、エンドポイントをテストします。

エンドポイントをテストするには、次の手順を実行します。

  1. テスト送信をクリックしてください。
    テスト送信ボタンの下にテスト結果のメッセージが表示されます。
    テストメッセージがエンドポイントに送信されます。テストに失敗した場合、AppsFlyer IPアドレスを許可リストに追加しているか確認してください。
    注! 3秒間の待機時間をもつタイムアウトメカニズムが使用されます。この間にAppsFlyerがOKメッセージを受け取らなかった場合、AppsFlyerはこれをメッセージ送信の失敗と見なします。
  2. 御社エンドポイントがテストメッセージを受信したことを確認してください。
    送信されたメッセージのコピーを確認してください。

SKAdNetwork計測エンドポイントの設定

注意: プッシュAPI設定を変更できるのは、AppsFlyerアカウント所有者のみです。他のアカウントユーザーは設定を表示できます。

SKAdNetwork Push APIエンドポイントを追加する方法:
  1. インテグレーション > APIアクセス を開いてください。Push APIセクションまでスクロールダウンしてください。
  2. 計測エンティティでSKAdNetworkを選択してください。 
  3. エンドポイントを追加をクリックしてください。
    注:アプリごとに1-3個のSKAdNetworkエンドポイントを定義できます。
  4. HTTPを選択してください:POST または GET
  5. Endpoint URLを入力してください。 このURLは安全ではありません というメッセージが表示された場合は、AppsFlyerサポートにお問い合わせください。
  6. nullまたは空の項目と関連するキーは送信しません。インポート/解析プロセスを検討する際には、このことを考慮してください。
  7. 保存をクリックしてください。
    Push APIがアクティブになりました。このエンドポイントにデータが送信されます。

その他の手順—エンドポイントの管理

エンドポイントの変更

注意: プッシュAPI設定を変更できるのは、AppsFlyerアカウント所有者のみです。他のアカウントユーザーは設定を表示できます。

 エンドポイントの設定を変更する方法:

  1. インテグレーション > APIアクセス を開いてください。Push APIセクションまでスクロールダウンしてください。
  2. 変更したいエンドポイントを特定します。
  3. 修正を行います。
  4. [保存] をクリックします。

エンドポイントの削除

注意: プッシュAPI設定を変更できるのは、AppsFlyerアカウント所有者のみです。他のアカウントユーザーは設定を表示できます。

エンドポイントを削除する方法

  1. インテグレーション > APIアクセス を開いてください。Push APIセクションまでスクロールダウンしてください。
  2. エンドポイントを削除をクリックしてください。
  3. [保存] をクリックします。
    エンドポイントが削除されます。

トラブルシューティング、特性、制限事項

テストメッセージに失敗する場合:

テストメッセージが届かず、IPアドレスでサーバーへのアクセスを制限している場合は、AppsFlyer のすべてのIPアドレスを許可していることを確認してください。

リターゲティングアプリ内イベントの重複

ユーザー獲得リエンゲージメント期間中に、リターゲティングキャンペーンの一環として購入イベントが発生すると、アプリ内イベントのリターゲティングが重複します。これは、ユーザー獲得メディアソースとリターゲティングメディアソースの両方に収益を計上するために行われます。

両方を有効にしている場合にのみ、重複するイベントが発生します。

  • インストール後のアプリ内イベント
  • リターゲティングアプリ内イベント

アプリ内イベントを特定し重複を排除してください

 

アプリ内イベントメッセージの選択が無効になっている

InappSelectionDisabled_us-en.png

  • アプリ内イベントメッセージは、アプリ内イベントが記録された後にのみ選択できます。
  • テストデバイスを使用してアプリ内イベントを生成するか、S2S APIを使用して手動で生成します。

送信メッセージが見つからない(CloudFront使用の場合)

エンドポイントとして Amazon CloudFront を使用している場合は、CloudFront が拒否コード 421 でメッセージを拒否しているかどうかを確認してください。この場合には、CloudFront が HTTPS リクエストを処理する方法の選択を参照してください。

エンドポイントのエラーメッセージ

症状:エンドポイントURLを設定すると、このURLは安全ではありません というメッセージが表示されます。

必要なアクション:AppsFlyerサポートに連絡し、アプリID、エンドポイントURL、およびエラーメッセージのスクリーンショットを送信してください。

仕様と制限事項

仕様 備考
アドネットワーク 利用できません
代理店 利用不可
アプリ固有のタイムゾーン サポートされています。
アプリ固有の通貨 サポートされています。
サイズ制限 不適用
オーガニック はい
非オーガニック はい
データの更新頻度 継続的
ヒストリカルデータ サポートされていません。データが見つからない場合は、Pull API を使用してデータを取得してください。SKANの場合は、Data Locker経由で一部の過去データを取得できます(Data Lockerのデータ可用期間による制限)。

アカウント所有者 / ユーザーアクセス

プッシュAPI設定を変更できるのは、AppsFlyerアカウント所有者のみです。

  • 各AppsFlyerアカウントのアカウント所有者は 1人のみです。これは、最初のAppsFlyerユーザー(アカウントが開設された時点で作成されたユーザー)です

アカウントメンバーはPush APIの設定を閲覧できますが、変更はできません。