次の方法で共有

インベントリ リスト サービス

  • [アーティクル]

インベントリ リスト サービスは、ターゲットにするドメインとアプリを含むインベントリ リストを作成するために使用されます。 これらのインベントリ リストは、ターゲット設定のために広告申込情報に関連付けることができます。 インベントリ リスト サービスを使用して、インベントリ リストを作成、表示、更新します。 その後、 インベントリ リスト アイテム サービスを使用して、ドメインとアプリ (またはアプリ バンドル ID) をインベントリ リストに追加できます。

REST API

注:

UI のインベントリ リストの ID に基づいて API のインベントリ リストを編集するには、まず、次のGET呼び出しを使用して、API を使用してリストのidを取得する必要があります。

GET https://api.appnexus.com/inventory-list?inventory_url_list_id=[CONSOLE_UI_LIST_ID]

後続のすべての API 呼び出しで返される id フィールドの値を使用して、目的のインベントリ リストを編集します。

HTTP メソッド エンドポイント 説明
GET https://api.appnexus.com/inventory-list すべてのインベントリ リストを表示します。
GET https://api.appnexus.com/inventory-list?search=SEARCH_TERM 特定の文字を含むドメインまたはアプリを含むインベントリ リストを検索します。
POST https://api.appnexus.com/inventory-list 新しいインベントリ リストを追加します。
PUT https://api.appnexus.com/inventory-list/%5BINVENTORY_LIST_ID%5D インベントリ リストを更新します。
DELETE https://api.appnexus.com/inventory-list?id=INVENTORY_LIST_ID インベントリ リストを削除します。

注:

役立つクエリ文字列フィルター:

ほとんどのサービスで使用できるクエリ文字列フィルターの一般的な情報については、「 API Semantics (例: num_elements、 start elements、 search、 sort)」を参照してください。 has_appsおよびhas_domainsクエリ文字列フィルターは、inventory-list サービスに固有です。

HTTP メソッド エンドポイント 説明
GET https://api.appnexus.com/inventory-list?has_apps=true&has_domains=true アプリとドメインを含むすべてのリストを返します。
GET https://api.appnexus.com/inventory-list?has_apps=false&has_domains=true ドメインのみを含むすべてのリストを返します。
GET https://api.appnexus.com/inventory-list?has_apps=true&has_domains=false アプリのみを含むすべてのリストを返します。

JSON フィールド

フィールド 種類 説明
advertiser_id int このインベントリ リストが関連付けられている特定の広告主の ID。
null場合、すべてのメンバーの広告主がインベントリ リストを使用できます。
Default:null。
created_on string インベントリ リストが作成されたときのタイムスタンプ。
description string インベントリリストの説明。
id int インベントリ リストの ID ( POSTで自動生成)。
読み取り専用。
必須:PUT
name string 必須:POST
インベントリ リストの名前。
insertion_order_id int 在庫一覧が作成された挿入オーダの ID。
inventory_list_type 列挙 必須:POST

手記： 今後は、API に対して "allowlist" と "blocklist" の用語に従います。 これは、現在の用語の使用状況を評価し、Xandr プラットフォームのより包括的な用語を導き出す継続的な取り組みの一環です。
インベントリ リストの種類。 使用可能な値:
- allowlist
- blocklist

手記： このフィールドの値は、 PUT 呼び出しでは編集できません。
inventory_url_list_id int UI に表示されるインベントリ リストの ID。
last_modified string インベントリ リストが最後に更新されたときのタイムスタンプ。
line_item_id int ドメイン/アプリのターゲット設定にこの一覧を使用する広告申込情報の ID。
num_apps int インベントリ リスト内のアプリの合計数。
読み取り専用。
num_domains int インベントリ リスト内のドメインの合計数。
読み取り専用。
required_for_all ブール型 true場合、広告枠リストは広告主のすべての広告申込情報に適用されます (「advertiser_id」を参照)。
Default:false。

例

インベントリ リストを作成する

この例では、新しいインベントリ リストを作成します。

$ cat inventory-list-create
 
{
    "inventory-list": {
        "name": "XYZ Allowlist",
        "description": "A list of domains that Company XYZ wants to target",
        "inventory_list_type": "allowlist"
    }
}
 
$ curl -b cookies -X POST -d @inventory-list-create 'https://api.appnexus.com/inventory-list'
 
{
    "response": {
        "status": "OK",
        "inventory-list": {
           "id": 3901,
           "name": "XYZ Allowlist"
           ....
         }
    }
}

インベントリ リストを更新する

この例では、インベントリ リストを更新します。

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