Open RTB 2.5 入札リクエスト

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

推奨されるBidリクエストヘッダー

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

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

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

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

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

imp

属性	必須?	説明
id	はい	この入札リクエスト内で一意のインプレッションID（string）
bidfloor	いいえ	このインプレッションの最低入札額（CPM）/クリック（CPC）とアカウント通貨（float）。
banner	フルページのインプレッションのみ	バナーオブジェクト（オブジェクト）。
secure	いいえ; 推奨 1	インプレッションに安全な HTTPS URL のクリエイティブアセットとマークアップが必要かを示すフラグ。0 = 非セキュア、1 = セキュア。省略した場合、セキュア状態は不明ですが、非セキュアな HTTP のサポートはあるものと見なせます。任意（integer）

imp.banner

属性	必須?	説明
w	はい	バナーの幅（整数）
h	はい	バナーの高さ（整数）
mimes	はい	MIMEタイプ - image/jpg、image/png、video/mp4、またはimage/webp

imp.video

属性	必須?	説明
mimes	はい	サポートされるコンテンツMIMEタイプ（例: "video/mp4"）（文字列配列）
minduration	いいえ	最小動画広告再生時間（秒）（整数）
maxduration	いいえ	最大動画広告再生時間（秒）（整数）
protocols	いいえ	サポートされる動画プロトコルの配列（整数）
linearity	いいえ	インプレッションがリニア、ノンリニアなどである必要があるかを示します。指定がない場合は、すべて許可されているものと見なします（整数）
boxingallowed	いいえ	4:3コンテンツを16:9ウィンドウにレターボックス表示することが許可されるかを示します。0 = いいえ、1 = はい（整数）
pos	いいえ	画面上の広告位置（整数）
h	いいえ	デバイス非依存ピクセル（DIPS）単位の動画プレーヤーの幅（整数）
w	いいえ	デバイス非依存ピクセル（DIPS）単位の動画プレーヤーの高さ（整数）
ext	いいえ	OpenRTBへの交換事業者固有の拡張のためのプレースホルダー（オブジェクト）

imp.video.ext

属性	必須?	説明
zone_type	いいえ	ExoClickの広告フォーマット内のゾーンタイプ（例: video_slider）
cta	いいえ	広告ゾーンにCTAコンポーネントを表示するかどうかを指定します（整数）

site

属性	必須?	説明
id	推奨	一意の Site ID（string）
name	いいえ	サイト名（文字列）
domain	推奨	サイトのドメイン名（string）
cat	いいえ	IAB カテゴリ ID（文字列配列）
page	推奨	広告が表示されるページの完全な URL（string）
keywords	いいえ	キーワードを使用すると、広告ゾーンに適切な種類の広告を表示させることができます。キーワードはカンマ区切りの単語列である必要があります

site.ext

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

app

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

device

属性	必須?	説明
ua	はい	ブラウザーのユーザーエージェント（string）
sua	いいえ	構造化されたユーザーエージェント情報。クライアントが User-Agent Client Hints をサポートしている場合に使用できます（object）
geo	いいえ	Geo オブジェクトで定義される、ユーザーの現在位置と見なされるデバイスの位置。
ip	はい	ユーザーのIPv4アドレス（文字列）*
ipv6	はい	ユーザーの IPv6 アドレス（string）*
language	推奨	ブラウザの言語（文字列）
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）

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ヘッダーから導出する必要があります。（整数）
architecture	推奨	実装者はこの値をSec-CH-UA-Archヘッダーから取得する必要があります。（文字列）
bitness	推奨	実装者はこの値をSec-CH-UA-Bitnessヘッダーから取得する必要があります。（文字列）
model	推奨	実装者はこの値をSec-CH-UA-Modelヘッダーから取得する必要があります。（文字列）
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	いいえ	OpenRTBへの交換事業者固有の拡張のためのプレースホルダー（オブジェクト）

user.ext

属性	必須?	説明
consent	いいえ	これはIAB標準で要求される同意文字列です。現時点ではネガティブ同意のみ（文字列）

regs

属性	必須?	説明
ext	いいえ	OpenRTBへの交換事業者固有の拡張のためのプレースホルダー（オブジェクト）

regs.ext

属性	必須?	説明
gdpr	いいえ	これは、呼び出し元がユーザーがGDPR対象ではないと判断した場合は0、ユーザーがGDPR対象である場合は1です。どちらでもない場合、このパラメータは未定義になります。

ext

属性	必須?	説明
sub	いいえ	Sub ID。これは 1 〜 10 桁の数字である必要があります。Sub ID の先頭に 0 を使用しないでください。