Service Pixel tiers

2025-04-02

Le service de pixels tiers vous permet de charger et de modifier des pixels créatifs tiers, et de les attacher à des annonceurs ou des créateurs. Vous pouvez également attacher des pixels créatifs tiers à votre membre.

API REST

HTTP, méthode	Endpoint	Description
`GET`	`https://api.appnexus.com/thirdparty-pixel`	Affichez tous vos pixels tiers.
`GET`	`https://api.appnexus.com/thirdparty-pixel?id=THIRDPARTY-PIXEL_ID`	Afficher un pixel tiers spécifique.
`POST`	`https://api.appnexus.com/thirdparty-pixel`	Ajoutez un nouveau pixel tiers.
`PUT`	`https://api.appnexus.com/thirdparty-pixel?id=THIRDPARTY-PIXEL_ID`	Modifier un pixel tiers existant.
`DELETE`	`https://api.appnexus.com/thirdparty-pixel?id=THIRDPARTY-PIXEL_ID`	Supprimer un pixel tiers existant.

Champs JSON

Champ	Type	Description
`active`	valeur booléenne	Indicateur indiquant si le pixel est actif. Par défaut : `true`
`adservers`	tableau d’objets	Serveurs adserver que le pixel appelle. Obligatoire pour les pixels qui servent sur l’inventaire Google Ad Manager. Une liste complète des serveurs d’annonces peut être récupérée à partir du service de serveur publicitaire. Exemple : `"adservers":[{"id":11},{"id":12}]`
`advertisers`	tableau d’objets	Si le pixel a un annonceur propriétaire (c’est-à-dire que `advertiser_id` n’est pas `null`), ce tableau doit contenir l’ID (et uniquement l’ID) de l’annonceur propriétaire du pixel. Par conséquent, ce pixel s’affiche sur toutes les créations détenues par cet annonceur. Si le pixel n’a pas d’annonceur propriétaire, ce tableau peut contenir plusieurs annonceurs auxquels le pixel sera appliqué. Exemple : `"advertisers":[{"id":3}]` Optional
`advertiser_id`	int	ID de l’annonceur propriétaire du pixel tiers. Par défaut : `null`
`audit_status`	string	Status d’audit du pixel. Les valeurs possibles sont les suivantes : - `"pending"` - `"rejected"` - `"approved"` - `"exempt"` Remarque : Un pixel non audité n’empêche pas un créatif de servir, mais il n’est pas utilisé avec le créatif tant qu’il n’a pas passé l’audit. En lecture seule Par défaut : `"pending"`
`content`	string	Si le pixel est `format"raw-js"`, il s’agit du contenu JavaScript à servir avec le créatif. Les `content` champs et/ou `secure_content` sont obligatoires pour `raw-jsPOST` les pixels. Vous pouvez également ajouter des macros à votre pixel. Pour obtenir la liste des macros créatives que vous pouvez ajouter à votre pixel, consultez Macros créatives dans la documentation de l’interface utilisateur . Obligatoire Sur : `POST` si le pixel est `format"raw-js"`.
`creatives`	tableau d’objets	Créations auxquelles un pixel est appliqué. Les créateurs doivent appartenir au membre/annonceur propriétaire. Pour attacher un pixel tiers à un créateur, utilisez le service Créatif. Exemple : `"creatives":[{"id":860851}]` En lecture seule
format	chaîne	Format du pixel. Valeurs possibles pour les créatifs : - `"raw-js"` - `"url-html"` - `"url-js"` - `"url-image"` - `"raw-url"` Obligatoire sur : `POST` et `PUT` si vous modifiez `content`les champs , `secure_contenturl`, ou `url_secure` . Par défaut : `"raw-js"`
`id`	int	ID du pixel tiers. Obligatoire sur : `PUT` et `DELETE`.
`members`	tableau d’objets	Facultatif. S’il est spécifié, ce champ contient l’ID du membre propriétaire du pixel et ce pixel s’affiche sur toutes les créations détenues par ce membre. Exemple : `"members":[{"id":1}]`
`member_id`	int	ID du membre/réseau propriétaire de ce pixel. Obligatoire sur : `POST`
`name`	chaîne	Nom du pixel tiers.
`secure_content`	string	Si le pixel est `format"raw-js"`, le contenu JavaScript à servir avec le créatif. Les `content` champs et/ou `secure_content` sont obligatoires pour `raw-jsPOST` les pixels. Vous pouvez également ajouter des macros à votre pixel. Pour obtenir la liste des macros créatives que vous pouvez ajouter à votre pixel ; Consultez Macros créatives dans la documentation de l’interface utilisateur. Obligatoire Sur : `POST` si le pixel est `format"raw-js"`.
`secure_url`	chaîne	Si le pixel est , , `"url-image"`ou `"raw-url"`, l’URL `format` du pixel HTML, JavaScript ou Image à servir avec le créatif sur un appel `"url-js"`sécurisé (https).`"url-html"` Les `url` champs et/ou `secure_url` sont obligatoires pour `POST` ces types de pixels. Vous pouvez également ajouter des macros à votre pixel. Vous pouvez également ajouter des macros à votre pixel. Pour obtenir la liste des macros créatives que vous pouvez ajouter à votre pixel, consultez Macros créatives dans la documentation de l’interface utilisateur. Obligatoire Sur : `POST` si le pixel `format` est `"url-html"`, `"url-js"`, `"url-image"`ou `"raw-url"`.
`supply_exceptions`	tableau d’objets	Noms des membres sur lesquels le pixel doit `not` servir. `"AdX"` est actuellement la seule valeur acceptable. Exemple : `"supply_exceptions":[{"name":"AdX"}]`
`url`	string	Si le pixel est , , `"url-image"`ou `"raw-url"`, l’URL `format` du pixel HTML, JavaScript ou Image à servir `"url-js"`avec le créatif.`"url-html"` Les `url` champs et/ou `secure_url` sont obligatoires pour `POST` ces types de pixels. Vous pouvez également ajouter des macros à votre pixel. Pour obtenir la liste des macros créatives que vous pouvez ajouter à votre pixel, consultez Macros créatives dans la documentation de l’interface utilisateur.

