For the complete documentation index, see llms.txt. This page is also available as Markdown.

Zones de réponse

La réponse JSON de l'API de placement publicitaire contient les zones tableau et les moteurs de rendu et utilisateur objets.

Sur cette page, nous allons expliquer le zones tableau, qui contient tous les détails concernant l'annonce qui a remporté votre requête d'annonce.

Le tableau contient un objet avec les données de l'annonce pour chaque ID de zone demandé.

Propriété
Description

idzone

L'ID de la zone publicitaire.

type

Le format d'annonce utilisé, par ex. bannière.

données

Les données de l'annonce (objet)

Ci-dessous, vous trouverez une liste détaillée des propriétés renvoyées pour chaque données objet selon les formats publicitaires disponibles.

Bannière

Propriété
Description

url

L'URL vers laquelle l'annonce redirige.

impression

L'URL d'impression

image

L'image originale téléchargée pour l'annonce.

optimum_image

Si la création téléchargée est un GIF animé, il s'agit de sa version MP4 optimisée, créée pour être utilisée dans l'annonce.

width

La largeur de l'annonce en pixels.

height

La hauteur de l'annonce en pixels.

media

Cela indique quel type de bannière il s'agit : image, HTML ou vidéo : cela devrait être img_banner, html_banner ou video_banner, respectivement.

Exemples de réponse de bannière

Bannière image :

Bannière HTML :

Bannière vidéo :

Bannière fixe

Propriété
Description

url

L'URL de clic

impression

L'URL d'impression

image

L'image originale téléchargée pour l'annonce.

optimum_image

Dans une bannière fixe, si la création téléchargée est un GIF animé, il s'agit de sa version MP4 optimisée, créée pour être utilisée dans l'annonce.

width

La largeur de l'annonce en pixels.

height

La hauteur de l'annonce en pixels.

frequency_period

À quelle fréquence, en minutes, l'annonce s'affiche.

v_pos

La position verticale de l'annonce.

h_pos

La position horizontale de l'annonce.

media

Cela indique quel type de bannière il s'agit : image, HTML ou vidéo : cela devrait être img_banner, html_banner, ou video_banner respectivement.

Exemple de réponse de bannière fixe

Messages instantanés

Propriété
Description

url

L'URL de clic

impression

L'URL d'impression

image

L'URL de l'image

optimum_image

Si la création téléchargée est un GIF animé, il s'agit de sa version MP4 optimisée, créée pour être utilisée dans l'annonce.

width

La largeur de l'annonce en pixels.

height

La hauteur de l'annonce en pixels.

frequency_period

À quelle fréquence l'annonce s'affiche, en minutes.

media

Cela indique quel type de bannière est utilisé : image, HTML ou vidéo : cela devrait être img_banner, html_banner, ou video_banner respectivement.

Exemple de réponse de message instantané

Annonces natives

Lorsque la réponse renvoie une annonce native, zones.data renverra deux objets : layout et ad_items

data.layout

Propriété
Description

widgetHeaderContentHtml

L'URL de la mention « Powered by » affichée.*

branding_logo

L'URL du logo de branding affiché si l'option est activée.*

branding_logo_hover

L'URL du logo de branding affiché lorsque l'utilisateur le survole.*

itemsPerRow

Le nombre d'annonces affichées sur chaque ligne du widget.

itemsPerCol

Le nombre d'annonces affichées dans chaque colonne du widget.

font_family

La famille de police utilisée dans l'annonce.

header_font_size

La taille de police utilisée dans l'en-tête de branding.

header_font_color

La couleur de police utilisée dans l'en-tête de branding.

widget_background_color

Le code hexadécimal de la couleur de fond utilisée pour le widget.

widget_width

La largeur de l'ensemble du widget.

minimum_width_for_full_sized_layout

La largeur minimale pour une mise en page pleine taille, en pixels.

item_height

La hauteur de chaque annonce individuelle.

item_padding

L'espacement entre chacune des annonces.

image_height

La hauteur de l'image dans chaque annonce.

image_width

La largeur de l'image dans chaque annonce.

text_margin_top

La taille, en pixels, de la marge supérieure du texte.

text_margin_bottom

La taille, en pixels, de la marge inférieure du texte.

text_margin_left

La taille, en pixels, de la marge gauche du texte.

text_margin_right

La taille, en pixels, de la marge droite du texte.

