Unity Ads Advertising Statistics API
サードパーティデータ統合によって生成されたデータは、クラスターの消費データ量に含まれますのでご注意ください
概要
インターフェースの概要
| インターフェース名 | タイプ | 粒度 | アトリビューション | コスト | 収益 | 表示 | クリック | コンバージョン |
|---|---|---|---|---|---|---|---|---|
| Advertising Statistics API | API | 集約指標 | ✅ | ✅ | ✅ | ✅ |
Unity Adsの広告配信データをAdvertising Statistics APIを通じてThinking Analytics(以下、AEシステム)にコールバックするプランです。このプランでは次のことに対応しています:
- Unity Adsのコスト、クリック、表示などの基本レポート指標をAEシステムにコールバックします
統合の流れ
- Unity Dashboardの管理画面にログインし、データを統合するプロジェクトの「Organization ID」と「API Key」を取得します
- AE管理画面にログインし、サードパーティ統合モジュールでUnity統合プランを追加して、関連する設定を完了します
- AEシステムがデータを正常に受信しているかを確認し、レポートを作成します
1. 認証情報の取得
1.1 Organization IDの取得
Unity Dashboardの管理画面に移動し、左側のサイドバーで「Growth」ページの「Settings」ページを選択して、「Organization」テーブルで「Organization ID」を見つけてコピーし、保存します(Organization Core IDではないことに注意してください)。
1.2 API Keyの取得
再び左側のサイドバーで「Growth」ページの「API Management」タブを選択し、「Stats API Access」テーブルで「API Key」を見つけてコピーし、保存します。
2. プランの設定
Unityの管理画面から認証情報を取得したら、AEシステムにログインし、「サードパーティ統合」モジュールで新しいプランの設定を完了できます。下図はUnity Ads Advertising Statistics APIの設定画面です。この章の内容に従ってプランを作成してください:
2.1 認証情報の設定
「認証情報」の下にある「認証情報設定」ボタンをクリックし、ポップアップに前の手順で取得した情報を入力します:
2.2 定期取得
「定期取得」モジュールで、AEシステムがUnity Ads Advertising Statistics APIのデータを定期的に取得する方針を設定できます。毎日の特定の時刻に一定期間のデータを取得するよう選択できます。取得したデータもデータ量に計上されるため、定期取得で長すぎる期間のデータを取得しないことをお勧めします
2.3 格納設定
データをイベントとして書き込むかどうかを制御できます。オフにすると、データはイベントテーブルに書き込まれなくなるため、この設定はオフにしないでください。
2.4 統合構成
最後に、統合構成モジュールでデータ取得の詳細設定を制御できます。データの時間集計粒度、取得する指標フィールドとディメンション、格納後のイベント名などが含まれます。
統合構成の内容はJSONです。次の内容に従ってカスタム設定できます:
| モジュール | 名前 | 意味 |
|---|---|---|
| sink_event | event_name | 格納後のイベント名。カスタマイズ可能で、文字列型です。 |
| source | time_granularity | データ取得の時間粒度。以下から選択できます:
|
| metrics | 対応するインターフェースの指標フィールド。リスト型で、カスタマイズ可能 | |
| group_by | データ内のグループ化ディメンション。リスト型。カスタマイズ可能 | |
| transfer | double_columns | データ内の指標。リスト型です。ここに含まれるフィールドはデータ受信時に数値型で格納され、その他のフィールドは文字列(または時間)として格納されます。変更はお勧めしません |
- グループ化ディメンション
以下は、Unity Advertising Statistics APIが対応しているグループ化ディメンションです。調整する場合は、必要なグループ化ディメンションのディメンション名をsource.group_byに記述してください
| ディメンション名 | 説明 | 格納フィールド名 | デフォルトで取得するか |
|---|---|---|---|
campaignSet | Campaign Setでグループ化 | campaign_set_id | はい |
| campaign_set_name | はい | ||
| campaign | Campaignでグループ化 | campaign_id | はい |
| campaign_name | はい | ||
| creativePack | Creative Packでグループ化 | creative_pack_id | はい |
| creative_pack_name | はい | ||
| target | ターゲットゲームでグループ化 | target id | はい |
| target store id | はい | ||
| target name | はい | ||
| adType | 広告タイプ別にグループ化 | ad_type | はい |
| sourceAppId | ソースゲームでグループ化 | source_app_id | はい |
| store | アプリストアでグループ化 | store | はい |
| country | 国(地域)別にグループ化 | country | はい |
| platform | プラットフォームでグループ化 | platform | はい |
| osVersion | OSバージョンでグループ化 | os_version | はい |
| skadConversionValue | SKAdNetworkコンバージョン値でグループ化 | skad_conversion_value |
- 指標フィールド
Unity Ads Advertising Statistics APIは、グループ化ディメンションのほかに、次の指標フィールドも提供しています。調整する場合は、必要な指標名をsource.metricsに記述してください。
| 指標名 | 格納フィールド名 | フィールドの説明 | デフォルトで取得するか |
|---|---|---|---|
| timestamp | timestamp | イベント時間 | はい |
| starts | starts | 広告の露出回数 | はい |
| views | views | 広告の完全視聴回数 | はい |
| clicks | clicks | 広告クリック数 | はい |
| installs | installs | 広告を見てインストールした回数 | はい |
| spend | spend | 費用 | はい |
| skadInstalls | skad_installs | SKAdNetworkインストール | |
| skadCpi | skad_cpi | SKAdNetwork CPI | |
skadConversion | skad_conversion | SKAdNetworkコンバージョン |
2.5 イベントの格納ルール
- データ内のtimestampフィールド、つまりデータ集約の時間フィールドを、集約データの#event_timeとして設定します
- 名前を変更していない場合、データのイベント名は -- unity_ads_api_data です
- その他のフィールドはすべて格納されます
2.6 標準化フィールド
Unity Ads Advertising Statistics APIのデータ内の一部のフィールドは、AEシステムによって標準化処理されます:
| フィールド | 標準化フィールド | 意味 |
|---|---|---|
| campaign_name | te_ads_object.campaign_name | 広告キャンペーン名 |
| campaign_id | te_ads_object.campaign_id | 広告キャンペーンID |
| creative_pack_name | te_ads_object.ad_group_name | 広告グループ名 |
| creative_pack_id | te_ads_object.ad_group_id | 広告グループID |
| country | te_ads_object.country | 国・地域コード |
| platform | te_ads_object.platform | プラットフォーム(Android、iOSなど) |
| starts | te_ads_object.impressions | 露出数 |
| clicks | te_ads_object.clicks | クリック数 |
| installs | te_ads_object.installs | コンバージョン数(インストール) |
| spend | te_ads_object.cost | ユーザー獲得コスト |

