Remarque
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
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 d’adserver tiers ou une URL de réseau de distribution de contenu pour un fichier flash/GIF).
- Nous allons case activée media_urls régulièrement. Si un fichier disparaît, le créatif est traité comme non audité.
- Une demande de notification d’audit est envoyée au gestionnaire de audit_notify_uri pour chaque création dont l’status d’audit a changé.
- Le chargement de logiciels malveillants ou de créations trompeuses ou volontairement mal étiquetés créatifs est absolument interdit.
- Il est vivement recommandé de configurer votre membre (voir le service membre) pour recevoir des e-mails dans les cas suivants :
- La création est auditée (en configurant le champ audit_notify_email dans le service membre.)
- La création a été analysée par Sherlock (en configurant le sherlock_notify_email dans le service membre.)
Remarque
Stratégie de création expirée
Lorsqu’un élément créatif (1) n’a pas été exécuté et (2) n’a pas été modifié pendant 15 jours consécutifs, il est automatiquement marqué comme ayant expiré (« is_expired » : true) et ne sera utilisé sur aucun inventaire. Les créatifs seront automatiquement réactivés si votre soumissionnaire reprend les enchères avec le créatif.
Autorisations :
- Seul l’administrateur peut modifier
audit_statusle champ. - Les créations qui sont modifiées après avoir été auditées retournent à un status d’audit
pending.
API REST
| Méthode HTTP | Point de fin | Description |
|---|---|---|
| SUPPRIMER | https://api.adnxs.com/creative/MEMBER_ID?id=CREATIVE_ID | Supprimer un élément créatif. |
| GET | https://api.adnxs.com/creative/MEMBER_ID https://api.adnxs.com/creative/MEMBER_ID?num_elements=X& start_element=Y&min_last_activity=Z&sort=id.asc |
Afficher toutes les créations d’un membre. Remarque : Si vous avez plus de 100 créations pour un membre, utilisez les paramètres num_elements et start_element décrits ci-dessous. Pour afficher un nombre spécifique et une gamme de créations pour un membre. X est le nombre d’éléments à retourner. Cette valeur doit être inférieure ou égal à 100. Y est le premier élément des éléments X à retourner. Le premier élément est 0. Si vous utilisez num_elements, vous devez également spécifier le start_element. Pour récupérer des résultats paginés uniques, utilisez le paramètre &sort=id.asc comme indiqué ci-dessous. Vous pouvez également spécifier min_last_activity=Z en tant que filtre. Z doit être au format YYYY-MM-DD. |
| GET | https://api.adnxs.com/creative/MEMBER_ID/CREATIVE_ID https://api.adnxs.com/creative?member_id=MEMBER_ID& id=CREATIVE_ID1,CREATIVE_ID2,CREATIVE_ID3https://api.adnxs.com/creative?member_id=MEMBER_ID& ; code=CODE | Afficher une création spécifique. |
| POST | https://api.adnxs.com/creative/MEMBER_ID (JSON créatif) | Ajoutez un nouveau créatif. |
| PUT | https://api.adnxs.com/creative-macro-check?include_tests=1 (replace_pattern_in_content_url JSON) | Modifier un élément créatif existant. |
| PUT | https://api.adnxs.com/creative/MEMBER_ID/CREATIVE_ID (JSON créatif) https://api.adnxs.com/creative/MEMBER_ID?code=CODE |
Structure JSON
| Champ | Définir par | Obligatoire | Type | Description |
|---|---|---|---|---|
active |
Interne | Non | Valeur booléenne | En lecture seule. État actuel du créatif. |
added_by_bidder |
Interne | Non | int | ID du soumissionnaire qui a ajouté cette création. |
adservers |
Interne | Non | tableau d’objets | En lecture seule. 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. |
adx_audit |
Interne | Non | objet |
En lecture seule. Cet objet contient des informations sur les status et les commentaires liés à l’audit Google Ad Exchange 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. |
allow_audit |
Client | Non | Valeur booléenne | Définissez sur true si vous souhaitez choisir le créatif dans le processus d’audit. |
allow_ssl_audit |
Client | Non | Valeur booléenne | Si la valeur est true, la création est soumise à un audit sécurisé (https). Si la valeur est false, la création n’est pas envoyée. Si la valeur est true, media_url_secure ou content_secure est également nécessaire. Valeur par défaut : false |
audit_feedback |
Interne | Non | string | Si le créatif a échoué à l’audit créatif pour Xandr, cela inclut le raisonnement de l’équipe d’audit. |
audit_status |
équipe d’audit et client | Non | enum ('no_audit','pending','rejected','unauditable', 'audited') | Status de l’audit. Ce champ est défini par l’équipe d’audit créatif Xandr. Un élément créatif qui n’a pas audit_status « audité » peut être soumis à nouveau à l’audit en définissant le audit_status du créatif sur « en attente ». |
backup_upload_status |
Déconseillé. | |||
brand |
Client | Non | objet | Contient l’ID de la marque de l’entreprise qui annonce le créatif, le nom et le category_id. Sera audité. Conseil : Pour retourner category_name également, transmettez show_category_name=true la chaîne de requête de votre appel. |
brand_id |
Client | Non | int | Id de la marque de la société qui annonce le créatif. |
campaign |
Client | Non | string(50) | Nom (facultatif) de la campagne pour cette création , utilisé à des fins de création de rapports/gestion. |
categories |
équipe d’audit | Non | Liste des ints | ID des catégories associées au créatif : consultez Service de catégorie. Pour GET, ils sont retournés uniquement si vous utilisez l’indicateur attributes=true dans l’URL de la requête. |
click_action |
Non | Non | string | 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, « cliquer sur le web ». Par défaut : click-to-web |
click_target |
Non | Non | string | 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. |
click_trackers |
Déconseillé. | |||
click_url |
Client | oui (quand creative.format est image) | string(1000) | Ne fonctionne pas pour les clients soumissionnaires. |
code |
Client | Non | string (100) | Code membre du créatif ; utilisé à des fins de mappage d’ID externe uniquement (voir Réponse d’enchère entrante des soumissionnaires). |
content |
Client | non (si media_url existe) | text | Contenu javascript brut ou html du créatif utilisé au lieu d’un media_url. |
content_secure |
Client | non (si media_url_secure existe) | text | Contenu Javascript ou HTML lorsque « format » est « raw-js » ou « iframe-html » servi sur un appel publicitaire sécurisé. |
created_on |
Interne | Non | Timestamp | Horodatage lorsque la création a été initialement chargée sur Xandr |
creative_upload_status |
Déconseillé. | |||
description |
Non | string (400) | Description facultative associée au créatif. | |
filter |
Déconseillé. | |||
flash_backup_url |
Non | string | Sauvegarde des créations au format Flash, qui sera servie si le navigateur de l’utilisateur ne prend pas en charge flash. | |
flash_click_variable |
Client | Non | string | Pour les créatifs flash uniquement. La tentative d’accéder à POSTPUT ce champ pour les créations non flash n’est pas activée. Il s’agit du nom de la variable Flash clickTAG dans laquelle Xandr insère une URL de suivi des clics (si le suivi des clics est activé) qui sera suivie lorsque l’utilisateur clique sur le créatif. Consultez le guide du concepteur Adobe sur la configuration d’un fichier Flash pour utiliser la variable clickTAG. |
format |
Déconseillé. | |||
height |
Client | oui | int | Hauteur du créatif en pixels. |
id |
Interne | oui (lors de la mise à jour) | int | ID du créatif ; utilisé à des fins de correspondance interne uniquement. |
impression_trackers |
Déconseillé. | |||
is_expired |
Interne | Non | valeur booléenne | Indique si la création a été servie ou modifiée au cours des 15 derniers jours. |
is_prohibited |
Interne | Non | valeur booléenne | True si le système d’audit interne Xandr a détecté un comportement malveillant lors de l’analyse de la création. Si la valeur est True, cette création ne peut pas être servie. |
is_suspicious |
Interne | Non | valeur booléenne | True si le système d’audit interne Xandr a détecté un comportement suspect lors de l’analyse du créatif. Si la valeur est True, cette création ne peut pas être servie. |
language_id |
équipe d’audit | Non | int | ID de la langue du créatif - voir Service de langue |
last_activity |
Interne | Non | Timestamp | Date et heure de la dernière modification de la création. Le fuseau horaire est UTC. En lecture seule. |
last_checked |
Interne | Non | Timestamp | Horodatage de la dernière vérification de l’EXISTENCE de l’URL. |
media_subtypes |
Déconseillé. | |||
media_url |
Client | non (si le contenu existe) | string(1000) | L’URL du créatif peut être image, flash, html, javascript. L’URL doit exister et doit se trouver sur un CDN ou un équivalent. |
media_url_secure |
Client | non (si content_secure existe) | string(1000) | L’URL de l’élément créatif sécurisé (https) peut être image, flash, HTML, javascript à servir lors d’un appel publicitaire sécurisé. L’URL doit exister et doit se trouver sur un CDN ou un équivalent. |
member_id |
Client | Non | int | ID du membre auquel appartient cette création. Cela est spécifié dans l’URI de l’appel d’API et n’a pas besoin d’être également dans le JSON. |
mobile |
Client | Non | objet | Informations nécessaires pour que les créatifs mobiles réussissent l’audit créatif. Voir Mobile ci-dessous. |
native |
Déconseillé. | |||
native_attribute |
Client | oui (obligatoire pour les publicités natives avec le modèle 39461) | objet | Il s’agit de l’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. |
no_iframes |
Déconseillé. | |||
no_iframes |
Déconseillé. | |||
not_found |
Interne | Non | valeur booléenne | Nombre de fois où le chargement de l’URL a échoué. Après un certain nombre de vérifications, le créatif se désactive. |
original_content |
Interne | Non | string | Ce champ est à titre de référence uniquement. Lorsqu’une balise avec du contenu tiers est chargée sur Xandr, le contenu d’origine chargé avec le créatif est stocké dans ce champ. Par défaut : Obligatoire sur : POST lors de l’envoi en tant que type raw-html. |
original_content_secure |
Interne | Non | string | Voir original_content. Il s’agit de la version sécurisée de ce contenu. |
passed_sherlock_audit |
Interne | Non | valeur booléenne | Indique si la création a été récemment vérifiée par le système d’audit créatif automatisé Xandr (« Sherlock »). |
pixel_type |
Déconseillé. Utilisez le champ à la pixels place. |
|||
pixel_url |
Déconseillé. Utilisez le champ à la pixels place. |
|||
pixel_url_secure |
Déconseillé. Utilisez le champ à la pixels place. |
|||
pixels |
Client | Non | 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. |
placement |
Client | Non | string(50) | Nom (facultatif) du placement pour cette création de contenu , utilisé à des fins de création de rapports/de gestion. |
pop_values |
Déconseillé. | |||
segments |
Client | Non | 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. Exemple : "segments": [ { "id": 11111, "action": "add_on_view" }, { "id": 22222, "action": "add_on_click" } ] |
size_in_bytes |
Interne | Non | int | Taille du fichier multimédia en octets. |
sla |
Client | Non | entier | Délai cible lors de la demande d’audit de plateforme. La valeur 0 est standard, 2 est prioritaire/pressée. La valeur par défaut est 0. Remarque : Lors de la demande d’un audit standard, l’API remplit ce champ avec une valeur null. |
ssl_status |
équipe d’audit | Non | enum('disabled','pending','approved','failed') | Seuls les créatifs avec ssl_status = approuvé peuvent servir sur un inventaire sécurisé.
Remarque : Si un élément 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 par « en attente ». Par défaut : 'disabled' |
state |
Interne | Non | enum | État du créatif. Les valeurs possibles sont « active » ou « inactive » |
status |
Client | Non | objet | Le status du créatif décrivant si le créatif est prêt à servir. Pour plus d’informations, consultez État ci-dessous. |
technical_attributes |
équipe d’audit | Non | Liste des ints | ID des attributs techniques associés à la création : consultez Service d’attributs techniques. Pour GET, ils sont retournés uniquement si vous utilisez l’indicateur attributes=true dans l’URL de la requête. |
template |
Client | oui | objet | Modèle créatif (par exemple : template_id 6 ) 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. Avertissement : Lors de l’utilisation d’un modèle pour le format « raw-html » (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 Par défaut : POST |
text_description |
Client | Oui, uniquement si le format est du texte | chaîne jusqu’à 70 caractères | Ligne inférieure de texte affichée dans un texte créatif |
text_display_url |
Client | Oui, uniquement si le format est du texte | chaîne jusqu’à 35 caractères | URL lisible affichée dans un texte créatif |
text_title |
Client | Oui, uniquement si le format est du texte | chaîne jusqu’à 25 caractères | Ligne supérieure de texte affichée dans un texte créatif |
track_clicks |
Déconseillé. | |||
track_clicks |
Déconseillé. | |||
video_attribute |
Client | Non | objet | Attributs pour les créations vidéo tierces in-stream (VAST). Pour plus d’informations, consultez Attribut vidéo ci-dessous. |
width |
Client | oui | int | Largeur du créatif en pixels. |
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. Avertissement : Vous devez fournir une URL pouvant être auditable pour que votre créatif réussisse l’audit. |
L’audio
| Champ | Type | Description |
|---|---|---|
click_target |
string | La cible du click_action, qui est l’action que l’appareil doit effectuer lorsque l’utilisateur clique sur le créateur. Entrez une URL que notre équipe d’audit peut utiliser pour vérifier la marque et les attributs de votre création audio. Vérifiez que le site vers lequel pointe l’URL est dans la même langue que l’audio. Cette URL est utilisée uniquement à des fins d’audit. Avertissement : Vous devez fournir une URL pouvant être auditable pour que votre créatif réussisse l’audit. |
Attribut vidéo
L’ID de modèle pour video_attribute est 6439 - Vidéo : Standard VAST (accepte également VPAID), et l’objet inclut les champs suivants :
Remarque
Audio L’objet d’attribut vidéo est également utilisé pour créer des créations audio. L’ID de modèle pour l’audio est 38745 - Xandr Audio Template (VAST). Les URL XML et les URL de fichier audio sont acceptées.
VASTE case activée. Lors de l’ajout d’une création vidéo VAST ou VPAID tierce, une série de vérifications sont effectuées sur le xml. Il existe différentes sorties que vous pouvez voir et des mesures correctives peuvent être prises. Pour plus d’informations, consultez VAST Check .
| Champ | Type | Description |
|---|---|---|
duration_ms |
double | Durée, en millisecondes, de la création vidéo en flux (VAST). Cette valeur doit être supérieure à 0. |
is_skippable |
valeur booléenne | Si truela valeur est , la création vidéo en flux (VAST) est skippable. Seules les créations vidéo vast pouvant être skippables tierces sont prises en charge ; par conséquent, quand is_skippable a la valeur true, is_hosted doit être false. |
wrapper |
objet | Wrapper de document VAST qui contient le elements tableau et le trackers tableau. |
Wrapper d’attribut vidéo
L’objet wrapper contient les champs suivants :
| Champ | Type | Description |
|---|---|---|
elements |
tableau | Éléments du wrapper VAST. |
secure_url |
string | URL sécurisée du document VAST. |
url |
string | URL du document VAST. |
Élément wrapper d’attribut vidéo
Le elements tableau contient les champs suivants :
Au moins un élément doit être spécifié.
| Champ | Type | Description |
|---|---|---|
trackers |
tableau | Traqueurs d’événements VAST. |
type |
string | En lecture seule. Type d’élément. Valeur possible : « linéaire » |
vast_element_type_id |
int | ID d’élément VAST. Valeur possible : 1linéaire |
Suivis d’événements d’attribut vidéo
Vous pouvez supprimer des pixels sur chaque événement que nous suivons dans les rapports (voir vast_event_type_id ci-dessous). Ajoutez le ou les pixels comme trackers sur le créatif. Le trackers tableau contient les champs suivants :
| Champ | Type | Description |
|---|---|---|
event_type |
string | En lecture seule. Type d’événement correspondant à vast_event_type_id. |
is_segment_pixel |
valeur booléenne | Définit le pixel en tant que pixel de segment et garantit que l’id utilisateur de cet événement est ajouté au segment, quel que soit le type d’appareil. Valeur par défaut = false. Si cette valeur est définie sur true, l’URL doit être configurée au format standard : https://ib.adnxs.com/seg?add=segmentID, sinon, vous recevrez une erreur. |
name |
string | Nom du suivi d’événements. |
secure_url |
string | URL sécurisée du suivi des événements. |
url |
string | URL du suivi d’événements. |
vast_event_type_id |
int | ID de l’événement VAST. Valeurs possibles : - 1 : service - 2 : démarrer - 3 : ignorer - 4 : erreur - 5 : first_quartile - 6 : point médian - 7 : third_quartile - 8 : achèvement - 9 : impression - 10 : clic |
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. |
Voici les ID de modèle standard pour les formats créatifs les plus courants.
| ID | Format | Nom |
|---|---|---|
1 |
url-html | Bannière standard |
2 |
url-js | Bannière standard |
3 |
Flash | Bannière standard |
4 |
image | Bannière standard |
5 |
raw-js | Bannière standard |
6 |
raw-html | Bannière standard |
7 |
iframe-html | Bannière standard |
8 |
url-xml | vidéo In-Banner |
9 |
url-html | Popup |
10 |
url-js | Popup |
11 |
Flash | Popup |
12 |
image | Popup |
13 |
raw-js | Popup |
14 |
raw-html | Popup |
15 |
iframe-html | Popup |
6439 |
VASTE, VPAID | Standard VAST |
Pour les créations extensibles, consultez la page Expandables et Rich Media pour plus d’informations.
É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 » Valeur par défaut : true |
hosted_assets_association_complete |
booléen / null | En lecture seule. É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. |
Attribut natif
L’objet native_attribute contient les champs suivants. Pour plus d’informations, consultez Ajout d’un créatif natif dans les exemples .
| Champ | Type | Description |
|---|---|---|
data_assets |
tableau d’objets | Attributs de la création native. Pour plus d’informations , consultez Ressources de données ci-dessous. |
image_assets |
tableau d’objets | Attributs de chaque image individuelle. Pour plus d’informations, consultez Ressources d’image . |
image_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’images ci-dessous. |
javascript_trackers |
tableau d’objets | Liste d’URL de suivi d’impression tierces. Pour plus d’informations, consultez Suivis Javascript ci-dessous. Toutes les macros OpenRTB et Xandr sont prises en charge pour ce champ, à l’exception de ${AUCTION_PRICE} et ${PRICE_PAID}. |
link |
objet | URL associées à la création native. Pour plus d’informations, voir Lien ci-dessous. |
privacy_url |
string | 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 | Attributs des ressources vidéo. Pour plus d’informations, consultez Ressources vidéo. |
Remarque
Utilisez image_trackers pour les suivis d’impression et link.trackers pour les suivis de clics.
Liens
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 |
|---|---|---|
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. Il doit s’agir d’un tableau de suivi des clics. Pour plus d’informations, consultez Suivis ci-dessous. |
url |
string | Page d’accueil de la création native. Obligatoire le : POST,PUT |
Remarque
Par défaut, toutes les créations natives sont soumises pour un 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 de « https », la création est envoyée pour un audit sécurisé.
Trackers
| Nom | Type | Description |
|---|---|---|
url |
string | URL de suivi d’impression tierce. Celui-ci doit contenir votre traceur d’impression. |
url_secure |
chaîne | URL de suivi d’impression tierce (qui utilise SSL). Celui-ci doit contenir votre traceur d’impression. |
Suivis d’images
| Nom | Type | Description |
|---|---|---|
url |
string | URL de suivi d’impression tierce. Celui-ci doit contenir votre traceur d’impression. |
url_secure |
chaîne | URL de suivi d’impression tierce (qui utilise SSL). Celui-ci doit contenir votre traceur d’impression. |
Suivis Javascript
| Nom | Type | Description |
|---|---|---|
url |
string | URL de suivi Javascript tierce. |
url_secure |
string | UNE URL de suivi Javascript tierce (qui utilise SSL) |
Ressources de données
L’objet data_assets inclut les champs suivants :
| Champ | Type | Description |
|---|---|---|
data_type |
string | Type de ressource pour la création native. Valeurs possibles : - sponsored_by -Titre -Description -Évaluation - call_to_action - display_url -Aime -Téléchargements -Prix - sale_price -Téléphone -Adresse - additional_description |
value |
string | Description du data_type asset que vous avez spécifié. - « sponsored_by » - nom de marque du sponsor - « title » - titre du créatif - « description » : description du produit ou du service annoncé - « rating » : évaluation du produit proposé - « call_to_action » - action suggérée pour l’étape suivante - « display_url » : l’URL que vous souhaitez afficher - « J’aime » - J’aime sur les réseaux sociaux - « téléchargements » - nombre de téléchargements/installations de ce produit - « price » - Prix pour l’achat produit/application/in-app - « sale_price » : prix de vente qui peut être utilisé avec le prix pour indiquer un prix réduit - « téléphone » - numéro de téléphone « adresse » - adresse - « additional_description » : version plus longue de la description de votre annonce |
Ressources d’image
L’objet image_assets inclut les champs suivants :
| Champ | Type | Description |
|---|---|---|
creative_asset_image |
objet | Objet contenant les détails de la ressource créative. Requis pour les créations natives tierces. Consultez les détails de l’image de ressource créative ci-dessous. |
image_type |
string | Format de l’image. Les valeurs admises sont les suivantes : - icon_image - main_image |
Image de ressource créative
| Champ | Type | Description |
|---|---|---|
height |
int | Hauteur de l'image. La valeur doit être > 0 |
url |
string | URL de l’image. |
url_secure |
string | URL sécurisée de l’image. |
width |
int | Largeur de l'image. La valeur doit être > 0 |
Ressources vidéo
L’objet video_assets inclut les champs suivants :
| Champ | Type | Description |
|---|---|---|
video_creative_id |
int | ID créatif Xandr de la ressource vidéo associée à la création native. Remarque : Un créateur vidéo distinct doit d’abord être inscrit avant d’inscrire un créateur vidéo natif. |
Pixels
Vous utilisez ce tableau pour ajouter jusqu’à cinq pixels personnalisés et approuvés par Xandr à une création.
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. Consultez l’exemple « Ajout d’un pixel approuvé par Xandr à un objet créatif » ci-dessous pour obtenir des conseils supplémentaires. Notez que 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 plus d’informations, consultez l’exemple Ajout d’un pixel personnalisé à un élément créatif ci-dessous.
| Champ | Type | Description |
|---|---|---|
content |
string (255) | Si le format de pixel est « raw-js », le contenu HTML ou JavaScript à servir avec le créatif. |
format |
enum | Format du pixel. Valeurs possibles : « raw-js », « url-html », « url-js » ou « url-image ». |
id |
int | En lecture seule. ID du pixel. |
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 pixel](pixel-template-service .md). |
param_2 |
string | 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. |
pixel_template_id |
int | ID du pixel approuvé par Xandr. Vous pouvez utiliser le service de modèle de pixels pour obtenir cet ID. |
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. |
Segments
Ces champs seront inclus dans le tableau Segments :
| Champ | Type | Description |
|---|---|---|
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 |
id |
int | ID du segment. Obligatoire sur : POST, PUT |
name |
chaîne | Nom du segment. |
segment_id |
int | ID du segment. Ce champ contient les mêmes informations que le champ id. |
| Champ | Type | Description |
|---|---|---|
landing_page_url |
string | URL de la page d’accueil entrée par l’administrateur Xandr pendant le processus d’audit. Par défaut : null |
thirdparty_campaign_id |
int |
En lecture seule. Si la campagne a été synchronisée avec un tiers, il s’agit de l’ID dans le système tiers. Par défaut : null |
thirdparty_creative_id |
int |
En lecture seule. Si la création a été synchronisée avec un tiers tel que Yahoo Ad Exchange, il s’agit de l’ID dans le système tiers. Si un problème survient avec la synchronisation, vous pouvez rétablir la valeur thirdparty_creative_id Null avec l’appel PUT suivant : $ curl -b cookies -c cookies -X PUT -d '{"creative":{}}' 'https://api.adnxs.com/creative/MEMBER_ID/CREATIVE_ID&reset_thirdparty_creative_id'Par défaut : null |
Modifications qui provoquent Re-Audit
Une fois qu’un créatif a réussi l’audit Xandr (audit_status est « audité »), la modification de l’un des champs suivants entraîne la soumission du créatif pour audit (allow_audit est défini sur « en attente ») :
- largeur
- height
- contenu
- 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 est créatif et passe de false à true)
- video_attribute
- media_assets
En outre, si le audit_status est « no_audit », la modification de allow_audit de « false » à « true » entraîne la soumission du créatif pour l’audit Xandr.
Exemples
Ajout d’un élément créatif
$ cat creative
{
"creative":
{ "width" : 300,
"height" : 250,
"media_url" : "https://ad.doubleclick.net/adi/ABC.Advertising.com/DEF.40;sz=300x250;click0=",
"template":{
"id": 1
}
}
}
$ curl -b cookies -c cookies -X POST -d @creative.json "https://api.adnxs.com/creative/5"
{
"response": {
"status": "OK",
"count": 1,
"id": 703355,
"creative": {
"id": 703355,
"active": true,
"member_id": 5,
"description": null,
"code": null,
"code2": null,
"media_url": "https:\/\/ad.doubleclick.net\/adi\/ABC.Advertising.com\/DEF.40;sz=300x250;click0=",
"audit_status": "pending",
"allow_audit": true,
"size_in_bytes": 0,
"last_checked": null,
"not_found": 0,
"added_by_bidder": null,
"campaign": null,
"placement": null,
"format": null,
"width": 300,
"height": 250,
"click_url": null,
"landing_page_url": null,
"flash_click_variable": null,
"no_iframes": false,
"content": null,
"original_content": null,
"track_clicks": true,
"audit_feedback": null,
"created_on": "2013-10-31 21:17:17",
"flash_backup_url": null,
"is_self_audited": false,
"file_name": null,
"is_prohibited": false,
"last_activity": "2013-10-31 21:17:17",
"passed_sherlock_audit": true,
"is_expired": false,
"creative_upload_status": null,
"backup_upload_status": null,
"filter": null,
"is_suspicious": false,
"suspicious_activity_timestamp": null,
"media_subtypes": [
"banner"
],
"no_adservers": false,
"is_blanking": false,
"is_rotating": false,
"text_title": null,
"text_description": null,
"text_display_url": null,
"click_action": "click-to-web",
"click_target": null,
"ssl_status": "disabled",
"allow_ssl_audit": false,
"media_url_secure": null,
"content_secure": null,
"original_content_secure": null,
"flash_backup_url_secure": null,
"is_hosted": false,
"content_source": "standard",
"thirdparty_creative_id": null,
"thirdparty_campaign_id": null,
"custom_request_template": null,
"brand": {
"id": 1,
"name": "Unknown",
"category_id": 8
},
"language": {
"id": 1,
"name": "English"
},
"template": {
"id": 1
},
"segments": null,
"pixels": null,
"mobile": null,
"brand_id": 1,
"sla": "0",
"sla_eta": "2013-11-01 11:18:17"
}
}
}
Afficher le contenu créatif qui a été ajouté
$ curl -b cookies -c cookies 'https://api.adnxs.com/creative/5/6'
{
"response":{
"status":"OK",
"creative":{
"id": 6,
"active": true,
"member_id": 5,
"description": null,
"code": null,
"brand_id": 43,
"media_url": "https:\/\/ad.doubleclick.net\/adi\/ABC.Advertising.com\/DEF.40;sz=300x250;click0=",
"audit_status": "pending",
"allow_audit": true,
"size_in_bytes": 18467,
"last_checked": null,
"not_found": false,
"added_by_bidder": 14,
"campaign": null,
"placement": null,
"format": "url-html",
"width": 300,
"height": 250,
"click_url": "",
"flash_click_variable": null,
"pixel_url": "",
"no_iframes": false,
"content": null,
"original_content": null,
"track_clicks": true,
"pixel_type": "image",
"audit_feedback": null,
"created_on": "0000-00-00 00:00:00",
"flash_backup_url": null,
"is_self_audited": false,
"last_activity": "2008-08-26 05:41:04",
"passed_sherlock_audit": true,
"is_expired": false,
"creative_upload_status": null,
"backup_upload_status": null,
"filter": null,
"is_suspicious": false,
"suspicious_activity_timestamp": null,
"media_subtypes": [
"banner"
],
"no_adservers": false,
"is_blanking": false,
"is_rotating": false,
"text_title": null,
"text_description": null,
"text_display_url": null,
"click_action": "click-to-web",
"click_target": null,
"ssl_status": "disabled",
"allow_ssl_audit": false,
"media_url_secure": null,
"content_secure": null,
"original_content_secure": null,
"flash_backup_url_secure": null,
"is_hosted": false,
"content_source": "standard",
"thirdparty_creative_id": null,
"thirdparty_campaign_id": null,
"custom_request_template": null,
"brand": {
"id": 5,
"name": "Adobe",
"category_id": 27
},
"language": {
"id": 16,
"name": "Norwegian"
},
"template": {
"id": 1
},
"segments": null,
"pixels": null,
"mobile": null,
"brand_id": 5,
"sla": null,
"sla_eta": null
}
}
}
Modification d’un élément créatif
Si vous décidez ensuite d’ajouter un nom de campagne « Triple Play - Octobre 2008 » à la création à des fins de création de rapports :
$ cat creative_mod
{"creative" : {
"campaign":"Triple Play - October 2008"
}
}
$ curl -b cookies -c cookies -X PUT --data-binary @creative_mod 'https://api.adnxs.com/creative/5/6'
{
"response":{
"status":"OK",
"id":6
}}
Et puis pour afficher la modification :
$ curl -b cookies -c cookies 'https://api.adnxs.com/creative/5/6'
{
"response": {
"creatives": [
{
"id": 6,
"active": true,
"member_id": 5,
"description": null,
"code": null,
"brand_id": 43,
"media_url": "https:\/\/ad.doubleclick.net\/adi\/ABC.Advertising.com\/DEF.40;sz=300x250;click0=",
"audit_status": "pending",
"allow_audit": true,
"size_in_bytes": 18467,
"last_checked": null,
"not_found": 0,
"added_by_bidder": 14,
"campaign": "Triple Play - October 2008",
"placement": null,
"format": "url-html",
"width": 300,
"height": 250,
"click_url": "",
"flash_click_variable": null,
"pixel_url": "",
"no_iframes": false,
"content": null,
"original_content": null,
"track_clicks": true,
"pixel_type": "image",
"audit_feedback": null,
"created_on": "2008-08-26 05:41:04",
"flash_backup_url": null,
"last_activity": "2008-09-14 06:20:04"
}
],
"status": "OK"
}
}
Soumettre un élément créatif à des fins d’audit
Si vous souhaitez demander un audit pour un créatif, celui-ci doit être actif et avoir le allow_audit champ défini sur true :
$ cat creative_mod
{"creative" : {
"audit_status": "pending",
"allow_audit" : true
}
}
$ curl -b cookies -c cookies -X PUT --data-binary @creative_mod 'https://api.adnxs.com/creative/5/6'
{
"response":{
"status":"OK",
"id":6
}}
Annuler une créativité et soumettre à nouveau pour l’audit
Si un élément créatif a expiré, vous pouvez le mettre à jour avec ces paramètres pour définir le status sur « en attente » et soumettre à nouveau le créatif pour audit. Notez qu’à compter de novembre 2017, les créations expirées depuis plus d’un an seront définitivement supprimées. Pour plus d’informations, consultez « Stratégie de création expirée » en haut de cette page.
$ cat unexpire_creative
{
"creative": {
"audit_status": "pending",
"allow_audit": true,
"status": {
"user_ready": true
}
}
}
Envoyer une création mobile pour audit
Cet exemple utilise le nouvel mobile objet :
$ cat mobile_creative
{
"creative" : {
"audit_status": "pending",
"allow_audit" : true,
"mobile" : {
"alternative_landing_page_url" : "https://..."
}
}
}
$ curl -b cookies -c cookies -X PUT --data-binary @creative_mod 'https://api.adnxs.com/creative/5/6'
{
"response":{
"status":"OK",
"id":6
}
}
Soumettre un élément créatif pour l’audit prioritaire
Si vous souhaitez soumettre un audit prioritaire. Définissez « sla » sur 2 (la valeur 1 n’est pas utilisée actuellement). Des frais d’audit prioritaires vous seront facturés pour votre contrat.
$ cat creative_mod
{"creative" : {
"audit_status": "pending",
"sla": 2
}
}
$ curl -b cookies -c cookies -X PUT --data-binary @creative_mod 'https://api.adnxs.com/creative/5/6'
{
"response":{
"status":"OK",
"id":6
}}
Afficher le temps d’audit estimé pour votre création (« sla_eta »)
$ curl -b cookies -c cookies 'https://api.adnxs.com/creative/5/6'
{
"response": {
"creatives": [
{
"id": 6,
...
"audit_status": "pending",
"sla": 0,
"sla_eta": "2011-05-21 05:33:06"
}
],
"status": "OK"
}
}
Ajout d’un élément créatif (balise HTML tierce)
$ cat creative
{
"creative":
{ "width" : 300,
"height" : 250,
"media_url" : "https://ad.doubleclick.net/adi/ABC.Advertising.com/DEF.40;sz=300x250;click0=",
"template":{
"id": 1
}
}
}
$ curl -b cookies -c cookies -X POST -d @creative.json 'https://api.sand-08.adnxs.net/creative?member_id=1282'
{
"response":{
"status":"OK",
"count":1,
"start_element":null,
"num_elements":null,
"id":816447,
"creative":{
"id":816447,
"active":true,
"member_id":1282,
"description":null,
"code":null,
"code2":null,
"media_url":"https:\/\/ad.dblclick.net\/adi\/ABC.Advertising.com\/DEF.40;sz=300x250;click0=",
"audit_status":"pending",
"allow_audit":true,
"size_in_bytes":0,
"last_checked":null,
"not_found":0,
"added_by_bidder":null,
"campaign":null,
"placement":null,
"format":null,
"width":300,
"height":250,
"click_url":null,
"landing_page_url":null,
"flash_click_variable":null,
"no_iframes":false,
"content":null,
"original_content":null,
"track_clicks":true,
"audit_feedback":null,
"created_on":"2014-01-24 16:02:31",
"flash_backup_url":null,
"is_self_audited":false,
"file_name":null,
"is_prohibited":false,
"last_activity":"2014-01-24 16:02:31",
"passed_sherlock_audit":true,
"is_expired":false,
"creative_upload_status":null,
"backup_upload_status":null,
"filter":null,
"is_suspicious":false,
"suspicious_activity_timestamp":null,
"media_subtypes":[
"banner"
],
"no_adservers":false,
"is_blanking":false,
"is_rotating":false,
"text_title":null,
"text_description":null,
"text_display_url":null,
"click_action":"click-to-web",
"click_target":null,
"ssl_status":"disabled",
"allow_ssl_audit":false,
"media_url_secure":null,
"content_secure":null,
"original_content_secure":null,
"flash_backup_url_secure":null,
"is_hosted":false,
"content_source":"standard",
"thirdparty_creative_id":null,
"thirdparty_campaign_id":null,
"custom_request_template":null,
"brand":{
"id":1,
"name":"Unknown",
"category_id":8
},
"language":{
"id":1,
"name":"English"
},
"template":{
"id":1
},
"segments":null,
"pixels":null,
"mobile":null,
"brand_id":1,
"sla":"0",
"sla_eta":"2014-01-27 00:03:31"
}
Ajout d’un iframe-html creative
Le service créatif permet de créer différents types de créations. Par exemple, pour créer un objet créatif au format « iframe-html », vous devez charger le code html brut qui sera incorporé dans un iframe dans la page de diffusion de l’annonce.
$ cat iframe-html-creative
{
"creative" : {
"content":"<script type=\"text/javascript\" language=\"javascript\">
var sample_var = 350;
</script>
<script type=\"text/javascript\" language=\"javascript\" src=\"https://sample_source.com/sample_id?ord=${CACHEBUSTER}\"</script>",
"width":"300",
"height":"250",
"format":"iframe-html",
"brand_id" : 43
}
}
$ curl -b cookies -c cookies --data-binary @iframe-html-creative 'https://api.adnxs.com/creative/5'
{
"response":{
"status":"OK",
"id":7
}}
Ajout d’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.
Tout d’abord, vous devez déterminer la 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.adnxs.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": {
...
}
}
}
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.
Ensuite, vous créez le fichier au format JSON pour ajouter le pixel à la création. Dans le fichier, vous définissez pixel_template_id sur 2, et vous définissez param_1 et param_2 sur les valeurs de {P1} et {P2} dans le contenu des pixels.
Remarque
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": [
{
"pixel_template_id": 1,
"param_1":"12",
"param_2":"34"
}
]
}
}
Enfin, vous effectuez un appel PUT 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. Notez que, étant donné que le pixel icône Evidon AdChoices n’oblige pas le créatif à effectuer un audit, audit_status n’a pas été rétabli à « en attente ».
$ curl -b cookies -c cookies -X PUT -d @creative_update 'https://api.adnxs.com/creative/3/503577'
{
"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",
"member_id": 3,
...
"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": {
...
}
}
}
Ajout d’un pixel personnalisé à un élément créatif
Dans cet exemple, la requête PUT 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 fournir avec le créatif. Notez dans la réponse que audit_status est « en attente » ; Cela est dû au fait que l’ajout d’un pixel personnalisé à une création entraîne la soumission du créatif à des fins d’audit.
Remarque
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.adnxs.com/creative/3/503577'
{
"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",
"member_id": 3,
...
"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 une vidéo créative avec un objet d’attribut vidéo et un wrapper
{
"creative": {
"id": 145,
...
"template_id": 6439,
"video_attribute": {
"is_skippable": true,
"duration_ms": 21000,
"wrapper": {
"url": "http://www.doubleclick.net/...",
"secure_url": "https://www.doubleclick.net/...",
"elements": [
{
"vast_element_type_id": 1,
"name": "linear",
"trackers": [
{
"name": "startTracker",
"vast_event_type_id": 2,
"url": "http://tracker.com/...",
"secure_url": "https://tracker.com/...",
"event_type": "start"
},
{
"name": "completionTracker",
"vast_event_type_id": 8,
"url": "http://tracker.com/...",
"secure_url": "https://tracker.com/...",
"event_type": "completion"
}
]
}
]
}
}
}
}
Ajout d’une création native
Lors de l’ajout d’une création native, utilisez l’ID de modèle 39461.
cat native
{
"creative": {
"description": "native_test",
"brand_id": 1,
"media_url": "https://mediaurl.com",
"code": "test",
"code2": null,
"member_id": 4,
"state": "active",
"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": "icon_image",
"creative_asset_image": {
"url": "http://url.com",
"url_secure": "https://secureurl.com",
"height": 1,
"width": 1
}
}],
"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
}
}
$ curl -b cookies -c cookies -X POST -s @native 'https://api.adnxs.com/creative/4'
{
"response": {
"status": "OK",
"count": 1,
"id": 411,
"start_element": 0,
"num_elements": 100,
"dbg_info": {
...
},
"creative": {
"description": "native_test",
"brand_id": 1,
"media_url": "https://mediaurl.com",
"id": 411,
"code": "test",
"code2": null,
"member_id": 4,
"state": "active",
"click_track_result": "not_tested",
"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"
},
"brand": {
"id": 1,
"name": "Unknown",
"category_id": null
},
"template": {
"id": 329,
"name": "native ad",
"media_subtype_id": 17,
"format_id": 11
},
"ios_ssl_audit": null,
"adx_audit": 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": "icon_image",
"creative_asset_image": {
"url": "https://vcdn.adnxs.com/sand/creative-image/ea/f5/30/28/eaf53028-e6c6-4ac0-bcbb-ce8fe14b73ab.png",
"url_secure": "https://secureurl.com",
"height": 12,
"width": 34
}
}],
"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"
}
}
}
Détermination des atttributes techniques attribués à votre créatif
Bien que les attributs techniques ne puissent pas être ajoutés aux rapports automatisés aujourd’hui, ils peuvent être récupérés via le service Creative dans l’API du soumissionnaire. Pour plus d’informations, reportez-vous au service d’attributs techniques.
Vous pouvez y accéder en ajoutant le paramètre de chaîne de requête « ?attributes=true » comme suit : « adnxs.com/creative/MEMBER_ID/CREATIVE_ID?attributes=true »
"technical_attributes": [
{
"id": 2,
"name": "Flash"
},
{
"id": 9,
"name": "Initial Load > 40kb"
},
{
"id": 13,
"name": "Banner has AdChoices Icon"
},
{
"id": 15,
"name": "Animated: 15 seconds or less"
}
]
Le meta service fournit les informations les plus récentes sur l’interface avec les objets de notre API.
Macros créatives
Le bus d’impression prend en charge deux types de macros créatives remplacées en temps réel : les macros Xandrcreative prédéfinies et les macros personnalisées qui peuvent être définies par le soumissionnaire. La main différence entre les deux est la perspective. Par exemple, le bus d’impression n’a pas connaissance d’une campagne ou d’un ordre d’insertion lorsqu’une enchère en temps réel est placée. Par conséquent, tous les objets pris en charge avec le modèle objet interne d’un soumissionnaire et requis dans une macro doivent être pris en charge à l’aide de macros personnalisées.
Avertissement
Macro Restrictions
Seules les macros Xandr prédéfinies et les macros personnalisées sont prises en charge lors de l’inscription de créations.
N’utilisez PAS de macros OpenRTB lors de l’inscription de créations. Les macros OpenRTB sont destinées à être utilisées uniquement dans la réponse d’enchère.
Ne donnez pas à une macro personnalisée un nom qui correspond au nom d’une macro OpenRTB.
Macros créatives Xandr
Consultez Macros Xandr pour obtenir la liste complète des macros créatives disponibles.
Cliquez sur Exemple de suivi :
"media_url": "https://ad.doubleclick.net/adi/N5364.Ivillage.com/B2965815.5;sz=728x90;click0=${CLICK_URL};ord=${CACHEBUSTER}?"
Macros personnalisées
En utilisant custom_macro fonctionnalité dans la réponse d’enchère, vous pouvez passer dynamiquement dans les créations préinscrites. Par instance, si vous souhaitez toujours retourner un code de campagne et de création de rapports particulier, vous pouvez configurer votre créativité comme suit :
{
"creative":{
"media_url":"https://adserver.com/imp?z=300x250;camp=${CAMPAIGN_ID};int=${INT_CODE}",
"format":"url-html",
"width":"300",
"height":"250"
}}
Ensuite, lorsque votre soumissionnaire répond à une enchère, la réponse de l’offre peut spécifier le nom et la valeur des macros à remplacer, en incluant, par exemple :
"custom_macros":[
{
"name":"CAMPAIGN_ID",
"value":"452346"
},
{
"name":"INT_CODE",
"value":"a352-45we-sdr3"
}]
Remarque
Même si la valeur est un entier, elle doit être placée entre guillemets (par exemple, "42").
<iframe src="https://adserver.com/sz=300x250;camp=452346;int=a352-45we-sdr3" width=300 height=250/>