ディール サービス

取引サービスを使用すると、買い手、売り手、外部の入札者は、交渉された取引を設定および管理できます。 取引によって購入者は以下を提供できます:

• 在庫の優遇価格
• 排他インベントリへのアクセス
• 在庫競争の減少
• その他の機会

各取引は 1 人の購入者に対して有効です。

REST API

JSON フィールド

Seller

seller オブジェクトには以下のフィールドがあります。

Buyer

Buyer オブジェクトは POSTに設定できますが、 PUTで更新することはできません。 購入者を変更したい場合は、新規取引を作成する必要があります。

buyer オブジェクトには以下のフィールドがあります。

buyer オブジェクトの例

"buyer": {
                "bidder_id": 2,
                "bidder_name": "Microsoft Invest",
                "id": 9155,
                "name": "Hearts & Science (AT&T)"
            },
"buyer_seats": null

買い手の入札者

buyer_bidders オブジェクトは POST に設定でき、PUTで更新できます。 販売者が複数購入者取引に対して有効になっている場合。 buyer_bidders オブジェクトは、buyer_seats および buyer_members と組み合わせて設定できます。

buyer_bidders オブジェクトには以下のフィールドがあります。

buyer_bidders オブジェクトの例

"buyer_bidders": [{
    "bidder_id": 1,
    "bidder_name": "Example Bidder"
}],

購入者メンバー

buyer_members オブジェクトは POST に設定でき、PUTで更新できます。 販売者が複数の購入者の取引に対して有効になっている場合は、 buyer_members オブジェクトを buyer_seats および buyer_bidders と組み合わせて設定できます。

buyer_members オブジェクトには以下のフィールドがあります。

buyer_members オブジェクトの例

"buyer_members": [{
    "bidder_id": 1,
    "bidder_name": "Example Bidder",
    "id": "456",
    "name": "Example Buyer Member"
}],

購入者シート

シートとの取引は、API 経由で buyer_seats オブジェクトを使用して設定できます。

で新しい取引が設定されると、API には buyer_seats オブジェクトが設定されます。 bidder_idだけでなく code フィールドでも Invest 購入者の会員 ID を使用できます。 外部 DSP との新しい取引は、購入者のシート ID を設定することもできます。 購入者のシート ID を使用している外部 DSP は、ここでチェックできます。

buyer_seats オブジェクトには以下のフィールドがあります。

buyer_seats オブジェクトの例

"buyer": null,
"buyer_seats": [
                {
                    "bidder_id": 2,
                    "bidder_name": "",
                    "code": "9155",
                    "name": "Hearts & Science (AT&T)"
                }
            ],

型

type オブジェクトには以下のフィールドがあります。

オークションの種類

auction_type オブジェクトには以下のフィールドがあります。

ブランド

各 brands オブジェクトには以下のフィールドがあります。

許可されるメディアの種類

この配列を使用して、この取引の一部であるプレースメントで配信できるメディアの種類 (クリエイティブの一般的な表示スタイル) を制限できます。

指定した場合、取引は、選択したメディア タイプが利用可能なオークションにのみ追加されます。

一部のオークションでは複数の種類のメディアがサポートされます。 選択したメディア タイプがオークションでサポートされている場合、取引は参加資格があります。

各 allowed_media_types オブジェクトには以下のフィールドがあります。

許可されるメディア サブタイプ

この配列を使用して、この取引の一部であるプレースメントで配信できるメディア サブタイプ (クリエイティブの特定の表示スタイル) を制限できます。 指定した場合、取引は、選択したメディア サブタイプが利用可能なオークションにのみ参加します。

一部のオークションでは、複数のメディア タイプとサブタイプがサポートされます。 指定されたメディア サブタイプがオークションでサポートされている場合、取引は参加資格があります。

allowed_media_typesを設定せずに、allowed_media_subtypesのみを指定することで、API を介して取引を作成できます。 この場合、取引は指定されたメディア サブタイプをサポートするオークションに参加します。

各 allowed_media_subtypes オブジェクトには以下のフィールドがあります。

許可されるサイズ

