Compartir a través de

Servicio de elemento de lista de inventario

  • Artículo

El servicio de elemento de lista de inventario le permite agregar identificadores de lote de aplicaciones y direcciones URL sin procesar (dominio o aplicación) a una lista de inventario existente. Por ejemplo:

API de REST

Http (método) Endpoint Description
GET https://api.appnexus.com/inventory-list/%5BLIST_ID%5D/item Ver todos los elementos (dominios o aplicaciones) en una lista de inventario específica.
GET https://api.appnexus.com/inventory-list/%5BLIST_ID%5D/item?search=SEARCH_TERM Busque dominios o aplicaciones que contengan determinados caracteres.
POST https://api.appnexus.com/inventory-list/%5BLIST_ID%5D/item Agregue nuevos dominios o aplicaciones a una lista de inventario.

Nota: 1000 elementos (dominios o aplicaciones) es el número máximo de elementos que puede agregar a una lista de inventario para cada POST solicitud.
PUT https://api.appnexus.com/inventory-list/%5BLIST_ID%5D/item/%5BINVENTORY_LIST_ITEM_ID%5D Actualizar un elemento de lista de inventario.

Nota: El include_children campo es el único campo de un elemento de lista de inventario que puede actualizar con una PUT solicitud.
DELETE https://api.appnexus.com/inventory-list/%5BLIST_ID%5D/item?id=1,2,3 Elimine elementos (dominios o aplicaciones) de una lista de inventario.

Campos JSON

Campo Tipo Descripción
app_name string Nombre del elemento de aplicación (null si es un dominio).
audit_status enumeración Estado actual del dominio o la aplicación. Los posibles valores son:
- audited: el dominio o la aplicación ha superado la auditoría de inventario de Xandr.
- rejected: el dominio o la aplicación han producido un error en la auditoría de inventario de Xandr (debido a infracciones de la directiva de Xandr).
- unaudited: el dominio o la aplicación no se auditó.
- unauditable: el dominio o la aplicación no se auditó.
- pending: el dominio o la aplicación no se auditó (valor predeterminado).
- masked: el vendedor no expuso la dirección URL real del dominio o la aplicación para la creación de informes o de destino, pero se auditó y pasó la auditoría de inventario de Xandr.
- is_adserver: el dominio o la aplicación no se auditó y se detectó como un dominio de servidor de anuncios.
id Entero Identificador asociado a la aplicación o dominio que va a agregar. Generado automáticamente en POST.
Solo lectura.
Obligatorio activado:PUT
is_supported booleano Indica si Xandr admite actualmente la aplicación o dominio (por ejemplo, si se ha auditado). Si truees , se admite.
inventory_url string Dirección URL de la aplicación o dominio una vez validada. Para obtener más información sobre cómo se realiza la validación, consulte Validate Inventory Item service(Validar el servicio de elementos de inventario).
include_children booleano Indica si se deben incluir subdominios y subpaths del dominio primario. Si truees , se incluirán subdominios.
rejection_reason string El motivo por el que este dominio o aplicación infringe la directiva Xandr (por ejemplo, Violence, Hate Speech) si el audit_status campo está establecido rejecteden . Si el audit_status campo no está establecido en rejected, este campo será null.
url string Obligatorio activado:POST
Dirección URL sin formato o identificador de lote de aplicaciones que proporcione para agregar el elemento (dominio o aplicación).

Ejemplos

Adición de dominios y aplicaciones (elementos) a una lista de inventario

En este ejemplo, agregamos dominios y aplicaciones (elementos) a una lista de inventario.

$ cat inventory-list-item
 
{
    "inventory-list-items": [
        {
            "url": "bad-domain.com",
            "include_children": false
        }, 
        {
            "url": "app_id"
        }, 
        ...
    ]
}
 
curl -b cookies -X POST -d @inventory-list-item "https://api.appnexus.com/inventory-list/3452/item"
 
{ 
    "response": { 
        "status": "OK",
        "inventory-list-items": [
            {
                "audit_status": "rejected",
                "inventory_url": "bad-domain.com",
                "include_children": false,
                "is_supported": true, 
                "rejection_reason": "Violence"
            }, 
            {
                "audit_status": "audited",
                "inventory_url": "app_url.com",
                "include_children": false,
                "is_supported": true, 
                "rejection_reason": null
            }, 
            ...
        ]
    }
}

Visualización de todos los dominios o aplicaciones (elementos) en una lista de inventario específica

En este ejemplo, se ven dominios y aplicaciones (elementos) en una lista de inventario.

$ curl -b cookies -X GET "https://api.appnexus.com/inventory-list/3452/item" 

{ 
    "response": { 
        "status": "OK",
        "inventory-list-items": [
            {
                "id": 1, 
                "audit_status": "rejected",
                "app_name": null, 
                "inventory_url": "bad-domain.com",
                "include_children": false,
                "is_supported": true, 
                "rejection_reason": "Violence"
            }, 
            {
                "id": 2, 
                "audit_status": "audited",
                "app_name": "Name of the app", 
                "inventory_url": "app_url.com",
                "include_children": false,
                "is_supported": true, 
                "rejection_reason": null
            }, 
            ...
        ]
    }
}

Actualización de un elemento de lista de inventario en una lista de inventario

En este ejemplo, actualizamos un elemento de lista de inventario en una lista de inventario.

$ cat inventory-list-item

{
    "inventory-list-item": {
        "include_children": true
    }
}

curl -b cookies -X PUT -d @nventory-list-item 'https://api.appnexus.com/inventory-list/3452/item/2'

{
    "response": {
        "inventory-list-item": {
            "id": 2,
            "include_children": true,
            "audit_status": "audited",
            "app_name": "Name of the app",
            "inventory_url": "app_url.com"
        },
        "status": "OK",
        "num_elements": 1,
        "start_element": 0,
        "count": 1
    }
}