Open RTB 2.4 入札リクエスト

このページでは、入札を行うために受け取る RTB リクエストのさまざまな構成要素について説明します。

入札リクエストヘッダー

• OpenRTB バージョン HTTP ヘッダー: x-openrtb-version: 2.4
• Keep-Alive HTTP ヘッダー: Connection: Keep-Alive
• コンテンツ JSON: Content-Type: application/json
• データエンコーディングヘッダー: Accept-Encoding

入札リクエストオブジェクト

特定のコンテキストで入札を要求する場合、プラットフォームはタイムアウト 300ms で HTTP リクエストを実行し、次のオブジェクトを JSON としてエンコードしてリクエスト本文に送信します。 HTTP HTTPS を使用すると追加の遅延が発生するため推奨されます。

属性	説明
で	オークションタイプ、ファーストプライス = 1（int）
id	一意の入札リクエストID（string）
imp	提示されるインプレッションを表すオブジェクト（object）。
site	Site オブジェクトを介した、パブリッシャーの Web サイトに関する詳細（object）。
device	インプレッションが配信されるユーザーのデバイスに関する、Device オブジェクトを介した詳細（object）。
user	デバイスの人間のユーザー、つまり広告の対象者に関する、User オブジェクトを介した詳細（object）。
ext	取引所固有の拡張用プレースホルダー。

imp

属性	説明
id	この入札リクエスト内で一意のインプレッションID（string）
bidfloor	このインプレッションの最小入札額（CPM）/ クリック単価（CPC）およびアカウント通貨、任意（float）。
bidfloorcur	ISO-4217 の英字コードで指定する最小入札額の通貨、任意（string）
native	Native オブジェクト。 このインプレッションがネイティブ広告枠として提供される場合は必須（object）。
banner	banner オブジェクト。 このインプレッションがバナー広告枠として提供される場合は必須（object）。
instl	インタースティシャルオブジェクト。 このインプレッションがインタースティシャルまたはポップアンダー広告枠として提供される場合は必須（object）。(object).
secure	インプレッションに安全な HTTPS URL のクリエイティブアセットとマークアップが必要かを示すフラグ。0 = 非セキュア、1 = セキュア。省略した場合、セキュア状態は不明ですが、非セキュアな HTTP のサポートはあるものと見なせます。任意（integer）
el	Base64 でエンコードされたメールアドレス（string）

imp.banner

属性	説明
w	バナーの幅（ピクセル単位）（integer）。
h	バナーの高さ（ピクセル単位）（integer）。
mimes	サポートされる MIME タイプ。例: image/jpg、image/png、video/mp4、image/webp。

imp.instl

属性	説明
instl	広告がポップアンダー/インタースティシャルかを示すフラグ（integer）：1=true、0=false

imp.native（ネイティブ & プッシュ通知）

属性	説明
request	Native Ad Specification に準拠したリクエストペイロード - JSON でエンコードされた文字列 Native Ads リクエストの、以下を含む native トップレベルオブジェクト（JSON オブジェクト）
ver	Dynamic Native Ads API のバージョン。 request 準拠します（string）

imp.native.request

