ポストバックマクロ：アナリティクスパートナー向け

推奨
アドネットワーク
最終更新日：
概要： 関連する計測データをAppsFlyerからアナリティクスパートナーに対してポストバックで送信する際に利用可能なマクロについて記載しています。

アナリティクスパートナーへのポストバック

AppsFlyerとの連携の一環として、アナリティクスパートナーはAppsFlyerから送信されるポストバックの内容とエンドポイントの情報を定義する必要があります。ポストバックは、インストール、アプリ内イベント、リエンゲージメントなど、アプリユーザーのエンゲージメント全般に関連します。

  • ポストバック設定：ポストバック設定の変更をご希望の場合には、担当PDMまでご連絡ください。
  • ポストバックの種類：インストールとアプリ内イベントのポストバックを利用可能です。

ポストバックのマクロ

マクロをポストバックに含めることで、ポストバック時に関連する実際のユーザーデータに自動的に置き換えられます。たとえば、インストール時のユーザーのIPアドレスを取得するには、ポストバックURLに"&country_code=(ip)"を追加します。サポートしているマクロについては以下の表を参照してください：

  • データソース： データの取得元がどこかを示しています。
    • SDK＝アプリに実装されているAppsFlyerSDK、もしくはServer-to-ServerのAPI
    • AF＝AppsFlyer側で処理した情報
  • [基本] すべてのポストバック向け：インストールとアプリ内イベントに関連するマクロです。
  • [オプション] アプリ内イベント向け：アプリ内イベントのデータ専用のマクロです。
インストールおよびアプリ内イベントのマクロ
ポストバックマクロ名 データソース 説明 [基本] すべてのポストバック向け [オプション] アプリ内イベント向け
advertising_id SDK ユーザーがリセット可能なAndroidの広告ID＝GAIDで、(sha1-advertiserId)も使用可能 はい  
event_name SDK 各イベントに割り当てられたイベント名   はい
event_revenue_USD AF イベントの値（USD（米ドル））    はい
event_revenue SDK event_revenue_currency もしくは 予め選択した通貨単位を使ってSDKによってレポートされるイベント値   はい
event_revenue_currency SDK イベントでレポートされたイベント収益の通貨コード、もしくは予め選択された通貨単位   はい
event_time SDK Event time   はい
event_value SDK アプリ内イベントに含まれるvalueの情報は、JSON形式ですべて送信可能です。URLは(encode)のマクロを使用してエンコードされます。   はい
partner_event_id AF パートナーのプラットフォームで発生したイベントと照合するための名前またはID   はい
app_name SDK 広告主が設定したアプリ名 はい  
appsflyer_id SDK コンバージョン時に記録されるAppsFlyerにおけるユニークID はい  
attributed_touch_type AF ビュースルーによってアトリビューションが発生したかどうかを示すフラグ
（1 =impression、0 =click）		 はい  
country_code AF ISO 3166 (alpha-2) を使用した国コード：US, CN など はい  
idfa SDK ユーザーがリセット可能なiOSの広告ID＝IDFAで、(sha1-idfa)も使用可能 はい  
idfv SDK iOS端末において、アプリベンダー毎にユーザー毎に発番される一意の識別子 はい  
install_time SDK インストールのタイムスタンプ はい  
install_unix_ts SDK UNIXフォーマットでのインストールのタイムスタンプ はい  
is_lat SDK 追跡型広告の制限(LAT)：
iOS：iOS 14以降、 LATの機能はAppleによって廃止されており、代わりにATTを使ってユーザーのプライバシーステータスを判別してください。またその場合、is_latの値は無視してください。iOS14より前の端末でtrueの場合にはIDFAは利用できず、0に設定されます。
Android：trueの場合、そのユーザーは興味に基づく広告をオプトアウトしていますが、その場合でもGAIDの取得は可能です。		 はい  
language SDK 端末OSによって設定され、端末から取得した言語設定(+地域情報) はい  
app_id SDK AppsFlyerで使用される一意のアプリ識別子 はい  
app-version-name SDK 開発者によってアプリのコードに設定された、アプリのバージョン はい  
attributed_touch time AF ユーザーの広告接触時間 はい  
device_type SDK 端末の商用モデル名
例: SM-GM284、iPhone7など		 はい  
ip AF イベント記録時のユーザー端末のIPアドレス はい  
match_type AF アトリビューション手法のタイプ
例：srn / id_matching / probabilistic		 はい  
os_version SDK デバイスのOSバージョン はい  
user_agent SDK URLのユーザーエージェント はい  
wifi SDK trueの場合、各種イベントの計測時にWi-Fiに接続していたことを示します はい  
oaid SDK 一部のAndroid端末でGAIDの代わりに利用されている、ユーザーがリセット可能なID はい  
platform SDK 端末のプラットフォーム：
iOS / Android / Windows Mobile		 はい  
retargeting_conversion_type SDK リアトリビューション、またはリエンゲージメントであるかどうかを示すフラグ はい  
pid AF インストールまたはアプリ内イベントが紐付けられたアドネットワークの識別ID はい  
af_ad リンク 広告名（詳細）
広告主/代理店/アドネットワークにより設定		 はい はい
af_ad_id リンク 広告主/代理店/アドネットワークにより設定 はい はい
af_adset リンク
  • 広告主/代理店/アドネットワークにより設定
  • 広告セットはキャンペーンと広告の間に位置する階層レベル(詳細)
