Digital Platform API - Deal Buyer Access サービス
この読み取り専用サービスを使用すると、購入者は Xandr の UI 販売者や外部供給パートナーと交渉された取引に関する情報を表示できます。 取引は、買い手の優遇価格、排他的在庫へのアクセス、在庫の競争の減少、またはその他の機会を提供する可能性があります。 各取引は1人の買い手に対して有効ですが、取引に含まれる在庫は他のバイヤーとの取引にも含まれる可能性があることに注意してください。
購入者は、プロファイル サービスのフィールドをdeal_targets使用して取引をターゲットにすることができます。 販売者は 、取引サービス を使用して取引を設定および管理できます。
REST API
| HTTP メソッド | エンドポイント | 説明 |
|---|---|---|
GET |
https://api.appnexus.com/deal-buyer-access |
販売者が持っているすべての取引を表示する |
GET |
https://api.appnexus.com/deal-buyer-access?seller_member_id=SELLER_MEMBER_ID |
特定の販売者に関するすべての取引を表示する |
GET |
https://api.appnexus.com/deal-buyer-access?id=DEAL_ID |
特定の取引を表示する |
GET |
https://api.appnexus.com/deal-buyer-access?id=1,2,3 |
コンマ区切りリストを使用して ID で複数の取引を表示する |
GET |
https://api.adnxs.com/deal-buyer-access?search="Deal_ID,DEAL_NAME,orCODE" |
名前、ID、またはコードで取引を検索する |
GET |
https://api.appnexus.com/deal-buyer-access/meta |
フィルター処理および並べ替え可能なフィールドを確認する |
JSON フィールド
| フィールド | 型 (長さ) | 説明 |
|---|---|---|
active |
ブール値 | の場合 true、取引はアクティブです。 取引は、このフィールドtruestart_dateが 、 が過去 (または) であり、将来 (またはnullnull) end_date である場合にのみ買い手が利用できる点に注意してください。 |
ask_price |
int | 取引に関連付けられている価格。 これは、販売者がこのインベントリに対して受け入れる最小金額です。 |
audit_status_option |
string | 取引でクリエイティブを処理する方法を指定します。 - none: クリエイティブは既存の広告品質設定を使用します。- provisional: 監査状態の "pending" クリエイティブが配信されます。 これらのクリエイティブが監査されると、既存の広告品質設定が使用されます。- max_trust: この取引では、すべてのクリエイティブにサービスを提供できます。Creatives オブジェクトに特にリストされているクリエイティブは、これらの設定をオーバーライドします。 |
brands |
オブジェクトの配列 | 取引の対象となるクリエイティブのブランド。 詳細については、以下の 「ブランド 」を参照してください。 |
brand_restrict |
Boolean | 取引が Brands オブジェクトに リストされているブランドのみに制限されるかどうかを指定します。 - true: 取引はリストされたブランドにのみ制限されます。- false:その他のブランドも提供可能です。 |
buyer |
object | この取引をターゲットにできる購入メンバー。 詳細については、以下の 「購入者 」を参照してください。 |
categories |
オブジェクトの配列 | 取引の対象となるクリエイティブを表すカテゴリ。 詳細については、以下の 「カテゴリ 」を参照してください。 |
category_restrict |
Boolean | 取引が Categories オブジェクトに リストされているカテゴリのみに制限されるかどうかを指定します。 - true: 取引は、一覧表示されたカテゴリにのみ制限されます。- false: その他のカテゴリも提供できます。 |
code |
string (100) | 取引のカスタム コード。 外部供給パートナーとの取引の場合、これは通常、取引を識別するために使用する文字列です。 |
creatives |
オブジェクトの配列 | 取引に対して特に承認または禁止されているクリエイティブの一覧。 このリストは、他の広告品質設定よりも優先されます。 詳細については、以下 の「クリエイティブ」 を参照してください。 |
currency |
列挙 | の通貨 floor_price。 使用可能な通貨の完全な一覧については、読み取り専用 通貨サービスを使用します。 |
description |
string (65535) | 取引の説明。 外部供給パートナーとの取引については、説明によって、取引に関する追加の分析情報または詳細が提供される場合があります。 |
end_date |
timestamp | 取引が買い手に提供されなくなった日と時刻。 Null は "無期限" に対応します。 |
floor_price |
double | 非推奨。 代わりに フィールドを ask_price 参照してください。 買い手が取引の資格を得るために入札する必要がある最小 CPM 値。注: が の falsefloor_price場合use_deal_floorは になります0。 この場合、フロア価格として表示されますが 0 、取引フロアは適用されません。売り手に他のフロア (配置または利回り管理プロファイル) がある場合は適用されます。または、売り手に他のフロアがない場合は、標準の 2 番目の価格のオークションメカニズムが適用されます。 |
id |
int | 取引の ID。 |
languages |
オブジェクトの配列 | 取引の対象となるクリエイティブに関連付けられている言語。 詳細については、以下 の「言語 」を参照してください。 |
language_restrict |
ブール型 | 取引を Languages オブジェクトに一覧表示されている言語のみに制限するかどうかを指定します。 - true: 取引は、一覧に記載されている言語のみに制限されます。- false: その他の言語も提供できます。 |
last_modified |
timestamp | 取引が最後に変更された日時。 |
name |
string (255) | 取引の名前。 |
payment_type |
string | 取引の支払いタイプを指定します。 - default: この取引では、この取引の購入者に対して既定の支払いタイプが使用されます。 CPM が含まれており、CPA、CPC、またはその両方も含めることができます。- cpvm: この取引では、表示可能な CPM 支払いタイプが使用されます。 表示可能なインプレッションのみが購入者からの支払いになります。 |
seller |
object | 取引を提供している販売メンバー。 詳細については、以下の 「販売者 」を参照してください。 |
sizes |
オブジェクトの配列 | 取引の対象となるクリエイティブのサイズ。 詳細については、以下の 「サイズ ターゲット 」を参照してください。 注: この配列が応答に存在しない場合、取引のクリエイティブ サイズ要件はありません。 |
size_preference |
string | この取引がプライベート サイズを処理する方法を指定します。 プライベート サイズは、販売者が取引に対応できる配置サイズです。 次のような 2 つのオプションがあります。 - standard: プライベート サイズは、この取引では使用できません。- append: プライベート サイズは、指定した配置サイズに加えて使用できます。 |
start_date |
timestamp | 取引が買い手に提供され始める日時。 Null は "すぐに" に対応します。 |
suggested_min_bid_price |
int | ask 価格をクリアする可能性がある最小金額。 これは、Xandr 契約で指定された の合計とオークション サービス料金の合計 ask_price です。 外部サプライヤーとの取引の場合、この金額には不一致を考慮する追加のマージンが含まれます。を suggested_min_bid_price 入札すると、取引の資格が保証されますが、入札が勝つ保証はありません。 |
technical_attributes |
オブジェクトの配列 | 取引の対象となるクリエイティブの技術的属性。 詳細については、以下の 「技術属性 」を参照してください。 |
technical_attribute_restrict |
ブール型 | 取引が技術 属性オブジェクトに リストされている技術属性のみに制限されるかどうかを指定します。 - true: 取引は、一覧表示された技術属性にのみ制限されます。- false: その他の技術的属性も提供できます。 |
type |
object | 取引の種類。 売り手の場合、取引はオープン オークションまたはプライベート オークションにすることができます。 外部供給パートナーの場合は、取引をファーストルック アクセスにすることもできます。 詳細については、以下の 「型 」を参照してください。 |
use_deal_floor |
ブール値 | true の場合は、 floor_price が取引に適用されます。注: が の true場合use_deal_floor、取引のフロア価格は、売り手が配置または利回り管理プロファイルで持つ可能性のある他のフロアをオーバーライドします。 |
売り手
| フィールド | 種類 | 説明 |
|---|---|---|
id |
int | 読み取り専用。 販売者のメンバー ID。 |
name |
string | 読み取り専用。 販売者のメンバー名。 |
バイヤー
| フィールド | 種類 | 説明 |
|---|---|---|
id |
int | 購入者のメンバー ID。 |
bidder_id |
int | メンバーの入札者 ID。 Xandr の UI 購入者の場合、これは常に 2 になります。 |
name |
string | 購入者のメンバー名。 |
型
オブジェクトには Type 、次のフィールドが含まれています。
| フィールド | 型 (長さ) | 説明 |
|---|---|---|
id |
int | 取引の種類を表す ID。 使用可能な値:1 = オークションを開くでは、 "Open Auction"取引をターゲットとするバイヤーと、他の手段を介してインベントリをターゲットとするバイヤーは、印象を競います。 取引を対象とする買い手が最高額の入札を送信し、その入札が取引のフロアをクリアした場合、その買い手はオークションに勝ち、2番目に高い入札または取引フロア価格のどちらか高い方を支払います。 取引以外の購入者の 1 人が最高額の入札を送信した場合、その購入者はオークションに勝ち、2 番目に高い入札または ECP のどちらか高い方を支払います。 2 = プライベート オークションでは、 "Private Auction"プライベート取引をターゲットとするバイヤーは、最初に印象を競います。 次に、どの取引購入者も勝たなかった場合、オークションは他の手段を介して在庫をターゲットとするバイヤーに開かれます。 取引を対象とする購入者が、取引のフロアよりも高く、他のプライベート オークション入札よりも高い入札を送信した場合、その買い手はオークションに勝ち、プライベート オークションから 2 番目に高い入札または取引フロア価格のどちらか高い方を支払います。 プライベート オークションの取引がフロアをクリアしない場合は、オープン オークションの最高入札が勝ち、オープン オークションから 2 番目に高い入札または ECP のどちらか高い方を支払います。3 = 最初の外観取引は "First Look" 外部供給パートナーによってのみ提供され、供給パートナーと売り手の両方に応じて非常に多様なオークションロジックを持っています。 取引のしくみの詳細については、供給パートナーに問い合わせる必要があります。 購入プラットフォームとしてのXandrは、最初のルック取引が実際に印象を最初に見ることができるという保証はありません。 |
name |
string (255) | 取引の種類の名前。 使用可能な値: - "Open Auction" - "Private Auction" - "First Look". |
ブランド
各 brands オブジェクトには、次のフィールドが含まれています。
| フィールド | 種類 | 説明 |
|---|---|---|
id |
int | 取引の対象となるブランドの ID。 ブランド サービスを使用してブランド ID を取得できます。 |
name |
string | 取引の対象となるブランドの名前。 |
override |
ブール値 | に true設定すると、広告品質プロファイルでブロックされた可能性がある場合でも、ブランドは取引に役立ちます。 |
Categories
各 categories オブジェクトには、次のフィールドが含まれています。
| フィールド | 種類 | 説明 |
|---|---|---|
id |
int | 取引の対象となるカテゴリの ID。 カテゴリ サービスを使用して、カテゴリ ID を取得できます。 |
name |
string | 取引の対象となるカテゴリの名前。 |
override |
Boolean | に true設定すると、広告品質プロファイルでブロックされた場合でも、カテゴリは取引に役立ちます。 |
言語
各 languages オブジェクトには、次のフィールドが含まれています。
| フィールド | 種類 | 説明 |
|---|---|---|
id |
int | 取引の対象となる言語の ID。 言語サービスを使用して、言語 ID を取得できます。 |
name |
string | 取引の対象となる言語の名前。 |
override |
Boolean | に true設定すると、広告品質プロファイルでブロックされた可能性がある場合でも、取引に対応する言語が提供されます。 |
技術属性
各 technical_attribute オブジェクトには、次のフィールドが含まれています。
| フィールド | 種類 | 説明 |
|---|---|---|
id |
int | 取引の対象となる技術属性の ID。 技術属性サービスを使用して、技術属性 ID を取得できます。 |
name |
string | 取引の対象となる技術属性の名前。 |
override |
ブール型 | に設定すると true、広告品質プロファイルでブロックされた可能性がある場合でも、技術属性が取引に役立ちます。 |
クリエイティブ
配列は creatives 100 個のクリエイティブに制限されています。 各 creatives オブジェクトには、次のフィールドが含まれています。
| フィールド | 種類 | 説明 |
|---|---|---|
id |
int | 取引が承認または禁止されているクリエイティブの ID。 クリエイティブ サービスを使用して、クリエイティブ ID を取得できます。 |
status |
string | この取引に対するこのクリエイティブの処理方法を指定します。 - approved: このクリエイティブは、他の広告品質設定やオーバーライドに関係なく、常にこの取引で配信できます。- banned: このクリエイティブは、他の広告品質設定やオーバーライドに関係なく、この取引で配信することはできません。 |
サイズ
配列内の size_targets 各オブジェクトには、次のフィールドが含まれています。
| フィールド | 種類 | 説明 |
|---|---|---|
width |
string | クリエイティブの幅。 |
height |
string | クリエイティブの高さ。 |
例
販売者が持っているすべての取引を表示する
$ curl -b cookies -c cookies 'https://api.appnexus.com/deal-buyer-access'
{
"response": {
"status": "OK",
"count": 6,
"start_element": 0,
"num_elements": 100,
"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": 100004,
"name": "Seller 123"
},
"buyer": {
"id": 100005,
"bidder_id": 2,
"name": "Buyer 123"
},
"type": {
"id": 2,
"name": "Private Auction"
},
"brands": [
{
"id": 1,
"name": "Example Brand"
},
"ask_price": 2.75,
"suggested_min_bid_price": 3,
"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": 100006,
"name": "Seller 456"
},
"buyer": {
"id": 100007,
"bidder_id": 2,
"name": "Buyer 456"
},
"type": {
"id": 2,
"name": "Private Auction"
},
"brands": [
{
"id": 1,
"name": "Example Brand"
}
]
},
...
]
}
}
特定の販売者に関するすべての取引を表示する
$ curl -b cookies -c cookies 'https://api.appnexus.com/deal-buyer-access?seller_member_id=100006'
{
"response": {
"status": "OK",
"count": 1,
"start_element": 0,
"num_elements": 100,
"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": 100007,
"bidder_id": 2,
"name": "Buyer 456"
},
"type": {
"id": 2,
"name": "Private Auction"
},
"brands": [
{
"id": 1,
"name": "Example Brand"
}
],
"ask_price": 2.75,
"suggested_min_bid_price": 3,
"sizes": [
{
"width": "300",
"height": "250"
}
]
}
]
}
}
特定の取引を表示する
$ curl -b cookies -c cookies 'https://api.appnexus.com/deal-buyer-access?id=63'
{
"response": {
"status": "OK",
"count": 1,
"start_element": 0,
"num_elements": 100,
"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": 100007,
"bidder_id": 2,
"name": "Buyer 456"
},
"type": {
"id": 2,
"name": "Private Auction"
},
"brands": [
{
"id": 1,
"name": "Example Brand"
}
],
"ask_price": 2.75,
"suggested_min_bid_price": 3,
"sizes": [
{
"width": "300",
"height": "250"
}
]
}
}
}
期限切れではないすべての取引を表示する
この例では、今日が 2018 年 12 月 4 日であると仮定して、期限切れではないすべての取引を検索します。 これを行うには、クエリ文字列にフィルターを min_end_date=2018-12-04 渡します。 ただし、終了日のない取引は応答に表示されないことに注意してください。
$ curl -b cookies -c cookies 'https://api.appnexus.com/deal-buyer-access?min_end_date=2018-12-04'
{
"response": {
"status": "OK",
"count": 4,
"start_element": 0,
"num_elements": 100,
"deals": [
{
"id": 60,
"code": null,
"name": null,
"description": null,
"active": true,
"start_date": "2018-12-01 00:00:00",
"end_date": "2018-12-31 23:59:00",
"floor_price": 3.2,
"currency": "USD",
"use_deal_floor": true,
"last_modified": "2018-12-04 18:47:39",
"seller": {
"id": 100006,
"name": "Seller 456"
},
"buyer": {
"id": 100007,
"bidder_id": 2,
"name": "Buyer 456"
},
"type": {
"id": 2,
"name": "Private Auction"
},
"brands": null,
"ask_price": 3.5,
"suggested_min_bid_price": 3.75,
},
{
"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": "2018-12-01 00:00:00",
"end_date": "2018-12-31 23:59:59",
"profile_id": null,
"floor_price": 2.5,
"currency": "USD",
"use_deal_floor": true,
"last_modified": "2018-12-04 20:15:38",
"seller": {
"id": 100006,
"name": "Seller 456"
},
"buyer": {
"id": 100007,
"bidder_id": 2,
"name": "Buyer 456"
},
"type": {
"id": 2,
"name": "Private Auction"
},
"brands": [
{
"id": 1,
"name": "Example Brand"
}
]
},
...
]
}
}