Partager via


API de plateforme numérique - Service créatif

Vous pouvez utiliser creative service pour ajouter des créations à notre système. Toutes les créations doivent être attachées à un annonceur ou à un éditeur.

  • Vous pouvez afficher votre ID d’annonceur en appelant le service annonceur.
  • Vous pouvez afficher votre ID d’éditeur en appelant le service serveur de publication.
  • Vous pouvez attacher un élément créatif à un éditeur pour l’utiliser en tant que création par défaut pour un placement. Vous devez ensuite attacher le créatif à un placement via son ID à l’aide du service de placement.

Remarque

Les services vidéo et audio hébergés et tiers sont uniquement accessibles à l’aide du creative vast service. Les créations HTML hébergées et tierces sont accessibles uniquement à l’aide du service CREATIVE HTML.

Audit

Xandr travaille avec des membres qui se soucient profondément de la marque et de la réputation. Pour cette raison, nous nous assurons que les publicités (créatives) qui passent par notre système sont acceptables par toutes les parties. Pour garantir la qualité, toutes les créations qui servent sur l’inventaire tiers doivent être préinscrites à l’aide du service Créatif.

  • Les créatifs sont identifiés par leur media_url (une URL de serveur adserver tiers ou une URL de réseau de distribution de contenu pour un fichier Flash, image ou vidéo).
  • Xandr vérifie régulièrement media_urls. Si un fichier disparaît, le créatif est traité comme non audité.
  • Une fois qu’un créatif a réussi l’audit de Xandr, certaines modifications apportées à la création entraînent son renvoi pour l’audit. Pour plus d’informations, consultez Modifications qui provoquent un ré audit ci-dessous .

API REST

HTTP, méthode Endpoint Description
POST https://api.appnexus.com/creative?advertiser_id=ADVERTISER_ID
(JSON créatif)
Ajoutez un nouveau créatif à l’un de vos annonceurs.
POST https://api.appnexus.com/creative?publisher_id=PUBLISHER_ID
(JSON créatif)
Ajoutez un nouveau créatif à l’un de vos éditeurs.
PUT - https://api.appnexus.com/creative?id=CREATIVE_ID& advertiser_id=ADVERTISER_ID
- https://api.appnexus.com/creative?id=CREATIVE_ID&p ublisher_id=PUBLISHER_ID
(JSON créatif)
Modifier un élément créatif existant.
GET https://api.appnexus.com/creative Afficher toutes les créations.
GET - https://api.appnexus.com/creative?advertiser_id=ADVERTISER_ID
- https://api.appnexus.com/creative?advertiser_code=ADVERTISER_CODE
- https://api.appnexus.com/creative?publisher_id=PUBLISHER_ID
- https://api.appnexus.com/creative?publisher_code=PUBLISHER_CODE
Afficher toutes les créations d’un annonceur ou d’un éditeur.

Remarque :
Vous pouvez filtrer les créations en fonction du moment où elles ont été servies pour la première et la dernière fois. Cela est particulièrement utile lorsque vous approchez de votre limite d’objets et que vous devez identifier les éléments créatifs qui peuvent être supprimés du système. Pour plus d’informations, consultez Première exécution/Dernière exécution ci-dessous.
GET - https://api.appnexus.com/creative?id=CREATIVE_ID
- https://api.appnexus.com/creative?code=CREATIVE_CODE
Afficher une création spécifique.
GET https://api.appnexus.com/creative?id=1,2,3 Affichez plusieurs créations par ID à l’aide d’une liste séparée par des virgules.
GET https://api.appnexus.com/creative?audit_stats=true Affichez les statistiques d’audit créatives.

Remarque :
La réponse vous indique le nombre de créations avec chaque status d’audit Xandr, Microsoft et Google. Pour connaître le format de réponse, consultez les exemples ci-dessous.
DELETE - https://api.appnexus.com/creative?id=CREATIVE_ID& advertiser_id=ADVERTISER_ID
- https://api.appnexus.com/creative?id=CREATIVE_ID&p ublisher_id=PUBLISHER_ID
Supprimer un élément créatif.

Note: Vous ne pouvez pas supprimer un élément créatif utilisé comme création par défaut pour un membre ou un placement. Les éléments créatifs par défaut peuvent être supprimés une fois qu’ils sont dissociés d’un placement.
GET https://api.appnexus.com/creative/meta Découvrez les champs que vous pouvez filtrer et trier.

Champs JSON

Champ Type Description
id int ID interne associé au créatif.
Par défaut: Nombre généré automatiquement.
Obligatoire On :PUT, dans la chaîne de requête.
code string (100) Code personnalisé pour le créatif. Remarque : Il est important que ce code soit unique.
code2 string (100) Code personnalisé supplémentaire pour le créatif. Remarque : Il est important que ce code soit unique.
name string (400) Nom du créatif.
type enum Type de créatif. Valeurs possibles :
- "standard"
"html"
- "video"

Remarque :
Avis alpha-bêta
Ce champ ou cette fonctionnalité fait partie de la fonctionnalité actuellement en phase Alpha ou Bêta. Il est donc susceptible d’être modifié.

En lecture seule.
advertiser_id int ID de l’annonceur auquel le créateur est attaché.
Obligatoire On :POST/PUT, dans la chaîne de requête, si le créatif est attaché à un annonceur.
political objet En lecture seule. Si ce créatif est « politique » et sert aux États-Unis, cet objet est rempli avec les éléments requis pour les créatifs politiques américains. Pour plus d’informations, consultez la description de l’objet Politique ci-dessous.
Par défaut:null
publisher_id int ID de l’achat de l’éditeur/média auquel le créatif est attaché.
Obligatoire On :POST/PUT, dans la chaîne de requête, si le créatif est attaché à un serveur de publication.
brand_id int ID de la marque de l’entreprise qui annonce le créatif. S’il est inclus, il sera vérifié par l’équipe d’audit Xandr. S’il n’est pas inclus, il est attribué par l’équipe d’audit. Pour récupérer la liste complète des marques, consultez Le service de marque.
state enum État du créatif. Valeurs possibles : "active" ou "inactive".
En lecture seule.
status objet Le status du créatif décrivant si le créatif est prêt à servir. Pour plus d’informations, consultez État ci-dessous.
click_track_result enum Résultat du test de suivi des clics, fonctionnalité disponible uniquement dans l’interface utilisateur. Valeurs possibles : "not_tested", "passed"ou "failed".
Par défaut:"not_tested"
campaigns tableau d’objets Liste des campagnes auxquelles le créatif est associé. Pour plus d’informations, consultez Campagnes ci-dessous.

Note: Ce champ est retourné uniquement si un advertiser_id est spécifié dans la chaîne de requête.
format enum Déconseillée.
template objet Modèle créatif (par exemple : template_id6) pour le format et le type de média du créatif (c’est-à-dire flash et extensible). Le modèle inclut du code pour contrôler la façon dont la création s’affiche sur les pages web. Pour plus d’informations, consultez Modèle créatif ci-dessous.

Note: Lors de l’utilisation d’un modèle pour le "raw-html" format (HTML qui ne sera pas servi dans un iFrame), tout ce qui se trouve dans le content champ doit être escaped (guillemets, barres obliques, etc.) et être encapsulé dans une document.write(); instruction. Cela est nécessaire pour remettre le contenu à la page.
Obligatoire sur :POST
thirdparty_page objet Note: Ce champ n’est plus utilisé.
custom_macros tableau d’objets Valeurs des macros personnalisées utilisées dans le modèle créatif. Pour plus d’informations, consultez Macros personnalisées ci-dessous.
Obligatoire :POST si le modèle inclut les macros personnalisées requises.
width Int Largeur du créatif ; la chaîne doit contenir un int.
Obligatoire Sur :POST, si le modèle est pour le "Banner" type de média ou "Expandable" .
height Int Obligatoire Sur :POST, si le modèle est pour le "Banner" type de média ou "Expandable" .
La hauteur du créatif ; la chaîne doit contenir un int. Si le modèle du créatif a un type de média pop, le height créatif doit être défini OU pop_window_maximize (dans le pop_values champ) doit être true (mais pas les deux).

Note: Vous pouvez uniquement envoyer des créations pop de tailles acceptées pour l’audit Xandr. Si media_subtype_id dans le tableau a la template valeur 4 (fenêtre contextuelle) et audit_status a la valeur "pending", height doit être défini sur 300 et width sur 720. Si media_subtype_id dans le template tableau est 2 (fenêtre contextuelle) et audit_status a la valeur "pending", width et height doit être l’une des suivantes : 250x250, 300x250, 550x480.
Obligatoire Sur :POST, si le modèle est pour le "Banner" type de média ou "Expandable" .
media_url string (1000) L’URL du créatif peut être image, flash, HTML, javascript (voir format). L’URL doit exister et doit se trouver sur un CDN ou un équivalent.
Obligatoire On :POST, si le contenu n’est pas utilisé.
media_url_secure string (1000) L’URL de l’élément créatif sécurisé (HTTPS) peut être image, flash, HTML, javascript (voir le format) à servir lors d’un appel publicitaire sécurisé. L’URL doit exister et doit se trouver sur un CDN ou un équivalent.
click_url string (2000) click_url est déconseillé en faveur de click_target.

Remarque :
Cette valeur doit commencer par « http:// » ou « https:// »
Obligatoire Sur :POST, si le modèle est pour le format « image ».
file_name string (1000) Nom de fichier et extension d’une création hébergée. Types de fichiers autorisés : jpg, gif, png, swf, svg, mp4, wmv, f4v, avi, m4v, mov et mpg.
Obligatoire Sur :POST, si vous ajoutez un créatif hébergé.
flash_click_variable string (255) Variable ClickTag dans une création Flash. Xandr peut exécuter et suivre les clics utilisateur sur une création Flash uniquement si vous fournissez la variable exacte dans le fichier (clickTAG, ClickTag, Clicktag, etc.). Vous pouvez utiliser le service ClickTags pour identifier cette variable. Si vous devez spécifier plusieurs variables ClickTag pour un seul élément créatif, contactez le support technique.

Note: Ce champ peut uniquement être mis à jour (via POST ou PUT) pour les créations Flash.
content string Contenu Javascript ou HTML quand "format" est "raw-js" ou "iframe-html". Pour une création hébergée, le contenu du fichier doit être codé en base64 et envoyé sous forme de chaîne dans le champ de contenu.

Pointe: Lorsque vous utilisez un modèle (exemple : template_id6) pour le "raw-html" format (HTML qui ne sera pas servi dans un iFrame), tout ce qui se trouve dans le content champ doit être escaped (guillemets, barres obliques, etc.) et être encapsulé dans une document.write(); instruction. Cela est nécessaire pour remettre le contenu à la page.

Pointe: La longueur maximale du champ de contenu est de 65535 caractères.
Obligatoire Sur :POST, si vous n’utilisez media_urlpas .
Par défaut : détenteur d’étiquettes tierces.
content_secure string Contenu Javascript ou HTML quand "format" est "raw-js" ou "iframe-html" servi sur un appel publicitaire sécurisé.
original_content string La valeur que vous transmettez au "content" champ via l’interface utilisateur sera retournée dans ce champ inchangée. Le "content" champ contient le contenu modifié par Xandr pour qu’il soit correctement utilisé. Ce champ peut également être chargé directement via l’API. Dans ce cas, la valeur chargée dans ce champ est référencée dans la section contenu de l’interface utilisateur (champ Creative Content > Tag).
Obligatoire sur :POST lors de l’envoi en tant que type raw-html.
original_content_secure string Voir original_content (en anglais). Il s’agit de la version sécurisée de ce contenu.
macros string L’API extrait les macros et les place dans ce champ afin que le soumissionnaire sache quelles macros attendre.
En lecture seule.
audit_status enum Audit status du créatif. Valeurs possibles : "no_audit", "pending", "rejected"ou "audited".

Remarque :
- Si allow_audit a la valeur false, ce champ doit être "no_audit".
- Si une création a expiré, vous pouvez la réactiver en modifiant ce champ. Si vous la définissez sur "pending" , vous la renvoyez à des fins d’audit. Le champ user_ready doit également définir sur true pour réactiver une création expirée. Pour les modifications qui resoumettent automatiquement le créatif à des fins d’audit, consultez Modifications qui provoquent un ré-audit ci-dessous .
- Vous pouvez uniquement envoyer des créations pop de tailles acceptées pour l’audit Xandr. Si media_subtype_id dans le template tableau est 4 (fenêtre contextuelle), audit_status ne peut pas être défini sur, "pending" sauf si width est 720 et height est 300. Si media_subtype_id dans le tableau a la template valeur 2 (fenêtre contextuelle), audit_status ne peut pas être défini sur en attente, sauf si width et height sont l’un des éléments suivants : 250x250, 300x250, 550x480.

Par défaut:"pending"
audit_feedback string L’équipe d’audit créatif peut transmettre des messages sur un créatif dans ce domaine.
En lecture seule.
allow_audit Valeur booléenne Si truela valeur est , la création est soumise à l’audit. Si falsela valeur est , le créatif n’est pas envoyé. Les créations non auditées ne peuvent s’exécuter que sur l’inventaire managé d’un réseau.

Remarque :
- Si audit_status a la valeur "no_audit", ce champ doit être "false".
- Si votre membre n’est pas encore actif, vous pouvez ajouter des éléments créatifs, mais ils ne seront pas soumis pour audit (allow_audit seront false). Une fois que votre membre a été activé, si vous souhaitez que ces éléments créatifs soient audités, vous devez mettre à jour les éléments créatifs et définir allow_audit sur true.
- Vous pouvez uniquement envoyer des créations pop de tailles acceptées pour l’audit Xandr. Si media_subtype_id dans le template tableau est 4 (fenêtre contextuelle), allow_audit ne peut pas être défini sur 1, sauf si width est 720 et height est 300. Si media_subtype_id dans le template tableau est 2 (fenêtre contextuelle), allow_audit ne peut pas être défini sur 1, sauf si width et height sont l’un des suivants : 250x250, 300x250, 550x480.

