広告収益化ネットワークの集計レポートAPI

概要:広告収益化ネットワークから集計された広告収益データ(計測メディアソースを含まない)を取得しましょう。このレポートを使用して、収益化ネットワークを最適化できます。

広告収益化ネットワークの連携とレポートAPI

広告収益は、多くの場合、アプリパブリッシャーにとって大きな収益源です。このAPIは、異なる広告収益化ネットワークが収益を生み出しているかについての洞察を提供します。

広告収益化ネットワークのデータを取得する方法:

  1. アドネットワークと連携し広告収益タブにて、Aggregated monetization revenue(集計された広告収益)を選択してください。パートナー連携の詳細な手順を参照してください。
  2. APIを使用して広告収益化ネットワークの集計レポートを取得してください。
  3. キャンペーンのメディアソース最適化については、広告収益キャンペーンの最適化を使用してください。

BIディベロッパー向けの考慮事項

  • 日付:日付や日付範囲は、収益化パートナーから収益がレポートされた日を指します。
  • ブーリアン型:true (真) または false (偽) です(大文字小文字を区別)。

次のセクションでは、APIリクエストを用意するために必要な情報を説明しています。

広告収益APIの詳細

概要 APIコールは、パス、ヘッダー、データクエリを含むJSONで構成されます。データはデフォルトでCSV形式(ファイルではない)で返されます。 
パス

https://hq1.appsflyer.com/api/ad-revenue-agg/v1/data/app/app_id

パスのパラメータ(必須)
  • app_id: AppsFlyerの管理画面上で使用されているアプリID。管理画面に表示される通りに入力してください。
  • アカウント内のアプリの一覧を取得してください。

クエリパラメータ―

[オプション]

結果は次のように返ってきます。

  • [デフォルト] 表形式のCSV構造。最初の行には列名が含まれています。
  • JSON構造
  • 例:format=json
  • https://hq1.appsflyer.com/api/ad-revenue-agg/v1/data/app/app_id?format=JSON
HTTP method POST
ヘッダー
リクエストヘッダー

Key

value 必須
Content-Type application/json はい 
Authorization Bearer はい 
Accept application/json はい 
Authorization
日付の制限
  • サポートされている最も古い日付:AppsFlyerで機能を有効にした日付
  • 最大クエリ範囲:60日間
レート制限
  • APIコールのレート制限は、アカウントごとに1分あたり60コール、1日あたり50,000コールです
  • クエリは最大 10,000 行のデータを取得します。
ブーリアン値 常に小文字:truefalse
データ更新頻度
  • 日中
  • パートナーからデータをリクエストするたびに、当日および過去2日間のデータをリクエストされます。つまり、データは過去に遡って更新されます。データの取り込み処理の際にこの点を考慮してください。
広告収益化APIに関する詳細

主要パラメーター

基本パラメーター

項目

説明 必須 

from 

日付範囲の開始日

  • 形式:文字列 yyyy-mm-dd
  • 例:"from": "2020-11-02"
はい

to

日付範囲の終了日

  • 1日のみの場合:fromto の値は同一になります。
  • 形式: yyyy-mm-dd
  • 例:"from": "2020-10-01", "to": 2020-10-31 は31日間です。
  • 設定できる最大範囲は60日間です
はい
preferred_currency
  • デフォルトの通貨設定:USD
  • true の場合、レスポンスにはアプリ固有の通貨で値が返されます。アプリ固有の通貨への変換は、リクエスト時の為替レートを使用して米ドル(USD)から実行されます。
  • [デフォルト] false の場合、レスポンスは米ドル(USD)で返されます。
いいえ
filters

フィルタをディメンションの一覧から選択してください。

形式:JSON内の文字列。

