取引購入者設定サービス

[アーティクル]
07/05/2024

取引買い手設定サービスを使用すると、購入者は、UI で明確にするために取引に内部エイリアスを与え、取引にステータスを割り当てることで、購入者が対象となる取引をより詳細に制御できます。これらの取引設定は、それらを作成した購入者のみが使用でき、取引の売り手には表示されないことに注意してください。

注:

購入者は、取引購入者アクセスサーヴィースを使用して、利用可能な取引を表示し、プロファイルサービスのdeal_targetsフィールドで取引をターゲットにすることができます。販売者は、取引サービスを使用して取引を設定および管理できます。

REST API

HTTP メソッド	エンドポイント	説明
`GET`	`https://api.appnexus.com/deal-buyer-setting`	すべての取引設定を表示します。
`GET`	`https://api.appnexus.com/deal-buyer-setting?id=ID`	特定の取引設定を表示します。
`GET`	`https://api.appnexus.com/deal-buyer-setting?deal_id=DEAL_ID`	特定の取引の設定を表示します。
`GET`	`https://api.appnexus.com/deal-buyer-setting?id=1,2,3`	コンマ区切りリストを使用して、ID で複数の取引設定を表示します。
`GET`	`https://api.appnexus.com/deal-buyer-setting/meta`	フィルター処理および並べ替えの対象となるフィールドを確認します。
`POST`	`https://api.appnexus.com/deal-buyer-setting`	取引の設定を追加します。
`PUT`	`https://api.appnexus.com/deal-buyer-setting?id=ID`	取引の設定を変更します。

JSON フィールド

フィールド	種類	説明
`acceptance_status`	string	取引の状態: - `active` - `inactive` - `declined` - `pending` 注: `pending` 状態は、 `PUT` 要求では許可されません既定値: このフィールドの既定値は、 `member.default_accept_deals` フィールドの値によって異なります ( 「メンバーサービス」を参照)。 `member.default_accept_deals`が`true`の場合、`acceptance_status`の既定値は`active`。`member.default_accept_deals`が`false`の場合、`acceptance_status`の既定値は`pending`。
`buyer_bidder_id`	int	メンバーの入札者 ID。購入者の場合、これは常に `2`されます。読み取り専用既定値: `null`
`buyer_member_id`	int	取引を購入できるメンバーの ID。取引は、バイヤーメンバーIDまたはバイヤーシートコードで設定されます。これは Xandr メンバー ID です。読み取り専用
`buyer_seat_code`	string	取引を購入できる購入者シートのコード。取引は、バイヤーメンバーIDまたはバイヤーシートコードで設定されます。これは Xandr メンバー ID です。読み取り専用既定値: `null`
`comments`	string (65534)	UI ではまだ使用されていません。取引の UI に表示するカスタムコメント。既定値: `null`
`deal_id`	int	設定が適用される取引の ID。必須:`POST`
`deal_alias`	string (254)	UI に表示される取引のエイリアス。既定値: `null`
`id`	int	取引設定の ID 必須:`PUT` 既定値: 自動インクリメントされた数値。

例

取引設定を追加する

取引に対して取引買い手設定オブジェクトが既に作成されている場合、POST 要求は次のエラーメッセージを返します。"The buyer_member_id, deal_id combination was not unique." この取引購入者設定を変更するには、最初に GEThttps://api.appnexus.com/deal-buyer-setting?deal_id=DEAL_ID 要求を行って、取引購入者設定 ID を返します。次に、 PUThttps://api.appnexus.com/deal-buyer-setting?id=ID 要求で取引購入者設定 ID を使用して、取引購入者設定を変更します。

$ cat deal_settings.json
 
{
    "deal-buyer-setting": {
        "deal_id": 22896,
        "deal_alias": "This is an alias",
        "comments": "this is a comment on a deal",
        "acceptance_status": "active"
    }
}

$ curl -b cookies -c cookies -X POST -d @deal_settings.json 'https://api.appnexus.com/deal-buyer-setting'

