取引サービス

Deal Service を使用すると、買い手、売り手、外部の入札者が交渉された取引を設定および管理できます。 取引は買い手を提供する可能性があります:

• 在庫の優先価格
• 排他的在庫へのアクセス
• 在庫の競合を減らす
• その他の機会

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

REST API

JSON フィールド

売り手

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

バイヤー

購入者オブジェクトは、 で 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_membersをbuyer_seats組み合わせて設定できます。

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

オブジェクトの buyer_bidders 例

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

購入者メンバー

オブジェクトは buyer_members 、 に POST設定でき、 を使用して PUT更新できます。 売り手が複数の買い手取引に対して有効になっている場合、buyer_membersオブジェクトは と buyer_biddersをbuyer_seats組み合わせて設定できます。

オブジェクトには 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では、投資購入者のメンバー ID と code を使用できます。 外部 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_subtypes オブジェクトには、次のフィールドが含まれています。

許可されるサイズ

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

外部メタデータ

オブジェクトは external_metadata 、プログラムによる保証取引に適用されます。

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

ネイティブ資産

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

Categories

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

言語

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

技術属性

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

クリエイティブ

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

広告サーバーリスト

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

販売者の制限付きターゲティング

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

• 制限なし - 投資購入者は、この取引をターゲットにしながら、広告申込情報のすべての属性をターゲットにすることができます。
• 一部の制限 - 投資購入者は、広告申込情報の特定の属性をターゲットにすることができます。
• すべての制限 - 投資バイヤーは、この取引をターゲットにしながら、他の属性をターゲットにすることはできません。

メンバーは、新しい取引の作成時に既定でこれらの設定のいずれかを使用するように構成できます。

取引が一部の制限に対して構成されている場合、取引に関連付けられている可視性プロファイル (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
    }
}