次の方法で共有

Bidders - 取引購入者アクセス サービス

  • [アーティクル]

この読み取り専用サービスを使用すると、入札者は Xandr のプラットフォームで販売者と交渉された取引に関する情報を表示できます。 取引は、買い手の優遇価格、排他的在庫へのアクセス、在庫の競争の減少、またはその他の機会を提供する可能性があります。 各取引は1人の買い手に対して有効ですが、取引に含まれる在庫は他のバイヤーとの取引にも含まれる可能性があることに注意してください。

REST API

ヒント

メンバー ユーザーと共にログインすると、次の呼び出しは、そのメンバーが利用できる取引のみを返します。 入札者ユーザーと共にログインすると、次の呼び出しにより、その入札者のすべてのメンバーまたは購入者シートで利用可能な取引が返されます。

HTTP メソッド エンドポイント 説明
GET https://api.adnxs.com/deal-buyer-access 売り手と一緒に持っているすべての取引を表示します。
GET https://api.adnxs.com/deal-buyer-access?seller_member_id=SELLER_MEMBER_ID 特定の販売者に対して持っているすべての取引を表示します。
GET https://api.adnxs.com/deal-buyer-access?id=DEAL_ID 特定の取引を表示します。
GET https://api.adnxs.com/deal-buyer-access?id=1,2,3 コンマ区切りのリストを使用して、ID で複数の取引を表示します。
GET https://api.adnxs.com/deal-buyer-access?search="Deal_ID, DEAL_NAME, or CODE 名前、ID、またはコードで取引を検索します。
取得 https://api.adnxs.com/deal-buyer-access/meta フィルター処理および並べ替えの対象となるフィールドを確認します。

JSON フィールド

フィールド 型 (長さ) 説明
active ブール値 true場合、取引はアクティブになります。 この取引は、このフィールドが true、 start_date が過去 (または null) であり、 end_date が将来 (または null) にある場合にのみ使用できます。
ask_price int 取引に関連付けられている価格。 これは、販売者がこのインベントリに対して受け入れる最小金額です。
brands オブジェクトの配列 取引の対象となるクリエイティブのブランド。 詳細については、以下の 「ブランド 」を参照してください。
buyer object 購入入札者と、この取引をターゲットにできるメンバー。 詳細については、以下の 「購入者 」を参照してください。
buyer_bidders オブジェクトの配列 この取引をターゲットにできる買い入札者。 詳細については、以下の 「購入者の入札者 」を参照してください。
buyer_members オブジェクトの配列 購入入札者と、この取引をターゲットにできるメンバー。 詳細については、以下の 「購入者メンバー 」を参照してください。
buyer_seats オブジェクトの配列 この取引をターゲットにできる買い入札者とシート。 詳細については、以下の 「購入者シート 」を参照してください。
code string (100) 取引のカスタム コード。
currency 列挙 floor_priceの通貨。
description string (65535) 取引の説明。
end_date timestamp 取引が買い手に提供されなくなった日と時刻。 Null は "無期限" に対応します。
floor_price double 非推奨。 を参照してください。 ask_price 代わりに。 入札者が取引の資格を得るために入札する必要がある最小 CPM 値。
注: use_deal_floor が falseの場合、 floor_price は 0 になります。 この場合、フロア価格として 0 が表示されますが、取引フロアは適用されません。売り手が他のフロア (配置または利回り管理プロファイル) を持っている場合、それらは適用されます。または売り手が他のフロアを持っていない場合は、標準の2番目の価格のオークションの仕組みが適用されます。
id int 取引の ID。 これは、入札要求で受け取るフィールドです。 注: 外部販売者との取引を設定し、Xandr を通じてファネルした場合、そのコードがこの ID に変わります。
last_modified timestamp 取引が最後に変更された日時。
name string (255) 取引の名前。
seller object 取引を提供している販売メンバー。 詳細については、以下の 「販売者 」を参照してください。
sizes オブジェクトの配列 取引の対象となるクリエイティブのサイズ。 詳細については、以下の 「サイズ 」を参照してください。
注: この配列が応答に存在しない場合、取引のクリエイティブ サイズ要件はありません。
start_date timestamp 取引が買い手に提供され始める日時。 Null は "すぐに" に対応します。
suggested_min_bid_price int ask_priceと同じ金額。
注: 最小入札額は、Xandr 契約で指定されたオークション サービス料金を考慮するために、 ask_price よりも高くする必要があります。 外部サプライヤーとの取引については、入札に不一致を考慮する追加のマージンも含める必要があります。 ask_priceを超える入札を行うと、取引の対象となりますが、入札が当たる保証はありません。
type object 取引の種類。 取引には、オープン オークションまたはプライベート オークションがあります。 詳細については、以下の 「型 」を参照してください。
use_deal_floor ブール値 true場合、取引にfloor_priceが適用されます。
注: use_deal_floor が trueされている場合、取引のフロア価格は、売り手が配置や利回り管理プロファイルで持つ可能性のある他のフロアをオーバーライドします。

