Ad Quality Raw Data API
Ad Quality Raw Data API を利用して、Android アプリから収益、クリック率、広告ソース、クリエイティブ ID、UX パターンなどのインプレッション単位の広告品質指標を抽出し、BI プラットフォームで分析しましょう。
読み終わるまでの所要時間 2 分最終更新 5日前
Ad Quality Raw Data API を利用すると、Ad Quality からインプレッション単位のデータを取得し、社内の BI プラットフォームで活用できます。
API の使用方法
- Ad Quality の生データは、以下のように取得します。
- API リクエストを送信し、レポートをダウンロードするための URL リンクを取得する
- 提供されたリンクをクリックしてレポートをダウンロードする
- 各 API 呼び出しは、アプリごと、日付ごとに行う必要があります
- 各日付のデータは保存して 14 日間利用できます
- 例: 1 月 1 日のデータは 1 月 14 日まで利用可能。
- 指定日のデータは、その翌日の午後 5 時 (日本時間) 以降にのみ利用できます。この時間以降に API 呼び出しを行ってください。
- 例: 1 月 1 日のデータは 1 月 2 日の午後 5 時 (日本時間) 以降にのみ利用可能。
- データは、利用可能になった後、2 日間にわたって更新され続けます。その後は変更されません。
- 例: 1 月 1 日のデータは 1 月 2 日と 1 月 3 日に更新される。1 月 3 日以降はデータは変更されない。
- レポートには日付とアプリキーは含まれません (レポート (ファイル) ごとに異なるため)
レポート URL 取得のための API リクエスト
正しい API リクエストを送信すると、リクエストしたファイルへのリンクが返されます。認証タイプ
Bearer API 認証メソッド
GET https://ad-quality.soomla.com/api/rawdata/v1?必須パラメーター
名前 | 型 | 説明 |
|---|---|---|
| date | 文字列 | YYYY-MM-DD (UTC タイムゾーン) |
| appKey | 文字列 | アプリケーションキー (プラットフォーム上で表示されるもの) |
リクエストの URL 例
request GET 'https://ad-quality.soomla.com/api/rawdata/v1?appKey=c0492d05&date=2022-07-12'``` ### Response Example URL##response-example-url```js{ "urls": [ "https://ad-quality-raw-data-api.s3.amazonaws.com/production/daily_dumps/2022-07-06/4/appkey%3Dc0492d05/20220707_070020_00066_jht7e_bucket-00000.gz?AWSAccessKeyId=ASIAZF2UTGTCQF2VSIVE&Expires=1657212469&Signature=u%2F2qOWmVw3iC2v21nqRYnOE443s%3D&x-amz-security-token=FwoGZXIvYXdzELv%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDJtzCMfRJtv%2B7dCGjyLkAQX4BODoGx%2F92huTOXt86j31N1mrr2UvKuD9Qi5w1Kzu0B%2FfBrXlk4in64Z53Iy%2BOR1A5cGxvu25LObGXreMeCfdLz1S5p4WOM1ldmKgkWxYMvU01obpj3dvUXob4G1Gz13Uf5Go9B7THZlVV6g8Mhduk7zpIqYRmwYDCq4U2WBeN%2BKiJOT6Rf2SRDvpDXQJDW1bl%2FV4UfYFJUz8s%2B1HIVxmeVmrIzJVevD35Wjh4dGHuD0OTRSEL7NsTjzqtTZs7mUIWjqV2aJh8l8Rz%2BwG3d%2FGtgblKJ%2Fi3wE5X0xJjkQNJgm6WCiW1pqWBjIyuheodw%2FxNLedYFcSY7wuJa6iKhxdZQwumUZgp1TS0j2kfu8eSPe6D0jvsGhlpk4zYms%3D" ], "expiration": "2022-07-07 18:47:49"}
フィールドの定義
この表には、Ad Quality の生データを取得した後、レポートに表示される各フィールドが示されています。各フィールドについて、その説明と、実際に表示される内容の例を確認できます。 前のステップで取得した URL を選択し、レポートをダウンロードします。フィールド | 説明 | 例 |
|---|---|---|
| Bigint | |
| String | |
| String | |
| 広告を配信するネットワークの名前 | |
| DSP 名 (ある場合) | |
| ネットワークインスタンス名 | |
| 2 文字の国コード (ISO 3166-1 Alpha-2 に準拠) | |
| インプレッションが発生した州コード | |
| String | |
| String | |
| String | |
| String | |
| 広告主名 | |
| String | |
| ゲーム内で表示される広告主の種類を表すフィールドで、iOS ストア ID、Android パッケージ名、ブランドなどが含まれます | |
| 整数値 (クリックが発生した場合は 1、発生しなかった場合は 0) | |
| 文字列、この内容に関連する UX パターンが見られたかどうか Ad Quality の用語集 (qClick、proximity_click、auto_click、early_click、hasty_click、その他) | |
| Bigint、クライアントのタイムスタンプ (UTC) | |
| クリエイティブの種類が動画の場合に関連する値で、1 は動画が最後まで再生されたことを示し、0 は最後まで再生されなかったことを示します。 | |
| Bigint | |
| ユーザーによって発生した収益 (ドル)。 | |
| アプリストアや Google Play から取得した広告主のアプリのカテゴリ | |
| 米国の Apple/Google のアプリストアでの年齢区分 | |
| creative_type | 主なクリエイティブの種類: プレイアブル/動画/画像 | |
| 文字列、広告品質クリエイティブ ID | |
| String | |
| 文字列の配列 | |
| end_card_urls | 文字列の配列 | |
| String | |
| 文字列の配列 | |
| ユーザーごとの広告表示の順番 (インプレッション番号)。バナー広告やネイティブ広告の場合、この値は | |
| 整数値、 | |
| Bigint | |
| 文字列、インプレッションが発生した広告主の開発者 | |
| String | |