Ce service en lecture seule vous permet de récupérer l’ID, le nom, le code, l’état et, dans certains cas, les descriptions des types d’objets suivants dans votre compte. Elle retourne également des informations hiérarchiques sur ces objets, par exemple, l’ID d’éditeur pour un emplacement ou l’ID d’annonceur pour un élément de ligne. Dans les cas où vous avez des informations limitées sur les objets, ce service vous offre un moyen simple de mapper à d’autres données pertinentes.
Les flux de création de rapports en bloc, par exemple, retournent des données regroupées par ID d’objet. Vous pouvez utiliser le service de recherche pour faire correspondre ces ID avec des noms, des codes, etc.
- Annonceurs
- Ordres d’insertion
- Éléments de ligne
- Campagnes
- Créatifs
- Segment Pixels
- Conversion Pixels
- Éditeurs
- Règles de paiement
- Sites
- Placements
- Étiquettes
Remarque
- Le service de recherche est différent du service de recherche , car il retourne tous les objets d’un certain type dans votre compte. Le service de recherche vous permet de rechercher des objets avec un nom, un code ou un ID spécifique.
- Le service de recherche peut retourner un maximum de 50 000 objets.
- Le service de recherche est basé sur des données mises en cache et mises à jour toutes les 8 minutes.
API REST
| Méthode |
Endpoint |
Description |
GET |
https://api.appnexus.com/lookup |
Afficher des informations sur tous les objets de votre système. |
GET |
https://api.appnexus.com/lookup?type=OBJECT_TYPE |
Afficher des informations sur tous les objets d’un type spécifique.
Remarque :
Vous pouvez obtenir des informations sur les types d’objets suivants : , , campaign, , , segment_pixelconversion_pixelcreative, , publisher, payment_rule, placement, , site, et .labelbudget_splitterline_iteminsertion_orderadvertiser |
GET |
https://api.appnexus.com/lookup?advertiser_id=ADVERTISER_ID |
Afficher des informations sur tous les objets appartenant à un annonceur spécifique. |
Champs JSON
Champs retournés pour tous les types d’objets :
| Champ |
Type |
Description |
code |
string |
Code personnalisé de l’objet (non applicable à tous les types d’objets). |
id |
int |
ID interne associé à l’objet . |
last_modified |
Timestamp |
Date et heure de la dernière modification de l’objet. |
name |
string |
Nom de l’objet. |
state |
enum |
État de l’objet.
Valeurs possibles : "active" ou "inactive". |
Champs JSON spécifiques à l’objet
Champs supplémentaires retournés pour des types d’objets spécifiques.
Annonceur
| Champ |
Type |
Description |
member_id |
int |
ID du membre auquel appartient l’annonceur. |
Ordre d’insertion
| Champ |
Type |
Description |
advertiser_id |
int |
ID de l’annonceur auquel appartient l’ordre d’insertion. |
Élément de ligne
| Champ |
Type |
Description |
advertiser_id |
int |
ID de l’annonceur auquel appartient l’élément de ligne. |
Campagne
| Champ |
Type |
Description |
line_item_id |
int |
ID de l’élément de ligne auquel appartient la campagne. |
Séparateur de budget
| Champ |
Type |
Description |
line_item_id |
int |
ID de l’élément de ligne auquel appartiennent les fractionnements de budget. |
name |
string |
Nom du fractionnement du budget. |
id |
int |
ID du fractionnement du budget. |
state |
string |
État du fractionnement du budget.
Les valeurs autorisées sont les suivantes :
- active
- inactive |
last_modified |
date |
Horodatage de la dernière modification du fractionnement. |
Créatif
| Champ |
Type |
Description |
advertiser_id |
int |
ID de l’annonceur auquel appartient le créatif. |
brand_id |
int |
ID de la marque associée au créatif. |
description |
chaîne |
Description du créatif. |
landing_page_url |
string |
URL de la page d’accueil associée à cette création. |
publisher_id |
int |
ID de l’éditeur auquel le créatif est associé. |
Pixel de segment
| Champ |
Type |
Description |
advertiser_id |
int |
ID de l’annonceur auquel le pixel de segment est associé. |
member_id |
int |
ID du membre auquel appartient le pixel de segment. |
Pixel de conversion
| Champ |
Type |
Description |
advertiser_id |
int |
ID de l’annonceur auquel appartient le pixel de conversion. |
Éditeur
| Champ |
Type |
Description |
member_id |
int |
ID du membre auquel appartient l’éditeur. |
Règle de paiement
| Champ |
Type |
Description |
description |
string |
Description de la règle de paiement. |
publisher_id |
int |
ID de l’éditeur auquel appartient la règle de paiement. |
Placement
| Champ |
Type |
Description |
publisher_id |
int |
ID du serveur de publication auquel appartient le placement. |
Site
| Champ |
Type |
Description |
publisher_id |
int |
ID de l’éditeur auquel le site appartient. |
Étiquette
| Champ |
Type |
Description |
label_id |
int |
ID de l’étiquette. |
member_id |
int |
ID du membre auquel appartient l’étiquette. |
object_id |
int |
ID de l’objet auquel l’étiquette peut être appliquée. |
object_type |
enum |
Type d’objet auquel l’étiquette peut être appliquée.
Valeurs possibles : "advertiser", "insertion_order", "line_item", "campaign"ou "publisher". |
value |
chaîne |
Texte de l’étiquette. |
Exemples
Rechercher toutes vos campagnes
$ curl -b cookies -c cookies 'https://api.appnexus.com/lookup?type=campaign'
{
"response": {
"status": "OK",
"num_elements": 2,
"start_element": 0,
"results": {
"campaign": {
"results": [
{
"id": "58990",
"name": "Car Donations",
"line_item_id": "31189",
"state": "active",
"code": "cdon",
"last_modified": "2011-10-18 17:25:00"
},
{
"id": "58991",
"name": "Bucket Builders",
"line_item_id": "31189",
"state": "active",
"code": "bb",
"last_modified": "2011-10-12 22:08:04"
}
],
"num_elements": "2"
}
}
}
}
Rechercher tous les objets accessibles à ce service
$ curl -b cookies -c cookies 'https://api.appnexus.com/lookup'
{
"response": {
"status": "OK",
"num_elements": 24,
"start_element": 0,
"results": {
"advertiser": {
"results": [
{
"id": "35081",
"name": "Bucketeer",
"code": "bucket",
"member_id": "1066",
"state": "active",
"last_modified": "2011-10-18 17:25:00"
}
],
"num_elements": "1"
},
"insertion_order": {
"results": null,
"num_elements": 0
},
"line_item": {
"results": [
{
"id": "31189",
"name": "bucket line 1",
"code": "bk1",
"advertiser_id": "35081",
"state": "active",
"last_modified": "2011-10-18 17:25:00"
}
],
"num_elements": "1"
},
"campaign": {
"results": [
{
"id": "58990",
"name": "Car Donations",
"line_item_id": "31189",
"state": "active",
"code": "cdon",
"last_modified": "2011-10-18 17:25:00"
},
{
"id": "58991",
"name": "Bucket Builders",
"line_item_id": "31189",
"state": "active",
"code": "bb",
"last_modified": "2011-10-17 13:24:00"
}
],
"num_elements": "2"
},
"budget_splitter":{
"results": [
{
"line_item_id": 1,
"name": "Split 1",
"id": 1,
"state": "active",
"last_modified": "2023-04-18 17:25:00"
},
{
"line_item_id": 1,
"name": "Split 2",
"id": 2,
"state": "active",
"last_modified": "2023-04-19 17:25:00"
},
],
"num_elements": "2"
},
"creative": {
"results": [
{
"id": "445832",
"code": null,
"description": "Donate car.png",
"advertiser_id": "35081",
"publisher_id": "0",
"state": "active",
"brand_id": 1,
"landing_page_url": "www.cardonations.com/donate",
"last_modified": "2011-10-17 13:24:00"
},
{
"id": "445833",
"code": null,
"description": "bucketbuilders.png",
"advertiser_id": "35081",
"publisher_id": "0",
"state": "active",
"brand_id": 3,
"landing_page_url": "www.buckets.com/build",
"last_modified": "2011-10-17 13:24:00"
}
],
"num_elements": "2"
},
"segment_pixel": {
"results": null,
"num_elements": 0
},
"payment_rule": {
"results": [
{
"id": "91345",
"name": "",
"publisher_id": "89286",
"state": "active",
"description": "",
"last_modified": "2011-10-17 13:24:00"
},
{
"id": "91346",
"name": "Default",
"publisher_id": "89287",
"state": "active",
"description": "",
"last_modified": "2011-10-17 13:24:00"
},
{
"id": "91375",
"name": "Base Payment Rule",
"publisher_id": "89314",
"state": "active",
"description": "",
"last_modified": "2011-10-17 13:24:00"
}
],
"num_elements": "3"
},
"conversion_pixel": {
"results": null,
"num_elements": 0
},
"publisher": {
"results": [
{
"id": "89286",
"name": "Default Real Time",
"member_id": "1066",
"state": "inactive",
"code": "",
"last_modified": "2011-10-17 13:24:00"
},
{
"id": "89287",
"name": "Wide Road",
"member_id": "1066",
"state": "active",
"code": "bb",
"last_modified": "2011-10-17 13:24:00"
},
{
"id": "89314",
"name": "Radio Live",
"member_id": "1066",
"state": "active",
"code": "rlive",
"last_modified": "2011-10-17 13:24:00"
},
...
],
"num_elements": "5"
},
"placement": {
"results": [
{
"id": "594594",
"name": "[Default Real Time] - Default",
"publisher_id": "89286",
"state": "active",
"code": "",
"last_modified": "2011-10-17 13:24:00"
},
{
"id": "594595",
"name": "[Wide Road] - Placement 1",
"publisher_id": "89287",
"state": "active",
"code": "",
"last_modified": "2011-10-17 13:24:00"
},
{
"id": "594641",
"name": "[Radio Live] - Default",
"publisher_id": "89314",
"state": "active",
"code": "",
"last_modified": "2011-10-17 13:24:00"
},
...
],
"num_elements": "5"
},
"site": {
"results": [
{
"id": "188039",
"code": "",
"name": "[Default Real Time] - ROS",
"publisher_id": "89286",
"state": "active",
"last_modified": "2011-10-17 13:24:00"
},
{
"id": "188040",
"code": "",
"name": "[Wide Road] - ROS",
"publisher_id": "89287",
"state": "active",
"last_modified": "2011-10-17 13:24:00"
},
{
"id": "188070",
"code": "",
"name": "[Radio Live] - ROS",
"publisher_id": "89314",
"state": "active",
"last_modified": "2011-10-17 13:24:00"
},
...
],
"num_elements": "5"
},
}
}
}