Par défaut:true
ssl_status enum Le status ssl (HTTPS) du créatif. Seuls les créatifs avec ssl_status = approuvé peuvent servir sur un inventaire sécurisé.

Remarque :
Si un créatif échoue à l’audit Ssl Sherlock, vous pouvez l’envoyer pour un nouveau test (une fois que vous avez corrigé le contenu non sécurisé en aval) en remplaçant ce champ "pending"par . Valeurs autorisées :
- "disabled"
- "pending"
- "approved"
- "failed"

Par défaut:"disabled"
allow_ssl_audit Valeur booléenne Si truela valeur est , le créatif est soumis à un audit sécurisé (HTTPS). Si falsela valeur est , le créatif n’est pas envoyé. Si true, media_url_secure ou content_secure est également requis.
Valeur par défaut :true, si media_url_secure ou content_secure est fourni. Sinon, false sera la valeur par défaut.
msft_audit_status enum Déconseillée.
msft_audit_feedback string Déconseillée.
facebook_audit_status enum Note: Ce champ n’est plus utilisé.
facebook_audit_feedback string Note: Ce champ n’est plus utilisé.
is_self_audited Valeur booléenne Si truela valeur est , la création est auto-auditée et ne passe donc pas par l’audit de la plateforme Xandr. Le créatif ne peut servir que sur l’inventaire qui accepte votre création auto-classifiée ou sur l’inventaire qui accepte les créatifs non audités.
Par défaut:false
is_expired Valeur booléenne Si votre création (1) n’a pas été exécutée et (2) n’a pas été modifiée dans les 45 jours, elle sera automatiquement marquée comme ayant expiré et ne sera servie sur aucun inventaire.
- Les créations expirées doivent être réinitditées pour s’exécuter sur un inventaire tiers. Pour annuler l’authentification d’un créatif pour l’inventaire tiers, définissez audit_status sur "pending".
- Les créations expirées n’ont pas besoin d’être rééditées pour s’exécuter sur un inventaire direct. Pour annuler l’exécution d’un élément créatif pour l’inventaire direct, définissez sur audit_status"no_audit".
Par défaut:false
En lecture seule.
is_prohibited Valeur booléenne Si Sherlock marque le créatif pour avoir un programme malveillant ou charger des domaines bloqués, cette valeur est définie sur true pour empêcher le contenu créatif de servir.
Par défaut:false
En lecture seule.
is_hosted Valeur booléenne Si truela valeur est , la création est hébergée par Xandr.
En lecture seule.
lifetime_budget double Le budget à vie en dollars.

Note: Pour inclure ce champ dans une GET réponse, transmettez attributes=1 la chaîne de requête.

Par défaut:unlimited
lifetime_budget_imps int Limite de durée de vie du nombre d’impressions.

Remarque :
Pour inclure ce champ dans une GET réponse, transmettez attributes=1 la chaîne de requête.
Par défaut:unlimited
daily_budget double Le budget quotidien en dollars.

Remarque :
Pour inclure ce champ dans une GET réponse, transmettez attributes=1 la chaîne de requête.
Par défaut:unlimited
daily_budget_imps int Limite quotidienne du nombre d’impressions.

Remarque :
Pour inclure ce champ dans une GET réponse, transmettez attributes=1 la chaîne de requête.
Par défaut:unlimited
enable_pacing Valeur booléenne Si truela valeur est , les dépenses budgétées quotidiennes sont réparties uniformément tout au long d’une journée.

Remarque :
Pour inclure ce champ dans une GET réponse, transmettez attributes=1 la chaîne de requête.
Par défaut:true
allow_safety_pacing Valeur booléenne Administration uniquement. Si truela valeur est , les dépenses par minute sont limitées à un maximum de 1 % du budget de durée de vie et de 5 % du budget quotidien.
profile_id int Vous pouvez attacher un ciblage tel que le sexe et la géographie à un créateur en créant un profil et en l’associant ici.
folder objet Pour organiser vos créations dans des dossiers par souci pratique (généralement dans l’interface utilisateur), vous allez créer un dossier à l’aide du service De dossiers créatifs , puis l’associer ici via l’ID de dossier ou dans le service Dossier créatif via l’ID créatif. La sortie est la suivante :
{"id": "41", "name": "MyFolder"}
line_items tableau d’objets Éléments de ligne associés au créatif. Pour plus d’informations, consultez Éléments de ligne ci-dessous.
pixels tableau d’objets Pixels à servir avec le créatif. Elles peuvent être destinées au suivi des impressions externes, au suivi des clics externes ou à d’autres fins, telles que l’ajout de l’icône AdChoices à un créatif. Pour plus d’informations, consultez Pixels ci-dessous.
pixel_url string (100) Déconseillé. Utilisez plutôt le tableau de pixels. URL d’un pixel d’impression à servir avec l’URL ou le contenu du média.
pixel_url_secure string (100) Déconseillé. Utilisez plutôt le tableau de pixels. URL d’un pixel d’impression sécurisé (HTTPS) à servir avec le contenu de l’URL multimédia lors d’un appel publicitaire sécurisé.
pixel_type enum Déconseillé. Utilisez plutôt le tableau de pixels. Type de pixel d’impression. Ce champ doit être défini si pixel_url est utilisé. Valeurs possibles : "javascript" ou "image".
no_iframes Valeur booléenne Déconseillé. Si truela valeur est , le soumissionnaire ne sert pas ce contenu créatif lorsqu’un iframe est détecté dans l’appel publicitaire.
Par défaut:false
track_clicks Valeur booléenne Déconseillée.
Par défaut:true
flash_backup_content string Pour une création flash, il s’agit du contenu de la création de sauvegarde qui sera servi si le navigateur d’un utilisateur ne prend pas en charge flash. Pour une vidéo dans une bannière créative, il s’agit du contenu de l’image d’affiche qui s’affiche avant que les utilisateurs cliquent sur lire et une fois la vidéo terminée. Ce champ doit être utilisé en combinaison avec flash_backup_file_name.
Une fois la création de sauvegarde chargée, le contenu est stocké sur le CDN et l’emplacement est défini dans le champ flash_backup_url. Ni flash_backup_content ni flash_backup_file_name ne peut être récupéré sur GET.
Obligatoire Sur :POST/PUT, si vous utilisez flash_backup_file_name.
En écriture seule.
flash_backup_file_name string Ce champ doit être utilisé en combinaison avec flash_backup_content. Il s’agit du nom de fichier et de l’extension de la création de sauvegarde.
Obligatoire Sur :POST/PUT, si vous utilisez flash_backup_content.
En écriture seule.
flash_backup_url string (100) Pour un flash créatif, il s’agit de l’URL d’un créatif tiers qui sera servi si le navigateur de l’utilisateur ne prend pas en charge flash. Pour une vidéo dans une bannière créative, il s’agit de l’URL de l’image d’affiche qui s’affiche avant que les utilisateurs cliquent sur Lire et une fois la lecture de la vidéo terminée.
is_control Valeur booléenne Il s’agit d’un indicateur utilisé pour marquer ce créatif dans le cadre d’un groupe de contrôle/test dans les tests A/B.
Par défaut:false
segments tableau Liste des segments auxquels un utilisateur sera ajouté lors de l’affichage ou du clic sur cette création. Pour plus d’informations, consultez Segments ci-dessous.
created_on Timestamp Date et heure de création de cette création. S’il a été créé avant janvier 2010, ce sera zéro.
En lecture seule.
last_activity Timestamp Date et heure de la dernière modification de la création. Le fuseau horaire est UTC.
En lecture seule.
media_subtypes tableau de chaînes Déconseillée.
creative_upload_status enum Déconseillée.
backup_upload_status enum Déconseillée.
use_dynamic_click_url Valeur booléenne Si truela valeur est , l’URL (facultative) de la page d’accueil pour l’image tierce et les créations flash est définie au niveau de la campagne ou de l’élément de ligne.
Par défaut:false
size_in_bytes int Taille d’un élément créatif chargé (en octets).
En lecture seule.
text_title string (25) Ligne supérieure de texte affichée dans un texte créatif.
Obligatoire On :POST, si le modèle est pour le "text" format.
text_description string (70) Ligne inférieure du texte affichée dans une création de texte.
Obligatoire On :POST, si le modèle est pour le "text" format.
text_display_url string (35) URL lisible affichée dans un texte créatif.
Obligatoire On :POST, si le modèle est pour le "text" format.
click_action enum Action que l’appareil doit effectuer lorsque l’utilisateur clique sur le créateur. Actuellement, ce champ est défini sur la seule action de clic prise en charge, "click-to-web".
Par défaut:"click-to-web"
click_target string (2000) Cible du click_action. Pour un clic sur le web, il s’agit click_url du créatif.
click_url sera finalement déprécié en faveur de ce champ. En attendant, la définition click_url ou click_target aura le même effet.
categories tableau d’objets Catégories qui décrivent le type de création et d’offre.
Remarque :
Pour inclure des catégories dans une GET réponse, transmettez attributes=1 la chaîne de requête. Pour récupérer la liste complète des catégories, consultez service de catégorie.
adservers tableau d’objets Les serveurs publicitaires qui fournissent le créatif ou sont appelés à des fins de collecte de données pendant la livraison du créatif.

Note: Pour inclure des serveurs adserver dans une GET réponse, transmettez attributes=1 la chaîne de requête. Pour récupérer la liste complète des serveurs publicitaires, consultez le service Ad Server.
En lecture seule.
technical_attributes tableau d’objets Attributs qui décrivent les caractéristiques techniques du créatif, tels que "Expandable" ou "Video".

Remarque :
Pour inclure des attributs techniques dans une GET réponse, transmettez attributes=1 la chaîne de requête. Pour récupérer la liste complète des attributs techniques, consultez le service d’attributs techniques.
language objet Le langage du créatif. Pour récupérer la liste complète des langues, consultez le service de langage.
brand objet La marque de l’entreprise qui annonce le créatif et la catégorie associée à la marque. Pour plus d’informations, consultez Marque ci-dessous.
En lecture seule.
pop_values tableau Déconseillée.
sla int Les créations définies sur 0 seront soumises pour audit avec un contrat SLA standard.

Attention: Les créations soumises avec un nombre autre que 0 entraînent un audit prioritaire (lorsqu’elles sont activées) et les frais qui en résultent.
Si vous avez un contrat de services supplémentaire avec Xandr pour les audits prioritaires, vous pouvez soumettre un élément créatif pour l’audit prioritaire (audit dans les 2 heures pendant les heures d’ouverture) en définissant ce champ sur 2.
sla_eta Timestamp Estimation de la durée d’exécution d’un audit prioritaire.
En lecture seule.
currency chaîne En lecture seule. Code qui définit la devise principale de l’annonceur (par exemple, USD). Pour plus d’informations sur les types de devises disponibles, consultez Service monétaire.
Par défaut: Devise par défaut du membre.
first_run Timestamp Date et heure auxquelles le créatif a été servi pour la première fois, actualisé toutes les heures. Cette valeur reflète le fuseau horaire UTC. Pour inclure ces informations dans une GET réponse, transmettez flight_info=true la chaîne de requête. Pour plus d’informations sur la façon de filtrer les éléments créatifs en fonction du moment où ils sont servis pour la première fois, voir Première exécution/Dernière exécution ci-dessous.
En lecture seule.
last_run Timestamp Date et heure de la dernière exécution de la création, actualisée toutes les heures. Cette valeur reflète le fuseau horaire UTC. Pour inclure ces informations dans une GET réponse, transmettez flight_info=true la chaîne de requête. Pour plus d’informations sur la façon de créer en fonction du moment où ils ont été servis pour la dernière fois, voir Première exécution/Dernière exécution ci-dessous.
En lecture seule.
mobile objet Informations nécessaires pour que les créatifs mobiles réussissent l’audit créatif. Voir Mobile ci-dessous.
video_attribute objet Attributs pour les créations tierces in-stream (VAST) et les vidéos hébergées.

Remarque :
Pour ajouter & mettre à jour de vastes créations, utilisez le /creative-vast service . Pour plus d’informations, consultez Creative Vast Service.
Par défaut:null
stats objet L’objet stats est déconseillé (depuis le 17 octobre 2016). Utilisez plutôt le service de rapports pour obtenir des informations statistiques.
content_source string Source du contenu de cette création.
Par défaut:"standard"
Valeurs autorisées :
- "standard": ce contenu créatif se compose de contenu hébergé sur un serveur publicitaire, qui est généralement récupéré avec une seule requête HTTP.
- "mediation": ce conteneur créatif est utilisé pour extraire du contenu d’un autre serveur publicitaire à des fins de médiation. En raison de la façon dont la médiation est effectuée, cela peut impliquer l’exécution de plusieurs requêtes HTTP dans l’ordre. Pour plus d’informations, consultez le service de modèle de demande personnalisée Creative.

