Compartir a través de

Servicio de lista de inventario

  • Artículo

Inventory List Service se usa para crear listas de inventario que contengan los dominios y las aplicaciones de destino. Estas listas de inventario se pueden asociar a los elementos de línea para la selección de destino. Use Inventory List Service para crear, ver y actualizar listas de inventario. Después, puede agregar dominios y aplicaciones (o identificadores de agrupación de aplicaciones) a la lista de inventario a través del servicio de elementos de lista de inventario.

API de REST

Nota:

Para editar una lista de inventario en la API en función del identificador de la lista de inventario de la interfaz de usuario, primero debe obtener el id de la lista a través de la API mediante la llamada siguiente GET :

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

Use el valor del id campo devuelto para todas las llamadas API posteriores para editar la lista de inventario deseada.

Http (método) Endpoint Description
GET https://api.appnexus.com/inventory-list Ver todas las listas de inventario.
GET https://api.appnexus.com/inventory-list?search=SEARCH_TERM Busque listas de inventario con dominios o aplicaciones que contengan determinados caracteres.
POST https://api.appnexus.com/inventory-list Agregue una nueva lista de inventario.
PUT https://api.appnexus.com/inventory-list/%5BINVENTORY_LIST_ID%5D Actualizar una lista de inventario.
DELETE https://api.appnexus.com/inventory-list?id=INVENTORY_LIST_ID Elimine una lista de inventario.

Nota:

Filtros de cadena de consulta útiles:

Para obtener información general sobre los filtros de cadena de consulta disponibles para la mayoría de los servicios, vea Semántica de API (por ejemplo, num_elements, start elements, , searchsort). Los has_apps filtros de cadena de consulta y has_domains son únicos para el inventory-list servicio.

Http (método) Endpoint Description
GET https://api.appnexus.com/inventory-list?has_apps=true& has_domains=true Devuelve todas las listas que contienen aplicaciones y dominios.
GET https://api.appnexus.com/inventory-list?has_apps=false& has_domains=true Devuelve todas las listas que contienen solo dominios.
GET https://api.appnexus.com/inventory-list?has_apps=true& has_domains=false Devuelve todas las listas que contienen solo aplicaciones.

Campos JSON

Campo Tipo Descripción
advertiser_id Entero El identificador del anunciante específico al que está asociada esta lista de inventario.
Si nulles , la lista de inventario está disponible para todos los anunciantes del miembro.
Valor predeterminado:null.
created_on string Marca de tiempo cuando se creó la lista de inventario.
description string Descripción de la lista de inventario.
id Entero Identificador de la lista de inventario (generado automáticamente en POST).
Solo lectura.
Obligatorio activado:PUT
name string Obligatorio activado:POST
Nombre de la lista de inventario.
insertion_order_id Entero Identificador del orden de inserción en el que se creó la lista de inventario.
inventory_list_type enumeración Obligatorio activado:POST

Nota: En el futuro, se seguirá la terminología de "allowlist" y "blocklist" para nuestras API. Esto forma parte de un esfuerzo continuo para evaluar el uso actual de la terminología y dar inicio a una terminología más inclusiva para las plataformas Xandr.
Tipo de lista de inventario. Posibles valores:
- allowlist
- blocklist

Nota: El valor de este campo no se puede editar en PUT las llamadas.
inventory_url_list_id Entero Identificador de la lista de inventario tal como aparece en la interfaz de usuario.
last_modified string Marca de tiempo cuando se actualizó por última vez la lista de inventario.
line_item_id Entero Identificador del elemento de línea que usa esta lista para el destino de dominio o aplicación.
num_apps Entero Número total de aplicaciones en la lista de inventario.
Solo lectura.
num_domains Entero Número total de dominio en la lista de inventario.
Solo lectura.
required_for_all Booleano Si truees , la lista de inventario se aplicará a todos los artículos de línea del anunciante (consulte advertiser_id).
Valor predeterminado:false.

Ejemplos

Creación de una lista de inventario

En este ejemplo, se crea una nueva lista de inventario.

$ 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"
           ....
         }
    }
}

Actualización de una lista de inventario

En este ejemplo, actualizamos una lista de inventario.

$ 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",
           ....
         }
    }
}