AppLovin Basic Reporting API

TIP

データ統合によって生成されたデータは、クラスターのデータ消費量にカウントすることに注意してください。

概要

API名	統合タイプ	データ粒度	アトリビューション	コスト	収益	インプレッション	クリック	コンバージョン
Basic Reporting API	API	集計		✅	✅	✅	✅	✅

AppLovinは、ユーザーレベルの収益データに加えて、集計指標APIであるBasic Reporting API (opens new window)も提供しています。

統合プロセス

1. AppLovin のバックエンドにログインし、Report Keyを入手します。
2. TE のバックエンドにログインし、サードパーティ統合に進み、AppLovin Basic Reporting APIのプランを追加し、関連設定を完了します。
3. TEシステムがデータを正常に受信し、レポートの構築が完了したかどうかを確認してください。

Report Key 取得

AppLovinのバックエンドにログインし、「Account」-「Key」からReport Keyを取得してください。このキーはしっかり保管してください。

TEのサードパーティ統合設定

Report Keyを取得したら、TEシステムにログインして、「サードパーティ」モジュールで新しいプランの設定を完了できます。以下はAppLovin Basic Reporting APIの設定画面です。この章の内容に従ってプランを作成してください：

2.1 認証情報の設定

「認証情報」ボタンをクリックし、ポップアップ内で取得した認証情報を入力してください。

2.2 定期取得

「定期取得」モジュールで、TE システムが AppLovin Basic Reporting API データを定期的の取得を設定できます。特定の時間帯ごとや毎時など、データを一定期間ごとに取得することができます。

2.3 イベントテーブル格納設定

「イベントテーブルへのデー格納設定」を有効にすると、送信されたデータはすべてイベントテーブルに書き込まれます。イベントデータの格納をお勧めします。

2.4 統合構成

データの取り込みの詳細設定を統合構成モジュールで制御することができます。これには、データの時間集計粒度、取り込む指標フィールドや次元、およびイベント名などが含まれます。

統合構成の内容はJSON形式であり、以下の内容に従ってカスタマイズ設定が可能です：

モジュール	名称	意味
sink_event	event_name	格納後のイベント名は、カスタマイズできます。
source	report_types	データの取得レベル、リストタイプについては、1つのエレメントだけを入力することをお勧めします。つまり、1回に1つのレベルのデータのみを取得してください。 選択肢：advertiser、publisher
	metrics	データ内の指標、リストタイプ、異なるレベルで異なる指標がサポートされており、入力時に注意が必要です。
	group_by	データのグループ化、リストタイプ、異なるレベルでgroup_byのサポートに注意して入力してください

Basic Reporting APIは、広告主レポート（advertiser）とパブリッシャーレポート（publisher）の2つの異なるレポートを提供しており、以下のセクションではそれぞれのレポートの設定方法について説明します。

2.4.1 広告主レポート（advertiser）

広告主のレポートテンプレートは以下の通りです：

{
    "sink_event":
    {
        "event_name": "applovin_advertiser"
    },
    "source":
    {
        "group_by":
        [
            "day",
            "campaign",
            "campaign_id_external",
            "creative_set",
            "creative_set_id",
            "ad_id",
            "ad",
            "ad_type",
            "app_id_external",
            "campaign_ad_type",
            "campaign_package_name",
            "campaign_store_id",
            "campaign_type",
            "country",
            "device_type",
            "external_placement_id",
            "platform",
            "size",
            "traffic_source"
        ],
        "report_types":
        [
            "advertiser"
        ],
        "metrics":
        [
            "impressions",
            "clicks",
            "ctr",
            "conversions",
            "conversion_rate",
            "average_cpa",
            "average_cpc",
            "cost",
            "sales"
        ]
    }
}

• テンプレートで使用する時間粒度は日です（広告主のレポートは時間の集約を時間単位でサポートしていません）。システムはデータの day フィールド、すなわちデータの日付を使ってデータのタイムを割り当てます。
• テンプレートで使用するイベント名は -- applovin_advertiser
• 残りのフィールドはすべて格納されます。
• 対応可能フィールド

広告主のレポートで選択可能なフィールドは以下の通りです。実際のニーズに応じて調整してください。必要なフィールド名をsource.group_byに記入してください。

フィールド	デフォルト	意味
day	yes	レポートの日付
campaign	yes	Campaign 名称
campaign_id_external	yes	Campaign のユニーク識別
creative_set	yes	広告グループ名
creative_set_id	yes	広告グループID
ad_id	yes	広告 ID
ad	yes	広告名称
ad_type	yes	広告タイプ　GRAPHIC, VIDEO, REWARD, PLAY
app_id_external	yes	ハッシュ処理されたapp ID
application		App 名称
campaign_ad_type	yes	User Acquisition Campaignの場合、その値はuaになります。Retargeting Campaignの場合、その値はrtになります。
campaign_package_name	yes	アプリのパッケージ名を広告配信し、Android では package name と呼び、iOS では Bundle ID と呼びます。
campaign_store_id	yes	Androidではpackage name、iOSではiTunes IDの数字部分です。
campaign_type	yes	Campaign の最適化目標（PP, CPE, IAP ROAS, ad ROAS, or ROAS）
custom_page_id		広告グループに関連するiOSカスタム製品ページまたはAndroidストア詳細ページ
country	yes	Country Code
device_type	yes	デバイスタイプ：phone, tablet or other
external_placement_id	yes	エンコードされたアプリケーションID
optimization_day_target		Campaignの目標最適化日（たとえば、day 0またはday 7）
platform	yes	デバイスプラットフォーム　android, ios, fireos, tvos
size	yes	広告サイズ　INTER, BANNER, MREC, LEADER, or NATIVE
target_event		Campaignの計算イベント（CPE Campaignにのみ有効）
traffic_source	yes	トラフィックのソース、値はAppLovinまたはその他のexchange名