Note: Si ce champ est défini sur "mediation", les actions suivantes se produisent :
- Un "mediation" attribut technique sera ajouté au tableau du technical_attributes créateur.
En outre, les validations suivantes seront effectuées :
- "audit_status" ne peut pas être défini sur "pending"; au lieu de cela, il sera toujours défini sur "no_audit".
- allow_audit ne peut pas être défini sur true; au lieu de cela, il sera toujours défini sur false.
- Le custom_request_template multi-objet doit être défini pour le créatif.
- Le custom_macros tableau doit être rempli avec des macros définies par les paramètres de modèle associés au modèle de demande personnalisée.
Les champs suivants ne seront plus nécessaires :
- content
- media_url
- template
custom_request_template multi-objet Si la valeur du champ de content_source ce créatif est définie sur "mediation", cet objet décrit l’association entre ce créatif et un modèle de demande personnalisé qui est utilisé pour remplir le créatif avec du contenu. Pour plus d’informations, consultez Modèle de requête personnalisé.
Par défaut:null
Obligatoire On :PUT, si content_source a la valeur "mediation".
competitive_brands tableau d’objets Les créatifs associés aux marques de ce tableau ne serviront pas ensemble aux /mtj enchères. L’exemple classique des marques concurrentes est Coke vs Pepsi. Voir Les marques concurrentielles ci-dessous. Pour plus d’informations sur les marques de notre système, consultez service de marque.
competitive_categories tableau d’objets Les créatifs associés aux catégories de ce tableau ne seront pas mis en /mtj vente aux enchères, par exemple, « Rencontre » et « Éducation ». Voir Catégories concurrentielles ci-dessous. Pour plus d’informations sur les catégories que nous appliquons aux créatifs (et aux marques), consultez service de catégorie.
thirdparty_pixels tableau d’objets Tableau de pixels tiers associés au créatif. Vous pouvez attacher automatiquement ces pixels à toutes les créations détenues par un annonceur ou un membre à l’aide du service Pixel tiers ou les attacher individuellement au niveau créatif à l’aide du service créatif.
Par défaut:null
Obligatoire sur :PUT
native objet Déconseillé. Si cette création est une publicité native, cet objet est rempli avec les éléments requis pour les publicités natives. Pour plus d’informations, consultez la description de l’objet Native ci-dessous.
Par défaut:null
Obligatoire sur :POST et PUT pour les publicités natives. Techniquement, les publicités natives sont identifiées par notre système comme les créatifs qui ont un template avec un creative_format_id qui 12 les identifie comme native.
native_attribute objet Il s’agit du nouvel objet natif qui contient les éléments requis pour les publicités natives. Pour plus d’informations, consultez la description de l’objet Attribut natif ci-dessous.
Par défaut:null
Obligatoire sur : Obligatoire pour la publicité native avec le modèle 39461.
click_trackers tableau d’objets Liste des URL de suivi des clics tierces destinées à être utilisées avec des créations natives. Pour plus d’informations, consultez Click Trackers ci-dessous.
impression_trackers tableau d’objets Liste des URL de suivi des impressions tierces destinées à être utilisées avec des créations natives. Pour plus d’informations, consultez Suivis d’impression ci-dessous.
adx_audit objet Cet objet contient des informations sur les status et les commentaires relatifs à l’audit Google AdExchange de la création. Les informations indiquant si une création a été approuvée ou non sont retournées dans le audit_status champ.
En lecture seule.
flash_backup_url_secure chaîne Il s’agit de la version sécurisée de flash_backup_url, qui est servie lors d’un appel publicitaire sécurisé.
msft_external_audit_feedback string Déconseillée.
msft_external_audit_status enum Déconseillée.
member_id int ID du membre propriétaire du créatif.
media_assets tableau d’objets ID de la ressource du fichier d’origine et champ décrivant à quoi doit servir la ressource. Il est utilisé pour associer des fichiers hébergés par Xandr à votre création. Ce tableau est renseigné automatiquement lors du chargement des fichiers via l’API. Pour plus d’informations, consultez Ressources multimédias ci-dessous.
ad_type chaîne Pointe: Ce champ s’applique uniquement lorsque vous associez des éléments créatifs à des éléments de ligne augmentée.
Type de création utilisé. Valeurs possibles :
- banner
- video (inclut les types audio)
- native
Cette valeur détermine la façon dont les articles aux enchères sont suivis pour la stratégie d’achat, la stratégie de paiement, les options d’optimisation, l’association créative et les options de ciblage de l’article.

Note: Toutes les créations associées à un élément de ligne doivent avoir le même type d’annonce, qui doit correspondre au ad_type sélectionné dans le service d’élément de ligne - ALI.

Marque

L’objet brand contient les champs suivants.

Remarque

Cet objet est en lecture seule. Pour définir la marque d’un créatif, utilisez le brand_id champ en dehors de cet objet.

Champ Type Description
id int ID de la marque de l’entreprise qui annonce le créatif.
En lecture seule.
name string Nom de la marque de la société qui annonce le créatif.
En lecture seule.
category_id int ID de la catégorie associée à la marque.
En lecture seule.
category_name string Nom de la catégorie associée à la marque.

Remarque :
Le champ category_name est retourné uniquement lorsque vous transmettez show_category_name=true la chaîne de requête de votre appel.
En lecture seule.

Campagnes

Chaque objet du campaigns tableau inclut les champs suivants. Pour obtenir des informations sur "id" les champs ou "code" , vous pouvez utiliser le service Campaign.

Champ Type (Longueur) Description
id int ID de la campagne. ou "id""code" est requis lors de la mise à jour de l’association de campagne.
Obligatoire sur :PUT
campaign_id int ID de la campagne.
creative_id int ID du créatif.
name chaîne Nom de la campagne.
En lecture seule.
state enum État de la campagne. Valeurs possibles : "active", "inactive"ou "parent_inactive".
En lecture seule.
code chaîne Code personnalisé pour la campagne. ou "id""code" est requis lors de la mise à jour de l’association d’éléments de ligne.
Obligatoire sur :PUT

Marques concurrentielles

Remarque

Pour plus d’informations sur les marques, consultez Service de marque.

Nom Type Description
id int ID de la marque.
name chaîne Nom de la marque.

Catégories concurrentielles

Remarque

Pour plus d’informations sur les catégories, consultez service de catégorie.

Nom Type Description
id int ID de la catégorie.
name chaîne Nom de la catégorie.

Modèle créatif

Vous pouvez utiliser le service de modèles créatifs pour afficher tous les modèles de rendu qui peuvent être affectés à des éléments créatifs.

Champ Type Description
id int ID du modèle créatif.
name chaîne Nom du modèle créatif.
En lecture seule.
media_subtype_id int ID du sous-type de média affecté au modèle. Vous pouvez utiliser le service De sous-type multimédia pour afficher tous les sous-types multimédias pris en charge.
En lecture seule.
format_id chaîne Nom du format affecté au modèle. Vous pouvez utiliser creative format service pour afficher tous les formats pris en charge.
En lecture seule.

Modèles créatifs fréquemment utilisés

Pour plus d’informations, consultez Sélection du modèle correct pour votre création.

ID de modèle Type de création Configuration requise
1 URL unique qui pointe vers un morceau de code HTML. Vous devez passer l’URL dans le media_url champ et définir un ID de 1 dans l’objet modèle.
2 URL unique qui pointe vers un morceau de code Javascript. Vous devez passer l’URL dans le media_url champ et définir un ID de 2 dans l’objet de modèle.
5 Créatif qui commence et se termine par des composants Javascript, même si le code Javascript écrit du code HTML. Vous devez passer le code Javascript dans le content champ et définir un ID de 5 dans l’objet modèle.
6 Créatif qui commence et se termine par des composants HTML, même si ces composants HTML sont <script> des balises. Vous devez passer le code html dans le content champ et définir un ID de 6 dans l’objet modèle.

Macros personnalisées

Si le modèle créatif fournit des valeurs par défaut pour une macro, la transmission des codes et des valeurs ici est facultative. Toutefois, si le modèle définit une macro personnalisée comme nécessaire, vous devez transmettre le code et la valeur de la macro.

Champ Type Description
code string Nom exact de la macro, tel qu’il est utilisé dans le code du modèle créatif, par exemple . "BORDER_COLOR"
value string Valeur de la macro.
Note: Cette valeur doit correspondre au type de la macro, tel que défini dans le modèle.
Par exemple, si une macro est de type « integer », la valeur doit être un entier. Les types de macros possibles sont "true/false", "string", "integer""url", , "decimal"et "select_from_list".

Pour plus d’informations, consultez l’exemple Ajout d’un élément créatif qui utilise un modèle de rendu personnalisé dans les exemples ci-dessous.

Modèle de requête personnalisé

Champ Type Description
id int Modèle de demande personnalisée de création associé à ce créatif, si son content_source est défini sur "mediation". Pour plus d’informations, consultez le service de modèle de demande personnalisée Creative.
timeout_ms int S’il s’agit d’un créatif de « médiation », il effectue au moins une requête HTTP à un serveur publicitaire externe, qui peut à son tour effectuer une ou plusieurs requêtes supplémentaires. C’est le temps au-delà duquel nous n’attendrons plus que cette création soit remplie de contenu. Pour plus d’informations, consultez le service de modèle de demande personnalisée Creative.
last_activity Timestamp Date et heure de la dernière modification de la création. Le fuseau horaire est UTC. En lecture seule.

Éléments de ligne

Chaque objet du line_items tableau inclut les champs suivants. Pour obtenir des informations pour "id" les champs ou "code" , vous pouvez utiliser le service d’élément de ligne.

Champ Type (Longueur) Description
name string Nom de l’élément de ligne.
En lecture seule.
state enum État du créatif. Valeurs possibles : "active" ou "inactive".
En lecture seule.
id int ID de l’élément de ligne. ou "id""code" est requis lors de la mise à jour de l’association d’éléments de ligne.
Obligatoire sur :PUT
code chaîne Code personnalisé pour l’élément de ligne. ou "id""code" est requis lors de la mise à jour de l’association d’éléments de ligne.
Obligatoire sur :PUT

Ressources multimédias

Le media_assets tableau d’objets contient les champs suivants :

Champ Type Description
media_asset_id int ID unique de la ressource créative.
creative_field chaîne Ce champ indique ce pour quoi cette ressource créative particulière doit être utilisée. Les valeurs valides possibles sont les suivantes :
- null (si la ressource est VAST ou HTML5)
- media_url
- flash_backup_url
- native_icon_img_url
- native_main_media
- macro_CODE_FOR_MACRO: ceci est généré dynamiquement en fonction des macros du modèle sélectionné.

Pour chaque media_assets tableau, les règles suivantes s’appliquent :

  • Chaque valeur de champ ne peut être utilisée qu’une seule fois par création. Par exemple, vous ne pouvez pas avoir deux ressources « flash_backup_url ».
  • La valeur doit être l’une des valeurs valides.
  • Les créatifs VAST/HTML5 doivent avoir une seule ressource.
  • Tous les autres éléments créatifs peuvent avoir 0 ou plus de ressources multimédias.

Ressources multimédias : exemple

"media_assets": [
    {
        "media_asset_id": 22,
        "creative_field": "media_url"
    }, 
    {
        "media_asset_id": 23,
        "creative_field": "flash_backup_url"
    }
]

Mobile

Champ Type Description
alternative_landing_page_url string Autre URL de page d’accueil qui peut être consultée dans un navigateur de bureau pour les créatifs qui ont une page d’accueil ciblée sur un appareil, un système d’exploitation ou un opérateur spécifique. Vous devez fournir une URL pouvant être auditable pour que votre créativité réussisse l’audit.

Attribut natif

L’objet native_attribute contient les champs suivants. Pour plus d’informations, consultez Ajout d’un créatif natif dans les exemples ci-dessous.

Champ Type Description
link objet URL associées à la création native. Pour plus d’informations, voir Lien ci-dessous.
image_trackers tableau d’objets Liste des URL de suivi des impressions tierces destinées à être utilisées avec des créations natives.
javascript_trackers tableau d’objets Liste d’URL de suivi d’impression tierces.
data_assets tableau d’objets Attributs de la création native. Pour plus d’informations, consultez Ressource de données ci-dessous.
image_assets tableau d’objets Attributs de chaque image individuelle. Pour plus d’informations, consultez Ressource d’image ci-dessous.
privacy_url chaîne Si la prise en charge a été indiquée dans la demande, l’URL d’une page informant l’utilisateur de l’activité de ciblage de l’acheteur. Xandr ne fournit pas de lien de confidentialité par défaut.
video_assets tableau d’objets Liste d’objets video_asset. Pour plus d’informations, consultez Ressources vidéo ci-dessous.

L’objet link contient l’URL de la page d’accueil, l’URL de secours et les trackers associés à la création native. L’objet link est requis pour l’attribut natif.

L’objet link inclut les champs suivants :

Champ Type Description
url string Page d’accueil de la création native.
Obligatoire sur :PUT, POST
fallback_url string URL de sauvegarde si l’URL de lien profond main n’est pas prise en charge.
trackers tableau d’objets Liste des URL de suivi tierces destinées à être utilisées avec des créations natives.

Par défaut, toutes les créations natives sont soumises pour l’audit sécurisé.

  • Si l’URL sécurisée n’a pas été spécifiée pour un dispositif de suivi (suivis d’images, suivis javascript et suivis de ressources d’image créative), l’audit sécurisé est désactivé pour cette création.
  • Si l’URL sécurisée n’a pas été spécifiée, mais que l’URL est précédée httpsde , le créatif est soumis à un audit sécurisé.

L’objet link_tracker inclut les champs suivants :

Champ Type Description
url string URL de suivi tierce.
url_secure string (facultatif) URL de suivi tierce sécurisée.

Suivi d’image

L’objet image_tracker inclut les champs suivants :

Nom Type Description
url string URL de suivi d’impression tierce.
url_secure chaîne URL de suivi d’impression tierce (qui utilise SSL).

Traceur Javascript

L’objet javascript_tracker inclut les champs suivants :

Nom Type Description
url string URL de suivi Javascript tierce.
url_secure chaîne URL de suivi Javascript tierce (qui utilise SSL).

Ressource de données

Chaque data_asset représente un composant de texte de la création native. L’objet data_assets inclut les champs suivants :

Champ Type Description
data_type string Type de ressource pour la création native. Valeurs possibles :
- title
- description
- sponsored_by
- call_to_action
- display_url
- price
- sale_price
- rating
- likes
- downloads
- phone
- address
- additional_description
- custom_title_1 - custom_title_5
- custom_body_1 - custom_body_5
- custom_call_to_action_1 - custom_call_to_action_5
- custom_social_url_1 - custom_social_url_5
- custom_display_url_1 - custom_display_url_5

