Ad Quality Raw Data API

Ad Quality Raw Data API を利用して、Android アプリから収益、クリック率、広告ソース、クリエイティブ ID、UX パターンなどのインプレッション単位の広告品質指標を抽出し、BI プラットフォームで分析しましょう。

読み終わるまでの所要時間 2 分

最終更新 1日前

Ad Quality Raw Data API を利用すると、Ad Quality からインプレッション単位のデータを取得し、社内の BI プラットフォームで活用できます。

注

Raw Data API の利用を希望する場合は、担当のアカウントマネージャーにお問い合わせください。

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 リクエストを送信すると、リクエストしたファイルへのリンクが返されます。

注

このファイルをダウンロードできるのは 1 時間のみです。

認証タイプ

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 を選択し、レポートをダウンロードします。

フィールド	説明	例
`event_timestamp`	Bigint	`1657500000000`
`user_id`	String	`1834b456-b9ea-4811-a121-9afc165c1eb0`
`ad_unit`	String	`Interstitial`
`ad_source`	広告を配信するネットワークの名前	`Google AdMob`
`dsp`	DSP 名 (ある場合)	`TheTradeDesk`
`instance_name`	ネットワークインスタンス名	`DefaultRewarded`
`country`	2 文字の国コード (ISO 3166-1 Alpha-2 に準拠)	`US`
`us_state`	インプレッションが発生した州コード	`OR`
`device_model`	String	`SM-A127M`
`os_version`	String	`18.3.1`
`sdk_version`	String	`5.17.0`
`app_version`	String	`2.8.9`
`advertiser`	広告主名	`Project Makeover`
`advertiser_id`	String	`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、その他)	`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`

ドキュメント

Development

User Acquisition

Monetization

産業