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.
Le service pixel peut être utilisé pour créer des pixels de conversion à placer sur les pages de l’annonceur afin de suivre à la fois les conversions d’affichage et de clic.
Remarque
Une fois que vous avez un ID de pixel de conversion, le format de base d’un pixel de conversion d’image est <img src="media/px?id=37&t=2" width="1" height="1" />.
Conseil
Les pixels de segment sont créés séparément via le service segment.
API REST
| HTTP, méthode | Endpoint | Description |
|---|---|---|
GET |
https://api.appnexus.com/pixel | Afficher tous les pixels de conversion. |
GET |
https://api.appnexus.com/pixel?id=123,456,789 | Afficher un tableau de pixels de conversion spécifiques. |
GET |
https://api.appnexus.com/pixel?advertiser_id=ADVERTISER_ID | Affichez tous les pixels de conversion de l’un de vos annonceurs. |
GET |
https://api.appnexus.com/pixel?advertiser_code=ADVERTISER_CODE | Affichez tous les pixels de conversion de l’un de vos annonceurs. |
GET |
https://api.appnexus.com/pixel?advertiser_id=ADVERTISER_ID& id=PIXEL_ID | Affichez un pixel de conversion particulier pour l’un de vos annonceurs. |
GET |
https://api.appnexus.com/pixel?advertiser_code=ADVERTISER_CODE& code=PIXEL_CODE | Affichez un pixel de conversion particulier pour l’un de vos annonceurs. |
GET |
https://api.appnexus.com/pixel/meta | Découvrez les champs que vous pouvez filtrer et trier. |
POST |
https://api.appnexus.com/pixel?advertiser_id=ADVERTISER_ID | Ajoutez un nouveau pixel de conversion à l’un de vos annonceurs. |
POST |
https://api.appnexus.com/pixel?advertiser_code=ADVERTISER_CODE | Ajoutez un nouveau pixel de conversion à l’un de vos annonceurs. |
PUT |
https://api.appnexus.com/pixel?advertiser_id=ADVERTISER_ID& id=PIXEL_ID | Modifier un pixel de conversion existant. |
PUT |
https://api.appnexus.com/pixel?advertiser_code=ADVERTISER_CODE& code=PIXEL_CODE | Modifier un pixel de conversion existant. |
DELETE |
https://api.appnexus.com/pixel?advertiser_id=ADVERTISER_ID& id=PIXEL_ID | Supprimer un pixel de conversion existant. Note: Vous ne pouvez pas supprimer un pixel utilisé par un ou plusieurs éléments de ligne. Vous devez d’abord modifier l’élément de ligne pour supprimer le pixel de conversion. |
Champs JSON
| Champ | Type | Description |
|---|---|---|
advertiser_id |
int | ID de l’annonceur propriétaire du pixel. Obligatoire sur : POST |
campaigns |
tableau | Campagnes auxquelles le pixel est associé. Pour plus d’informations sur les champs de ce tableau, consultez Campagnes ci-dessous. En lecture seule. |
code |
string | Code personnalisé pour le pixel. |
created_on |
Timestamp | Date et heure de création du pixel. En lecture seule. |
id |
int | ID interne associé au pixel. Obligatoire sur : PUT |
name |
string | Nom du pixel. Obligatoire sur : POST |
last_modified |
Timestamp | Date et heure de la dernière modification du pixel. En lecture seule. |
line_items |
tableau | Éléments de ligne auxquels le pixel est associé. Pour plus d’informations sur les champs de ce tableau, consultez Éléments de ligne ci-dessous. En lecture seule. |
min_minutes_per_conv |
int | Intervalle (en minutes) pour autoriser une conversion de répétition. La valeur maximale est 32767 (22 jours).- Si la valeur est 0définie sur : comptez toutes les conversions.- Si la valeur null est définie sur (valeur par défaut) : comptez un par utilisateur.Par défaut: null |
piggyback_pixels |
tableau d’objets | URL des pixels que vous souhaitez que nous tirions lorsque le pixel de conversion se déclenche. Pour plus d’informations, consultez Pixels piggyback ci-dessous. |
pixel_conversion_event |
tableau | Catégorie d’événement de conversion de pixels à laquelle le pixel est associé. Pour plus d’informations, consultez Événement de conversion de pixels ci-dessous. En lecture seule. |
pixel_conversion_event_id |
enum | Optional. ID de l’événement de conversion associé au pixel. La définition d’une catégorie d’événement n’affecte pas immédiatement nos algorithmes d’optimisation. Au lieu de cela, il fournit à notre équipe d’optimisation des données précieuses pour la prédiction que nous pouvons commencer à tester et incorporer. Si vous ne voyez pas de correspondance correcte pour votre type d’événement de conversion, laissez ce champ vide. Les valeurs possibles sont les suivantes : - null: aucune catégorie sélectionnée.- 2: visite de la page d’accueil : un utilisateur visite votre site web après avoir été servi d’une annonce.- 3: Vue d’élément : un utilisateur visite une page de votre site web qui affiche un ou plusieurs produits ou services.- 4: Ajouter au panier : un utilisateur ajoute un ou plusieurs de vos produits ou services à son panier d’achat.- 5: lancer l’extraction : un utilisateur commence le processus de validation.- 6: Ajouter des informations de paiement : un utilisateur ajoute des informations de paiement, telles qu’un numéro de carte de crédit, pendant le processus de validation.- 7: Achat - Une vente confirmée de votre produit ou service.- 8: générer un prospect : collectez des informations de prospect, telles que des adresses e-mail ou des codes postaux, auprès de personnes intéressées par votre entreprise. |
post_click_expire_mins |
int | Intervalle (en minutes) à partir du temps d’impression autorisé pour qu’une conversion de clic soit comptabilisée comme éligible. La valeur maximale est 129600 (90 jours). Si la 0 valeur est ou null, la fenêtre de recherche arrière maximale s’applique. |
post_click_value |
double | Valeur que vous attribuez à une conversion après un clic. |
post_view_expire_mins |
int | Intervalle (en minutes) à partir du temps d’impression autorisé pour qu’une conversion d’affichage soit comptabilisée comme éligible. La valeur maximale est 43200 (30 jours). Si la 0 valeur est ou null, la fenêtre de recherche arrière maximale s’applique. |
post_view_value |
double | Valeur que vous attribuez à une conversion après une vue. |
state |
enum | État du pixel. Valeurs possibles : "active" ou "inactive". |
trigger_type |
enum | Type d’événement requis pour une conversion valide (avec attributs). Valeurs possibles : view, clickou hybrid.Par défaut: click |
Campagnes
Ce tableau affiche les associations de campagne. Pour associer un pixel à une campagne, utilisez le service Campaign.
| Champ | Type | Description |
|---|---|---|
id |
string | ID de la campagne. En lecture seule. |
Éléments de ligne
Ce tableau affiche les associations d’éléments de ligne. Pour associer un pixel à un élément de ligne, utilisez le service d’élément de ligne.
| Champ | Type | Description |
|---|---|---|
id |
string | ID de l’élément de ligne. En lecture seule. |
name |
chaîne | Nom de l’élément de ligne. En lecture seule. |
state |
enum | État de l’élément de ligne. Valeurs possibles : "active" ou "inactive".En lecture seule. |
Pixels piggyback
Chaque objet du piggyback_pixels tableau contient les champs suivants.
Lorsque vous ajoutez des pixels piggyback, gardez à l’esprit les points suivants :
- Les pixels d’image peuvent uniquement se détacher d’autres pixels d’image, et les pixels JavaScript peuvent uniquement piggyback d’autres pixels JavaScript.
- Les pixels d’image ne peuvent avoir qu’un pixel piggyback. Si vous devez utiliser plusieurs pixels, veillez à utiliser un pixel JavaScript.
- Il n’existe aucune limite de caractères pour les pixels piggybackés dans AppNexus, mais des limites d’URL de navigateur/serveur peuvent s’appliquer.
| Champ | Type (longueur) | Description |
|---|---|---|
pixel_type |
enum | Type du pixel à piggyback. Valeurs possibles : "js" ou "img". |
url |
string (255) | URL du pixel à piggyback. |
Événement de conversion de pixels
| Champ | Type | Description |
|---|---|---|
id |
enum | ID de l’événement de conversion associé éventuellement à ce pixel. Les valeurs possibles sont des entiers compris entre 2 et 8, qui sont associés aux name valeurs ci-dessous.- null: aucune catégorie sélectionnée.- 2: LandingPage : un utilisateur visite votre site web après avoir été servi d’une annonce.- 3: ItemView : un utilisateur visite une page de votre site web qui affiche un ou plusieurs produits ou services.- 4: AddToCart : un utilisateur ajoute un ou plusieurs de vos produits ou services à son panier d’achat.- 5: InitiateCheckout : un utilisateur commence le processus de validation.- 6: AddPaymentInfo : un utilisateur ajoute des informations de paiement, telles qu’un numéro de carte de crédit, pendant le processus de paiement.- 7: Achat - Une vente confirmée de votre produit ou service.- 8: Prospect : collectez des informations de prospect, telles que des adresses e-mail ou des codes postaux, auprès de personnes intéressées par votre entreprise.En lecture seule. |
name |
enum | Nom de l’événement de conversion associé éventuellement à ce pixel. Les valeurs possibles sont associées aux id valeurs ci-dessus :- null: aucune catégorie sélectionnée.- 2: LandingPage : un utilisateur visite votre site web après avoir été servi d’une annonce.- 3: ItemView : un utilisateur visite une page de votre site web qui affiche un ou plusieurs produits ou services.- 4: AddToCart : un utilisateur ajoute un ou plusieurs de vos produits ou services à son panier d’achat.- 5: InitiateCheckout : un utilisateur commence le processus de validation.- 6: AddPaymentInfo : un utilisateur ajoute des informations de paiement, telles qu’un numéro de carte de crédit, pendant le processus de paiement.- 7: Achat - Une vente confirmée de votre produit ou service.- 8: Prospect : collectez des informations de prospect, telles que des adresses e-mail ou des codes postaux, auprès de personnes intéressées par votre entreprise.En lecture seule. |
Exemples
Ajouter un pixel de conversion pour l’annonceur 2
$ cat pixel
{
"pixel": {
"min_minutes_per_conv": 120,
"name": "ProStarr Post View Pixel 2",
"piggyback_pixels": [
{
"pixel_type": "img",
"url": "https://www.testing.com"
}
],
"post_view_expire_mins": 3600,
"post_view_value": 1,
"state": "active",
"trigger_type": "view"
}
}
$ curl -b cookies -c cookies -X POST -d @pixel 'https://api.appnexus.com/pixel?advertiser_id=2'
{
"response":{
"status":"OK",
"id":17
}
}
Afficher le pixel de conversion 17 pour l’annonceur 2
$ curl -b cookies -c cookies 'https://api.appnexus.com/pixel?id=17&advertiser_id=2'
{
"response": {
"status": "OK",
"pixels": [
{
"id": 17,
"code": null,
"name": "ProStarr Hybrid Pixel",
"state": "active",
"campaigns": [
{
"id": "17607"
}
],
"line_items": [
{
"id": 382,
"name": "Line Item",
"state": "active"
}
],
"trigger_type": "hybrid",
"min_minutes_per_conv": null,
"post_view_expire_mins": null,
"post_click_expire_mins": null,
"post_click_value": 10,
"post_view_value": 1,
"piggyback_pixels": [
{
"url": "https://www.testing.com",
"pixel_type": "img"
}
],
"created_on": "2010-01-01 19:24:20",
"last_modified": "2010-01-15 21:41:40",
"advertiser_id": 2
}
]
}
}
Afficher les pixels de conversion pour tous les annonceurs
Remarque
"advertiser_id" le champ indique l’annonceur auquel appartient le pixel.
$ curl -b cookies -c cookies -X POST -d @pixel 'https://api.appnexus.com/pixel'
{
"response": {
"status": "OK",
"pixels": [
{
"id": 5,
"code": null,
"name": "Sample Pixel 1",
"state": "active",
"campaigns": [
{
"id": "17883"
},
{
"id": "34091"
}
],
"line_items": [
{
"id": 67729,
"name": "5556",
"state": "active"
},
{
"id": 67734,
"name": "7017",
"state": "active"
},
{
"id": 67733,
"name": "8302",
"state": "active"
}
],
"trigger_type": "view",
"min_minutes_per_conv": 32767,
"post_view_expire_mins": 1440,
"post_click_expire_mins": null,
"post_click_value": null,
"post_view_value": 0,
"piggyback_pixels": [
{
"url": "https://test.com/test",
"pixel_type": "img"
}
],
"created_on": "2011-08-12 18:11:13",
"last_modified": "2011-09-12 19:55:21",
"advertiser_id": 8
},
{
"id": 6,
"code": null,
"name": "blargh2",
"state": "active",
"campaigns": [
{
"id": "17775"
},
{
"id": "17776"
}
],
"line_items": [
{
"id": 67895,
"name": "7082",
"state": "active"
},
{
"id": 67477,
"name": "3468",
"state": "active"
},
{
"id": 67679,
"name": "7870",
"state": "active"
}
],
"trigger_type": "click",
"min_minutes_per_conv": 1,
"post_view_expire_mins": null,
"post_click_expire_mins": 20160,
"post_click_value": 0,
"post_view_value": null,
"piggyback_pixels": null,
"created_on": "2011-05-07 18:11:13",
"last_modified": "2011-06-07 20:23:08",
"advertiser_id": 10
},
...
],
"count": 10,
"start_element": null,
"num_elements": null
}
}
Ajouter une catégorie d’événement de conversion à un pixel
Cet exemple ajoute le pixel de conversion 1017110 à la catégorie d’événement 3 (affichage d’un élément).
$ cat pixel-category
{
"pixel":
{"pixel_conversion_event_id": 3
}
}
$ curl -b cookies -c cookies -X PUT -s -d @pixel-category "https://api.appnexus.com/pixel?id=1017110&advertiser_id=57992"
{
"response": {
"count": 1,
"dbg_info": {
"output_term": "pixel",
"version": "1.18.651",
"warnings": []
},
"id": "1017110",
"num_elements": 100,
"pixel": {
"advertiser_id": 57992,
"campaigns": null,
"code": null,
"created_on": "2018-07-25 18:39:30",
"id": 1017110,
"last_modified": "2018-07-27 20:55:31",
"line_items": null,
"member_id": 1370,
"min_minutes_per_conv": 0,
"name": "Confirmation Page",
"piggyback_pixels": null,
"pixel_conversion_event": {
"id": 3,
"name": "ItemView"
},
"pixel_conversion_event_id": 3,
"post_click_expire_mins": 20160,
"post_click_value": null,
"post_view_expire_mins": 10080,
"post_view_value": null,
"state": "active",
"trigger_type": "hybrid"
},
"start_element": 0,
"status": "OK"
}
}