Open RTB 2.4 入札リクエスト

このページでは、入札のリクエスト方法を説明します

入札リクエストヘッダー

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

以下のオブジェクトは、リクエスト本文で JSON としてエンコードして送信してください:

入札リクエスト

属性	必須?	説明
で	はい	オークションタイプ、ファーストプライス = 1（int）
id	はい	一意の入札リクエストID（string）
imp	はい	提示されたインプレッションを表す Imp オブジェクトの配列（オブジェクト）。
site	はい	Site オブジェクトを介した、パブリッシャーの Web サイトに関する詳細（object）。
app	はい	公開者のアプリに関する App オブジェクト経由の詳細*（オブジェクト）。
device	はい	インプレッションが配信されるユーザーのデバイスに関する、Device オブジェクトを介した詳細（object）。
user	いいえ	デバイスの人間のユーザー、つまり広告の対象者に関する、User オブジェクトを介した詳細（object）。
ext	いいえ	OpenRTB 拡張のためのプレースホルダー。

オブジェクトは 1 つだけ {site, app} を各リクエストに含める必要があります。

imp

属性	必須?	説明
id	はい	この入札リクエスト内で一意のインプレッションID（string）
bidfloor	いいえ	このインプレッションの最低入札額（CPM）/ クリック（CPC）およびアカウント通貨（float）
bidfloorcur	いいえ	ISO-4217 のアルファコードで指定する最低入札額の通貨（string）
native	native および push の imp のみ	Native オブジェクトの機会（object）。
banner	banner および全画面インタースティシャルの imp のみ	Banner オブジェクトの機会（object）。
instl	pop、ダイレクトリンク、メール、および全画面インタースティシャルのクリック imp のみ	Fullscreen オブジェクトの機会（object）。
video	video のみ	Video オブジェクトの機会（object）
secure	推奨	インプレッションが、HTTPS の安全な URL のクリエイティブ素材とマークアップを必要とするかどうかを示すフラグ。0 = 非安全、1 = 安全（推奨オプション）。省略された場合、安全状態は不明ですが、非安全な HTTP のサポートがあると見なせます（整数）
el	いいえ	Base64 でエンコードされたメールアドレス（string）
ext	いいえ	取引所固有の拡張のためのプレースホルダー

imp.banner

属性	必須?	説明
w	はい	バナーの幅（整数）
h	はい	バナーの高さ（整数）
mimes	いいえ	サポートされる MIME タイプのリスト（string 配列）。対応: image/jpeg, image/jpg, image/png, image/png, image/gif, image/webp, video/mp4
ext	いいえ	取引所固有の拡張のためのプレースホルダー（object）

imp.banner.ext

属性	必須?	説明
image_output	いいえ	画像バナーの出力形式を示します*（string）
video_output	いいえ	動画バナーの出力形式を示します*（string）

* バナーフォーマットの adm フィールドの形式を定義します。選択肢は xml または html です。フィールドが指定されていない場合のデフォルト値は xml です。

imp.instl

属性	必須?	説明
instl	はい	0 = ダイレクトリンク/メールのクリック、1 = ポップアンダー/全画面インタースティシャル

imp.native（Native および Push Notification 広告向け）

属性	必須?	説明
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	いいえ	このレイアウトにおける同一配置の数。最大: 10（整数）（整数）
assets	はい	の配列 アセットオブジェクト。任意の入札レスポンスは、入札リクエストで示された要素の配列に準拠する必要があります（JSON オブジェクトの配列）
seq	いいえ	1つ目の広告は0、2つ目の広告は1、その後も同様です。これは通常 plcmtcnt と組み合わせて使用されることはありません。複数の同一プレースメントをオークションにかける場合（この場合 plcmtcnt>1、seq=0）か、フィード内の個別アイテムごとに別々のオークションを行う場合（この場合 plcmtcnt=1、seq=>=1）のいずれかです。

imp.native.request.assets

属性	必須?	説明
id	はい	取引所によって割り当てられる一意のアセット ID。通常は配列のカウンター（整数）1: 画像アセット ID、2: タイトルアセット ID、3: 説明アセット ID
required	いいえ	次に設定 1 アセットが必須の場合、または 0 アセットが任意の場合（整数）
plcmtcnt	いいえ	このレイアウト内の同一プレースメント数（integer）
img	はい	画像アセット用の Image オブジェクト**（JSON オブジェクト）
title	いいえ	タイトルアセット用の Title オブジェクト**（JSON オブジェクト）
data	いいえ	ブランド名、説明、評価、価格などのための Data オブジェクト*（JSON オブジェクト）

* Native リクエストで受信する入札数は、"plcmtcnt" に設定した値に基づきます。たとえば、"plcmtcnt":3 の入札リクエストでは、3 つの異なる bid オブジェクトが返されます。これの例は レスポンス例ページ.

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

imp.native.request.assets.img

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

*Push Notification アイコンの寸法: 192px x 192px

imp.native.request.assets.title

属性	必須?	説明
len	はい	タイトル要素内テキストの最大長。（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" を指定しない場合、動画はその再生時間にかかわらずスキップ可能になります。

imp.ext

属性	必須?	説明
video_cta	いいえ	CTA を提供するかどうかを示します。0 = いいえ、1 = はい（デフォルト 1）

CTA の例を見るには、こちらを確認してください レスポンス例ページ.

site

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

site.ext

属性	必須?	説明
exchangecat	いいえ	カスタム ExoClick カテゴリ ID（integer）
idzone	いいえ	カスタム ExoClick 広告ゾーン ID（integer）

app

属性	必須?	説明
id	必須	一意の App ID（string）
cat	いいえ	IAB カテゴリ ID（文字列配列）
keywords	いいえ	キーワードは、広告枠に適切な種類の広告を配信するために使用できます。キーワードは、カンマ区切りの単語列である必要があります（string）
publisher	いいえ	公開者に関する詳細（object）

app.publisher

属性	必須?	説明
domain	推奨	公開者の最上位ドメイン（例: "publisher.com"）（string）

device

属性	必須?	説明
ua	はい	ブラウザーのユーザーエージェント（string）
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 のどちらか一方だけを含めればよく、両方は不要です。ipv6 を使う場合は ip 属性を削除し、その逆も同様です。両方を含めるとエラーの原因になります。

device.geo

属性	必須?	説明
country	いいえ	国の ISO3 コード

device.ext

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

user

属性	必須?	説明
id	はい	一意のユーザー ID（string）

ユーザー ID 文字列を生成できない場合は、空（""）のままにできます。リクエストに "user" オブジェクトが含まれていれば、リクエストは応答を受け取れます。

ext

属性	必須?	説明
sub	いいえ	Sub ID。これは 1 〜 10 桁の数字である必要があります。Sub ID の先頭に 0 を使用しないでください。
export	いいえ	レスポンス形式は "json" または "xml" にできます（string）。デフォルトは "json" です。

例

リクエスト例の詳細な一覧は、こちらで確認できます 例のページ