入札者からの受信入札応答
警告
ここでは、 OpenRTB 2.4 プロトコルの統合について説明します。
インプレッション バスから入札リクエストを受け取った後、入札者から 入札 応答が送信されます。 入札応答には、入札者の入札 (price
) と選択したクリエイティブ (creative_id
または creative_code
) が含まれます。 このクリエイティブは、広告サーバーが最終的に入札を承諾した場合に配信されます。 入札応答内の複数の入札が推奨されます。
実装
詳細が必要なオブジェクトを見つけるには、次のリンクを参照してください。
入札応答オブジェクト | シート入札オブジェクト| Bid オブジェクト | Bid Extension オブジェクト | AppNexus オブジェクト| カスタム マクロ オブジェクト| Bid Payment Type オブジェクト|
Xandr では、HTTP コード 204 を返す空の入札応答 (入札なし) を除き、すべての呼び出しで HTTP コード 200 が返されることを想定しています。 現在、入札応答オブジェクトでは次のフィールドがサポートされています。
入札応答オブジェクト
フィールド | 種類 | 説明 |
---|---|---|
id |
string | 必須: これが応答である入札要求の ID。 |
seatbid |
オブジェクトの配列 | 入札が行われた場合に必須: シート禁止オブジェクトを識別するために使用されます。 詳細については、「 シート入札オブジェクト 」を参照してください。 |
bidid |
string | 入札者の追跡を支援する入札応答 ID。 この値は、相互参照の入札者によって選択されます。 注: これは、マクロ ${AUCTION_BID_ID} の設定にのみ使用されます。 この情報は保存されません。 |
cur |
string | ISO-4217 アルファベットコードを使用した入札通貨。 省略した場合、既定値は USD です。 また、win 通知 URL とクリエイティブまたはピクセル ペイロードのマクロ ${AUCTION_CURRENCY} にも使用されます。 |
ext |
string | OpenRTB 入札応答オブジェクトに対するプラットフォーム固有の拡張機能を識別するために使用されます。 |
シート入札オブジェクト
Xandr では、 seatbid
オブジェクト内の次のフィールドがサポートされています。それぞれ異なる入札者シートを表し、1 つ以上の個別の入札が含まれています。
フィールド | 種類 | 説明 |
---|---|---|
bid |
オブジェクトの配列 |
必須: 入札オブジェクトの配列。各入札オブジェクトは、 入札要求のインプレッション オブジェクトに関連します。 注: 取引所でサポートされている場合、1 つのインプレッション オブジェクトに多数の入札オブジェクトを含めることができます。 詳細については、「 Bid オブジェクト 」を参照してください。 |
seat |
string |
必須: 入札者によってクリエイティブが選択され、Xandr member_id に対応するメンバーの ID。 また、win 通知 URL とクリエイティブまたはピクセル ペイロードに ${AUCTION_SEAT_ID} マクロを設定するためにも使用されます。注: - 購入者シート ID 入札に移行された DSP では、独自のシステムにネイティブな購入者 ID を使用できます。 これらの識別子は、Xandr システムのシート コードとして登録されます。 - この機能は現在、クローズド ベータ版です。 参加に興味がある場合は、Xandr の担当者にお問い合わせください。 |
Bid オブジェクト
フィールド | 種類 | 説明 |
---|---|---|
id |
string | 必須: bid オブジェクトの ID。これは、追跡とデバッグの目的で入札者によって選択されます。 特定のシートに対して 1 回のインプレッションに対して複数の入札が送信される場合に便利です。 |
impid |
string |
必須: この入札が適用されるインプレッション オブジェクトの ID。 入札リクエストのインプレッション オブジェクトの id フィールドと一致する必要があります。
${AUCTION_IMP_ID} マクロを設定するために使用できます。 |
price |
浮動小数点数 |
必須: CPM で表される入札価格。 また、 ${AUCTION_PRICE} マクロを設定するためにも使用されます。bid_payment_type が"Impression" に設定されていない場合、価格は入札の eCPM 価格になり、payment_type_price を使用して${{AUCTION_PRICE} macro.PRICE} マクロを設定します。注: bid_payment_type は、すべてのクライアントで有効になっているわけではありません。 この機能については、アカウント担当者にお問い合わせください。警告: この値は浮動小数点数ですが、OpenRTB は丸めエラーを回避するために、アカウンティングに整数演算を使用することを強くお勧めします。 |
adid |
string |
クリエイティブ サービスを使用して API を介して表示できる Xandr クリエイティブ ID。 この ID は、入札が成功した場合に配信される実際の広告を参照します。 ${AUCTION_AD_ID} マクロを設定するために使用できます。
adid とcrid の両方が渡された場合は、adid が優先されます。 |
nurl |
string | Win 通知 URL。Web ブラウザーまたは SDK にピクセルとしてドロップされます。 サーバーは、デバイスからクライアント側の通知を受け取ると、この URL に ping を実行します。これは、オークションに落札したことを示します。 応答はサーバー側に送信されます。 これは、インプレッションを記録するときに同時に発生します。 マクロが展開された最大長は 2,000 文字です。 通知 URL では、次のマクロがサポートされています。 ${AUCTION_ID} - Xandr auction_id_64 ${AUCTION_BID_ID} - 入札応答の [ bidid ] フィールドで指定された入札の ID${AUCTION_IMP_ID} - seatbid オブジェクトの bid オブジェクトのimpid フィールドからのインプレッションの ID${AUCTION_SEAT_ID} - seatbid オブジェクトのseat フィールドからの当選シートの ID${AUCTION_AD_ID} - 購入者のクリエイティブの ID。seatbid オブジェクトのbid オブジェクトのadid フィールドから${AUCTION_PRICE} - 入札応答の [ cur ] フィールドで指定した通貨でのインプレッションのクリア価格${AUCTION_CURRENCY} - 入札応答の [ cur ] フィールドで指定された決済価格の通貨${CREATIVE_CODE} - クリエイティブを登録するときに API を使用してcreative オブジェクトに設定されたcode フィールド${AN_PAYMENT_TYPE} - 入札応答の [ bid_payment_type ] フィールドに指定された支払いの種類の入札の ID注: - このマクロは、すべてのクライアントで有効になっているわけではありません。 この機能については、アカウント担当者にお問い合わせください。 - 前の一覧のマクロのみを通知 URL で使用できます。入札応答では他のマクロはサポートされていません。 |
lurl |
string |
警告: この機能は現在、クローズド ベータ テスト中であり、すべての入札者統合で使用できるわけではありません。 入札応答でこのフィールドを使用する場合は、アカウント担当者に連絡するか、 https://help.xandr.comでサポート チケットを提出してください。 入札が失われたことがわかっている場合に Xandr によって呼び出される損失通知 URL。 置換マクロを含めることができます。 応答はサーバー側に送信されます。 損失通知 URL では、次のマクロがサポートされています。 ${AUCTION_ID} - Xandr auction_id_64 ${AUCTION_BID_ID} - 入札応答の [ bidid ] フィールドで指定された入札の ID${AUCTION_IMP_ID} - seatbid オブジェクトのbid オブジェクトのimpid フィールドからのインプレッションの ID${AUCTION_SEAT_ID} - seatbid オブジェクトのseat フィールドからの当選シートの ID${AUCTION_AD_ID} - 購入者のクリエイティブの ID。seatbid オブジェクトのbid オブジェクトのadid フィールドから${AUCTION_LOSS} - 損失理由コード${AUCTION_CURRENCY} - 入札応答の [ cu r] フィールドで指定された決済価格の通貨${CREATIVE_CODE} - クリエイティブを登録するときに API を介してcreative オブジェクトに設定されたcode フィールド。${AUCTION_LOSS} マクロでサポートされている損失理由コードの完全な一覧については、「損失理由コード」を参照してください。 |
crid |
string | 入札者のシステムからのクリエイティブ ID。
クリエイティブ サービスを介して設定されたクリエイティブ コードに基づいて Xander クリエイティブを参照するために使用されます。
adid とcrid の両方が渡された場合は、adid が優先されます。 |
cid |
string | 入札者のシステムからのキャンペーン ID。 SSP レポートに使用されます。 |
dealid |
string | この入札が取引に関連している場合は、Bid Request のdeal オブジェクトの取引 ID。 |
ext |
object | OpenRTB 入札応答に対するプラットフォーム固有の拡張機能を識別するために使用されます。 「 Bid Extension オブジェクト」を参照してください。 |
Bid 拡張機能オブジェクト
bid.ext
オブジェクトでは、次のフィールドがサポートされています。
フィールド | 種類 | 説明 |
---|---|---|
dsa |
object | DSA オブジェクト |
DSA 拡張オブジェクト
属性 | 種類 | 説明 |
---|---|---|
behalf |
string | 広告主の透明性: 広告の代わりに表示される の名前を持つ無料の UNICODE テキスト文字列。 最大 100 文字。 |
paid |
string | 広告主の透明性: 広告に対して支払ったユーザーの無料 UNICODE テキスト文字列。 behalf 属性に記載されているものと同じであっても、常に含まれている必要があります。 最大 100 文字。 |
透明性 | オブジェクトの配列 | ユーザー パラメーターと、適用したパラメーターを適用したエンティティのオブジェクトの配列。 |
adrender | integer | 購入者/広告主がクリエイティブ内で独自の DSA 透明性情報をレンダリングすることを示すフラグ。 0 = 購入者/広告主はレンダリングされません1 = 購入者/広告主がレンダリングされます。 |
オブジェクト: 透過性
属性 | 種類 | 説明 |
---|---|---|
domain |
string | ユーザー パラメーターを適用したエンティティのドメイン。 |
params |
整数の配列 | 購入側で適用されたユーザー パラメーターのターゲットの配列 ( DSA Transparency Taskforce によって提供されるリストを使用)。 独自のユーザー ターゲット パラメーターを追加する可能性がある複数のベンダーのサポートを含めます。 |
DSA 透明度を使用した OpenRTB 2.6 入札応答のサンプル:
{
"id": "1234567890",
"bidid": "abc1123",
"seatbid": [
{
"seat": "512",
"bid": [
{
"id": "1",
"nurl": "http://adserver.com/winnotice?impid=102",
"iurl": "http://adserver.com/pathtosampleimage",
"adomain": [
"advertiserdomain.com"
],
"ext": {
"dsa": {
"behalf": "Advertiser",
"paid": "Advertiser",
"transparency": {
"domain": "dsp1domain.com",
"params": [
1,
2
]
},
"adrender": 1
}
}
}
]
}
]
}
AppNexus オブジェクト
Xandr では、 appnexus
拡張オブジェクトの次のフィールドがサポートされています。
フィールド | 種類 | 説明 |
---|---|---|
custom_macros |
オブジェクトの配列 |
custom_macro オブジェクトを識別するために使用されます。 「 カスタム マクロ オブジェクト」を参照してください。 |
min_price |
浮動小数点数 | 2 つ目の価格オークションで入札を減らす必要がある最小価格。 |
spend_protection_pixel_ids |
整数の配列 | 非推奨。 |
custom_notify_data |
string |
注: この機能は既定では有効になっていません。 このフィールドを有効にするように要求する必要があります。 通知要求に情報を渡すには、このフィールドを使用 します。 文字列はフリーフォーム テキストとして入力され、ImpBus によって自動的に URL または Cookie でエンコードされます。 |
click_url |
string | クリエイティブに関連付けるクリック URL。 このフィールドにはリダイレクト リンクが含まれている必要があります。 たとえば、https://mydomain.com/abcd?redir= のように指定します。 |
enable_bid_shading |
integer | 注: このフィールドは非推奨の処理中です。 入札応答で送信された値に関係なく false に設定されます。 |
bid_payment_type |
オブジェクトの配列 |
注: この機能は既定では有効になっていません。 このフィールドを有効にするように要求する必要があります。 Bidder が入札を行い、課金される支払いの種類を指定します。 省略した場合、支払いの種類が 'impression' と見なされます。 |
カスタム マクロ オブジェクト
Xandr では、appnexus
拡張オブジェクトの custom_macro
オブジェクトで次のフィールドがサポートされています。
フィールド | 種類 | 説明 |
---|---|---|
name |
string | クリエイティブの URL (メディア、ピクセル、クリックなど) で置き換えられるマクロの名前。 名前は、クリエイティブの URL またはコンテンツ内で ${MACRO_NAME} 形式にする必要があります。注: カスタム・マクロは、システム・マクロが置き換えられた後に置き換えられます。 詳細については、 クリエイティブ サービス を参照してください。 |
value |
string | マクロの置き換えに使用される値。 スラッシュはエスケープしないでください。 値が整数の場合でも、引用符 (たとえば、 "42" ) 内に配置する必要があります。 値の最大長は 550 文字です。 |
入札支払いタイプ オブジェクト
Xandr では、appnexus
拡張オブジェクトの bid_payment_type
オブジェクトで次のフィールドがサポートされています。
注:
この機能は既定では有効になっていません。 このフィールドを有効にするように要求する必要があります。
フィールド | 種類 | 説明 |
---|---|---|
payment_type |
integer | Bidder が入札を行い、課金される支払いの種類を指定します。 支払いタイプが 'impression' されていない場合は、bid オブジェクトに課金通知 URL を設定する必要があります。 現在サポートされている値は です。1 :印象2 : ビュー - 標準表示6 : ビュー - カスタム ディスプレイ - 100pv1s8 : 景色 - 標準ビデオ9 : Views - Custom Video - 100pv50pd注: 現在、 "Viewable Impression" の入札では、USD の入札のみがサポートされています。 |
price |
double | 支払いタイプの入札価格を指定します。
'Viewable Impression' 支払いタイプの場合、入札価格は vCPM になります。 |
詳細については、「 概要 」ページを参照してください。
注:
adm
フィールドがサポートされないのはなぜですか?
Xandrは、ブランドと評判を深く気にするメンバーと協力しています。 そのため、システムを通過する広告(クリエイティブ)が全ての関係者に受け入れられるよう注意を払っています。 品質保証のため、サード パーティの広告枠で配信するすべてのクリエイティブは 、クリエイティブ サービスを使用して事前に登録する必要があります。
このような理由から、Xandr は adm
フィールドをサポートしていません (これにより、入札者は実際の広告マークアップを渡すことができます)。 代わりに、提供された adid
を使用して広告マークアップを作成し、win 通知用に nurl
します。
入札応答の例
{
"id": "4876290993254515176",
"seatbid": [{
"bid": [{
"id": "1",
"impid": "8278013996604217356",
"price": 1,
"adid": "16",
"nurl": "https://68.67.148.76:10011/notify?TAFFYOpenRTBAuctionID=${AUCTION_ID}&price=${AUCTION_PRICE}",
"ext": {
"appnexus": {
"custom_macros": [{
"name": "dynamic_ad_markup",
"value": "dynamic.js"
}]
}
}
}
],
"seat": "2739"
}],
"bidid": "1",
"cur": "USD"
}
複数入札応答の例
Multi-bid response for one seat value
Option 1
{
"id": "4876290993254515176",
"seatbid": [{
"bid": [{
"id": "1",
"impid": "8278013996604217356",
"price": 1,
"adid": "16",
"nurl": "https://68.67.148.76:10011/notify?TAFFYOpenRTBAuctionID=${AUCTION_ID}&price=${AUCTION_PRICE}"
},
{
"id": "2",
"impid": "8278013996604245835",
"price": 1,
"adid": "22",
"nurl": "https://68.67.148.76:10011/notify?TAFFYOpenRTBAuctionID=${AUCTION_ID}&price=${AUCTION_PRICE}"
},
{
"id": "3",
"impid": "2345613996604245835",
"price": 1,
"adid": "23",
"nurl": "https://68.67.148.76:10011/notify?TAFFYOpenRTBAuctionID=${AUCTION_ID}&price=${AUCTION_PRICE}"
}
],
"seat": "2739"
}],
"bidid": "1",
"cur": "USD"
}
Option 2
{
"id": "4876290993254515176",
"seatbid": [{
"bid": [{
"id": "1",
"impid": "8278013996604217356",
"price": 1,
"adid": "16",
"nurl": "https://68.67.148.76:10011/notify?TAFFYOpenRTBAuctionID=${AUCTION_ID}&price=${AUCTION_PRICE}"
}
],
"seat": "2739"
}],
"seatbid": [{
"bid": [ {
"id": "2",
"impid": "8278013996604245835",
"price": 1,
"adid": "22",
"nurl": "https://68.67.148.76:10011/notify?TAFFYOpenRTBAuctionID=${AUCTION_ID}&price=${AUCTION_PRICE}"
}
],
"seat": "2739"
}],
"seatbid": [{
"bid": [ {
"id": "3",
"impid": "2345613996604245835",
"price": 1,
"adid": "23",
"nurl": "https://68.67.148.76:10011/notify?TAFFYOpenRTBAuctionID=${AUCTION_ID}&price=${AUCTION_PRICE}"
}
],
"seat": "2739"
}],
"bidid": "1",
"cur": "USD"
}
Multi-bid response for multiple seat values
{
"id": "4876290993254515176",
"seatbid": [{
"bid": [{
"id": "1",
"impid": "8278013996604217356",
"price": 1,
"adid": "16",
"nurl": "https://68.67.148.76:10011/notify?TAFFYOpenRTBAuctionID=${AUCTION_ID}&price=${AUCTION_PRICE}"
}
],
"seat": "2739"
},
{
"bid": [{
"id": "1",
"impid": "8278013996604217356",
"price": 1,
"adid": "15",
"nurl": "https://68.67.148.76:10011/notify?TAFFYOpenRTBAuctionID=${AUCTION_ID}&price=${AUCTION_PRICE}"
}
],
"seat": "1234"
},
{
"bid": [{
"id": "1",
"impid": "8278013996604217356",
"price": 1,
"adid": "22",
"nurl": "https://68.67.148.76:10011/notify?TAFFYOpenRTBAuctionID=${AUCTION_ID}&price=${AUCTION_PRICE}"
}
],
"seat": "9876"
}],
"bidid": "1",
"cur": "USD"
}
Win 通知
詳細については、上記の nurl
フィールドの定義を参照してください。
注:
特定のオークションの種類では、落札通知の前に、紛失または保留中の通知が生成される場合があります。 Win 通知は常に権限を持ち、そのオークションで以前に受信した他の通知をオーバーライドします。
損失通知
損失通知を選択すると、次のようになります。 損失通知情報は、応答の最後に表示されます。
{
"notify_request": {
"timestamp": "2016-03-17 06: 52: 40 ",
"auction_timestamp": "2016 - 03 - 17 06: 52: 40 ",
"user_id_64 ": 659854875312903738,
"response_time_ms ": 40,
"bid_info ": {
"no_cookies": false,
"payment_rule_id": 1772411,
"no_flash": false,
"browser": 7,
"operating_system": 2,
"operating_system_extended": 91,
"operating_system_family": 5,
"carrier": 1,
"device_type": 1,
"language": 1,
"session_freq": 1,
"pub_session_freq": 1,
"country": "US",
"within_iframe": false,
"selling_member_id": 701,
"publisher_id": 1483811,
"user_id_64": 659214875312903738,
"ip_address": "98.21.53.49",
"user_agent": "Mozilla/5.0 (Windows NT 6.0; WOW64; rv: 44.0) Gecko / 20100101Firefox / 44.0 ",
"region ": "PA ",
"city ": "Ephrata",
"postal_code ": "17522 ",
"postal_code_id ": 12813,
"dma ": 566,
"time_zone ": "America / New_York ",
"url ": "https: //www.example.com/",
"domain": "example.com",
"device_ids": {},
"inventory_audits": [{
"auditor_member_id": null,
"intended_audience": "general",
"inventory_attributes": [],
"content_categories": [27, 8476]
}],
"userdata_json": "{\"uid\":\"5xb25EqcY3Hd9B\"}",
"tpuids": [{
"user_id": "5xc25EqcY3Hc9B"
}],
"segments": [{
"id": 1,
"member_id": 0,
"code": "cookie_birthday",
"provider": "Appnexus",
"last_seen_min": 23767080
}, {
"id": 2087662,
"member_id": 2636,
"last_seen_min": 23959609
}]
},
"tags": [{
"id": 6123680,
"auction_id_64": 4123382184097823951,
"full_tag_info": {
"auction_id_64": 4123382184097823951,
"size": "300x250",
"sizes": ["300x250"],
"smaller_sizes_allowed": false,
"position": "unknown",
"tag_format": "iframe",
"ad_profile_id": 114603,
"visibility_profile_id": 625,
"allowed_media_types": [1, 11],
"media_subtypes": ["banner"],
"predicted_view_rate": 0.1708,
"estimated_clear_price": 9.00000,
"estimated_average_price": 3.1630,
"id": 6003680,
"site_id": 1672260,
"venue_id": 1299844
},
"payment_rule_id": 177245,
"notify_type": "lost"
}],
"responses": [{
"result": "error",
"error": "Creative inactive, expired or not found by code;Member id: 1999,code: '537748'",
"error_id ": 307
}]
}
}