各 permitted_sizes オブジェクトには以下のフィールドがあります。

外部メタデータ

external_metadata オブジェクトは、プログラマティック保証取引に適用できます。

各 external_metadata オブジェクトには以下のフィールドがあります。

ネイティブ アセット

各 native_assets オブジェクトには以下のフィールドがあります。

Categories

各 categories オブジェクトには以下のフィールドがあります。

言語

各 languages オブジェクトには以下のフィールドがあります。

技術的属性

各 technical_attribute オブジェクトには以下のフィールドがあります。

クリエイティブ

creatives配列は 100 個のクリエイティブに制限されています。 各 creatives オブジェクトには以下のフィールドがあります。

広告サーバーのリスト

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

販売者による制限付きターゲティング

取引では、Invest の購入者がこの取引をターゲットとしながらターゲットにできる属性を指定できます。 以下のオプションがあります:

• 制限なし - Invest の購入者は、この取引をターゲットとしながら、広告申込品のすべての属性をターゲットにすることができます。
• いくつかの制限 - Invest の購入者は、品目の特定の属性をターゲットにすることができます。
• すべての制限 - Invest の購入者は、この取引をターゲットにしている間、他の属性をターゲットにすることはできません。

メンバーは、新しい取引が作成されるときに、既定でこれらの設定のいずれかを使用するように構成されている場合があります。

取引にいくつかの制限が設定されている場合、取引に関連付けられた表示範囲プロファイル (JSON フィールドセクションの visibility_profile_id フィールドを参照) によって、購入者がターゲットにできる属性の選択が決まります。 次の表示プロファイル フィールドを使用して、購入者が許可するターゲティングを制限できます。

例

$2.50 のフロアのプライベート オークション取引を追加する

$ cat new_deal
 
{
    "deal": {
        "name": "Private deal for buyer 1234 with floor of $2.50",
        "active": false,
        "start_date": "2016-12-01 00:00:00",
        "end_date": "2016-12-31 23:59:59",
        "floor_price": 2.5,
        "currency": "USD",
        "use_deal_floor": true,
        "buyer": {
                "id": 1234
        },
        "type": {
                "id": 2
        },
        "brands": [
                {
                        "id": 1
                }
            ]
    }
}
 
$ curl -b cookies -c cookies -X POST -d @new_deal.json 'https://api.appnexus.com/deal'
 
{
    "response": {
        "status": "OK",
        "count": 1,
        "id": 63,
        "start_element": 0,
        "num_elements": 100,
        "deal": {
            "id": 63,
            "code": null,
            "name": "Private deal for buyer 1234 with floor of $2.50",
            "description": null,
            "active": false,
            "seller_member_id": 2345,
            "start_date": "2013-12-01 00:00:00",
            "end_date": "2013-12-31 23:59:59",
            "profile_id": null,
            "package_id": null,
            "floor_price": 2.5,
            "currency": "USD",
            "use_deal_floor": true,
            "last_modified": "2013-12-04 20:39:57",
            "seller": {
                "id": 1066,
                "name": "Seller 123"
            },
            "buyer": {
                "id": 1234,
                "bidder_id": 6,
                "name": "Buyer 456"
            },
            "type": {
                "id": 2,
                "name": "Private Auction"
            },
            "brands": [
                {
                    "id": 1,
                                        "name": "Example Brand"
                }
            ],
            "ask_price": 0,
            "size_preference": null
        }
    }
}

フロアのないプライベート オークション取引を追加する

$ cat new_deal_nofloor
 
{
    "deal": {
        "name": "Private deal for buyer 1234 with no floor",
        "active": false,
        "start_date": "2016-12-01 00:00:00",
        "end_date": "2016-12-31 23:59:59",
        "floor_price": 0,
        "use_deal_floor": false,
        "buyer": {
                "id": 1234
        },
        "type": {
                "id": 2
        },
        "brands": [
                {
                        "id": 1
                }
            ]
    }
}
 
$ curl -b cookies -c cookies -X POST -d @new_deal_nofloor.json 'https://api.appnexus.com/deal'
 