売り手

seller オブジェクトには、次のフィールドが含まれています。

フィールド 種類 説明
id int 販売者のメンバー ID。
name string 販売者のメンバー名。

買主

購入入札者と、この取引をターゲットにできるメンバー。 単一購入者取引を使用する販売者の場合、取引では、両方ではなく、 buyer フィールドまたは buyer_seats フィールドのみを使用します。 buyer フィールドは、配列ではなく単一のメンバーをサポートします。 [ buyer ] フィールドは、マルチ購入者取引が有効になっている販売者によって使用されません。 マルチバイヤー取引はまだ売り手向けのベータ版であるため、一部の売り手は当面、シングルバイヤー取引の買い手フィールドを引き続き使用することを期待できます。

buyerフィールドを販売者が更新することはできません。 buyerフィールドを使用して取引が作成されると、変更されません。

buyer オブジェクトには、次のフィールドが含まれています。

フィールド 種類 説明
bidder_id int メンバーの入札者 ID。
id int 購入者のメンバー ID。
name string 購入者のメンバー名。

購入者メンバー

購入入札者と、この取引をターゲットにできるメンバー。 マルチバイヤー取引を使用する販売者の場合、 buyer_members オブジェクトは buyer_seats と buyer_biddersと組み合わせて設定できます。 購入者と組み合わせて設定することはできません。

[ buyer_members ] フィールドは、マルチ購入者取引が有効になっている販売者によって使用されます。 2 つの主な違いを除いて、 buyer フィールドと同様に機能します。 buyer_members はオブジェクトの配列をサポートし、作成後に編集できます。 マルチバイヤー取引はまだベータ機能であるため、すべての売り手が buyer_membersを使用して取引を設定できるわけではありません。

DSP は、次の場合にこのフィールドを読み取る必要があります。

  • 複数の購入者が適格な取引を受け入れることが可能です。この場合、このフィールドは、複数のオブジェクトを含むオブジェクトの配列として読み取る必要があります。
  • 複数の購入者が適格な取引を受け入れることはできません。このフィールドは、1 つのオブジェクトを持つオブジェクトの配列として読み取ります。 DSP が複数の購入者を受け入れることができない場合は、購入者とまったく同じ方法でこのフィールドを読む必要があります。 シートに移行した DSP でも、古い取引とレガシ メンバーがここに入力されている可能性があります。

buyer オブジェクトには、次のフィールドが含まれています。

フィールド 種類 説明
bidder_id int メンバーの入札者 ID。
bidder_name string 入札者の名前。
id int 購入者のメンバー ID。
name string 購入者のメンバー名。

バイヤーシート

この取引をターゲットにできる買い入札者とシート。 マルチバイヤー取引を使用する販売者の場合、 buyer_seats オブジェクトは buyer_members と buyer_biddersと組み合わせて設定できます。 単一購入者取引を使用する販売者の場合、 buyer_seats オブジェクトは独自に設定できます。 buyer_seatsオブジェクトを購入者と組み合わせて設定することはできません。

すべての売り手は、単一の買い手と複数の買い手の取引を設定し、 buyer_seatsを使用して取引を設定する機能を持っています。

