Partager via


Service d’élément de liste d’inventaire

Le service d’éléments de liste d’inventaire vous permet d’ajouter des ID d’ensemble d’applications et des URL brutes (domaine ou application) à une liste d’inventaire existante. Par exemple :

API REST

HTTP, méthode Endpoint Description
GET https://api.appnexus.com/inventory-list/%5BLIST_ID%5D/item Afficher tous les éléments (domaines/applications) dans une liste d’inventaire spécifique.
GET https://api.appnexus.com/inventory-list/%5BLIST_ID%5D/item?search=SEARCH_TERM Recherchez des domaines ou des applications contenant certains caractères.
POST https://api.appnexus.com/inventory-list/%5BLIST_ID%5D/item Ajouter de nouveaux domaines/applications à une liste d’inventaire.

Remarque : 1 000 éléments (domaines/applications) est le nombre maximal d’éléments que vous pouvez ajouter à une liste d’inventaire pour chaque POST requête.
PUT https://api.appnexus.com/inventory-list/%5BLIST_ID%5D/item/%5BINVENTORY_LIST_ITEM_ID%5D Mettre à jour un élément de liste d’inventaire.

Note: Le include_children champ est le seul champ d’un élément de liste d’inventaire que vous pouvez mettre à jour avec une PUT requête.
DELETE https://api.appnexus.com/inventory-list/%5BLIST_ID%5D/item?id=1,2,3 Supprimer des éléments (domaines/applications) d’une liste d’inventaire.

Champs JSON

Champ Type Description
app_name string Nom de l’élément d’application (null si un domaine).
audit_status enum Status actuel du domaine ou de l’application. Les valeurs possibles sont les suivantes :
- audited: le domaine ou l’application a passé l’audit de l’inventaire Xandr.
- rejected: le domaine ou l’application a échoué à l’audit de l’inventaire Xandr (en raison de violations de stratégie Xandr).
- unaudited: le domaine ou l’application n’a pas été audité.
- unauditable: le domaine ou l’application n’a pas été audité.
- pending: le domaine ou l’application n’a pas été audité (valeur par défaut).
- masked: l’URL réelle du domaine ou de l’application n’a pas été exposée par le vendeur pour le ciblage ou la création de rapports, mais elle a toujours été auditée et a passé l’audit d’inventaire Xandr.
- is_adserver: le domaine ou l’application n’a pas été audité et a été détecté comme domaine de serveur publicitaire.
id int ID associé à l’application ou au domaine que vous ajoutez. Généré automatiquement le POST.
En lecture seule.
Obligatoire sur :PUT
is_supported valeur booléenne Indique si l’application ou le domaine est actuellement pris en charge par Xandr (par exemple, s’il a été audité). Si truela valeur est , elle est prise en charge.
inventory_url string URL de l’application ou du domaine une fois qu’elle a été validée. Pour plus d’informations sur la façon dont la validation est effectuée, consultez Service Valider l’élément d’inventaire.
include_children valeur booléenne Indique si les sous-domaines et sous-chemins du domaine parent doivent être inclus. Si truela valeur est , les sous-domaines sont inclus.
rejection_reason chaîne Raison pour laquelle ce domaine ou cette application ne respecte pas la stratégie Xandr (par exemple, Violence, Hate Speech) si le champ a la audit_status valeur rejected. Si le audit_status champ n’est pas défini sur rejected, ce champ sera null.
url string Obligatoire sur :POST
URL brute ou ID d’ensemble d’applications que vous fournissez pour l’élément (domaine ou application) à ajouter.

Exemples

Ajouter des domaines et des applications (éléments) à une liste d’inventaire

Dans cet exemple, nous ajoutons des domaines et des applications (éléments) à une liste d’inventaire.

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

Afficher tous les domaines/applications (éléments) dans une liste d’inventaire spécifique

Dans cet exemple, nous affichons les domaines et les applications (éléments) dans une liste d’inventaire.

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

Mettre à jour un élément de liste d’inventaire dans une liste d’inventaire

Dans cet exemple, nous mettons à jour un élément de liste d’inventaire dans une liste d’inventaire.

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