{
    "response": {
        "status": "OK",
        "count": 1,
        "id": 64,
        "start_element": 0,
        "num_elements": 100,
        "deal": {
            "id": 64,
            "code": null,
            "name": "Private deal for buyer 1234 with no floor",
            "description": null,
            "active": false,
            "start_date": "2013-12-01 00:00:00",
            "end_date": "2013-12-31 23:59:59",
            "profile_id": null,
            "package_id": null,
            "floor_price": 0,
            "currency": "USD",
            "use_deal_floor": false,
            "last_modified": "2013-12-04 20:43:44",
            "seller": {
                "id": 2345,
                "name": "Seller 123"
            },
            "buyer": {
                "id": 1234,
                "bidder_id": 6,
                "name": "Buyer 456"
            },
            "type": {
                "id": 2,
                "name": "Private Auction"
            },
            "brands": [
                {
                    "id": 1,
                    "name": "Example Brand"
                }
            ],
            "ask_price": 0,
            "size_preference": null
        }
    }
}

取引を変更する

この例では、対象となる別のブランドを取引に追加し、終了日を延長します。

$ cat deal_update
 
{
    "deal": {
        "end_date": "2017-01-31 23:59:59",
        "brands": [
                {
                        "id": 1
                },
            {
                "id": 5
            }
            ]
    }
}
 
$ curl -b cookies -c cookies -X PUT -d @deal_update.json 'https://api.appnexus.com/deal?id=64'
{
    "response": {
        "status": "OK",
        "count": 1,
        "id": "64",
        "start_element": 0,
        "num_elements": 100,
        "deal": {
            "id": 64,
            "code": null,
            "name": "Private deal for buyer 1234 with no floor",
            "description": null,
            "active": false,
            "start_date": "2016-12-01 00:00:00",
            "end_date": "2016-01-31 23:59:59",
            "profile_id": null,
            "package_id": null,
            "floor_price": 0,
            "currency": "USD",
            "use_deal_floor": false,
            "last_modified": "2016-12-04 20:51:35",
            "seller": {
                "id": 2345,
                "name": "Seller 123"
            },
            "buyer": {
                "id": 1234,
                "bidder_id": 6,
                "name": "Buyer 456"
            },
            "type": {
                "id": 2,
                "name": "Private Auction"
            },
            "brands": [
                {
                    "id": 1,
                    "name": "Example Brand"
                },
                {
                    "id": 5,
                    "name": "Another Brand"
                }
            ],
            "ask_price": 0,
            "size_preference": null
        }
    }
}

取引を修正してオーバーライドを追加し、特定のクリエイティブを禁止する

この例では、広告品質設定に関係なく、ユーザーと自動開始されたオーディオ クリエイティブが常に配信できるように取引を更新します。 また、特に 2 つのクリエイティブ ID も禁止されています。

$ cat deal_override
 
{
    "deal": {
        "id": 201,
        "technical_attributes": [
            {
                "id": 7,
                "name": "Audio: user-initiated",
                "override": true
            },
            {
                "id": 8,
                "name": "Audio: auto-initiated",
                "override": true
            }
        ],
        "creatives": [
            {
                "id": 987654,
                "status": "banned"
            },
            {
                "id": 123456,
                "status": "banned"
            }
        ]
    }
}
 
$ curl -b cookies -c cookies -X PUT -d @deal_override.json 'https://api.appnexus.com/deal?id=64'
{
    "response": {
        "status": "OK",
        "count": 1,
        "id": "64",
        "start_element": 0,
        "num_elements": 100,
        "deal": {
            "id": 201,
            "code": null,
            "name": "Private deal for buyer 1085 with no floor",
            "description": null,
            "active": false,
            "start_date": "2016-12-01 00:00:00",
            "end_date": "2017-01-31 23:59:59",
            "profile_id": null,
            "package_id": null,
            "floor_price": 0,
            "currency": "USD",
            "use_deal_floor": false,
            "last_modified": "2016-12-04 20:51:35",
            "seller": {
                "id": 2345,
                "name": "Seller 123"
            },
            "buyer": {
                "id": 1234,
                "bidder_id": 6,
                "name": "Buyer 456"
            },
            "type": {
                "id": 2,
                "name": "Private Auction"
            },
            "technical_attributes": [
                {
                    "id": 7,
                    "name": "Audio: user-initiated",
                    "override": true
                },
                {
                    "id": 8,
                    "name": "Audio: auto-initiated",
                    "override": true
                }
            ],
            "creatives": [
                {
                    "id": 987654,
                    "status": "banned"
                },
                {
                    "id": 123456,
                    "status": "banned"
                }
            ],
            "ask_price": 0,
            "size_preference": null
        }
    }
}