DSP は、次の場合にこのフィールドを読み取る必要があります。

  • 購入者シートを使用して に移行されます。

  • 複数の購入者が適格な取引を受け入れることが可能です。この場合、このフィールドは、複数のオブジェクトを含むオブジェクトの配列として読み取る必要があります。

  • 複数の購入者が適格な取引を受け入れることはできません。このフィールドは、1 つのオブジェクトを持つオブジェクトの配列として読み取ります。

buyer_seats オブジェクトには、次のフィールドが含まれています。

フィールド 種類 説明
bidder_id int メンバーの入札者 ID。
bidder_name string 入札者の名前。
id int 購入者のメンバー ID。
name string 購入者のメンバー名。

購入者の入札者

この取引をターゲットにできる買い入札者。 マルチバイヤー取引を使用する販売者の場合、 buyer_bidders オブジェクトは buyer_seats と buyer_membersと組み合わせて設定できます。 購入者と組み合わせて設定することはできません。

[ buyer_bidders ] フィールドは、マルチ購入者取引が有効になっている販売者によって使用されます。 このシートが取引で使用されると、DSP 内のすべての購入者が対象となります。 このフィールドは、OpenRTB 入札要求で空の pmp.deals.wseat で送信される取引に対応します。 マルチバイヤー取引はまだベータ機能であるため、すべての売り手が buyer_biddersを使用して取引を設定できるわけではありません。

DSP は、次の場合にこのフィールドを読み取る必要があります。

  • OpenRTB 入札要求で空白の pmp.deals.wseat で取引を受け入れることが可能です。

buyer_bidders オブジェクトには、次のフィールドが含まれています。

フィールド 種類 説明
bidder_name string 読み取り専用です。 入札者の名前。
bid int メンバーの入札者 ID。

種類

type オブジェクトには、次のフィールドが含まれています。

フィールド 種類 説明
id int 取引の種類を表す ID。 使用可能な値:
- 1 = オープン オークション
「オープンオークション」では、 他の手段を介して在庫をターゲットとする取引と買い手をターゲットとする買い手は、印象を競います。 取引を対象とする買い手が最高額の入札を送信し、その入札が取引のフロアをクリアした場合、その買い手はオークションに勝ち、2番目に高い入札または取引フロア価格のどちらか高い方を支払います。 取引以外の購入者の 1 人が最高額の入札を送信した場合、その購入者はオークションに勝ち、2 番目に高い入札または ECP のどちらか高い方を支払います。
- 2 = プライベート オークション
「プライベートオークション」では、 プライベート取引をターゲットとするバイヤーが最初に印象を競います。 次に、どの取引購入者も勝たなかった場合、オークションは他の手段を介して在庫をターゲットとするバイヤーに開かれます。 取引を対象とする購入者が、取引のフロアよりも高く、他のプライベート オークション入札よりも高い入札を送信した場合、その買い手はオークションに勝ち、プライベート オークションから 2 番目に高い入札または取引フロア価格のどちらか高い方を支払います。 プライベート オークションの取引がフロアをクリアしない場合は、オープン オークションの最高入札が勝ち、オープン オークションから 2 番目に高い入札または ECP のどちらか高い方を支払います。
これらのさまざまな種類のオークションのしくみを示す例については、「 取引オークションの仕組み」を参照してください。
name string 取引の種類の名前。 使用可能な値: "Open Auction"、"Private Auction"、または "First Look"。

ブランド

各 brands オブジェクトには、次のフィールドが含まれています。

フィールド 種類 説明
id int 取引の対象となるブランドの ID。 ブランド サービスを使用してブランド ID を取得できます。
name string 取引の対象となるブランドの名前。 ブランド サービスを使用してブランド名を取得できます。

サイズ

sizes配列内の各オブジェクトには、次のフィールドが含まれています。

フィールド 種類 説明
width string クリエイティブの幅。
height string クリエイティブの高さ。

例

販売者が持っているすべての取引を表示する

