Service Liste d’inventaire

2025-04-01

Le service de liste d’inventaire est utilisé pour créer des listes d’inventaire qui contiennent les domaines et les applications que vous souhaitez cibler. Ces listes d’inventaire peuvent ensuite être associées à des éléments de ligne à des fins de ciblage. Utilisez le service Liste d’inventaire pour créer, afficher et mettre à jour des listes d’inventaire. Vous pouvez ensuite ajouter des domaines et des applications (ou des ID d’ensemble d’applications) à la liste d’inventaire via le service d’éléments de liste d’inventaire.

API REST

Remarque

Pour modifier une liste d’inventaire dans l’API en fonction de l’ID de la liste d’inventaire dans l’interface utilisateur, vous devez d’abord obtenir le id de la liste via l’API à l’aide de l’appel suivant GET :

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

Utilisez la valeur du id champ retourné pour tous les appels d’API suivants afin de modifier la liste d’inventaire souhaitée.

HTTP, méthode	Endpoint	Description
`GET`	https://api.appnexus.com/inventory-list	Afficher toutes les listes d’inventaire.
`GET`	https://api.appnexus.com/inventory-list?search=SEARCH_TERM	Recherchez des listes d’inventaire avec des domaines ou des applications contenant certains caractères.
`POST`	https://api.appnexus.com/inventory-list	Ajoutez une nouvelle liste d’inventaire.
`PUT`	https://api.appnexus.com/inventory-list/%5BINVENTORY_LIST_ID%5D	Mettre à jour une liste d’inventaire.
`DELETE`	https://api.appnexus.com/inventory-list?id=INVENTORY_LIST_ID	Supprimer une liste d’inventaire.

Remarque

Filtres de chaîne de requête utiles :

Pour obtenir des informations générales sur les filtres de chaîne de requête disponibles pour la plupart des services, consultez Sémantique d’API (par exemple, num_elements, , start elementssearch, sort). Les has_apps filtres de chaîne de requête et has_domains sont uniques au inventory-list service.

HTTP, méthode	Endpoint	Description
`GET`	https://api.appnexus.com/inventory-list?has_apps=true& has_domains=true	Retourne toutes les listes qui contiennent des applications et des domaines.
`GET`	https://api.appnexus.com/inventory-list?has_apps=false& has_domains=true	Retourne toutes les listes qui contiennent uniquement des domaines.
`GET`	https://api.appnexus.com/inventory-list?has_apps=true& has_domains=false	Retourne toutes les listes qui contiennent uniquement des applications.

Champs JSON

Champ	Type	Description
`advertiser_id`	int	ID de l’annonceur spécifique à laquelle cette liste d’inventaire est associée. Si `null`la valeur est , la liste d’inventaire est disponible pour tous les annonceurs du membre. Valeur par défaut :`null` .
`created_on`	string	Horodatage lors de la création de la liste d’inventaire.
`description`	string	Description de la liste d’inventaire.
`id`	int	ID de la liste d’inventaire (généré automatiquement sur `POST`). En lecture seule. Obligatoire sur :`PUT`
`name`	chaîne	Obligatoire sur :`POST` Nom de la liste d’inventaire.
`insertion_order_id`	int	ID de l’ordre d’insertion sous lequel la liste d’inventaire a été créée.
`inventory_list_type`	enum	Obligatoire sur :`POST` Note: À l’avenir, les terminologies « allowlist » et « blocklist » seront suivies pour nos API. Cela fait partie d’un effort continu visant à évaluer notre utilisation actuelle de la terminologie et à intégrer une terminologie plus inclusive pour les plateformes Xandr. Type de liste d’inventaire. Valeurs possibles : - `allowlist` - `blocklist` Note: La valeur de ce champ ne peut pas être modifiée lors `PUT` des appels.
`inventory_url_list_id`	int	ID de la liste d’inventaire telle qu’elle apparaît dans l’interface utilisateur.
`last_modified`	string	Horodatage de la dernière mise à jour de la liste d’inventaire.
`line_item_id`	int	ID de l’élément de ligne utilisant cette liste pour le ciblage de domaine/d’application.
`num_apps`	int	Nombre total d’applications dans la liste d’inventaire. En lecture seule.
`num_domains`	int	Nombre total de domaines dans la liste d’inventaire. En lecture seule.
`required_for_all`	Valeur booléenne	Si `true`la valeur est , la liste d’inventaire est appliquée à tous les éléments de ligne sous l’annonceur (voir `advertiser_id`). Valeur par défaut :`false` .

Exemples

Create une liste d’inventaire

Dans cet exemple, nous créons une liste d’inventaire.

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

Mettre à jour une liste d’inventaire

Dans cet exemple, nous mettons à jour une liste d’inventaire.

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

Partager via