La data_type chaîne doit comporter des guillemets doubles.
value string Contenu de la data_type ressource que vous avez spécifiée. Les valeurs admises sont les suivantes :
- title: titre du créatif.
- description: description du produit ou du service en cours de publicité.
- sponsored_by: nom de marque du sponsor.
- call_to_action: action suggérée pour l’étape suivante.
- display_url: URL que vous souhaitez afficher.
- price: prix de l’achat du produit/de l’application/dans l’application.
- sale_price: prix de vente qui peut être utilisé avec le prix pour indiquer un prix réduit.
- rating: évaluation du produit proposé.
- likes: J’aime sur les réseaux sociaux.
- downloads: nombre de téléchargements/installations de ce produit.
- phone: numéro de téléphone.
- address:Adresse.
- additional_description: version plus longue de la description de votre annonce.
- custom_title_1 - custom_title_5: titres supplémentaires qui apparaîtront sur la création native.
- custom_body_1 - custom_body_5: corps de texte supplémentaire qui apparaîtra sur la création native.
- custom_call_to_action_1 - custom_call_to_action_5: appels à l’action supplémentaires qui encouragent l’utilisateur à prendre les mesures nécessaires après avoir consulté la création native (par exemple, la signature de la liste de diffusion).
- custom_social_url_1 - custom_social_url_5: URL de réseaux sociaux qui amèneront l’utilisateur aux plateformes de réseaux sociaux correspondantes.
- custom_display_url_1 - custom_display_url_5: URL publiques supplémentaires qui peuvent être visibles et/ou rediriger automatiquement l’utilisateur vers une page web connectée au domaine de la page d’accueil.

La value chaîne doit comporter des guillemets doubles.

Ressource d’image

Chaque image_asset représente un composant d’image de la création native. L’objet image_asset inclut les champs suivants :

Champ Type Description
image_type string Format de l’image. Les valeurs admises sont les suivantes :
- main_image: image principale qui s’affiche lorsque la création native est rendue.
- icon_image: icône principale qui s’affiche lors du rendu de la création native.
- custom_image_1 - custom_image_5: images supplémentaires qui s’affichent lors du rendu de la création native.
- custom_icon_1 - custom_Icon_5: icônes supplémentaires qui s’affichent lors du rendu de la création native.
- custom_social_icon_1 - custom_social_icon_5: icônes de réseaux sociaux correspondantes qui s’affichent lors du rendu de la création native.
media_asset_id int ID de la ressource multimédia. Obligatoire pour les créations natives hébergées.
Si media_asset_id peut être récupéré, l’objet creative_asset_image est rempli automatiquement.
creative_asset_image objet Objet contenant les détails de la ressource créative. Requis pour les créations natives tierces. Pour plus d’informations, consultez Image de ressource créative ci-dessous.
image_resize_setting objet Objet contenant les paramètres de redimensionnement de l’image. Pour plus d’informations, consultez Paramètre de redimensionnement d’image ci-dessous.

Image de ressource créative

L’objet creative_asset_image inclut les champs suivants :

Champ Type Description
url string URL de la page d’accueil de l’image.
url_secure string URL de la page d’accueil sécurisée de l’image.
width int Largeur de l'image. La valeur doit être > 0.
height int Hauteur de l'image. La valeur doit être > 0.

Paramètre de redimensionnement d’image

L’objet image_resize_setting inclut les champs suivants :

Champ Type Description
resize_enabled valeur booléenne Indique si le créatif doit être redimensionné. Les valeurs admises sont les suivantes :
- True
- False
crop_enabled valeur booléenne Indique si le créatif doit être rogné pour le placement de remplissage. Les valeurs admises sont les suivantes :
- True
- False
aspect_ratio_upper_bound double Proportions maximales autorisées pour le créatif.
aspect_ratio_lower_bound double Proportion minimale autorisée pour le créatif.
max_scale_factor double Valeur maximale que la largeur et la hauteur du créatif peuvent être mises à l’échelle.

Ressource vidéo

Chacun video_asset représente un composant vidéo de la création native. L’objet video_asset inclut les champs suivants :

Champ Type Description
media_asset_id int ID de la ressource multimédia vidéo hébergée.
Obligatoire sur :PUT, POST
vast_url chaîne URL d’un document VAST. Doit être sécurisé.
Obligatoire sur :PUT, POST
trackers tableau Suivis d’événements VAST facultatifs.
media_files tableau Tableau de fichiers multimédias disponibles. Pour plus d’informations, consultez Fichier multimédia.
En lecture seule.
duration int Durée (en millisecondes) de la vidéo extraite d’une ressource multimédia vidéo ou d’un document VAST.
En lecture seule.
minimum_vast_version chaîne Version MINIMALE DE VAST requise pour lire la vidéo. Valeurs possibles :
- 2.0
- 3.0
- 4.0
En lecture seule.

Un seul de { media_asset_id , vast_url } doit être rempli par demande.

Vaste dispositif de suivi

L’objet vast_tracker inclut les champs suivants :

Champ Type Description
vast_event_type string Type d’événement de suivi. Les valeurs admises sont les suivantes :
- service
- start
- skip
- error
- first_quartile
- completion
- impression
- click
url string URL d’un document VAST. Doit être sécurisé.

Fichier multimédia

L’objet media_file inclut les champs suivants :

Champ Type Description
bitrate_kbps int Vitesse de transmission du fichier multimédia.
mime_type chaîne Type MIME du fichier multimédia.
width int Largeur du fichier multimédia.
height int Hauteur du fichier multimédia.

Natif

Objet native utilisé pour contenir les champs suivants, qui ont tous été dépréciés.

Champ Type Description
title text Déconseillée.
description text Déconseillée.
full_text text Déconseillée.
context chaîne Déconseillée.
icon_img_url chaîne Déconseillée.
main_media tableau d’objets Déconseillée.
sponsored string Déconseillée.
cta string Déconseillée.
rating objet Déconseillée.
click_url string Déconseillée.
click_fallback_url string Déconseillée.
custom_key_values tableau d’objets Déconseillée.

Média principal

Nom Type Description
width int Déconseillée.
height int Déconseillée.
media_url string Déconseillée.
media_url_secure chaîne Déconseillée.

Remarque

Il ne peut y avoir qu’un main_media seul objet associé à un créateur natif.

Valeurs de clé personnalisées

Nom Type Description
custom_key string Déconseillée.
custom_value string Déconseillée.

Suivis de clic

Nom Type Description
click_tracker_url string Déconseillée.

Suivis d’impression

Nom Type Description
impression_tracker_url string Déconseillée.
impression_tracker_url_secure string Déconseillée.

Pixels

Vous utilisez ce tableau pour ajouter des pixels personnalisés et approuvés par Xandr à un créatif. Vous pouvez ajouter jusqu’à cinq pixels pour un créatif.

Les pixels approuvés par Xandr proviennent de fournisseurs approuvés et couramment utilisés. La plupart d’entre eux n’entraînent pas la soumission de la création à des fins d’audit. Pour ajouter un pixel approuvé par Xandr à un créateur, vous devez transmettre uniquement les pixel_template_id et le nombre de paramètres requis par le pixel. Pour obtenir des conseils supplémentaires, consultez l’exemple d’ajout d’un pixel approuvé par Xandr à un exemple créatif dans Exemples ci-dessous.

Remarque

Vous pouvez utiliser le service de modèle de pixels pour obtenir des informations sur ces pixels, notamment s’ils déclenchent ou non un audit.

Les pixels personnalisés sont définis par vous et entraînent la soumission de la création à des fins d’audit. Pour ajouter un pixel personnalisé, vous devez transmettre uniquement le format et, selon le format, le contenu ou l’URL. Pour obtenir des conseils supplémentaires, consultez l’exemple Ajout d’un pixel personnalisé à un élément créatif dans les exemples ci-dessous.

Attention

Lorsque vous effectuez un PUT appel pour mettre à jour le tableau de pixels, le tableau est complètement remplacé par les informations contenues dans le fichier au format JSON. Par conséquent, si le tableau comprend déjà des pixels, veillez à inclure ces pixels également dans le fichier au format JSON.

Champ Type Description
id int ID attribué par Xandr du tableau de pixels. Vous associerez des pixels via les pixel_template_idchamps , contentou URL répertoriés ci-dessous.
En lecture seule.
pixel_template_id int ID du pixel approuvé par Xandr. Vous pouvez utiliser le service de modèle de pixels pour obtenir cet ID.
param_1 chaîne Pour le pixel approuvé par Xandr : valeur du premier paramètre dans le contenu ou l’URL du pixel. Pour déterminer le nombre de paramètres requis pour un pixel approuvé par Xandr, utilisez le service de modèle de pixels.
param_2 chaîne Pour le pixel approuvé par Xandr : valeur du deuxième paramètre dans le contenu ou l’URL du pixel.
param_3 chaîne Pour le pixel approuvé par Xandr : valeur du troisième paramètre dans le contenu ou l’URL du pixel.
param_4 chaîne Pour le pixel approuvé par Xandr : valeur du quatrième paramètre dans le contenu ou l’URL du pixel.
param_5 string Pour le pixel approuvé par Xandr : valeur du cinquième paramètre dans le contenu ou l’URL du pixel.
format enum Format du pixel. Valeurs possibles : "raw-js", "url-html", "url-js"ou "url-image".
content string (255) Si le format de pixel est "raw-js", le contenu HTML ou JavaScript à servir avec le créatif.
secure_content string (255) Si le format de pixel est "raw-js", le contenu HTML ou JavaScript à fournir avec le créatif sur un appel publicitaire sécurisé (HTTPS).
url string (255) Si le format de pixel est "url-html", "url-js", "url-image"ou "raw-url", l’URL du pixel HTML, JavaScript ou Image à servir avec le créatif.
secure_url string (255) Si le format de pixel est "url-html", "url-js", "url-image"ou "raw-url", l’URL du pixel HTML, JavaScript ou Image à servir avec le créatif sur un appel sécurisé (HTTPS).

Politique

Objet "political" utilisé pour contenir les champs suivants :

Champ Type Description
in_scope valeur booléenne Détermine si le créativité politique des États-Unis est dans l’étendue d’être réglementé. Si oui, toutes les informations politiques requises sur l’acheteur doivent être fournies au niveau de l’insertion. Pour plus d’informations, consultez la documentation Create une commande d’insertion via notre interface utilisateur (une connexion est requise).

Valeurs contextuelles

Remarque

Les pop_values champs sont déconseillés et ignorés/non utilisés par nos systèmes.

Ces champs doivent être inclus dans un "pop_values" tableau dans le json créatif. Pour obtenir un exemple, voir ci-dessous.

Champ Type (Longueur) Description
pop_window_maximize Boolean Si la valeur est true, la balise de l’éditeur doit agrandir la fenêtre. Uniquement pertinent pour les créations au format "url-html" et "url-js". Si pop_window_maximize a la truevaleur , ni ne "height""width" doit être défini sur le créatif.
Par défaut:false
pop_is_tag_initiated Valeur booléenne Si truela valeur est , la balise du créateur lance la fenêtre contextuelle. Si falsela valeur est , le bus d’impression lance la fenêtre contextuelle.
Par défaut:false
pop_window_title string (255) Titre de la fenêtre éclatée. S’applique uniquement aux fenêtres avec pop_is_tag_initiated la valeur définie sur false. Il n’est pas garanti qu’il soit pris en charge dans tous les navigateurs.
Par défaut:Network name
pop_statusbar Valeur booléenne Si truela valeur est , une barre de status s’affiche dans la fenêtre contextuelle. S’applique uniquement aux fenêtres avec pop_is_tag_initiated la valeur définie sur false. Il n’est pas garanti qu’il soit pris en charge dans tous les navigateurs.
Par défaut:true
pop_menubar Valeur booléenne Si truela valeur est , une barre de menus s’affiche dans la fenêtre contextuelle. S’applique uniquement aux fenêtres avec pop_is_tag_initiated la valeur définie sur false. Il n’est pas garanti qu’il soit pris en charge dans tous les navigateurs.
Par défaut:true
pop_resizable Valeur booléenne Si truela valeur est , la fenêtre contextuelle est redimensionnable. S’applique uniquement aux pops avec pop_is_tag_initiated défini sur false. Il n’est pas garanti qu’il soit pris en charge dans tous les navigateurs.
Par défaut:true
pop_scrollbars Valeur booléenne Si la valeur est true, les barres de défilement sont affichées dans la fenêtre contextuelle. S’applique uniquement aux fenêtres avec pop_is_tag_initiated la valeur définie sur false. Il n’est pas garanti qu’il soit pris en charge dans tous les navigateurs.
Par défaut:true
pop_toolbar Valeur booléenne Si truela valeur est , une barre d’outils s’affiche dans la fenêtre contextuelle. S’applique uniquement aux fenêtres avec pop_is_tag_initiated la valeur définie sur false. Il n’est pas garanti qu’il soit pris en charge dans tous les navigateurs.
Par défaut:true
pop_addressbar Valeur booléenne Si truela valeur est , une barre d’adresse s’affiche dans la fenêtre contextuelle. S’applique uniquement aux fenêtres avec pop_is_tag_initiated la valeur définie sur false. Il n’est pas garanti qu’il soit pris en charge dans tous les navigateurs.
Par défaut:true

Segments

Ces champs seront inclus dans le tableau Segments :

Champ Type Description
id int ID du segment.
Obligatoire sur :POST, PUT
segment_id int ID du segment. Ce champ contient les mêmes informations que le id champ .
action enum Action effectuée par les utilisateurs qui les ajouteront au segment. Valeurs possibles : "add on view" ou "add on click".
Obligatoire sur :POST, PUT
name string Nom du segment.

État

Nom Type Description
user_ready valeur booléenne La status de l’ensemble créatif par l’utilisateur qui décrit si le créatif est prêt à être utilisé ou non. Valeurs possibles : "true" ou "false". La valeur de user_ready doit être true pour réactiver une création expirée avec son audit_status.
Par défaut:true
hosted_assets_association_complete booléen/null État de la création chargée par les systèmes internes de Xandr. Valeurs possibles : "true" ou "false" pour les créations hébergées et « null » pour les créations tierces.
En lecture seule.

Pixels tiers

Le thirdparty_pixels tableau contient les champs du tableau ci-dessous. Ces champs, à l’exception de id, sont en lecture seule. Utilisez ce service pour mettre à jour le id d’un pixel tiers ou attacher des pixels tiers à des créations individuelles.

Champ Type Description
id int ID du pixel.
Obligatoire sur :PUT
name chaîne Nom complet du pixel.
En lecture seule.
active Valeur booléenne La status actuelle du pixel (true = actif).
En lecture seule.
audit_status string Auditer status du pixel.
En lecture seule.

