Remarque
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
Une transaction est un accord entre un acheteur et un vendeur qui fournit un accès spécial à l’inventaire et/ou aux données. Les transactions sont principalement utilisées pour accéder à l’inventaire premium préféré ou à l’inventaire négocié. Une liste de transactions est un groupe d’ID de transactions catégorisés sous un titre pour le ciblage d’éléments de ligne. Les listes de transactions permettent aux spécialistes de l’inventaire d’organiser l’inventaire des transactions pour les traders et de simplifier les flux de travail des traders, comme le ciblage du même ensemble de transactions sur les articles de ligne. Si les exigences de regroupement de transactions changent, seul le fait d’apporter les modifications requises dans la liste des transactions met automatiquement à jour tous les éléments de ligne en conséquence.
L’API Liste de transactions facilite la recherche, l’ajout, la modification et la récupération d’une liste de transactions spécifique ou différente. Il vous permet de créer, d’ajouter et de remplacer une liste de transactions par des ID de transaction séparés par des virgules.
Remarque
Tous les paramètres de requête du service Liste de transactions prennent en charge une liste de valeurs séparées par des virgules. Par exemple, pour supprimer un ensemble de listes de transactions, une liste d’ID séparés par des virgules peut être passée en tant que paramètres de requête.
API REST
| HTTP, méthode | Endpoint | Description |
|---|---|---|
POST |
https://api.appnexus.com/deal-list(Liste de transactions JSON) |
Ajouter une liste de nouvelles transactions. |
PUT |
https://api.appnexus.com/deal-list(Liste de transactions JSON) |
Modifier une liste de transactions. |
DELETE |
https://api.appnexus.com/deal-list?id=DEAL_LIST_ID |
Supprimer une liste de transactions. |
DELETE |
https://api.appnexus.com/deal-list?id=DEAL_LIST_ID1,DEAL_LIST_ID2,DEAL_LIST_ID3 |
Supprimez différentes listes de transactions. |
GET |
https://api.appnexus.com/deal-list |
Affichez toutes les listes de transactions et les transactions qu’elles contiennent. |
GET |
https://api.appnexus.com/deal-list?name=DEAL_LIST_NAME |
Affichez une liste de transactions par nom et les transactions qu’elle contient. |
GET |
https://api.appnexus.com/deal-list?id=DEAL_LIST_ID |
Affichez une liste de transactions spécifique et les transactions qu’elle contient. |
GET |
https://api.appnexus.com/deal-list?advertiser_id=ADVERTISER_ID |
Affichez une liste de transactions par ID d’annonceur et les transactions qu’elle contient. |
GET |
https://api.appnexus.com/deal-list?deal_id=DEAL_ID |
Afficher toutes les listes de transactions contenant une transaction. |
GET |
https://api.appnexus.com/deal-list?search=SEARCH_TERMRemarque : SEARCH_TERM peut être DEAL_ID ou DEAL_LIST_NAME contenir certains caractères. |
Recherchez une liste de transactions par ID ou nom comme terme de recherche. |
GET |
https://api.appnexus.com/deal-list?search=SEARCH_TERM&advertiser_id=ADVERTISER_IDRemarque : SEARCH_TERM peut être DEAL_ID ou DEAL_LIST_NAME contenir certains caractères. |
Rechercher une liste de transactions par ID ou nom en tant que terme de recherche et accessible à un annonceur particulier. |
GET |
https://api.appnexus.com/deal-list?line_item_id=LINE_ITEM_ID |
Afficher toutes les listes de transactions ciblées par un élément de ligne. |
Champs JSON
| Champ | Type | Description |
|---|---|---|
id |
int | ID d’une liste de transactions. Obligatoire Sur : PUT, dans la charge utile JSON. |
name |
string | Nom de la liste des transactions. Obligatoire Sur : POST, dans la charge utile JSON. |
deals |
tableau d’objets | Les transactions qui doivent être incluses dans la liste des transactions. Les ID des transactions sont inclus ici. Consultez l’exemple pour ce champ. Obligatoire sur : POST, PUT |
advertisers |
tableau d’objets | Les annonceurs pour lesquels la liste des transactions est destinée. Les ID d’annonceur sont inclus ici. Consultez l’exemple pour ce champ. Remarque : Lors POST des appels, si le advertisers champ est défini sur un tableau vide ou sans valeur, il est défini par défaut sur tous les annonceurs auxquels l’utilisateur a accès. En d’autres termes, si l’utilisateur a accès à tous les annonceurs sous un membre, ce champ est défini par défaut sur un tableau vide, car aucune restriction spécifique à l’annonceur n’est présente.De même, sur PUT les appels, si les annonceurs sont définis sur des tableaux vides, il s’agit par défaut de tous les annonceurs auxquels l’utilisateur a accès (la définition d’une valeur de champ sur PUT les appels n’a aucun effet). |
last_modified |
Timestamp | Heure de la dernière modification apportée à la liste des transactions. En lecture seule. |
created_on |
Timestamp | Heure de création de la liste des transactions. |
line_items |
tableau d’objets | Éléments de ligne qui ciblent la liste des transactions (éléments de ligne auxquels un profil est attaché et ce profil cible la liste des transactions). Consultez l’exemple pour ce champ. En lecture seule. |
Exemple pour le deals champ
"deals":[
{"id":1},
{"id":2},
{"id":3}
],
Exemple pour le advertisers champ
"advertisers":[
{"id":1},
{"id":2},
{"id":3}
],
Exemple pour le line_items champ
"line_items":[
{"id":1,
"name":"LINE_ITEM1",
"code":null
},
{
"id":2,
"name":"LINE_ITEM2",
"code":null
}
],
Exemples
Create une liste de transactions
Dans cet exemple, nous créons une liste de nouvelles transactions.
$ cat deal-list-create
{
"deal-list":[
{
"name":"My first deal list",
"description": null,
"advertisers":[
{"id": 1},
{"id": 2},
{"id": 3}
]
},
{
"deals":[
{"id": 1},
{"id": 2},
{"id": 3}
],
"name":"Another one"
}
]
}
$ curl -b cookies -X POST -d @deal-list-create 'https://api.appnexus.com/deal-list'
{
"response": {
"status": "OK",
"deal-list": {
"id": 3901,
"name": "My first deal list"
....
}
}
}
Mettre à jour une liste de transactions
Dans cet exemple, nous mettons à jour une liste de transactions.
$ cat deal-list-update
{
"deal-list": {
"deals": [{"id": 1}],
"name":"My modified first deal list",
"id":3901
}
}
$ curl -b cookies -X PUT -d @deal-list-update 'https://api.appnexus.com/deal-list'
{
"response": {
"status": "OK",
"inventory-list": {
"id": 3901,
"name": "XYZ Allowlist"
"description": "Updated Description",
....
}
}
}
Supprimer une liste de transactions
Dans cet exemple, nous supprimons une liste de transactions existante.
$ curl -b cookies -c cookies -X DELETE https://api.appnexus.com/deal-list?id=3901
{
"response": {
"status": "OK",
"count": 1,
"start_element": null,
"num_elements": null
}
}