# 広告品質 Raw データ API

> BI プラットプラットフォーム分析用の Ad 品質 Raw データ API を使用して、Android アプリケーションからインプレッションレベルの広告品質指標　 (収益、クリック率、広告ソース、クリエイティブ ID、UX パターンなど) を抽出します。

広告品質 Raw データ API を使用すると、広告品質からインプレッションレベルのデータを取得して、内部 BI プラットフォームで使用できます。

> **Note:**
>
> Raw データ API へのアクセスについては、アカウント マネージャに接触してください。

## API の使用方法##how-to-use-the-api

* Ad 品質 Rawデータのプルは、以下の手順を実行して実行されます。

1. レポートをダウンロードするための URL リンクを返す API リクエストを作成する
2. 指定されたリンクをクリックしてレポートをダウンロードします。

* 各API呼び出しは個々のアプリケーションと 1つの日付に対して行う必要がある
* 各日付のデータは保存され、14日間使用できます。
  * 例: 1月1日のデータは1月14日まで利用できます\_
* 指定した日付のデータは、以下の日の08：00 AM UTCからのみ使用可能です。この時間以降、API のみを呼び出しようにしてください。
  * 例: 1 月 1 日のデータは 1 月 2 日の 08：00 AM UTC 以降でのみ使用可能です。
* データは利用可能になってから 2 日間更新が続けられます。その後、それらは変更されません。
  * 例: 1 月 1 日のデータは 1 月 2 日と 1 月 3 日に更新されます。1 月 3 日以降、データは変更されません\_
* Date & アプリケーション キー (日付とアプリキー) はレポート (ファイル) ごとに一意のであるため、レポートに含まれません。

## レポート URL の API リクエスト##api-request-for-report-url

有効な API ヒットは、要求されたファイルへのリンクを返します。

> **Note:**
>
> ファイルは 1 時間だけダウンロードできます。

### 認証タイプ##authentication-type

[Bearer API 認証](/grow/levelplay/platform/api/authentication.md)

### メソッド##method

GET

### 必須パラメーター:##required-parameters

| 名前     | 型   | 説明                      |
| ------ | --- | ----------------------- |
| date   | 文字列 | YYYY-MM-DD (UTC タイムゾーン) |
| appKey | 文字列 | キーットフォーム上に表示されます)       |

### リクエスト例 URL##request-example-url

````js
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":1
}
````

## フィールド定義##fields-definition

このテーブルには、Ad 品質 Rawデータをプルした後にレポートに表示されるフィールドが表示されます。それぞれについて、説明と含まれるものの例を見ることができます。 

上記の手順を使用してプルした URL を選択してレポートをダウンロードします。