Remarque

Pour mettre à jour ou créer un pixel tiers et/ou attacher des pixels tiers à toutes les créations appartenant à l’annonceur ou au membre du réseau, utilisez le service Pixel tiers.

Première exécution/dernière exécution

Pour inclure les first_run champs et last_run dans une GET réponse, transmettez flight_info=true la chaîne de requête. Vous pouvez également filtrer les éléments créatifs en fonction du moment où ils ont été servis pour la première et la dernière fois, comme suit :

Récupérer uniquement les créations qui n’ont jamais été servies

Transmettez never_run=true la chaîne de requête.

curl -b cookies -c cookies 'https://api.appnexus.com/creative?advertiser_id=100&flight_info=true&never_run=true'

Remarque

Vous pouvez utiliser never_run=true en combinaison avec d’autres filtres, mais notez qu’il s’agit toujours d’une relation OR. Par exemple, si vous transmettez never_run=trueet min_first_run=2012-01-01 00:00:00 dans la chaîne de requête, vous recherchez des éléments créatifs qui n’ont jamais servi des éléments de ligne OR qui ont servi pour la première fois le ou après le 01-01-2012.

Récupérer uniquement les créations qui ont été servies pour la première fois à ou après une date spécifique

Transmettez min_first_run=YYYY-MM-DD HH:MM:SS la chaîne de requête.

curl -b cookies -c cookies 'https://api.appnexus.com/creative?advertiser_id=100&flight_info=true&min_first_run=2012-01-01 00:00:00'

Récupérer uniquement les créations qui ont été servies pour la première fois à ou avant une date spécifique

Transmettez max_first_run=YYYY-MM-DD HH:MM:SS la chaîne de requête.

curl -b cookies -c cookies 'https://api.appnexus.com/creative?advertiser_id=100&flight_info=true&max_first_run=2012-08-01 00:00:00'

Récupérer uniquement les créations d’abord servies dans une plage de dates spécifique

Transmettez min_first_run=YYYY-MM-DD HH:MM:SS&max_first_run=YYYY-MM-DD HH:MM:SS la chaîne de requête.

curl -b cookies -c cookies 'https://api.appnexus.com/creative?advertiser_id=100&flight_info=true&min_first_run=2012-01-01 00:00:00&max_first_run=2012-08-01 00:00:00'

Récupérer uniquement les créations qui ont été servies pour la dernière fois à ou après une date spécifique

Transmettez min_last_run=YYYY-MM-DD HH:MM:SS la chaîne de requête.

curl -b cookies -c cookies 'https://api.appnexus.com/creative?advertiser_id=100&flight_info=true&min_last_run=2012-01-01 00:00:00'

Récupérer uniquement les créations qui ont été servies pour la dernière fois ou avant une date spécifique

Transmettez max_last_run=YYYY-MM-DD HH:MM:SS la chaîne de requête.

curl -b cookies -c cookies 'https://api.appnexus.com/creative?advertiser_id=100&flight_info=true&max_last_run=2012-08-01 00:00:00'

Récupérer uniquement les créations qui ont été servies pour la dernière fois dans une plage de dates spécifique

Transmettez min_last_run=YYYY-MM-DD HH:MM:SS&max_last_run=YYYY-MM-DD HH:MM:SS la chaîne de requête.

curl -b cookies -c cookies 'https://api.appnexus.com/creative?advertiser_id=100&flight_info=true&min_last_run=2012-01-01 00:00:00&max_last_run=2012-08-01 00:00:00'

Stats

Remarque

L’objet statsest déconseillé (depuis le 17 octobre 2016). Utilisez plutôt le service de rapports pour obtenir des informations statistiques.

Modifications qui provoquent un audit de nouveau

Une fois qu’un créatif a réussi l’audit Xandr (audit_status est "audited"), la modification de l’un des champs suivants entraîne la soumission du créatif pour l’audit (allow_audit est défini sur "pending") :

  • width
  • height
  • content
  • media_url
  • click_url
  • template
  • custom_macros
  • media_subtypes
  • language
  • categories
  • technical_attributes
  • brand_id
  • pixel_url
  • pixels (si vous ajoutez ou supprimez un pixel personnalisé ou un pixel approuvé par Xandr)
  • text_title (si le texte est créatif)
  • text_description (si le texte est créatif)
  • text_display_url (si le texte est créatif)
  • pop_window_maximize (si pop creative)
  • pop_is_tag_initiated (si pop creative et change de false à true)
  • video_attribute
  • media_assets
  • brand_url (non applicable aux utilisateurs d’API)
  • alternative_landing_page_url
  • native_attribute

En outre, si a la audit_status valeur "no_audit", le passage allow_audit de "false" à "true" entraîne la soumission de la création pour l’audit Xandr.

Macros créatives

Xandr a prédéfini certaines macros qui peuvent être utilisées dans les champs , content, click_urlet pixel_url de media_urlla création.

Exemple de suivi des clics

"media_url": "https://ad.doubleclick.net/adi/N5364.Ivillage.com/B2965815.5;sz=728x90;click0=$
{CLICK_URL};ord=${CACHEBUSTER}?"
        

Exemples

Attention

Excluez audit_status et no_audit dans les PUT appels pour éviter les erreurs.

Ajouter une image de bannière créative (hébergée)

Lors du chargement d’une image de bannière standard créative pour l’hébergement avec Xandr :

Une fois la création inscrite, le contenu est stocké sur le CDN, et le créatif reçoit un media_url tel que https://cdn.adnxs.com/p/29/23/21/a0/292321a0bea05427598914c8bb626032.jpg.

Audit : par défaut, le créatif est soumis à l’audit par Xandr. Si vous ne souhaitez pas que la création soit auditée, vous devez l’inclure allow_audit et la définir sur false. Sinon, si vous souhaitez auditer vous-même le créatif, vous devez l’inclure is_self_audited et le définir sur true.

$ cat creative

{
   "creative": {
      "template": {"id":4},
      "width": 300,
      "height": 250,
      "click_url": "https://www.gothere.com",
      "click_target": "https://www.gothere.com",
      "file_name": "gothere.png",
      "content": "/9j/4AAQSkZJRgABAgAAZABkAAD/7AARRHVja3kAAQAEAAAAPAAA/+4ADkFkb2JlAGTAAAAAAf/b
                 AIQABgQEBAUEBgUFBgkGBQYJCwgGBggLDAoKCwoKDBAMDAwMDAwQDA4PEA8ODBMTFBQTExwbGxsc
                 Hx8fHx8fHx8fHwEHBwcNDA0YEBAYGhURFRofHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8f
                 ...
                 nwj3HrP+oer6/wDPa/tKsOz/AEf8CnxP82z3fTu9VDboP//Z"
   }
}

$ curl -b cookies -c cookies -X POST -d @creative 'https://api.appnexus.com/creative?advertiser_id=2'

{
   "response": {
      "status": "OK",
      "id": 10,
      ...
      "template": {
          "id": 4,
          "name": "Standard",
          "media_subtype_id": 1,
          "format_id": 4
      },
      "width": 300,
      "height": 250,
      ...
      "click_url": "https://www.gothere.com",
      "click_target": "https://www.gothere.com",
      "media_url": "https://cdn.adnxs.com/p/29/23/21/a0/gothere.png"
      ...
      "audit_status": "pending",
      ...
   }
}

Ajouter une image de bannière mobile (hébergée)

Pour que les créatifs mobiles réussissent l’audit de la plateforme Xandr, vous devez passer l’objet mobile avec une AUTRE URL qui s’affichera correctement dans un navigateur de bureau lorsque vous cliquez sur le contenu créatif.

$ cat creative
 
{
    "creative": {
        "content": "\/9j\/4AAQSkZJRgABAQEASABIAAD\/7QCEUGhvdG9zaG9wIDMuMAA4QklNBAQAAAAAAGccAVoAAxsl...",
        "mobile": {
            "alternative_landing_page_url": "https:\/\/example.com"
        },
        "file_name": "SWEET.png",
        "click_url": "https:\/\/example.com",
        "click_target": "https:\/\/example.com",
        "height": 250,
        "width": 300,
        "template": {
            "id": 4
        }
    }
}

$ curl -b cookies -c cookies -X POST -d @creative 'https://api.appnexus.com/creative?advertiser_id=3141'

{
    "response": {
        "status": "OK",
        "count": 1,
        "id": 700864,
        "start_element": 0,
        "num_elements": 100,
        "creative": {
            "name": null,
            "brand_id": 1,
            "media_url": "https:\/\/cdn.sand-08.adnxs.net\/s\/d3\/d6\/1c\/61\/d3d61c611fd6f98becc8ad6d45c43875.png",
            "id": 700864,
            "code": null,
            "code2": null,
            "member_id": 1309,
            "state": "inactive",
            "click_track_result": "not_tested",
            "advertiser_id": 41798,
            "publisher_id": null,
            "format": null,
            "width": 300,
            "height": 250,
            "click_url": "https:\/\/example.com",
            "click_target": "https:\/\/example.com",
            "flash_click_variable": null,
            "no_iframes": false,
            "content": null,
            "original_content": null,
            "file_name": "OH_YEAH.png",
            "track_clicks": true,
            "audit_status": "pending",
            "macros": null,
            "profile_id": null,
            "audit_feedback": null,
            "is_prohibited": false,
            "is_suspicious": false,
            "created_on": "2013-10-18 15:57:03",
            "flash_backup_url": null,
            "last_modified": "2013-10-18 15:57:03",
            "is_control": false,
            "allow_audit": true,
            "is_expired": false,
            "creative_upload_status": "pending",
            "backup_upload_status": null,
            "use_dynamic_click_url": false,
            "media_subtypes": [
                "banner"
            ],
            "size_in_bytes": 15171,
            "msft_audit_status": "pending",
            "msft_audit_feedback": null,
            "msft_external_audit_status": "pending",
            "msft_external_audit_feedback": null,
            "is_self_audited": false,
            "no_adservers": false,
            "text_title": null,
            "text_description": null,
            "text_display_url": null,
            "click_action": "click-to-web",
            "ssl_status": "disabled",
            "allow_ssl_audit": false,
            "media_url_secure":"https:\/\/a248.e.akamai.net\/appnexus.download.akamai.com\/89298\/sandbox\/s\/d3\/d6\/1c\/61\/d3d61c611fd6f98becc8ad6d45c43875.png",
            "content_secure": null,
            "original_content_secure": null,
            "flash_backup_url_secure": null,
            "is_hosted": true,
            "content_source": "standard",
            "lifetime_budget_imps": null,
            "daily_budget_imps": null,
            "enable_pacing": null,
            "allow_safety_pacing": null,
            "lifetime_budget": null,
            "daily_budget": null,
            "landing_page_url": null,
            "thirdparty_creative_id": null,
            "thirdparty_campaign_id": null,
            "custom_request_template": null,
            "language": {
                "id": 1,
                "name": "English"
            },
            "pop_values": null,
            "brand": {
                "id": 1,
                "name": "Unknown",
                "category_id": 8
            },
            "template": {
                "id": 4,
                "name": "Standard",
                "media_subtype_id": 1,
                "format_id": 4
            },
            "thirdparty_page": null,
            "custom_macros": null,
            "segments": null,
            "folder": null,
            "campaigns": null,
            "competitive_brands": null,
            "competitive_categories": null,
            "pixels": null,
            "mobile": {
                "alternative_landing_page_url":"https:\/\/example.com"
            },
            "sla": null,
            "sla_eta": null,
            "currency": "USD"
        },
        "dbg_info": {
            ...
        }
    }
}

Ajouter une bannière flash creative (hébergée)

Lors du chargement d’une bannière standard flash creative pour l’hébergement avec Xandr :

Une fois la création inscrite, le contenu est stocké sur le CDN, et le créatif reçoit un media_url tel que https://cdn.adnxs.com/p/29/23/21/a0/292321a0bea05427598914c8bb626032.jpg.

Audit : par défaut, le créatif est soumis à l’audit par Xandr. Si vous ne souhaitez pas que la création soit auditée, vous devez l’inclure allow_audit et la définir sur false. Sinon, si vous souhaitez auditer vous-même le créatif, vous devez l’inclure is_self_audited et le définir sur true.

$ cat creative

{
   "creative": {
      "template": {"id":3},
      "width": 300,
      "height": 250,
      "click_url": "https://www.gothere.com",
      "click_target": "htpps://www.gothere.com",
      "file_name": "gothere.swf",
      "flash_click_variable": "ClickTag",
      "content": "/9j/4AAQSkZJRgABAgAAZABkAAD/7AARRHVja3kAAQAEAAAAPAAA/+4ADkFkb2JlAGTAAAAAAf/b
                 AIQABgQEBAUEBgUFBgkGBQYJCwgGBggLDAoKCwoKDBAMDAwMDAwQDA4PEA8ODBMTFBQTExwbGxsc
                 Hx8fHx8fHx8fHwEHBwcNDA0YEBAYGhURFRofHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8f
                 ...
                 nwj3HrP+oer6/wDPa/tKsOz/AEf8CnxP82z3fTu9VDboP//Z",
      "flash_backup_content": "AcndgAAZABkAAD/7AARRHVja3kAAQAEAAAAPAAA/+4ADkFkb2JlAGTAAAAAAf/b
                 AIQABgQEBAUEBgUFBgkGBQYJCwgGcdkDCADBdcdDDBAMDAwMDAwQDA4PEA8ODBMTFBQTExwbGxsc
                 Hx8fHx8fHx8fHwEHBwcNDA0YEBAYGhURFRofHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx6smd34
                 ...
                 nwj3HrP+oer6/wDPa/tKsOz/AEf8Cnnd30cddaxcio244adc",
      "flash_backup_file_name": "flash_backup.png"
   }
}

$ curl -b cookies -c cookies -X POST -d @creative 'https://api.appnexus.com/creative?advertiser_id=2'

