# TopOn
このドキュメントでは、TEでAdjustデータを統合する方法について説明します。
現在、TEはTopOnのデバイスレポートAPI (opens new window)をサポートしています。
TIP
プラットフォームのデータ統合によって生成されたデータは、クラスターのデータ消費量にカウントすることに注意してください。
# 概要
API名 | 統合タイプ | データ粒度 | アトリビューション | コスト | 収益 | 露出 | クリック | コンバージョン |
---|---|---|---|---|---|---|---|---|
Device Reporting | API | ユーザー | ✅ | ✅ | ✅ |
デバイスレポートAPI (opens new window)では、ユーザーを基準にした集計指標を取得できます。これには、一定期間内のユーザーの総露出回数、クリック回数、収益データが含まれます。そのためTEシステムは各ユーザーごとに毎日のデータを個別に取得します。つまり、1ユーザーあたり1日の広告表示回数、クリック回数および収益状況が含まれます。
TopOnデータと連携する前に、TEシステムのユーザー識別ルールについての#distinct_idと#account_idを理解しておいてください。
# 統合手順
- TopOn クライアントSDK (opens new window)とTE SDKに接続し、TopOn SDKでTEのユーザー識別IDを設定します。
- TopOnのバックエンドにログインして、Publisher KeyとAPP Keyを取得します。
- TEにログインし、サードパーティー統合ページで、TopOnの統合を追加し設定を完了します。
- TEシステムがデータを正常に受信し、レポートの構築が完了したかどうかを確認します。
# クライアントSDK設定
TopOnデータを統合する最初のステップは、TEのSDKとTopOnのSDKをクライアント側で接続し、AFのSDK内でTEシステムのユーザー識別IDを設定することです。
# 1.1 プラン①(自動統合)
- TEのSDK のバージョンが2.8.0〜2.8.1である場合、このプランを直接使用することができます。
- TEのSDK のバージョンが2.8.2以上であれば、サードパーティのデータプラグインをインストールする必要があります。詳細については、Android SDKとiOS SDKを参照してください。
このプランは自動統合プランであり、TEクライアントSDKを初期設定した後に以下のコードを呼び出して開始してください。
// Initialize the TE SDK
ThinkingAnalyticsSDK instance = ThinkingAnalyticsSDK.sharedInstance(this, TA_APP_ID, TA_SERVER_URL);
// Enable TopOn ID association.
instance.enableThirdPartySharing(TDThirdPartyShareType.TD_TOP_ON);
// Initialize the TopOn SDK
// ...
// After registration or creating a character, after calling login to set the account ID, it is necessary to synchronize the data again (optional).
instance.identify("distinct_id");
instance.enableThirdPartySharing(TDThirdPartyShareType.TD_TOP_ON);
このプランの原理は、内部でAT SDKのinitCustomMapメソッドを自動的に呼び出し、AT CustomRuleKeys.USER_IDを渡し、値としてTEプロジェクトのゲストIDを渡すことです。
# 1.2 プラン②(手動統合)
TopOnのアプリ全体にわたるカスタムルール設定を使用し、TEのdistinct_idをTopOn SDKのcustom_rule内のuser_id
に渡します。
iOS クライアントコード例:
[[ATAPI sharedInstance] setCustomData:@{kATCustomDataUserIDKey:self.TA_DISTINCT_ID}];
Android クライアントコード例:
Map<String, String> customMap = new HashMap<>();
customMap.put(ATCustomRuleKeys.USER_ID,"ta_distinct_id");
ATSDK.initCustomMap(customMap);
::: caution 注意(非常に重要)
setCustomData(iOS)メソッドまたはinitCustomMap(Android)を使用して送信するには、TopOn SDKの初期化前に完了する必要があります。そうしないと、一部のuser_idを取得できない場合があります。
:::
# TopOnバックエンド情報取得
SDKの設定が完了したら、TopOnバックエンドにログインし、データを取得するために必要な認証情報を取得する必要があります。
認証情報を取得するには、まずTopOnの担当者に連絡し、デバイスレベルのデータレポートAPIアクセス許可を申請する必要があります。 許可されたら、開発者ダッシュボードのアカウント管理ページでPublisher KeyとApp Keyを確認できます。 これら2つの情報をコピーし、次にTEシステム構成で使用します。
# TEのサードパーティ統合設定
SDKの設定が完了したら、次にTEにログインし「サードパーティ」でTopOnの設定を完了する必要があります。以下はTopOnの設定ページです。「統合スイッチ」を開いて、TopOnの設定を開始してください。
# 3.1 ユーザーの識別と関連付け
TopOnはカスタムユーザーIDフィールドのみを返すことができるため、識別フィールドの変更を許可していません。このドキュメントにしたがってクライアントSDKの構成を完了する必要があります。TopOnデータ内のuser_idはTEシステムのゲストIDと識別されます。
# 3.2 統合パラメータ
次に、データを取得するための設定を行う必要があります。主な構成は2つあります:
データ取得のタイムゾーンの選択:UTC-9、+9、±0 の3つのタイムゾーンを選択できます。
定期取得:TEシステムの定期的なデータ取得を設定することができます。毎日または時間ごとに一定期間のデータを取得することが可能です。ただし、TopOnデバイスレベルのデータレポートAPIは過去29日間のデータしかサポートしていません。
# 3.3 統合プラン作成
データを取得するには、統合プランを作成し、TopOnバックエンドで取得した認証情報を統合プランに入力する必要があります。次の図のように、プラン名を設定し、Publisher Key とApp Keyを入力してください。
# 3.4 設定保存と一回取得
最後に、上記の設定がすべて正しく入力されていることを確認し、ページ右下の「設定保存」をクリックしてください。これで、TopOnの統合設定作業は完了です。
設定を保存した後、ページの右下にある「一回取得」ボタンをクリックし、データの取得を手動で実行することをお勧めします。データ取得のポップアップで、必要なデータ範囲とどのプランが必要かを設定してください。
# データ格納ルール
# 4.1 ユーザー識別ルール
TopOn APIのデータフィールド制限により、TopOn APIのユーザー識別ルールは固定されています:
- アカウントID:チェックせずに、空白のままにします。
- ゲストID:user_idが存在するかどうかを確認し、あればそれを#distinct_idに設定します。存在しない場合は、このデータは無効なデータと見なされ、直接破棄されます。
# 4.2 イベント格納ルール
- TEシステムは毎日0時をイベントの#event_timeとして扱います
- イベント名: -- ta_ad_revenue_topon
- その他フィールドはすべて格納されます
# 4.3 フィールド
TopOnのデータには、以下のイベントプロパティが含まれています。一部のフィールドはTEシステムによって標準化処理されます。
フィールド | 説明 | 標準化フィールド |
---|---|---|
placement_id | 広告プレースID | |
placement_name | 広告プレース名 | te_ads_object.placement |
placement_format | 広告タイプ: 0:native;1:rewarded_video;2:banner;3:interstitial; 4:splash | |
android_id | デバイスID,androidid | |
gaid | Google の広告デバイスID | |
idfa | iOS のデバイスID | |
area | 国家(地域) | |
impression | 露出数 | |
click | クリック数 | |
revenue | 収益は、3つの広告プラットフォームに基づいてデバイスレベルを分割し、通貨単位は開発者のバックエンド構成と同じです。 | te_ads_object.revenue |
ecpm | TopOnは収益APIに基づいて、デバイスの表示ごとに分割された収益とTopOnが統計したデバイスの表示からeCPMを計算します。 計算式:(デバイス収益/ TopOnが統計した露出デバイス)* 1000。 注:eCPMは2日遅れで提供されます。 | |
is_abtest | 対照グループまたは実験グループ: 0:対照グループまたはA/Bテストが設定されていない 1:実験グループ | |
traffic_group_id | 対象グループまたは実験グループID | |
segment_id | トラフィックセグメントID | |
segment_name | トラフィックセグメント名称 | |
idfv | iOSのデバイスID | |
oaid | AndroidのデバイスID | |
user_id | 開発者のカスタムユーザーID | |
network_firm_id | 広告プラットフォームID | |
network_firm | 広告プラットフォーム名称 | te_ads_object.media_source |
currency | 開発者アカウントの通過コード | te_ads_object.currency |
os_version | iOSデバイスの操作OS | |
att_status | iOSデバイスのATT授権状態: 0:Not determined(授権未定) ;1:Restricted (制限);2:Denied(拒否済み);3:Authorize(授権済み) | |
imei | Androidのデバイス識別コード | |
device_type | IOSのデバイスタイプ: 0:非IOSデバイス;1:iPhone;2:iPad | |
brand | デバイスのブランド名 | |
model | デバイスの機種 | |
app_vn | アプリバージョン名 | |
app_vc | アプリバージョン | |
new_user_type | 新規ユーザーかどうか: 1: 新規ユーザー;2: 新規ユーザーではない | |
channel | チャネル、TopOn SDKを介して開発者が入力したチャネル | |
estimate_revenue | 推定収益は、入札広告ソースからリアルタイムの広告表示価格を集計して推定収益を算出し、非入札広告ソースはTopOnが統計した表示数に人工的に設定されたeCPM価格を乗じて推定収益を算出します。 |
# 4.4 ユーザープロパティ格納ルール
現在、TopOnはユーザープロパティのデータ格納ルールを対応していません。
# 後続利用
# 5.1 データ格納検証
最後にTEシステムがTopOnのデータを受信したかどうかを確認してください。以下の方法に従って確認できます:
- 「データ管理」-「メタデータ」ページで、ta_ad_revenue_topon イベントが作成されているかどうかを確認してください。
- イベント分析モデルで ta_ad_revenue_topon にデータがあるかどうかを確認することもできます。
# 5.2 报表建议
以下はレポートを構築するためのいくつかの提案です。
- イベント分析モデルではTopOnのデータを使用して広告収益のコア指標を構築し、広告分析レポートを作成します。
- リテンション分析モデルにおいて、TopOnのデータを活用して広告収益情報とゲーム内課金イベントを組み合わせ、広告収益を含めたLTVを計算します。