Adjust Report Service API
サードパーティデータ統合によって生成されたデータは、クラスターの消費データ量に含まれますのでご注意ください
概要
インターフェースの概要
| インターフェース名 | タイプ | 粒度 | アトリビューション | コスト | 収益 | 表示 | クリック | コンバージョン |
|---|---|---|---|---|---|---|---|---|
| Report Service API | API | 集約指標 | ✅ | ✅ | ✅ | ✅ | ✅ |
AdjustのReport Service APIは集計された指標データを提供しており、コスト、収益、表示、クリック、コンバージョンなど多くのデータが含まれます。
統合の流れ
Adjust Report Service APIのデータの統合手順は次のとおりです：
- Adjust管理画面で、Adjust APIトークンとアプリトークンを取得します
- AE管理画面にログインし、サードパーティ統合モジュールでAdjust Report Service API統合プランを追加して、関連する設定を完了します
- AEシステムがデータを正常に受信しているかを確認し、レポートを作成します
1. Adjust APIトークンとアプリトークンの取得
1.1 Adjust APIトークンの取得
Report Service APIからデータを取得する前に、まずAdjust APIトークンを取得する必要があります。このトークンは、Adjust Suite管理画面の「アカウント設定」-「マイプロフィール」で取得できます。クラシックダッシュボードの場合は、「マイアカウント」-「あなたのデータ」タブで「ユーザー詳細」を見つけ、下部の歯車ボタンをクリックして取得します。
下図はAdjust Suiteの画面です。APIトークンは図中のAPI Tokenです：
1.2 アプリトークンの取得
次に、Adjustのアプリトークンも取得する必要があります。これによって、どのAdjustプロジェクトからデータを取得するかが決まります。
Adjust管理画面でアプリを見つけ、アプリオプションのキャレット記号（^）をクリックすると、左側のプロジェクトカードにアプリトークン（App Token）が表示されます。また、プロジェクトカードの「すべての設定」をクリックし、「アプリの詳細を表示」をクリックしてもアプリトークンを取得できます。
2. プランの設定
AdjustのAPIトークンとアプリトークンを取得したら、AEシステムにログインし、「サードパーティ統合」モジュールで新しいプランを設定します。下図はAdjust Report Service APIの設定画面です。本章の内容に従ってプランを作成してください：
2.1 認証情報の設定
「認証情報」の下にある「認証情報設定」ボタンをクリックし、ポップアップにApp ID（AdjustのアプリID）とAPI Tokenを入力します
2.2 定期取得
「定期取得」モジュールでは、AEシステムがAdjust Report Service APIのデータを定期的に取得する戦略を設定できます。毎日の特定の時刻、または1時間ごとに、一定期間のデータを取得するよう選択できます。取得したデータもデータ量に計上されるため、長すぎる期間のデータを定期取得しないことをお勧めします
2.3 取得タイムゾーン
取得するデータのタイムゾーンも設定できます。デフォルトはUTC+8です
2.4 格納設定
データをイベントとして書き込むかどうかを制御できます。イベントデータの格納を有効にすることをお勧めします。
2.5 統合構成
最後に、統合構成モジュールでデータ取得の詳細設定を制御できます。データの時間集計粒度、取得する指標フィールドとディメンション、格納後のイベント名などが含まれます。
統合構成の内容はJSONです。次の内容に従ってカスタム設定できます：
| モジュール | 名前 | 意味 |
|---|---|---|
| sink_event | event_name | 格納後のイベント名。カスタマイズ可能 |
| source | metrics | データ内の指標。リスト型。カスタマイズ可能 |
| group_by | データ内のグループ化ディメンション。リスト型。カスタマイズ可能 | |
| time_granularity | データの時間集計粒度。文字列型。値は2.5.2 グループ化ディメンションの時間粒度を参照。テンプレートのデフォルトはday |
必要に応じて統合構成を変更できます
2.5.1 対象指標
対象指標は統合構成のsource.metricsに対応します。Report Serviceは非常に多くの指標に対応しているため、本節では一部のよく使われる指標のみを示します。詳細な指標リストはAdjust公式ドキュメントで確認できます。指標を変更する場合は、必要な指標のフィールド名をsource.metricsに入力してください。
- コンバージョン指標
| フィールド | 定義 | 数式 | フィールド名 | テンプレートでデフォルト使用 |
|---|---|---|---|---|
| 平均DAUs | 選択した期間の平均デイリーアクティブユーザー数 | (D0 DAU + D1 DAU + DAY N DAU) / 選択した期間の日数 | daus | はい |
| 平均MAUs | 選択した期間の平均MAU | (M0 MAU + M1 MAU + MONTH N MAU) / 選択した期間の月数 | maus | はい |
| 平均WAUs | 選択した期間の平均WAU | (W0 WAU + W1 WAU + WEEK N WAU) / 選択した期間の週数 | waus | はい |
基本Sessions数 | ユーザーのsessions数（インストールと再アトリビューションを除く） | - | base_sessions | はい |
| クリック数 | トラッキングされたクリック数 | - | clicks | はい |
| クリック数 (チャネル) | チャネルAPIから報告されたクリック数 | - | network_clicks | はい |
| クリックコンバージョン率 (CCR) | インストール数とクリック数の比率 | インストール数 / クリック数 | click_conversion_rate | はい |
| クリック率(CTR) | クリックと露出の割合 | クリック数 / 露出数 | ctr | はい |
| アトリビューション解除 | アトリビューション解除が発生した回数 | - | deattributions | はい |
| GDPRの忘れられる権利を行使したユーザー数 | EU GDPRの忘れられる権利を行使したユーザー数。Adjustはこれらのユーザーの個人データを永久に削除します | - | gdpr_forgets | はい |
| 露出数 | トラッキングされた広告露出数 | - | impressions | はい |
| 露出数 (チャネル) | チャネルAPIから報告された広告露出数 | - | network_impressions | はい |
| インストール露出比 | インストール数と露出数の割合 | インストール数 / 露出数 | impression_conversion_rate | はい |
| インストール数 | トラッキングされた、アプリをインストールしたユーザー数 | - | installs | はい |
| インストール数 (チャネル) | チャネルAPIから報告されたインストール数 | - | network_installs | はい |
| インストール差異数 | インストール数と、チャネルAPIから報告されたインストール数の差 | インストール数 - インストール数 (チャネル) | network_installs_diff | はい |
| 1000回表示あたりのインストール数 (IPM) | 広告表示1000回あたりに発生したインストール数 | 1000 * 表示コンバージョン比 | installs_per_mile | はい |
| トラッキング制限デバイスのインストール数 | トラッキング制限 (LAT) を有効にしたデバイスのインストール数 | - | limit_ad_tracking_installs | はい |
| トラッキング制限デバイスのインストール割合 | トラッキング制限デバイスのインストール数とインストール数の比率 | トラッキング制限デバイスのインストール数 / インストール数 | limit_ad_tracking_install_rate | はい |
| トラッキング制限デバイスの再アトリビューション数 | トラッキング制限 (LAT) を有効にしたデバイスの再アトリビューション数 | - | limit_ad_tracking_reattributions | はい |
| トラッキング制限デバイスの再アトリビューション割合 | トラッキング制限デバイスの再アトリビューション数と再アトリビューション数の比率 | トラッキング制限デバイスの再アトリビューション数 / 再アトリビューション数 | limit_ad_tracking_reattribution_rate | はい |
| 非オーガニックインストール数 | オーガニックとしてアトリビューションされなかったユーザーのインストール数 | - | non_organic_installs | はい |
| オーガニックインストール数 | オーガニックとしてアトリビューションされたユーザーのインストール数 | - | organic_installs | はい |
| 再アトリビューション数 | 再アトリビューションされたユーザー数 | - | reattributions | はい |
| 再アトリビューションによる再インストール数 | 再アトリビューションされたユーザーの再インストール数 | - | reattribution_reinstalls | |
| 再インストール数 | 再インストールの回数 Uninstall and Reinstall Growth Solutionの購入が必要 | - | reinstalls | |
| 総Sessions数 | 総Sessions数（インストールと再アトリビューションを含む） | base_sessions + installs + reattributions | sessions | はい |
- コスト指標
| フィールド | 定義 | 数式 | フィールド名 | テンプレートでデフォルト使用 |
|---|---|---|---|---|
| 広告支出 | 広告の総支出（取得パラメータによって決定） | クリック支出 + 露出支出 + インストール支出 | cost | はい |
| 広告支出(アトリビューション) | Adjustがトラッキングした広告支出 | クリック支出 + 露出支出 + インストール支出 | adjust_cost | はい |
広告支出(チャネル) | チャネルAPIから報告された広告支出 | クリック支出 + 露出支出 + インストール支出 | network_cost | はい |
| 広告支出の差異 | 広告支出(アトリビューション)と広告支出(チャネル)の差 | 広告支出(アトリビューション)- 広告支出(チャネル) | network_cost_diff | はい |
| クリックコスト | 広告クリックにかかったコスト支出 | - | click_cost | はい |
| 有料クリック数 | 広告支出が発生した広告クリック数 | - | paid_clicks | はい |
| eCPI (全インストール) | 全インストールの平均有効支出 | 広告支出 / インストール | ecpi_all | はい |
| eCPI (チャネル) | チャネルAPIから報告されたインストールの平均有効支出 | チャネルAPIから報告された広告支出 / チャネルAPIから報告されたインストール数 | network_ecpi | はい |
| eCPI (有料インストール) | 有料インストールの平均有効支出 | チャネルAPIから報告された広告支出 / 有料インストール数 | ecpi | はい |
| eCPM (アトリビューション) | アトリビューションデータから報告されたeCPMデータ | (広告支出 / 有料露出数) * 1000 | ecpm | はい |
| eCPM (チャネル) | チャネルAPIから報告されたeCPMデータ | (チャネル支出 / チャネル有料露出) * 1000 | network_ecpm | はい |
| eCPC | クリックあたりの平均有効支出 | 広告支出 / 有料クリック数 | ecpc | はい |
| 露出コスト | 露出にかかったコスト支出 | - | impression_cost | はい |
| 有料露出数 | 広告支出が発生した有料露出数 | - | paid_impressions | はい |
| インストールコスト | インストールにかかったコスト支出 | - | install_cost | はい |
| 有料インストール数 | 広告支出が発生した有料インストール数 | - | paid_installs | はい |
- 収益指標
| フィールド | 定義 | 数式 | フィールド名 | テンプレートでデフォルト使用 |
|---|---|---|---|---|
| 広告露出数 | 広告の総露出数 | - | ad_impressions | はい |
| 広告収入 | 広告の総収入 | - | ad_revenue | はい |
| コホート累計広告収入 | 選択した期間内にインストールしたユーザーの現在までの広告収入 例：選択した期間が1/1～1/31で、今日が5/1の場合、1/1～1/31にインストールしたユーザーの5/1までの広告収入を計算します | - | cohort_ad_revenue | はい |
| 1000回表示あたりの広告収入 | 広告表示1000回あたりの平均収入 | (広告収益 / 広告露出) * 1000 | ad_rpm | はい |
| アプリ内課金収入 | アプリ内課金収入 | - | revenue | はい |
| コホート累計アプリ内課金収入 | 選択した期間内にインストールしたユーザーの現在までのアプリ内課金収入 例：選択した期間が1/1～1/31で、今日が5/1の場合、1/1～1/31にインストールしたユーザーの5/1までのアプリ内課金収入を計算します | - | cohort_revenue | はい |
| 総収入 | 広告収入とアプリ内課金収入を含む総収入 | 広告収入 + アプリ内課金収入 | all_revenue | はい |
| コホート累計総収入 | 選択した期間内にインストールしたユーザーの現在までの総収入 例：選択した期間が1/1～1/31で、今日が5/1の場合、1/1～1/31にインストールしたユーザーの5/1までの総収入を計算します | コホート累計アプリ内課金収入 + コホート累計広告収入 | cohort_all_revenue | はい |
| ARPU (全体) | すべての収入を含むアクティブユーザーあたりの平均収益 | 総収入 / 総DAU | arpdau | はい |
| ARPU(広告のみ) | 広告収入のみを含むアクティブユーザーあたりの平均収益 | 広告収入 / 総DAU | arpdau_ad | はい |
| ARPU (アプリ内課金のみ) | アプリ内課金収入のみを含むアクティブユーザーあたりの平均収益 | アプリ内課金収入 / 総DAU | arpdau_iap | はい |
| 粗利益 | 総収入から総コストを差し引いたもの | 総収入 - 総コスト | gross_profit | はい |
| コホート粗利益 | 選択した期間にインストールしたユーザーの粗利益 | コホートの総収入 - コスト | cohort_gross_profit | はい |
| コホートROI | 選択した期間にインストールしたユーザーの粗利益をコストで割ったもの | コホートの粗利益 / コスト | return_on_investment | はい |
| アプリ内課金数 | トラッキングされたアプリ内課金イベント数 | - | revenue_events | はい |
| 収入コスト比 (RCR) | 選択した期間にインストールしたユーザーの収入とコストの比率 | コホートの総収入 / 総コスト | revenue_to_cost | はい |
| ROAS (総収入) | 総収入で計算したROAS | (広告収入 + アプリ内課金収益) / コスト | roas | はい |
| ROAS (広告収入) | 広告収入のみで計算したROAS | 広告収入 / コスト | roas_ad | はい |
| ROAS (アプリ内課金収入) | アプリ内課金収入のみで計算したROAS | アプリ内課金収益 / コスト | roas_iap | はい |
2.5.2 グループ化ディメンション
以下は、Report Serviceが対応しているグループ化ディメンションです。時間粒度（1つのみ選択可能。統合構成のsource.time_granularityに対応し、テンプレートのデフォルトはday）とグループ化ディメンション（複数選択可能。統合構成のsource.group_byに対応）が含まれます。ディメンションを変更する場合は、必要なディメンションのフィールド名をsource.group_byに入力してください。
- 時間粒度
| ディメンション | データタイプ | 説明 | 例 | テンプレートでデフォルト使用 |
|---|---|---|---|---|
hour | 日付 | ISO形式の日付値：YYYY-MM-DDTHH:MM:SS | 2021-05-11T17:00:45 | |
| day | 日付 | 日付値の形式：YYYY-MM-DD | 2021-05-11 | はい |
- グループ化ディメンション
| ディメンション | データタイプ | 説明 | 例 | テンプレートでデフォルト使用 |
|---|---|---|---|---|
os_name | 文字列 | OS | 値：android、Bada、blackberry、iOS、Linux、Mac OS、server、symbian、unknown、WebOS、Windows、windows-phone | はい |
device_type | 文字列 | デバイスタイプ | 値：bot、console、iPod、Mac、PC、phone、server、simulator、tablet、TV、unknown | はい |
| app | 文字列 | アプリ名 | - | はい |
| app_token | 文字列 | AdjustでのアプリID | - | はい |
| store_id | 文字列 | ストアのアプリID | com.random.app | はい |
| store_type | 文字列 | アプリのインストール元ストア | google_play | はい |
app_network | 文字列 | アプリ識別子 | 形式：<store_type>:<store_id> 例：google_play:com.random.app | はい |
| currency | 文字列 | 通貨 | Euro | はい |
| currency_code | 文字列 | 3文字のISO 4217通貨コード | EUR | はい |
network | 文字列 | 広告チャネルの名前 | 値：Organic, AppLovin, Facebook Installs, Instagram Installs | |
| campaign | 文字列 | キャンペーン名とIDを含む | - | はい |
| campaign_network | 文字列 | チャネルのキャンペーン名 | - | はい |
| campaign_id_network | 文字列 | チャネルのキャンペーンID | - | はい |
| adgroup | 文字列 | 広告グループ名とIDを含む | - | はい |
| adgroup_network | 文字列 | チャネルの広告グループ名 | - | はい |
| adgroup_id_network | 文字列 | チャネルの広告グループID | - | はい |
| source_network | 文字列 | チャネルに基づく任意の値。通常はadgroup_networkと同じ | - | はい |
| source_id_network | 文字列 | source_appの値 | - | はい |
| creative | 文字列 | クリエイティブ名とIDを含む | - | はい |
| creative_network | 文字列 | チャネルのクリエイティブ名 | - | はい |
| creative_id_network | 文字列 | チャネルのクリエイティブID | - | はい |
| country | 文字列 | 国/地域名 | United States of America | はい |
| country_code | 文字列 | 2文字のISO 3166国/地域コード | US | はい |
| region | 文字列 | ビジネス地域 | APAC | はい |
| partner_name | 文字列 | Adjustシステムでのパートナー名 | AppLovin | はい |
| partner_id | 文字列 | Adjustシステムでのパートナー ID | 34 | はい |
2.5.3 格納ルール
- データ内のdayまたはhourフィールド、つまりデータの日付を、集計データの#event_timeとして設定します
- テンプレートで使用されるイベント名は -- adjust_report_service_ad_spend です。変更する場合は、sink_event.event_nameを調整してください
- その他の指標、ディメンションのフィールドはすべて格納されます
2.6 標準化フィールド
以下はReport Service APIの標準化フィールドです：
| 元フィールド | 標準化フィールド | 意味 |
|---|---|---|
| campaign_network | te_ads_object.campaign_name | 広告キャンペーン名 |
| campaign_id_network | te_ads_object.campaign_id | 広告キャンペーンID |
| adgroup_network | te_ads_object.ad_group_name | 広告グループ名、マネタイズ広告のUnit名 |
| adgroup_id_network | te_ads_object.ad_group_id | 広告グループID、マネタイズ広告のUnit ID |
| creative_network | te_ads_object.ad_name | 広告名 |
| creative_id_network | te_ads_object.ad_id | 広告ID |
| partner_name | te_ads_object.media_source | メディアチャンネルまたはマネタイズチャンネル |
| store_id | te_ads_object.app_id | アプリID |
| app | te_ads_object.app_name | アプリ名 |
| os_name | te_ads_object.platform | プラットフォーム（Android、iOSなど） |
| country_code | te_ads_object.country | 国・地域コード |
| currency_code | te_ads_object.currency | コストまたは収益の通貨 |
| impressions | te_ads_object.impressions | 露出数 |
| clicks | te_ads_object.clicks | クリック数 |
| installs | te_ads_object.installs | コンバージョン数（インストール） |
| cost | te_ads_object.cost | ユーザー獲得コスト |
| revenue | te_ads_object.revenue | マネタイズ収益 |
3. その後の利用
3.1 データ格納の確認
「データ管理」ページで、イベントadjust_report_service_ad_spendが格納されているかどうかを確認できます
3.2 単発のデータ取得
過去の一定期間のデータ（履歴データや、取得に失敗したデータの補完など）を統合したい場合は、プランを保存した後に再度プランページに入り、右上の単発取得ボタンをクリックして、時間範囲を指定したデータ取得を1回実行できます。なお、取得するデータの期間が以前の取得と重複する場合（たとえば2023-08-01のデータを取得し、この日のデータが以前にすでに取得されている場合）は、最新の取得データで以前のデータが上書きされます：
3.3 ad_spend_modeパラメータの機能
https://help.adjust.com/zh/article/how-ad-spend-source-affects-your-data
新しいAPI機能に対応するため、AEがデフォルトで使用するパラメータはcost_modeからad_spend_modeに変更されました。パラメータのデフォルト値はnetworkです。
ad_spend_sourceをmixedに設定した場合、広告支出の値は次のように取得されます：
- パートナーがAdjustの広告支出API連携を使用している場合、広告支出 = 広告支出 (チャネル) となります。この場合、接続ページでアカウントを追加する必要があります。追加しない場合、値は0と表示されます。
- パートナーがAdjustとAPI連携していないその他のすべての場合、広告支出 = 広告支出 (アトリビューション) となります。