{
   "response": {
      "status": "OK",
      "id": 11,
      ...
      "template": {
          "id": 3,
          "name": "Standard",
          "media_subtype_id": 1,
          "format_id": 3
      },
      "width": 300,
      "height": 250,
      ...
      "click_url": "https://www.gothere.com",
      "click_target": "https://www.gothere.com",
      "media_url": "https://cdn.adnxs.com/p/29/23/21/a0/gothere.swf"
      "flash_backup_url": "https://cdn.adnxs.com/c/54/f2/d1/v3/flash_backup.png"
      ...
      "audit_status": "pending",
      ...
   }
}

Ajouter une bannière flash creative (URL tierce)

Lors de l’ajout d’une URL tierce pour une bannière flash creative :

Audit : par défaut, le créatif est soumis à l’audit par Xandr. Si vous ne souhaitez pas que la création soit auditée, vous devez l’inclure allow_audit et la définir sur false. Sinon, si vous souhaitez auditer vous-même le créatif, vous devez l’inclure is_self_audited et le définir sur true.

$ cat creative

{
   "creative": {
      "media_url": "https://creative.com/300x250",
      "flash_backup_url": "https://creative.com/backupimage/300x250",
      "template": {"id":2},
      "width": 300,
      "height": 250,
      "campaigns": [
         {"id":58990},
         {"id":58991}
      ]
   }
}

$ curl -b cookies -c cookies -X POST -d @creative 'https://api.appnexus.com/creative?advertiser_id=35'

{
   "response": {
      "status": "OK",
      "id":12,
      ...
      "media_url": "https://creative.com/300x250",
      "flash_backup_url": "https://creative.com/backupimage/300x250",
      ...
      "template": {
          "id": 2,
          "name": "Standard",
          "media_subtype_id": 1,
          "format_id": 2
      },
      ...
      "audit_status": "pending",
      ...
   }
}

Ajouter un objet créatif extensible MediaMind (URL tierce)

Dans cet exemple, notez que le media_url champ fournit l’URL tierce du créatif extensible, et que le tableau de modèles spécifie le modèle 108, qui est le modèle Xandr standard pour les créatifs du "MediaMind Expandable" sous-type multimédia et du "url-js" format.

Audit : par défaut, le créatif est soumis à l’audit par Xandr. Si vous ne souhaitez pas que la création soit auditée, vous devez l’inclure allow_audit et la définir sur false. Sinon, si vous souhaitez auditer vous-même le créatif, vous devez l’inclure is_self_audited et le définir sur true.

$ cat creative

{
   "creative": {
      "media_url": "https://bs.serving-sys.com/BurstingPipe/adServer.bs?ncu=$$${CLICK_URL_ENC}$$&cn=rsb&c=28&
          pli=2980019&PluID=0&w=300&h=250&ord=${CACHEBUSTER}&ucm=true",
      "template": {"id":108},
      "width": 300,
      "height": 250,
      "campaigns":[
          {"id": 58990},
          {"id": 58991}
      ]
   }
}

$ curl -b cookies -c cookies -X POST -d @creative 'https://api.appnexus.com/creative?advertiser_id=35'

{
   "response":{
      "status":"OK",
      "id":12,
      ...
      "media_url":"https://bs.serving-sys.com/BurstingPipe/adServer.bs?ncu=$$${CLICK_URL_ENC}$$&cn=rsb&c=28&
          pli=2980019&PluID=0&w=300&h=250&ord=${CACHEBUSTER}&ucm=true",
      ...
      "template": {
          "id": 108,
          "name": "Standard",
          "media_subtype_id": 11,
          "format_id": 2
      },
      ...
      "audit_status": "pending",
      ...
   }
}

Ajouter un élément créatif extensible Pointroll (balise HTML tierce)

Dans cet exemple, notez que le champ de contenu fournit la balise JavaScript pour la création extensible, et que le tableau de modèles spécifie le modèle 159, qui est le modèle Xandr standard pour les créatifs du "Pointroll Expandable" sous-type multimédia et du "raw-html" format.

Audit : par défaut, le créatif est soumis à l’audit par Xandr. Si vous ne souhaitez pas que la création soit auditée, vous devez l’inclure allow_audit et la définir sur false. Sinon, si vous souhaitez auditer vous-même le créatif, vous devez l’inclure is_self_audited et le définir sur true.

$ cat creative

