入札者への送信入札要求
注:
ここでは、 OpenRTB 2.4 プロトコルの統合について説明します。
この入札リクエストは、広告通話がインプレッション バスに到達するたびに、入札者に送信されます。 入札者が入札価格とクリエイティブを提供するために必要なすべての情報が含まれています。
入札リクエストには、オークションに勝ち、ページで実行できる広告主とクリエイティブを指定する販売者からの情報が含まれています。
注:
プラットフォームを通過するすべての入札要求を受け取りたくない場合があります。 要求をある割合で調整するか、geography などの事前設定された条件で要求をフィルター処理できます。
実装
詳細が必要なオブジェクトやヘッダーなどの実装の詳細を見つけるには、テーブルを参照してください。
Bid 要求ヘッダー
| フィールド | 種類 | 説明 |
|---|---|---|
Content-Length |
int | HTTP 要求の本文の長さ (以下で説明するすべてのフィールドを含む)。 |
Host |
string | 入札要求が送信された IP アドレス。 |
Connection |
string | 永続的な TCP 接続を確保するには、常に "keep-alive" に設定します。 |
Content-Type |
string | 要求で渡されるコンテンツの種類。 常に "application/json" に設定します。 |
x-openrtb-version |
string | 入札要求でサポートされている openrtb バージョン。 現在、 2.4に設定されています。 |
Bid 要求オブジェクト
Xandr では、最上位レベルの入札要求オブジェクトの次のフィールドがサポートされています。
| フィールド | 種類 | 説明 |
|---|---|---|
id |
string | (必須)入札要求の一意識別子。 |
imp |
オブジェクトの配列 | (必須)この入札要求で提供されるインプレッション。 以下の 「インプレッション オブジェクト」を 参照してください。 |
site |
object | インプレッションの Web サイトまたはインベントリ (配置グループ) のサブセットに関する情報を指定します。 Web サイトのインプレッションに適用されます。 以下の サイト オブジェクトを 参照してください。 |
app |
object | インプレッションのアプリに関する情報を指定します。 アプリのインプレッションに適用されます。 以下の 「アプリ オブジェクト」を 参照してください。 |
device |
object | これらのインプレッションを配信するユーザーのデバイスに関する情報を指定します。 以下の 「デバイス オブジェクト」を 参照してください。 |
user |
object | インプレッションを配信するユーザーに関する情報を指定します。 以下の 「ユーザー オブジェクト」を 参照してください。 |
test |
integer | このオークションがテスト モードであり、課金対象ではないことを示します。 存在しない場合は、既定値が使用されます。 - 0: ライブ モード。課金対象 (既定値)。- 1: テスト モード。課金対象ではありません。 |
at |
integer | オークションの種類を指定します。 存在しない場合は、既定値が使用されます。 - 1: 最初の価格。- 2: 2 番目の価格と 1 セント (既定値)。 |
wseat |
文字列の配列 | このインプレッションで入札できる購入者シートの許可リストを表す配列を指定します。 |
tmax |
integer | タイムアウト前に入札を送信する最大時間 (ミリ秒単位) を指定します。 |
cur |
文字列の配列 | ISO-4217 アルファベットコードを使用して、この入札要求の入札で許可される通貨の配列を指定します。 既定値は USD です。 |
bcat |
文字列の配列 | ブロックされたコンテンツ カテゴリの一覧を指定します。 IAB カテゴリが含まれます (仕様のセクション 5.1 に記載されています)。
Bcat は必須フィールドではなく、入札要求に関連付けられているブロックされたカテゴリがある場合にのみ送信されます。 ブロックされたカテゴリが関連付けられていない場合、このフィールドは送信されません。 |
badv |
文字列の配列 | システム内のブランド URL に対応するブロックされた最上位レベルの広告主ドメインの一覧を指定します。 たとえば、「 ["company1.com","company2.com"] 」のように入力します。 詳細については、 ブランド サービスに関するページを参照してください。 最大 64 個の値が送信されます。 |
regs |
object | この要求に対して実施される業界、法律、または政府の規制に関する情報を指定します。 以下 の「Regs オブジェクト」を 参照してください。 |
source |
object | インベントリ ソースと、最終的な決定を行うエンティティに関するデータを提供します。 以下の ソース オブジェクトを 参照してください。 |
ext |
object | OpenRTB 入札要求に対するプラットフォーム固有の拡張機能を識別するために使用されます。 以下の 「Bid Request Extension オブジェクト」を 参照してください。 |
Bid request 拡張機能オブジェクト
プラットフォーム固有の拡張機能とサプライチェーン信号をサポートするために、 ext オブジェクトの次のオブジェクトをサポートします。
| フィールド | 種類 | 説明 |
|---|---|---|
appnexus |
object | OpenRTB 入札要求に対するプラットフォーム固有の拡張機能を指定します。 |
schain |
object | OpenRTB 入札要求に含まれる SupplyChain フィールドを指定して、サプライ パスの透明性を確保します。 以下 の「Schain オブジェクト」を 参照してください。 |
Schain オブジェクト
schain (Supply Chain) オブジェクトでは、次のフィールドがサポートされています。
| フィールド | 種類 | 説明 |
|---|---|---|
ver |
string | 使用中のサプライ チェーン仕様のバージョン ("major.minor" の形式)。 現在、バージョン 1.0 の仕様を使用しています。 |
complete |
列挙 | チェーンに、サイト、アプリ、またはインベントリの他のメディアの所有者に戻るトランザクションに関連するすべてのノードが含まれているかどうかを示すフラグ (0 = いいえ、1 = はい)。 |
nodes |
object | SupplyChainNode オブジェクトの配列をチェーンの順序で指定します。 完全なサプライ チェーンでは、最初のノードは、トランザクションに関与する初期広告システムと販売者 ID 、つまりサイト、アプリ、またはその他のメディアの所有者を表します。 不完全なサプライ チェーンでは、最初の既知のノードを表します。 最後のノードは、この入札要求を送信するエンティティ (Xandr ノード) を表します。 nodes オブジェクトでは、次のフィールドがサポートされています。 - asi (string): 入札者が接続する SSP、Exchange、ヘッダー ラッパーなどのシステムの正規ドメイン名。 これは、ads.txt ファイル内の販売者を識別するために使用される値と同じ値にする必要があります (存在する場合)。 Xandr ノードの場合、ドメインは appnexus.com - sid (string): 広告システム内の販売者またはリセラー アカウントに関連付けられている識別子。 - rid (string): 販売者によって発行された要求の OpenRTB RequestId。 - hp (整数): このノードが在庫の支払フローに関与しているかどうかを示します。 SupplyChain のバージョン 1.0 の場合、このプロパティは常に 1 である必要があります。 |
Bid 要求オブジェクト
入札要求オブジェクトの appnexus 拡張オブジェクトの次のフィールドがサポートされています。
| フィールド | 種類 | 説明 |
|---|---|---|
seller_member_id |
integer | インベントリを販売するメンバーの ID を指定します。 対応するメンバー名を見つけるには、「 プラットフォーム メンバー サービス 」を参照してください。 |
spend_protection |
ブール型 | 非推奨 (2018 年 10 月)。 |
publisher_integration |
object | パブリッシャー統合の詳細を提供します。 |
ext_inv_code |
integer | レポートで使用できるクエリ文字列に渡される定義済みの値。 この値は、ログに記録される前にシステムに入力する必要があります。 詳細については、「 外部インベントリ コード サービス」を参照してください。 例: ext_inv_code=10039 |
パブリッシャー統合オブジェクト
publisher_integration オブジェクトでは、次のフィールドがサポートされています。
| フィールド | 種類 | 説明 |
|---|---|---|
is_header |
ブール値 |
-
0: これはヘッダー入札統合ではありません。- 1: ラッパーへの統合。 |
bid_shading_high |
double | 非推奨 (2018 年 10 月)。 |
bid_shading_medium |
double | 非推奨 (2018 年 10 月)。 |
bid_shading_low |
double | 非推奨 (2018 年 10 月)。 |
Impression オブジェクト
imp オブジェクトの次のフィールドがサポートされています。これは、オークションされるインプレッションを表します。 1 つの入札要求に、複数の imp オブジェクトを含む配列を含む場合があります。
| フィールド | 種類 | 説明 |
|---|---|---|
id |
string | (必須)入札要求のコンテキスト内で、このインプレッションの一意識別子を指定します。
auction_id_64の値に設定します。 |
banner |
object | このインプレッションがバナー広告として提供される場合は必須です。 以下の 「バナー オブジェクト 」を参照してください。 |
video |
object | このインプレッションが動画広告として提供される場合は必須です。 下の ビデオ オブジェクトを 参照してください。 |
audio |
object | このインプレッションがオーディオ広告として提供される場合は必須です。 以下の 「Audio オブジェクト 」を参照してください。 |
native |
object | このインプレッションがネイティブ広告として提供される場合は必須です。 以下の 「ネイティブ オブジェクト」を 参照してください |
instl |
integer | インプレッションがスポットまたは全画面表示かどうかを示します。 - 0: インプレッションはスポットまたは全画面表示ではありません (既定値)。- 1: 印象はスポットまたは全画面表示です。 |
tagid |
string | オークションの開始に使用された特定の広告の配置または広告タグの識別子を指定します。 これはプラットフォームの配置 ID です。 販売者の可視性設定で共有が禁止されている場合は省略されます。 |
bidfloor |
浮動小数点数 | このインプレッションの最小入札額は CPM で表されます。 Xandr は、送信入札要求の [ bidfloor ] フィールドのパブリッシャーの総公開市場のフロア価格をダウンストリームの DSP に送信します。 (これには、関連する Xandr 販売者と買い手の手数料が含まれます)。 これは、パブリッシャーの受信広告リクエストで bidfloor が設定されている場合、またはパブリッシャーのプレースメント予約価格が設定されている場合に適用されます。 |
bidfloorcur |
string | ISO-4217 アルファ コードを使用して指定された通貨。 これは、交換によって許可されている場合、入札者が返す入札通貨とは異なる場合があります。 |
secure |
integer | インプレッションに安全な HTTPS URL クリエイティブアセットとマークアップが必要かどうかを示します。 省略すると、セキュリティで保護された状態は不明ですが、セキュリティで保護されていない HTTP サポートが想定される場合があります。 - 0: 印象は安全ではありません。- 1: 印象は安全です。 |
pmp |
object | このインプレッションに有効なプライベート マーケットプレース取引に関する情報を指定します。 以下の 「プライベート Marketplace オブジェクト」を 参照してください。 |
ext |
object | インプレッション オブジェクトの OpenRTB へのプラットフォーム固有の拡張機能を識別するために使用されます。 以下の 「インプレッション拡張オブジェクト」 を参照してください。 |
バナー オブジェクト
バナーインプレッションの場合、次のフィールドがサポートされます。
| フィールド | 種類 | 説明 |
|---|---|---|
w |
integer | (推奨)バナーの正確な幅をピクセル単位で指定します。 |
h |
integer | (推奨)バナーの正確な高さをピクセル単位で指定します。 |
id |
string | バナー オブジェクトの一意の識別子を指定します。 複数のバナー オブジェクト (コンパニオン バナー配列など) を追跡する場合に便利です。 通常、配列の最初のバナーは 1 され、後続のオブジェクトはそこからインクリメントされます。 現在、 1にハードコーディングされています。 |
btype |
整数の配列 | ブロックするバナー クリエイティブの種類を指定します。 型の一覧については、IAB 仕様のセクション 5.2 を参照してください。 |
battr |
整数の配列 | ブロックするバナー クリエイティブ属性を指定します。 属性の一覧については、IAB 仕様のセクション 5.3 を参照してください。 |
pos |
integer | 画面上のバナーの位置を指定します。 - 0: 不明 (既定値)- 1: フォールドの上- 3: フォールドの下 |
api |
整数の配列 | このインプレッションでサポートされている API フレームワークを指定します。 API が明示的に一覧表示されていない場合は、サポートされていないと見なされます。 API フレームワークの一覧については、IAB 仕様のセクション 5.6 を参照してください。 |
format |
オブジェクトの配列 | 許可されているバナー サイズを表す format オブジェクト。 以下の「 オブジェクトの書式設定」を 参照してください。 手記： format オブジェクトで呼び出されるバナー サイズは、取引を介して許可されるサイズを表すものではありません。 |
ext |
object | サポートされていません。 |
Format オブジェクト
banner オブジェクトのformat オブジェクトでは、次のフィールドがサポートされています。
| フィールド | 種類 | 説明 |
|---|---|---|
w |
integer | クリエイティブの幅をピクセル単位で指定します。 |
h |
integer | クリエイティブの高さをピクセル単位で指定します。 |
Video オブジェクト
ビデオインプレッションの場合、次のフィールドがサポートされています。
| フィールド | 種類 | 説明 |
|---|---|---|
mimes |
文字列の配列 | (必須)サポートされるビデオ コンテンツ MIME の種類を指定します。たとえば、 video/x-ms-wmv や video/x-flvなどです。 |
minduration |
integer | (推奨)ビデオ広告の最小再生時間を秒単位で指定します。 |
maxduration |
integer | (推奨)ビデオ広告の最大再生時間を秒単位で指定します。 |
w |
integer | (推奨)ビデオ プレーヤーの幅をピクセル単位で指定します。 |
h |
integer | (推奨)ビデオ プレーヤーの高さをピクセル単位で指定します。 |
startdelay |
integer | (推奨)動画広告の開始遅延を指定します。 - > 0: 0 より大きい値の場合、ビデオ開始前の遅延 (秒単位)。- 0: プリロール。- -1: 汎用ミッドロール。- -2: 汎用ポストロール。 |
battr |
整数の配列 | ブロックするビデオ クリエイティブ属性を指定します。 属性の一覧については、IAB 仕様のセクション 5.3 を参照してください。 |
minbitrate |
integer | 最小ビット レート (キロバイト/秒)。 |
maxbitrate |
integer | 最大ビット レート (キロバイト/秒)。 |
playbackmethod |
整数の配列 | 許可される再生方法を指定します。 指定しない場合、すべてが許可されるものと見なされます。 現在サポートされている値は次のとおりです。 - 1: 自動再生、サウンドオン。- 2: 自動再生、サウンドオフ。- 3: クリックして再生します。- 4:マウスオーバーして再生します。 |
api |
整数の配列 | このインプレッションでサポートされている API フレームワークを指定します。 API が明示的に一覧表示されていない場合は、サポートされていないと見なされます。 現在サポートされている値は次のとおりです。 - 1: VPAID 1.0- 2: VPAID 2.0- 3: MRAID-1- 4: ORMMA- 5: MRAID-2- 6: MRAID-3- 7: OMID-1 |
protocols |
整数の配列 | サポートされているビデオ プロトコルの配列。 現在サポートされている値は次のとおりです。 - 1: VAST 1.0- 2: VAST 2.0- 3: VAST 3.0- 4: VAST 1.0 Wrapper- 5: VAST 2.0 Wrapper- 6: VAST 3.0 Wrapper- 7: VAST 4.0- 8: DAAST 1.0 |
placement |
integer | インプレッションの配置の種類。 使用可能なオプション: - 1: In-Stream- 2: バナー内- 3: 記事内- 4: インフィード- 5: スポット/スライダー/フローティング |
linearity |
integer | インプレッションが線形、非線形などである必要があるかどうかを示します。何も指定しない場合は、すべて許可されていると仮定します。 - 1: 線形/In-Stream- 2: 非線形/オーバーレイ |
ext |
object | ビデオ オブジェクトの OpenRTB へのプラットフォーム固有の拡張機能を識別するために使用されます。 以下の 「Video Extension オブジェクト」を 参照してください。 |
ビデオ拡張オブジェクト
video オブジェクトに対する Xandr 固有の拡張機能をサポートするために、ext オブジェクト内の 1 つのオブジェクトをサポートします。
| フィールド | 種類 | 説明 |
|---|---|---|
appnexus |
object | ビデオ オブジェクトに対するプラットフォーム固有の拡張機能を指定します。 |
Video AppNexus オブジェクト
video オブジェクトのappnexus拡張オブジェクトでは、次のフィールドがサポートされています。
| フィールド | 種類 | 説明 |
|---|---|---|
context |
integer | ビデオ コンテキストを指定します。 - 0：不明- 1: プリロール- 2: ミッドロール- 3: ポストロール- 4: Outstream- 5: BannerStream- 6: インフィード- 7：間隙 |
Audio オブジェクト
| フィールド | 種類 | 説明 |
|---|---|---|
mimes |
文字列の配列 | (必須)サポートされるオーディオ コンテンツ MIME の種類を指定します。たとえば、 audio/vnd.wav、 audio/mpeg、 audio/mp4、 audio/ogg、 audio/mp2などです。 |
minduration |
integer | (推奨)オーディオ広告の最小再生時間を秒単位で指定します。 |
maxduration |
integer | (推奨)オーディオ広告の最大再生時間を秒単位で指定します。 |
startdelay |
integer | (推奨)オーディオ広告の開始遅延を指定します。 - > 0: 0 より大きい値の場合、オーディオ開始前の遅延 (秒単位)。- 0: プリロール。- -1: 汎用ミッドロール (遅延不明)。- -2: 汎用ポストロール。 |
battr |
整数の配列 | ブロックするオーディオ クリエイティブ属性を指定します。 次のサポートを行います。 - 11：調査- 16: 広告はスキップ ボタンを提供します |
minbitrate |
integer | 最小ビット レート (キロバイト/秒)。 |
maxbitrate |
integer | 最大ビット レート (キロバイト/秒)。 |
api |
整数の配列 | このインプレッションでサポートされている API フレームワークを指定します。 API が明示的に一覧表示されていない場合は、サポートされていないと見なされます。 現在サポートされている値は次のとおりです。 - 1: VPAID 1.0- 2: VPAID 2.0- 3: MRAID-1- 4: ORMMA- 5: MRAID-2- 6: MRAID-3- 7: OMID-1 |
ネイティブ オブジェクト
ネイティブ インプレッションの場合、クリエイティブ マークアップを含む次のフィールドがサポートされます。
| フィールド | 種類 | 説明 |
|---|---|---|
request |
string | 配信されるレンダリングされたクリエイティブ マークアップ。ネイティブ クリエイティブは、このフィールドで JSON でエンコードされた文字列として返すことができます。 文字列の最初の値は nativeする必要があります。 ネイティブ入札要求の例については、以下の 「要求オブジェクト 」および「 入札要求の例」を参照してください。 |
Request オブジェクト
ネイティブ インプレッションの場合、 request オブジェクトには、次のフィールドにクリエイティブ オブジェクトが含まれます。
| フィールド | 種類 | 説明 |
|---|---|---|
ver |
string | (推奨)現在使用されているネイティブ広告仕様のバージョンを指定します。 現在、バージョン 1.1 と 1.2 がサポートされています。 |
plcmtcnt |
integer | 入札要求で使用できる同一の配置の数を指定します。 通常は 1されますが、入札要求がフィード内に複数の配置があるフィードに対する場合は、別の整数にすることができます。 |
plcmttype |
integer | 提供されている広告ユニットのデザイン/フォーマット/レイアウト。 Xandr は、次のいずれかの値を送信します。 - 1: コンテンツのフィード内。- 4: レコメンデーション ウィジェット。 |
privacy |
ブール値 | 販売者が購入者固有のプライバシーに関する通知をサポートしているかどうかを示すフラグ。 - 0 または存在しない: ネイティブ広告はカスタム プライバシー リンクをサポートしていません。- 1: ネイティブ広告では、購入者固有のプライバシーに関する通知がサポートされます。 |
assets |
オブジェクトの配列 | 入札応答で返される予定の資産の一覧を指定します。 以下 の「Assets オブジェクト」を 参照してください。 |
Assets オブジェクト
native オブジェクトの assets オブジェクトでは、次のフィールドがサポートされています。
| フィールド | 種類 | 説明 |
|---|---|---|
id |
integer | この入札要求の資産の一意の識別子を指定します。 通常、配列の最初のアセットは 1 され、以降のアセットはそこからインクリメントされます。 |
required |
integer | 資産が必要かどうかを指定します。 - 0: 資産は省略可能です。- 1: 資産が必要です。 |
title |
object | 資産のタイトルに関する情報を指定します。 以下の 「Title オブジェクト」を 参照してください。 |
img |
object | 資産のイメージに関する情報を指定します。 以下の 「Image オブジェクト」を 参照してください。 |
data |
object | 資産のデータに関する情報を指定します。 以下 の「Assets Data Object」を 参照してください。 |
video |
object | アセットのビデオに関する情報を指定します。 以下のアセットについては、「 Video オブジェクト」を 参照してください。 |
Title オブジェクト
assets オブジェクトの title オブジェクトでは、次のフィールドがサポートされています。
| フィールド | 種類 | 説明 |
|---|---|---|
len |
integer | タイトル内のテキストの最大長。 |
画像オブジェクト
assets オブジェクトの img オブジェクトでは、次のフィールドがサポートされています。
| フィールド | 種類 | 説明 |
|---|---|---|
type |
integer | 発行元から要求された image 要素の型 ID を指定します。 サポートされている値は次のとおりです。 - 1: 小さい画面サイズ (icon_img_url) で使用するためのアイコン画像。 - 3: 大きな画面サイズ (main_media) で使用する広告の大きな画像プレビュー。 |
w |
integer | イメージの正確な幅をピクセル単位で指定します。 |
wmin |
integer | イメージの最小要求幅をピクセル単位で指定します。 含まれている場合、この値は、クライアントによるイメージの再スケーリングに使用する必要があります。 w または wmin の両方が含まれている場合は、正確な幅として w を使用します。 |
h |
integer | イメージの高さをピクセル単位で指定します。 |
hmin |
integer | イメージの要求される最小高さをピクセル単位で指定します。 含まれている場合、この値は、クライアントによるイメージの再スケーリングに使用する必要があります。 h と hmin の両方が含まれている場合は、正確な高さとして h を使用します。 |
mimes |
文字列の配列 | サポートされる画像コンテンツ MIME の種類を指定します。 すべてのイメージの種類がサポートされるため、空にする必要があります。 |
Assets データ オブジェクト
assets オブジェクトの data オブジェクトでは、次のフィールドがサポートされています。
| フィールド | 種類 | 説明 |
|---|---|---|
type |
integer | パブリッシャーがサポートする要素の型 ID を指定します。 発行元は、この情報を適切な形式で表示できます。 サポートされている値は次のとおりです。 - 1: sponsored - 「スポンサー」メッセージ。応答にスポンサーのブランド名が含まれています- 2: desc - アドバタイズされる製品またはサービスに関連付けられている説明テキスト- 3: rating - ユーザーに提供されている製品の評価。 たとえば、0 から 5 のアプリ ストアでのアプリの評価です。- 12: ctatext - 宛先 URL の [アクションの呼び出し] ボタンの説明テキスト |
len |
integer | 要素の応答内のテキストの最大長。 |
イベント トラッカー要求オブジェクト
event trackers request オブジェクトでは、次のフィールドがサポートされています (ネイティブ 1.2 のみ)。
| フィールド | 種類 | 説明 |
|---|---|---|
event |
integer | 追跡に使用できるイベントの種類。 サポートされている値は次のとおりです。 - 1: impression - 印象- 2: viewable-mrc50 - MRC 定義を使用した表示可能なインプレッションが 50% で 1 秒間表示されます。- 3: viewable-mrc100 - MRC 定義を使用した表示可能なインプレッションが 1 秒間 100% 表示されます (つまり、GroupM 標準)。- 4: viewable-video50 - MRC 定義を 50% で 2 秒間表示するビデオの表示可能なインプレッション。- 555: custom value to signify OMID |
methods |
整数の配列 | 指定されたイベントで使用できる追跡の種類の配列。 サポートされている値は次のとおりです。 - 1: img - Img-pixel tracking - 指定された URL は、イベントの時点で 1x1 ピクセルとして挿入されます。- 2: js - Javascript ベースの追跡 - 指定された URL は、イベントの時点で js タグとして挿入されます。 |
アセットの Video オブジェクト
assets オブジェクトの video オブジェクトでは、次のフィールドがサポートされています。
| フィールド | 種類 | 説明 |
|---|---|---|
mimes |
文字列の配列 | サポートされているコンテンツ MIME の種類。 供給側からの入札要求で MIME が指定されていない場合は、既定で通常のビデオとモバイル用の“video/x-flv”に“video/mp4”されます。 |
minduration |
integer | ビデオ広告の最小再生時間 (秒)。 |
maxduration |
integer | 動画広告の最大再生時間 (秒単位)。 |
protocols |
整数の配列 | パブリッシャーが入札応答で受け入れることができるビデオ プロトコルの配列。 現在サポートされている値は次のとおりです。 - 1: VAST 1.0- 2: VAST 2.0- 3: VAST 3.0- 4: VAST 1.0 Wrapper- 5: VAST 2.0 Wrapper- 6: VAST 3.0 Wrapper- 7: VAST 4.0- 8: DAAST 1.0 |
プライベート マーケットプレース オブジェクト
このインプレッションに適用される可能性のある買い手と売り手間のプライベート マーケットプレース (取引) をサポートするために、imp オブジェクトの pmp オブジェクトの次のフィールドをサポートします。
| フィールド | 種類 | 説明 |
|---|---|---|
private_auction |
integer |
deals オブジェクトでという名前のシートのオークションの適格性を示します。- 0: すべての入札が受け入れられます。- 1: 指定した取引の入札のみが受け付けられます。 |
deals |
オブジェクトの配列 | この入札の取引に関する情報を指定します。 以下の 「Deal オブジェクト」を 参照してください。 |
Deal オブジェクト
pmp オブジェクトの deal オブジェクトでは、次のフィールドがサポートされています。
| フィールド | 種類 | 説明 |
|---|---|---|
id |
string | (必須)取引の一意識別子を指定します。 |
bidfloor |
浮動小数点数 | 既定の通貨 (USD) を使用して、取引の最小入札価格を CPM で指定します。 省略した場合、既定値は 0.00。 |
at |
integer | 入札要求の全体的なオークションの種類のオプションのオーバーライド。 省略した場合、既定値は 2。- 1: 最初の価格。- 2: 2 番目の価格と 1 セント (既定値)。- 3: 入札フロアは、合意された取引価格(固定価格)です。 |
wseat |
文字列の配列 | この取引で入札できる購入者シート ID の一覧を指定します。 座席指定がない場合は、すべての購入者が対象となります。 |
ext |
object | 取引オブジェクトの OpenRTB へのプラットフォーム固有の拡張機能を識別するために使用されます。 以下の 「取引拡張オブジェクト」 を参照してください。 |
Deal 拡張オブジェクト
deal オブジェクトに対するプラットフォーム固有の拡張機能をサポートするために、ext オブジェクト内の 1 つのオブジェクトをサポートします。
| フィールド | 種類 | 説明 |
|---|---|---|
appnexus |
object | 取引オブジェクトに対するプラットフォーム固有の拡張機能を指定します。 |
Deal AppNexus オブジェクト
deal オブジェクトのappnexus拡張オブジェクトでは、次のフィールドがサポートされています。
| フィールド | 種類 | 説明 |
|---|---|---|
ad_quality_override |
integer | 取引がクリエイティブを処理する方法を指定します。 - 1: クリエイティブは既存の広告品質設定を使用します (既定)。- 2: "保留中" の監査状態のクリエイティブが配信されます。 これらのクリエイティブが監査されると、既存の広告品質設定が使用されます。- 3: この取引には広告プロファイルの制限は適用されません (最大信頼)。 |
allowed_media_types |
整数の配列 | この取引で許可されるメディアの種類の ID を指定します。 メディアの種類の一覧については、「 展開可能なメディアとリッチ メディア」を参照してください。 メインの入札要求オブジェクトと比較して、この取引に一意のメディアの種類がない場合、このフィールドは空の配列になります。 これは、取引がメディアの種類を許可しないことを意味するものではありません。代わりに、メインの入札オブジェクト上のメディアタイプ(特に"バッター"オブジェクトに記載されていないもの)がこの取引に入札するときに使用できることを意味します。 この配列が設定されている場合は、この取引で許可されているメディアの種類の完全なリストが含まれます。 |
allowed_media_subtypes |
整数の配列 | この取引で許可されるメディア サブタイプの ID を指定します。 メディア サブタイプの一覧については、「 展開可能なメディアとリッチ メディア」を参照してください。 メインの入札要求オブジェクトと比較して、この取引の一意のメディア サブタイプがない場合、このフィールドは空の配列になります。 これは、取引でメディア サブタイプが許可されないことを意味するものではありません。代わりに、メイン入札オブジェクト (特に "バッター" オブジェクトに記載されていないもの) のメディア サブタイプを、この取引で入札するときに使用できることを意味します。 この配列が設定されている場合は、この取引で許可されているサブメディアの種類の完全な一覧が含まれます。 |
sizes |
オブジェクトの配列 | この取引で許可されるクリエイティブ サイズを指定します。 この配列が設定されている場合は、この取引で許可されるサイズの完全なリストが含まれます。 取引で許可されるサイズは、メインの入札要求オブジェクトで許可されているもののサブセットである必要はありません。 配列が空の場合は、この取引に一意のサイズがないことを意味し、代わりにメインの bid オブジェクトから許可されるサイズを使用する必要があります。 以下の 「サイズ オブジェクト」を 参照してください。 |
sc |
integer | 取引オブジェクトの wseat フィールドが購入者シート ID を渡すかどうかを指定します。 このフィールドは、DSP の購入者シート ID で設定された取引にのみ存在し、 "1"の値を渡します。 |
gtd |
integer | 取引がプログラムによる保証かどうかを指定します。 このフィールドは、プログラム保証として設定された取引にのみ存在し、 "1"の値を渡します。 |
サイズ オブジェクト
deal ext オブジェクトの sizes オブジェクトで次のフィールドをサポートします。
| フィールド | 種類 | 説明 |
|---|---|---|
w |
integer | この取引で許可されるクリエイティブの幅をピクセル単位で指定します。 |
h |
integer | この取引で許可されるクリエイティブの高さをピクセル単位で指定します。 |
インプレッション拡張オブジェクト
imp オブジェクトに対するプラットフォーム固有の拡張機能をサポートするために、ext オブジェクト内の 1 つのオブジェクトをサポートします。
| フィールド | 種類 | 説明 |
|---|---|---|
appnexus |
object | インプレッション オブジェクトに対するプラットフォーム固有の拡張機能を指定します。 |
Impression AppNexus オブジェクト
imp オブジェクトのappnexus拡張オブジェクトでは、次のフィールドがサポートされています。
| フィールド | 種類 | 説明 |
|---|---|---|
estimated_clear_price |
double | インプレッション獲得に必要な見積もりクリア価格を指定します。 価格は発行元の通貨と見なされます。 指定しない場合は、通貨単位を指定する必要があります。 |
predicted_view_rate |
double | 過去のデータに基づいて、測定された表示インプレッションの割合としてユーザーがインプレッションを表示できる確率を指定します。 |
predicted_view_rate_over_total |
double | 履歴データに基づいて、すべての表示インプレッションに対してユーザーがインプレッションを表示できる確率を指定します。 |
predicted_video_view_rate_over_total |
double | 過去のデータに基づいて、すべてのビデオインプレッションに対してユーザーがインプレッションを表示できる確率を指定します。 |
predicted_video_view_rate |
double | 過去のデータに基づいて、測定されたビデオインプレッションの割合としてユーザーがインプレッションを表示できる確率を指定します。 |
member_ad_profile_id |
integer | 販売者の広告プロファイル ID を指定します。 |
allowed_payment_types |
オブジェクトの配列 | このインプレッションに対して許容される支払いの種類を指定します。 このフィールドが存在しない場合、許可される支払いタイプは 'impression'のみです。手記： このオブジェクトは、すべてのクライアントで有効になっているわけではありません。 この機能については、アカウント担当者にお問い合わせください。 |
traffic_source_code |
string | このインプレッションのサード パーティ トラフィックの外部ソースを指定します。 |
predicted_video_completion_rate |
double | 履歴データに基づいて、ユーザーがビデオインプレッションを完全に表示する確率を指定します。 |
gpid |
string | ページ上の特定の広告の配置を示すためにパブリッシャーによって提供されるグローバル配置レベルの識別子。 |
許可される支払タイプ オブジェクト
allowed_payment_types オブジェクトでは、次のフィールドがサポートされています。
注:
このオブジェクトは、すべてのクライアントで有効になっているわけではありません。 この機能については、アカウント担当者にお問い合わせください。
| フィールド | 種類 | 説明 |
|---|---|---|
payment_type |
integer | このインプレッションに許可される支払いの種類を指定します。 現在サポートされている値: - 1：印象- 2: ビュー - 標準表示- 6: ビュー - カスタム ディスプレイ - 100pv1s- 8: 景色 - 標準ビデオ- 9: Views - Custom Video - 100pv50pd |
conversion_rate |
double | Xandr がインプレッション以外の入札をオークションの入札ランキングの eCPM 価格に変換するために使用するレートを指定します。 入札者は、内部入札の順位付け、予算設定/ペース設定、または他の入札者に対してこれを使用する場合があります。 |
imp_count_method |
int | インプレッションのカウント方法を指定します。 現在サポートされている値: - 0: 該当なし- 1：不明- 2: レンダリング時のカウント- 3: 意思決定/サービスのカウント |
詳細については、「 概要 」ページを参照してください。
Site オブジェクト
サイト (配置グループとも呼ばれます) は、パブリッシャーのインベントリのサブセットです。
site オブジェクトでは、次のフィールドがサポートされています。
| フィールド | 種類 | 説明 |
|---|---|---|
id |
string | 推奨。 Xandr サイト ID を指定します。 販売者の可視性で共有が禁止されている場合は省略されます。 入札者は ID が対応するサイトを検索できませんが、これらの ID は匿名で最適化可能なインベントリ チャンクとして使用できます。 |
domain |
string | サイトのドメイン (たとえば、 publishersite.com) を指定します。 販売者の可視性で共有が禁止されている場合は省略されます。 |
cat |
文字列の配列 | コンテンツ カテゴリの一覧を指定します。 IAB カテゴリが含まれます (仕様のセクション 5.1 に記載されています)。 販売者の可視性設定で共有が禁止されている場合は省略されます。 |
page |
string | インプレッションが表示されるページの完全な URL を指定します (たとえば、 page.publishersite.com/path/to/page)。 販売者の可視性設定で共有が禁止されている場合は省略されます。 可視性プロファイルでドメインのみが公開されている場合は、完全な URL の代わりにドメインが含まれます。 |
publisher |
object | 発行元に関する情報を指定します。 販売者の可視性設定で共有が禁止されている場合は省略されます。 下 の「Publisher オブジェクト」を 参照してください。 |
content |
object | サイト内のコンテンツの詳細。 以下の コンテンツ オブジェクトを 参照してください。 |
ext |
object | アプリ拡張機能フィールドを保持するために使用されます。 以下の サイト拡張オブジェクト を参照してください。 |
サイト拡張オブジェクト
サイト オブジェクトの ext オブジェクトでは、次のフィールドがサポートされています。
| フィールド | 種類 | 説明 |
|---|---|---|
inventorypartnerdomain |
object | このフィールドに渡された値は、ディレクティブ inventorypartnerdomain=[このフィールドの値] に対してアプリの app-ads.txt ファイルを確認するように app-ads.txt エンフォーサに指示します。 |
アプリ オブジェクト
app オブジェクトでは、次のフィールドがサポートされています。
| フィールド | 種類 | 説明 |
|---|---|---|
id |
string | Xandr アプリ ID を指定します。 販売者の可視性で共有が禁止されている場合は省略されます。 入札者は ID が対応するサイトを検索できませんが、これらの ID は匿名で最適化可能なインベントリ チャンクとして使用できます。 |
bundle |
string | アプリケーション バンドルまたはパッケージ名 (例: com.foo.mygame) を指定します。 これは、複数の交換で一意の ID を使用することを目的としています。 iOS の場合、これは iTunes アプリ ID (数値 ID) になります。 販売者の可視性で共有が禁止されている場合は省略されます。 |
cat |
文字列の配列 | コンテンツ カテゴリの一覧を指定します。 IAB カテゴリが含まれます (仕様のセクション 5.1 に記載されています)。 販売者の可視性設定で共有が禁止されている場合は省略されます。 |
publisher |
object | 発行元に関する情報を指定します。 販売者の可視性設定で共有が禁止されている場合は省略されます。 下 の「Publisher オブジェクト」を 参照してください。 |
name |
string | アプリのフル ネーム (怒っている鳥など)。 (この値は、発行元の要求でエイリアス化される場合があります)。 |
content |
object | サイト内のコンテンツの詳細。 以下の コンテンツ オブジェクトを 参照してください。 |
storeurl |
string | インストールされているアプリのアプリ ストア URL。 |
ext |
object | アプリ拡張機能フィールドを保持するために使用されます。 以下の 「アプリ拡張機能オブジェクト」を 参照してください。 |
Publisher オブジェクト
publisher オブジェクトでは、次のフィールドがサポートされています。
| フィールド | 種類 | 説明 |
|---|---|---|
id |
string | Xandr パブリッシャー ID を指定します。 販売者の可視性設定で共有が禁止されている場合は省略されます。 |
Content オブジェクト
Xandr では、Content オブジェクトの次のフィールドがサポートされています。
| フィールド | 種類 | 説明 |
|---|---|---|
genre |
string | コンテンツを最もよく表すジャンル (ロック、ポップなど)。 |
id |
string | コンテンツを一意に識別する ID。 |
language |
string | ISO-639-1-alpha-2 を使用したコンテンツ言語。 |
ext |
object | OpenRTB への Exchange 固有の拡張機能のプレースホルダー。 |
episode |
integer | エピソード番号。 |
title |
string | コンテンツ タイトル。 ビデオの例: "検索委員会" (テレビ)、"新しい希望" (映画)、または "Endgame" (Web 用に作成)。 ビデオ以外の例: "なぜ南極氷河がこんなに早く溶けているのか" (タイム誌の記事)。 |
series |
string | ビデオの例: "The Office" (テレビ)、"Star Wars" (映画)、または "Arby 'N' The Chief" (Web 用)。 ビデオ以外の例: "Ecocentric" (タイム マガジン ブログ)。 |
season |
string | コンテンツ シーズン ("シーズン 3" など)。 |
artist |
string | コンテンツでクレジットされたアーティスト。 |
album |
string | コンテンツが属するアルバム。通常はオーディオ用です。 |
isrc |
string | ISO-3901に準拠した国際標準記録コード。 |
producer |
object | コンテンツ Producerの詳細。 IAB 仕様のセクション 3.2.12 を参照してください。 |
url |
string | 購入側のコンテキスト化またはレビュー用のコンテンツの URL。 |
cat |
文字列配列 | コンテンツ プロデューサーを記述する IAB コンテンツ カテゴリの配列。 IAB 仕様のリスト 5.1 を参照してください。 |
prodq |
integer | 生産品質。 IAB 仕様のリスト 5.11 を参照してください。 |
videoquality |
integer | prodq を優先して非推奨になりました。 ビデオ品質。 IAB 仕様のリスト 5.11 を参照してください。 |
context |
integer | コンテンツの種類 (ゲーム、ビデオ、テキストなど)。 IAB 仕様のリスト 5.16 を参照してください。 |
contentrating |
string | コンテンツレーティング (MPAA など)。 |
userrating |
string | コンテンツのユーザー評価 (例: 星の数、いいねなど)。 |
qagmediarating |
integer | IQG ガイドラインごとのメディアレーティング。 IAB 仕様のリスト 5.17 を参照してください。 |
keywords |
string | コンテンツを記述するキーワードのコンマ区切りリスト。 |
livestream |
integer |
0 = ライブではありません。 1 = コンテンツはライブです (ストリーム、ライブ ブログなど)。 |
sourcerelationship |
integer |
0 = 間接、 1 = 直接。 |
len |
integer | コンテンツの長さ (秒単位)。ビデオまたはオーディオに適しています。 |
data |
object 配列 | その他のコンテンツ データ。 各 Data オブジェクトは、異なるデータ ソースを表します。 IAB 仕様のセクション 3.2.16 を参照してください。 |
コンテンツ拡張機能オブジェクト
Xandr では、ext オブジェクトで次のフィールドがサポートされています。
| フィールド | 種類 | 説明 |
|---|---|---|
network |
string | 最上位の親企業、または関連する場合は、複数のテレビのようなチャネル、d2c コンテンツ ブランド、またはコンテンツが表示されているデジタル プロパティを所有するサブブランド。 |
アプリ拡張機能オブジェクト
アプリ オブジェクトの ext オブジェクトでは、次のフィールドがサポートされています。
| フィールド | 種類 | 説明 |
|---|---|---|
inventorypartnerdomain |
string | このフィールドに渡された値は、ディレクティブ inventorypartnerdomain=[このフィールドの値] に対してアプリの app-ads.txt ファイルを確認するように app-ads.txt エンフォーサに指示します。 |
Device オブジェクト
device オブジェクトでは、次のフィールドがサポートされています。
| フィールド | 種類 | 説明 |
|---|---|---|
ua |
string | (推奨)ブラウザーからのユーザー エージェント文字列を指定します。 ユーザー エージェントは、多くの場合、ユーザーに代わって動作するアプリケーション、オペレーティング システム、ソフトウェア ベンダーなどの情報 (たとえば、 "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.5; en-US; rv:1.9.0.4) Gecko/2008102920 Firefox/3.0.4") を識別します。 |
geo |
object | デバイスの位置情報サービス (セル タワーの三角形分割や GPS など) または IP アドレスから派生したデバイスの場所を指定します。 また、タイムゾーンと指定された市場領域のコードも含まれます。 注: geo は IP をオーバーライドします。 詳細については、「 Geo オブジェクト」を参照してください。 |
dnt |
integer | [追跡不可] 設定を指定します。 - 0: ブラウザーで [追跡不可] が false に設定されています (追跡は許可されます)。- 1: ブラウザーで [追跡不可] が true に設定されています (ユーザーが追跡をオプトアウトしました)。 |
ip |
string | デバイスに最も近い IPv4 アドレスを指定します。 販売者の可視性設定で共有が禁止されている場合は省略されます。 |
ipv6 |
string | IPv6 としてデバイスに最も近い IP アドレス。 |
devicetype |
integer | IAB 値を使用して、デバイスの種類を指定します。 - 1: モバイル/タブレット- 2：パソコン- 3: 接続されたテレビ- 4：電話- 5：錠剤- 6: 接続されたデバイス- 7: トップボックスの設定 |
make |
string | デバイスのメイクを指定します。 |
model |
string | デバイスのモデルを指定します。 |
os |
string | デバイスのオペレーティング システムを指定します。 渡された場合、ua フィールドのオペレーティング システムがオーバーライドされます。 os フィールドで使用できる値を次に示します。 - "不明" - "Android" - "Apple iOS" - "Apple Mac" - "Microsoft Windows" - "Blackberry OS" - "Microsoft Mobile" - "Linux" - "Symbian OS" - "Chrome OS" - "PlayStation 4 OS" - "Firefox OS" - "Roku OS" |
language |
string | ブラウザー言語を指定します。ISO 639-1 または ISO 3166 alpha-2 コードを使用します。 |
lmt |
integer | "Limit Ad Tracking" シグナルは、商用で承認されている (iOS、Android など)、0=tracking が無制限である場合、1=トラッキングは商用ガイドラインごとに制限する必要があります。 |
carrier |
string | デバイスの通信事業者を指定します。 |
connectiontype |
integer | IAB 値を使用して、デバイスの検出されたデータ接続の種類を指定します。 現在、次の値がサポートされています。 - 0：不明- 3: 携帯ネットワーク – 不明な世代 |
ifa |
string | クリアで広告主が使用するために承認される ID を指定します。 使用可能な場合は、iOS idfa、Android aaid、または Windows adid に設定します。 また、デバイス提供、発行元提供、またはその他のデバイス ID の種類 (該当する場合) を使用して、CTV インプレッションにも設定されます。 詳細については、「 ext.ifa_type」を参照してください。 販売者の可視性設定で共有が禁止されている場合は省略されます。 |
dpidsha1 |
string | SHA1 で暗号化されたプラットフォーム固有の (iOS の場合は ANDROID_ID または UDID など) モバイル デバイスの一意識別子を指定します。 販売者の可視性設定で共有が禁止されている場合は省略されます。 |
dpidmd5 |
string | MD5 で暗号化されたプラットフォーム固有の (iOS の場合は ANDROID_ID または UDID など) モバイル デバイスの一意識別子を指定します。販売者の可視性設定で共有が禁止されている場合は省略されます。 |
ext |
object | geo オブジェクトの OpenRTB へのプラットフォーム固有の拡張機能を識別するために使用されます。 以下の 「Geo 拡張オブジェクト」を 参照してください。 |
Geo オブジェクト
geo オブジェクトでは、次のフィールドがサポートされています。
| フィールド | 種類 | 説明 |
|---|---|---|
lat |
浮動小数点数 | デバイスの位置情報サービスから派生した、デバイスの緯度を指定します。 これは、 -90 から 90までの範囲です。 South は負です。 |
lon |
浮動小数点数 | デバイスの位置情報サービスから派生した、デバイスの経度を指定します。 これは、-180 から 180 までの範囲です。 West は負の値です。 |
country |
string | ISO-3166-1 Alpha-3 に従って国名を指定します。 |
region |
string | ISO-3166-2 を使用するリージョン コード。米国の場合は 2 文字の状態コード。 |
city |
string | 市区町村名を指定します。 販売者の可視性設定で共有が禁止されている場合は省略されます。 |
zip |
string | デバイスが配置されている郵便番号を指定します。 販売者の可視性設定で共有が禁止されている場合は省略されます。 |
metro |
string | IP アドレス (IP アドレスを決定できる場合) に基づいて、ユーザーの指定された市場領域のコードが含まれます。 |
utcoffset |
int | UTC からのオフセットとしてローカル時刻を示します。 |
ext |
object | geo オブジェクトの OpenRTB へのプラットフォーム固有の拡張機能を識別するために使用されます。 以下の 「Geo 拡張オブジェクト」を 参照してください。 |
Geo 拡張オブジェクト
geo オブジェクトに対するプラットフォーム固有の拡張機能をサポートするために、ext オブジェクト内の 1 つのオブジェクトをサポートします。
| フィールド | 種類 | 説明 |
|---|---|---|
appnexus |
object | geo オブジェクトに対するプラットフォーム固有の拡張機能を指定します。 このオブジェクトの拡張機能の一覧については、以下の 「Geo AppNexus オブジェクト 」を参照してください。 |
Geo AppNexus オブジェクト
geo オブジェクトのappnexus拡張オブジェクトでは、次のフィールドがサポートされています。
| フィールド | 種類 | 説明 |
|---|---|---|
timezone |
string | IP アドレスに基づくユーザーのタイム ゾーンが含まれます (IP アドレスを決定できる場合)。 |
デバイス拡張オブジェクト
device オブジェクトに対するプラットフォーム固有の拡張機能をサポートするために、ext オブジェクト内の 1 つのオブジェクトをサポートします。
| フィールド | 種類 | 説明 |
|---|---|---|
ifa_type |
string | IFA のソースを指定します。デバイスによって生成される (したがってアプリ間で使用される) か、発行元が提供する IFA か、一時的/セッション IFA かを指定します。 主に CTV インプレッションに使用されます。 IFA の種類は、デバイス、パブリッシャー (アプリを含む)、SSP、セッションです。 ifa_type パラメーターの推奨値を次に示します。- "dpid" - 一般的な "デバイス指定 ID" ですが、使用状況の履歴に基づいて、一般的なデバイスの種類固有の値を使用できます - "rida" - Roku id - "aaid" - Android ID - "idfa" - Apple ID - "afai" - Amazon Fire ID - "tifa" - Tizen Identifier for Advertising (Samsung Ad ID) - "vida" - Vizio Advertising ID - "lgudid" - LG 固有のデバイス ID - "msai" - Microsoft ID - "ppid" - 発行元が指定した ID - "sspid" - SSP が指定した ID - "sessionid" - セッション ID/合成 ID (後述) |
User オブジェクト
user オブジェクトでは、次のフィールドがサポートされています。
| フィールド | 種類 | 説明 |
|---|---|---|
id |
string | ( id または buyeruid をお勧めします) このユーザーの Xandr 一意 ID を指定します。 販売者の可視性設定で共有が禁止されている場合は省略されます。 ユーザーの一意の 64 ビット ID。 Cookie がクリアされるまで、このユーザーからの要求はすべて同じです。 このフィールドは、Xandr がこのユーザーと一致しない場合、またはユーザーのブラウザーが Cookie を受け入れない場合に 0 されます。 これは、オプトアウト ユーザーに -1 されます。 |
buyeruid |
string | ( id または buyeruid をお勧めします)このユーザーの購入者の一意の ID (既知の場合)。 販売者の可視性設定で共有が禁止されている場合は省略されます。 |
yob |
integer | 誕生年を 4 桁の整数として指定します。 不明な場合、または販売者の可視性設定で共有が禁止されている場合は省略されます。 |
gender |
string | 性別を指定します。 不明な場合は、 null に設定します。 不明な場合は省略するか、販売者の可視性設定で共有が禁止されます。- M：男性- F：女性- O：他 |
data |
オブジェクトの配列 | ユーザーのデータに関する情報を指定します。 以下の 「ユーザー データ オブジェクト」 を参照してください。 |
ext |
object | ユーザー オブジェクトの OpenRTB に対するプラットフォーム固有の拡張機能を識別するために使用されます。 |
ユーザー データ オブジェクト
user オブジェクトの data オブジェクトでは、次のフィールドがサポートされています。
| フィールド | 種類 | 説明 |
|---|---|---|
id |
string | データ プロバイダーの ID を指定します。 |
segment |
オブジェクトの配列 | 非推奨 (2019 年 4 月)。 |
ユーザー拡張オブジェクト
user オブジェクトに対するプラットフォーム固有の拡張機能をサポートするために、ext オブジェクトの次のフィールドがサポートされています。
| フィールド | 種類 | 説明 |
|---|---|---|
appnexus |
object | ユーザー オブジェクトに対するプラットフォーム固有の拡張機能を指定します。 このオブジェクトの拡張機能の一覧については、以下を参照してください。 |
consent |
string | 省略可能。 IAB ヨーロッパの後援の下で、一般データ保護規則 (GDPR) 同意ワーキング グループによって開発されたデータ構造が含まれています。 |
eids |
object | 拡張ユーザー ID に関連する情報を指定します。 これは、サード パーティの ID ソリューション (Criteo、TDID、RampID など) またはパブリッシャーが提供する識別子 (PPID) のいずれかです。 |
オブジェクト
注:
eids プライバシーシグナルが個人情報を処理できないことを示す場合は使用できません。
eids オブジェクトでは、次のフィールドがサポートされています。
| フィールド | 種類 | 説明 |
|---|---|---|
source |
string | サード パーティ ID のジェネレーターである組織のドメインを指定します。 |
uids |
オブジェクト | サード パーティの ID ソリューションまたは発行元に固有の ID 情報を指定します。 関連するフィールドは次のとおりです。 id string サード パーティ ID ソリューションまたはパブリッシャーによって提供されるユーザー ID。 ext オブジェクト サード パーティの ID ソリューションまたは発行元から提供される特定の追加情報を指定します。 Ext フィールドには、次のものが含まれます。 rtiPartner = TDID によって使用されるサード パーティの ID ソリューション名。 |
Segment オブジェクト
警告
このオブジェクトは非推奨です (2019)。
ユーザー data オブジェクトのsegment オブジェクトでは、次のフィールドがサポートされています。
| フィールド | 種類 | 説明 |
|---|---|---|
id |
string | Xandr セグメント ID を指定します。 |
value |
string | データ セグメントの値を指定します。 |
Regs オブジェクト
regs オブジェクトでは、次のフィールドがサポートされています。
| フィールド | 種類 | 説明 |
|---|---|---|
coppa |
integer | この要求が米国児童オンラインプライバシー保護法 (COPPA) の対象かどうかを示します。 - 0: COPPA の対象ではありません。 通常のオークションとして扱います。- 1: COPPA の対象です。 必要に応じて、ターゲット設定とログ記録に許可される内容を制限します。 |
ext |
object | reg オブジェクトの OpenRTB へのプラットフォーム固有の拡張機能を識別するために使用されます。 |
gpp |
実際の IAB GPP 同意文字列を示します。 これは、個人データを処理することが許可されているベンダーと、その条件を意味します。 例: { "Regs": { "ext": { "gpp": "DBACNYA~CPXxRfAPXxRfAAfKABENB-CgAAAAAAAAAAYgAAAAAAAA~1YNN", "gpp_sid": [2,6]} } } |
|
gpp_sid |
省略可能: 適用する規制または GPP ロジック、またはユーザーが GPP の一部であるフレームワークを持つ国 (EEA 国) に配置されているかどうかを示します。 例: { "Regs": { "ext": { "gpp": "DBACNYA~CPXxRfAPXxRfAAfKABENB-CgAAAAAAAAAAYgAAAAAAAA~1YNN", "gpp_sid": [2,6]} } } |
Regs 拡張オブジェクト
regs.ext オブジェクトでは、次のフィールドがサポートされています。
| フィールド | 種類 | 説明 |
|---|---|---|
gdpr |
integer | 省略可能。 要求が一般データ保護規則 (GDPR) 規制の対象であるかどうかを示します。 使用可能な値: - 0: いいえ。要求は GDPR 規制の対象ではありません。- 1: はい。要求は GDPR 規制の対象となります。[値なし] は [不明] を示します。 |
us_privacy |
string | 現在、米国プライバシー文字列では、次の情報を文字列に渡すことで CCPA コンプライアンスがサポートされています。 仕様バージョン 数値 (文字列内の 1 文字) 文字列のエンコードに使用されるこの文字列仕様のバージョン 明示的な通知/オプトアウトの機会 ENUM ( N = いいえ、 Y = はい、 - = 該当なし)CCPAの1798.115(d)およびCCPAの1798.120および1798.135に基づくデータの販売をオプトアウトする機会によって、明示的な通知が提供されている オプトアウト販売 ENUM ( N = いいえ、 Y = はい、 - = 該当なし)1798.120 および 1798.135 に従って、ユーザーが自分または個人情報の販売をオプトアウトした場合 LSPA ENUM ( N = いいえ、 Y = はい、 - = 該当なし)パブリッシャーは、契約で定義されている IAB 制限の署名者です。 d サービス プロバイダー契約 (LSPA) と発行元は、これらの条件が契約で定義されているため、トランザクションが "対象オプトアウト トランザクション" または "非オプトアウト トランザクション" としてカバーされることを宣言します。 これらの条項は、本契約で定義されています。 |
gpp |
実際の IAB GPP 同意文字列を示します。 これは、個人データを処理することが許可されているベンダーと、その条件を意味します。 例: { "Regs": { "ext": { "gpp": "DBACNYA~CPXxRfAPXxRfAAfKABENB-CgAAAAAAAAAAYgAAAAAAAA~1YNN", "gpp_sid": [2,6]} } } |
|
gpp_sid |
省略可能: 適用する規制または GPP ロジック、またはユーザーが GPP の一部であるフレームワークを持つ国 (EEA 国) に配置されているかどうかを示します。 例: { "Regs": { "ext": { "gpp": "DBACNYA~CPXxRfAPXxRfAAfKABENB-CgAAAAAAAAAAYgAAAAAAAA~1YNN", "gpp_sid": [2,6]} } } |
|
dsa |
要求がデジタル サービス法 (DSA) の対象かどうかを示します。 詳細については、こちらを参照してください。 例: { dsarequired: 1, pubrender: 0, transparency: [ { domain: 'request.tomato.com', dsaparams: [ 1 ] },{ domain: 'request2.tomato.com', dsaparams: [ 1, 2, 3 ] }],datatopub: 1 } |
Source オブジェクト
source オブジェクトでは、次のフィールドがサポートされています。
| フィールド | 種類 | 説明 |
|---|---|---|
fd |
integer | 最終的なインプレッション販売の決定を担当するエンティティ。次の場所: - 0: exchange (既定値)- 1: アップストリーム ソース |
tid |
string | この入札要求のすべての参加者に共通である必要があるトランザクション ID。 値は販売者から渡されます。 販売者がトランザクション ID を指定しない場合は、トランザクション ID を作成して共有します。 |
入札要求の例
バナー入札要求
{
"id": "8765482113786061111",
"imp": [{
"id": "7654319310942953333",
"banner": {
"w": 320,
"h": 50,
"id": "1",
"battr": [1, 2, 15],
"pos": 0,
"format": [{
"w": 320,
"h": 50
}]
},
"instl": 0,
"tagid": "12347654",
"secure": 1,
"ext": {
"appnexus": {
"estimated_clear_price": 0.57,
"predicted_view_rate": 0.073255,
"member_ad_profile_id": 1111055,
"predicted_video_completion_rate": 0.592172,
"predicted_view_rate_over_total": 0.067229,
"allowed_payment_types": [{
"payment_type": 1,
"imp_count_method": 2
}]
}
}
}],
"site": {
"id": "3232399",
"domain": "example.com",
"cat": ["IAB12-2", "IAB12", "IAB11-5"],
"page": "https://example.com/somepage.md",
"publisher": {
"id": "1111999"
}
},
"device": {
"ua": "Mozilla/5.0 (Linux; Android 6.0.1; HUAWEI Build/MMB28B) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/64.0.3282.137 Mobile Safari/537.36",
"geo": {
"lat": 36.6203,
"lon": -4.4998,
"country": "ESP",
"region": "MA",
"metro": "1",
"city": "UnaCuidad",
"zip": "11111",
"utcoffset": 60,
"ext": {
"appnexus": {
"timezone": "Africa/Ceuta"
}
}
},
"dnt": 0,
"ip": "11.222.111.0",
"devicetype": 4,
"make": "Unknown",
"model": "Generic Android Mobile",
"os": "Android",
"language": "es",
"connectiontype": 0
},
"user": {
"id": "7939999668795769876",
"buyeruid": "CABBBBrbuQ9AA5DMJJJJlOL9ZOo",
"gender": "O",
"data": [{
"id": "0",
"segment": [{
"id": "1",
"value": "0"
}]
}, {
"id": "1234",
"segment": [{
"id": "4444555",
"value": "0"
}]
}],
"ext": {
"appnexus": {
"userdata_json": "{\"uid\":\"CABBBBrbuQ9AA5DMJJJJlOL9ZOo\"}"
}
}
},
"test": 0,
"at": 1,
"tmax": 150,
"wseat": ["1234",..., "9988"],
"cur": ["USD"],
"bcat": ["IAB23-7", "IAB23-5", "IAB23-10", "IAB23-9", "IAB23-1", "IAB7-44", "IAB9-9", "IAB8-18", "IAB8-5"],
"badv": ["url1.com", "url2.com"],
"ext": {
"appnexus": {
"seller_member_id": 123,
"publisher_integration": {
"is_header": 0
}
},
"schain": {
"complete": 1,
"nodes": [{
"asi": "appnexus.com",
"sid": "123",
"rid": "2dd111ff-7777-4abc-8558-86a123ab46d6",
"hp": 1
}],
"ver": "1.0"
}
},
"source": {
"fd": 1,
"tid": "2dd111ff-7777-4abc-8558-86a123ab46d6"
}
}
ネイティブ 1.1 入札要求
{
"id": "123456789",
"imp": [{
"id": "987654321",
"native": {
"request": "{\"ver\":\"1.1\",\"plcmttype\": 4,\"plcmtcnt\": 1,\"assets\":[{\"id\": 1,\"required\": 1,\"title\":{\"len\": 140}},{\"id\": 4,\"required\": 1,\"img\":{\"type\": 3,\"wmin\": 600,\"hmin\": 315}},{\"id\": 2,\"required\": 0,\"img\":{\"type\": 1,\"wmin\": 320,\"hmin\": 180}},{\"id\": 6,\"required\": 1,\"data\":{\"type\": 2,\"len\": 205}},{\"id\": 5,\"required\": 1,\"data\":{\"type\": 1,\"len\": 140}}]}}",
"ver": "1.1"
},
"instl": 0,
"secure": 0,
"ext": {
"appnexus": {
"estimated_clear_price": 11.644000,
"member_ad_profile_id": 667317,
"predicted_view_rate_over_total": 0.000000
}
}
}],
"app": {
"id": "1234",
"bundle": "com.news.example"
},
"device": {
"ua": "iPad; OS like Mac OS X; iOS 9.2; STR 2.2.4",
"geo": {
"country": "USA",
"city": "Wilmington",
"zip": "01887"
},
"dnt": 0,
"ip": "198.51.100.2",
"devicetype": 1,
"make": "Apple",
"model": "iPad",
"os": "Apple iOS",
"connectiontype": 0
},
"user": {
"id": "2233445566",
"data": [{
"id": "0",
"segment": [{
"id": "1",
"value": "0"
}]
}],
"ext": {
"appnexus": {
"userdata_json": "{}"
}
}
},
"test": 0,
"at": 2,
"tmax": 2000,
"wseat": [
"1234"
],
"cur": [
"USD"
],
"ext": {
"appnexus": {
"seller_member_id": 1234
},
"schain": {
"complete": 1,
"nodes": [{
"asi": "appnexus.com",
"sid": "1234",
"rid": "25e2b11c-004f-4903-a912-5aef7732096b",
"hp": 1
}],
"ver": "1.0"
}
}
}
マルチメディア入札要求
これらの要求を受け取るために入札者が構成されていることを確認するには、サポート ケースを開きます。
{
"id": "914181541748747384",
"imp": [{
"id": "837746433617288491",
"banner": {
"w": 320,
"h": 250,
"id": "1",
"battr": [1, 2, 3, 4, 5, 9, 10, 12, 14],
"pos": 0,
"api": [3, 5],
"format": [{
"w": 320,
"h": 250
}, {
"w": 1,
"h": 1
}, {
"w": 1,
"h": 1
}]
},
"native": {
"request": "{\"ver\":\"1.2\",\"plcmtcnt\":1,\"assets\":[{\"id\":7,\"required\":0,\"img\":{\"type\":3}},{\"id\":8,\"required\":0,\"img\":{\"type\":1}},{\"id\":1,\"required\":0,\"title\":{\"len\":100}},{\"id\":2,\"required\":0,\"data\":{\"type\":2,\"len\":300}},{\"id\":3,\"required\":0,\"data\":{\"type\":12,\"len\":20}},{\"id\":4,\"required\":0,\"data\":{\"type\":1}},{\"id\":5,\"required\":0,\"data\":{\"type\":3}}],\"plcmttype\":4,\"eventtrackers\":[{\"event\":1,\"methods\":[1]}]}",
"ver": "1.2"
},
"instl": 0,
"tagid": "12345678",
"secure": 1,
"pmp": {
"private_auction": 0,
"deals": [{
"id": "345667",
"bidfloor": 4,
"bidfloorcur": "USD",
"at": 2,
"wseat": ["1234"],
"ext": {
"appnexus": {
"sizes": [{
"w": 1,
"h": 1
}, {
"w": 320,
"h": 250
}]
}
}
}, {
"id": "345678",
"bidfloor": 3,
"bidfloorcur": "USD",
"at": 2,
"wseat": ["1234"],
"ext": {
"appnexus": {
"sizes": [{
"w": 1,
"h": 1
}, {
"w": 320,
"h": 250
}]
}
}
}]
},
"ext": {
"appnexus": {
"estimated_clear_price": 10.72,
"predicted_view_rate": 0.784599,
"member_ad_profile_id": 23456,
"predicted_video_completion_rate": 0,
"predicted_view_rate_over_total": 0.764223,
"allowed_payment_types": [{
"payment_type": 1,
"imp_count_method": 2
}]
}
}
}],
"app": {
"id": "3840770",
"name": "FunAPP",
"bundle": "no.funapp.android",
"publisher": {
"id": "123567"
}
},
"device": {
"ua": "Mozilla/5.0 (Linux; Android 9; SM-G965F Build/PPR1.180610.011; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/74.0.3729.157 Mobile Safari/537.36",
"geo": {
"country": "NOR",
"region": "02",
"metro": "2435",
"city": "Hakadal",
"zip": "1487",
"utcoffset": 120,
"ext": {
"appnexus": {
"timezone": "Europe/Oslo"
}
}
},
"lmt": 0,
"ip": "123.23.100.5",
"devicetype": 4,
"make": "Samsung",
"model": "SM-G965F",
"os": "Android",
"connectiontype": 0,
"ifa": "0b3979c6-9c84-4359-a5e6-ee6565048fde",
"ext": {
"ifa_type": "aaid"
}
},
"user": {
"id": "4038657820804547795",
"buyeruid": "S5670DGCSRG"
},
"at": 2,
"tmax": 100,
"wseat": ["3456"],
"cur": ["USD"],
"bcat": ["IAB9-9", "IAB8-5", "IAB8-18"],
"badv": ["some_advertiser_domain.com"],
"regs": {
"coppa": 0
},
"source": {
"fd": 0,
"tid": "5676d767-e8b8-43b1-b7bf-fd6056b65018"
},
"ext": {
"appnexus": {
"seller_member_id": 1234,
"publisher_integration": {
"is_header": 0
}
},
"schain": {
"complete": 1,
"nodes": [{
"asi": "appnexus.com",
"sid": "1234",
"rid": "5676d767-e8b8-43b1-b7bf-fd6056b65018",
"hp": 1
}],
"ver": "1.0"
}
}
}
MultiTag 入札要求
{
"id": "5698201228871522665",
"imp": [{
"id": "13529449707735835",
"banner": {
"w": 300,
"h": 250,
"id": "1",
"battr": [1, 2, 3, 4, 5, 9, 10, 12, 14],
"pos": 0,
"format": [{
"w": 300,
"h": 250
}]
},
"instl": 0,
"tagid": "123456",
"secure": 1,
"ext": {
"appnexus": {
"estimated_clear_price": 0.5,
"member_ad_profile_id": 1234,
"allowed_payment_types": [{
"payment_type": 1,
"imp_count_method": 2
}]
}
}
},
{
"id": "2460698130037038280",
"banner": {
"w": 580,
"h": 400,
"id": "1",
"battr": [1, 2, 3, 4, 5, 9, 10, 12, 14],
"pos": 0,
"format": [{
"w": 580,
"h": 400
}, {
"w": 580,
"h": 500
}]
},
"instl": 0,
"tagid": "123457",
"secure": 1,
"ext": {
"appnexus": {
"estimated_clear_price": 12.4,
"member_ad_profile_id": 1235,
"allowed_payment_types": [{
"payment_type": 1,
"imp_count_method": 2
}]
}
}
}, {
"id": "5610871170052394076",
"banner": {
"w": 580,
"h": 400,
"id": "1",
"battr": [1, 2, 3, 4, 5, 9, 10, 12, 14],
"pos": 0,
"format": [{
"w": 580,
"h": 400
}, {
"w": 580,
"h": 500
}]
},
"instl": 0,
"tagid": "123478",
"secure": 1,
"ext": {
"appnexus": {
"estimated_clear_price": 11.14,
"member_ad_profile_id": 8765,
"allowed_payment_types": [{
"payment_type": 1,
"imp_count_method": 2
}]
}
}
}, {
"id": "9057531734780521319",
"banner": {
"w": 580,
"h": 400,
"id": "1",
"battr": [1, 2, 3, 4, 5, 9, 10, 12, 14],
"pos": 0,
"format": [{
"w": 580,
"h": 400
}, {
"w": 580,
"h": 500
}]
},
"instl": 0,
"tagid": "677",
"secure": 1,
"ext": {
"appnexus": {
"estimated_clear_price": 11.31,
"member_ad_profile_id": 65987,
"allowed_payment_types": [{
"payment_type": 1,
"imp_count_method": 2
}]
}
}
}, {
"id": "7953238633763561522",
"banner": {
"w": 160,
"h": 600,
"id": "1",
"battr": [1, 2, 3, 4, 5, 9, 10, 12, 14],
"pos": 0,
"format": [{
"w": 160,
"h": 600
}]
},
"instl": 0,
"tagid": "987345",
"secure": 1,
"ext": {
"appnexus": {
"estimated_clear_price": 18.91,
"member_ad_profile_id": 12345,
"allowed_payment_types": [{
"payment_type": 1,
"imp_count_method": 2
}]
}
}
}, {
"id": "6528429208551730965",
"banner": {
"w": 980,
"h": 300,
"id": "1",
"battr": [1, 2, 3, 4, 5, 9, 10, 12, 14],
"pos": 0,
"format": [{
"w": 980,
"h": 300
}, {
"w": 580,
"h": 400
}, {
"w": 580,
"h": 500
}]
},
"instl": 0,
"tagid": "34546",
"secure": 1,
"ext": {
"appnexus": {
"estimated_clear_price": 8.58,
"member_ad_profile_id": 3456,
"allowed_payment_types": [{
"payment_type": 1,
"imp_count_method": 2
}]
}
}
}, {
"id": "8731177004555232453",
"banner": {
"w": 160,
"h": 600,
"id": "1",
"battr": [1, 2, 3, 4, 5, 9, 10, 12, 14],
"pos": 0,
"format": [{
"w": 160,
"h": 600
}, {
"w": 180,
"h": 500
}, {
"w": 180,
"h": 700
}]
},
"instl": 0,
"tagid": "345637",
"secure": 1,
"ext": {
"appnexus": {
"estimated_clear_price": 8.78,
"member_ad_profile_id": 34567,
"allowed_payment_types": [{
"payment_type": 1,
"imp_count_method": 2
}]
}
}
}
],
"site": {
"id": "346789",
"domain": "xandr.com",
"cat": ["IAB12", "IAB12-2", "IAB11-5"],
"page": "xandr.com",
"publisher": {
"id": "876543"
}
},
"device": {
"ua": "Mozilla/5.0 (Linux; Android 9; SAMSUNG SM-G950U) AppleWebKit/537.36 (KHTML, like Gecko) SamsungBrowser/10.1 Chrome/71.0.3578.99 Mobile Safari/537.36",
"geo": {
"country": "USA",
"region": "FL",
"metro": "539",
"city": "Tampa",
"zip": "33617",
"utcoffset": -240,
"ext": {
"appnexus": {
"timezone": "America/Indiana/Vevay"
}
}
},
"dnt": 0,
"ip": "173.168.163.240",
"devicetype": 2,
"make": "Samsung",
"model": "SM-G950U",
"os": "Android",
"language": "en",
"connectiontype": 0,
"ext": {}
},
"user": {
"id": "6535227187230073444",
"buyeruid": "a_dsp_user_id",
"at": 1,
"tmax": 100,
"wseat": ["1417"],
"cur": ["USD"],
"regs": {
"coppa": 0
},
"source": {
"fd": 0,
"tid": "0edd5bae-91e7-4723-9f6b-21e942b623ce"
},
"ext": {
"appnexus": {
"seller_member_id": 958,
"publisher_integration": {
"is_header": 0
}
},
"schain": {
"complete": 1,
"nodes": [{
"asi": "appnexus.com",
"sid": "958",
"rid": "0edd5eab-91e7-4723-9f6b-21e912b623ce",
"hp": 1
}],
"ver": "1.0"
}
}
}
}