$ curl -b cookies -c cookies 'https://api.adnxs.com/deal-buyer-access'
{ 
    "response": {
        "status": "OK",
        "count": 6,
        "deals": [
            {
                "id": 62,
                "code": null,
                "name": "Private deal for buyer 1085 with floor of 2.5",
                "description": null,
                "active": false,
                "start_date": "2013-12-01 00:00:00",
                "end_date": "2013-12-31 23:59:59",
                "floor_price": 2.5,
                "currency": "USD",
                "use_deal_floor": true,
                "last_modified": "2013-12-04 20:15:38",
                "seller": {
                    "id": 1004,
                    "name": "Seller 1004"
                },
                "buyer": {
                    "id": 1005,
                    "bidder_id": 2,
                    "name": "Buyer 1005"
                },
                "type": {
                    "id": 2,
                    "name": "Private Auction"
                },
                "brands": [
                    {
                        "id": 1
                    }
                ],
                                "ask_price": 2.75,
                                "suggested_min_bid_price": 2.75,
                "sizes": [
                    {
                        "width": "300",
                        "height": "250"
                    }
                ],
            },
            {
                "id": 63,
                "code": null,
                "name": "Private deal for buyer 1085 with floor of $2.50",
                "description": null,
                "active": false,
                "start_date": "2013-12-01 00:00:00",
                "end_date": "2013-12-31 23:59:59",
                "floor_price": 2.5,
                "currency": "USD",
                "use_deal_floor": true,
                "last_modified": "2013-12-04 20:39:57",
                "seller": {
                    "id": 1006,
                    "name": "Seller 1006"
                },
                "buyer": {
                    "id": 1007,
                    "bidder_id": 2,
                    "name": "Buyer 1007"
                },
                "type": {
                    "id": 2,
                    "name": "Private Auction"
                },
                "brands": [
                    {
                        "id": 1
                    }
                ]
            },
            ...
        ]
    }
}

特定の販売者に関するすべての取引を表示する

$ curl -b cookies -c cookies 'https://api.adnxs.com/deal-buyer-access?seller_member_id=100006'
{
    "response": {
        "status": "OK",
        "count": 1,
        "deals": [
            {
                "id": 63,
                "code": null,
                "name": "Private deal for buyer 1085 with floor of $2.50",
                "description": null,
                "active": false,
                "start_date": "2013-12-01 00:00:00",
                "end_date": "2013-12-31 23:59:59",
                "floor_price": 2.5,
                "currency": "USD",
                "use_deal_floor": true,
                "last_modified": "2013-12-04 20:39:57",
                "seller": {
                    "id": 100006,
                    "name": "Seller 456"
                },
                "buyer": {
                    "id": 1007,
                    "bidder_id": 2,
                    "name": "Buyer 1007"
                },
                "type": {
                    "id": 2,
                    "name": "Private Auction"
                },
                "brands": [
                    {
                        "id": 1
                    }
                ],
                                "ask_price": 2.75,
                                "suggested_min_bid_price": 2.75,
            }
        ]
    }
}

特定の取引を表示する

$ curl -b cookies -c cookies 'https://api.adnxs.com/deal-buyer-access?id=63'
{
    "response": {
        "status": "OK",
        "count": 1,
        "deal": 
        "deals": {
            "id": 63,
            "code": null,
            "name": "Private deal for buyer 1085 with floor of $2.50",
            "description": null,
            "active": false,
            "start_date": "2013-12-01 00:00:00",
            "end_date": "2013-12-31 23:59:59",
            "floor_price": 2.5,
            "currency": "USD",
            "use_deal_floor": true,
            "last_modified": "2013-12-04 20:39:57",
            "seller": {
                "id": 100006,
                "name": "Seller 456"
            },
            "buyer": {
                "id": 1007,
                "bidder_id": 2,
                "name": "Buyer 1007"
            },
            "type": {
                "id": 2,
                "name": "Private Auction"
            },
            "brands": [
                {
                    "id": 1
                }
            ],
                        "ask_price": 2.75,
                        "suggested_min_bid_price": 2.75
        }
    }
}

特定の取引を表示する (シート コード付き)

