文档

支持

Ad Quality

Analysis

广告素材

规则和通知

Ad Quality

Ad Quality Raw Data API

通过 Ad Quality Raw Data API，从 Android 应用程序中提取展示级广告质量指标，包括收入、点击率、广告源、广告素材 ID 和 UX 模式等，用于 BI 平台分析。
阅读时间4 分钟最后更新于 2 天前
Ad Quality Raw Data API 支持从 Ad Quality 提取展示级数据，供您在内部 BI 平台使用。
注意
如需访问 Raw Data API，请联系您的客户经理。

如何使用该 API

  • 拉取 Ad Quality 原始数据需完成以下步骤：
  1. 发起 API 请求，获取用于下载报告的 URL 链接
  2. 点击提供的链接下载报告
  • 每次 API 调用必须对应单个应用程序和单个日期
  • 每日数据会存储并可供访问 14 天
    • 示例：1 月 1 日的数据将在 1 月 14 日及之前可供访问
  • 任意日期的数据仅在次日 UTC 时间上午 08:00 后可供访问。请确保仅在该时间之后调用该 API
    • 示例：1 月 1 日的数据仅在 1 月 2 日 UTC 时间上午 08:00 后可供访问
  • 数据将在可用后会持续更新 2 天。之后数据将不再变化。
    • 示例：1 月 1 日的数据将在 1 月 2 日和 1 月 3 日更新。1 月 3 日之后，数据将不再变化
  • 日期与应用密钥不会包含在报告中，因为它们对于每个报告（文件）都是唯一的

用于获取报告 URL 的 API 请求

有效的 API 请求会返回所请求文件的链接。
注意
该文件的下载有效期仅为一小时。

身份验证类型

Bearer API 身份验证

方法

GET https://ad-quality.soomla.com/api/rawdata/v1?

必需参数

Name（名称）

类型

描述

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 下载报告。

字段

描述

示例

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 标准。
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 模式 Ad Quality 术语表 （qClick、proximity_click、auto_click、early_click、hasty_click 和 other）
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
字符串，发生广告展示的广告主所属开发者
Supersonic
ad_source_sdk_version
字符串
5.17.0