Tenjinリアルタイムコールバックインターフェース
サードパーティデータ統合によって生成されたデータは、クラスターの消費データ量に含まれますのでご注意ください
概要
インターフェースの概要
| インターフェース名 | タイプ | 粒度 | アトリビューション | コスト | 収益 | 表示 | クリック | コンバージョン |
|---|---|---|---|---|---|---|---|---|
| リアルタイムコールバックインターフェース | コールバック | ユーザーレベル | ✅ | ✅ |
Tenjinはリアルタイムコールバックリンクを設定する方法を提供しています。アクティベーションイベントをコールバックすることで、ユーザー粒度のアトリビューションデータを取得できます。
Tenjinのリアルタイムコールバックデータの統合を始める前に、AEシステムのユーザー識別ルールを読み、AEが#distinct_idと#account_idによってユーザーを識別する仕組みを理解しておいてください
統合の流れ
- AE管理画面にログインし、サードパーティ統合モジュールでTenjinリアルタイムコールバックインターフェースのプランを追加して、関連する設定を完了します
- Tenjinの管理画面でWebhooksを設定し、AEのコールバックリンクを渡します
- AEシステムがデータを正常に受信しているかを確認し、レポートを作成します
1. プランの設定
Tenjinのコールバックデータを統合する最初のステップとして、AEシステムの管理画面にログインし、「サードパーティ統合」モジュールでTenjinリアルタイムコールバックインターフェースのプランを設定する必要があります。下図はTenjinリアルタイムコールバックインターフェースのプランの設定画面です：
1.1 イベントデータの格納設定
「イベントデータの格納設定」スイッチをオンにすると、Tenjinがコールバックしたデータはすべてイベントテーブルに書き込まれます。イベントデータの格納を有効にすることをお勧めします。
1.2 ユーザープロパティの格納設定
デフォルトでは、AEシステムはTenjinのコールバックデータをユーザープロパティに書き込みません。TenjinにはAEシステムのユーザー識別フィールドが存在せず、コールバックデータをAEのユーザーと紐付けることができないため、ユーザープロパティの格納を有効にすることはお勧めしません
1.3 統合構成
統合構成モジュールでは、データ取得の詳細な設定を制御できます。たとえば、格納後のイベント名などです
統合構成の内容はJSONです。次の内容に従ってカスタム設定できます：
| モジュール | 名前 | 意味 |
|---|---|---|
| sink_event | event_name | 格納後のイベント名。カスタマイズ可能です。 |
1.4 ターミナルアドレス
1.4.1 デフォルト設定
システムレベルおよびプロジェクトレベルのデータ受信URLを設定している場合は、次のリンクが表示されます。このアドレスをそのままコピーできます：
ここにアドレスが表示されない場合は、右上のメニュー「プロジェクト管理 → プロジェクト設定 → プロジェクト構成」でパブリックネットワークURLを設定してください。このアドレスは、AE SDKで設定するデータ受信URLです。設定後、Tenjinリアルタイムコールバックインターフェースの設定ページの「ターミナルアドレス」に戻ってターミナルアドレスをコピーしてください。
1.4.2 カスタムマクロ
TenjinリアルタイムコールバックインターフェースのコールバックURLには、マクロと呼ばれる構造が含まれており、{{macro_name}}の形式で表されます。マクロはプレースホルダーの一種と考えることができ、Tenjinがコールバックするデータにマクロに対応するフィールドが含まれる場合、そのフィールドの値がマクロの位置に埋め込まれます。{{campaign_name}}を例にすると、Tenjinはデータをコールバックする際に、Campaignの値をコールバックURL内のマクロの位置に埋め込みます。
先ほど取得したターミナルアドレスで、以下のアドレスの先頭部分を置き換えてください。置き換えたコールバックURLはコピーしておいてください。後でTenjinの管理画面でこのアドレスを入力する必要があります：
https://{ターミナルアドレス}?bundle_id={{bundle_id}}&platform={{platform}}&store_id={{store_id}}&time_in_ms={{time_in_ms}}&engaged_at_s={{engaged_at_s}}&acquired_at_ms={{acquired_at_ms}}&advertising_id={{advertising_id}}&developer_device_id={{developer_device_id}}&allow_ad_tracking={{allow_ad_tracking}}&ip_address={{ip_address}}&country={{country}}&campaign_name={{campaign_name}}&tenjin_campaign_id={{tenjin_campaign_id}}&click_id={{click_id}}&referrer={{referrer}}&site_id={{site_id}}&ad_network={{ad_network}}&device={{device}}&os_version={{os_version}}&app_version={{app_version}}&sdk_version={{sdk_version}}&language={{language}}&user_agent={{user_agent}}&creative_name={{creative_name}}&device_brand={{device_brand}}&device_model={{device_model}}&carrier={{carrier}}&locale={{locale}}&timezone={{timezone}}&tracking_status={{tracking_status}}
2. Tenjin管理画面での設定
2.1 設定方法
まず、Tenjinの管理画面にログインし、「CONFIGURE」-「Apps」で設定するアプリを選択して、「+ New Callback」をクリックしてコールバックを追加します
右上の「Create Custom Callback」をクリックします
- トリガーイベントには「App Open」イベントを選択します
- トリガー条件には「Ping on Every Install」を選択できます
- コールバックURLには、1.4.2章で推奨しているマクロを入力できます
設定が完了すると、下図のような設定情報が表示されます。Activeにtrueと表示されていれば、コールバックの設定は完了です
2.2 推奨マクロ
コールバックリンクのマクロは、コールバックリンクに設定するプレースホルダーフィールドです。データがコールバックされる際、Tenjinはこれらのマクロをフィールド値に置き換えます。そのため、どのフィールドがコールバックされるかはマクロによって決まります。
下表は推奨するマクロで、1.4.2で提供しているマクロ付きコールバックURLでもこれらのマクロを使用しています。より詳細なマクロの一覧はTenjinの公式サイトで確認できます。設定するマクロを調整したい場合は、TenjinコールバックのCallback URLをご自身で変更してください。
| マクロ | 説明 |
|---|---|
| {{bundle_id}} | Bundle ID（例：com.tenjin.wordfinder） |
| {{platform}} | プラットフォーム |
| {{store_id}} | App Store ID（数字部分） |
| {{time_in_ms}} | リクエスト時間（ミリ秒単位） |
| {{engaged_at_s}} | クリックまたは露出のタイムスタンプ（秒単位） |
| {{acquired_at_ms}} | インストールのタイムスタンプ（ミリ秒単位） |
| {{advertising_id}} | デバイスの広告識別子ID |
| {{developer_device_id}} | IDFVまたは開発者のDevice ID |
| {{allow_ad_tracking}} | 広告トラッキングを許可するかどうか（true、falseはそれぞれ許可、不許可を表します） |
| {{ip_address}} | IPアドレス |
| {{country}} | ユーザーデバイスのCountry code |
| {{campaign_name}} | アトリビューションされたCampaign名 |
| {{tenjin_campaign_id}} | アトリビューションされたCampaign ID |
| {{click_id}} | Channelのclick ID |
| {{referrer}} | Android側のreferrer |
| {{site_id}} | Channelのsite ID |
| {{ad_network}} | 流入チャネル名 |
| {{device}} | デバイスモデル |
| {{os_version}} | デバイスのOSバージョン |
| {{app_version}} | Appバージョン |
| {{sdk_version}} | Tenjin SDKのバージョン |
| {{language}} | デバイスの言語 |
| {{user_agent}} | デバイスのUser Agent |
| {{creative_name}} | クリエイティブ名 |
| {{device_brand}} | デバイスのブランド |
| {{device_model}} | デバイスの機種 |
| {{carrier}} | デバイスの通信キャリア |
| {{locale}} | ローカライズ情報 |
| {{timezone}} | デバイスのタイムゾーン |
| {{tracking_status}} | iOSデバイスのATT許可ステータス。
|
3. データの格納
3.1 格納ルール
- TenjinにはAEシステムのユーザー識別フィールドが存在しないため、固定値をユーザー識別子として使用します。すべてのデータが1人の仮想ユーザーに紐付けられていると考えてください
- データ内のtime_in_msフィールドを、イベントの#event_timeとして使用します
- デフォルトのイベント名は -- tenjin_callback です
- コールバックリンクで設定したその他のフィールドはすべて格納されます
ユーザー粒度のコールバックデータをAEのユーザーに関連付ける必要がある場合は、ユーザープロパティにGAIDとIDFAを記録し（1つのユーザープロパティに記録することをお勧めします）、データ遡及の方法でTenjinのコールバックデータをAEのユーザーに関連付ける必要があります
3.2 標準化フィールド
Tenjinのリアルタイムコールバックデータの一部のフィールドについて、AEシステムは標準化処理を行います
| 元フィールド | 標準化フィールド | 意味 |
|---|---|---|
| campaign_name | te_ads_object.campaign_name | 広告キャンペーン名 |
| tenjin_campaign_id | te_ads_object.campaign_id | 広告キャンペーンID |
| creative_name | te_ads_object.ad_name | 広告名 |
| ad_network | te_ads_object.media_source | メディアチャンネル |
| bundle_id | te_ads_object.app_id | アプリID |
| platform | te_ads_object.platform | プラットフォーム（Android、iOSなど） |
| country | te_ads_object.country | 国・地域コード |