{
    "response": {
        "status": "OK",
        "count": 1,
        "id": "12005",
        "start_element": 0,
        "num_elements": 100,
        "deal-buyer-setting": {
            "id": 12005,
            "deal_id": 22896,
            "deal_alias": "This is an alias",
            "comments": "this is a comment on a deal",
            "buyer_member_id": 546,
            "acceptance_status": "active"
        }
    }
}

取引設定を変更する

$ cat deal_settings_update.json
 
{
    "deal-buyer-setting": {
        "deal_alias": "new deal alias"
    }
}

$ curl -b cookies -c cookies -X PUT -d @deal_settings_update.json 'https://api.appnexus.com/deal-buyer-setting?id=11777'
 
{
    "response": {
        "status": "OK",
        "count": 1,
        "id": "11777",
        "start_element": 0,
        "num_elements": 100,
        "deal-buyer-setting": {
            "id": 11777,
            "deal_id": 560402,
            "deal_alias": "new deal alias",
            "comments": null,
            "buyer_member_id": 546,
            "acceptance_status": "active"
        }
    }
}

すべての取引設定を表示する

$ curl -b cookies -c cookies 'https://api.appnexus.com/deal-buyer-setting'
 
{
    "response": {
        "status": "OK",
        "start_element": 0,
        "num_elements": 100,
        "deal-buyer-settings": [
            {
                "id": 9980,
                "deal_id": 558605,
                "deal_alias": null,
                "comments": null,
                "buyer_member_id": 546,
                "acceptance_status": "active"
            },
            {
                "id": 10950,
                "deal_id": 559575,
                "deal_alias": null,
                "comments": null,
                "buyer_member_id": 546,
                "acceptance_status": "active"
            },
            {
                "id": 11777,
                "deal_id": 560402,
                "deal_alias": "new deal alias",
                "comments": null,
                "buyer_member_id": 546,
                "acceptance_status": "active"
            }, 
            {
                "id": 1802,
                "deal_id": 550427,
                "deal_alias": null,
                "comments": null,
                "buyer_member_id": 546,
                "acceptance_status": "active"
            },
            {
                "id": 1937,
                "deal_id": 550562,
                "deal_alias": null,
                "comments": null,
                "buyer_member_id": 546,
                "acceptance_status": "active"
            }
        ]
    }
}

特定の取引設定 ID の設定を表示する

$ curl -b cookies -c cookies 'https://api.appnexus.com/deal-buyer-setting?id=11777'

{
    "response": {
        "status": "OK",
        "start_element": 0,
        "num_elements": 100,
        "deal-buyer-settings": [
            {
                "id": 11777,
                "deal_id": 560402,
                "deal_alias": "new deal alias",
                "comments": null,
                "buyer_member_id": 546,
                "acceptance_status": "active"
            }
        ]
    }
}

特定の取引 ID の設定を表示する

$ curl -b cookies -c cookies 'https://api.appnexus.com/deal-buyer-setting?deal_id=560402'

{
    "response": {
        "status": "OK",
        "start_element": 0,
        "num_elements": 100,
        "deal-buyer-settings": [
            {
                "id": 11777,
                "deal_id": 560402,
                "deal_alias": "new deal alias",
                "comments": null,
                "buyer_member_id": 546,
                "acceptance_status": "active"
            }
        ]
    }
}

複数の取引 ID の設定を表示する

$ curl -b cookies -c cookies 'https://api.appnexus.com/deal-buyer-setting?deal_id=560402,559575,558605'

{
    "response": {
        "status": "OK",
        "start_element": 0,
        "num_elements": 100,
        "deal-buyer-settings": [
            {
                "id": 9980,
                "deal_id": 558605,
                "deal_alias": null,
                "comments": null,
                "buyer_member_id": 546,
                "acceptance_status": "active"
            },
            {
                "id": 10950,
                "deal_id": 559575,
                "deal_alias": null,
                "comments": null,
                "buyer_member_id": 546,
                "acceptance_status": "active"
            },
            {
                "id": 11777,
                "deal_id": 560402,
                "deal_alias": "deal alias",
                "comments": null,
                "buyer_member_id": 546,
                "acceptance_status": "active"
            }
        ]
    }
}

次の方法で共有