- 対応可能指標

これは広告主のレポートで選択できる指標です。実際の必要に応じて調整することができます。必要なフィールドをsource.metricsに記入してください。

フィールド	デフォルト	意味
average_cpa	yes	平均CPA（インストール）
average_cpc	yes	平均 CPC
clicks	yes	クリック量
conversions	yes	コンバージョン量（インストール量）
conversion_rate	yes	コンバージョンレート（インストール量/クリック量）
cost	yes	広告コスト
ctr	yes	クリック率
campaign_bid_goal		Campaignの入札目標
campaign_roas_goal		Campaign の ROAS 目標
first_purchase		初回内部購入ユーザー数（収益コールバックの設定が必要です）
impressions	yes	インプレッション量
sales	yes	購入回数（収益コールバックの設定が必要です）

2.4.2 パブリッシャーレポート（publisher）

パブリッシャーレポートのテンプレート：

{
    "sink_event":
    {
        "event_name": "applovin_publisher"
    },
    "source":
    {
        "group_by":
        [
            "day",
            "hour",
            "country",
            "ad_type",
            "size",
            "device_type",
            "platform",
            "application",
            "package_name",
            "store_id",
            "placement",
            "application_is_hidden",
            "zone",
            "zone_id",
            "bidding_integration"
        ],
        "report_types":
        [
            "publisher"
        ],
        "metrics":
        [
            "impressions",
            "clicks",
            "ctr",
            "revenue",
            "ecpm"
        ]
    }
}

• テンプレートで使用する時間粒度は時間単位で、つまりデータの day + hour フィールドがデータのタイムとして使用されます。
• テンプレートで使用するイベント名は -- applovin_publisher です。
• 残りのフィールドはすべてデータベースに格納されます。
• 対応粒度

これはパブリッシャーレポートで選択可能な粒度です。実際の必要に応じて調整できます。必要なフィールドをsource.group_byに書き込んでください。

フィールド	デフォルト	含义
day	yes	レポートの日付
hour	yes	レポートの時間値（直近30日間のデータのみを取得できます）。このフィールドを使用しない場合、データはdayだけになります。
country	yes	Country Code
ad_type	yes	広告タイプ：GRAPHIC, PLAY, VIDEO, REWARD, or MRAID
size	yes	広告サイズ：INTER, BANNER, MREC, LEADER, or NATIVE
device_type	yes	デバイスタイプ：phone, tablet or other
platform	yes	デバイスプラットフォーム：android, ios, fireos, tvos
application	yes	App 名称
package_name	yes	Android は package name、iOS は Bundle ID
store_id	yes	Android は package name、iOS は Bundle ID
placement	yes	Placement 名称
application_is_hidden	yes	AppがAppLovinのダッシュボードで非表示にされるか
zone	yes	Zone 名称（アカウントが Zones を有効にしている場合のみ）
zone_id	yes	Zone ID（アカウントがZonesを有効にしている場合のみ）
bidding_integration	yes	統合入札方式（MAX や Admob Open Bidding のような値）

- 対応指標

パブリッシャーレポートで選択可能な指標は以下の通りです。実際の必要に応じて調整してください。必要なフィールド名をsource.metricsに記入してください。

フィールド	デフォルト	含义
impressions	yes	インプレッション量
clicks	yes	クリック量
ctr	yes	クリック率
revenue	yes	収益
ecpm	yes	ECPM

2.5 標準化フィールド

AppLovin Basic Reporting APIの標準化フィールドが以下に示されています：

• 広告主レポート

元フィールド	標準化フィールド	意味
traffic_source	te_ads_object.media_source	メディアソース
campaign	te_ads_object.campaign_name	キャンペーン名
campaign_id_external	te_ads_object.campaign_id	キャンペーン ID
creative_set	te_ads_object.ad_group_name	広告グループ名
creative_set_id	te_ads_object.ad_group_id	広告グループ ID
ad	te_ads_object.ad_name	広告名
ad_id	te_ads_object.ad_id	広告 ID
campaign_package_name	te_ads_object.app_name	app名
campaign_store_id	te_ads_object.app_id	app ID
country	te_ads_object.country	国家地域コード
platform	te_ads_object.platform	プラットフォーム　Android、iOS
【USD】固定値	te_ads_object.currency	通貨
impressions	te_ads_object.impressions	インプレッション量
clicks	te_ads_object.clicks	クリック量
conversions	te_ads_object.installs	コンバージョン量（インストール）
cost	te_ads_object.cost	コスト

- パブリッシャーレポート

元フィールド	標準化フィールド	意味
country	te_ads_object.country	国家地域コード
platform	te_ads_object.platform	プラットフォーム Android、iOS
application	te_ads_object.app_name	app名
package_name	te_ads_object.app_id	app ID
placement	te_ads_object.placement	広告位置
【USD】固定値	te_ads_object.currency	通貨
impressions	te_ads_object.impressions	インプレッション量
clicks	te_ads_object.clicks	クリック量
revenue	te_ads_object.revenue	収益