$ curl -b cookies -c cookies 'https://api.adnxs.com/deal-buyer-access?id=689280'
{
        "response": {
                "count": 1,
                "dbg": {
                        "output_term": "deal",
                        "version": "1.18.1370",
                        "warnings": []
                },
                "deal": {
                        "active": false,
                        "adserver_lists": null,
                        "adserver_restrict": false,
                        "allow_creative_add_on_click": true,
                        "allow_creative_add_on_view": false,
                        "allowed_media_subtypes": null,
                        "allowed_media_types": null,
                        "ask_price": 1,
                        "auction_type": {
                                "id": 2,
                                "name": "Standard Price"
                        },
                        "audit_status_option": "none",
                        "bidder_guaranteed_deals_support_id": null,
                        "brand_restrict": false,
                        "brands": null,
                        "buyer": null,
                        "buyer_exposure": {
                                "id": 1,
                                "name": "Single buyer"
                        },
                        "buyer_seats": [{
                                "bidder_id": 100,
                                "bidder_name": "Buyer 100",
                                "bidder_supports_hashed_user_ids": true,
                                "code": "A123D",
                                "guaranteed_deals_support": "Disabled",
                                "name": "buyer seat id deal test"
                        }],
                        "categories": null,
                        "category_restrict": false,
                        "code": null,
                        "created_by": "seller",
                        "creatives": null,
                        "currency": "USD",
                        "data_protected": false,
                        "description": "Test Deal with seller 958",
                        "end_date": "2019-12-31 23:59:59",
                        "external_metadata": null,
                        "id": 689280,
                        "language_restrict": false,
                        "languages": null,
                        "last_modified": "2019-11-13 17:33:40",
                        "media_preference": "standard",
                        "name": "buyer seat test",
                        "package_id": null,
                        "payment_type": "default",
                        "priority": 10,
                        "seller": {
                                "bidder_id": 2,
                                "id": 958,
                                "name": "Member 958"
                        },
                        "size_preference": "standard",
                        "sizes": null,
                        "start_date": "2019-11-11 00:00:00",
                        "suggested_min_bid_price": 1,
                        "technical_attribute_restrict": false,
                        "technical_attributes": null,
                        "type": {
                                "id": 2,
                                "name": "Private Auction"
                        },
                        "use_deal_floor": true,
                        "version": 1,
                        "visibility_profile_id": null
                }
        }
}

期限切れではないすべての取引を表示する

この例では、今日が 2013 年 12 月 4 日であると仮定して、期限切れではないすべての取引を検索します。 これを行うには、クエリ文字列に min_end_date="2013-12-04 00:00:00" フィルターを渡します。 ただし、終了日のない取引は応答に表示されないことに注意してください。

$ curl -b cookies -c cookies 'https://api.adnxs.com/deal-buyer-access?min_end_date="2013-12-04 00:00:00"'
{
    "response": {
        "status": "OK",
        "count": 4,
        "deals": [
            {
                "id": 60,
                "code": null,
                "name": null,
                "description": null,
                "active": true,
                "start_date": "2013-12-01 00:00:00",
                "end_date": "2013-12-31 23:59:00",
                "floor_price": 3.2,
                "currency": "USD",
                "use_deal_floor": true,
                "last_modified": "2013-12-04 18:47:39",
                "seller": {
                    "id": 100006,
                    "name": "Seller 456"
                },
                "buyer": {
                    "id": 1007,
                    "bidder_id": 2,
                    "name": "Buyer 1007"
                },
                "type": {
                    "id": 2,
                    "name": "Private Auction"
                },
                "brands": null,
                                "ask_price": 3.5,
                                "suggested_min_bid": 3.5
            },
            {
                "id": 62,
                "code": null,
                "name": "Private deal for buyer 1085 with floor of 2.5",
                "description": null,
                "active": false,
                "seller_member_id": 1066,
                "start_date": "2013-12-01 00:00:00",
                "end_date": "2013-12-31 23:59:59",
                "profile_id": null,
                "floor_price": 2.5,
                "currency": "USD",
                "use_deal_floor": true,
                "last_modified": "2013-12-04 20:15:38",
                "seller": {
                    "id": 1006,
                    "name": "Seller 1006"
                },
                "buyer": {
                    "id": 1007,
                    "bidder_id": 2,
                    "name": "Buyer 1007"
                },
                "type": {
                    "id": 2,
                    "name": "Private Auction"
                },
                "brands": [
                    {
                        "id": 1
                    }
                ],
                                "ask_price": 3.5,
                                "suggested_min_bid_price": 3.5,
            },
            ...
        ]
    }
}