はい はい
af_adset_id リンク 広告主/代理店/アドネットワークにより設定 はい はい
c リンク キャンペーン名。広告主/代理店/媒体によって設定されます。長さが100文字を超えるものは、"c_name_exceeded_max_length"と管理画面に表示されます。 はい はい
af_c_id リンク 広告主/代理店/アドネットワークにより設定 はい はい
af_siteid リンク
  • 広告を表示しているパブリッシャー(配信面)を識別する、広告媒体が発行しているユニークなID。
    詳細はこちら
はい はい
af_subsite_id リンク
  • アドネットワークのサブネットワーク/パブリッシャーID 
  • メインのパブリッシャー(サイトID)に加えて、サブパブリッシャーが存在する場合や、バナー、インターステシャル、ビデオといった広告タイプ、プレースメントなどの追加情報を含めたい場合にも利用可能です。
    例：af_sub_siteid=ABCD_4567
 はい はい
af_ad_type リンク

以下の命名規則を利用してください：

  • text： テキストのみを含む広告ユニット(例：検索結果など）
  • banner： 画面の上部または下部に表示される基本フォーマット
  • interstitial： 画面閲覧中に差し込まれる、インターステシャル広告
  • video： リワード広告ではない通常の動画広告
  • rewarded_video： 動画視聴と引き換えにアプリ内報酬を提供するリワード動画広告
  • playable： 実際のアプリ操作が一部可能な、インタラクティブな広告
  • sponsored_content： 広告記事のようなスポンサードコンテンツに含まれるリンク
  • audio： 音声広告
はい はい

アプリ内イベント専用マクロ

以下の例では、パートナーが利用可能なアプリ内イベントのポストバックについて紹介しています。

 実装例

&event=(event_name)&json=(event_value) のイベントポストバックのテンプレートの場合、特定のaf_purchaseのイベントは以下のように変換されます：

&event=af_purchase&json=%7B%22af_quantity%22%3A1%2C%22
af_revenue%22%3A%2212000%22%2C%22af_currency%22%3A%22USD%22%2C%22af_content_id%22%3A%221107%22%2C%22af_content_type%22%3A%22default_type%22%7D%0A

このポストバックのデコードされたevent_valueのJSONの値は以下のようになります：
{"af_quantity":1,"af_revenue":"12000","af_currency":"USD","af_content_id":"1107","af_content_type":"default_type"}

エンコードされる値

ポストバックに、 英数字以外の特殊文字が含まれる場合があります。ポストバック時にこれらの値を正しく送信するために、AppsFlyerではポストバック内の英数字以外の値をURLエンコードします。
ポストバックをデコード、もしくはエンコードする場合には、各種エンコードのWebサービスを利用してください。

ポストバックの例

一般的なインストールポストバックの例

Android iOS 
http://YourCompanyDomain.com?pid=(media_source)&advertising_id=(advertiserId)&android_id=(android-id)&install_time=(install-unix-ts)

一般的なアプリ内イベントのポストバックの例

Android iOS 
http://YourCompanyDomain.com?pid=(media_source)&device_ip=(ip)&advertising_id=(advertiserId)&android_id=(android-id)&install_time=(install-unix-ts)&event_name=(event-name)&currency=(currency)&json=(event-value)

アプリ内イベントのポストバック例

イベントパラメータ：

  • イベント名：af_revenue
  • イベント収益：120.00
  • イベントの通貨設定：USD
  • イベントの値(event_value)： {"af_quantity":1,"af_revenue":"120","af_currency":"USD","af_content_id":"1107","af_content_type":"default_type"}

ポストバック：

http://YourCompanyDomain.com?pid=(media_source)&device_ip=38.166.144.142&advertising_id=121sxxxx-xxxx-xxxx-xxxx-52454bd7500b&android_id=9aaeecc4455xxxxx&install_time=1451923560&event_name=af_purchase&currency=USD&revenue=120.00&json=%7B%22af_quantity%22%3A1%2C%22 />af_revenue%22%3A%22120.10%22%2C%22af_currency%22%3A%22USD%22%2C%22af_content_id%22%3A%221107%22%2C%22af_content_type%22%3A%22default_type%22%7D%0A