Ad Generation(SSP)-DSP RTB仕様書
基本仕様
プロトコル
- Ad Generation から DSP へ、OpenRTB 2.x の Bid Request を JSON で HTTP POST します。OpenRTB 2.5 を基本に、2.6 のフィールド(
user.eidsなど)にも対応しています。 - ネイティブ広告のリクエストは、OpenRTB Native Ads 1.2 または 1.0.0.2 で送ります。
リクエストの経路
在庫は、Ad Generation のタグ・SDK 経由のほか、Header Bidding の Prebid、Google Open Bidding(旧EBDA)、Amazon TAM の経路からも届きます。
Header Bidding の経路は source.ext.stype または source.ext.schain で分かります。
接続手順
接続にあたり、DSP と Ad Generation で以下の項目を調整します。 DSP の準備ができたら、Ad Generation の検証環境で Bid Request / Bid Response を確認し、広告の表示などに問題がなければ本番環境に移行します。 本番では 1% のトラフィックから始め、双方で計測した impression 数と金額に乖離がないことを確認しながらトラフィックを増やします。
DSP エンドポイント
DSP は Bid Request を受ける URL を用意してください。Ad Generation のサーバーは東京にあるため、レイテンシを抑えるために DSP のデータセンターも日本にあることが望ましいです。
タイムアウトは Bid Request の tmax(ミリ秒)で示します。多くの在庫で 150ms 前後ですが、Google Open Bidding 経由の在庫では長くなります。
広告フォーマット
Web とアプリのそれぞれで、バナー、ネイティブ、動画に対応しています。DSP が入札できるフォーマットの Bid Request だけを送ります。
取引単位・通貨
入札額と落札額の単位は CPM です。通貨は JPY と USD に対応しています。どちらを使うかは事前に取り決めます。指定がなければ JPY です。
オークション
1st price auction で行います(at が 1)。
1st price auction に対応していない DSP には at を 2 にして送り、入札額は過去の市場価格を元にした価格まで下げて(bid shading)扱います。
落札金額の通知
DSP は、adm に含めたマクロで落札金額を受け取れます。${AUCTION_PRICE} は、落札金額を暗号化した文字列に置換されます。
以前から接続している DSP では、${SSP_WINNING_PRICE} を使っている場合があります。
nurl による通知には対応していません。
落札金額の暗号化方式は、事前に取り決めます。よく使われる方式は次の通りです。
- 暗号化しない
- Google の暗号化方式
- AES/CBC/PKCS5Padding + UTF-8 + URL Safe Base64
- Blowfish + UTF-8 + URL Safe Base64
- TripleDES + UTF-8 + URL Safe Base64
- DESede/CFB8/NoPadding + UTF-8 + URL Safe Base64
マクロ一覧
Bid Response の adm の中で、次のマクロが使えます。
| マクロ | 置換される内容 |
|---|---|
${AUCTION_PRICE}(旧 ${SSP_WINNING_PRICE}) | 落札金額を暗号化した文字列。クリエイティブ検査のときは AUDIT |
${AUCTION_CURRENCY} | 取り決めた通貨(JPY または USD) |
${SSP_REDIRECT_ENCURL} | Ad Generation のクリックリダイレクターの URL を URL エンコードした文字列 |
${SSP_REDIRECT_URL} | Ad Generation のクリックリダイレクターの URL |
${SSP_AUDIT} | クリエイティブ検査のときは AUDIT、それ以外は AUDIT 以外の任意の文字列 |
クリック計測
Ad Generation 側でクリックを計測するため、バナー広告ではクリック時の遷移先が Ad Generation のリダイレクターを経由するようにしてください。ネイティブと動画では Ad Generation 側で挿入するので不要です。
${SSP_REDIRECT_ENCURL}: 遷移の順は DSP → Ad Generation → LP- 例:
<a href="https://dsp1.example/click?rd=${SSP_REDIRECT_ENCURL}">
- 例:
${SSP_REDIRECT_URL}: 遷移の順は Ad Generation → DSP → LP- 例:
<a href="${SSP_REDIRECT_URL}https%3A%2F%2Fdsp1.example%2Fclick">
- 例:
クリエイティブ検査
マルウェアなど有害な問題を検出するため、入札されたクリエイティブを定期的に検査します。検査の際は落札金額のマクロを AUDIT に置換して広告を表示するので、その場合は impression として数えず、広告主にも請求しないでください。
Ad Generation が接続している一部の Header Bidding の経路でも、同じ目的でクリエイティブを検査することがあります(初回と 2,000 impression ごと)。この場合は落札金額のマクロでは見分けられないので、${SSP_AUDIT} で見分けられます。
Ad Generation はこの検査を impression として数えず、DSP にも請求しないので、DSP 側で無視できる場合はこのマクロを使う必要はありません。
ads.txt
ads.txt のドメインは ad-generation.jp、媒体のアカウント ID は Bid Request の publisher.id です。
ad-generation.jp, 8258, DIRECT
ID 同期(Cookie Sync)
Web の在庫を買う場合は、Cookie のユーザー ID の対応付けが必要です。アプリの在庫だけを買う場合は不要です。 対応付けは、Ad Generation 側と DSP 側のどちらで持つこともできます。
Ad Generation 側で対応付けを持つ場合
- ブラウザが DSP の ID 同期用 URL にアクセスするようにします。
<img src="https://dsp1.example/sync?ssp=1">
- DSP は、DSP のユーザー ID を付けた Ad Generation の ID 同期用 URL にリダイレクトします。
302 redirect to https://ssp1.example/sync?uid=dspuid123
- ブラウザが Ad Generation の ID 同期用 URL にアクセスし、Ad Generation が対応付けを保存して 1x1 の画像を返します。
Bid Request の user.buyeruid に DSP のユーザー ID が入ります。
DSP 側で対応付けを持つ場合
- ブラウザが Ad Generation の ID 同期用 URL にアクセスするようにします。
<img src="https://ssp1.example/sync?dsp=1">
- Ad Generation は、Ad Generation のユーザー ID を付けた DSP の ID 同期用 URL にリダイレクトします。
302 redirect to https://dsp1.example/sync?uid=sspuid123
- ブラウザが DSP の ID 同期用 URL にアクセスし、DSP が対応付けを保存して 1x1 の画像を返します。
Bid Request の user.id に Ad Generation のユーザー ID が入ります。
カテゴリ
ブロックするカテゴリ(bcat)と枠のカテゴリ(site.cat / app.cat)は、Ad Generation 独自のカテゴリコードを、IAB のカテゴリコード、DSP 独自のカテゴリコード、Ad Generation のカテゴリコードのまま、など DSP が指定する任意の対応表で変換して送ります。対応表はいつでも変更できます。
広告主ドメインによる入札のブロック
媒体の設定に従って、広告主のドメインで入札を除外します。
- DSP は Bid Response の
adomainに広告主のドメインを入れます。 - Ad Generation は、広告枠のドメイン除外設定と
adomainを突き合わせて、入札を除外します。
- ドメインはランディングページではなく、広告主のコーポレートサイトのドメインです。
- 入札が広告主ドメインで除外されたかどうかを、DSP 側から直接知ることはできません。
標準以外のフィールドには印を付けています。ADG拡張 は Ad Generation 独自の拡張、IAB拡張 は IAB Tech Lab の community extension などで定義された拡張、外部拡張 はそれ以外の事業者が定義した拡張です。
Bid Request
Ad Generation が DSP に送る OpenRTB 2.x の Bid Request です。
BidRequest
位置: (root) / OpenRTB 2.6 の BidRequest オブジェクト
Ad Generation が DSP に送る OpenRTB 2.x の Bid Request。site と app のどちらか一方が入る。
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | ✓ | Bid Request ごとにユニークな ID。 例: "7749a0cb204eea02d50e7c98d790ae25c6f74318" |
imp | array of Imp | ✓ | Imp オブジェクトの配列。複数入る場合がある。 |
site | Site | Web の在庫の場合のサイトの情報。 | |
app | App | アプリの在庫の場合のアプリの情報。 | |
device | Device | ✓ | 端末の情報。 |
user | User | ✓ | ユーザーの情報。 |
at | integer | ✓ | オークションタイプ。1st price auction(1)で行う。 1st price auction に対応していない DSP には 2 を送り、入札額を過去の市場価格を元に推定した価格まで下げる(bid shading)。 値: 1: first price2: second price例: 2 |
tmax | integer | タイムアウト(ミリ秒)。在庫によって異なる。多くは 150ms 前後で、Google Open Bidding 経由の在庫では長い。 例: 120 | |
wseat | array of string | 入札可能なSeat Id(ホワイトリスト)。特定のDSPだけに使用される。 | |
cur | array of string | 通貨コード(ISO-4217)。事前に取り決めた JPY か USD が入る。 例: ["JPY"] | |
wlang | array of string | クリエイティブに使ってよい言語のホワイトリスト(ISO-639-1-alpha-2)。 無い場合は制限しないが、device.language があればそれも考慮してほしい。 例: ["ja"] | |
bcat | array of string | ブロックするカテゴリ。DSP が指定する対応表で変換したカテゴリコード。詳しくはカテゴリを参照。 例: ["ADG_11001", "ADG_14002"] | |
source | Source | リクエストの出どころ(Header Bidding の経路やサプライチェーン)。 | |
regs | Regs | 規制に関する情報。 |
Imp
位置: imp[] / OpenRTB 2.6 の Imp オブジェクト
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | ✓ | ImpオブジェクトのユニークID Bid Request内でユニークとなる 例: "4974d82c61b283497cc4e220e8f748854018a086" |
tagid | string | ✓ | 広告枠のid。同一メディア内に複数の広告枠がある。メディアをまたいでユニーク。 例: "12345" |
metric | array of Metric | この枠の計測値(過去の落札額など)。 | |
banner | Banner | バナーの在庫の場合の情報。 | |
video | Video | 動画の在庫の場合の情報。 | |
native | Native | ネイティブの在庫の場合の情報。 | |
displaymanager | string | 広告表示をするSDKの名前 値: adg_ios_sdk: AdGeneration iOS SDKadg_android_sdk: AdGeneration Android SDKadg_web_sdk: AdGeneration Web SDKadg_rewarded_video_ios_sdk: AdGeneration iOS Rewarded Video SDKadg_rewarded_video_android_sdk: AdGeneration Android Rewarded Video SDKprebidjs_web_sdk: AdGeneration Prebid.js SDKtam_web_sdk: Amazon TAM Web SDKtam_ios_sdk: Amazon TAM iOS SDKtam_android_sdk: Amazon TAM Android SDKebda_web_sdk: Google Open Bidding(旧EBDA) Web SDKebda_ios_sdk: Google Open Bidding(旧EBDA) iOS SDKebda_android_sdk: Google Open Bidding(旧EBDA) Android SDK例: "adg_ios_sdk" | |
displaymanagerver | string | SDK version | |
instl | integer | ✓ | インターステシャル枠かどうかを示すフラグ 値: 0: not interstitial1: interstitial or full screen例: 0 |
bidfloor | number | フロアプライス 例: 0 | |
bidfloorcur | string | フロアプライスの通貨コード ISO-4217で定義されている文字列を設定 | |
secure | integer | HTTPS の広告素材とマークアップが必要かどうか。 値: 0: non-secure1: secure例: 1 | |
pmp | Pmp | Private Marketplace の Deal の情報。 | |
exp | integer | オークションから impression までに経過しうる最大の秒数。動画リワードで入る。この値まで impression の有効期限を延ばしてほしい。 例: 10800 | |
ext | Imp Ext | 拡張領域 |
Imp Ext
位置: imp[].ext
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
skadn | SKAdNetwork | AppleのSKAdNetwork用のパラメータ。iOS14以降 IAB拡張 | |
spid | string | Source Placement ID。Header Bidding の上流が管理する枠の ID。Amazon TAM の場合は Tag ID、Google Open Bidding の場合は ad unit code。 ADG拡張 例: "my_upstream_placementid123" | |
gpid | string | Global Placement ID。 Amazon TAM の場合 imp[].ext.gpid、Google Open Bidding の場合 dfp_ad_unit_code、ADG JS / SDK の場合 imp[].tagid IAB拡張 例: "/1111/homepage#div-leftnav" | |
vcpm | integer | viewable課金のimpressionか否かを示す。 この値が1,2なら、広告が画面上で見えた時にのみ課金される。現状では1はなく0か2のみ。 ADG拡張 値: 0: non viewable impression1: viewable impression2: 広告が画面上に1%、0.1秒表示でimpressionとカウント例: 1例: 2 |
Site
位置: site / OpenRTB 2.6 の Site オブジェクト
Webサイトの情報
媒体がアプリではなくWebサイトの場合含まれる
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | ✓ | Ad Generationで付番したサイトID 例: "9336" |
name | string | サイト名 例: "本番環境用テスト広告" | |
domain | string | サイトのドメイン 例: "example.com" | |
cat | array of string | ✓ | サイトのカテゴリ。DSP が指定する対応表で変換したカテゴリコード。詳しくはカテゴリを参照。 例: ["CATEGORY_CODE_SAMPLE"] |
page | string | ページURL 例: "http://example.com/hoge" | |
ref | string | リファラ 例: "http://example.com/hoge/ref" | |
mobile | integer | モバイル向けに最適化されたページかどうか。 値: 01例: 0 | |
publisher | Publisher | ✓ | パブリッシャーの情報。 |
content | Content | コンテンツの情報。 | |
keywords | string | サイトに関するカンマ区切りのキーワード |
App
位置: app / OpenRTB 2.6 の App オブジェクト
アプリの情報
媒体がWebサイトではなくアプリの場合含まれる
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | ✓ | Ad Generationで付番したアプリID 例: "9336" |
name | string | アプリ名 例: "本番環境用テスト広告" | |
bundle | string | SSPによらずアプリを特定するplatform固有の識別子。 Androidの場合、com.example.myapp などのpackage name。 iOSの場合、com.example.myapp などのbundle identifier。590384791のようなapp store上の数字のidに変更も可能。 例: "com.example.myapp" | |
storeurl | string | ストアのURL 例: "https://itunes.apple.com/us/app/example/idXXXXXXXXXX?l=ja&ls=1&mt=8" | |
cat | array of string | ✓ | アプリのカテゴリ。DSP が指定する対応表で変換したカテゴリコード。詳しくはカテゴリを参照。 例: ["ADG_01000"] |
ver | string | アプリのバージョン 設定できない場合もある 例: "1.0.0" | |
publisher | Publisher | ✓ | パブリッシャーの情報。 |
content | Content | コンテンツの情報。 |
Device
位置: device / OpenRTB 2.6 の Device オブジェクト
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
ua | string | User-Agent ヘッダーの値。 例: "Mozilla/5.0 (iPhone; CPU iPhone OS 8_1_1 like Mac OS X) AppleWebKit/600.1.4 (KHTML, like Gecko) Mobile/12B435" | |
sua | UserAgent | 構造化されたUser Agent Object。 uaはフリーズされた文字列の可能性があるため、uaとsuaが両方ある場合はsuaの方が正確な情報とする。 | |
geo | Geo | 位置情報。 | |
dnt | integer | ブラウザのヘッダーDo Not Trackフラグの値。 値: 0: tracking is unrestricted1: do not track | |
lmt | integer | Limited Ad Tracking のシグナル。ユーザー ID に類するデータが Bid Request に含まれない場合は 1 にしている。 値: 0: 制限しない1: 制限する | |
ip | string | IP v4 アドレス Google Open Bidding(旧EBDA)の場合、最初の3オクテット(3byte)のみ送られてくるので第4オクテットは0を固定で入れる(例: 122.103.233.0)。 例: "163.49.202.118" | |
ipv6 | string | IPv6 アドレス。 Google Open Bidding の場合は先頭の 6 バイトだけが送られてくるので、残りは 0 にして送る(例: 2001:db8:1001::)。 | |
devicetype | integer | デバイスタイプ。Android 端末は User-Agent からは判定できないため、すべて 4(Phone)にしている。 値: 1: Mobile/Tablet Version 2.02: Personal Computer Version 2.03: Connected TV Version 2.04: Phone New for Version 2.25: Tablet New for Version 2.26: Connected Device New for Version 2.27: Set Top Box New for Version 2.2 | |
model | string | モデル | |
os | string | OS。 | |
osv | string | OS のバージョン。 | |
js | integer | javascriptをサポートしているか否か 1 固定 値: 0: no1: yes例: 1 | |
language | string | ブラウザの言語コード ISO-639-1-alpha-2 例: "ja" | |
mccmnc | string | MCC-MNC。 例: "440-50" | |
carrier | string | キャリア名 | |
connectiontype | integer | ネットワークの接続タイプ。 値: 0: Unknown1: Ethernet2: WIFI3: Cellular Network – Unknown Generation4: Cellular Network – 2G5: Cellular Network – 3G6: Cellular Network – 4G例: 0 | |
ifa | string | 広告ID idfa や google advertising id 例: "99999999-9999-9999-9999-999999999999" | |
ext | Device Ext | 拡張領域 |
Device Ext
位置: device.ext
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
atts | integer | (iOS Only) アプリのTracking Authorization statusを表す整数 IAB拡張 値: 0: not determined1: restricted2: denied3: authorized例: 3 | |
ifah | string | hash化したifa。device.ifaを送らない設定の枠でもDSP側でフリークエンシーコントロールが可能なように。 ADG拡張 例: "f70543455ab035ef44711a1f7c45e7f2691a91d7" | |
cdep | string | Chrome の Cookie Deprecation のテスト用ラベル。 IAB拡張 例: "example_label_1" |
User
位置: user / OpenRTB 2.6 の User オブジェクト
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | SSP側のUID 例: "TESTocCo4ccAAH2awC4AAAAA" | |
buyeruid | string | DSP のユーザー ID。ID 同期で Ad Generation 側が対応付けを持つ場合に入る。 例: "mydspuid123"例: "TESTocCo4ccAAH2awC4AAAAA" | |
geo | Geo | 位置情報。 | |
data | array of Data | 追加のユーザーデータ | |
eids | array of EID | 3rd party ID providerのID | |
ext | User Ext | 拡張領域 |
User Ext
位置: user.ext
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
unifiedid | string | The Trade Desk(TTD)社が提供するUnified ID。 Cookie SyncをTTDとだけ行うことで各SSP間とSyncしなくて済み、Match率も上がることが期待される。 Unified IDについて詳しくはTTDにお問い合わせください。 https://www.thetradedesk.com/industry-initiatives/unified-id-solution ADG拡張 例: "0525fe22-5ea4-4b8e-a81c-7eef017154af" | |
mediauid | string | 同一アプリ・サイト内でユニークなメディア管理のuser識別子。 メディアから明示的に送られている場合に利用可能 ADG拡張 例: "myuid123" | |
uidh | string | hash化したcookie uid。user.id/buyeruidを送らない設定の枠でもDSP側でフリークエンシーコントロールできるように。 ADG拡張 例: "f70543455ab035ef44711a1f7c45e7f2691a91d7" | |
eids | array of EID | 非推奨。user.eids に移行した。3rd party の ID プロバイダーの ID。 IAB拡張 |
Source
位置: source / OpenRTB 2.6 の Source オブジェクト
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
fd | integer | ✓ | 最終的な落札を決めるのが Ad Generation か上流のオークションかを示す。Header Bidding の場合は 1。 値: 0: exchange1: upstream source例: 0 |
tid | string | Header Biddingの時、複数SSPを跨いで共通なID。リクエストの重複を検知できるように。 Prebid8からは媒体側の設定でこのid(transactionId)はopt-inであり渡されないケースがある。 例: "fa7f737be3245606617b18eabf1e41bfaedc4e3a" | |
ext | Source Ext | 拡張領域 |
Source Ext
位置: source.ext
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
stype | string | Header Bidding Solutionの種類 ADG拡張 値: tam: Amazon TAM(Transparent Ad Marketplace)ebda: Google Open Bidding(旧EBDA)prebid: Prebid.js例: "tam" | |
schain | SupplyChain | OpenRTB の SupplyChain オブジェクト。 IAB拡張 | |
omidpn | string | OM SDK を組み込んだ事業者の識別子。OMID Partner の name と同じ。 IAB拡張 例: "Supershipjp" | |
omidpv | string | OM SDK を組み込んだ SDK のバージョン(OM SDK 自体のバージョンではない)。OMID Partner の version と同じ。 IAB拡張 例: "2.18.1" |
Regs
位置: regs / OpenRTB 2.6 の Regs オブジェクト
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
ext | Regs Ext | 拡張領域 |
Regs Ext
位置: regs.ext
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
gdpr | integer | このリクエストがGDPRの対象かどうか。現状ではGDPRのリクエストは送らないので常に0。 IAB拡張 値: 0: No1: Yes例: 0 |
Metric
位置: imp[].metric[] / OpenRTB 2.6 の Metric オブジェクト
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
type | string | ✓ | 計測値のタイプ。SSPが用意した計測値の項目の文字列。 値: avgwin: 該当枠の落札額の平均値。value は単位CPM、通貨はDSPに固定で設定されたbid_request.curと同じ。 medwin: 該当枠の落札額の中央値。value は単位CPM、通貨はDSPに固定で設定されたbid_request.curと同じ。 例: "avgwin" |
value | number | ✓ | typeに対応する数値。確率の場合は0.0から1.0の範囲。 例: 12.0 |
vendor | string | ✓ | 値の出どころを示す文字列。AdGenerationで算出した値の場合はEXCHANGE。 値: EXCHANGE: Source of value is AdGeneration.例: "EXCHANGE" |
Banner
位置: imp[].banner / OpenRTB 2.6 の Banner オブジェクト
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
format | array of Format | bannerのサイズのリスト。 複数サイズがある時imp objectを分けてw/hにいれるのではなく一つのimp objectにまとめることができる。 DSPがこのパラメータをサポートする場合はimp objectを分けない。 その場合、DSPはbid responseにseatbid.bid.w/hを返さないといけない。 | |
w | integer | 幅。単位: device independent pixels (DIPS). DSPがbanner.formatに対応している場合w/hはデフォルトではなし。 ただし、banner.format対応していても必要であれば入れる。 例: 320 | |
h | integer | 高さ。単位: device independent pixels (DIPS). DSPがbanner.formatに対応している場合w/hはデフォルトではなし。 ただし、banner.format対応していても必要であれば入れる。 例: 50 | |
id | string | Imp オブジェクト内でユニークな ID。0 から始まる連番。 例: "12345" | |
battr | array of integer | ブロックする広告属性 値: 1: Audio Ad (Auto-Play)2: Audio Ad (User Initiated)3: Expandable (Automatic)4: Expandable (User Initiated - Click)5: Expandable (User Initiated - Rollover)6: In-Banner Video Ad (Auto-Play)7: In-Banner Video Ad (User Initiated)8: Pop (e.g., Over, Under, or Upon Exit)9: Provocative or Suggestive Imagery10: Shaky, Flashing, Flickering, Extreme Animation, Smileys11: Surveys12: Text Only13: User Interactive (e.g., Embedded Games)14: Windows Dialog or Alert Style15: Has Audio On/Off Button16: Ad Can be Skipped (e.g., Skip Button on Pre-Roll Video) | |
pos | integer | ✓ | 広告のスクリーン上の位置。 値: 0: Unknown1: Above the Fold2: DEPRECATED - May or may not be initially visible depending on screen size/resolution.3: Below the Fold4: Header5: Footer6: Sidebar7: Full Screen9: overlay例: 9 |
api | array of integer | このインプレッションで対応している API フレームワークのリスト。リストに無い API は対応していないものとみなす。 値: 1: VPAID 1.02: VPAID 2.03: MRAID-14: ORMMA5: MRAID-26: MRAID-37: OMID-1例: [3] |
Video
位置: imp[].video / OpenRTB 2.6 の Video オブジェクト
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
mimes | array of string | ✓ | 対応している MIME タイプ。 例: ["video/mp4"] |
minduration | integer | 最小再生時間(秒指定) 例: 0 | |
maxduration | integer | 最大再生時間(秒指定) 例: 3600 | |
protocols | array of integer | サポートするvideo bid response protocolを示す値 値: 1: VAST 1.02: VAST 2.03: VAST 3.04: VAST 1.0 Wrapper5: VAST 2.0 Wrapper6: VAST 3.0 Wrapper7: VAST 4.08: VAST 4.0 Wrapper例: [2, 3, 5, 6] | |
w | integer | ビデオプレーヤーの幅(ピクセル) 例: 320 | |
h | integer | ビデオプレーヤーの高さ(ピクセル) 例: 180 | |
startdelay | integer | 再生開始遅延時間(秒) Instreamの場合のみ値が入る。 Outstreamの場合なし。 値: > 0: Mid-Roll (value indicates start delay in second)0: Pre-Roll-1: Generic Mid-Roll-2: Generic Post-Roll例: -1 | |
skip | integer | 広告を再生する動画プレイヤーが動画広告のスキップを許可するか否か 値: 0: no1: yes例: 0 | |
skipmin | integer | スキップされる可能性のある動画の最小秒数 例: 5 | |
skipafter | integer | スキップ可能となるまでの秒数 例: 5 | |
placement | integer | Deprecated(OpenRTB 2.6-202303) 代わりにplcmtを参照. 広告表示される場所のタイプ 値: 1: In-Stream2: In-Banner3: In-Article4: In-Feed5: Interstitial/Slider/Floating例: 0 | |
plcmt | integer | 広告表示される場所のタイプ. OpenRTB 2.6-202303で追加 値: 1: インストリーム (Instream):消費者がリクエストしたストリーミング動画コンテンツの再生前、再生中、または再生後に再生されるプレロール、ミッドロール、ポストロール広告。 インストリーム動画は、プレイヤー開始時にデフォルトで音声オンに設定されているか、ユーザーがその動画コンテンツを視聴する明確な意図を持っている必要があります。 プレイヤーの周囲に他のコンテンツが存在する場合もありますが、動画コンテンツ自体がユーザーの訪問の主目的である必要があります。 それはページの主要なコンテンツであり続け、再生中はビューポート内で音声再生可能な唯一の動画プレイヤーでなければなりません。 プレイヤーがフローティング/スティッキー形式に移行した場合、その後の広告呼び出し(アドコール)は更新されたプレイヤーサイズを正確に伝える必要があります。 2: 付属コンテンツ(Accompanying Content):ストリーミング動画コンテンツの再生前、再生中、または再生後に再生されるプレロール、ミッドロール、ポストロール広告。 動画プレイヤーは、テキストやグラフィックコンテンツの段落の前、間、または後に読み込まれ、ビューポート(表示領域)に入ったときにのみ再生を開始します。 アコンパニングコンテンツは、ビューポートに入った時にのみ再生を開始する必要があります。 ページからスクロールアウトする際に、フローティング/スティッキープレイヤーに移行する場合があります。 3: インタースティシャル(Interstitial):動画コンテンツなしで再生される動画広告。再生中は、ページの主な焦点となり、ビューポートの大部分を占め、スクロールして表示外に出ることはできません。 アプリ内動画やスライドショーのようなプレースメントでも可能。 4: コンテンツなし/スタンダロン(No Content/Standalone):動画コンテンツをストリーミングせずに再生される動画広告。 スライドショー、ネイティブフィード、コンテンツ内、スティッキー/フローティングなどのプレースメントで使用できます。 例: 1 | |
linearity | integer | 許容されるビデオの直線性 指定がなければ限定されない 1(Linear)で固定 値: 1: Linear / In-Stream2: Non-Linear / Overlay例: 1 | |
battr | array of integer | ブロックする広告属性 値: 1: Audio Ad (Auto-Play)2: Audio Ad (User Initiated)3: Expandable (Automatic)4: Expandable (User Initiated - Click)5: Expandable (User Initiated - Rollover)6: In-Banner Video Ad (Auto-Play)7: In-Banner Video Ad (User Initiated)8: Pop (e.g., Over, Under, or Upon Exit)9: Provocative or Suggestive Imagery10: Shaky, Flashing, Flickering, Extreme Animation, Smileys11: Surveys12: Text Only13: User Interactive (e.g., Embedded Games)14: Windows Dialog or Alert Style15: Has Audio On/Off Button16: Ad Can be Skipped (e.g., Skip Button on Pre-Roll Video) | |
minbitrate | integer | 最小ビットレート(kbps) 例: 300 | |
maxbitrate | integer | 最大ビットレート(kbps) 例: 1500 | |
boxingallowed | integer | letter-boxing 4:3のコンテンツを16:9にするのを許可するかを示すフラグ 1 固定 値: 0: no1: yes例: 1 | |
delivery | array of integer | サポートされる動画の配信方法(streaming, progressive) 2 固定 値: 1: Streaming2: Progressive例: [2] | |
pos | integer | 広告のスクリーン上の位置 値: 0: Unknown1: Above the Fold2: DEPRECATED - May or may not be initially visible depending on screen size/resolution.3: Below the Fold4: Header5: Footer6: Sidebar7: Full Screen9: overlay例: 0 | |
api | array of integer | このインプレッションで対応している API フレームワークのリスト。リストに無い API は対応していないものとみなす。 値: 1: VPAID 1.02: VPAID 2.03: MRAID-14: ORMMA5: MRAID-26: MRAID-37: OMID-1 | |
ext | Video Ext | 拡張領域 |
Video Ext
位置: imp[].video.ext
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
video_ad_skippable | integer | 動画広告がSKIP可かどうかを示すフラグ ADG拡張 値: 0: not skippable1: skippable例: 0 | |
outstream | integer | INSTREAM型(動画コンテンツの間に広告を挟み込む形式)の広告枠か OUTSTREAM(動画コンテンツ内に埋め込まないタイプのVideo広告)の枠かどうかを示すフラグ ADG拡張 値: 0: INSTREAM1: OUTSTREAM例: 1 | |
rewarded_video | integer | 動画リワードかどうかを示すフラグ ADG拡張 値: 0: not rewarded video1: rewarded video例: 0 | |
inread | integer | inread(記事内動画)かどうかを示すフラグ ADG拡張 値: 0: not inread1: inread例: 0 | |
orientation | integer | 縦型動画かどうかを示すシグナル。 ADG拡張 値: 0: ORIENTATION_UNKNOWN1: HORIZONTAL (width > height)2: VERTICAL (height > width) |
Native
位置: imp[].native / OpenRTB 2.6 の Native オブジェクト
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
request | string | Native Ads 1.2 または 1.0.0.2 のリクエストを JSON 文字列にしたもの。 中身は Native 1.2 Request と Native 1.0.0.2 Request を参照。 例: "{\"native\":{\"ver\":\"1.0.0.2\",\"layout\":3,\"plcmtcnt\":1,\"assets\":[{\"id\":1,\"title\":{\"len\":30}},{\"id\":2,\"img\":{\"type\":1,\"w\":64,\"h\":64,\"mimes\":[\"image/jpeg\"]}},{\"id\":3,\"data\":{\"type\":1,\"len\":10}},{\"id\":4,\"data\":{\"type\":2,\"len\":10}},{\"id\":5,\"data\":{\"type\":12,\"len\":10}}]}}" | |
ver | string | requestの内容がどの仕様に準拠しているかを示すバージョン番号 例: "1.0.0.2" | |
api | array of integer | このインプレッションで対応している API フレームワークのリスト。リストに無い API は対応していないものとみなす。 値: 1: VPAID 1.02: VPAID 2.03: MRAID-14: ORMMA5: MRAID-26: MRAID-37: OMID-1 | |
battr | array of integer | ブロックする広告属性 値: 1: Audio Ad (Auto-Play)2: Audio Ad (User Initiated)3: Expandable (Automatic)4: Expandable (User Initiated - Click)5: Expandable (User Initiated - Rollover)6: In-Banner Video Ad (Auto-Play)7: In-Banner Video Ad (User Initiated)8: Pop (e.g., Over, Under, or Upon Exit)9: Provocative or Suggestive Imagery10: Shaky, Flashing, Flickering, Extreme Animation, Smileys11: Surveys12: Text Only13: User Interactive (e.g., Embedded Games)14: Windows Dialog or Alert Style15: Has Audio On/Off Button16: Ad Can be Skipped (e.g., Skip Button on Pre-Roll Video) | |
ext | Native Ext | 拡張領域 |
Native Ext
位置: imp[].native.ext
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
request_json | Native 1.0.0.2 Request / Native 1.2 Request | native.request を文字列ではなく JSON オブジェクトのまま入れたもの。希望する DSP には native.request の代わりにこちらで送る。 ADG拡張 | |
w | integer | ネイティブ広告表示領域の固定サイズが分かる場合の横幅(width) ADG拡張 例: 300 | |
h | integer | ネイティブ広告表示領域の固定サイズが分かる場合の高さ(height) ADG拡張 例: 250 |
Pmp
位置: imp[].pmp / OpenRTB 2.6 の Pmp オブジェクト
Pmp オブジェクト。利用する場合はご相談ください。
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
private_auction | integer | ✓ | Deal オブジェクトに指定した seat の入札だけを受け付けるかどうか。0 = すべての入札を受け付ける、1 = 指定した deal とその条件の入札に限る。 値: 0: all bids are accepted1: bids are restricted to the deals specified and the terms thereof. |
deals | array of Deal | ✓ | Deal オブジェクトの配列 |
ext | any | 拡張領域 |
SKAdNetwork
位置: imp[].ext.skadn
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
version | string | 対応している SKAdNetwork のバージョン(2.0 以上)。非推奨。versions を参照。 例: "2.1" | |
versions | array of string | 対応している SKAdNetwork のバージョンのリスト(2.0 以上)。OS と SDK のバージョンによる。 例: ["2.0", "2.1", "2.2"] | |
sourceapp | string | 媒体アプリの App Store 上の ID。 例: "880047117" | |
skadnetids | array of string | 媒体アプリのinfo.plistのSKAdNetworkItemの内、DSPに関連のあるエントリーのリスト 例: ["cDkw7geQsH.skadnetwork", "qyJfv329m4.skadnetwork"] | |
skoverlay | integer | SKOverlayのサポート有無 例: 1 |
Publisher
位置: site.publisher, app.publisher / OpenRTB 2.6 の Publisher オブジェクト
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | ✓ | Ad Generationで付番したパブリッシャーID 例: "9999" |
name | string | ✓ | パブリッシャー名 例: "Scaleout .Inc" |
Content
位置: site.content, app.content / OpenRTB 2.6 の Content オブジェクト
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | ユニークなコンテンツID 例: "6316725204112" |
UserAgent
位置: device.sua / OpenRTB 2.6 の UserAgent オブジェクト
User-Agent Client Hintsを元にした情報
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
browsers | array of BrandVersion | ブラウザの情報。Sec-CH-UA-Full-Version-List ヘッダーを元にしている。 | |
platform | BrandVersion | OS(プラットフォーム)の情報。Sec-CH-UA-Platform ヘッダーを元にしている。 | |
mobile | integer | モバイル版のコンテンツが好ましい場合は 1、デスクトップ版(フル版)が好ましい場合は 0。Sec-CH-UA-Mobile ヘッダーの値。 例: 1 | |
architecture | string | 端末のアーキテクチャ。Sec-CH-UA-Arch ヘッダーの値。 例: "x86" | |
bitness | string | 端末のビット数(64 ビットなら 64)。Sec-CH-UA-Bitness ヘッダーの値。 例: "64" | |
model | string | 端末のモデル名。Sec-CH-UA-Model ヘッダーの値。 例: "Pixel 3" | |
source | integer | このオブジェクトの情報源。AdCOM 1.0定義のList: User-Agent Source 値: 0: Unspecified/unknown1: User-Agent Client Hints (only low-entropy headers were available)2: User-Agent Client Hints (with high-entropy headers available)3: Parsed from User-Agent header (the same string carried by the ua field) |
Geo
位置: device.geo, user.geo / OpenRTB 2.6 の Geo オブジェクト
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
lat | number | 緯度 | |
lon | number | 経度 | |
type | integer | 位置情報の取得元。 値: 1: GPS/Location Services2: IP Address3: User provided (e.g., registration data) | |
country | string | 国コード ISO-3166-1-alpha-3 例: "JPN" |
Data
位置: user.data[] / OpenRTB 2.6 の Data オブジェクト
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | データ提供元ID | |
name | string | データ提供元の名前 | |
segment | array of Segment | 実際のデータが入っているSegmentオブジェクトの配列 | |
ext | Data Ext | 拡張領域 |
Data Ext
位置: user.data[].ext
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
segtax | integer | Segment Taxonomies で定められた分類体系のコード。 IAB拡張 例: 601 | |
segclass | string | セグメントを分類した分類器(classifier)のバージョン。 IAB拡張 例: "classifier_v1" |
EID
位置: user.eids[], user.ext.eids[] / OpenRTB 2.6 の EID オブジェクト
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
source | string | ✓ | トップレベルドメインで表現されたID提供元 値: id5-sync.com: ID5uidapi.com: Unified ID 2.0intimatemerger.com: IM-UIDintentiq.com: Intent IQcriteo.com: Criteo例: "id5-sync.com" |
inserter | string | ID配列要素の追加を引き起こしたエンティティ(媒体、SSP、エクスチェンジ、ヘッダーラッパーなど)の正規ドメイン名。 例: "ad-generation.jp" | |
matcher | string | mmで定義された照合方式を提供する技術。場合によっては、この値は inserter と同じになることがある。 空白の場合、matcherはsourceと同一であるとみなされる。mm=0、1、または 2 の場合、省略可能。 例: "intentiq.com" | |
mm | integer | マッチャーが使用する照合方法。 値: 0: Unknown1: No Match. No matching has occurred. The associated ID came directly from a 3rd-party cookie or OS-provided resettable device ID for advertising (IFA).2: Browser Cookie Sync. Real time cookie sync as described in Appendix: Cookie Based ID Syncing of OpenRTB 2.x3: Authenticated. ID match was based on user authentication such as an email login or hashed PII4: Observed. ID match was based on a 1st party observation, but without user authentication (e.g. GUID, SharedID, Session IDs, CHIPS or other 1st party cookies contained in localStorage)5: Inference. ID match was inferred from linkage based on non-authenticated features across multiple browsers or devices (e.g. IP address and/or UserAgent))例: 5 | |
uids | array of UID | ✓ | 該当ID提供元からのUIDの配列 |
ext | any | 拡張領域 |
SupplyChain
位置: source.ext.schain / OpenRTB 2.6 の SupplyChain オブジェクト
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
ver | string | ✓ | SupplyChain仕様書のversion。 現状では1.0固定。 例: "1.0" |
complete | integer | ✓ | アプリやwebサイトのオーナーまでリクエストに関与するノードが完全に含まれているかどうかを示すフラグ。 値: 0: incomplete1: complete例: 1 |
nodes | array of SupplyChainNode | ✓ | SupplyChainNodeの順序付けされたリスト。 完全なリストでは最初のノードはアプリやwebサイトの保有者が直接接する広告システム。 不完全なリストでは最初のノードは知っている限りの最初のノード。 最後のノードはDSPに送っている広告システム、つまり当システム。 |
Format
位置: imp[].banner.format[] / OpenRTB 2.6 の Format オブジェクト
bannerのサイズ情報
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
w | integer | 横幅。単位: device independent pixels (DIPS). 例: 320 | |
h | integer | 高さ。単位: device independent pixels (DIPS). 例: 50 |
Deal
位置: imp[].pmp.deals[] / OpenRTB 2.6 の Deal オブジェクト
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | ✓ | Dealを識別するid 例: "mydealid" |
bidfloor | number | Deal のフロアプライス(CPM)。at が 3 のときは落札額になる固定価格。 例: 12.345 | |
bidfloorcur | string | 通貨指定(ISO-4217)。JPYまたはUSD 例: "JPY" | |
at | integer | ✓ | このDealのオークションタイプ 1はDSPがbid responseで入札した価格、3はSSPがbid requestで指定した固定価格(bidfloor)が落札額になる。 値: 1: First Price3: bidfloor例: 3 |
wseat | array of string | このdealで入札ができるseat idのホワイトリスト 例: ["200", "abc"] | |
ext | Deal Ext | 拡張領域 |
Deal Ext
位置: imp[].pmp.deals[].ext
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
ignore_bcat | boolean | DSP側でDealの入札時にブロックカテゴリ(BidRequest.bcat)を無視するかのフラグ trueの時無視する。falseまたはない場合無視しない ADG拡張 例: true |
BrandVersion
位置: device.sua.browsers[], device.sua.platform / OpenRTB 2.6 の BrandVersion オブジェクト
User-Agent Client Hintsを元にしたブラウザ・OS情報
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
brand | string | ブラウザ名・OS(platform)名。User-Agent Client Hints headersを元にした情報 例: "Google Chrome" | |
version | array of string | バージョン番号(major, minor, micro, ...)。 例: ["10", "5", "1"] |
Segment
位置: user.data[].segment[] / OpenRTB 2.6 の Segment オブジェクト
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | セグメントの ID。Topics API の場合は topic の ID。 例: "351" | |
name | string | セグメントの名前。 | |
value | string | セグメントの値。 |
UID
位置: user.eids[].uids[] / OpenRTB 2.6 の UID オブジェクト
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | ✓ | UID |
atype | integer | IDの由来となるユーザーエージェントの種類. 値: 1: An ID which is tied to a specific web browser or device (cookie-based, probabilistic, or other).2: In-app impressions, which will typically contain a type of device ID (or rather, the privacy-compliant versions of device IDs).3: A person-based ID, i.e., that is the same across devices.例: 1 | |
ext | UID Ext | 拡張領域 |
UID Ext
位置: user.eids[].uids[].ext
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
linkType | integer | id5用Link Type。Google Open Biddingで不明の場合はフィールド自体なし 外部拡張 値: 0: unlinked1: probabilistic2: deterministic例: 2 |
SupplyChainNode
位置: source.ext.schain.nodes[] / OpenRTB 2.6 の SupplyChainNode オブジェクト
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
asi | string | ✓ | 広告システム(SSP, Header Wrapper等)のドメイン名。 ads.txt上のドメイン名と同じ値。 例: "ad-generation.jp" |
sid | string | ✓ | 広告システム内でのseller, resellerアカウントのid。 例: "4321" |
hp | integer | ✓ | このノードが支払いに関与するかどうか。1 は、asi の広告システムが sid の販売者に支払い、その販売者が一つ前のノードに支払うことを示す。Ad Generation のノードは 1。 値: 0: このノードは支払いに関与しない。1: このノードは支払いに関与する。例: 1 |
rid | string | OpenRTBのRequestId。 例: "abc12345678" |
リクエストの例
Ad Generation のタグ経由の、スマートフォンの Web バナー(300x250)の例です。実際に送る内容は在庫と DSP ごとの設定(カテゴリの対応表、送るフィールドなど)で変わります。この例では、カテゴリを Ad Generation のコードのまま送っています。
{
"id" : "example-auction-id",
"imp" : [ {
"id" : "1",
"tagid" : "736714",
"banner" : {
"format" : [ {
"w" : 300,
"h" : 250
} ],
"w" : 300,
"h" : 250,
"id" : "0",
"pos" : 1,
"api" : [ ]
},
"displaymanager" : "adg_web_sdk",
"displaymanagerver" : "2.27.1",
"instl" : 0,
"bidfloor" : 25.0,
"bidfloorcur" : "JPY",
"secure" : 1,
"ext" : {
"gpid" : "736714",
"vcpm" : 0
}
} ],
"site" : {
"id" : "736714",
"name" : "マンガサイト_SP",
"domain" : "manga.example.com",
"cat" : [ "ADG_01000", "ADG_ent" ],
"page" : "https://manga.example.com/",
"ref" : "",
"mobile" : 1,
"publisher" : {
"id" : "8954",
"name" : "サンプルマンガ株式会社"
}
},
"device" : {
"ua" : "Mozilla/5.0 (iPhone; CPU iPhone OS 18_7 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/26.6.1 Mobile/15E148 Safari/604.1",
"geo" : {
"country" : "JPN"
},
"dnt" : 0,
"ip" : "203.0.113.130",
"devicetype" : 4,
"model" : "iPhone",
"os" : "iOS",
"js" : 1,
"language" : "ja",
"connectiontype" : 0,
"ext" : { }
},
"user" : {
"id" : "ddYXE9Ti6NUUDZeUkyXYXDPB",
"geo" : {
"country" : "JPN"
},
"ext" : { }
},
"at" : 1,
"tmax" : 150,
"cur" : [ "JPY" ],
"bcat" : [ "ADG_bridal", "ADG_25003", "ADG_medical", "ADG_compladies", "ADG_marriage", "ADG_dating", "ADG_pachi", "ADG_ebookxs", "ADG_adult", "ADG_14003", "ADG_comphair", "ADG_healcomp", "ADG_religion", "ADG_clitrial", "ADG_vcurrency", "ADG_gamexs", "ADG_25004", "ADG_23001", "ADG_datingxs", "ADG_25005", "ADG_healnomal", "ADG_fortune", "ADG_ebookx", "ADG_ciga", "ADG_07002", "ADG_rei", "ADG_gamble", "ADG_08002", "ADG_gambleo", "ADG_ebook", "ADG_23002", "ADG_political", "ADG_others", "ADG_compmens", "ADG_24000", "ADG_25001", "ADG_hincome", "ADG_11001", "ADG_07003", "ADG_surger", "ADG_alcohol", "ADG_loan", "ADG_14004", "ADG_03006", "ADG_19003", "ADG_eleciga", "ADG_affiliate", "ADG_25002", "ADG_13006", "ADG_dentistry", "ADG_14002" ],
"source" : {
"fd" : 0,
"tid" : "example-auction-id",
"ext" : {
"schain" : {
"ver" : "1.0",
"complete" : 1,
"nodes" : [ {
"asi" : "ad-generation.jp",
"sid" : "8954",
"hp" : 1,
"rid" : "example-auction-id"
} ]
}
}
},
"regs" : {
"ext" : {
"gdpr" : 0
}
}
}
Bid Response
DSP が Ad Generation に返す OpenRTB 2.x の Bid Response です。Ad Generation が読むフィールドだけを載せています。
BidResponse
位置: (root) / OpenRTB 2.6 の BidResponse オブジェクト
DSP が返す OpenRTB 2.x の Bid Response。入札しない場合は、レスポンスの代わりに HTTP ステータスコード 204 を返してもよい。
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | ✓ | 対応するBid RequestのID 例: "7749a0cb204eea02d50e7c98d790ae25c6f74318" |
seatbid | array of SeatBid | 入札するならば1つ以上 Seatbid オブジェクトを含んだ配列 | |
bidid | string | DSPで付番したID | |
cur | string | 入札金額の通貨コード(ISO-4217)。 例: "JPY" | |
nbr | integer | 入札しない理由。 値: 0: Unknown Error1: Technical Error2: Invalid Request3: Known Web Spider4: Suspected Non-Human Traffic5: Cloud, Data center, or Proxy IP6: Unsupported Device7: Blocked Publisher or Site8: Unmatched User |
SeatBid
位置: seatbid[] / OpenRTB 2.6 の SeatBid オブジェクト
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
bid | array of Bid | ✓ | Bid オブジェクトの配列 Bid Requestの Imp オブジェクトに対応 |
seat | string | 入札する buyer の seat ID。 例: "seat-id-001" |
Bid
位置: seatbid[].bid[] / OpenRTB 2.6 の Bid オブジェクト
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | ✓ | DSP側で付番したID 例: "1" |
impid | string | ✓ | 対応するImp オブジェクトのID 例: "4974d82c61b283497cc4e220e8f748854018a086" |
price | number | ✓ | 入札額 例: 10.5 |
adid | string | 落札した場合に配信する、事前に登録された広告の ID。 | |
adm | string | 広告のマークアップ。バナーは HTML、ネイティブは Native Ads のレスポンスの JSON 文字列(Native 1.2 Response、Native 1.0.0.2 Response)、動画は VAST。 例: "<div style=\"margin:0px;padding:0px;overflow:hidden\">\\n<iframe src=\"https://s3-ap-northeast-1.amazonaws.com/adg-dummy-dsp/banner1/320x50fix.html?prc=${AUCTION_PRICE}&rd=${SSP_REDIRECT_ENCURL}\" style=\"overflow:hidden;height:50px;width:320px\" frameborder=\"0\" scrolling=\"no\"></iframe>\\n</div>" | |
adomain | array of string | ✓ | 広告主のコーポレイトサイト(ランディングページではなく)のドメイン ブロックリストのチェックに使われる。 ローテーションするクリエイティブの場合、複数になり得る。 広告主ドメインによる入札のブロックについて参照 例: ["ford.com"] |
bundle | string | 広告するアプリのバンドル ID かパッケージ名(例: com.foo.mygame)。 | |
iurl | string | 広告の品質・安全性の確認に使う、キャンペーンの内容を表す画像の URL(キャッシュバスティングなし)。可能な限り入れてほしい。 | |
cid | string | 広告の品質確認に使うキャンペーン ID。iurl が代表するクリエイティブの集合を表す。 | |
crid | string | ✓ | クリエイティブ ID。広告の検査に必要。 |
cat | array of string | クリエイティブのカテゴリ。IAB カテゴリなど、取り決めた体系のコード。 | |
attr | array of integer | アドのクリエイティブ属性 値: 1: Audio Ad (Auto-Play)2: Audio Ad (User Initiated)3: Expandable (Automatic)4: Expandable (User Initiated - Click)5: Expandable (User Initiated - Rollover)6: In-Banner Video Ad (Auto-Play)7: In-Banner Video Ad (User Initiated)8: Pop (e.g., Over, Under, or Upon Exit)9: Provocative or Suggestive Imagery10: Shaky, Flashing, Flickering, Extreme Animation, Smileys11: Surveys12: Text Only13: User Interactive (e.g., Embedded Games)14: Windows Dialog or Alert Style15: Has Audio On/Off Button16: Ad Can be Skipped (e.g., Skip Button on Pre-Roll Video) | |
dealid | string | private marketplace の deal に対する入札の場合、Bid Request の deal.id。 | |
h | integer | クリエイティブの高さ(DIPS)。Bid Request の imp[].banner.format が複数の場合は必須。 例: 250 | |
w | integer | クリエイティブの幅(DIPS)。Bid Request の imp[].banner.format が複数の場合は必須。 例: 300 | |
burl | string | impression の通知 URL。バナーの入札では必要。 inview 課金の枠では、バナーのクリエイティブを事前に読み込むだけで表示に至らない場合があるため、クリエイティブの読み込みとは別にこの URL で impression を通知する。事前に読み込まない枠では adm に img タグとして付けて呼ぶので、バナーの入札では常に burl を返して問題ない。 burl の中のマクロも置換する。burl を返せない場合は、事前に読み込む可能性のある Header Bidding の在庫を送らないようにもできる。複数の URL は ext.burls で返せる。 ネイティブでは imptrackers、動画では VAST の Impression を使うので不要。返された場合はそれらとまとめて通知し、同じ URL は二重には呼ばない。 例: "https://mydsp1.com/imp?id=123456" | |
lurl | string | 落札しなかったときの通知 URL。 例: "https://example.com/loss_notice?reason=${AUCTION_LOSS}" | |
ext | Bid Ext | 拡張領域。 |
Bid Ext
位置: seatbid[].bid[].ext
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
atype | integer | admの内容の種類を示す値 本仕様でnative広告だけでなく、banner広告も取り扱う場合、どちらの広告が戻ってきたか、SSP側で判断がつかないため、 下記の値で判断する。 未設定の場合、1:banner とみなす ADG拡張 値: 1: banner2: native3: video例: 2 | |
advertiser | string | 広告主名 会社名にキャンペーン名や期間が付加された正確な会社名でなくてもよい ADG拡張 例: "株式会社Example"例: "Example Inc." | |
agency | string | 代理店名 ADG拡張 例: "株式会社Example"例: "Example Inc." | |
lp | string | ランディングページのURL 中間の計測用ツールのURLではなく最終的なLP。 ADG拡張 例: "https://example.com/landingpage.html" | |
bidshading | integer | 1st price auctionの時(at:1)でも入札価格をBid Shadingで調節することができるようにするフラグ。 2nd price auction(at:2)の時は無視される。 DSP側で1st priceでの入札とBid Shading機能を切り替えて効果を見る目的に使用する。 ADG拡張 値: 0: 入札額はそのまま1st priceの入札として扱われる。未指定の時のデフォルト。1: 入札額はBid Shading機能で過去のオークションから推定された市場価格に引き下げられる。例: 1 | |
skadn | SKAdNetwork | SKAdNetwork の情報。 IAB拡張 | |
burls | array of string | burlの複数版。 ADG拡張 例: ["https://example.com/imp1", "https://example.com/imp2"] |
SKAdNetwork
位置: seatbid[].bid[].ext.skadn
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
version | string | SKAdNetwork のバージョン(2.0 以上)。 例: "2.0" | |
network | string | 署名に使われたAd network ID。BidRequestのskadnetids内のどれかに一致している必要がある。 例: "cDkw7geQsH.skadnetwork" | |
sourceidentifier | string | 広告ネットワークが定める広告キャンペーンの4桁の数字。SKAdNetwork 4.0 以上では、これを使って署名を生成すること。 例: "4321" | |
campaign | string | Appleの仕様に準拠したキャンペーンID。2.0では1〜100の間の数字を文字列とした値。 例: "45" | |
itunesitem | string | 広告対象アプリのAppleのapp store上のID。BidResponse.bid.bundleと同じ値であるべき。 例: "880047117" | |
fidelities | array of SKAdNetwork Fidelity | SKAdNetwork v2.2で導入された複数フィデリティタイプ | |
nonce | string | レスポンス毎にユニークなID。 Note: SKAdNetwork v2.2以降では複数フィデリティタイプに対応するためこのフィールドは廃止してBidResponse.seatbid.bid.ext.skadn.fidelities.nonceを使う。 例: "473b1a16-b4ef-43ad-9591-fcf3aefa82a7" | |
sourceapp | string | 媒体アプリの App Store 上の ID。Bid Request の imp.ext.skadn.sourceapp と同じ値。 例: "123456789" | |
timestamp | string | 署名時のUnix timeをミリ秒で表した文字列 Note: SKAdNetwork v2.2以降では複数フィデリティタイプに対応するためこのフィールドは廃止してBidResponse.seatbid.bid.ext.skadn.fidelities.timestampを使う。 例: "1594406341" | |
signature | string | Appleに指定されたSKAdNetworkの署名 Note: SKAdNetwork v2.2以降では複数フィデリティタイプに対応するためこのフィールドは廃止してBidResponse.seatbid.bid.ext.skadn.fidelities.signatureを使う。 例: "MEQCIEQlmZRNfYzK…" | |
skoverlay | SKAdNetwork SKOverlay | SKOverlay の設定。 |
SKAdNetwork Fidelity
位置: seatbid[].bid[].ext.skadn.fidelities[]
異なるフィデリティタイプ毎に異なる値を持つべきフィールド(例: fidelity, nonce, signature)はこの配列のオブジェクトに入れる。
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
fidelity | integer | 追跡する属性のフィデリティタイプ 例: 0 | |
nonce | string | 広告レスポンス毎にユニークなid。 UUIDのフォーマット仕様についてはAppleのドキュメントを参照 例: "473b1a16-b4ef-43ad-9591-fcf3aefa82a7" | |
timestamp | string | 署名した時刻の Unix 時間(ミリ秒)の文字列。 例: "1594406341" | |
signature | string | Appleによって指定されたSKAdNetwork署名 例: "MEQCIEQlmZRNfYzK…" |
SKAdNetwork SKOverlay
位置: seatbid[].bid[].ext.skadn.skoverlay
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
delay | integer | SKOverlayを表示するまでの遅延秒数。 この値が0の場合、即座にオーバーレイが表示されます。未設定の場合、オーバーレイは表示されません。 例: 0 | |
endcarddelay | integer | エンドカード上でSKOverlayを表示するまでの遅延秒数。 この値が0の場合、即座にオーバーレイが表示されます。未設定の場合、オーバーレイは表示されません。 例: 0 | |
dismissible | integer | ユーザーがオーバーレイを閉じることができるかどうか。0 = 不可、1 = 可能 例: 0 | |
pos | integer | オーバーレイの表示位置。0 = bottom、1 = bottomRaised 例: 1 |
Native 1.2 Request
imp.native.request に文字列で入る Native Ads 1.2 のリクエストです。
Native Markup Request
位置: (root), native / Native Ads 1.2 の Native Markup Request オブジェクト
imp.native.request に JSON 文字列として入る Native Ads 1.2 のリクエスト。
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
ver | string | 準拠しているOpenRTB Nativeの仕様のバージョン 例: "1.2" | |
context | integer | ✓ | 広告が表示される場所のコンテキスト 値: 1: Content-centric context such as newsfeed, article, image gallery, video gallery, or similar.2: Social-centric context such as social network feed, email, chat, or similar3: Product context such as product listings, details, recommendations, reviews, or similar.例: 3 |
plcmtcnt | integer | ✓ | 広告枠に入れられる広告の数。最大でこの数まで Bid Response に広告を含められる。 例: 1 |
assets | array of Asset Request | ✓ | Asset の配列。入札は各 Asset の条件に沿うこと。 |
aurlsupport | integer | Asset を URL で返すこと(assetsurl)に対応しているか。 | |
durlsupport | integer | 動的クリエイティブの URL(dcourl)に対応しているか。 | |
eventtrackers | array of Event Trackers Request | イベントトラッカーの配列。 | |
privacy | integer | DSP のプライバシーに関する通知(オプトアウトページ)の表示に対応しているか。1 なら、レスポンスの privacy で URL を返せる。 | |
ext | any | 拡張領域。 |
Native Wrapper
位置: (root)
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
native | Native Markup Request | ✓ | Native 1.2 のリクエストを {"native": {...}} で包んだもの。DSP設定 enableNative1_2RequestWrapper のときだけこの形で送る。 IAB拡張 |
Asset Request
位置: assets[] / Native Ads 1.2 の Asset Request オブジェクト
Asset オブジェクト
Bid Requestに設定
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
id | integer | ✓ | Asset のユニークな ID。連番とは限らない。 例: 1 |
required | integer | この Asset が必須かどうか。 値: 0: 不要1: 必要例: 0 | |
title | Title Request | タイトルの Asset。 | |
img | Image Request | 画像の Asset。 | |
video | Video Request | 動画の Asset。 | |
data | Data Request | データ(説明文、広告主名など)の Asset。 | |
ext | any | 拡張領域。 |
Event Trackers Request
位置: eventtrackers[] / Native Ads 1.2 の Event Trackers Request オブジェクト
EventTracker オブジェクト
Bid Requestに設定
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
event | integer | ✓ | トラッキングできるイベントのタイプ。 値: 1: Impression2: Visible impression using MRC definition at 50% in view for 1 second.3: 100% in view for 1 second (ie GroupM standard)4: Visible impression for video using MRC definition at 50% in view for 2 seconds例: 1 |
methods | array of integer | ✓ | そのイベントで使えるトラッキング方法の配列。 値: 1: Image-pixel tracking - URL provided will be inserted as a 1x1 pixel at the time of the event.2: Javascript-based tracking - URL provided will be inserted as a js tag at the time of the event.例: [1] |
ext | Event Trackers Request Ext | 拡張領域 |
Event Trackers Request Ext
位置: eventtrackers[].ext, assets[].data.ext
Data 拡張オブジェクト
Bid Requestに設定
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
default_value | string | レスポンスで返されなかった場合に使われるデフォルト値 ADG拡張 例: "my-default-value123" |
Title Request
位置: assets[].title / Native Ads 1.2 の Title Request オブジェクト
Title オブジェクト
Bid Requestに設定
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
len | integer | ✓ | タイトル文字列の最大長 例: 10 |
ext | any | 拡張領域 |
Image Request
位置: assets[].img / Native Ads 1.2 の Image Request オブジェクト
Image オブジェクト
Bid Requestに設定
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
type | integer | 画像の Asset Type(Native Ads 1.2 の Image Asset Types)。 値: 1: Icon アイコン画像3: Main ワイドフォーマットで表示するような画像例: 3 | |
wmin | integer | 画像の最小幅(ピクセル) 例: 32 | |
hmin | integer | 画像の最小高さ(ピクセル) 例: 32 | |
mimes | array of string | 許容できるMIMEタイプのホワイトリスト 未定義あるいは空配列の場合、すべて許容できることを示す 例: ["image/jpeg"] | |
ext | any | 拡張領域 |
Video Request
位置: assets[].video / Native Ads 1.2 の Video Request オブジェクト
Video オブジェクト
Bid Requestに設定
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
mimes | array of string | 許容できるMIMEタイプのホワイトリスト 例: ["video/mp4"] | |
minduration | integer | ✓ | 最小再生時間(秒) 例: 30 |
maxduration | integer | ✓ | 最大再生時間(秒) 例: 60 |
protocols | array of integer | ✓ | Video Protocolコードの配列(OpenRtbのVideo Bid Response Protocols参照) 値: 1: VAST 1.02: VAST 2.03: VAST 3.04: VAST 1.0 Wrapper5: VAST 2.0 Wrapper6: VAST 3.0 Wrapper |
ext | any | 拡張領域 |
Data Request
位置: assets[].data / Native Ads 1.2 の Data Request オブジェクト
Data オブジェクト
Bid Requestに設定
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
type | integer | ✓ | Data Asset Type。Ad Generation 独自の 501〜503 はインフォメーションアイコンを参照。 値: 1: sponsored : text2: desc : text3: rating : number formatted as string4: likes : number formatted as string5: downloads : number formatted as string6: price : number formatted as string7: saleprice : number formatted as string8: phone : formatted string9: address : text10: desc2 : text11: displayurl : text12: ctatext : text501: accompanying_text : text502: optout_url : text503: information_icon_url : text例: 1 |
len | integer | 最大文字列長 例: 30 | |
ext | Event Trackers Request Ext | 拡張領域 |
Native 1.2 Response
DSP が bid.adm に文字列で入れて返す Native Ads 1.2 のレスポンスです。
Native Markup Response
位置: (root), native / Native Ads 1.2 の Native Markup Response オブジェクト
seatbid.bid.adm に JSON 文字列として入れる Native Ads 1.2 のレスポンス。
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
ver | string | 準拠している仕様のバージョン 例: "1.2" | |
assets | array of Asset Response | ✓ | Asset の配列。 |
link | Link Response | ✓ | クリックされたときの遷移先。 |
imptrackers | array of string | インプビーコンURLの配列 1x1のimageかHTTP Status 204を返すものであるべき 例: ["http://example.jp/imptrackers/v1/hoge?foo=bar"] | |
jstracker | string | JavaScriptによるインプレッショントラッカーの配列 | |
eventtrackers | array of Event Tracker Response | イベントトラッカーの配列。 | |
privacy | string | ユーザーにターゲティングについて案内するページの URL。インフォメーションアイコンのオプトアウトページに使う。詳しくはインフォメーションアイコンを参照。 |
Native Wrapper
位置: (root)
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
native | Native Markup Response | ✓ | Native 1.2 のレスポンスを {"native": {...}} で包んだもの。包まない形も受け付ける。 IAB拡張 |
Asset Response
位置: assets[] / Native Ads 1.2 の Asset Response オブジェクト
Asset オブジェクト
Bid Responseに設定
Bid requestのAsset objectに対応するasset
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
id | integer | ✓ | ユニークなID Bid RequestのAssetと対応するように設定する 例: 1 |
required | integer | このAssetが必須か否か 値: 0: 必要ない1: 必要 | |
title | Title Response | タイトルの Asset。 | |
img | Image Response | 画像の Asset。 | |
video | Video Response | 動画の Asset。 | |
data | Data Response | データ(説明文、広告主名など)の Asset。 | |
link | Link Response | 未対応。ルートの link だけに対応している。 | |
ext | any | 拡張領域 |
Link Response
位置: link, assets[].link / Native Ads 1.2 の Link Response オブジェクト
Link オブジェクト
Bid Responseに設定
クリックされた際のリンク先を示す
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
url | string | ✓ | 遷移先URL 例: "http://example.com/ad-generation/" |
clicktrackers | array of string | 3rd PartyのclickトラッキングURL | |
fallback | string | Fallback URL | |
ext | any | 拡張領域 |
Event Tracker Response
位置: eventtrackers[] / Native Ads 1.2 の Event Tracker Response オブジェクト
イベントトラッカー。
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
event | integer | ✓ | イベントのタイプ 値: 1: Impression2: Visible impression using MRC definition at 50% in view for 1 second.3: 100% in view for 1 second (ie GroupM standard)4: Visible impression for video using MRC definition at 50% in view for 2 seconds例: 1 |
method | integer | ✓ | トラッキングの方法。 値: 1: Image-pixel tracking - URL provided will be inserted as a 1x1 pixel at the time of the event.2: Javascript-based tracking - URL provided will be inserted as a js tag at the time of the event.例: 1 |
url | string | 画像または JavaScript の URL。 | |
customdata | map of string | トラッカーに渡す任意のデータ。 | |
ext | Event Tracker Response Ext | 拡張領域 |
Event Tracker Response Ext
位置: eventtrackers[].ext
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
vendorKey | string | OM SDK の計測を行う事業者のキー(例: company.com-omid)。 IAB拡張 | |
verification_parameters | string | OM SDK の計測に渡す追加のパラメータ。 IAB拡張 |
Title Response
位置: assets[].title / Native Ads 1.2 の Title Response オブジェクト
Title オブジェクト
Bid Responseに設定
RequestのTitleオブジェクトに対応
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
text | string | ✓ | タイトル文字列 例: "スマホ広告収益最大化SSPツール - Ad Generation(アドジェネ)"例: "Ad Generation automatically maximize the revenue." |
ext | any | 拡張領域 |
Image Response
位置: assets[].img / Native Ads 1.2 の Image Response オブジェクト
Image オブジェクト
Bid Responseに設定
RequestのImageオブジェクトに対応
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
url | string | ✓ | 画像URL 例: "https://example.com/wp-content/themes/scaleout/images/ad_logo.png" |
w | integer | ✓ | 画像の幅(ピクセル) 例: 230 |
h | integer | ✓ | 画像の高さ(ピクセル) 例: 45 |
ext | any | 拡張領域 |
Video Response
位置: assets[].video / Native Ads 1.2 の Video Response オブジェクト
Video オブジェクト
Bid Responseに設定
RequestのVideoオブジェクトに対応
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
vasttag | string | ✓ | VAST xml 例: "<VAST version=\"3.0\">...</VAST>" |
Data Response
位置: assets[].data / Native Ads 1.2 の Data Response オブジェクト
Data オブジェクト
Bid Responseに設定
RequestのDataオブジェクトに対応
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
label | string | Data Asset Type の名前。 IAB拡張 | |
value | string | ✓ | フォーマット済み文字列 例: "詳細はこちら"例: "more info" |
ext | any | 拡張領域 |
Native 1.0.0.2 Request
imp.native.request に文字列で入る Native Ads 1.0.0.2 のリクエストです。
Native Ad Markup Request
位置: (root)
imp.native.request に JSON 文字列として入る Native Ads 1.0.0.2 のリクエスト。{"native": {...}} で包む。
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
native | Native Markup Request | ✓ | Native オブジェクト。 |
Native Markup Request
位置: (root), native / Native Ads 1.0.0.2 の Native Markup Request オブジェクト
Native オブジェクト
Bid Requestに設定され、入札されるnative広告の情報が定義されている。
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
ver | string | 準拠している仕様のバージョン 例: "1.0.0.2" | |
layout | integer | ✓ | ネイティブ広告のレイアウト ID(Native Ads 1.0 の Native Layout IDs)。 値: 1: Content Wall2: App Wall3: News Feed4: Chat List5: Carousel6: Content Stream7: Grid adjoining the content例: 3 |
plcmtcnt | integer | ✓ | 広告枠に入れられる広告の数。最大でこの数まで Bid Response に広告を含められる。 例: 1 |
assets | array of Asset Request | ✓ | Asset の配列。入札は各 Asset の条件に沿うこと。 |
ext | any | 拡張領域。 |
Asset Request
位置: assets[] / Native Ads 1.0.0.2 の Asset Request オブジェクト
Asset オブジェクト
Bid Requestに設定
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
id | integer | ✓ | Asset のユニークな ID。連番とは限らない。 例: 1 |
required | integer | この Asset が必須かどうか。 値: 0: 不要1: 必要例: 0 | |
title | Title Request | タイトルの Asset。 | |
img | Image Request | 画像の Asset。 | |
video | Video Request | 動画の Asset。 | |
data | Data Request | データ(説明文、広告主名など)の Asset。 | |
ext | any | 拡張領域。 |
Title Request
位置: assets[].title / Native Ads 1.0.0.2 の Title Request オブジェクト
Title オブジェクト
Bid Requestに設定
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
len | integer | ✓ | タイトル文字列の最大長 例: 10 |
ext | any | 拡張領域 |
Image Request
位置: assets[].img / Native Ads 1.0.0.2 の Image Request オブジェクト
Image オブジェクト
Bid Requestに設定
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
type | integer | 画像の Asset Type(Native Ads 1.0 の Image Asset Types)。 値: 1: Icon アイコン画像3: Main ワイドフォーマットで表示するような画像例: 3 | |
wmin | integer | 画像の最小幅(ピクセル) 例: 32 | |
hmin | integer | 画像の最小高さ(ピクセル) 例: 32 | |
mimes | array of string | 許容できるMIMEタイプのホワイトリスト 未定義あるいは空配列の場合、すべて許容できることを示す 例: ["image/jpeg"] | |
ext | any | 拡張領域 |
Video Request
位置: assets[].video / Native Ads 1.0.0.2 の Video Request オブジェクト
Video オブジェクト
Bid Requestに設定
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
mimes | array of string | 許容できるMIMEタイプのホワイトリスト 例: ["video/mp4"] | |
minduration | integer | ✓ | 最小再生時間(秒) 例: 30 |
maxduration | integer | ✓ | 最大再生時間(秒) 例: 60 |
protocols | array of integer | ✓ | Video Protocolコードの配列(OpenRtbのVideo Bid Response Protocols参照) 値: 1: VAST 1.02: VAST 2.03: VAST 3.04: VAST 1.0 Wrapper5: VAST 2.0 Wrapper6: VAST 3.0 Wrapper |
ext | any | 拡張領域 |
Data Request
位置: assets[].data / Native Ads 1.0.0.2 の Data Request オブジェクト
Data オブジェクト
Bid Requestに設定
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
type | integer | ✓ | Data Asset Type。Ad Generation 独自の 501〜503 はインフォメーションアイコンを参照。 値: 1: sponsored : text2: desc : text3: rating : number formatted as string4: likes : number formatted as string5: downloads : number formatted as string6: price : number formatted as string7: saleprice : number formatted as string8: phone : formatted string9: address : text10: desc2 : text11: displayurl : text12: ctatext : text501: accompanying_text : text502: optout_url : text503: information_icon_url : text例: 1 |
len | integer | 最大文字列長 例: 30 | |
ext | Data Request Ext | 拡張領域 |
Data Request Ext
位置: assets[].data.ext
Data 拡張オブジェクト
Bid Requestに設定
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
default_value | string | レスポンスで返されなかった場合に使われるデフォルト値 ADG拡張 例: "my-default-value123" |
Native 1.0.0.2 Response
DSP が bid.adm に文字列で入れて返す Native Ads 1.0.0.2 のレスポンスです。
Native Ad Markup Response
位置: (root)
seatbid.bid.adm に JSON 文字列として入れる Native Ads 1.0.0.2 のレスポンス。{"native": {...}} で包む。
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
native | Native Markup Response | ✓ | Native オブジェクト。 |
Native Markup Response
位置: native / Native Ads 1.0.0.2 の Native Markup Response オブジェクト
Native オブジェクト
Bid Responseに設定
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
ver | string | 準拠している仕様のバージョン 例: "1.0.0.2" | |
assets | array of Asset Response | ✓ | Asset の配列。 |
link | Link Response | ✓ | クリックされたときの遷移先。 |
imptrackers | array of string | インプビーコンURLの配列 1x1のimageかHTTP Status 204を返すものであるべき 例: ["http://example.jp/imptrackers/v1/hoge?foo=bar"] | |
jstracker | string | JavaScriptによるインプレッショントラッカーの配列 | |
eventtrackers | array of Event Tracker Response | イベントトラッカーの配列。 IAB拡張 |
Asset Response
位置: native.assets[] / Native Ads 1.0.0.2 の Asset Response オブジェクト
Asset オブジェクト
Bid Responseに設定
Bid requestのAsset objectに対応するasset
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
id | integer | ✓ | ユニークなID Bid RequestのAssetと対応するように設定する 例: 1 |
required | integer | このAssetが必須か否か 値: 0: 必要ない1: 必要 | |
title | Title Response | タイトルの Asset。 | |
img | Image Response | 画像の Asset。 | |
video | Video Response | 動画の Asset。 | |
data | Data Response | データ(説明文、広告主名など)の Asset。 | |
ext | any | 拡張領域 |
Link Response
位置: native.link / Native Ads 1.0.0.2 の Link Response オブジェクト
Link オブジェクト
Bid Responseに設定
クリックされた際のリンク先を示す
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
url | string | ✓ | 遷移先URL 例: "http://example.com/ad-generation/" |
clicktrackers | array of string | 3rd PartyのclickトラッキングURL | |
fallback | string | Fallback URL | |
ext | any | 拡張領域 |
Event Tracker Response
位置: native.eventtrackers[] / Native Ads 1.0.0.2 の Event Tracker Response オブジェクト
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
event | integer | ✓ | イベントのタイプ。 |
method | integer | ✓ | トラッキングの方法。 |
url | string | トラッカーの URL。 | |
customdata | map of string | トラッカーに渡す任意のデータ。 | |
ext | Event Tracker Response Ext | 拡張領域。 |
Event Tracker Response Ext
位置: native.eventtrackers[].ext
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
vendorKey | string | OM SDK の計測を行う事業者のキー(例: company.com-omid)。 IAB拡張 | |
verification_parameters | string | OM SDK の計測に渡す追加のパラメータ。 IAB拡張 |
Title Response
位置: native.assets[].title / Native Ads 1.0.0.2 の Title Response オブジェクト
Title オブジェクト
Bid Responseに設定
RequestのTitleオブジェクトに対応
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
text | string | ✓ | タイトル文字列 例: "スマホ広告収益最大化SSPツール - Ad Generation(アドジェネ)"例: "Ad Generation automatically maximize the revenue." |
ext | any | 拡張領域 |
Image Response
位置: native.assets[].img / Native Ads 1.0.0.2 の Image Response オブジェクト
Image オブジェクト
Bid Responseに設定
RequestのImageオブジェクトに対応
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
url | string | ✓ | 画像URL 例: "https://example.com/wp-content/themes/scaleout/images/ad_logo.png" |
w | integer | ✓ | 画像の幅(ピクセル) 例: 230 |
h | integer | ✓ | 画像の高さ(ピクセル) 例: 45 |
ext | any | 拡張領域 |
Video Response
位置: native.assets[].video / Native Ads 1.0.0.2 の Video Response オブジェクト
Video オブジェクト
Bid Responseに設定
RequestのVideoオブジェクトに対応
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
vasttag | string | ✓ | VAST xml 例: "<VAST version=\"3.0\">...</VAST>" |
Data Response
位置: native.assets[].data / Native Ads 1.0.0.2 の Data Response オブジェクト
Data オブジェクト
Bid Responseに設定
RequestのDataオブジェクトに対応
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
label | string | Data Asset Type の名前。 | |
value | string | ✓ | フォーマット済み文字列 例: "詳細はこちら"例: "more info" |
ext | any | 拡張領域 |
付録
カテゴリ
枠のカテゴリ(site.cat / app.cat)とブロックするカテゴリ(bcat)で使う、Ad Generation 独自のカテゴリです。
DSP が指定する対応表で変換して送ることもできます。右端の列は IAB カテゴリへの対応の例です。
| カテゴリ名 | 補足 | Ad Generation のコード | IAB カテゴリ(例) |
|---|---|---|---|
| エンターテイメント | ADG_ent | IAB1 | |
| 自動車・バイク・乗り物 | メーカー、部品、販売 | ADG_car | IAB2 |
| 興信・探偵 | ADG_detective | IAB11 | |
| 情報商材 | ADG_affiliate | IAB3-11 | |
| 通信・プロバイダ・電話 | ADG_com | IAB19-6 | |
| 求人・キャリア | 就職・転職・アルバイト、人材派遣 | ADG_job | IAB4 |
| 教育・資格 | 留学、語学、通信教育 | ADG_edu | IAB5 |
| 出産・育児 | ADG_birth | IAB6-7 | |
| 介護・福祉 | ADG_care | IAB6-9 | |
| スポーツ・フィットネス | ADG_sport | IAB17 | |
| 病院 | 一般・大学病院、イメージ訴求等 | ADG_hospital | IAB7 |
| 美容外科 | 二重・ワキガ・豊胸・シワ取り等、医師による手術やサービス全般(レーザーやメスなどの医療器具を使った処方) | ADG_surger | IAB18-1 |
| 審美歯科・レーシック | インプラント・矯正治療や、レーシック等、医師によって施される手術やサービス全般 | ADG_dentistry | IAB7-17 |
| 治験 | ADG_clitrial | IAB7 | |
| 医療機器・医薬品・漢方 | 医療機器メーカー、製薬会社等 | ADG_medical | IAB7 |
| コンプレックス商材(ダイエット・豊胸・除毛・シミ) | ダイエット・豊胸・除毛脱毛・肌改善等、着用・発布・塗る等、体外からの効果を期待する商材 | ADG_compladies | IAB7-45 |
| コンプレックス商材(滋養強壮・体臭・口臭) | 滋養強壮・体臭等、着用・塗る等、体外からの効果を期待する商材 | ADG_compmens | IAB7-31 |
| コンプレックス商材(毛髪・植毛・カツラ) | 毛髪・頭皮・育毛・植毛等、体外からの効果を期待する商材 | ADG_comphair | IAB7 |
| アルコール | ADG_alcohol | IAB8-5 | |
| 食品・飲料 | ADG_food | IAB8 | |
| 趣味・娯楽 | ADG_hobbie | IAB9 | |
| ゲーム(一般) | ADG_game | IAB9-30 | |
| ゲーム(アダルト弱) | 水着、バストアップ、過度な肌露出等。DSP側で振り分け困難であれば対応しなくてOK | ADG_gamexs | IAB25-3 |
| 生活家電・AV機器 | ADG_elec | IAB10-1 | |
| 政治団体 | 特定政党 | ADG_political | IAB11-4 |
| 官庁・自治体・公共団体 | 選挙管理委員会、その他、官庁・自治体・公共団体による訴求 | ADG_org | IAB3-7 |
| 法律 | ADG_legal | IAB11-2 | |
| 生活インフラ | 電気・ガス・水道等のライフライン | ADG_infra | IAB10 |
| ニュース・新聞・出版 | ADG_news | IAB12 | |
| テレビ・ラジオ | ADG_tv | IAB1-7 | |
| 金融(銀行・信用金庫) | ADG_bank | IAB13-2 | |
| 金融(保険) | 生命、損害保険 | ADG_insur | IAB13-6 |
| 金融(長期投資) | 長期投資、証券、ブランディング | ADG_secur | IAB13-8 |
| 金融(短期投資) | 短期投資、FX、先物、投資商品 | ADG_invest | IAB13-11 |
| 金融(ローン・クレジット・消費者金融) | 消費者金融含む | ADG_loan | IAB13-2 |
| SNS・動画 | SNS、動画共有サービス | ADG_sns | IAB14 |
| マッチングアプリ | デート、食事、コミュニティ等のアプリ(omiai、pairs、タップル誕生、dine等) | ADG_dating | IAB14-1 |
| 出会い | 結婚を前提としない出会いサービス(YYC、イククル等) | ADG_datingxs | IAB14-1 |
| 結婚情報 | 大手結婚情報サービス(サンマリエ,ノッツェ、Yahooパートナー等) | ADG_marriage | IAB14-4 |
| 結婚・ブライダル | 結婚式場、ブライダル関連サービス | ADG_bridal | IAB14-4 |
| シニア | ADG_senior | IAB14-5 | |
| 葬祭サービス | ADG_ceremonial | IAB14-7 | |
| ペット | ADG_pets | IAB16 | |
| ファッション / アパレル | ADG_fashion | IAB18-3 | |
| 美容・化粧品(商材) | メイク用品、化粧品等(資生堂、ファンケル、コーセー等) | ADG_cosme | IAB18-1 |
| 美容(サービス) | ヘアサロン・ネイルサロン・エステ等、店舗訴求(ミュゼ、TBC、銀座クリニック等) | ADG_beauty | IAB18-1 |
| 健康食品(コンプレックス) | ダイエット、豊胸、シミ等、体内から改善する商材 | ADG_healcomp | IAB8-12 |
| 健康食品(健康維持・体質改善) | 飲食することで体内から体質改善を促す商材(大塚製薬、山田養蜂場、アサヒ、キリン等) | ADG_healnomal | IAB8-12 |
| ソフトウェア | ソフトウェア、ウイルスソフト、メールサービス等 | ADG_software | IAB19 |
| 電子書籍(一般) | ADG_ebook | IAB1-1 | |
| 電子書籍(アダルト弱) | 水着、バストアップ、過度な肌露出等 | ADG_ebookxs | IAB1-1 |
| 電子書籍(アダルト強) | パンチラ・恥部露出・抱擁等性的表現のあるもの | ADG_ebookx | IAB25-3 |
| 旅行・観光 | ADG_tourism | IAB20 | |
| 不動産 | 分譲・賃貸・新築・リフォーム | ADG_estate | IAB21 |
| 不動産投資 | ADG_rei | IAB21-3 | |
| 総合通販 | 楽天、Yahoo、AMAZON等 | ADG_geneorder | IAB22 |
| クーポン | ADG_coupon | IAB22-2 | |
| 百貨店・小売・商店 | ADG_shop | IAB22 | |
| 比較サービス | ADG_compare | IAB22-3 | |
| ポイント・懸賞 | ADG_point | IAB22-2 | |
| 宗教 | ADG_religion | IAB23 | |
| 占い | ADG_fortune | IAB23-1 | |
| その他 | ADG_others | IAB24 | |
| 公営ギャンブル(宝くじ・TOTO・競技) | 宝くじ・TOTO・競輪・競馬・競艇 | ADG_gamble | IAB9-7 |
| パチンコ・スロット | パチンコ・スロットのホール、機器 | ADG_pachi | IAB9-7 |
| その他ギャンブル | その他、オンラインカジノ等 | ADG_gambleo | IAB9-7 |
| タバコ | ADG_ciga | IAB9-9 | |
| 電子タバコ | ADG_eleciga | IAB9-9 | |
| アダルト | アダルトグッズ、成人向け雑誌等 | ADG_adult | IAB25-3 |
| 高収入・ナイト求人 | キャバクラ・風俗求人、ナイトワーク | ADG_hincome | IAB25-3 |
| 仮想通貨 | 取引所・販売所 | ADG_vcurrency | IAB13-7 |
ネイティブ広告のインフォメーションアイコン
Ad Generation のネイティブ広告には、DSP のオプトアウトページへ案内するインフォメーションアイコンを表示できます。
表示に必要な次の3つの情報を、Ad Generation 独自の Data Asset として Bid Response に含めるか、事前に Ad Generation に伝えてください。Bid Response に含めた値が、事前に伝えた値より優先されるので、案件ごとに切り替えることもできます。
Native 1.2 では、オプトアウトページの URL を標準の privacy で返すこともできます。502 の Data Asset と両方ある場合は 502 を使います。
| Data Asset Type | 内容 |
|---|---|
| 501 | アイコンの横に表示するテキスト |
| 502 | アイコンをクリックしたときに開くオプトアウトページの URL |
| 503 | アイコン画像の URL |
Bid Request では、これらを任意の Data Asset("required": 0)として含めます。インフォメーションアイコンの表示が必須の枠で、オプトアウトページの既定値が無い場合は、502 を必須("required": 1)にします。
501: アイコンの横に表示するテキスト
Bid Request:
{"id": 501, "required": 0, "data": {"type": 501, "len": 22}}
基本的には事業者名かサービス名だけを入れてください。たとえば事業者名が MyDspA なら、Ads by MyDspA ではなく MyDspA とします。
Bid Response に含まれていない場合は事前に伝えられた値を使い、それも無い場合は AD を表示します。
{"id": 501, "data": {"value": "MyDspA"}}
502: オプトアウトページの URL
Bid Request:
{"id": 502, "required": 0, "data": {"type": 502, "len": 2000}}
Bid Response に含まれていない場合は、Native 1.2 の privacy、事前に伝えられた URL の順に使います。どれも無い場合、インフォメーションアイコンは表示されません。
{"id": 502, "data": {"value": "https://dsp1.example/optout.html"}}
503: アイコン画像の URL
Bid Request:
{"id": 503, "required": 0, "data": {"type": 503, "len": 2000}}
アイコン画像は 26x26 ピクセルにしてください。媒体はアイコンの背景を白か黒から選べます(既定は白)。背景が黒で data.ext.black_back がある場合はその画像を、それ以外は data.value の画像を使います。
Bid Response に含まれていない場合は事前に伝えられた画像を使い、それも無い場合は Ad Generation が用意した次の画像を使います。
![]()
{"id": 503, "data": {"value": "https://dsp1.example/icon_white_back.png", "ext": {"black_back": "https://dsp1.example/icon_black_back.png"}}}