ポストバックマクロ:アドネットワーク向け

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

関連する連携済みパートナー向けのポストバックガイド:

アドネットワークへのポストバック

  • ポストバックの設定: ポストバック設定の変更をしたい場合には、担当PDMまでご連絡ください。
  • ポストバックの種類: ポストバックは、インストールとアプリ内イベント、ブロックされたインストールとアプリ内イベント(Protect360による不正検知、もしくは検証ルールの違反によるもの)において利用可能です。
ポストバックデータのソース
データソース 説明
計測リンクのパラメーター

クリックURLとインプレッションURL上でパートナーによって提供されたパラメータ

例:計測リンク上のclick IDのパラメータ - "&click_id=CLICK_ID"

各種Partner ID

パートナーから広告主へ提供された一意のID

例:app ID, account ID, user ID, network ID

SDKによる取得情報

AppsFlyerのSDKによって端末から取得された情報

例:iOSの広告IDは、ポストバック時に"&IDFA=(idfa)"を使うことで取得できます。

AppsFlyerのプラットフォームが取得

AppsFlyerのプラットフォームによって取得された情報

Protect360と検証ルール 不正と判定されたインストールと検証ルールを違反したインストール、またそれらに紐付くアプリ内イベントに関する情報

ポストバックのマクロ

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

以下の表の各列は、それぞれ以下のような内容で構成されています。

  • データソース: データの取得元がどこかを示しています。
    • リンク=計測リンク
    • SDK=アプリに実装されているAppsFlyerSDK、もしくはServer-to-ServerのAPI
    • AF=AppsFlyer側で処理した情報
  • Send All:"はい"の場合、そのアドネットワークに紐付けられていないインストールとイベントに関するデータ(オーガニックを含む)も受信できるかどうかを示しています。 
  • [基本] すべてのポストバック向け:インストール、アプリ内イベント、ブロックされたイベントのポストバックに関連するマクロです。
  • [オプション] アプリ内イベントとブロックされたイベント向け:列に記入されているイベント向けのマクロです。(ブロック / アプリ内イベント)
マクロ名一覧 - インストール / アプリ内イベント / ブロックされたイベント向け
ポストバックマクロ名 データソース Send all 説明 [基本] すべてのポストバック向け [オプション]アプリ内イベントとブロックされたデータ向け
advertising_id SDK はい ユーザーがリセット可能なAndroidの広告ID=GAIDで、(sha1-advertiserId)も使用可能 はい  
app_name SDK はい 広告主が設定したアプリ名 はい  
appsflyer_id SDK はい コンバージョン記録時に発番される、AppsFlyerのユニークID はい  
attributed_touch_type SDK いいえ 想定値:
click, impression, TV, pre-install
はい  
blocked_reason AF いいえ 不正/検証ルールのブロック理由 いいえ ブロック
blocked_reason_value AF いいえ 不正/検証ルールのブロックに関する値(site IDなど) いいえ ブロック
blocked_sub_reason AF いいえ 不正/検証ルールのブロック理由の追加情報 いいえ ブロック
bundle_id SDK はい iOS: 1 アプリまたはアプリのグループを一致させる識別子 (Apple developer bundle IDを参照してください。)
Android:アプリ名
はい  
country_code AF はい ISO 3166 (alpha-2) を使用した国コード:US, CN など はい  
event_name SDK はい 各イベントに割り当てられたイベント名 いいえ アプリ内
event_revenue_USD AF はい イベントの値(USD(米ドル))  いいえ アプリ内
event_revenue SDK はい event_revenue_currency もしくは 予め選択した通貨単位を使ってSDKによってレポートされるイベント値 いいえ アプリ内
event_revenue
_currency
SDK はい イベントでレポートされたイベント収益の通貨コード、もしくは予め選択された通貨単位 いいえ アプリ内
event_time SDK はい イベント時刻 いいえ アプリ内
event_value SDK はい アプリ内イベントに含まれるvalueの情報は、JSON形式ですべて送信可能です。URLは(encode)のマクロを使用してエンコードされます。 いいえ アプリ内
idfa SDK はい ユーザーがリセット可能なiOSの広告ID=IDFAで、(sha1-idfa)も使用可能 はい  
idfv SDK はい iOS端末において、アプリベンダー毎にユーザー毎に発番される一意の識別子 はい  
install_time SDK はい インストールのタイムスタンプ はい  
install_unix_ts SDK はい UNIXフォーマットでのインストールのタイムスタンプ はい  
is_attributed AF はい インストールまたはイベントがこのメディアソースに成果として紐付けられているかどうかを示すフラグ はい  
is_lat SDK はい 追跡型広告の制限(LAT):
iOS:iOS 14以降、 LATの機能はAppleによって廃止されており、代わりにATTを使ってユーザーのプライバシーステータスを判別してください。またその場合、is_latの値は無視してください。iOS14より前の端末でtrueの場合にはIDFAは利用できず、0に設定されます。
Android:trueの場合、そのユーザーは興味に基づく広告をオプトアウトしていますが、その場合でもGAIDの取得は可能です。
はい  
is_primary_attribution AF はい

falseの場合には、"is_retargeting"の項目も参照してください

いいえ アプリ内
is_retargeting リンク いいえ

"is_primary_attribution"の項目と組み合わせて使用します。詳細については、リターゲティングイベントの二重計測を参照してください。

True(1)の場合、そのイベントはリターゲティングキャンペーンに紐付く形でレポートされ、media_sourceの値もリターゲティング媒体になります。

False(0)でis_primary_attributionもfalseの場合、そのイベントはリターゲティングキャンペーンに紐づきますが、media_sourceの値には元々そのユーザーを獲得した新規獲得媒体が入ります。

 

いいえ  
language SDK はい 端末OSによって設定され、端末から取得した言語設定(+地域情報) はい  
oaid SDK はい 一部のAndroid端末でGAIDの代わりに利用されている、ユーザーがリセット可能なID はい  
partner_event_id AF はい パートナーのプラットフォームで発生したイベントと照合するための名前またはID いいえ アプリ内
platform SDK はい 端末のプラットフォーム:
iOS / Android / Windows Mobile
はい  
retargeting_
conversion_type
AF いいえ リアトリビューション、またはリエンゲージメントであるかどうかを示すフラグ リターゲティング限定  
app_version SDK はい アプリのバージョン(開発者によってアプリのコードに設定) はい  
app_id SDK はい アプリによって記録されたapp ID はい  
att-0-1 SDK はい

想定値:

  • 1: ATTステータス=authorized または af_authorized
  • 0: 上記以外
はい  
att-status SDK はい

iOSによって記録されたATTステータス。(authorized、not_determinedなど )

場合によっては値がなく、""が返されることがあります。 

はい  
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: 音声広告
はい はい
imei SDK はい

携帯電話の識別に使用される端末固有の番号

はい  

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

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

イベントポストバックのテンプレート"&event=(event)&json=(encode)"が、次の固有の 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%22
af_content_type%22%3A%22default_type%22%7D%0A


このポストバックのデコードされた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?site_id=(publisher_id)
&advertising_id=(advertiser_id)&android_id=(android_id)
&install_time=(install_unix_ts)

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

Android iOS
http://YourCompanyDomain.com?site_id=(publisher_id)&
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?clickid=8594845&site_id=click123&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