title_font_size

La taille de police du titre de chaque annonce.

title_font_color

La couleur de police du titre de chaque annonce.

title_font_weight

L'épaisseur de police du titre de chaque annonce.

title_decoration

Si le titre est souligné ou non.

title_hover_color

La couleur de police lorsque le titre est survolé.

title_hover_font_weight

L'épaisseur de police lorsque le titre est survolé.

title_hover_decoration

Si le titre est souligné au survol ou non.

description_font_size

La taille de police de la description de chaque annonce.

description_font_color

La couleur de police de la description de chaque annonce.

description_font_weight

L'épaisseur de police de la description de chaque annonce.

description_decoration

Si la description est soulignée ou non.

description_hover_color

La couleur de police lorsque la description est survolée.

description_hover_font_weight

L'épaisseur de police lorsque la description est survolée.

description_hover_decoration

Si la description est soulignée au survol ou non.

open_in_new_window

Si l'annonce doit s'ouvrir dans une nouvelle fenêtre lorsqu'elle est cliquée. 1=oui, 0=non.

mobile_responsive_type

Le type de réactivité lors de l'utilisation d'un appareil mobile (c.-à-d. aucun ou compact). 1=compact, 0=non.

header_is_on_top

Si le branding doit être affiché au-dessus ou en dessous des annonces. 1=oui, 0=non.

header_text_align

L'alignement horizontal de l'en-tête de branding.

title_enabled

Si le titre est activé ou non. 1=oui, 0=non.

description_enabled

Si la description est activée ou non. 1=oui, 0=non.

image_border_size

La taille, en pixels, de la bordure de l'image.

image_border_color

Le code hexadécimal de la couleur de la bordure de l'image.

text_align

L'alignement du texte : gauche, centré ou droite.

customcss_enabled

Si le CSS personnalisé est activé ou non. 1=oui, 0=non.

customcss

S'il est activé, le CSS personnalisé s'affichera ici.

header_enabled

Si l'en-tête est activé ou non. 1=oui, 0=non.

mobile_breakpoint

Le point de rupture, en pixels, entre les vues ordinateur et mobile de la zone publicitaire.

spacing_v

L'espacement vertical, en pixels, entre les annonces, défini dans les options avancées.

spacing_h

L'espacement horizontal, en pixels, entre les annonces, défini dans les options avancées.

zoom

Si l'annonce doit zoomer/dézoomer au survol.

mobile_rows

Le nombre de lignes d'annonces dans le widget mobile.

mobile_cols

Le nombre de colonnes d'annonces dans le widget mobile.

use_v2_script

Si la zone publicitaire a été créée avec la nouvelle configuration V2 ou l'ancienne v1.

text_enabled

Si le titre et la description du texte doivent être affichés. 1=oui, 0=non.

mobile_image_width

La largeur de l'image dans chaque annonce sur mobile.

mobile_text_box_size

La taille de la zone de texte sur mobile. Plage valide : 50-500.

mobile_text_enabled

Si le titre est activé ou non sur mobile. 1=oui, 0=non.

mobile_text_position

La position du texte sur mobile : en bas ou à droite.

item_spacing_on_each_side

L'espacement de chaque côté des annonces, s'ils ont été configurés à l'aide de l'ancienne configuration v1.

text_position

Si le texte est positionné à gauche ou à droite.

text_box_size

La taille de la zone de texte en pixels. Plage 50-500.

widget_height

La hauteur de l'ensemble du widget.

brand_enabled

Si le branding est activé ou non.

brand_font_size

La taille de police du branding.

brand_font_color

La couleur de police du branding.

brand_font_weight

L'épaisseur de police du branding.

brand_decoration

Si la police est soulignée ou non.

mobile_image_height

La hauteur de l'image dans chaque annonce sur mobile.

publisherAdType

Quel type d'annonce native il s'agit, c.-à-d. recommandation, sortie ou interstitielle : native-recommendation, native-interstitial.

data.ad_items

Propriété
Description

idvariation

L'ID de la variation.

image

L'image originale téléchargée pour l'annonce.

url

L'URL de clic.

impression

L'URL d'impression.

title

Le texte du titre de l'annonce.

description

Le texte de description de l'annonce.

brand

Le texte de marque de l'annonce.

original_url

L'URL d'origine de la page de destination.

image_position