{
   "creative": {
      "content":<script type=\"text/javascript\">function pr_swfver(){var osf,osfd,i,axo=1,v=0,nv=navigator;
       if(nv.plugins&&nv.mimeTypes.length){osf=nv.plugins[\"ShockwaveFlash\"];if(osf&&osf.description)
       {osfd=osf.description;v=parseInt(osfd.substring(osfd.indexOf(\".\")-2))}}else{try{for(i=5;axo!=null;i++)
       {axo=new ActiveXObject(\"ShockwaveFlash.ShockwaveFlash.\"+i);v=i}}catch(e){}}return v;}var pr_d=new Date
       ();pr_d=pr_d.getDay()+\"|\"+pr_d.getHours()+\": \"+pr_d.getMinutes()+\"|\"+-pr_d.getTimezoneOffset()/60;
       var pr_postal=\"\";var pr_data=\"\";var pr_redir=\"$CTURL$\";var pr_nua=navigator.userAgent.toLowerCase();
       </script>,
      "template": {"id":159},
      "width": 300,
      "height": 250,
      "campaigns": [
         {"id": 58990},
         {"id": 58991}
      ]
   }
}

$ curl -b cookies -c cookies -X POST -d @creative 'https://api.appnexus.com/creative?advertiser_id=35'

{
   "response": {
      "status": "OK",
      "id": 12
      ...
      "content":"var click = '${CLICK_URL}'; var t = (new Date()).getTime(); var s = document.createElement('script');
                s.setAttribute('src', 'https://pointroll.adserver.org/showad?size=300x250;click=' + click + ';ord=' + t);
                document.getElementsByTagName('body').appendChild(s);https://creative.com/300x250",
      ...
      "template": {
         "id": 159,
         "name": "Standard",
         "media_subtype_id": 12,
         "format_id": 6
      },
      ...
      "audit_status":"pending",
      ...
   }
}

Ajouter une image contextuelle créative (URL tierce)

Dans cet exemple, notez que le media_url champ fournit l’URL tierce de l’image contextuelle et que le tableau de modèles spécifie le modèle 10, qui est le modèle de rendu Xandr standard pour le "Popup" sous-type multimédia et le "url-js" format. Si vous ne spécifiez pas de modèle dans la demande, vous devez passer le format en tant que "image" et media_subtype en tant que "popup".

{
   "creative":
   {
     "media_url": "https://dummyimage.com/728x90",
     "click_url": "https://www.google.com",
     "click_target": "https://www.google.com",
     "template": {"id":10},
     "pop_values": {
       "pop_is_tag_initiated": false,
       "pop_window_maximize": false,
       "pop_window_title": null,
       "pop_statusbar": false,
       "pop_resizable": false,
       "pop_scrollbars": false,
       "pop_toolbar": false,
       "pop_addressbar": false
       },
      "width": 728,
      "height": 90
   }
}

$ curl -b cookies -c cookies -X POST -d @creative 'https://api.appnexus.com/creative?advertiser_id=2'

{
   "response": {
      "status": "OK",
      "id": 14,
      ...
      "template": {
          "id": 10,
          "name": "Standard",
          "media_subtype_id": 2,
          "format_id": 2
      },
      "width": 728,
      "height": 90,
      ...
      "audit_status": "pending",
      ...
   }
}

Ajouter une image contextuelle créative (URL tierce)

Dans cet exemple, notez que le media_url champ fournit l’URL tierce pour la création d’image contextuelle, et que le tableau de modèles spécifie le modèle 17, qui est le modèle de rendu Xandr standard pour le "Popunder" sous-type multimédia et le "url-js" format. Si vous n’incluez pas de modèle dans la demande, vous devez passer le format en tant que "image" et media_subtype en tant que "popunder".

{
   "creative" :
   {
     "media_url": "https://dummyimage.com/728x90",
     "click_url": "https://www.google.com",
     "click_target": "https://www.google.com",
     "template": {"id":17},
     "pop_values": {
       "pop_is_tag_initiated": false,
       "pop_window_maximize": false,
       "pop_window_title": null,
       "pop_statusbar": false,
       "pop_resizable": false,
       "pop_scrollbars": false,
       "pop_toolbar": false,
       "pop_addressbar": false
       },
      "width": 728,
      "height": 90
   }
}

$ curl -b cookies -c cookies -X POST -d @creative 'https://api.appnexus.com/creative?advertiser_id=2'

{
   "response": {
      "status": "OK",
      "id":14,
      ...
      "template": {
          "id": 17,
          "name": "Standard",
          "media_subtype_id": 2,
          "format_id": 2
      },
      "width": 728,
      "height": 90,
      ...
      "audit_status": "pending",
      ...
   }
}

Ajouter une vidéo dans la bannière (fichier vidéo tiers)

Lors de l’ajout d’un fichier vidéo tiers dans la bannière :

Audit : par défaut, le créatif est soumis à l’audit par Xandr. Si vous ne souhaitez pas que la création soit auditée, vous devez l’inclure allow_audit et la définir sur false. Sinon, si vous souhaitez auditer vous-même le créatif, vous devez l’inclure is_self_audited et le définir sur true.

$ cat inbanner

{
   "creative": {
      "media_url": "https://example.com/inbanner.flv",
      "template": {"id":219},
      "click_url": "https://www.example.com",
      "click_target": "https://www.example.com",
      "width": 300,
      "height": 250,
      "flash_backup_url": "https://www.example.com/poster_image.png"
      "custom_macros": [
          {
              "code": "FLV_URL",
              "value": "https:www.example.com/inbanner.flv"
          },
          {
              "code": "MP4_URL",
              "value": "https:www.example.com/inbanner.mp4"
          },
          {
              "code": "WEBM_URL",
              "value": "https:www.example.com/inbanner.webm"
          }
      ],
   }
}


$ curl -b cookies -c cookies -X POST -d @inbanner 'https://api.appnexus.com/creative?advertiser_id=2'
{
    "response": {
        "status": "OK",
        "count": 1,
        "id": 510242,
        "start_element": 0,
        "num_elements": 100,
        "creative": {
            "name": null,
            "brand_id": 1,
            "media_url": "https://example.com/inbanner.flv",
            "id": 510244,
            "code": null,
            "code2": null,
            "state": "inactive",
            "click_track_result": "not_tested",
            "advertiser_id": 2,
            "publisher_id": null,
            "format": null,
            "width": 300,
            "height": 250,
            "click_url": "https://www.example.com",
            "flash_click_variable": null,
            "pixel_url": null,
            "pixel_type": "image",
            "no_iframes": false,
            "content": null,
            "original_content": null,
            "file_name": "inbanner.flv",
            "track_clicks": true,
            "audit_status": "pending",
            "macros": null,
            "profile_id": null,
            "audit_feedback": null,
            "is_prohibited": false,
            "created_on": "2012-04-13 14:47:46",
            "flash_backup_url": "https://example.com/poster_image.png",
            "last_modified": "2012-04-13 14:47:46",
            "is_control": false,
            "allow_audit": true,
            "is_expired": false,
            "creative_upload_status": "pending",
            "backup_upload_status": null,
            "use_dynamic_click_url": false,
            "media_subtypes": [
                "banner"
            ],
            "size_in_bytes": 0,
            "msft_audit_status": "pending",
            "msft_audit_feedback": null,
            "msft_external_audit_status": "pending",
            "msft_external_audit_feedback": null,
            "is_self_audited": false,
            "no_adservers": false,
            "text_title": null,
            "text_description": null,
            "text_display_url": null,
            "click_action": "click-to-web",
            "click_target": "https://www.example.com",
            "ssl_status": "disabled",
            "allow_ssl_audit": false,
            "media_url_secure": "https://example.com/inbanner.flv",
            "content_secure": null,
            "original_content_secure": null,
            "pixel_url_secure": null,
            "flash_backup_url_secure": null,
            "is_hosted": true,
            "lifetime_budget_imps": null,
            "daily_budget_imps": null,
            "enable_pacing": null,
            "lifetime_budget": null,
            "daily_budget": null,
            "language": {
                "id": 1,
                "name": "English"
            },
            "pop_values": null,
            "brand": {
                "id": 1,
                "name": "Unknown",
                "category_id": 8
            },
            "template": {
                "id": 219,
                "name": "Standard",
                "media_subtype_id": 3,
                "format_id": 11
            },
            "custom_macros": [
                {
                    "code": "AUTOPLAY",
                    "value": "0"
                },
                {
                    "code": "CONTROLS",
                    "value": "1"
                },
               {
                    "code": "FLV_URL",
                    "value": "https:www.example.com/inbanner.flv"
                },
                {
                    "code": "MP4_URL",
                    "value": "https:www.example.com/inbanner.mp4"
                },
                {
                    "code": "WEBM_URL",
                    "value": "https:www.example.com/inbanner.webm"
                }
            ],
            "segments": null,
            "folder": null,
            "campaigns": null,
            "competitive_brands": null,
            "competitive_categories": null,
            "pixels": null,
            "sla": null,
            "sla_eta": null,
            "currency": "USD"
        },
        "dbg_info": {
            ... 
        }
    }
}

Ajouter une vidéo dans la bannière (fichier XML tiers)

Lors de l’ajout d’un fichier XML dans la bannière tiers :

Audit : par défaut, le créatif est soumis à l’audit par Xandr. Si vous ne souhaitez pas que la création soit auditée, vous devez l’inclure allow_audit et la définir sur false. Sinon, si vous souhaitez auditer vous-même le créatif, vous devez l’inclure is_self_audited et le définir sur true.

$ cat inbanner

{
   "creative": {
      "media_url": "https://example.com/inbanner.xml",
      "template": {"id":8},
      "click_url": "https://www.example.com",
      "click_target": "https://www.example.com",
      "width": 300,
      "height": 250,
      "flash_backup_url": "https://example.com/poster_image.png"
   }
}


$ curl -b cookies -c cookies -X POST -d @inbanner 'https://api.appnexus.com/creative?advertiser_id=2'
{
    "response": {
        "status": "OK",
        "count": 1,
        "id": 510242,
        "start_element": 0,
        "num_elements": 100,
        "creative": {
            "name": null,
            "brand_id": 1,
            "media_url": "https://example.com/inbanner.xml",
            "id": 510245,
            "code": null,
            "code2": null,
            "state": "inactive",
            "click_track_result": "not_tested",
            "advertiser_id": 2,
            "publisher_id": null,
            "format": null,
            "width": 300,
            "height": 250,
            "click_url": "https://www.example.com",
            "flash_click_variable": null,
            "pixel_url": null,
            "pixel_type": "image",
            "no_iframes": false,
            "content": null,
            "original_content": null,
            "file_name": "inbanner.xml",
            "track_clicks": true,
            "audit_status": "pending",
            "macros": null,
            "profile_id": null,
            "audit_feedback": null,
            "is_prohibited": false,
            "created_on": "2012-04-13 14:47:46",
            "flash_backup_url": "https://example.com/poster_image.png",
            "last_modified": "2012-04-13 14:47:46",
            "is_control": false,
            "allow_audit": true,
            "is_expired": false,
            "creative_upload_status": "pending",
            "backup_upload_status": null,
            "use_dynamic_click_url": false,
            "media_subtypes": [
                "banner"
            ],
            "size_in_bytes": 0,
            "msft_audit_status": "pending",
            "msft_audit_feedback": null,
            "msft_external_audit_status": "pending",
            "msft_external_audit_feedback": null,
            "is_self_audited": false,
            "no_adservers": false,
            "text_title": null,
            "text_description": null,
            "text_display_url": null,
            "click_action": "click-to-web",
            "click_target": "https://www.example.com",
            "ssl_status": "disabled",
            "allow_ssl_audit": false,
            "media_url_secure": "https://example.com/inbanner.xml",
            "content_secure": null,
            "original_content_secure": null,
            "pixel_url_secure": null,
            "flash_backup_url_secure": null,
            "is_hosted": true,
            "lifetime_budget_imps": null,
            "daily_budget_imps": null,
            "enable_pacing": null,
            "lifetime_budget": null,
            "daily_budget": null,
            "language": {
                "id": 1,
                "name": "English"
            },
            "pop_values": null,
            "brand": {
                "id": 1,
                "name": "Unknown",
                "category_id": 8
            },
            "template": {
                "id": 8,
                "name": "Standard",
                "media_subtype_id": 3,
                "format_id": 10
            },
            "custom_macros": null,
            "segments": null,
            "folder": null,
            "campaigns": null,
            "competitive_brands": null,
            "competitive_categories": null,
            "pixels": null,
            "sla": null,
            "sla_eta": null,
            "currency": "USD"
        },
        "dbg_info": {
           ...
        }
    }
}

Ajouter un élément créatif qui utilise un modèle de rendu personnalisé

Dans cet exemple, la POST demande ajoute une bannière flash hébergée créative à Xandr. Le créatif utilise un modèle créatif personnalisé, qui est conçu pour restituer le créatif avec une bordure lorsqu’il est servi. Les macros personnalisées dans le modèle permettent au trafiquant de spécifier le code de couleur HTML et la taille (en pixels) ou la bordure.

$ cat creative

{
   "creative": {
      "template": {"id":252},
      "width": 300,
      "height": 250,
      "custom_macros": [
         {
            "code": "BORDER_COLOR",
            "value": "#000000"
         },
         {
            "code": "BORDER_SIZE",
            "value": 1
         }
      ],
      "click_url": "https://www.gothere.com",
      "click_target": "https://www.gothere.com",
      "file_name": "gothere.swf",
      "flash_click_variable": "ClickTag",
      "content": "/9j/4AAQSkZJRgABAgAAZABkAAD/7AARRHVja3kAAQAEAAAAPAAA/+4ADkFkb2JlAGTAAAAAAf/b
                 AIQABgQEBAUEBgUFBgkGBQYJCwgGBggLDAoKCwoKDBAMDAwMDAwQDA4PEA8ODBMTFBQTExwbGxsc
                 Hx8fHx8fHx8fHwEHBwcNDA0YEBAYGhURFRofHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8f
                 ...
                 nwj3HrP+oer6/wDPa/tKsOz/AEf8CnxP82z3fTu9VDboP//Z",
      "flash_backup_content": "AcndgAAZABkAAD/7AARRHVja3kAAQAEAAAAPAAA/+4ADkFkb2JlAGTAAAAAAf/b
                 AIQABgQEBAUEBgUFBgkGBQYJCwgGcdkDCADBdcdDDBAMDAwMDAwQDA4PEA8ODBMTFBQTExwbGxsc
                 Hx8fHx8fHx8fHwEHBwcNDA0YEBAYGhURFRofHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx6smd34
                 ...
                 nwj3HrP+oer6/wDPa/tKsOz/AEf8Cnnd30cddaxcio244adc",
      "flash_backup_file_name": "flash_backup.png"
   }
}

$ curl -b cookies -c cookies -X POST -d @creative 'https://api.appnexus.com/creative?advertiser_id=2'

{
   "response": {
      "status": "OK",
      "id": 11,
      ...
      "template": {
          "id": 252,
          "name": "Flash Banner with Border",
          "media_subtype_id": 1,
          "format_id": 3
      },
      "width": 300,
      "height": 250,
      ...
      "click_url": "https://www.gothere.com",
      "click_target": "https://www.gothere.com",
      "media_url": "https://cdn.adnxs.com/p/29/23/21/a0/gothere.swf"
      "flash_backup_url": "https://cdn.adnxs.com/c/54/f2/d1/v3/flash_backup.png"
      ...
      "audit_status": "pending",
      ...
      "custom_macros": [
         {
            "code": "BORDER_COLOR",
            "value": "#000000"
         },
         {
            "code": "BORDER_SIZE",
            "value": 1
         }
      ],
      ...
   }
}

Ajouter un élément créatif sécurisé

Lors du chargement d’un élément créatif non sécurisé, vous pouvez également charger une version à servir sur l’inventaire SSL comme suit :

Remarque

Vous pouvez case activée l’audit ssl status d’un créatif en effectuant une simple GET demande. Le ssl_status champ dans la réponse vous indique l’status d’audit. Le créatif ne peut servir sur un inventaire sécurisé qu’une fois qu’il a réussi l’audit et que le ssl_status est "approved". Un créateur tiers réussira notre audit uniquement si tous les appels de la chaîne de publicité passent par des serveurs sécurisés. Si le créatif échoue à l’audit ssl, vous pouvez le soumettre à nouveau pour l’audit ssl en remplaçant le ssl_status champ "pending"par .

$ cat creative

{
   "creative": {
      "media_url": "https://creative.com/123",
      "media_url_secure": "https://creative.com/123",
      "template": {"id":2},
      "allow_ssl_audit": true
      "format": "image",
      "width": 300,
      "height": 250,
      "campaigns": [
         {"id":58990},
         {"id":58991}
      ]
   }
}

$ curl -b cookies -c cookies -X POST -d @creative 'https://api.appnexus.com/creative?advertiser_id=35'

{
   "response": {
      "status":"OK",
      "id":13
      ...
      "audit_status":"pending",
      ...
      "ssl_status":"pending",
      ...
   }
}

Soumettre un élément créatif pour l’audit prioritaire

Si vous avez un contrat de services supplémentaire avec Xandr pour les audits prioritaires, vous pouvez soumettre un élément créatif pour l’audit prioritaire (audit dans les 2 heures pendant les heures d’ouverture) en définissant le sla champ sur 2. Le sla_eta champ de la réponse fournit une heure de fin estimée pour l’audit.

$ cat creative

{
   "creative": {
      "media_url": "https://creative.com/456",
      "template": {"id":2},
      "width": 300,
      "height": 250,
      "campaigns": [
         {"id":58990},
         {"id":58991}
      ],
      "sla": 2
   }
}

$ curl -b cookies -c cookies -X POST -d @creative 'https://api.appnexus.com/creative?advertiser_id=35'

{
   "response": {
      "status": "OK",
      "id": 469340,
      ...
      "audit_status": "pending",
      ...
      "sla": "2",
      "sla_eta": "2012-01-13 22:43:33",
      ...
   }
}

Annuler un audit créatif

Si vous avez soumis un créatif pour l’audit Xandr et que le audit_status est "pending", vous pouvez annuler l’audit et ne pas être facturé les frais d’audit en effectuant une PUT demande avec allow_audit défini sur false. Le audit_status champ se trouve "no_audit" dans la réponse.

$ cat creative

{
   "creative": {
      "allow_audit":false
   }
}

$ curl -b cookies -c cookies -X PUT -d @creative 'https://api.appnexus.com/creative?id=469340&advertiser_id=35'

{
   "response": {
      "status": "OK",
      "id": 469340,
      ...
      "audit_status":"no_audit",
      ...
   }
}

Afficher les statistiques d’audit pour tous les créatifs

Dans cet exemple, "audit_stats=true" est passé dans la chaîne de requête de l’appel GET . Cela retourne le nombre de créations avec chaque status d’audit Xandr, Microsoft et Google.

$ curl -b cookies -c cookies 'https://api.appnexus.com/creative?audit_stats=true'

{
    "response": {
        "status": "OK",
        "count": 30,
        "start_element": 0,
        "num_elements": 100,
        "creatives": [
            {
                "total": 30,
                "appnexus_audit": {
                    "no_audit": 10,
                    "pending": 18,
                    "approved": 0,
                    "rejected": 1
                },
                "microsoft_audit": {
                    "no_audit": 10,
                    "pending": 18,
                    "approved": 1,
                    "rejected": 1
                }
            }
        ],
        "dbg_info": {
            ...
        }
    }
}

Ajouter un pixel approuvé par Xandr à un créatif

Cet exemple vous guide tout au long du processus d’ajout du pixel icône Evidon AdChoices approuvé par Xandr à un élément créatif.

  1. Tout d’abord, vous devez déterminer le pixel_template_id et le nombre de paramètres que vous devez définir pour le pixel. Vous utilisez le service de modèle de pixels pour obtenir ces informations.

    $ curl -b cookies -c cookies 'https://api.appnexus.com/pixel-template'
    
    {
        "response": {
            "status": "OK",
            "count": 3,
            "start_element": 0,
            "num_elements": 100,
            "pixel-templates": [
                {
                    "id": 1,
                    "name": "Evidon AdChoices Icon",
                    "format": "raw-js",
                    "content": "(function() {document.write('<sc'+'ript type=\"text/javascript\"' + ((\"https:\"
                     == document.location.protocol) ? \"https://c.betrad.com\" : \"https://c.betrad.com\") +
                     '/surly.js?;ad_wxh=${CREATIVE_SIZE};coid=${P1};nid=${P2};${P3}\"></scr'+'ipt>');}());",
                    "num_required_params": 2,
                    "require_reaudit": false
                },
                {
                    "id": 2,
                    "name": "Brilig Impression Tracker",
                    "format": "url-image",
                    "num_required_params": 1,
                    "require_reaudit": false,
                    "url": "https://p.brilig.com/contact/bct?pid=${P1}&_ct=pixel&adid=${CP_ID}&action=1"
                },
                ...
            ],
            "dbg_info": {
                ...
            }
        }
    }
    
  2. Le pixel Evidon AdChoices Icon est le premier de la réponse. Vous notez que l’ID est 1. Vous notez également que num_required_params est 2. Cela signifie que, lorsque vous ajoutez le pixel à votre élément créatif, vous devez fournir des valeurs pour {P1} et {P2} dans le contenu du pixel.

  3. Vous créez le fichier au format JSON pour ajouter le pixel à la création. Dans le fichier, vous définissez 2pixel_template_id sur , et vous définissez param_1 et param_2 sur les valeurs pour {P1} et {P2} dans le contenu des pixels.

    Attention

    Le tableau de pixels sera complètement remplacé par votre json. Par conséquent, si le tableau de pixels sur le créatif inclut déjà des pixels, veillez également à les spécifier dans votre tableau JSON. Pour plus d’informations, consultez Creative Service.

    $ cat creative_update
    
    {
        "creative": {
            "pixels": [
                {
                    "pixel_template_id": 1,
                    "param_1":"12",
                    "param_2":"34"
                }
            ]
        }
    }
    
  4. Enfin, vous effectuez un PUT appel pour mettre à jour le créatif. Le tableau de pixels dans la réponse indique ensuite que le pixel a été ajouté. Les deux paramètres sont définis et ont été renseignés dans le contenu des pixels.

    Remarque

    Le pixel d’icône Evidon AdChoices n’oblige pas le créatif à effectuer un audit, audit_status et n’a "pending"pas été rétabli en .

    $ curl -b cookies -c cookies -X PUT -d @creative_update 'https://api.appnexus.com/creative?id=503577&advertiser_id=35081'
    
    {
        "response": {
            "status": "OK",
            "count": 1,
            "id": "503577",
            "start_element": 0,
            "num_elements": 100,
            "creative": {
                "name": null,
                "brand_id": 1,
                "media_url": "https://creative.com/300x250",
                "id": 503577,
                "code": null,
                "code2": null,
                "state": "active",
                "click_track_result": "not_tested",
                "advertiser_id": 35081,
                ...
                "audit_status": "audited",
                ...
                "pixels": [
                    {
                        "id": 163,
                        "pixel_template_id": 1,
                        "param_1": "12",
                        "param_2": "34",
                        "param_3": null,
                        "param_4": null,
                        "param_5": null,
                        "format": "url-image",
                        "content": "(function() {document.write('<sc'+'ript type=\"text/javascript\"' +
                         ((\"https:\" == document.location.protocol) ? \"https://c.betrad.com\" :
                         \"https://c.betrad.com\") + '/surly.js?;ad_wxh=${CREATIVE_SIZE};coid=12;nid=34;
                         \"></scr'+'ipt>');}());"
                    }
                ],
                ...
            },
            "dbg_info": {
                ...
            }
        }
    }
    

Ajouter un pixel personnalisé à un élément créatif

Dans cet exemple, la PUT requête ajoute un pixel url-js personnalisé à des 503577 créatifs. Dans le fichier au format JSON, le format est défini sur "url-js", et l’URL est définie sur l’emplacement du Code JavaScript que vous souhaitez servir avec le créatif.

Remarque

Dans la réponse qui est ; cela est "pending"dû au fait que audit_status l’ajout d’un pixel personnalisé à un créatif entraîne la soumission du créatif à des fins d’audit.

Attention

Le tableau de pixels est complètement remplacé par les informations contenues dans ce fichier. Par conséquent, si le créatif inclut déjà des pixels, veillez à les spécifier également dans le fichier.

$ cat creative_update

{
    "creative": {
        "pixels": [
            {
                "format": "url-js",
                "url": "https://50.16.221.228/render_js?cb=${CACHEBUSTER}&uid=${USER_ID}&ref=${REFERER_URL}
                 &campaign_id=147"
            }
        ]
    }
}
$ curl -b cookies -c cookies -X PUT -d @creative_update 'https://api.appnexus.com/creative?id=503577&advertiser_id=35081'

{
    "response": {
        "status": "OK",
        "count": 1,
        "id": "503577",
        "start_element": 0,
        "num_elements": 100,
        "creative": {
            "name": null,
            "brand_id": 1,
            "media_url": "https://creative.com/300x250",
            "id": 503577,
            "code": null,
            "code2": null,
            "state": "active",
            "click_track_result": "not_tested",
            "advertiser_id": 35081,
            ...
            "audit_status": "pending",
            ...
            "pixels": [
                {
                    "id": 196,
                    "pixel_template_id": null,
                    "param_1": null,
                    "param_2": null,
                    "param_3": null,
                    "param_4": null,
                    "param_5": null,
                    "format": "url-js",
                    "url": "https://50.16.221.228/render_js?cb=${CACHEBUSTER}&uid=${USER_ID}
                     &ref=${REFERER_URL}&campaign_id=147"
                }
            ],
            ...
        },
        "dbg_info": {
            ...
        }
    }
}

Ajouter un pixel tiers à un élément créatif

Dans cet exemple, la PUT requête ajoute 2 pixels tiers à des « 503577 » créatifs.

Remarque

Dans la réponse qui est ; cela est "pending"dû au fait que audit_status l’ajout d’un pixel tiers à un créatif entraîne la soumission du créatif à des fins d’audit.

$ cat creative_update

{
    "creative": {
        "thirdparty_pixels": [
          {
            "id": 145
          },
          {
            "id": 314
          }
        ]
    }
}
$ curl -b cookies -c cookies -X PUT -d @creative_update 'https://api.appnexus.com/creative?id=503577&advertiser_id=35081'

{
    "response": {
        "status": "OK",
        "count": 1,
        "id": "503577",
        "start_element": 0,
        "num_elements": 100,
        "creative": {
            "name": null,
            "brand_id": 1,
            "media_url": "https://creative.com/300x250",
            "id": 503577,
            "code": null,
            "code2": null,
            "state": "active",
            "click_track_result": "not_tested",
            "advertiser_id": 35081,
            ...
            "audit_status": "pending",  ??remove this, confirm with UTSAV
            ...
            "thirdparty_pixels": [

                {
                  "id": 145,
                  "name": "sample pixel",
                  "audit_status": "pending",
                  "active": true
                },
                {
                  "id": 314,
                  "name": "another sample pixel",
                  "audit_status": "pending",
                  "active": true
                }
            ],
            ...
        },
        "dbg_info": {
            ...
        }
    }
}

Ajouter un élément créatif (balise HTML tierce)

Lorsque le champ de format est défini sur "raw-html", le contenu du content champ doit être encapsulé dans document.write() et également escaped.

$ cat creative 
{
    "creative": {
        "adservers": [
            {
                "id": 79,
                "use_type": "adserver"
            }
        ],
        "name": "Test Creative",
        "original_content": "<script language=\"javascript\"src=\"https://track.adform.net/adfscript/?bn=2342059;click=${CLICK_URL}\"></script><noscript><a href=\"{CLICK_URL}https://track.adform.net/C/?bn=2342059;C=0\"  target=\"_blank\"><img  src=\"https://track.adform.net/adfserve/?bn=2342059;srctype=4;ord=${CACHEBUSTER}\"  border=\"0\"  width=\"300\"  height=\"250\"  alt=\"\"/></a></noscript>",
        "track_clicks": "true",
        "width": 300,
        "height": 250,
        "is_self_audited": "false",
        "content": "document.write('<scr' + 'ipt language=\\\"javascript\\\"src=\\\"https://track.adform.net/adfscript/?bn=2342059;click=${CLICK_URL}\\\"></scr' + 'ipt><noscript><a href=\\\"{CLICK_URL}https://track.adform.net/C/?bn=2342059;C=0\\\"  target=\\\"_blank\\\"><img  src=\\\"https://track.adform.net/adfserve/?bn=2342059;srctype=4;ord=${CACHEBUSTER}\\\"  border=\\\"0\\\"  width=\\\"300\\\"  height=\\\"250\\\"  alt=\\\"\\\"/></a></noscript>');",
        "template": {
            "id": "6"
        }
    }
}

$ curl -b cookies -c cookies -X POST -d @creative 'https://api.appnexus.com/creative?advertiser_id=1'

{
   "response": {
      "status": "OK",
      "id": 20,
      ...
      "template": {
          "id": 6,
          "name": "Standard"
      },
      "width": 300,
      "height": 250,
      "audit_status": "pending",
   }
}

Ajouter une création native

Il s’agit du nouvel attribut natif. Lors de l’ajout d’une création native avec le nouvel attribut, utilisez l’ID de modèle 39461.

Étape 1 : Charger la ressource dans le service de chargement créatif.

curl -X POST -H 'Authorization:hbapi:21816:58f909dfa3405:nym2' --form "type=image" --form "file=@./NATIVE.JPG" 'https://api.appnexus.com/creative-upload?member_id=123'

est media_asset_id retourné.

{  
   "response": {  
      "status": "OK",
      "count": 0,
      "start_element": 0,
      "num_elements": 0,
      "dbg_info": {  
         "instance": "05.media-asset-pipeline.prod.nym2",
         "db":"",
         "warnings": [  
         ],
         "start_microtime": 1492716035.805,
         "time": 5,
         "version": "",
         "output_term": "media-asset"
      },
      "media-asset":[  
         {  
            "id": 1536691,
            "parent_media_asset_id": null,
            "member_id": 123,
            "advertiser_id": null,
            "publisher_id": null,
            "file_name": "NATIVE.JPG",
            "size_in_bytes": 79400,
            "cdn_uploaded_on": null,
            "cdn_url": "https://vcdn.adnxs.com/p/creative-image/1b/ee/3d/95/1bee3d95-7042-4e10-b0bf-7f43e2e4322a.JPG",
            "cdn_secure_url": "https://vcdn.adnxs.com/p/creative-image/1b/ee/3d/95/1bee3d95-7042-4e10-b0bf-7f43e2e4322a.JPG",
            "created_on": "2017-04-20 19:20:35",
            "last_modified": "2017-04-20 19:20:35",
            "deleted": false,
            "media_asset_status": [  
               {  
                  "id": 1536687,
                  "media_asset_id": 1536691,
                  "error_message": null,
                  "local_path": "1b/ee/3d/95/1bee3d95-7042-4e10-b0bf-7f43e2e4322a.JPG",
                  "cdn_upload_attempt_count": 0,
                  "created_on": "2017-04-20 19:20:35",
                  "last_modified": "2017-04-20 19:20:35",
                  "deleted": false,
                  "status": "on_shared_storage"
               }
            ],
            "media_asset_image": {  
               "id": 1005450,
               "media_asset_id": 1536691,
               "height": 480,
               "width": 640,
               "created_on": "2017-04-20 19:20:35",
               "last_activity": "2017-04-20 19:20:35",
               "deleted": false
-            },
            "media_asset_video": null,
            "media_asset_html5": null,
            "asset_type": "image",
            "mime_type": "image/jpeg"
         }
      ]
   }
}

Étape 2 : Utilisez pour media_asset_id charger le créatif.

cat native
{
    "creative": {
        "name": null,
        "brand_id": 1,
        "media_url": "https://mediaurl.com",
        "code": "test",
        "code2": null,
        "member_id": 4,
        "state": "active",
        "advertiser_id": 7,
        "publisher_id": null,
    "template": {
        "id": 39461
    },
        "native_attribute": {
            "link": {
                "url": "https://url.com",
                "fallback_url": "https://fallback.com",
                "trackers": [
                    {
                        "url": "http://url.com",
                        "url_secure": "https://secureurl.com"
                    }
                ]
            },
            "data_assets": [
                {
                    "data_type": "sponsored_by",
                    "value": "a value"
                },
                {
                    "data_type": "rating",
                    "value": "8"
                }
            ],
            "image_assets": [
                {
                    "image_type": "main_image",
                    "media_asset_id": 1536691,
                    "image_resize_setting": {
                        "resize_enabled": true,
                        "crop_enabled": true,
                        "aspect_ratio_upper_bound": 1.2,
                        "aspect_ratio_lower_bound": 0.8,
                        "max_scale_factor": 1.41
                    }
                }
            ],
            "image_trackers": [
                {
                    "url": "http://url.com",
                    "url_secure": "https://secureurl.com"
                }
            ],
            "javascript_trackers": [
                {
                    "url": "http://url.com",
                    "url_secure": "https://secureurl.com"
                }
            ]
        },
        "thirdparty_viewability_providers": null,
        "status": {
            "user_ready": true
        },
        "sla_eta": null,
        "currency": "USD",
        "type": "native"
    }
}
 
$ curl -b cookies -c cookies -X POST -d @native 'https://api.appnexus.com/creative/1751'
{
    "response": {
        "status": "OK",
        "count": 1,
        "id": 411,
        "start_element": 0,
        "num_elements": 100,
        "dbg_info": {
            ...
            },
            "proxy": true
        },
        "creative": {
            "name": null,
            "brand_id": 1,
            "media_url": "https://mediaurl.com",
            "id": 411,
            "code": "test",
            "code2": null,
            "member_id": 4,
            "state": "active",
            "click_track_result": "not_tested",
            "advertiser_id": 3,
            "publisher_id": null,
            "format": "url-file",
            "width": null,
            "height": null,
            "click_url": null,
            "flash_click_variable": null,
            "no_iframes": false,
            "content": null,
            "original_content": null,
            "file_name": null,
            "track_clicks": true,
            "audit_status": "pending",
            "macros": null,
            "profile_id": null,
            "audit_feedback": null,
            "is_prohibited": false,
            "is_suspicious": false,
            "created_on": "2017-03-09 21:54:11",
            "flash_backup_url": null,
            "last_modified": "2017-03-09 21:54:11",
            "is_control": false,
            "allow_audit": true,
            "is_expired": false,
            "creative_upload_status": null,
            "backup_upload_status": null,
            "use_dynamic_click_url": false,
            "media_subtypes": [
                "popunder",
                "popup",
                "banner"
            ],
            "size_in_bytes": 0,
            "is_self_audited": false,
            "no_adservers": false,
            "text_title": null,
            "text_description": null,
            "text_display_url": null,
            "click_action": "click-to-web",
            "click_target": null,
            "ssl_status": "pending",
            "allow_ssl_audit": true,
            "media_url_secure": "https://MEDIAURL.appnexus.com",
            "content_secure": "document.write(\\\"\\\")",
            "original_content_secure": null,
            "flash_backup_url_secure": null,
            "is_hosted": false,
            "content_source": "standard",
            "lifetime_budget": null,
            "lifetime_budget_imps": null,
            "daily_budget": null,
            "daily_budget_imps": null,
            "enable_pacing": null,
            "allow_safety_pacing": null,
            "landing_page_url": null,
            "thirdparty_creative_id": null,
            "thirdparty_campaign_id": null,
            "facebook_audit_status": null,
            "facebook_audit_feedback": null,
            "custom_request_template": null,
            "language": {
                "id": 1,
                "name": "English"
            },
            "pop_values": null,
            "brand": {
                "id": 1,
                "name": "Unknown",
                "category_id": null
            },
            "template": {
                "id": 39461,
                "name": "native ad",
                "media_subtype_id": 17,
                "format_id": 11
            },
            "ios_ssl_audit": null,
            "adx_audit": null,
            "thirdparty_page": null,
            "custom_macros": null,
            "segments": null,
            "folder": null,
            "campaigns": null,
            "line_items": null,
            "competitive_brands": null,
            "competitive_categories": null,
            "pixels": null,
            "mobile": null,
            "video_attribute": null,
            "media_assets": null,
            "sla": null,
            "thirdparty_pixels": null,
            "native": null,
            "native_attribute": {
                "link": {
                    "url": "https://url.com",
                    "fallback_url": "https://fallback.com",
                    "trackers": [
                        {
                            "url": "http://url.com",
                            "url_secure": "https://secureurl.com"
                        }
                    ]
                },
                "data_assets": [
                    {
                        "data_type": "sponsored_by",
                        "value": "a value"
                    },
                    {
                        "data_type": "rating",
                        "value": "8"
                    }
                ],
                "image_assets": [
                    {
                        "image_type": "main_image",
                        "media_asset_id": 1536691,
                        "creative_asset_image": {
                            "url": "http://url.com",
                            "url_secure": "https://secureurl.com",
                            "height": 12,
                            "width": 34
                        }
                        "image_resize_setting": {
                            "resize_enabled": true,
                            "crop_enabled": true,
                            "aspect_ratio_upper_bound": 1.2,
                            "aspect_ratio_lower_bound": 0.8,
                            "max_scale_factor": 1.41
                        }
                    }
                ],
                "image_trackers": [
                    {
                        "url": "http://url.com",
                        "url_secure": "https://secureurl.com"
                    }
                ],
                "javascript_trackers": [
                    {
                        "url": "http://url.com",
                        "url_secure": "https://secureurl.com"
                    }
                ]
            },
            "thirdparty_viewability_providers": null,
            "status": {
                "user_ready": true
            },
            "sla_eta": null,
            "currency": "USD",
            "type": "standard"
        }
    }
    }