このページでは、入札依頼の方法について説明します。
入札依頼ヘッダー
- OpenRTBバージョンHTTPヘッダー: x-openrtb-version: 2.4
- キープアライブHTTPヘッダ：接続：キープアライブ
- コンテンツJSON：Content-Type: application/json
以下のオブジェクトは、リクエスト・ボディの中でJSONとしてエンコードされて送信されるべきである：
入札依頼
| 属性 | 必要ですか？ | 説明 |
|---|
| で | はい | オークションタイプ、最初の価格 = 1 (int) |
| アイドル | はい | 入札依頼ID（文字列） |
| 小悪魔 | はい | 提供された印象を表すImpオブジェクトの配列(object)。 |
| サイト | はい | パブリッシャーのウェブサイト（オブジェクト）に関するSiteオブジェクト経由の詳細。 |
| アプリ | はい | パブリッシャーのアプリ*（オブジェクト）に関するAppオブジェクト経由の詳細。 |
| 装置 | はい | インプレッションが配信されるユーザーのデバイスに関するDeviceオブジェクトを介した詳細（オブジェクト）。 |
| ユーザー | いいえ | Userオブジェクトを介して、デバイスの人間ユーザーに関する詳細、広告オーディエンス（オブジェクト）。 |
| エクステンド | いいえ | OpenRTBの拡張用のプレースホルダ。 |
*注***：注意: 各リクエストには、{site, app}オブジェクトのうち1つだけが存在する必要があります。
小悪魔
| 属性 | 必要ですか？ | 説明 |
|---|
| アイドル | はい | この入札リクエスト内でユニークなインプレッションID（文字列） |
| ビッドフロア | いいえ | このインプレッション（CPM）／クリック（CPC）およびアカウント通貨（フロート）の最低入札価格 |
| ビッドフロアカー | いいえ | ISO-4217アルファコードで指定された最低入札価格の通貨（文字列） |
| ネイティブ | ネイティブとプッシュインプのみ | ネイティブ・オブジェクトの機会（オブジェクト）。 |
| バナー | バナーとフルページ・インタースティシャルのみ | バナーオブジェクトの機会（オブジェクト）。 |
| インスタ | ポップ、ダイレクトリンク、Eメール、全ページのインタースティシャルクリックIMPのみ | フルスクリーンオブジェクトの機会（オブジェクト）。 |
| ビデオ | ビデオのみ | ビデオオブジェクトの機会（オブジェクト） |
| セキュア | おすすめ | インプレッションがセキュアな HTTPS URL のクリエイティブアセットとマークアップを必要とするかどうかを示すフラグで、0 = 非セキュア、1 = セキュア (推奨オプション)。省略された場合、セキュアな状態は不明ですが、非セキュアなHTTPサポートを想定できます（整数）。 |
| エル | いいえ | Base64 エンコードされた電子メール (文字列) |
| エクステンド | いいえ | 取引所固有の拡張機能のためのプレースホルダー |
インプバナー
| 属性 | 必要ですか？ | 説明 |
|---|
| w | はい | バナーの幅 (integer) |
| h | はい | バナーの高さ (integer) |
| マイムズ | いいえ | サポートしている MIME タイプの一覧 (文字列配列)。以下のものをサポートしています: image/jpeg, image/jpg, image/png, image/gif, image/webp, video/mp4 |
| エクステンド | いいえ | 取引所固有の拡張機能のためのプレースホルダ（オブジェクト） |
imp.banner.ext
| 属性 | 必要ですか？ | 説明 |
|---|
| 画像出力 | いいえ | 画像バナーの出力形式を示す* (文字列) |
| ビデオ出力 | いいえ | ビデオバナーの出力形式を示す* (文字列) |
*バナーフォーマットのadmフィールドのフォーマットを定義する。オプションはxmlまたはhtml。デフォルト値はxmlです。
インプル
| 属性 | 必要ですか？ | 説明 |
|---|
| インスタ | はい | 0 = ダイレクトリンク/メールクリック、1 = ポップアンダー/フルページ・インタースティシャル |
imp.native（ネイティブ広告およびプッシュ通知広告用）
| 属性 | 必要ですか？ | 説明 |
|---|
| リクエスト | はい | ネイティブアド仕様に準拠したリクエストペイロード - ネイティブトップレベルオブジェクト（JSONオブジェクト）を含むネイティブアドのリクエストのJSONエンコード文字列。 |
| ver | いいえ | リクエスト**が準拠するDynamic Native Ads APIのバージョン (文字列) |
インプ.ネイティブ.リクエスト
| 属性 | 必要ですか？ | 説明 |
|---|
| ver | はい | 使用中のネイティブ・マークアップのバージョン（文字列） |
| コンテキスト | いいえ | 広告が表示されるコンテキスト。この場合、1（ニュースフィード、記事、画像ギャラリー、動画ギャラリーなどのコンテンツ中心のコンテキスト）で、オプション（整数）です。 |
| プリセプタータイプ | はい | 提供する広告ユニットのデザイン/フォーマット/レイアウト。現在、4（レコメンドウィジェット）と500（プッシュ通知）（整数）をサポートしています。 |
| プランクトン | いいえ | このレイアウトにおける同一配置の数。最大：10（整数）（整数） |
| 資産 | はい | アセットオブジェクト**の配列。入札レスポンスは、入札リクエストで表現された要素の配列（JSONオブジェクトの配列）に従わなければなりません。 |
| シーク | いいえ | 最初の広告には0、2番目の広告には1というように。これは一般的に plcmtcnt と組み合わせて使用することはできません。複数の同じプレースメントをオークションにかける (plcmtcnt>1, seq=0 の場合) か、フィード内の個別のアイテムに対して個別のオークションを行う (plcmtcnt=1, seq=>=1 の場合) かのどちらかです。 |
インプ.ネイティブ.リクエスト.アセット
| 属性 | 必要ですか？ | 説明 |
|---|
| アイドル | はい | ユニークなアセット ID。通常は配列のカウンタ (整数) 1: 画像アセット ID、2: タイトルアセット ID、3: 説明アセット ID。 |
| 必須 | いいえ | アセットが必須の場合は1、オプションの場合は0に設定 (整数) |
| プランクトン | いいえ | このレイアウトにおける同一配置の数 (integer) |
| イムグ | はい | 画像資産用Imageオブジェクト（JSONオブジェクト） |
| タイトル | いいえ | タイトル資産**用のタイトル・オブジェクト（JSONオブジェクト） |
| データ | いいえ | ブランド名、説明、評価、価格などのデータオブジェクト。 |
※ネイティブリクエストに対して受け取った入札額は、「plcmtcnt」で設定した値に基づきます。たとえば、「plcmtcnt」:3 の入札リクエストは、3 つの異なる入札オブジェクトを受け取ります。この例は、応答例ページ を参照してください。
** 各アセットオブジェクトには、{img、title、data} オブジェクトのうち1つだけが存在する必要があります。
imp.native.request.assets.img
| 属性 | 必要ですか？ | 説明 |
|---|
| タイプ | いいえ | パブリッシャーがサポートする画像要素のタイプID。サポートしています： 1 (アイコン画像) (integer), 3 (広告の大きな画像プレビュー) (integer) |
| w | いいえ | 画像の幅。ピクセル単位で指定します（整数）。 |
| h | いいえ | 画像の高さ（ピクセル単位）、オプション（整数 |
| ウーミン | はい | ピクセル単位で指定する、画像の幅の最小値 (integer) |
| フミン | はい | ピクセル単位で指定する、画像の高さの最小値 (integer) |
*プッシュ通知アイコンの寸法192px x 192px
imp.native.request.assets.title
| 属性 | 必要ですか？ | 説明 |
|---|
| レン | はい | title 要素のテキストの最大長。整数 |
インプ.ネイティブ.リクエスト.アセット.データ
| 属性 | 必要ですか？ | 説明 |
|---|
| タイプ | はい | パブリッシャーがサポートする要素のタイプ ID (整数)。サポートしている： 1（sponsored-レスポンスにスポンサーのブランド名を含む必要があるSponsored Byメッセージ）、2**（desc-広告されている製品やサービスに関連する説明テキスト*）をサポートしています。 |
| レン | いいえ | 要素のレスポンスに含まれるテキストの最大長 (integer) |
インプ・ビデオ
| 属性 | 必要ですか？ | 説明 |
|---|
| マイムズ | いいえ | サポートする MIME タイプの一覧 (文字列配列)。 |
| プロトコル | いいえ | サポートしているビデオ入札応答プロトコルの一覧 (int array) |
| スキップ | いいえ | プレーヤーがビデオのスキップを許可するかどうかを示します。 |
| スキップアフター | いいえ | 広告がスキップ可能な場合にのみ適用されます。 |
| スキップミン | いいえ | 広告がスキップ可能な場合にのみ適用されます。 |
注意: リクエストで "skip "のみを指定し、"skipafter "を指定しない場合、ビデオは5秒後に スキップ可能になる。skip "を指定し、"skipmin "を指定しなかった場合、ビデオはその継続時間に関係なくスキップ可能になる。
インプ.エクステント
| 属性 | 必要ですか？ | 説明 |
|---|
| ビデオ | いいえ | CTAを提供するかどうかを示す。0=no、1=yes（デフォルト1） |
CTAの例を見るには、レスポンス例ページをご覧ください。
サイト
| 属性 | 必要ですか？ | 説明 |
|---|
| アイドル | 必須 | ユニークサイトID（文字列） |
| ドメイン | 必須 | サイトのドメイン名 (文字列) |
| 名称 | 必須 | サイト名（文字列） |
| 猫 | いいえ | IABカテゴリーID (文字列配列) |
| ページ | おすすめ | 広告が表示されるページの完全なURL（文字列） |
| キーワード | いいえ | キーワードは、広告ゾーンが適切なタイプの広告を取得できるようにするために使用できます。キーワードはコンマで区切られた文字列でなければなりません。 |
| エクステンド | いいえ | OpenRTBに対する取引所固有の拡張のためのプレースホルダ。 |
サイトエクステンション
| 属性 | 必要ですか？ | 説明 |
|---|
| エクスチェンジキャット | いいえ | カスタム ExoClick カテゴリ ID (整数) |
| イドゾーン | いいえ | カスタムExoClick広告ゾーンID（整数） |
アプリ
| 属性 | 必要ですか？ | 説明 |
|---|
| アイドル | 必須 | 固有のアプリID（文字列） |
| 猫 | いいえ | IABカテゴリーID (文字列配列) |
| キーワード | いいえ | キーワードは、広告ゾーンが適切なタイプの広告を取得できるようにするために使用できます。キーワードは、カンマで区切られた単語（文字列）でなければなりません。 |
| 出版社 | いいえ | 発行者（オブジェクト）の詳細 |
アプリパブリッシャー
| 属性 | 必要ですか？ | 説明 |
|---|
| ドメイン | おすすめ | パブリッシャーの最上位ドメイン（例："publisher.com"）（文字列） |
| 属性 | 必要ですか？ | 説明 |
|---|
| ua | はい | ブラウザのユーザーエージェント (文字列) |
| ジオ | いいえ | デバイスの位置は、Geoオブジェクトで定義されたユーザーの現在地と仮定。 |
| ip | はい | ユーザーのIPアドレス(文字列) |
| アイピーブイシックス | おすすめ | ユーザーのIPv6アドレス(文字列) |
| 言語 | おすすめ | ISO-639-1-alpha-2を使用したブラウザ言語 (文字列) |
| os | いいえ | オペレーティングシステム (文字列) |
| js | いいえ | JavaScriptのサポート。0 = no, 1 = yes (整数) |
| エクステンド | いいえ | OpenRTBへの取引所固有の拡張のためのプレースホルダ |
*注***：リクエストにはipかipv6のどちらか一方を含めるだけでよく、両方を含める必要はない。ipv6を使う場合はip属性を削除してください。その逆も同様です。
デバイスジオ
| 属性 | 必要ですか？ | 説明 |
|---|
| カントリー | いいえ | 国名 ISO3 |
デバイスエクステンション
| 属性 | 必要ですか？ | 説明 |
|---|
| リモートアドレス | いいえ | ユーザーのメインIPアドレス（文字列） |
| x_forwarded_for | いいえ | ユーザーのX-FORWARDED-FOR IPアドレス、または設定されていない場合は空（文字列） |
ユーザー
| 属性 | 必要ですか？ | 説明 |
|---|
| アイドル | はい | ユニークユーザーID (文字列) |
*注***：ユーザーID文字列を生成できない場合は、空文字列("")のままにしておくことができます。リクエストに "user "オブジェクトが含まれている限り、リクエストはレスポンスを得る。
エクステンド
| 属性 | 必要ですか？ | 説明 |
|---|
| サブ | いいえ | サブID。1桁から10桁の数字でなければならない：サブIDの先頭に0を使用しないでください。 |
| 輸出 | いいえ | レスポンス・タイプは "json "または "xml"（文字列）。デフォルトは "json"。 |
リクエストの例の詳細なリストは、例のページ