Exemples

Afficher un pixel tiers spécifique

Dans cet exemple, nous affichons un pixel tiers avec l’ID 123.

$ curl -b cookies -X GET 'https://api.appnexus.com/thirdparty-pixel?id=123'
 
{
    "thirdparty-pixel":{
        "id":123,
        "active":true,
        "member_id":456,
        "advertiser_id": 789,
        "format":"raw-js",
        "content":"var img = new Image(); img.src="https://url.com/event/js?self=" + data;"
        "url":null,
        "secure_url":null,
        "members":null,
        "advertisers":[{"id":789}], 
        "creatives":null
        "audit_status":"unaudited" // admin only
        "supply_exceptions":[
            {"name":"AdX"},
        ]
        "adservers":[
            {"id":123}
        ]
  }
}

Ajouter un nouveau pixel tiers

Dans cet exemple, nous créons un pixel tiers côté vente avec l’ID 123. Notez que les informations sur l’objet parent sont "null" dues au fait que le fichier JSON que nous avons transmis à l’API n’a pas spécifié d’objet parent pour le pixel.

$ cat thirdparty-pixel.json
{
  "thirdparty-pixel":
    {
      "format":"url-html",
      "secure_url":"https://secureurl.com"
    }
}  

$ curl -b cookies -c cookies -X POST -d @thirdparty_pixel 'https://api.appnexus.com/thirdparty-pixel'

{
    "response":{
        "status":"OK",
        "count":1,
        "id":123,
        "start_element":0,
        "num_elements":100,
        "thirdparty-pixel":{
            "id":123,
            "active":true,
            "name":null,
            "member_id":456,
            "advertiser_id":789,
            "publisher_id":null,
            "format":"url-html",
            "audit_status":"pending",
            "created_on":"2014-11-05 19:51:44",
            "last_modified":"2014-11-05 19:51:44",
            "url":null,
            "secure_url":"https://secureurl.com",
            "members":null,
            "advertisers":null,
            "publishers":null,
            "creatives":null,
            "supply_exceptions":null,
            "adservers":null
       
    }
}

Mettre à jour un pixel tiers

Dans cet exemple, nous mettons à jour un pixel tiers avec l’ID 123, en l’appliquant à tous les créateurs de l’annonceur propriétaire.

$ cat pixelupdate.json

{
  "thirdparty-pixel":
    {
      "advertisers":[{"id":789}]
    }
}  

$ curl -b cookies -c cookies -X PUT -d @pixelupdate 'https://api.appnexus.com/thirdparty-pixel?id=123'

{
   "response":{
      "status":"OK",
      "id":123
   }
}

Supprimer un pixel tiers

Dans cet exemple, nous supprimons un pixel tiers avec l’ID 123.

$ curl -b cookies -X DELETE 'https://api.appnexus.com/thirdparty-pixel?id=123'

{
   "response":{
      "status":"OK"
   }
}

Partager via