このページでは、入札依頼の方法について説明します。
入札依頼ヘッダーの提案
- OpenRTBバージョンHTTPヘッダー: x-openrtb-version: 2.5
- キープアライブHTTPヘッダ:接続:キープアライブ
- コンテンツJSON: Content-Type: application/json
以下のオブジェクトは、リクエスト・ボディの中でJSONとしてエンコードされて送信されるべきである:
入札依頼
| 属性 | 必要ですか? | 説明 |
|---|
| で | はい | オークションタイプ、最初の価格 = 1 (int) |
| アイドル | はい | 入札依頼ID(文字列) |
| 小悪魔 | はい | 提供された印象を表すImpオブジェクトの配列(object)。 |
| サイト | はい | 出版社のウェブサイト(オブジェクト)の詳細。 |
| アプリ | はい | 出版社のアプリ(オブジェクト)の詳細。 |
| 装置 | はい | インプレッションが配信されるユーザーのデバイスに関する詳細(オブジェクト)。 |
| ユーザー | いいえ | デバイスを使用する人間の詳細、広告オーディエンス(対象)。 |
| エクステンド | いいえ | OpenRTBの拡張用のプレースホルダ。 |
*注***:注意: 各リクエストには、{site, app}オブジェクトのうち1つだけが存在する必要があります。
小悪魔
| 属性 | 必要ですか? | 説明 |
|---|
| アイドル | はい | この入札リクエスト内でユニークなインプレッションID(文字列) |
| ビッドフロア | いいえ | このインプレッション(CPM)/クリック(CPC)およびアカウントの通貨(フロート)の最低入札価格。 |
| バナー | フルページ・インプのみ | バナーオブジェクト(オブジェクト)。 |
| セキュア | いいえ。 | インプレッションがセキュアなHTTPS URLクリエイティブアセットとマークアップを必要とするかどうかを示すフラグで、0 = 非セキュア、1 = セキュア。省略された場合、セキュアな状態は不明ですが、非セキュアなHTTPサポートを想定することができます。 |
インプバナー
| 属性 | 必要ですか? | 説明 |
|---|
| w | はい | バナーの幅 (integer) |
| h | はい | バナーの高さ (integer) |
| マイムズ | はい | パントマイムの種類 - image/jpg、image/png、video/mp4、image/webp |
インプ・ビデオ
| 属性 | 必要ですか? | 説明 |
|---|
| マイムズ | はい | 対応するコンテンツMIMEタイプ(例:"video/mp4")(文字列配列) |
| マインデュレーション | いいえ | 最小動画広告時間(秒)(整数 |
| 最大持続時間 | いいえ | 最大動画広告時間(秒)(整数 |
| プロトコル | いいえ | サポートするビデオプロトコルの配列 (integer) |
| 直線性 | いいえ | 印象が線形でなければならないか、非線形でなければならないかなどを示す。指定がない場合は、すべて許容されるものとする (integer) |
| ボクシング可 | いいえ | 4:3コンテンツを16:9ウィンドウにレターボックスすることを許可するかどうかを示す。 |
| ポーズ | いいえ | 画面上の広告位置(整数) |
| h | いいえ | ビデオプレーヤーの幅(デバイス独立ピクセル(DIPS)単位)(整数 |
| w | いいえ | 動画プレーヤーの高さ (デバイス非依存ピクセル (DIPS) 単位) (integer) |
| エクステンド | いいえ | OpenRTBへの取引所固有の拡張のためのプレースホルダ(オブジェクト) |
imp.video.ext
| 属性 | 必要ですか? | 説明 |
|---|
| ゾーン・タイプ | いいえ | エクソクリックの広告フォーマット内のゾーンタイプ(例:video_slider) |
| クタ | いいえ | 広告ゾーンに CTA コンポーネントを表示するかどうかを指定します (整数)。 |
サイト
| 属性 | 必要ですか? | 説明 |
|---|
| アイドル | おすすめ | ユニークサイトID(文字列) |
| 名称 | いいえ | サイト名 (文字列) |
| ドメイン | おすすめ | サイトのドメイン名 (文字列) |
| 猫 | いいえ | IABカテゴリーID (文字列配列) |
| ページ | おすすめ | 広告が表示されるページの完全なURL(文字列) |
| キーワード | いいえ | キーワードは、広告ゾーンが適切なタイプの広告を得られるようにするために使用できます。キーワードはコンマで区切られた文字列でなければなりません。 |
サイトエクステンション
| 属性 | 必要ですか? | 説明 |
|---|
| エクスチェンジキャット | いいえ | カスタム ExoClick カテゴリ ID (整数) |
| イドゾーン | いいえ | カスタムExoClickゾーンID (整数) |
アプリ
| 属性 | 必要ですか? | 説明 |
|---|
| アイドル | おすすめ | 固有のアプリID(文字列) |
| 名称 | いいえ | アプリ名 (文字列) |
| ドメイン | おすすめ | アプリのドメイン名(文字列) |
| 猫 | いいえ | IABカテゴリーID (文字列配列) |
| キーワード | いいえ | キーワードは、広告ゾーンが適切なタイプの広告を取得できるようにするために使用できます。キーワードは、カンマで区切られた単語(文字列)でなければなりません。 |
| 出版社 | いいえ | 発行者(オブジェクト)の詳細 |
| 属性 | 必要ですか? | 説明 |
|---|
| ua | はい | ブラウザのユーザーエージェント (文字列) |
| スア | いいえ | 構造化されたユーザエージェント情報。クライアントがUser-Agent Client Hints (オブジェクト)をサポートしている場合に使用できる。 |
| ジオ | いいえ | デバイスの位置は、Geoオブジェクトで定義されたユーザーの現在地と仮定。 |
| ip | はい | ユーザーのIPv4アドレス(文字列)*。 |
| アイピーブイシックス | はい | ユーザーのIPv6アドレス(文字列)*。 |
| 言語 | おすすめ | ブラウザの言語 (文字列) |
| os | いいえ | オペレーティングシステム (文字列) |
| js | いいえ | JavaScriptのサポート。0 = no, 1 = yes (整数) |
| エクステンド | いいえ | OpenRTBへの取引所固有の拡張のためのプレースホルダ |
注意: リクエストに含める必要があるのは、ipかipv6のどちらかだけで、両方ではありません。ipv6を使用する場合は、ip属性を削除してください。その逆も同様です。
デバイスジオ
| 属性 | 必要ですか? | 説明 |
|---|
| カントリー | いいえ | 国名 ISO3 |
デバイスエクステンション
| 属性 | 必要ですか? | 説明 |
|---|
| リモートアドレス | いいえ | ユーザーのメインIPアドレス(文字列) |
| x_forwarded_for | いいえ | ユーザーのX-FORWARDED-FOR IPアドレス、または設定されていない場合は空(文字列) |
デバイス.sua
構造化されたユーザーエージェント情報。device.sua`はデバイス属性をより正確に表現していると考えられます。
| 属性 | 必要ですか? | 説明 |
|---|
| ブラウザ | おすすめ | 実装者はSec-CH-UA-Full-Version-Listヘッダーに由来するブランドとバージョンを送るべきである。(BrandVersionオブジェクトの配列) |
| プラットフォーム | おすすめ | 実装者は、Sec-CH-UA-Platform ヘッダに由来するブランドと、Sec-CH-UA-Platform-Version ヘッダに由来するバージョンを送信すべきである。(BrandVersion オブジェクト) |
| モバイル | おすすめ | 実装者はこの値をSec-CH-UA-Mobileヘッダーから導出すべきである。(整数) |
| 建築 | おすすめ | 実装者はSec-CH-UA-Archヘッダーからこの値を取得するべきである。(文字列) |
| ビットネス | おすすめ | 実装者はSec-CH-UA-Bitnessヘッダーからこの値を取得するべきである。(文字列) |
| モデル | おすすめ | 実装者はSec-CH-UA-Modelヘッダーからこの値を取得するべきである。(文字列) |
| ソース | おすすめ | このオブジェクトの作成に使用されたデータのソース。AdCOM 1.0 の リスト: ユーザー エージェント ソース (整数、デフォルト 0) |
デバイス.sua.ブラウザ|デバイス.sua.プラットフォーム
| 属性 | 必要ですか? | 説明 |
|---|
| ブランド | 必須 | この値はUser-Agent Client Hintsヘッダから取得することができ、ユーザーエージェントブランド(Sec-CH-UA-Full-Versionヘッダから)またはプラットフォームブランド(Sec-CH-UA-Platformヘッダから)を表す。(文字列) |
| バージョン | おすすめ | バージョン構成要素のシーケンス。階層順 [メジャー、マイナー、マイクロ、...](array of string) |
ユーザー
| 属性 | 必要ですか? | 説明 |
|---|
| アイドル | いいえ | ユニークユーザーID (文字列) |
| エクステンド | いいえ | OpenRTBへの取引所固有の拡張のためのプレースホルダ(オブジェクト) |
ユーザーエクスト
| 属性 | 必要ですか? | 説明 |
|---|
| 同意 | いいえ | これは IAB 標準で要求される同意の文字列です。現時点では否定的な同意のみ(文字列) |
レッグス
| 属性 | 必要ですか? | 説明 |
|---|
| エクステンド | いいえ | OpenRTBへの取引所固有の拡張のためのプレースホルダ(オブジェクト) |
レグスエクスト
| 属性 | 必要ですか? | 説明 |
|---|
| gdpr | いいえ | 呼び出し元が、ユーザーがGDPRの対象外であると考える場合は0となり、ユーザーがGDPRの対象である場合は1となる。どちらでもない場合、このパラメータは未定義となる。 |
エクステンド
| 属性 | 必要ですか? | 説明 |
|---|
| サブ | いいえ | サブID。1桁から10桁の数字でなければならない:サブIDの先頭に0を使用しないでください。 |