次の方法で共有

取引一覧サービス

  • [アーティクル]

取引とは、買い手と売り手の間の契約であり、インベントリやデータへの特別なアクセスを提供します。 取引は主に、優先プレミアム インベントリまたはネゴシエートされたインベントリにアクセスするために使用されます。 取引リストは、広告申込情報全体を対象とする見出しの下に分類された取引 ID のグループです。 取引リストを使用すると、在庫スペシャリストはトレーダーの取引在庫をキュレーションし、同じ取引セットを広告申込情報間でターゲットにするなど、トレーダーワークフローを合理化することができます。 取引グループ化の要件が変更された場合、取引一覧で必要な変更のみを行うと、それに応じてすべての明細が自動的に更新されます。

Deal List API を使用すると、特定または異なる取引リストの検索、追加、変更、フェッチが容易になります。 これにより、取引リストを作成、追加、およびコンマ区切りの取引 ID に置き換えることができます。

注:

Deal List サービスのすべてのクエリ パラメーターでは、コンマ区切り値の一覧がサポートされます。 たとえば、一連の取引リストを削除するには、ID のコンマ区切りリストをクエリ パラメーターとして渡すことができます。

REST API

HTTP メソッド エンドポイント 説明
POST https://api.appnexus.com/deal-list
(Deal List JSON)		 新しい取引リストを追加します。
PUT https://api.appnexus.com/deal-list
(Deal List JSON)		 取引リストを変更します。
DELETE https://api.appnexus.com/deal-list?id=DEAL_LIST_ID 取引リストを削除します。
DELETE https://api.appnexus.com/deal-list?id=DEAL_LIST_ID1,DEAL_LIST_ID2,DEAL_LIST_ID3 別の取引リストを削除します。
GET https://api.appnexus.com/deal-list 含まれるすべての取引リストと取引を表示します。
GET https://api.appnexus.com/deal-list?name=DEAL_LIST_NAME 名前で取引リストを表示し、それに含まれる取引を表示します。
GET https://api.appnexus.com/deal-list?id=DEAL_LIST_ID 特定の取引リストを表示し、それに含まれる取引を表示します。
GET https://api.appnexus.com/deal-list?advertiser_id=ADVERTISER_ID 広告主 ID 別に取引リストを表示し、それに含まれる取引を表示します。
GET https://api.appnexus.com/deal-list?deal_id=DEAL_ID 取引を含むすべての取引リストを表示します。
GET https://api.appnexus.com/deal-list?search=SEARCH_TERM

注:
SEARCH_TERM は、 DEAL_ID 特定の文字を含んでいるか、または DEAL_LIST_NAME 含まれている可能性があります。		 検索語句として ID または名前で取引リストを検索します。
GET https://api.appnexus.com/deal-list?search=SEARCH_TERM&advertiser_id=ADVERTISER_ID

注:
SEARCH_TERM は、 DEAL_ID 特定の文字を含んでいるか、または DEAL_LIST_NAME 含まれている可能性があります。		 検索語句として ID または名前で取引リストを検索し、特定の広告主がアクセスできます。
GET https://api.appnexus.com/deal-list?line_item_id=LINE_ITEM_ID 広告申込情報の対象となるすべての取引リストを表示します。

JSON フィールド

フィールド 種類 説明
id int 取引リストの ID。

必須:PUT JSON ペイロード内の 。
name string 取引リストの名前。

必須:POST JSON ペイロード内の 。
deals オブジェクトの配列 取引一覧に含める取引。 取引の取引 ID はここに含まれています。 このフィールドの例を参照してください。

必須のオン:POST、 PUT
advertisers オブジェクトの配列 取引リストの対象となる広告主。 広告主 ID はここに含まれています。 このフィールドの例を参照してください。

注:
呼び出し時 POST に、フィールドが空の advertisers 配列に設定されているか、値なしで設定されている場合、ユーザーがアクセスできるすべての広告主が既定で設定されます。 つまり、ユーザーがメンバーのすべての広告主にアクセスできる場合、広告主固有の制限がないため、このフィールドの既定値は空の配列になります。

同様に、通話の PUT 場合、広告主が空の配列に設定されている場合、ユーザーがアクセスできるすべての広告主が既定で設定されます (通話で PUT フィールド値を設定しても効果はありません)。
last_modified timestamp 取引リストに対して行われた最終変更時刻。

読み取り専用。
created_on timestamp 取引一覧の作成時刻。
line_items オブジェクトの配列 取引一覧を対象とする明細 (プロファイルがアタッチされ、そのプロファイルが取引リストを対象とする明細)。 このフィールドの例を参照してください。

読み取り専用。

フィールドの deals 例

"deals":[
{"id":1},
{"id":2},
{"id":3}
],

フィールドの advertisers 例

"advertisers":[
{"id":1},
{"id":2},
{"id":3}
],

フィールドの line_items 例

"line_items":[
{"id":1,
"name":"LINE_ITEM1",
"code":null
},
{
"id":2,
"name":"LINE_ITEM2",
"code":null
}
],

例

取引リストを作成する

この例では、新しい取引リストを作成します。

$ cat deal-list-create
 
{ 
   "deal-list":[ 
      { 
         "name":"My first deal list",
         "description": null,
         "advertisers":[
            {"id": 1},
            {"id": 2},
            {"id": 3}
         ]
      },
      { 
         "deals":[ 
            {"id": 1},
            {"id": 2},
            {"id": 3}
         ],
         "name":"Another one"
      }
   ]
}
 
$ curl -b cookies -X POST -d @deal-list-create 'https://api.appnexus.com/deal-list'
 
{
    "response": {
        "status": "OK",
        "deal-list": {
           "id": 3901,
           "name": "My first deal list"
           ....
         }
    }
}

取引リストを更新する

この例では、取引リストを更新します。

$ cat deal-list-update
 
{ 
   "deal-list": { 
       "deals": [{"id": 1}],
       "name":"My modified first deal list",
       "id":3901
   }
}
 
$ curl -b cookies -X PUT -d @deal-list-update 'https://api.appnexus.com/deal-list'
 
{
    "response": {
        "status": "OK",
        "inventory-list": {
           "id": 3901,
           "name": "XYZ Allowlist"
           "description": "Updated Description",
           ....
         }
    }
}

取引リストを削除する

この例では、既存の取引リストを削除します。

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