このページでは、入札のために受け取るRTBリクエストのさまざまな構成要素について説明します。
入札依頼ヘッダー
- OpenRTBバージョンHTTPヘッダー: x-openrtb-version: 2.4
- キープアライブHTTPヘッダ:接続:キープアライブ
- コンテンツJSON:Content-Type: application/json
- データエンコーディングヘッダー:Accept-Encoding
入札依頼
特定のコンテキストの入札を要求する場合、プラットフォームは300msのタイムアウトでHTTPリクエストを実行し、リクエストボディにJSONとしてエンコードされた以下のオブジェクトを送信します。 HTTPSを使用すると余分な待ち時間が発生するため、HTTP**を推奨します。
| 属性 | 説明 |
|---|
| で | オークションタイプ、最初の価格 = 1 (int) |
| アイドル | 入札依頼ID(文字列) |
| 小悪魔 | 提供された印象を表すオブジェクト(object)。 |
| サイト | パブリッシャーのウェブサイト(オブジェクト)に関するSiteオブジェクト経由の詳細。 |
| 装置 | インプレッションが配信されるユーザーのデバイスに関するDeviceオブジェクトを介した詳細(オブジェクト)。 |
| ユーザー | Userオブジェクトを介して、デバイスの人間ユーザーに関する詳細、広告オーディエンス(オブジェクト)。 |
| エクステンド | 取引所固有の拡張のためのプレースホルダ。 |
小悪魔
| 属性 | 説明 |
|---|
| アイドル | この入札リクエスト内でユニークなインプレッションID(文字列) |
| ビッドフロア | このインプレッション(CPM)/クリック(CPC)およびアカウント通貨(オプション)の最低入札価格(フロート)。 |
| ビッドフロアカー | ISO-4217アルファコードで指定された最低入札価格の通貨、オプション(文字列) |
| ネイティブ | このインプレッションがネイティブ広告の機会(オブジェクト)として提供される場合は、ネイティブオブジェクトが必要です。 |
| バナー | このインプレッションがバナー広告の機会(オブジェクト)として提供される場合は、バナーオブジェクトが必要です。 |
| インスタ | このインプレッションがインタースティシャル広告またはポップアンダー広告の機会として提供される場合は、インタースティシャル・オブジェクトが必要です。 |
| セキュア | インプレッションがセキュアなHTTPS URLクリエイティブアセットとマークアップを必要とするかどうかを示すフラグで、0 = 非セキュア、1 = セキュア。省略された場合、セキュアな状態は不明ですが、非セキュアなHTTPサポートを想定することができます。 |
| エル | Base64 エンコードされた電子メール (文字列) |
インプバナー
| 属性 | 説明 |
|---|
| w | バナーの幅をピクセル単位で指定する (整数)。 |
| h | バナーの高さをピクセル単位で指定 (整数)。 |
| マイムズ | サポートするMIMEタイプ。例:image/jpg、image/png、video/mp4、image/webp。 |
インプル
| 属性 | 説明 |
|---|
| インスタ | 広告がポップアンダーかインタースティシャルかを指定するフラグ (整数):1=true、0=false。 |
imp.native(ネイティブ&プッシュ通知)
| 属性 | 説明 |
|---|
| リクエスト | ネイティブアド仕様に準拠したリクエストペイロード - ネイティブトップレベルオブジェクト(JSONオブジェクト)を含むネイティブアドのリクエストのJSONエンコード文字列。 |
| ver | リクエスト**が準拠するDynamic Native Ads APIのバージョン (文字列) |
インプ.ネイティブ.リクエスト
| 属性 | 説明 |
|---|
| ver | 使用中のネイティブ・マークアップのバージョン(文字列) |
| コンテキスト | 広告が表示されるコンテキスト。この場合、1(ニュースフィード、記事、画像ギャラリー、動画ギャラリーなどのコンテンツ中心のコンテキスト)で、オプション(整数)です。 |
| プリセプタータイプ | 提供する広告ユニットのデザイン/フォーマット/レイアウト。現在、4(レコメンドウィジェット)と500(プッシュ通知)(整数)をサポートしています。 |
| プランクトン | このレイアウトにおける同一配置の数 (integer) |
| 資産 | アセットオブジェクト**の配列。入札レスポンスは、入札リクエストで表現された要素の配列(JSONオブジェクトの配列)に従わなければなりません。 |
| シーク | 最初の広告には0、2番目の広告には1というように。これは一般的に plcmtcnt と組み合わせて使用することはできません。複数の同じプレースメントをオークションにかける (plcmtcnt>1, seq=0 の場合) か、フィード内の個別のアイテムに対して個別のオークションを行う (plcmtcnt=1, seq=>=1 の場合) かのどちらかです。 |
インプ.ネイティブ.リクエスト.アセット
| 属性 | 説明 |
|---|
| アイドル | 取引所が割り当てる、一意のアセット ID。通常は配列のカウンタ (整数)。 |
| 必須 | アセットが必須の場合は1に、アセットがオプションの場合は0に設定する (整数) |
| プランクトン | このレイアウトにおける同一配置の数 (integer) |
| イムグ | 画像アセット用のImageオブジェクト* (JSONオブジェクト) |
| タイトル | タイトル資産用のタイトル・オブジェクト(JSONオブジェクト) |
| データ | ブランド名、説明、評価、価格などのデータオブジェクト。 |
| ビデオ | ビデオアセット用のビデオオブジェクト。Videoリクエストオブジェクトの定義を参照してください。インストリーム(プレロールなど)動画広告は、ネイティブの一部ではないことに注意してください。Native 広告には、広告クリエイティブ自体(オブジェクト)として動画を含めることができます。 |
* 各アセットオブジェクトには、{img, title, data} オブジェクトのうち1つだけが存在する必要があります。
** 広告が表示されるパブリッシャーゾーンの設定に従って、アセットは必要に応じてフラグが立て られる。
imp.native.request.assets.img
| 属性 | 説明 |
|---|
| タイプ | パブリッシャーがサポートする画像要素のタイプID。サポートしています: 1 (アイコン画像) (integer), 3 (広告の大きな画像プレビュー) (integer) |
| w | 画像の幅。ピクセル単位で指定します(整数)。 |
| h | 画像の高さ(ピクセル単位)、オプション(整数 |
| ウーミン | ピクセル単位で指定する、画像の幅の最小値 (integer) |
| フミン | ピクセル単位で指定する、画像の高さの最小値 (integer) |
imp.native.request.assets.title
| 属性 | 説明 |
|---|
| レン | title 要素のテキストの最大長。整数 |
インプ.ネイティブ.リクエスト.アセット.ビデオ
| 属性 | 説明 |
|---|
| マイムズ | サポートしている MIME タイプの一覧 (文字列配列)。 |
| マインデュレーション | 最小動画広告時間(秒)(整数)。 |
| 最大持続時間 | 最大動画広告時間(秒)(整数)。 |
| プロトコル | サポートしているビデオ入札応答プロトコルのリスト (整数配列)。 |
| 直線性 | 印象が線形でなければならないか、非線形でなければならないかなどを示す(整数)。 |
| ボクシング可 | 4:3コンテンツを16:9ウィンドウにレターボックスすることを許可するかどうかを示す(整数)。 |
インプ.ネイティブ.リクエスト.アセット.データ
| 属性 | 説明 |
|---|
| タイプ | パブリッシャーがサポートする要素のタイプ ID (整数)。サポートしている: 1(sponsored-レスポンスにスポンサーのブランド名を含む必要があるSponsored Byメッセージ)、2**(desc-広告されている製品やサービスに関連する説明テキスト*)をサポートしています。 |
| レン | 要素のレスポンスに含まれるテキストの最大長 (integer) |
インプ・ビデオ
| 属性 | 説明 |
|---|
| マイムズ | サポートする MIME タイプの一覧 (文字列配列)。 |
| プロトコル | サポートしているビデオ入札応答プロトコルの一覧 (int array) |
| スキップ | プレーヤーがビデオのスキップを許可するかどうかを示します。 |
| スキップアフター | 広告がスキップ可能な場合にのみ適用されます。 |
| スキップミン | 広告がスキップ可能な場合にのみ適用されます。 |
**パブリッシャーがリクエストで "skip "を提供し、"skipafter "を提供しな い場合、ビデオは5秒後にスキップ可能になる。パブリッシャーが "skip "を提供するが、"skipmin "を提供しない場合、ビデオは継続時間に関係なくスキップ可能である。
サイト
| 属性 | 説明 |
|---|
| id* | ユニークサイトID(文字列) |
| ドメイン | サイトのドメイン名 (文字列) |
| 猫 | IABカテゴリーID (文字列配列) |
| ページ | 広告が表示されるページの完全なURL(文字列) |
| キーワード | キーワードは、広告ゾーンが適切なタイプの広告を得られるようにするために使用できます。キーワードはコンマで区切られた文字列でなければなりません。 |
| エクステンド | OpenRTBに対する取引所固有の拡張のためのプレースホルダ。 |
*これらの属性は、ダイレクト・リンクとEメール・クリックのフォーマットには必須です。
サイトエクステンション
| 属性 | 説明 |
|---|
| エクスチェンジキャット | カスタム ExoClick カテゴリ ID (整数) |
| イドゾーン | カスタムExoClick広告ゾーンID(整数) |
| キーワード | マッチするキーワードがあれば(文字列) |
idzone 属性は、ExoClick 内でトラフィックの送信元を識別するために使用されます。
| 属性 | 説明 |
|---|
| ua | ブラウザのユーザーエージェント (文字列) |
| ジオ | デバイスの位置は、Geoオブジェクトで定義されたユーザーの現在地と仮定。 |
| ip | ユーザーのIPアドレス(文字列) |
| アイピーブイシックス | ユーザーのIPv6アドレス(文字列) |
| 言語 | ISO-639-1-alpha-2を使用したブラウザ言語 (文字列) |
| os | オペレーティングシステム (文字列) |
| js | JavaScriptのサポート。0 = no, 1 = yes (整数) |
| エクステンド | OpenRTBへの取引所固有の拡張のためのプレースホルダ |
デバイスジオ
デバイスエクステンション
| 属性 | 説明 |
|---|
| リモートアドレス | ユーザーのメインIPアドレス(文字列) |
| x_forwarded_for | ユーザーのX-FORWARDED-FOR IPアドレス、または設定されていない場合は空(文字列) |
ユーザー
エクステンド
| 属性 | 必要ですか? | 説明 |
|---|
| サブ | いいえ | subは、リクエストの発信元ゾーンのIDを表す整数値となる。 |
レグスエクスト
| 属性 | 説明 |
|---|
| dsaapply | リクエストにDSAを適用するかどうかを示すフラグ。1 = 必須 (int) |
| dsa | DSA透明性情報の拡張(オブジェクト) |
レグス
| 属性 | 説明 |
|---|
| 必須 | DSA 情報を利用可能にすべきかどうかを示すフラグ。0 = 不要, 1 = サポートあり、DSAオブジェクトの有無にかかわらず入札回答は受理される, 2 = 必須、DSAオブジェクトのない入札回答は受理されない, 3 = 必須、DSAオブジェクトのない入札回答は受理されない, 発行者はオンライン・プラットフォーム(int) |
| データパブ | パブリッシャーは監査目的で透明性データを必要とするかもしれない。0 = トランスペアレンシー・データを送信しない, 1 = トランスペアレンシー・データの送信は任意, 2 = トランスペアレンシー・データを送信する (int) |
注意: *もし、dsaapply:1 と required:2 または 3 を受け取った場合、レスポンスに dsa 属性の値を追加することが必須である。
広告主リクエストの例ページ](/ja/docs/rtb-advertisers/open-rtb/open-rtb-advertiser-code-examples#open-rtb-advertiser-request)に、受信可能なリクエストの全タイプのリストがあります。