概要:ローデータ計測イベントを自社サーバーのエンドポイントにストリーミングできます。
Push API
Push APIは、AppsFlyer計測とSKAdNetwork(SKAN)計測により生成されたローデータを、広告主のサーバーにメッセージとしてストリーミングします。メッセージタイプとコンテンツを選択し、送信先のエンドポイントを設定できます。
利用できるメッセージタイプ、データ更新頻度および項目は、次のセクションで説明するとおり、計測を行うフレームワーク(AppsFlyerかSKAN)よって異なります。
AppsFlyer計測メッセージ
メッセージの特性
| 特性 | 詳細 |
|---|---|
| メッセージタイプの分離 |
例: メッセージには次の項目が含まれています:
この表を使用して、このイベントがオーガニックユーザーのインストールイベントであると判断してください。 |
| データ更新頻度 | メッセージは、AppsFlyerプラットフォームにイベントが記録された直後に送信されます。これは通常数分以内に行われます。 |
| メッセージの内容(項目) |
|
| タイムスタンプ項目の形式 |
|
使用可能なメッセージタイプ
| アトリビューションのコンテキスト | メッセージタイプ | conversion_type 項目 | campaign_type 項目 | event_name 項目 | event_type 項目 |
|---|---|---|---|---|---|
| 新規獲得 | インストール* | install |
非オーガニック:UA オーガニック:organic |
install |
|
| 新規獲得 | 新規獲得 - アプリ内イベント | install |
非オーガニック:UA オーガニック:organic |
広告主が定義したイベント名 |
|
| リターゲティング | リエンゲージメント | re-engagement | retargeting | re-engagement | re-attribution |
| リターゲティング | リエンゲージメント アプリ内イベント | re-engagement | retargeting | 広告主が定義したイベント名 | re-engagement-in-app-event |
| リターゲティング | リアトリビューション | reinstall | retargeting | re-attribution | re-attribution |
| 新規獲得 | 再インストール | reinstall |
非オーガニック:UA オーガニック:organic |
reinstall |
|
| リターゲティング | リアトリビューションアプリ内イベント | reinstall | retargeting | 広告主が定義したイベント名 | re-attribution-in-app-event |
| * ビュースルー計測に紐づく一部のインストールは制限されたメディアソースに紐づいています。 | |||||
固有の項目
| 項目 | 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メッセージには、同様の構造と項目が存在します。
メッセージの特性
| 特性 | 詳細 |
|---|---|
| メッセージタイプの分離 |
例: メッセージには次の項目が含まれています:
このことから、次のことがわかります:
|
| データ更新頻度 |
|
| メッセージの例 | スプレッドシートには、メッセージの例が含まれています。提供されている例は JSON 形式です。 SKANメッセージの例 |
SKANアトリビューションのメッセージタイプ
| メッセージタイプ | event_name 項目 | skad_redownload 項目 | event_type 項目 |
|---|---|---|---|
| インストール | install |
|
skad-installs |
| 再インストール | install | True | skad-re-download |
| In-app events | 広告主が設定したイベント名 | 広告主が設定したイベント名 | skad-in-app-event |
| iOSからのポストバック | このメッセージでは利用できません | 場合によって利用できます | skad_postback |
| ポストバックコピー | このメッセージでは利用できません | 場合によって利用できます | skad-postback-copy |
Push APIエンドポイントの設定
注意
次の理由から、Push APIを使用して第三者にAppsFlyerの計測データを送信しないでください:
- ユーザーが第三者へのデータ送信をオプトアウトした場合、CCPAなどのプライバシー規制に違反する可能性があります。
- 一部のメディアソースは、それらによって提供されるユーザーレベルのデータの使用、第三者との共有、またはその両方を制限します。メディアソースの利用規約を遵守していることを確認してください。
例:X Ads / Snapchat / Pinterest
注記: この注記はSKANデータには適用されません。Push APIを使用して、SKANデータをサードパーティエンドポイントに送信してください。
Push APIを設定するには、次のアクションリストを完了してください。
Push API設定チェックリスト
| 手順No. | AppsFlyer計測 | SKAdNetwork 計測: |
|---|---|---|
| 1 |
既にアクティブなPush APIエンドポイントがある場合は、この手順をスキップしてください。 サーバー側の要件を完了してください。 |
|
| 2 | AppsFlyer計測については、Push API計画チェックリストを使用してエンドポイントの設定を計画してください。 | 不適用 |
| 3 | AppsFlyer計測エンドポイントの設定 | SKAdNetwork計測エンドポイントの設定 |
サーバー要件(お客様のサーバー)
サーバーが次の要件に準拠していることを確認してください。
サーバー要件
| エンドポイント URL |
|
| エンドポイントのリターンコード | メッセージ受信の際に、御社のエンドポイントは HTTP 200 ステータスコードを返す必要があります。 |
| AppsFlyerサーバーをホワイトリスト登録する | エンドポイントとの通信を確実にするために、自社のファイアウォールとセキュリティシステムにて、AppsFlyerサーバーのIPアドレスを許可リストに追加してください。 |
| TLSバージョン |
|
| ポート | ポート:80, 443 |
注意! 3秒間の待機時間をもつタイムアウトメカニズムが使用されます。この間にAppsFlyerがOKメッセージを受け取らなかった場合、AppsFlyerはこれをメッセージ送信の失敗と見なします。
AppsFlyer計測用のPush API計画チェックリスト
- このチェックリストを使用して、AppsFlyer計測のエンドポイント設定を進めてください。図の数字は、チェックリストの行番号を表しています。
- このセクションはSKAdNetwork計測には関係ありません。SKAdNetwork計測の設定をご覧ください。
エンドポイント
エンドポイント計画テーブル
| いいえ。 | 設定 | 詳細 | この列を使って計画した設定を記録してください。 |
|---|---|---|---|
| 1 | メソッド | POST または GET | |
| 2 | エンドポイント URL | - | |
| 3 | イベントメッセージタイプ |
|
|
| 4 |
|
要注意all を選択しても、今後追加されるメッセージフィールドは自動的には含まれません。新しいフィールドを追加するには、選択を手動で更新する必要があります。 必要なフィールドを選択します。
|
|
| 5 |
アプリ内イベントの種類
|
アプリ内イベントでフィルタリングして、エンドポイントに送信されるトラフィックを絞ることができます。
|
AppsFlyer計測エンドポイントの設定
注:Push API設定を変更できるのは、AppsFlyerアカウント所有者のみです。他のアカウントユーザーは設定の閲覧のみ可能です。
AppsFlyer計測のエンドポイントを追加する方法:
- エクスポート > API Access に移動します。 Push API セクションまで下にスクロールします。
-
エンドポイントを追加をクリックしてください。
- HTTPメソッドを選択します: POST または GET
- Endpoint URLを入力してください。 このURLは安全ではありませんというメッセージが表示された場合は、AppsFlyerサポートにお問い合わせください。
- 1つまたは複数のイベントタイプを選択してください。 注:アプリ内イベントメッセージが無効になっている場合は、アプリ内イベントは記録されていないことを意味します。
- Push APIメッセージを設定するフィールドを選択します。注記:
- 1つまたは複数のイベント(最大52イベント)またはすべてのアプリ内イベントを選択してください。
- リストには、すでに記録されているイベントタイプが表示されます。イベントが見つからない場合は、テストデバイスを使用して、このタイプのイベントを送信します。
-
保存をクリックしてください。
Push APIがアクティブになりました。コンバージョンデータはエンドポイントに送信されます。 - 次の手順を使用して、エンドポイントをテストします。
エンドポイントのテスト
-
コードを送信をクリックしてください。
テスト送信ボタンの下にテスト結果のメッセージが表示されます。
テストメッセージがエンドポイントに送信されます。テストに失敗した場合、AppsFlyer IPアドレスを許可リストに追加しているか確認してください。
注意!タイムアウトメカニズム(2秒間の待機時間)が使用されます。この間にAppsFlyerがOKメッセージを受け取らなかった場合、AppsFlyerはこれをメッセージ送信の失敗と見なします。 - 御社エンドポイントがテストメッセージを受信したことを確認してください。
送信されたメッセージのコピーを確認してください。
SKAdNetwork計測エンドポイントの設定
注:Push API設定を変更できるのは、AppsFlyerアカウント所有者のみです。他のアカウントユーザーは設定の閲覧のみ可能です。
SKAdNetwork Push APIエンドポイントの追加:
- エクスポート > API Access に移動します。 Push API セクションまで下にスクロールします。
- 計測エンティティでSKAdNetworkを選択してください。
-
エンドポイントを追加をクリックしてください。
注:アプリごとに1〜3個のSKAdNetworkエンドポイントを定義できます。 - HTTPメソッドを選択します: POST または GET
- Endpoint URLを入力してください。 このURLは安全ではありませんというメッセージが表示された場合は、AppsFlyerサポートにお問い合わせください。
- nullまたは空の項目と関連するキーは送信しません。インポート/解析プロセスを検討する際には、このことを考慮してください。
-
保存をクリックしてください。
Push APIがアクティブになりました。このエンドポイントにデータが送信されます。
認証トークンの設定
Push API認証トークンを使用すると、クライアントは、要求されたトークンを使用してカスタマイズ可能な認証ヘッダーを追加することで、Push APIメッセージをシームレスに統合し、保護できます。
各アプリIDに紐づくトークン名と値を定義することで、Push APIメッセージと共に送信されるauthorizationヘッダーをカスタマイズできます。これにより、メッセージは安全であるだけでなく、特定の要件に合わせて調整されます。
その他の手順—エンドポイントの管理
エンドポイントの変更
注:Push API設定を変更できるのは、AppsFlyerアカウント所有者のみです。他のアカウントユーザーは設定の閲覧のみ可能です。
エンドポイント設定の変更:
- エクスポート > APIアクセスに移動します。Push APIセクションまで下にスクロールします。
- 変更したいエンドポイントを特定します。
- 修正を行います。
- 保存 をクリックしてください。
エンドポイントの削除
注:Push API設定を変更できるのは、AppsFlyerアカウント所有者のみです。他のアカウントユーザーは設定の閲覧のみ可能です。
エンドポイントの削除:
- エクスポート > API Accessに移動します。 Push API access セクションまで下にスクロールします。
- エンドポイントを削除をクリックしてください。
-
保存をクリックしてください。
エンドポイントが削除されます。
トラブルシューティング、特性、制限事項
テストメッセージに失敗する場合:
テストメッセージが届かず、IPアドレスでサーバーへのアクセスを制限している場合は、AppsFlyer のすべてのIPアドレスを許可していることを確認してください。
リターゲティングアプリ内イベントの重複
ユーザー獲得リエンゲージメント期間中に、リターゲティングキャンペーンの一環として購入イベントが発生すると、アプリ内イベントのリターゲティングが重複します。これは、ユーザー獲得メディアソースとリターゲティングメディアソースの両方に収益を計上するために行われます。
両方を有効にしている場合にのみ、重複するイベントが発生します。
- 新規獲得 - アプリ内イベント
- リターゲティングアプリ内イベント
アプリ内イベントメッセージの選択が無効になっている
- アプリ内イベントメッセージは、アプリ内イベントが記録された後にのみ選択できます。
- テストデバイスを使用してアプリ内イベントを生成するか、S2S API を使用して手動で生成します。
プッシュメッセージが見つからない(CloudFront使用の場合)
エンドポイントとして Amazon CloudFront を使用している場合は、CloudFront が拒否コード 421 でメッセージを拒否しているかどうかを確認してください。この場合には、CloudFront が HTTPS リクエストを処理する方法の選択を参照してください。
エンドポイントのエラーメッセージ
症状:エンドポイントURLを設定すると、このURLは安全ではありません というメッセージが表示されます。
必要なアクション:AppsFlyerサポートに連絡し、アプリID、エンドポイントURL、およびエラーメッセージのスクリーンショットを送信してください。
特性と制限
| 特性 | 備考 |
|---|---|
| アドネットワーク | 利用不可 |
| 代理店 | 利用不可 |
| アプリ固有のタイムゾーン | サポート対象 |
| アプリ固有の通貨 | サポート対象 |
| サイズ制限 | 不適用 |
| オーガニック | はい |
| 非オーガニック | はい |
| データ更新頻度 | 継続的 |
| 過去データ | いいえ:データが見つからない場合は、Pull APIやData Lockerを使用してデータを取得してください。SKANの場合は、Data Locker経由で一部の過去データを取得できます(Data Lockerのデータ可用期間による制限)。 |
| アカウント所有者 / ユーザーアクセス |
Push API設定を変更できるのは、AppsFlyerアカウント所有者のみです。
アカウントメンバーはPush APIの設定を閲覧できますが、変更はできません。 |
| テストメッセージ内の認証トークン | テストメッセージのヘッダーには、認証トークンが含まれていません。 |
Push APIリクエストにカスタムヘッダーを含めることはできますか?
いいえ。Push APIでは、認証トークンにのみ Authorization ヘッダーを使用できます。追加のカスタム ヘッダー(consumer-key など)はサポートされていません。
追加のパラメーターを渡す必要がある場合は、URLに含めてください。例:
https://your.server.com?consumer_key=abc456