Unity Ads Advertising Statistics API V2.0
サードパーティデータ統合によって生成されたデータは、クラスターの消費データ量に含まれますのでご注意ください
概要
インターフェースの概要
| インターフェース名 | タイプ | 粒度 | アトリビューション | コスト | 収益 | 表示 | クリック | コンバージョン |
|---|---|---|---|---|---|---|---|---|
| Advertising Statistics API V2.0 | API | 集約指標 | ✅ | ✅ | ✅ | ✅ | ✅ |
Unity Adsの広告配信データ2.0をAdvertising Statistics API v2.0を通じてThinking Analytics（以下、AEシステム）にコールバックするプランです。このプランでは次のことに対応しています：
- Unity Adsのコスト、クリック、表示などの基本レポート指標をAEシステムにコールバックします
統合の流れ
- Unityの管理画面にログインし、データを統合するプロジェクトの「Organization ID」と「API Key」を取得します
- AE管理画面にログインし、サードパーティ統合モジュールでUnity統合プランを追加して、関連する設定を完了します
- AEシステムがデータを正常に受信しているかを確認し、レポートを作成します
1. 認証情報の取得
1.1 Organization IDの取得
Unity Ads User Acquisitionの管理画面に移動し、左側のサイドバーで「Administration」ページの「Settings」ページを選択して、「Organization Settings」テーブルで「Organization ID」を見つけてコピーし、保存します。
1.2 API KeyとSecretの取得
次に、サービスアカウント（service account）を作成し、そのアカウントに「広告統計API閲覧者（Advertise Stats API Viewer）」を設定する必要があります。このアカウントのAPI KeyとSecretを使用することで、データを取得できます。以下は、サービスアカウントの作成から始まる一連の手順です：
- サービスアカウントの作成
Unity Cloudの管理画面に移動し、Administration > Service accountsページで、右上の作成ボタンをクリックしてサービスアカウントの作成に進みます。
続いて、必要に応じてサービスアカウント名と説明を入力し、アカウントの作成を完了します。
- 認証Keyの作成
アカウントの作成が完了したら、アカウントの設定ページに移動し、「Keys」セクションで新しい認証Keyを作成します。
作成が完了したら、Key ID、Secret Key、Authorization headerを控えて大切に保管してください。これらの情報は統合プランを作成する際に使用します。
- アカウント権限の設定
次に、このアカウントに「広告統計API閲覧者（Advertise Stats API Viewer）」権限を設定する必要があります。「Organization roles」セクションで、ロールの作成をクリックして権限選択画面に移動します。
権限選択画面の「Growth」オプションで「Advertise Stats API Viewer」を選択し、権限の設定を完了します。
2. プランの設定
Unityの管理画面から認証情報を取得したら、AEシステムにログインし、「サードパーティ統合」モジュールで新しいプランの設定を完了できます。下図はUnity Ads Advertising Statistics API V2.0の設定画面です。この章の内容に従ってプランを作成してください：
2.1 認証情報の設定
「認証情報」の下にある「認証情報設定」ボタンをクリックし、ポップアップに前の手順で取得した情報を入力します：
Unityの管理画面で取得した情報をすべて入力してください。Authorization headerを入力する際は、先頭のBasicプレフィックスを含めてください
2.2 定期取得
「定期取得」モジュールで、AEシステムがUnity Ads Advertising Statistics API V2.0のデータを定期的に取得する方針を設定できます。毎日の特定の時刻に一定期間のデータを取得するよう選択できます。取得したデータもデータ量に計上されるため、定期取得で長すぎる期間のデータを取得しないことをお勧めします
2.3 格納設定
データをイベントとして書き込むかどうかを制御できます。オフにすると、データはイベントテーブルに書き込まれなくなるため、この設定はオフにしないでください。
2.4 統合構成
最後に、統合構成モジュールでデータ取得の詳細設定を制御できます。データの時間集計粒度、取得する指標フィールドとディメンション、格納後のイベント名などが含まれます。
統合構成の内容はJSONです。次の内容に従ってカスタム設定できます：
| モジュール | 名前 | 意味 |
|---|---|---|
| sink_event | event_name | 格納後のイベント名。カスタマイズ可能で、文字列型です。 |
| source | time_granularity | データ取得の時間粒度。以下から選択できます：
|
| metrics | 対応するインターフェースの指標フィールド。リスト型で、カスタマイズ可能 | |
| group_by | データ内のグループ化ディメンション。リスト型。カスタマイズ可能 | |
| transfer | double_columns | データ内の指標。リスト型です。ここに含まれるフィールドはデータ受信時に数値型で格納され、その他のフィールドは文字列（または時間）として格納されます。変更はお勧めしません |
- グループ化ディメンション
以下は、Unity Advertising Statistics API V2.0が対応しているグループ化ディメンションです。調整する場合は、必要なグループ化ディメンションのディメンション名をsource.group_byに記述してください
| ディメンション名 | 説明 | 格納フィールド名 | デフォルトで取得するか |
|---|---|---|---|
| app | Appでグループ化 | app_id | はい |
| app_name | はい | ||
| campaign | Campaignでグループ化 | campaign_id | はい |
| campaign_name | はい | ||
| country | 国（地域）別にグループ化 | country | |
| creativePack | Creative Packでグループ化 | creative_pack_id | はい |
| creative_pack_name | はい | ||
| creativePackType | Creative Packのタイプでグループ化 | creative_pack_type | はい |
| osVersion | OSバージョンでグループ化 | os_version | はい |
| platform | プラットフォームでグループ化 | platform | はい |
| sourceAppId | ソースゲームでグループ化 | source_app_id | |
| store | アプリストアでグループ化 | store | はい |
targetGame | ターゲットゲームでグループ化 | target_id | はい |
| target_store_id | はい | ||
| target_name | はい | ||
| eventType | Unityイベントタイプでグループ化 | event_type | |
| eventName | Unityイベント名でグループ化 | event_name |
- 指標フィールド
Unity Ads Advertising Statistics API v2.0は、グループ化ディメンションのほかに、次の指標フィールドも提供しています。調整する場合は、必要な指標名をsource.metricsに記述してください。
| 指標名 | 格納フィールド名 | フィールドの説明 | デフォルトで取得するか |
|---|---|---|---|
| timestamp | timestamp | イベント時間 | はい |
| starts | starts | 広告の露出回数 | はい |
| views | views | 広告の完全視聴回数 | はい |
| clicks | clicks | 広告クリック数 | はい |
| installs | installs | 広告を見てインストールした回数 | はい |
| spend | spend | 費用 | はい |
| cpi | cpi | インストール単価 | |
| ctr | ctr | クリック率 | |
| cvr | cvr | コンバージョン率 | |
| ecpm | ecpm | eCPM | |
| d[x]AdRevenue | d[x]_ad_revenue | N日広告収益 | |
| d[x]AdRevenueRoas | d[x]_ad_revenue_roas | N日広告収益の回収率 | |
| d[x]IapRevenue | d[x]_iap_revenue | N日アプリ内課金収益 | |
| d[x]IapRoas | d[x]_iap_roas | N日アプリ内課金収益の回収率 | |
| d[x]Purchases | d[x]_purchases | N日アプリ内課金回数 | |
| d[x]UniquePurchasers | d[x]_unique_purchasers | N日初回アプリ内課金ユーザー数 | |
| d[x]Retained | d[x]_retained | N日目継続人数 | |
| d[x]RetentionRate | d[x]_retention_rate | N日目継続率 | |
| d[x]TotalRoas | d[x]_total_roas | N日総収益の回収率 | |
| d[x]LevelComplete | d[x]_level_complete | N日特定レベルをクリアしたユーザー数 | |
| d[x]CostPerLevelComplete | d[x]_cost_per_level_complete | N日特定レベルをクリアしたユーザーの平均費用 | |
| d[x]LevelCompleteRate | d[x]_level_complete_rate | N日特定レベルのクリア率 |
上表の[x]は0, 1, 3, 7, 14などの実際の数字に置き換えることができます。たとえばd7は7日目までの指標を表します
2.5 イベントの格納ルール
- データ内のtimestampフィールド、つまりデータ集約の時間フィールドを、集約データの#event_timeとして設定します
- 名前を変更していない場合、データのイベント名は -- unity_ads_api_data です
- その他のフィールドはすべて格納されます
2.6 標準化フィールド
Unity Ads Advertising Statistics API v2.0のデータ内の一部のフィールドは、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 | ユーザー獲得コスト |