Macros Xandr

Les macros sont utilisées pour remplir les URL (telles que celles qui se trouvent dans les créations) avec des informations utiles. Il s’agit essentiellement de variables développées par notre serveur publicitaire, quelle que soit leur valeur réelle au moment de l’appel publicitaire.

Cette page contient des informations sur toutes les macros que nous prenons en charge. Pour chaque macro, nous listons les informations par lesquelles cette macro est remplacée pendant l’appel publicitaire.

Conseil

Pour plus de contrôle sur l’encodage et le décodage d’URL, consultez la section macros de fonction.

Pour obtenir des exemples supplémentaires sur la façon dont les macros peuvent être > utilisées lors du chargement de créations, reportez-vous à la page Creative Service .

Macros créatives

Avertissement

Les macros OpenRTB (comme ${AUCTION_PRICE}) ne sont pas prises en charge lors de l’ajout de créations à l’aide de Creative Service. Elles ne sont prises en charge que dans la réponse d’enchère.

Xandr prend en charge les macros créatives suivantes lors de l’ajout de créations à l’aide de Creative Service.

Macro	Description
`${CLICK_URL}`	URL de suivi des clics.
`${CLICK_URL_ENC}`	URL de suivi des clics encodée (nécessaire uniquement pour certains serveurs d’annonces tiers)
`${AUCTION_ID}`	Chaîne de caractères 64 bits représentant l’enchère individuelle qui a conduit à l’impression.
`${TAG_ID}`	ID Xandr TinyTag à l’origine de la demande d’offre
`${EXT_APP_ID}`	Identificateur externe de l’application demandant l’impression. Cela est particulièrement utile pour les impressions des applications mobiles.
`${CREATIVE_ID}`	ID créatif qui a gagné l’impression.
`${DEAL_ID}`	ID de transaction Xandr associé à l’enchère gagnante, le cas échéant. S’il n’y a pas d’accord, cela retournera 0.
`${ECP}`	Le côté éditeur Estimation du prix clair pour la vente aux enchères.
`${RESERVE_PRICE}`	Prix de réserve fixé par l’éditeur.
`${SESSION_FREQ}`	Fréquence de session de l’utilisateur.
`${AGE}`	Âge de l’utilisateur (si disponible). Entier (par exemple, 26) ou 0.
`${GENDER}`	Sexe de l’utilisateur (si disponible). Les valeurs sont 'f','m','u'.
`${CACHEBUSTER}`	Chaîne de nombre aléatoire utilisée pour limiter la mise en cache de l’URL
`${PRICE_PAID}`	Le prix payé pour cette impression. (Par opposition à l’offre de prix, avant la réduction de prix.)
`${SECOND_PRICE}`	Prix qui représente la deuxième offre la plus élevée dans l’enchère. Exprimé au format numérique à virgule flottante (par exemple, 1,23)
`${REFERER_URL}`	Si disponible, l’URL de référence pour cet inventaire. Remarque : Ce champ est déconseillé (depuis mai 2016). Utilisez ${REFERER_URL_ENC} à la place.
`${REFERER_URL_ENC}`	URL de référence encodée.
`${BID_PRICE}`	Offre de prix pour cette impression par opposition au prix payé après la réduction du prix.
`${TAG_CODE1}`	Code d’intégration défini sur le placement.
`${TAG_CODE2}`	Code d’intégration supplémentaire défini sur le placement.
`${INV_SOURCE_ID}`	Déconseillé.
`${USER_ID}`	Chaîne de caractères Xandr 64 bits représentant l’utilisateur pour l’impression.
`${USER_IP}`	Adresse IP de l’utilisateur.
`${IS_PREVIEW}`	Si nous « prévisualisons » le créatif, nous pouvons passer un indicateur au serveur tiers afin qu’ils ne le comptent pas comme une impression de production. Si la valeur est true, nous passons un « 1 » ; si la valeur est false, nous transmettons un « 0 ».
`${SELLER_MEMBER_ID}`	Membre propriétaire de l’éditeur d’où provient l’impression.
`${SEG_IDS}`	ID des segments appartenant à l’acheteur gagnant dans le cookie de cet utilisateur (dans l’ordre de l’heure de dernière consultation). Notez que cette macro ne fonctionne pas pour les segments partagés (tels que ceux appartenant à un fournisseur de données tiers).
`${SEG_CODES}`	Codes pour les segments appartenant à l’acheteur gagnant dans le cookie de cet utilisateur (par ordre d’heure de dernière consultation). Notez que cette macro ne fonctionne pas pour les segments partagés (tels que ceux appartenant à un fournisseur de données tiers).
`${DATACENTER}`	ID du centre de données (1 = NYM, 2 = LAX, 3 = AMS)
`${USER_CITY}`	Chaîne de caractères de la ville de l’utilisateur
`${USER_STATE}`	Chaîne de caractères de l’état de l’utilisateur (abréviation de 2 lettres. FIPS 10-4 en dehors des États-Unis et du Canada)
`${SITE_ID}`	ID du site sur lequel l’impression est servie
`${PUBLISHER_ID}`	ID de l’éditeur vendant l’impression
`${PUBLISHER_CODE}`	Code de l’éditeur vendant l’impression (si disponible)
`${CREATIVE_CODE}`	Code du créatif servi (si disponible)
`${CREATIVE_SIZE}`	Largeur x Hauteur du créatif servi (par exemple, `"300x250"`)
`${WIDTH}`	Largeur du créatif servi
`${HEIGHT}`	Hauteur de la créativité servie
`${SUPPLY_TYPE}`	Cette macro est remplie avec une valeur numérique qui indique le type de fourniture de l’impression. Les valeurs autorisées sont notamment les suivantes : 0 : web 1 : web mobile 2 : application mobile 4 : barre d’outils
`${TIMESTAMP}`	Horodatage UNIX pour la vente aux enchères.
`${USER_AGENT}`	Chaîne de l’agent utilisateur de l’en-tête HTTP de la requête. L’agent utilisateur identifie souvent des informations telles que l’application, le système d’exploitation et le fournisseur de logiciels agissant au nom de l’utilisateur (par exemple, « Mozilla/5.0 (Macintosh ; U; Intel Mac OS X 10.5 ; en-US ; rv :1.9.0.4) Gecko/2008102920 Firefox/3.0.4").
`${USER_AGENT_ENC}`	Chaîne d’agent utilisateur encodée à partir de l’en-tête HTTP de la requête.
`${EXTENDED_IDS}`	Les identificateurs (ID de secteur et ID fournis par l’éditeur) représentent l’utilisateur de l’impression. Ceux-ci sont passés comme reçus dans la demande, avec plusieurs identificateurs pris en charge suivant le format : `…&extended_ids=<source_1>,<id_1>\ <source_2>,<id_2>\ …` Les séparateurs proposés sont des virgules entre la source et la valeur, et un symbole de canal entre différents types d’ID et paires valeur.

Inventaire européen des annonces et notification, transparence et choix

Avertissement

Pour que nos clients répondent à leurs exigences de transparence, de notification et de choix/consentement en vertu de la loi sur la confidentialité de l’État américain, du RGPD et de la directive ePrivacy existante, Xandr prend en charge iAB Europe Transparency & Consent Framework (le « Framework »).

Il s’agit d’une référence pour les éditeurs qui utilisent les macros pour afficher la notification, la transparence et le choix aux utilisateurs finaux situés dans les États américains applicables et dans l’EEE et signaler les fournisseurs approuvés, et, si nécessaire, transmettre le consentement et/ou Ne pas partager/vendre des signaux à Xandr et à des sources de demande et leurs fournisseurs via la plateforme de Xandr.

Cette ressource ne doit pas être interprétée comme un conseil juridique et Xandr ne donne aucune garantie quant au respect d’une loi ou d’une réglementation. Veuillez noter que étant donné que chaque entreprise et sa collecte, utilisation et stockage de données personnelles sont différents, vous devez également demander des conseils juridiques indépendants concernant les obligations en vertu de la législation de l’État américain, des réglementations européennes, y compris le RGPD et la directive ePrivacy existante. Seul un avocat peut vous fournir des conseils juridiques adaptés à votre situation. Rien dans ce guide n’est destiné à vous fournir, ou ne doit être utilisé comme un substitut, des conseils juridiques adaptés à votre entreprise.

Notez que nos stratégies de partie de service (pour l’achat, la vente et les fournisseurs de données) incluent des obligations spécifiques à la confidentialité que vous devez connaître. Ces stratégies de service ont été mises à jour à compter du 1er janvier 2023.

Macro	Description
`${GDPR_APPLIES}`	Indique si les réglementations RGPD sont appliquées. Plus précisément, il indique si l’utilisateur se trouve dans un pays concerné par le RGPD, ou si un signal RGPD requis par le RGPD a été transmis avec la demande. 1 si oui, 0 si non.
`${GDPR}`	Offre la même fonctionnalité que `${GDPR_APPLIES}`.
`${GDPR_CONSENT_STRING}`	Il s’agit de la chaîne de consentement RGPD IAB. Si le RGPD s’applique, une liste de fournisseurs approuvés par l’utilisateur est établie en fonction de l’infrastructure de transparence et de consentement du RGPD IAB.
`${GDPR_CONSENT}`	Il s’agit de la chaîne de consentement RGPD IAB conformément à la spécification officielle TCF 1.0. Il est inclus pour maintenir la compatibilité descendante par souci de commodité du client.
`${GDPR_CONSENT_[0-9]+}`	Par exemple, GDPR_CONSENT_1, GDPR_CONSENT_12345, etc. Tous ces éléments sont résolus en la même chaîne de consentement RGPD que celle expliquée ci-dessus dans `'${GDPR_CONSENT_STRING}'`.
`${GPP_SID}`	Indique si une section (c’est-à-dire le cadre réglementaire) de la plateforme globale de confidentialité doit être appliquée. Plus précisément, il indique si l’utilisateur se trouve dans un pays concerné par la législation couverte par le GPP.
`${GPP_STRING_XXXXX*}`	Il s’agit de la chaîne GPP ( Global Privacy Platform ) IAB. Si une section du GPP s’applique, celle-ci contient des informations dépendantes de l’infrastructure reflétant les élections de consentement de l’utilisateur. Remarque : * XXXXX peut représenter n’importe quel ID numérique

Le tableau suivant contient des noms de macro réservés qui ne sont pas destinés aux clients soumissionnaires. Elles entraînent des conflits avec d’autres technologies Xandr et ne doivent pas être utilisées pour les macros personnalisées.

Nom de la macro réservée
`${ADV_CODE}`
`${ANCOST}`
`${BASE64_UID_ENC}`
`${BASE64_UID}`
`${BIDPRICE}`
`${CND}`
`${CONTENT}`
`${CREATIVE_HEIGHT}`
`${CREATIVE_WIDTH}`
`${FLASH_BACKUP_URL}`
`${FLASHVARS}`
`${IE7_FLASH_JS_URL}`
`${IF_CALLBACK_URL}`
`${IO_CODE}`
`${IO_ID}`
`${IS_PREVIEW_COL}`
`${IT_CALLBACK_URL}`
`${MATCHED_PROFILE_CODE}`
`${MATCHED_PROFILE_ID}`
`${MEDIA_SUBTYPE}`
`${MEDIA_TYPE}`
`${MEDIA_URL_ENC}`
`${MEDIA_URL}`
`${PMT_RULE_CODE}`
`${POP_CALLBACK_URL}`
`${POP_CREATIVE_MAXIMIZED}`
`${POP_IS_PREPOP}`
`${POP_IS_TAG_INITIATED}`
`${POP_WINDOW_LOCATION}`
`${POP_WINDOW_MENUBAR}`
`${POP_WINDOW_RESIZABLE}`
`${POP_WINDOW_SCROLLBARS}`
`${POP_WINDOW_STATUSBAR}`
`${POP_WINDOW_TITLE}`
`${POP_WINDOW_TOOLBARS}`
`${PRICE_PAID_ENCR}`
`${PT1}`
`${PT2}`
`${PT3}`
`${PT4}`
`${PT5}`
`${SECOND_LEVEL_CATEGORY_ID}`
`${SEG_CODES_COL}`
`${SITE_CODE}`
`${SSP_DATA}`
`${TAG_HEIGHT}`
`${TAG_WIDTH}`
`${TOP_LEVEL_CATEGORY_ID}`
`${TRACKER_ID}`
`${UID}`
`${USER_COUNTRY}`
`${VENUE_ID}`

Macros mobiles

Macro	Description
`${GEO_LAT}`	Latitude de l’emplacement de l’utilisateur, lorsque les données GPS sont disponibles à partir d’un appareil mobile. Exprimé au format « snn.ddd,snn.ddd » (par exemple, `+12.345` ou `-45.123`), où sud est représenté comme négatif. Il peut y avoir un maximum de 5 décimales de précision.
`${GEO_LON}`	Longitude de l’emplacement de l’utilisateur, lorsque les données GPS sont disponibles à partir d’un appareil mobile. Exprimé au format « snn.ddd,snn.ddd » (par exemple, `+12.345` ou `-45.123`), où west est représenté comme négatif. Il peut y avoir un maximum de 5 décimales de précision.
`${EXT_APP_ID}`	Identificateur externe de l’application demandant l’impression. Cela n’est utile que pour les impressions provenant d’applications mobiles.
`${DEVICE_MD5}`	Identificateur unique chiffré MD5 représentant l’appareil mobile.
`${DEVICE_SHA1}`	Identificateur unique chiffré sha1 représentant l’appareil mobile.
`${DEVICE_OPENUDID}`	Identificateur unique chiffré OPENUDID représentant l’appareil mobile.
`${DEVICE_ODIN}`	Identificateur unique chiffré par ODIN représentant l’appareil mobile.
`${DEVICE_AAID}`	Identificateur de publicité Android, lorsque l’impression provient d’un appareil Android.
`${DEVICE_APPLE_IDA}`	L’identificateur de publicité Apple, lorsque l’impression provient d’un appareil Apple.
`${DEVICE_MAKE_ID}`	Entier Xandr représentant l’ID de la fabrique de l’appareil mobile (par exemple, `26`). Pour obtenir la liste complète des ID de création d’appareils mobiles, consultez le service Device Make.
`${DEVICE_MODEL_ID}`	Entier Xandr représentant l’ID du modèle d’appareil mobile (par exemple, 301). Pour obtenir la liste complète des ID de modèle d’appareil mobile, consultez service de modèle d’appareil.
`${DEVICE_WIN_ID}`	ID Windows Ad de l’appareil sur lequel cette impression s’est produite (le cas échéant).
`${CARRIER_ID}`	Entier Xandr représentant l’ID de l’opérateur mobile. Pour obtenir la liste complète des ID d’opérateur mobile, consultez service d’opérateur.
`${SUPPLY_TYPE}`	Cette macro est remplie avec une valeur numérique qui indique le type de fourniture de l’impression. Les valeurs autorisées sont notamment les suivantes : 0 : web 1 : web mobile 2 : application mobile 4 : barre d’outils

Macros de fonction

Macro de fonction un type spécial de macro qui exécute une fonction sur une autre macro. Les macros de fonction peuvent être utilisées en combinaison avec n’importe quelle autre macro créative, y compris les macros personnalisées, bien que si elles ne sont pas reconnues au moment du rendu, elles ne seront pas traduites et la fonction ne sera pas appelée.

Xandr prend actuellement en charge la {$URL_ENC} macro de fonction, qui peut être utilisée à diverses fins liées à l’encodage. Un cas d’usage clé est lorsqu’une URL doit être passée d’un serveur publicitaire à un serveur publicitaire via une macro créative et, en raison de la présence de caractères non pris en charge dans la mise en forme d’URL standard, doit être encodée à différentes étapes du processus.

La macro prend la forme suivante :

 ${URL_ENC(${MACRO_NAME},#)}

où ${MACRO_NAME} est la macro à encoder et # est l’entier 1, 2ou 3, qui représente le nombre de fois où encoder le contenu. Notez que plus de trois encodages ne sont pas pris en charge.

Remarque

Chaque encodage correspond à une étape de la chaîne de redirection, ainsi qu’à la façon dont un suivi des clics tiers donné fonctionne avec la macro. Un double encodage est généralement nécessaire pour les URL de destination finale lorsqu’un deuxième serveur publicitaire est impliqué, et un encodage triple pour un troisième serveur publicitaire.

Pour déterminer si vous devez utiliser l’encodage simple, double ou triple, vous devez case activée avec votre dispositif de suivi des clics tiers, puis tester votre URL_ENC macro pour vous assurer qu’elle fonctionne. Si votre macro ne fonctionne pas, l’une des conséquences peut être la rupture de liaison, ce qui entraîne le fait que les utilisateurs n’atteignent pas l’URL de destination prévue.

Exemples d’encodage

Pour encoder une fois l’URL de clic

${URL_ENC(${CLICK_URL},1)}

Si https://xandr.com est passé en tant qu’URL de clic, l’utilisation ${URL_ENC(${CLICK_URL},1)} de pour encoder unique l’URL entraîne https%3A%2F%2Fxandr.com le remplissage de la création.

Pour encoder une fois l’URL du média :

 ${URL_ENC(${MEDIA_URL},1)}

Pour encoder deux fois l’URL du média :

 ${URL_ENC(${MEDIA_URL},2)}

Pour encoder une macro personnalisée appelée ADFORMAT une fois :

${URL_ENC(${ADFORMAT},1)}

Last updated on 2025-04-01

Partager via