| フィールド                             | 説明                                                                                                           | 例                                                                                                                                                                                                             |
| --------------------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `event_timestamp`                 | Bigint                                                                                                       | `1657500000000`                                                                                                                                                                                               |
| `user_id`                         | `1834b456-b9ea-4811-a121-9afc165c1eb0`                                                                       |                                                                                                                                                                                                               |
| `ad_unit`                         | `Interstitial`                                                                                               |                                                                                                                                                                                                               |
| `ad_source`                       | 広告を配信するネットワーク名                                                                                               | `Google AdMob`                                                                                                                                                                                                |
| `dsp`                             | 存在する場合の dsp 名                                                                                                | `TheTradeDesk`                                                                                                                                                                                                |
| `instance_name`                   | ネットワーク インスタンス名                                                                                               | `DefaultRewarded`                                                                                                                                                                                             |
| `country`                         | [ISO 3166-1 アルファ 2 に基づく 2 文字の国コード](http://www.iso.org/iso/country_names_and_コード_elements)                    | `US`                                                                                                                                                                                                          |
| `us_state`                        | 発生したインプレッションの状態コード                                                                                           | `OR`                                                                                                                                                                                                          |
| `device_model`                    | `SM-A127M`                                                                                                   |                                                                                                                                                                                                               |
| `os_version`                      | `18.3.1`                                                                                                     |                                                                                                                                                                                                               |
| `sdk_version`                     | `5.17.0`                                                                                                     |                                                                                                                                                                                                               |
| `app_version`                     | `2.8.9`                                                                                                      |                                                                                                                                                                                                               |
| `advertiser`                      | `Project Makeover`                                                                                           |                                                                                                                                                                                                               |
| `advertiser_id`                   | `com.bgg.jump`                                                                                               |                                                                                                                                                                                                               |
| `advertiser_type`                 | ゲーム内に表示される広告主のタイプを表すフィールド。iOS ストア ID、Android パッケージ名、ブランドなどが含まれます。                                            | `package_name`                                                                                                                                                                                                |
| `click`                           | 1 はクリックが発生したことを示し、0 はクリックがなかったことを示す整数                                                                        | `1`                                                                                                                                                                                                           |
| `click_type`                      | 文字列。この文字列に関連する UX パターンを確認しましたか。&#xA;Ad Quality の用語集&#xA;(qClick、近接\_click、自動\_click、早期\_click、急遽\_click、その他) | `auto_click,proximity_click`                                                                                                                                                                                  |
| `click_ts`                        | Bigint、クライアントのタイムスタンプ (UTC)                                                                                  | `1657450000000`                                                                                                                                                                                               |
| `video_completed`                 | 動画クリエイティブの種類に関連しており、1 は動画が完了したことを示し、0 は動画が完了しなかったことを示す整数です。                                                  | `1`                                                                                                                                                                                                           |
| `video_completed_ts`              | Bigint                                                                                                       | `1657450000000`                                                                                                                                                                                               |
| `revenue`                         | ユーザーによって発生した収益 (ドル)。                                                                                         | `0.5`                                                                                                                                                                                                         |
| `category`                        | アプリストアや Google Play から取得した広告主のアプリのカテゴリ                                                                       | `Casual`                                                                                                                                                                                                      |
| `content_rating`                  | 米国の Apple/Google のアプリストアでの年齢区分                                                                               | `{"US":"Everyone"}`                                                                                                                                                                                           |
| creative\_type                    | 主なクリエイティブの種類: プレイアブル/動画/画像                                                                                   | `playable`                                                                                                                                                                                                    |
| `creative_id`                     | 文字列、広告品質クリエイティブ ID                                                                                           | `6c3d78bfe7c74d805c01b13b44e6e1ecff16544c`                                                                                                                                                                    |
| `appstore_url` (現在のフィールド名は `url`) | String                                                                                                       | `https://www.ubereats.com/?utm_campaign=CM2176745-display-doubleclick_42_-99_CR-National_e_all_bra_cpm_es_Eater%7CCR%7CEatsDemandIIYTBumper-L2R0ED22-PO481364&utm_medium=display-programmatic&utm_source=dbm` |
| `video_urls`                      | 文字列の配列                                                                                                       | `https://www.youtube.com/watch?v=rdahaLbmxOw`                                                                                                                                                                 |
| end\_card\_urls                   | 文字列の配列                                                                                                       | `https://v.ssacdn.com/demand-creatives/assets/videos/m29ateosecjmkxt2xamf.mp4`                                                                                                                                |
| `icon_urls`                       | String                                                                                                       | `https://lh3.googleusercontent.com/y3iFaRQsuLPIiWnCX_Yg7j2IGWiKtnFFbsQPBwRWxIFszsV_xnZYE5VT7d1udxRqQSCPxn_cyw=w256-h256`                                                                                      |
| `image_urls`                      | 文字列の配列                                                                                                       | `https://i.ytimg.com/vi/Pv8H5ceSeF0/hqdefault.jpg`                                                                                                                                                            |
| `imp_num`                         | ユーザーのシーケンスのインプレッション番号。バナー広告やネイティブ広告の場合、この値は `-1` となります                                                       | `3`                                                                                                                                                                                                           |
| `ad_closed`                       | 整数値、`1` は広告が閉じられたイベントを受信したことを示し、`0` は広告が閉じられていないことを示します                                                      | `0`                                                                                                                                                                                                           |
| `ad_closed_ts`                    | Bigint                                                                                                       | `1657450000000`                                                                                                                                                                                               |
| `developer`                       | 文字列。インプレッションを取得した広告主の開発者。                                                                                    | `Supersonic`                                                                                                                                                                                                  |
| `ad_source_sdk_version`           | String                                                                                                       | `5.17.0`                                                                                                                                                                                                      |
