Reyun TrackingIO統合プラン
この記事では、AE管理画面でReyun TrackingIOのデータを統合する方法を説明します。AE管理画面は、Reyun TrackingIOのリアルタイムコールバックデータの統合に対応しています
サードパーティデータ統合によって生成されたデータは、クラスターの消費データ量に含まれますのでご注意ください
概要
インターフェースの概要
| インターフェース名 | タイプ | 粒度 | アトリビューション | コスト | 収益 | 表示 | クリック | コンバージョン |
|---|---|---|---|---|---|---|---|---|
| リアルタイムコールバック | コールバック | ユーザーレベル | ✅ |
Reyun TrackingIOのデータの統合を始める前に、AEシステムのユーザー識別ルールを読み、AEが#distinct_idと#account_idによってユーザーを識別する仕組みを理解しておいてください
現在、Reyun TrackingIOはアクティベーション、登録、ログイン、課金、カスタムイベントのコールバック機能を提供しています。Reyun TrackingIOコールバックリンクのドキュメントはこちらから確認できます。
顧客のアトリビューション情報を取得するために、アクティベーションまたは登録のコールバックデータを統合することをお勧めします。コールバックリンクはReyunの技術担当者が設定する必要があるため、この節の内容に従って必要な情報をすべて取得したうえで、Reyunの技術担当者に連絡してコールバックを設定してください。
統合の流れ
- Reyun TrackingIO SDKとAE SDKを導入し、Reyun SDKの登録メソッドを呼び出す際にAE SDKのゲストIDを渡します
- AE管理画面にログインし、サードパーティ統合モジュールでReyun TrackingIO統合を追加して、関連する設定を完了し、コールバックURLをコピーします
- アプリのAPP_IDとSecret、コールバックURL、コールバックデータの種類をReyunの技術担当者に提供します。Reyunの技術担当者がデータのコールバック設定をサポートします
- AEシステムがデータを正常に受信しているかを確認し、レポートを作成します
1. クライアントSDKの設定
1.1 Reyun SDKとAE SDKの導入
まず、アプリにReyun TrackingIO SDKとAE SDKを導入し、初期化の設定を完了する必要があります。Reyun TrackingIO SDKとAE SDKの統合ドキュメントは以下のとおりです：
1.2 SDKの設定
SDKを導入したら、次にAE SDKのゲストIDとアカウントIDをReyun SDKに設定します。コールバックしたいイベントを事前に決めておき、この章の該当部分に従ってSDKの設定を完了してください
1.2.1 アクティベーションイベント
アクティベーションイベントでは、AE SDKのゲストIDをカスタムプロパティとして設定できます。以下はAndroidのコード例です：
// AE SDK の初期化を完了する
//...
// Reyun でアクティベーションイベントを送信する
// 初期化パラメータオブジェクトを作成する
InitParameters parameters = new InitParameters();
// 初期化パラメータ appkey（必須）
parameters.appKey = "appkey";
// 初期化パラメータ channelId（必須）
parameters.channelId = "320110";
// 初期化パラメータ oaid。oaid を渡した場合、Reyun SDK は msa 関連のインターフェースを呼び出して oaid を取得しなくなる
parameters.oaid = "hahahahahahaha";
// 初期化パラメータ assetFileName。oaid バージョン 1.0.26+ 以上を使用する場合に必要
parameters.assetFileName = "com.reyun.chicken.cert.pem";
// 初期化パラメータ oaidLibraryString。oaid バージョン 1.0.26+ 以上を使用する場合に必要
// msa ドキュメントによると、1.0.26 の値は nllvm1623827671、1.0.27 の値は nllvm1630571663641560568、1.0.30 以上の値は msaoaidsec
parameters.oaidLibraryString = "msaoaidsec";
// AE SDK のゲスト ID を取得する
String distinctId = TDAnalytics.getDistinctId();
// カスタムパラメータに AE SDK のゲスト ID を設定する
HashMap<String, Object> params = new HashMap<>();
params.put("param6", distinctId);
parameters.installParams = params;
Tracking.initWithKeyAndChannelId(getApplication(), parameters);
1.2.2 登録イベント
同様に、登録イベントを送信する際も、カスタムプロパティとしてAE SDKのアカウントIDとゲストIDを渡すことができます：
// AE SDK と Reyun SDK を初期化する
// ...
// AE SDK のアカウント ID とゲスト ID を取得する
String teAccountId = "account_id";
String teDistinctId = TDAnalytics.getDistinctId();
// 登録イベントを送信し、AE SDK のアカウント ID とゲスト ID を渡す
HashMap<String, Object> params = new HashMap<>();
params.put("param6", teDistinctId);
params.put("param7", teAccountId);
Tracking.setRegisterWithAccountID("account_id", params);
1.2.3 カスタムイベント
カスタムイベントの送信は登録イベントと同様です。AE SDKのアカウントIDとゲストIDを取得したら、Reyun SDKのカスタムイベント送信インターフェースで渡すだけです：
// AE SDK と Reyun SDK を初期化する
// ...
// AE SDK のアカウント ID とゲスト ID を取得する
String teAccountId = "account_id";
String teDistinctId = TDAnalytics.getDistinctId();
// カスタムイベントを送信し、AE SDK のアカウント ID とゲスト ID を渡す
HashMap<String, Object> params = new HashMap<>();
params.put("param6", teDistinctId);
params.put("param7", teAccountId);
Tracking.setEvent("event_1", params);
2. プランの設定
SDKの設定が完了したら、次にAEシステムの管理画面にログインし、「サードパーティ統合」モジュールでReyun TrackingIOの設定を完了します。下図はReyun TrackingIOの設定画面です。この章の内容に従ってプランを作成してください：
2.1 ユーザー識別フィールド
Reyunがコールバックするのはユーザーレベルのデータであるため、ユーザー識別ルール、つまりコールバックデータ内で#distinct_idと#account_idに対応するフィールドを設定する必要があります。AEシステムはこの設定に基づき、コールバックデータを変換する際に、これらのフィールドをデータのユーザー識別フィールドとして設定します。
本ドキュメントの前のステップに従ってクライアントSDKを設定した場合は、デフォルト値をそのまま使用できます：
- アカウントIDの関連フィールド：param7
- ゲストIDの関連フィールド：param6
2.2 イベントデータの格納設定
「イベントデータの格納設定」スイッチをオンにすると、Reyunがコールバックしたデータはすべてイベントテーブルに書き込まれます。イベントデータの格納を有効にすることをお勧めします。
2.3 ユーザープロパティの格納設定
デフォルトでは、AEシステムはReyunのコールバックデータに含まれるアトリビューションフィールドを、標準化処理後のユーザープロパティに自動的に書き込みます。ユーザープロパティに書き込まれるフィールドとその意味は以下のとおりです：
| Reyunのフィールド | AEに格納後のユーザープロパティ名 | 説明 |
|---|---|---|
| ry_adgroup_name | te_ads_object.ad_group_name | テキスト |
| channel | te_ads_object.media_source | テキスト |
| ry_adplan_name | te_ads_object.campaign_name | テキスト |
| ry_adcreative_name | te_ads_object.ad_name | テキスト |
旧バージョンのユーザープロパティ格納のデフォルトルールは現在と異なるため、ご注意ください。新旧のプロパティを統合する必要がある場合は、仮想プロパティ機能を使用できます
変更が必要な場合は、「設定ルール」をクリックして、下図のような格納ルールの設定ページに移動します
ここでは、ユーザープロパティの取得元イベントと格納の方法を変更できます。格納の方法はデフォルトでuser_setOnceで、最初に送信された情報のみが保持されます。
「プロパティのマッピング」ボタンをクリックして、ユーザープロパティに書き込むフィールドを追加できます。また、左側の「ルール」ボタンをクリックして新しいルールを追加することもできます。
ユーザープロパティの格納を無効にしたい場合は、すべてのルールを停止します：
2.4 ターミナルアドレス
システムレベルおよびプロジェクトレベルのデータ受信URLを設定している場合は、以下のようなリンクが表示されます。このアドレスをそのままコピーできます：
ここにアドレスが表示されない場合は、右上のメニュー「プロジェクト管理 → プロジェクト設定 → プロジェクト構成」でパブリックネットワークURLを設定してください。このアドレスは、AE SDKで設定するデータ受信URLです。設定後、Reyunの設定ページの「ターミナルアドレス」に戻ってターミナルアドレスをコピーしてください。
2.5 統合構成
最後に、統合構成モジュールでデータ取得の詳細な設定を制御できます。格納後のイベント名などが含まれます。
統合構成の内容はJSONです。次の内容に従ってカスタム設定できます：
| モジュール | 名前 | 意味 |
|---|---|---|
| sink_event | event_mapping | 格納後のイベント名。カスタマイズできます。 対応しているKey：
|
2.6 イベントの格納ルール
-
データ内のactivetimeフィールドを、イベントの#event_timeとして使用します
-
コールバックデータのデフォルトのイベント名は以下のとおりです。sink_event.event_mappingを変更することで、デフォルトのイベント名を変更できます：
- アクティベーションイベント：reyun_init
- 登録イベント：reyun_sign_up
- ログインイベント：reyun_login
- 課金イベント：reyun_payment
- カスタムイベント：イベント名の前にreyun_を付けます。例：reyun_event_1
-
その他のフィールドはすべて格納されます。Reyunのコールバックデータには以下のフィールドが含まれます：
| Reyunのコールバックフィールド | タイプ | 説明 | 備考 |
|---|---|---|---|
| spreadurl | テキスト | キャンペーンの短縮リンク | クリックパラメータ。ASAアトリビューションまたはオーガニックユーザーの場合、これらのフィールドは返されません |
| spreadname | テキスト | キャンペーン名 | |
| channel | テキスト | チャンネル名 | |
| clicktime | テキスト | クリックの受信時刻 | |
| uip | テキスト | クリックIP | |
| csite | テキスト | 広告ユニットID | |
| ry_adgroup_id | テキスト | 広告グループID | |
| ry_adgroup_name | テキスト | 広告グループ名 | |
| ry_adplan_id | テキスト | 広告キャンペーンID | |
| ry_adplan_name | テキスト | 広告キャンペーン名 | |
| ry_adcreative_id | テキスト | 広告クリエイティブID | |
| ry_adcreative_name | テキスト | 広告クリエイティブ名 | |
| advert_id | テキスト | 広告ID | Ocean Engine 2.0固有のパラメータ |
| advert_name | テキスト | 広告名 | Ocean Engine 2.0固有のパラメータ |
| project_id | テキスト | プロジェクトID | Ocean Engine 2.0固有のパラメータ |
| project_name | テキスト | プロジェクト名 | Ocean Engine 2.0固有のパラメータ |
| mid1 | テキスト | 画像素材ID | Ocean Engine 2.0固有のパラメータ |
| mid2 | テキスト | タイトル素材ID | Ocean Engine 2.0固有のパラメータ |
| mid3 | テキスト | 動画素材ID | Ocean Engine 2.0固有のパラメータ |
| mid4 | テキスト | 組み合わせたプレイアブル素材ID | Ocean Engine 2.0固有のパラメータ |
| mid5 | テキスト | ランディングページ素材ID | Ocean Engine 2.0固有のパラメータ |
| mid6 | テキスト | Androidダウンロード詳細ページ素材ID | Ocean Engine 2.0固有のパラメータ |
| accountid | テキスト | 配信アカウントID | 媒体側の配信アカウント |
| requestid | テキスト | リクエスト配信ID | Ocean Engine共通パラメータ |
| convertid | テキスト | コンバージョンID | Ocean Engine共通パラメータ |
| appkey | テキスト | Reyunのアプリ固有識別子 | |
| activetime | テキスト | イベントの受信時刻 | |
| what | テキスト | イベントタイプ | アクティベーションの場合：install |
| osversion | テキスト | OSバージョン | |
| ryos | テキスト | OS | |
| devicetype | テキスト | デバイスタイプ | |
| deviceid | テキスト | デバイスID | |
| Idfa | テキスト | iOSのIDFA | |
| idfv | テキスト | iOSのIDFV | |
| imei | テキスト | AndroidのIMEI。Android 10以降では取得できません | |
| oaid | テキスト | OAID | |
| androidid | テキスト | Android ID | |
| aip | テキスト | コンバージョンイベントのIP | |
| skey | テキスト | リクエストパラメータsecuritykeyのことで、意味はありません | |
| attribution | テキスト | ASAアトリビューション | ASAパラメータ。ASA広告アトリビューションの場合のみ返されます |
| orgid | テキスト | キャンペーングループID | |
| campaignid | テキスト | キャンペーンID | |
| clickdate | テキスト | ASA広告のクリック時刻 | |
| adgroupid | テキスト | 広告グループID | |
| keywordid | テキスト | キーワードID | |
| creativesetid | テキスト | 素材ID（クリエイティブID） | |
| conversiontype | テキスト | コンバージョンタイプ（新規または再インストール） | |
| account | テキスト | 登録時に設定したアカウントID | 登録イベントにのみ含まれます |
| param1~param10 | テキスト | カスタムパラメータ | デフォルトでは、param6をAE SDKのゲストID、param7をアカウントIDに対応させることをお勧めします |
2.7 標準化フィールド
以下は、Reyunのコールバックデータで標準化されるフィールドです：
| コールバックフィールド | 標準化フィールド | 説明 |
|---|---|---|
| channel | te_ads_object.media_source | チャンネル名 |
| csite | te_ads_object.placement | 広告ユニットID |
| ry_adgroup_id | te_ads_object.ad_group_id | 広告グループID |
| ry_adgroup_name | te_ads_object.ad_group_name | 広告グループ名 |
| ry_adplan_id | te_ads_object.campaign_id | 広告キャンペーンID |
| ry_adplan_name | te_ads_object.campaign_name | 広告キャンペーン名 |
| ry_adcreative_id | te_ads_object.ad_id | 広告クリエイティブID |
| ry_adcreative_name | te_ads_object.ad_name | 広告クリエイティブ名 |
| advert_id | te_ads_object.ad_id | 広告ID |
| advert_name | te_ads_object.ad_name | 広告名 |
3. Reyunの技術担当者に連絡してコールバックを設定する
次に、Reyunの担当者に連絡してコールバックを有効にしてもらう必要があります。通常、Reyunに以下の4つの情報を提供する必要があります：
| メッセージ | 説明 | 例 |
|---|---|---|
| コールバックデータの種類 | 統合する必要があるコールバックデータ | |
| コールバックリンク | AEシステムがコールバックデータを受信するアドレス。統合構成ページで取得します | https://{receiver-host}/attribution/callback/reyun/{app-id} |
| appkey | Reyun管理画面における広告主のプロダクトの一意な識別子。Reyun管理画面から取得します | f819f9cac******812b2067d0cf8 |
| securitykey | セキュリティ検証用のフィールド。現在AEは対応していません。広告主が自由に設定できます | abc123 |
4. その後の利用
4.1 データ格納の確認
最後に、AEシステムがReyunのコールバックデータを受信しているかどうかを確認してください。以下の方法で確認できます：
- 詳細データで確認する
プラットフォームの統合ステータスが「統合済」であれば、そのプラットフォームからデータを受信し、データが格納されていることを示します。この場合、「サードパーティ統合」リストで該当プランのカードにカーソルを合わせ、詳細アイコンをクリックしてプランの詳細ページに入ると、受信した直近1000件のデータを確認できます。特定の行をクリックすると、変換前と変換後のデータを含むそのデータの詳細情報を確認でき、そのデータをコピーまたはエクスポートできます。また、詳細ページ右上の「フルデータのダウンロード」をクリックすると、すべてのデータをダウンロードできます：
- その他の製品モジュールで確認する
統合ページのほか、「データ管理」ページでも、コールバックイベントやユーザープロパティが作成されているかどうかを確認できます。
また、イベント分析モデルやユーザープロパティ分析モデルなどの分析モデルで分析を行い、データが格納されているかどうかを確認することもできます。
4.2 レポートの提案
レポート作成に関するいくつかの提案を以下に示します：
- 各モデルで、Reyunがコールバックしたユーザーのアトリビューションフィールドを使ってユーザーグループを比較し、流入元ごとのユーザーのゲーム内行動の違いを分析します
- リテンション分析モデルで、Reyunがコールバックしたアトリビューション情報を使って、流入元ごとのユーザーのLTVを比較分析します