La position de l'image de l'annonce (comment l'image sera recadrée).

size

La taille du format d'annonce sélectionné

iframe_url

Si un iframe est utilisé comme variation, ce sera l'URL de l'iframe.

video_thumb_id

L'identifiant de l'élément miniature vidéo (s'il est présent) associé à la création publicitaire.

video_thumb_url

L'URL de l'élément miniature vidéo (s'il est présent).

video_thumb_enabled

L'état de l'élément miniature vidéo (s'il est présent).

Exemple de réponse d'annonces natives

Vidéo Outstream

Propriété
Description

url

L'URL de clic

suivi

Un objet avec des informations de suivi.

vidéo

Le fichier d'annonce vidéo ou le lien VAST à charger.

brandingEnabled

Indicateur pour activer la marque. Cette valeur n'est actuellement pas utilisée

frequencyPeriod

À quelle fréquence, en minutes, l'annonce s'affiche.

maximumWidth

Taille de la largeur de la vidéo.

isVast

Indique si la campagne gagnante est une annonce vidéo standard (false) ou une campagne de lien VAST (true).

ctaEnabled

Indicateur pour afficher un CTA sur l'annonce

cta

Un objet contenant les détails du CTA

impression

L'URL d'impression

data.tracking

Pour le moment, l' data.tracking objet ne renvoie qu'un tableau de progression avec des objets destinés à suivre la lecture de la vidéo. Parmi ces objets, celui avec "offset": "00:00:10.000" est celui à appeler pour enregistrer la vue de la vidéo. Les propriétés de chaque objet sont expliquées ci-dessous :

Propriété
Description

offset

Marqueur de progression en secondes ou en pourcentage de la publicité vidéo lue

url

URL de suivi

data.cta

Propriété
Description

displayUrl

URL liée à la page de destination de l'annonce

text

Texte à utiliser dans l'élément CTA

Exemple de réponse vidéo Outstream

Slider vidéo

Propriété
Description

url

L'URL de clic

suivi

Un objet avec des informations de suivi.

vidéo

Le fichier d'annonce vidéo ou le lien VAST à charger.

screenDensity

Entier indiquant la part de l'espace d'écran maximal occupée par l'annonce sur l'appareil de l'utilisateur

onComplete

Indique le comportement de l'annonce une fois la vidéo terminée. "hide" signifie que l'annonce doit être masquée, tandis que "repeat" signifie que l'annonce doit rester sur la page pour permettre à l'utilisateur de la rejouer

closeAfter

Indique le nombre de secondes nécessaires avant que le bouton de fermeture ne s'affiche sur l'annonce

brandingEnabled

Indicateur pour activer la marque. Cette propriété n'est actuellement pas utilisée

frequencyPeriod

À quelle fréquence, en minutes, l'annonce s'affiche.

impression

L'URL d'impression

isVast

Indique si la campagne gagnante est une annonce vidéo standard (false) ou une campagne de lien VAST (true).

ctaEnabled

Indicateur pour afficher un CTA sur l'annonce

cta

Un objet contenant les détails du CTA

data.tracking

Pour le moment, l' data.tracking objet ne renvoie qu'un tableau de progression avec des objets destinés à suivre la lecture de la vidéo. Parmi ces objets, celui avec "offset": "00:00:10.000" est celui à appeler pour enregistrer la vue de la vidéo. Les propriétés de chaque objet sont expliquées ci-dessous :

Propriété
Description

offset

Marqueur de progression en secondes ou en pourcentage de la publicité vidéo lue

url

URL de suivi

data.cta

Propriété
Description

displayUrl

URL liée à la page de destination de l'annonce

text

Texte à utiliser dans l'élément CTA

Exemple de réponse du Slider vidéo

Interstitiels plein écran

Propriété
Description

url

L'URL de clic

impression

L'URL d'impression

image

L'image originale téléchargée pour l'annonce.

optimum_image

Si la création téléchargée est un GIF animé, il s'agit de sa version MP4 optimisée, créée pour être utilisée dans l'annonce.

width

La largeur de l'annonce en pixels.

height

La hauteur de l'annonce en pixels.

frequency_count

Nombre de fois que l'annonce peut s'afficher

frequency_period

À quelle fréquence, en minutes, l'annonce s'affiche

frequency_trigger_type

Indicateur précisant si la fréquence de cette annonce est basée sur les impressions (0) ou sur les clics (1)

ad_trigger_method

Méthode de déclenchement activée pour cette zone d'annonce

ad_trigger_classes

Classes qui doivent déclencher l'annonce, le cas échéant

first_trigger_clicks

Nombre de clics nécessaires lors de la visite initiale de l'utilisateur pour déclencher l'annonce

next_trigger_clicks

Nombre de clics nécessaires après le premier déclenchement de l'annonce pour l'afficher à nouveau

chrome_enabled

Indicateur précisant si cette zone d'annonce est activée pour Chrome (1), désactivée (0) ou activée exclusivement pour ce navigateur (2)

capping_enabled

Indicateur précisant si le plafonnement doit être appliqué à cette zone d'annonce ou non

media

Cela indique quel type de bannière il s'agit : image, HTML ou vidéo : cela devrait être img_banner, html_banner ou video_banner, respectivement.

Remarque : la plupart des propriétés de la réponse Interstitiel plein écran sont liées au plafonnement et au déclenchement de l'annonce. Puisque c'est vous qui vous chargez du rendu de l'annonce, c'est à vous de décider si vous souhaitez ou non tenir compte de ces propriétés.

Exemple de réponse Interstitiel plein écran

Notez que, même si l'exemple montre un Interstitiel plein écran de bureau, la réponse pour un Interstitiel plein écran mobile devrait être identique, à l'exception de zone.type.

Push intégré à la page

Propriété
Description

url

L'URL de clic

impression

L'URL d'impression

image

L'image originale téléchargée pour l'annonce.

optimum_image

Si la création téléchargée est un GIF animé, il s'agit de sa version MP4 optimisée, créée pour être utilisée dans l'annonce.

title

Titre de la notification

description

Description de la notification

position horizontale

Indique la position horizontale sur la page (gauche, centre, droite)

position verticale

Indique la position verticale sur la page (haut, milieu, bas)

délai

Nombre de secondes avant l'apparition de la notification après le chargement de la page

max_notifications_on_page

Nombre de notifications pouvant apparaître sur la page en même temps

once_closed_hide_for

Durée en secondes pendant laquelle l'annonce est masquée une fois fermée (nécessite le consentement aux cookies de l'utilisateur)

user_session_capping

Nombre de fois que l'annonce est affichée à l'utilisateur (nécessite le consentement aux cookies de l'utilisateur)

delay_between_notifications

Nombre de secondes avant l'apparition de la notification suivante après le chargement de la précédente

Exemple de réponse de notification Push intégrée à la page

Multi-format

Une réponse à une requête Multi-format peut renvoyer différents résultats :

  • Si l'annonce gagnante est une campagne Native, la réponse contiendra un objet de données Native standard.

  • Si l'annonce gagnante est une campagne bannière et que vous avez un Zone unique sur la mise en page, la réponse contiendra un objet de données bannière standard.

  • Si l'annonce gagnante est une campagne bannière et que vous avez choisi une mise en page avec plusieurs annonces, la réponse contiendra un groupe objet avec les propriétés suivantes :

Propriété
Description

orientation

L'orientation de la mise en page multi-zone, qui peut être "horizontal" ou "vertical"

ad_items

Tableau contenant les données d'annonce pour chaque emplacement de la mise en page.

Quel que soit le résultat, la propriété multizoneid sera ajoutée à la réponse, indiquant l'ID de la zone d'annonce multi-format à laquelle cette réponse correspond.

Exemple de réponse Multi-format

L'exemple suivant montre l' zones objet pour une zone d'annonce Multi-format avec un Horizontal x 3 mise en page :

Annonces display responsives

Certains formats, comme les bannières et les interstitiels plein écran, peuvent activer Annonces display responsives pour recevoir de la demande des campagnes d'annonces natives en plus de la demande de leurs formats d'annonce d'origine. Dans ces situations, la réponse contiendra le original_zone objet indiquant le type et les données du format d'origine.

Voici un exemple pour un format d'annonce Bannière :

Suivi des impressions

Assurez-vous d'effectuer un appel GET vers l'URL d'impression afin d'enregistrer les impressions de vos requêtes publicitaires. Une façon d'y parvenir consiste à créer un fichier image invisible en utilisant l'URL d'impression comme source sur la page où la publicité sera affichée, par exemple :

Mis à jour

Ce contenu vous a-t-il été utile ?