Bidders - パッケージ 購入者アクセス サービス
この読み取り専用サービスを使用すると、購入者は販売者のパッケージに関する情報を表示できます。 パッケージは、売り手が買い手に提供する準備ができている取引です。 購入者は、利用可能なパッケージを参照し、 Deal From Package Service を使用して自分で取引を生成します。
REST API
HTTP メソッド | エンドポイント | 説明 |
---|---|---|
GET |
https://api.adnxs.com/package-buyer-access | 使用可能なすべてのパッケージを表示します。 |
GET |
https://api.adnxs.com/package-buyer-access?member_id=SELLER_MEMBER_ID | 特定の販売者が提供するすべてのパッケージを表示します。 |
GET |
https://api.adnxs.com/package-buyer-access?id=PACKAGE_ID | 特定のパッケージを表示します。 |
GET |
https://api.adnxs.com/package-buyer-access?id=1,2,3 | コンマ区切りリストを使用して、複数のパッケージを ID で表示します。 |
GET |
https://api.adnxs.com/package-buyer-access?sizes=WIDTHxHEIGHT、WIDTHxHEIGHT | 特定のサイズを含むすべてのパッケージを表示します。 |
GET |
https://api.adnxs.com/package-buyer-access?search=PACKAGE_ID または NAME | 名前または ID でパッケージを検索します。 |
GET |
https://api.adnxs.com/package/meta | フィルター処理および並べ替えの対象となるフィールドを確認します。 |
JSON フィールド
名前 | 型 | 説明 |
---|---|---|
active |
ブール値 | の場合 true 、パッケージはアクティブです。 の場合 false 、パッケージから取引を生成できず、関連付けられているすべての取引が提供を停止します。 |
allow_creative_add_on_click |
true | まだサポートされていません。 |
allow_creative_add_on_view |
ブール値 | まだサポートされていません。 |
data_protected |
ブール値 | まだサポートされていません。 |
default_ask_price |
double | パッケージから生成されたすべての取引に適用される要求価格。 メモ:このフィールドは、 が true の場合default_use_deal_floor にのみ関連します。 |
default_currency |
string | パッケージから生成されたすべての取引に適用される ask 価格通貨。 |
default_deal_type |
object | パッケージから生成されたすべての取引に適用される取引の種類。 詳細については、以下の 「既定の取引の種類 」を参照してください。 |
default_use_deal_floor |
ブール値 | のdefault_ask_price 場合true は、 がパッケージから生成された取引に適用されます。ヒント:が の true 場合default_use_deal_floor 、取引の ask 価格は、売り手が配置または収益管理プロファイルで持つ可能性のある他のフロアをオーバーライドします。 |
description |
string | パッケージの説明。 売り手は一般的にこれを使用して、買い手に取引に関するより大きな洞察を提供します。 |
id |
int | パッケージの ID。 |
last_modified |
timestamp | パッケージが最後に変更された日時。 |
name |
string | パッケージの名前。 |
seller |
object | パッケージを提供している販売者の名前と ID。 詳細については、以下の 「販売者 」を参照してください。 |
seller_rank |
int | パッケージの販売者のランク付け。 これにより、 の販売者のパッケージの完全な一覧にパッケージが表示される場所を制御します。 許可される範囲: 1 から 65355。1 は最高ランクです。 |
setting |
object | パッケージに含まれるコンテンツの種類。 詳細については、以下の 「設定 」を参照してください。 |
sizes |
オブジェクトの配列 | パッケージに含まれるクリエイティブ サイズ。 詳細については、以下の 「サイズ 」を参照してください。 |
visibility_profile_id |
int | まだサポートされていません。 |
売り手
オブジェクトには seller
、次のフィールドが含まれています。
フィールド | 種類 | 説明 |
---|---|---|
id |
int | 販売者のメンバー ID。 |
name |
string | 販売者のメンバー名。 |
既定の取引の種類
オブジェクトには default_deal_type
、次のフィールドが含まれています。 既定では、すべてのパッケージでオープン オークション取引の種類に関する取引が生成されます。
フィールド | 種類 | 説明 |
---|---|---|
id |
int | 取引の種類を表す ID。 使用可能な値: 1 (オープン オークション) または 2 (プライベート オークション)。 オープン オークションとプライベート オークションの詳細については、 Deal Service に関するページを参照してください。 |
name |
string | 読み取り専用です。 取引の種類の名前。 使用可能な値: "Open Auction" または "Private Auction" 。 |
設定
この情報は、購入者にパッケージに含まれる在庫の一般的な理解を提供するために使用されます。 オブジェクトには setting
、次のフィールドが含まれています。
フィールド | 種類 | 説明 |
---|---|---|
has_inventory |
ブール値 | の場合 true 、パッケージにはパブリッシャー、配置、サイト、またはコンテンツ カテゴリのターゲットが含まれます。 |
has_segments |
ブール値 | の場合 true 、パッケージにはセグメント ターゲットが含まれます。 |
has_sizes |
ブール値 | の場合 true 、パッケージにはサイズ ターゲットが含まれます。 含まれる特定のサイズについては、配列を sizes 参照してください。 |
inventory_description |
string | が にtrue 設定されている場合has_inventory 、このフィールドには、パッケージに含まれるインベントリの説明が表示されます。 |
segments_description |
string | が にtrue 設定されている場合has_segments 、このフィールドはパッケージに含まれるセグメントの説明を提供します。 |
技術属性
各 technical_attribute
オブジェクトには、次のフィールドが含まれています。
フィールド | 種類 | 説明 |
---|---|---|
id |
int | パッケージの対象となる技術属性の ID。 技術属性サービスを使用して、技術属性 ID を取得できます。 |
name |
string | パッケージの対象となる技術属性の名前。 |
override |
ブール型 | に true 設定すると、広告品質プロファイルでブロックされた場合でも、技術的属性がパッケージに対して機能する可能性があります。 |
サイズ
配列内の sizes
各オブジェクトには、次のフィールドが含まれています。
フィールド | 種類 | 説明 |
---|---|---|
height |
string | クリエイティブの高さ。 |
width |
string | クリエイティブの幅。 |
例
使用可能なすべてのパッケージを表示する
$ curl -b cookies -c cookies "https://api.adnxs.com/package-buyer-access"
{
"response": {
"status": "OK",
"count": 102,
"packages": [
{
"id": 1,
"name": "Test Pkg",
"description": "this is a test package",
"active": true,
"default_ask_price": 2.5,
"default_currency": "USD",
"default_use_deal_floor": true,
"last_modified": "2014-05-30 15:02:33",
"seller_rank": 100,
"seller": {
"id": 5581,
"name": "AppNexus University"
},
"default_deal_type": {
"id": 1,
"name": "Open Auction"
},
"setting": null,
"sizes": null
},
{
"id": 2,
"name": "High Performance & Viewability!",
"description": "This is an artisanal, hand-picked collection of extremely high performing placements that are visible at least 90% of the time. Viewability audit performed daily by our proprietary View-O-Matic technology and verified by a trusted 3rd party.",
"active": true,
"default_ask_price": 8.8,
"default_currency": "USD",
"default_use_deal_floor": true,
"last_modified": "2014-06-26 22:12:31",
"seller_rank": 100,
"seller": {
"id": 55570,
"name": "Seller ABC"
},
"default_deal_type": {
"id": 1,
"name": "Open Auction"
},
"setting": {
"has_inventory": true,
"inventory_description: "Description of inventory.",
"has_segments": true,
"segment_description": "Description of segments.",
"has_sizes": true
},
"sizes": [
{
"width": "120",
"height": "600"
},
{
"width": "160",
"height": "600"
},
{
"width": "300",
"height": "250"
},
{
"width": "468",
"height": "60"
},
{
"width": "480",
"height": "80"
},
{
"width": "640",
"height": "360"
}
]
},
...
]
}
}
特定の販売者が提供するすべてのパッケージを表示する
$ curl -b cookies -c cookies "https://sand.api.adnxs.com/package-buyer-access?member_id=55586"
{
"response": {
"status": "OK",
"count": 2,
"packages": [
{
"id": 108,
"name": null,
"description": null,
"active": true,
"default_ask_price": 1,
"default_currency": "USD",
"default_use_deal_floor": true,
"last_modified": "2014-07-16 20:49:30",
"seller_rank": 100,
"seller": {
"id": 55586,
"name": "Tyroo Media Pvt. Ltd."
},
"default_deal_type": {
"id": 1,
"name": "Open Auction"
},
"setting": {
"has_inventory": true,
"inventory_description: "Description of inventory.",
"has_segments": true,
"segment_description": "Description of segments.",
"has_sizes": false
},
"sizes": null
}
],
{
"id": 5,
"name": "Package of inventory with data",
"description": "This package includes inventory X and data X.",
"active": false,
"default_ask_price": 11.26,
"default_currency": "USD",
"default_use_deal_floor": true,
"last_modified": "2014-06-06 18:10:47",
"seller_rank": 100,
"seller": {
"id": 55586,
"name": "Tyroo Media Pvt. Ltd."
},
"default_deal_type": {
"id": 1,
"name": "Open Auction"
},
"setting": {
"has_inventory": true,
"inventory_description: "Description of inventory.",
"has_segments": true,
"segment_description": "Description of segments.",
"has_sizes": true
},
"sizes": [
{
"width": "160",
"height": "600"
},
{
"width": "300",
"height": "50"
}
]
},
}
}
特定のパッケージを表示する
$ curl -b cookies -c cookies "https://api.adnxs.com/package?id=109"
{
"response": {
"status": "OK",
"count": 1,
"package": {
"id": 109,
"name": "Updated Package 1",
"description": null,
"active": true,
"default_ask_price": 1,
"default_currency": "USD",
"default_use_deal_floor": true,
"last_modified": "2014-07-21 17:14:16",
"seller_rank": 100,
"seller": {
"id": 5558,
"name": "TMP Ltd."
},
"default_deal_type": {
"id": 1,
"name": "Open Auction"
},
"setting": {
"has_inventory": true,
"inventory_description: "Description of inventory.",
"has_segments": true,
"segment_description": "Description of segments.",
"has_sizes": false
},
"sizes": null
}
}
}