# Ad Quality Raw Data API

> 通过 Ad Quality Raw Data API 从 Android 应用程序中提取展示量级别的广告质量指标（如收入、点击率、广告来源、广告素材 ID 和 UX 模式），用于 BI 平台分析。

Ad Quality Raw Data API 允许您从 Ad Quality 中提取展示级别数据以便在内部 BI 平台上使用。

> **Note:**
>
> 如需访问 Raw Data API，请联系客户经理。

## 如何使用 API##how-to-use-the-api

* 获取广告质量原始数据是通过完成以下步骤执行的：

1. 发出 API 请求，返回 URL 链接以下载报告
2. 单击提供的链接下载报告

* 必须为每个单独的应用程序进行每个 API 调用，并在单个日期内执行
* 每个日期的数据已存储并可供 14 天使用。
  * 示例：1 月 1 日的数据将在 1 月 14 日之前可用\_
* 任何给定日期的数据仅在第二天 UTC 上午 08:00 后可用。确保仅在此时间之后调用 API
  * 示例：1 月 1 日的数据仅在 UTC\_ 时间 1 月 2 日上午 08:00 之后可用
* 数据将在可用后继续更新 2 天。此后，它们不会改变。
  * 示例：1 月 1 日的数据将在 1 月 2 日和 1 月 3 日更新。1 月 3 日之后，数据不会改变\_
* 日期和应用密钥不包含在报告中，因为它们在每个报告（文件）中是唯一的

## 报告 URL 的 API 请求##api-request-for-report-url

有效的 API 命中会返回指向请求文件的链接。

> **Note:**
>
> 该文件只能下载一小时。

### 身份验证类型##authentication-type

[轴承 API 身份验证](/grow/levelplay/platform/api/authentication.md)

### 方法##method

GET

### 必需参数##required-parameters

| Name（名称） | 类型  | 描述                  |
| -------- | --- | ------------------- |
| 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": [
       
   ],
   “expiration”："2022-07-07 18:47:49"
}
````

## 字段定义##fields-definition

下表显示了在提取 Ad Quality 原始数据后将显示在报告中的字段。对于每个示例，您可以看到其包含的内容的描述和示例。 

选择使用上述步骤提取的 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 Alpha-2，2 个字母的国家/地区代码。](http://www.iso.org/iso/country_names_and_code_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 Store ID、Android 包名称、品牌等                                                     | `package_name`                                                                                                                                                                                                |
| `click`                       | 一个整数，其中 1 表示发生了单击，0 表示没有单击                                                                           | `1`                                                                                                                                                                                                           |
| `click_type`                  | String，我们是否看到了与此相关的 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`                 | 字符串，Ad Quality 广告素材 ID                                                                               | `6c3d78bfe7c74d805c01b13b44e6e1ecff16544c`                                                                                                                                                                    |
| `appstore_url`（当前字段名称为 `url`） | 字符串                                                                                                  | `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`                   | 字符串                                                                                                  | `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`                   | String，广告主的开发者，有广告展示                                                                                 | `Supersonic`                                                                                                                                                                                                  |
| `ad_source_sdk_version`       | 字符串                                                                                                  | `5.17.0`                                                                                                                                                                                                      |