属性	説明
ver	使用中の Native Markup バージョン（string）
context	広告が表示されるコンテキスト。この場合は 1 (ニュースフィード、記事、画像ギャラリー、動画ギャラリーなどのコンテンツ中心のコンテキスト）、任意（integer）
plcmttype	提供される広告ユニットのデザイン/形式/レイアウト。現在サポートしているのは 4 (おすすめウィジェット）および 500 (プッシュ通知）（integer）
plcmtcnt	このレイアウト内の同一プレースメント数（integer）
assets	の配列 アセットオブジェクト。任意の入札レスポンスは、入札リクエストで示された要素の配列に準拠する必要があります（JSON オブジェクトの配列）
seq	1つ目の広告は0、2つ目の広告は1、その後も同様です。これは通常 plcmtcnt と組み合わせて使用されることはありません。複数の同一プレースメントをオークションにかける場合（この場合 plcmtcnt>1、seq=0）か、フィード内の個別アイテムごとに別々のオークションを行う場合（この場合 plcmtcnt=1、seq=>=1）のいずれかです。

imp.native.request.assets

属性	説明
id	取引所によって割り当てられる一意のアセットID。通常は配列のカウンター（integer）
required	次に設定 1 アセットが必須の場合、または 0 アセットが任意の場合**（integer）
plcmtcnt	このレイアウト内の同一プレースメント数（integer）
img	画像アセット用の Image オブジェクト*（JSON オブジェクト）
title	タイトルアセット用の Title オブジェクト*（JSON オブジェクト）
data	ブランド名、説明、評価、価格などのための Data オブジェクト*（JSON オブジェクト）
video	動画アセット用の Video オブジェクト。Video リクエストオブジェクトの定義を参照してください。なお、インストリーム（つまり preroll など）の動画広告は Native の一部ではありません。Native 広告には、広告クリエイティブ自体として動画を含めることができます（object）。

* 各アセットオブジェクトには {img, title, data} のいずれか 1 つだけを含める必要があります

** アセットは、広告が表示される可能性のあるパブリッシャーゾーンの設定に応じて必須としてフラグ付けされます

imp.native.request.assets.img

属性	説明
type	パブリッシャーがサポートする画像要素のタイプID。サポートしているのは: 1 (アイコン画像）（integer）、 3 (広告用の大きな画像プレビュー）（integer）
w	画像の幅（ピクセル単位）、任意（integer）
h	画像の高さ（ピクセル単位）、任意（integer）
wmin	画像の最小要求幅（ピクセル単位）（integer）
hmin	画像の最小要求高さ（ピクセル単位）（integer）

imp.native.request.assets.title

属性	説明
len	タイトル要素内テキストの最大長。（integer）

imp.native.request.assets.video

属性	説明
mimes	サポートされる MIME タイプの一覧（文字列配列）。
minduration	動画広告の最小再生時間（秒）（integer）。
maxduration	動画広告の最大再生時間（秒）（integer）。
protocols	サポートされる動画入札レスポンスプロトコルの一覧（integer 配列）。
linearity	インプレッションがリニア、ノンリニアなどである必要があるかを示します（integer）。
boxingallowed	4:3 コンテンツを 16:9 ウィンドウにレターボックス表示することが許可されるかを示します（integer）。

imp.native.request.assets.data

属性	説明
type	パブリッシャーがサポートする要素のタイプID（integer）。サポートしているのは: 1 (sponsored - Sponsored By メッセージ。レスポンスにはスポンサーのブランド名を含める必要があります), 2 (desc - 広告される製品またはサービスに関連する説明テキスト)
len	要素のレスポンス内テキストの最大長（integer）

imp.video

属性	説明
mimes	サポートされる mime タイプの一覧（文字列配列）
protocols	サポートされる動画入札レスポンスプロトコルの一覧（int 配列）
skip	プレーヤーが動画のスキップを許可するかを示します。0 = いいえ、1 = はい
skipafter	スキップが有効になるまでに動画を再生する秒数。広告がスキップ可能な場合にのみ適用されます
skipmin	合計再生時間がこの秒数を超える動画はスキップ可能にできます。広告がスキップ可能な場合にのみ適用されます

パブリッシャーがリクエストで「skip」を指定しているが「skipafter」を指定していない場合、動画は 5 秒後にスキップ可能になります。レスポンスでは「skipoffset」が 5 に設定されます。 パブリッシャーが「skip」を指定しているが「skipmin」を指定していない場合、動画は再生時間に関係なくスキップ可能になります。

site

属性	説明
id*	一意の Site ID（string）
domain*	サイトのドメイン名（string）
cat	IAB カテゴリ ID（文字列配列）
page	広告が表示されるページの完全な URL（string）
keywords	キーワードを使用すると、広告ゾーンに適切な種類の広告を表示させることができます。キーワードはカンマ区切りの単語列である必要があります
ext	OpenRTB の取引所固有拡張用プレースホルダー。

*これらの属性は、Direct Link および Email Clicks 形式では必須です。

site.ext

属性	説明
exchangecat	カスタム ExoClick カテゴリ ID（integer）
idzone	カスタム ExoClick 広告ゾーン ID（integer）
keyword	一致するキーワードがある場合（string）

idzone 属性は、トラフィックの流入元となる ExoClick のソースを識別するために使用されます。

device

属性	説明
ua	ブラウザーのユーザーエージェント（string）
sua	構造化されたユーザーエージェント情報。クライアントが User-Agent Client Hints をサポートしている場合に使用できます（object）
geo	Geo オブジェクトで定義される、ユーザーの現在位置と見なされるデバイスの位置。
ip	ユーザーの IP アドレス（string）*
ipv6	ユーザーの IPv6 アドレス（string）*
language	ISO-639-1 alpha-2 によるブラウザー言語（string）
os	オペレーティングシステム（string）
js	JavaScript のサポート。0 = いいえ、1 = はい（integer）
ext	OpenRTB の取引所固有拡張用プレースホルダー

*入札リクエストには ip または ipv6 のどちらか一方のみが含まれます。

device.geo

属性	説明
country	国の ISO3 コード

device.ext

属性	説明
remote_addr	ユーザーのメイン IP アドレス（string）
x_forwarded_for	ユーザーの X-FORWARDED-FOR IP アドレス。未設定の場合は空（string）

device.sua

構造化された User Agent 情報。 device.sua デバイス属性をより正確に表すものと見なされます。

属性	説明
browsers	Sec-CH-UA-Full-Version-List ヘッダーから取得したブランドとバージョンを送信します。（ BrandVersion オブジェクトの配列）
platform	Sec-CH-UA-Platform ヘッダーから取得したブランドと、Sec-CH-UA-Platform-Version ヘッダーから取得したバージョンを送信します。(BrandVersion オブジェクト）
mobile	この値は Sec-CH-UA-Mobile ヘッダーから取得します。（integer）
architecture	この値は Sec-CH-UA-Arch ヘッダーから取得します。（string）
bitness	この値は Sec-CH-UA-Bitness ヘッダーから取得します。（string）
model	この値は Sec-CH-UA-Model ヘッダーから取得します。（string）
source	このオブジェクトの作成に使用されたデータのソース、 一覧: User-Agent ソース AdCOM 1.0 の中で（integer; デフォルト 0）

device.sua.browsers | device.sua.platform

属性	説明
brand	この値は User-Agent Client Hints ヘッダーから取得される場合があり、ユーザーエージェントのブランド（Sec-CH-UA-Full-Version ヘッダー由来）またはプラットフォームのブランド（Sec-CH-UA-Platform ヘッダー由来）のいずれかを表します。（string）
version	バージョン要素の並び。階層の降順 [major, minor, micro, …]（文字列配列）

user

属性	説明
id	一意のユーザー ID（string）

ext

属性	必須?	説明
sub	いいえ	sub は、リクエストの発生元ゾーンの ID を表す整数値になります。

regs.ext

属性	説明
dsaapply	DSA がリクエストに適用されるかを示すフラグ。1 = 必須（int）
dsa	DSA 透明性情報の拡張（object）

regs.ext.dsa

属性	説明
required	DSA 情報を利用可能にするかを示すフラグ。0 = 不要、1 = サポートされる、DSA オブジェクトの有無にかかわらず入札レスポンスは受け入れられます、2 = 必須、DSA オブジェクトのない入札レスポンスは受け入れられません、3 = 必須、DSA オブジェクトのない入札レスポンスは受け入れられません。パブリッシャーはオンラインプラットフォームです（int）
datatopub	パブリッシャーは監査目的で透明性データを必要とする場合があります。0 = 透明性データを送信しない、1 = 透明性データの送信は任意、2 = 透明性データを送信する（int）

次を受け取った場合 dsaapply: 1 と required: 2 または 3、レスポンスに値付きの dsa 属性を追加することが必須です。そうしないとレスポンスは拒否されます。

例

受信可能なすべてのリクエスト種類の完全な一覧は、次のページで確認できます。 Advertiser Request のサンプルページ.