この連携は、すでにAdjustをご利用のお客様が対象になります。
連携をご希望の際は、アプリストアからご利用ください。
なお、下記事項に同意の上インストールをお願いします。
- 連携するデータについては、テンプレート上でカスタマイズが可能です。
- エンドユーザーの個人情報を含むデータを連携する場合には、お客さまにて自社のポリシー等に準拠するかどうかのご判断をお願いいたします。
- 連携データを後からKARTE側で削除することはできないため、個人情報を含むデータの連携にはご注意ください。
またリージョン固定プランで外部サービス連携を行う場合には、以下をご留意ください。
- KARTEと連携して利用する外部サービスについては、データの処理・保管場所を国内に限定することを弊社で保証することはできません。
- 外部サービスがお客様のポリシーに準拠しているかどうかは、お客さまにて判断してご利用いただくようお願い致します。
連携概要
KARTEとAdjustを連携させることにより、KARTEとAdjustで相互にデータ連携をすることが可能です。
Adjust → KARTEへのデータ連携により、アプリへの流入元データに応じて、アプリ起動後の接客をパーソナライズしたり、KARTE → Adjustへのデータ連携により、プッシュ通知やアプリ内メッセージへの反応を含む、より細かなアプリ内の行動データをAdjustの管理画面でレポートとしてみることができるほか、広告配信リスト作成の条件としてご利用いただくことも可能です。
Adjust → KARTEへの連携
できること
- Adjustで発生したイベント(以降、Adjustイベント)には、インストール/アプリ起動時の流入元の情報が付与されています。これらの情報を使ってセグメントを定義することで、起動前と起動後のコミュニケーションの両方を顧客軸で最適化することができます。
- KARTE上のユーザー(メンバー / ビジター両方)に対して、 Adjustイベントを紐付けることができます。
- Adjustイベントを使ったセグメントの作成、接客サービスの配信トリガーの設定が可能になります。
想定される利用シナリオ
- アプリインストール / アプリの起動のきっかけとなった流入元(Webサイト内の導線や広告キャンペーン等)に応じて、アプリ起動時に表示するアプリ内メッセージを出し分ける
- アプリインストール / アプリの起動のきっかけとなった流入元(Webサイト内の導線や広告キャンペーン等)に応じて、それ以降に送信するプッシュ通知の内容をパーソナライズする
※FacebookとTwitterに関しては、流入元のキャンペーン情報は取得できません。チャネル(Facebook/Twitterからの流入であること)は取得できます。
KARTE → Adjustへの連携
できること
- KARTEで計測しているウェブまたはアプリでのユーザー行動をWebhookでリアルタイムにAdjustに連携します(後述)
- 連携されたデータは、Adjustのダッシュボード上でレポートとして見ることができ、また広告配信リストの条件として指定することも可能です。
想定される利用シナリオ
- KARTEで計測している、ウェブ/アプリの行動データをリアルタイムにAdjustに連携し、広告配信リスト作成の条件として利用する
連携に必要な準備、実装
すでに、KARTE for App および Adjust のセットアップは完了していることを前提とします。
Adjust ダッシュボードでの事前準備
Adjustダッシュボードでの設定は、Adjustのサポートサイト、 KARTE連携をご確認ください。
- KARTE連携を有効化
KARTE の API KEY を入力します。
パラメータ転送を「ON」にします。
各 In-App Event について、KARTE上で発火させたいイベント名を指定します。
- ※イベント名を指定しない場合も
_adjust_install
は自動発生します
- ※イベント名を指定しない場合も
その他のイベントについては自由に設定していただけます。
イベント名には半角小文字英字(a-z)、半角数字(0-9)と’_’が使用できます
※1 KARTEに連携するイベントは個別に指定可能です。やりたいシナリオで必要なイベントのみをホワイトリストで指定してください。(KARTEにIn-Appイベントを連携するには、Adjust側での指定とあわせ、後述するようにKARTE側でも受信するIn-Appイベントの指定が必要となります。)
※2 AdjustはAppという概念の下に、本番環境とsandboxがあり、Partner SetupではApp単位で1つのAPIしか紐づけることができません。従って、そのままでは、KARTE本番環境とAdjust本番環境、KARTE検証とAdjust sandboxを連携することができません。その上で検証を進めるには以下の3つの方法があります。
- a) 検証時は検証環境のAPIキーを入れて、本番リリース時には本番環境のAPIキーに差し替える
- b) AdjustのAppにはKARTE本番環境のAPIキーを設定し、sandboxのポストバックイベントもKARTE本番に連携されることを許容する
- c) AdjustのApp自体を本番と検証でわける(個別にAPIキーを指定できるようになる)
KARTE 管理画面での事前準備
Adjust連携の有効化設定をプレイド側で行います。
KARTE プラグイン設定画面にて 連携するIn-App Eventの指定
Adjust側のIn-Appイベントの連携が必要な場合に限り、本手順で KARTEに連携するIn-App Eventの指定を行います。
(インストール経路情報の連携のみであれば、本設定は必要ありません。)
- KARTEログイン後、左カラムメニューの「ストア>アプリ設定>Adjust」を選択します
- Adjustに関する詳細設定を開きます
- プロジェクト別設定にて、連携するIn-Appイベントをカンマで指定し設定下さい
ネイティブアプリでの実装
AdjustイベントとKARTE上のユーザーを紐付けるために、Adjust SDKを初期化(※)する際に、KARTE SDKから取得可能なvisitor_id
を全てのイベントのパラメータに付与する必要があります。
以下にサンプルコードを記載します。(こちらの Developer Portal の記事も参照下さい)
iOSの場合(Swift例)
let visitorId = KarteApp.visitorId
let yourAppToken = "{YourAdjustAppToken}"
let adjustConfig = ADJConfig(appToken: yourAppToken, environment: ADJEnvironmentProduction)
Adjust.addSessionPartnerParameter("visitor_id", value: visitorId)
Adjust.appDidLaunch(adjustConfig)
Androidの場合(Kotlin)
val visitorId = KarteApp.getVisitorId()
val appToken = "{YourAdjustAppToken}"
val environment = AdjustConfig.ENVIRONMENT_PRODUCTION
Adjust.addSessionPartnerParameter("visitor_id", visitorId)
val config = AdjustConfig(this, appToken, environment)
以上で、初期に必要な設定は完了です。
(※)ここでいう「初期化」とは、アプリ内にてSDKの機能を利用するにあたっての初期設定のことを指します。
実装のご確認
AdjustからKARTEへの連携タイミングですが、インストールイベント(_adjust_install
)から行われます。ユーザーストーリー画面より、該当イベントの到達および、イベントに付随するフィールド・パラメータをご確認くださいませ。
なお、すでに一度Adjust経由でインストール実績がある端末の場合は、再インストール扱いとなることから、インストールをしても_adjust_install
が発生しないケースがございます。その際は、以下手順に沿い、Adjust管理画面からテスト中のデバイスを削除した上での検証をお願い致します。
【Adjust管理画面でのデバイス削除手順について】
- テスト中のデバイスより、該当アプリの削除(アンインストール)を行います
- Adjust管理画面より、テストデバイスを削除致します
- 該当アプリを再度インストールします
Adjust管理画面からのテストデバイス削除については、Adjustサポートサイトを参考下さい。
デバイスのIDの確認には、別途各種ツールをご活用の上、ご対応ください。
上記の手順に沿うことで、改めて初回のインストールの扱いとなり、_adjust_install
が KARTEで発生すれば成功となります。
Adjust発生イベントが、KARTEに到達するまでのタイムラグについて
Adjustで発生したイベントが、KARTEに到達するまで、若干のタイムラグ(30秒〜1分30秒程度)が発生致します。例えば、インストール直後での接客サービスにご活用をご検討の際には、このタイムラグを考慮に入れて頂いたのち、動作検証をしたうえでのご確認をお願い致します。
KARTE → Adjustのイベント連携の設定方法
KARTEで計測しているウェブまたはアプリでのユーザー行動をリアルタイムにAdjustに連携するための設定方法について紹介します。
2023年10月以前は、「Webhook」タイプの接客アクションを利用した方式を採用していました。2023年10月以降、「Webhook」タイプの接客アクションは新規提供を停止しています。新規に利用開始される場合は、ここで紹介するKARTE Craftを利用した連携方式をご利用ください。
- 下記記事の手順に従って、「KARTE Craftを使った外部サービスへのWebhook連携」を利用可能な状態に設定します。
- 同ドキュメントのWebhook用接客サービスの作成手順に従い、Webhook接客サービスを作成します
- ※ Android向けとiOS向けで、それぞれWebhook用接客サービスの作成が必要です
ユーザー情報変数の作成
次のユーザー情報変数を作成します。
変数名 | 設定 |
---|---|
created_at_unix |
すべての期間 _adjust_karte_sync date の 最新の値 |
(Android向けのみ) gps_adid |
すべての期間 _adjust_karte_sync gps_adid の 最新の値 |
(iOS向けのみ) idfa |
すべての期間 _adjust_karte_sync idfa の 最新の値 |
dataの設定方法 (Android向け)
Android向けWebhook用接客サービスでは、アクション編集画面のdataを次のように設定します。
※ APP_TOKEN
と EVENT_TOKEN
には、実際にはダッシュボードで取得できるAdjustの「アプリトークン」と「イベントトークン」を記載してください
{
"url": "https://s2s.adjust.com/event",
"hookData": {
"app_token": "APP_TOKEN",
"event_token": "EVENT_TOKEN",
"s2s": "1",
"created_at_unix": "#{created_at_unix}",
"gps_adid": "#{gps_adid}"
},
"method": "GET",
"headers": {"Content-Type": "application/json; charset=UTF-8"},
"campaignId": "#{campaign_id}"
}
dataの設定方法 (iOS向け)
iOS向けWebhook用接客サービスでは、アクション編集画面のdataを次のように設定します。
※ APP_TOKEN
と EVENT_TOKEN
には、実際にはダッシュボードで取得できるAdjustの「アプリトークン」と「イベントトークン」を記載してください
{
"url": "https://s2s.adjust.com/event",
"hookData": {
"app_token": "APP_TOKEN",
"event_token": "EVENT_TOKEN",
"s2s": "1",
"created_at_unix": "#{created_at_unix}",
"idfa": "#{idfa}"
},
"method": "GET",
"headers": {"Content-Type": "application/json; charset=UTF-8"},
"campaignId": "#{campaign_id}"
}
Adjustイベント KARTEイベントの対応
イベント名とパラメータの対応表
Adjustプラグインによって KARTE に連携される Adjust イベントと、KARTEで発生するイベント名 および パラメータの対応表を以下に記載します。
Adjustイベント | KARTEで発生するイベント名 | KARTEイベントに設定されるパラメータ | 備考 |
---|---|---|---|
Install | _adjust_install |
※別紙記載のパラメータ | |
In-app event | _adjust_{event_name} |
※別紙記載のパラメータ + Adjust SDK でイベント送信時に設定した Partner Parameter | {event_name} には Adjust ダッシュボードで設定したKARTEに送信するイベント名が入ります。In-app Event の種類に応じて異なる {event_name} が入ります。 |
Reattribution | _adjust_reattribution |
※別紙記載のパラメータ | |
Reinstall | _adjust_reinstall |
※別紙記載のパラメータ | |
Reattribution Reinstall | _adjust_reattribution_reinstall |
※別紙記載のパラメータ- |
※ 別紙: KARTE に送信されるAdjustイベントのパラメータ一覧
パラメータについての補足
Adjust イベントで定義されている一部のパラメータは、 KARTE イベントでは異なる名前で連携されます。(KARTE 上で日付型のパラメータとして利用できるようにするため)
Adjust イベントでのパラメータ名 | KARTEイベントでのパラメータ名 |
---|---|
click_time | click_date |
impression_time | impression_date |
engagement_time | engagement_date |
installed_at | installed_date |
install_finish_time | install_finish_date |
install_begin_time | install_begin_date |
refferal_time | refferal_date |
created_at | created_date |
reattributed_at | reattributed_date |
attribution_updated_at | attribution_updated_date |
uninstalled_at | reinstalled_date |
last_session_at | last_session_date |
注意点
広告ID(IDFA/AAID)の連携について
Adjust連携で、広告ID(IDFA/AAID)はKARTEに連携されません。広告IDをKARTEに連携したい場合には、広告ID(IDFA/AAID)の送信について をご確認ください。
iOS 14のATTの影響について
AdjustとKARTEの連携には、IDFAを用いておりませんが、Adjustでのインストール経路判定の際、iOS 14の端末ではIDFAが収集できないケースが増え、probabilistic(確率的)計測による経路判定のデータの増加が見込まれます。その場合、IDFAによる手法と比較すると精度が落ちるため、その精度低下を踏まえた施策のご検討をお願い致します。
この、確率的計測による判定はLAT(Limited Ad Tracking)と呼ばれますが、これによる判定が行われる場合、イベントのフィールド match_type
が probabilistic_matching
という値となります。施策設定の際のご参考としてください。
Adjustのアトリビューションプライバシーモデル
Adjustには、エンドユーザーのトラッキングへの同意状況に基づき、データをサードパーティに共有するかどうかをコントロールする「アトリビューションプライバシーモデル」が存在します。こちらを『拡張プライバシー計測(Extended Privacy Measurement)』に設定した際は、同意を得られたユーザーのデータのみがKARTEにポストバックされる形となります。『確率的アトリビューション(Probabilistic Attribution)』をお選び頂くと、従来通り KARTEにデータを連携することが可能です。デフォルトでは、「確率的アトリビューション」の設定となっているため、特にご対応を頂く必要なく データを連携することが可能です。
※ 最新の仕様については、Adjustのドキュメントをご参照下さい。
一部メディアのポリシーによる取得データへの影響
広告掲載先の一部メディアのポリシーにより、弊社含むAdjustの外部パートナーへのデータ送信が制限されるケースがございます。その際、tracker_name 等のフィールドが、 Unattributedという値になります。以下もあわせてご参考くださいませ。
一部のAPI連携パートナー (SAN)とのインプレッションベースのアクティビティレポート
Googleのキャンペーンタイプの名称変更に伴う注意
- 2021年3月9日より、Google広告のキャンペーンに関するAdjustの仕様変更に伴い、フィールド名
adgroup_name
creative_name
tracker_name
について、パラメータ値が変更される見込みです。 - 具体的には、UACからACIへ、UACEからACEに変更が行われます
- イベント画面などにて、上記フィールドのパラメータのご確認を頂いたのち、適時 セグメント設定などの変更をお願い致します。