ブローカー サービス

  • [アーティクル]

重要

ブローカー サービスは、拡張明細 (ALI) の パートナー料金サービス に置き換えられました。

ブローカー サービスは、標準または従来の行項目でのみ使用できます。 ブローカー手数料は、拡張明細には適用されません。

ブローカー サービスを使用すると、標準または従来の行項目のユーザーがブローカーを定義できます。 ブローカーは、インプレッションを提供するときにネットワークから料金を収集します。 実際の料金は、 キャンペーン サービス、 広告申込情報サービス、または 挿入注文サービスを通じて定義されます。

注意

ブローカー手数料が挿入注文に適用された場合、その手数料は、挿入注文に関連付けられている拡張明細には適用されません。 これは、挿入指図の標準明細にのみ適用されます。

REST API

HTTP メソッド エンドポイント 説明
POST https://api.appnexus.com/broker
(add-broker JSON)		 ブローカーを追加します。
PUT https://api.appnexus.com/modify-broker?id=BROKER_ID
(modify-broker JSON)		 ブローカーを変更します。
取得 https://api.appnexus.com/broker すべてのブローカーを表示します。
GET https://api.appnexus.com/broker?id=BROKER_ID 特定のブローカーを表示します。

JSON フィールド

パラメーター 型 説明
broker_fees オブジェクトの配列 ブローカーに関連付けられているブローカー料金の配列。 ブローカー 手数料 に関するセクションを参照してください。
既定値: null
id int ブローカーの一意識別子。
既定値: 自動インクリメントされた数値 (つまり、123)
必須:PUT
last_modified timestamp 読み取り専用。 YYYY-MM-DD HH:MM:SS 形式のこのブローカーの最終変更時刻。
member_id int ブローカーのメンバーの一意の識別番号。 ブローカーを作成するときに、ユーザーのメンバーが割り当てられます。
name string ブローカーの説明に使用される一意の名前。
必須:POST
state string ブローカーの状態。 使用可能な値: active または inactive。
既定値: アクティブ

他のオブジェクトに適用されるブローカー手数料

ブローカー手数料は、 キャンペーン サービス、 広告申込情報サービス、または 挿入注文サービスを通じて作成されます。 これらはここで表示できますが、このサービスを使用して作成または編集することはできません。 ブローカーに手数料を適用する方法の詳細については、上記の各サービスのブローカー手数料に関するセクションを参照してください。

注意

ブローカー手数料が挿入注文に適用された場合、その手数料は、挿入注文に関連付けられている拡張明細には適用されません。 これは、挿入指図の標準明細にのみ適用されます。

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

フィールド 種類 説明
object_type string この料金が 1 つのキャンペーンまたはキャンペーンのグループに関連付けられているかどうかを示します。 使用可能な値: campaign または campaign-group。
読み取り専用。
object_id int 料金の一意の識別番号。
読み取り専用。
description string 料金に関する情報を提供するテキスト。
読み取り専用。
fee_type string 使用可能な値: commission または serving:
- 手数料 - これらは広告申込情報または挿入注文ブローカーの手数料であり、広告主からネットワークに与えられた予約収益から差し引かれます。 手数料は、常に関連する挿入注文、広告申込情報、またはキャンペーンの通貨です。
- 配信 - これらはキャンペーン ブローカーの料金であり、ネットワークがパブリッシャーに支払った在庫コストに加えて行われます。 サービス料は米ドルです。

読み取り専用。
payment_type string 支払いの種類: cpm または revshare。
読み取り専用。
value double 料金の値。
読み取り専用。

例

ブローカーを追加する

$ cat add-broker.json

{
    "broker":
    {
    "name": "JMS3"
    }
}

$ curl -b cookies -c cookies -X POST -d @add-broker.json 'https://api.appnexus.com/broker'

    "response":{
        "status":"OK",
        "count":1,
        "id":287,
        "start_element":0,
        "num_elements":100,
        "broker":{
            "id":287,
            "name":"JMS3",
            "state":"active",
            "member_id":1066,
            "last_modified":"2013-09-26 17:17:38",
            "broker_fees":null

ブローカーの変更

$ cat modify-broker.json

{
    "broker":
    {
    "state": "inactive"
    }
}

$ curl -b cookies -c cookies -X PUT -d @modify-broker.json 'https://api.appnexus.com/broker?id=81'

    "response":{
        "status":"OK",
        "count":1,
        "id":"81",
        "start_element":0,
        "num_elements":100,
        "broker":{
            "id":81,
            "name":"Test",
            "state":"inactive",
            "member_id":1066,
            "last_modified":"2013-09-26 17:21:42",
            "broker_fees":null
        },
}

すべてのブローカーを表示する

$ curl -b cookies -c cookies 'https://api.appnexus.com/broker'

{
    "response":{
        "status":"OK",
        "count":6,
        "start_element":0,
        "num_elements":100,
        "brokers":[
            {
                "id":81,
                "name":"Test",
                "state":"inactive",
                "member_id":1066,
                "last_modified":"2013-09-26 17:21:42",
                "broker_fees":null
            },
            {
                "id":145,
                "name":"Test 2",
                "state":"active",
                "member_id":1066,
                "last_modified":"2013-03-15 20:41:47",
                "broker_fees":null
            },
            {
                "id":152,
                "name":"Test 3",
                "state":"active",
                "member_id":1066,
                "last_modified":"2013-03-20 15:30:21",
                "broker_fees":null
            },
            {
                "id":217,
                "name":"Third party",
                "state":"active",
                "member_id":1066,
                "last_modified":"2013-05-21 03:58:36",
                "broker_fees":null
            },
            {
                "id":218,
                "name":"Third party",
                "state":"active",
                "member_id":1066,
                "last_modified":"2013-05-21 04:12:58",
                "broker_fees":null
            },
            {
                "id":287,
                "name":"JMS3",
                "state":"active",
                "member_id":1066,
                "last_modified":"2013-09-26 17:17:38",
                "broker_fees":null
            }
        ],
}

特定のブローカーを表示する

$ curl -b cookies -c cookies 'https://api.appnexus.com/broker?id=81'

{
    "response":{
        "status":"OK",
        "count":1,
        "start_element":0,        "num_elements":100,
        "broker":{
            "id":81,
            "name":"Test",
            "state":"inactive",
            "member_id":1066,
            "last_modified":"2013-09-26 17:21:42",
            "broker_fees":null
        },
}