購入者とのすべての取引を表示

$ curl -b cookies -c cookies 'https://api.appnexus.com/deal'
{
    "response": {
        "status": "OK",
        "count": 7,
        "start_element": 0,
        "num_elements": 100,
        "deals": [
            {
                "id": 63,
                "code": null,
                "name": "Private deal for buyer 1234 with floor of $2.50",
                "description": null,
                "active": false,
                "seller_member_id": 2345,
                "start_date": "2016-12-01 00:00:00",
                "end_date": "2016-12-31 23:59:59",
                "profile_id": null,
                "package_id": null,
                "floor_price": 2.5,
                "currency": "USD",
                "use_deal_floor": true,
                "last_modified": "2016-12-04 20:39:57",
                "seller": {
                    "id": 2345,
                    "name": "Seller 123"
                },
                "buyer": {
                    "id": 1234,
                    "bidder_id": 6,
                    "name": "Buyer 456"
                },
                "type": {
                    "id": 2,
                    "name": "Private Auction"
                },
                "brands": [
                    {
                        "id": 1,
                        "name": "Example Brand"
                    }
                ],
                "ask_price": 3,
                "size_preference": null
            },
            {
                "id": 64,
                "code": null,
                "name": "Private deal for buyer 1234 with no floor",
                "description": null,
                "active": false,
                "start_date": "2016-12-01 00:00:00",
                "end_date": "2016-12-31 23:59:59",
                "profile_id": null,
                "package_id": null,
                "floor_price": 1.2,
                "currency": "USD",
                "use_deal_floor": false,
                "last_modified": "2016-12-04 20:43:44",
                "seller": {
                    "id": 2345,
                    "name": "Seller 123"
                },
                "buyer": {
                    "id": 1234,
                    "bidder_id": 2,
                    "name": "Buyer ABC"
                },
                "type": {
                    "id": 2,
                    "name": "Private Auction"
                },
                "brands": [
                    {
                        "id": 1,
                        "name": "Example Brand"
                    }
                ],
                "ask_price": 0,
                "size_preference": null
            }
        ]
    }
}

特定の取引を表示

$ curl -b cookies -c cookies 'https://api.appnexus.com/deal?id=64'
{
    "response": {
        "status": "OK",
        "count": 1,
        "start_element": 0,
        "num_elements": 100,
        "deal": {
            "id": 64,
            "code": null,
            "name": "Private deal for buyer 1234 with no floor",
            "description": null,
            "active": false,
            "start_date": "2016-12-01 00:00:00",
            "end_date": "2017-01-31 23:59:59",
            "profile_id": null,
            "package_id": null,
            "floor_price": 1,
            "currency": "USD",
            "use_deal_floor": false,
            "last_modified": "2016-12-04 20:51:35",
            "seller": {
                "id": 2345,
                "name": "Seller 123"
            },
            "buyer": {
                "id": 1234,
                "bidder_id": 2,
                "name": "Buyer ABC"
            },
            "type": {
                "id": 2,
                "name": "Private Auction"
            },
            "brands": [
                {
                    "id": 1,
                    "name": "Example Brand"
                },
                {
                    "id": 5,
                    "name": "Another Brand"
                }
            ],
            "ask_price": 1.25,
            "size_preference": null
        }
    }
}

取引を削除する

$ curl -b cookies -c cookies -X DELETE 'https://api.appnexus.com/deal?id=61'
{
    "response": {
        "status": "OK",
        "count": 1,
        "start_element": null,
        "num_elements": null
    }
}