例: "filters": { "geo": [ "za", "de" ], "ad_type": [ "banner", "video", "interstitial" ]

いいえ
groupings

ディメンションの一覧から1つ以上のグループ化を選択してください。

形式:配列内の文字列

例:"groupings": [ "geo", "ad_type" ]

はい
指標

指標の一覧から1つ以上の指標を選択してください。

形式:配列内の文字列

例:"metrics": [ "impressions", "clicks", "ctr", "revenue" ]

はい

ディメンションの一覧(フィルタとグループ化)

  • フィルタのパラメーターを使用して必要なデータを取得します。
  • グループ化を使用して、列を追加したり、レポートの粒度を低くします。
  • geoplatform のディメンションは常に利用できます。その他のディメンションは、広告収益化ネットワークが提供するデータによって異なります。
  • 特定のグループ化に使用できるデータがない場合、レスポンスはN/Aになります。
  • リクエストにフィルタが含まれていない場合、レスポンスには、選択したディメンション間で分割された総収益が含まれます。
  • 収益化ネットワークは、異なるデータスキームを採用しています。したがって、地域やプラットフォームに加えて、収益化ネットワークごとにすべてのディメンションを使用できるわけではありません。
利用できるフィルタとグループ化のディメンション

ディメンション

形式

フィルタ

グループ

説明

geo

文字列

はい

はい

ISO 3166 2文字の国コード。地域(国)別に絞り込むために使用します。複数の値を選択できます。

例:"geo" : "US", "ZA"

ad_type

文字列

はい

はい

サポートされている値は、収益化ネットワークによって異なります。

例:"ad_type" : "banner", "interstitial"

device_type

文字列

はい

はい

許可されている値:phone、tablet、other

例:"device_type" : "tablet"

source_network

文字列

はい

はい

収益化ネットワーク。AppsFlyerで連携し有効になっているネットワークからデータが収集されます。

source_network 名は、AppsFlyrと連携しているパートナー名か連携パートナーから報告された収益化ネットワーク名です。

segment

文字列

はい

はい

例:"segment" : "my_segment"

date

文字列

いいえ

はい

広告収益データ

例:データでグループ化する場合、"groupings": ["date"]

placement

文字列

はい

はい

  • 例:"groupings": ["placement"]

  • 配置別にグループ化した場合:placementに加えて、placement_id が自動的に返されます。

ad_unit

文字列

はい

はい

  • 例:"groupings": ["ad_unit"].

  • ad_unit別にグループ化された場合ad_unitに加えて、ad_unit_id が自動的に返されます。

platform

文字列

はい

はい

広告を提供するプラットフォーム

app_id

文字列

はい

はい

 

指標

  • 利用できる指標は表にリストされています。
  • 配列に1つ以上の指標を指定してください。
  • 指標の可用性は、収益化ネットワークに依存します。

指標

形式

説明

requests

Integer

広告リクエスト数

impressions

Integer

インプレッション数

clicks

Integer

クリック数

revenue

Decimal

生成された収益の金額。

preferred_currency=false の場合:値はUSDです。

preferred_currency=true の場合:値はアプリ固有の通貨です。get App list API を使用して、通貨を確認するか、管理画面を確認してください。

通貨換算レート:通貨換算は、必要に応じて、広告収益日の実勢為替レートを使用して実行されます。

ecpm

Decimal

ecpM(1,000インプレッションあたりの生成利益)。

計算式:収益額 / インプレッション数 * 1000

completions

Integer

収益化パートナーによって報告された広告ビューの完了数

fill_rate

Decimal

計算式:インプレッション数/リクエスト数

注:リクエストデータを返さない収益化パートナーに対する項目は、n/a が返されるべきです

ctr

Decimal

計算式:クリック数/インプレッション数

arpdau

Decimal

計算式:(期間中の日次平均収益額l / 日数)/(期間中の日次ユニークアクティブユーザー数 / 日数)

広告収益指標

Curl サンプルリクエスト

この例には、完全なAPIコールが含まれています。


curl --location --request POST 'https://hq1.appsflyer.com/api/ad-revenue-agg/v1/data/app/{app-id}' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <V2 token of more than 700 characters' \
--data-raw '{
    "from": "2020-10-01",
    "to": "2020-10-30",
"preferred_currency": true, "filters": { "geo": [ "za", "de" ], "ad_type": [ "banner", "video", "interstitial" ] }, "groupings": [ "geo", "ad_type" ], "metrics": [ "impressions", "clicks", "ctr", "revenue" ] }'

JSON レスポンスの例


       {
    "results": [
        {
            "ad_type": "banner",
            "app_id": "com.adrevenue.agg_api_1b",
            "clicks": 0,
            "ctr": 0,
            "currency": "JPY",
            "geo": "de",
            "impressions": 960,
            "platform": "android",
            "revenue": 10097232.84006
        },
        {
            "ad_type": "interstitial",
            "app_id": "com.adrevenue.agg_api_1b",
            "clicks": 0,
            "ctr": 0,
            "currency": "JPY",
            "geo": "de",
            "impressions": 800,
            "platform": "android",
            "revenue": 8414360.70005
        },
        {
            "ad_type": "banner",
            "app_id": "com.adrevenue.agg_api_1b",
            "clicks": 0,
            "ctr": 0,
            "currency": "JPY",
            "geo": "za",
            "impressions": 80,
            "platform": "android",
            "revenue": 0
        }
    ]
}

CSVレスポンスの例


geo,ad_type,app_id,platform,currency,impressions,clicks,ctr,revenue
de,banner,com.adrevenue.agg_api_1b,android,JPY,960,0,0,1.009723284006e+07
de,interstitial,com.adrevenue.agg_api_1b,android,JPY,800,0,0,8.41436070005e+06
za,banner,com.adrevenue.agg_api_1b,android,JPY,80,0,0,0

追加情報

レスポンスコードとトラブルシューティング

レスポンスステイタスコード

レスポンスコード

メッセージ

備考

200 OK

有効なデータが返されました

400 Bad request  
401 Unauthorized
  • 認証トークンが見つかりませんでした。
  • 正しいトークンを使用していることを確認してください。700文字以上である必要があります。
404 Not found
  • ネットワーク、ファイアウォールなどに関連する問題を排除してください。
  • トークンは有効ですが、要求されたアプリIDと一致しません。
  • app_id が存在しません。
 422 Unprocessable entity (処理不能)
  • JSON で返されるエラーメッセージを参照してください。例えば、リクエストには少なくとも1つのグループ化を含める必要があります。
  • リクエストがJSONに含まれ、クエリパラメータ―として送信されていないことを確認します。
  • JSONがこの記事に従ってフォーマットされていることを確認してください。

特性と制限

特性
特性 備考
アドネットワークのアクセス いいえ
代理店アクセス いいえ
代理店への運用詳細の開示 適用されません。代理店は関与していません。
アプリ固有のタイムゾーン データは、広告収益化パートナーが提供する日付を使用して記録されます。
アプリ固有の通貨 サポートされています。
レート制限
  • APIコールレート制限は、アカウントあたり、1分間あたり60コール、1日あたり50,000コールまでです。
    クエリは最大 10,000 行のデータを返します。
オーガニックデータ 含まれています
非オーガニックデータ 含まれています
データ更新頻度 日中。当日および過去 2 日間のデータが取得されます。これは、履歴データが遡って変更される可能性があることを意味します。
過去データ プラットフォームで広告収益機能が有効になった日から利用できます。
チームメンバーアクセス 認証トークンは、アカウント管理者が管理画面から取得できます。
この記事は役に立ちましたか?