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

Demande d'enchère Open RTB 2.4

Cette page explique comment effectuer des demandes d’enchères

En-têtes de la requête d'enchère

  • En-tête HTTP de version OpenRTB: x-openrtb-version: 2.4

  • En-tête HTTP Keep-Alive: Connection: Keep-Alive

  • JSON du contenu: Content-Type: application/json

Les objets suivants doivent être envoyés encodés en JSON dans le corps de la requête :

Demande d’enchère

Attribut
Obligatoire ?
Description

à

Oui

Type d'enchère, premier prix = 1 (int)

id

Oui

ID unique de la requête d'enchère (chaîne)

imp

Oui

Tableau d’objets Imp représentant les impressions proposées (objet).

site

Oui

Détails via un objet Site sur le site web de l'éditeur (objet).

application

Oui

Détails via un objet App sur l’application du diffuseur* (objet).

device

Oui

Détails via un objet Device sur l'appareil de l'utilisateur auquel l'impression sera diffusée (objet).

user

Non

Détails via un objet User sur l'utilisateur humain de l'appareil ; l'audience publicitaire (objet).

ext

Non

Espace réservé aux extensions d’OpenRTB.

Un seul des objets {site, app} doit être présent dans chaque requête.

imp

Attribut
Obligatoire ?
Description

id

Oui

ID unique de l'impression dans cette requête d'enchère (chaîne)

bidfloor

Non

Enchère minimale pour cette impression (CPM) / clic (CPC) et devise du compte (float)

bidfloorcur

Non

Devise de la valeur d’enchère minimale spécifiée à l’aide des codes alpha ISO-4217 (chaîne)

native

Uniquement pour les impressions natives et push

Une opportunité d’objet Native (objet).

banner

Uniquement pour les impressions de bannière et d’interstitiel pleine page

Une opportunité d’objet Banner (objet).

instl

Uniquement pour les clics pop, lien direct, e-mail et interstitiel pleine page

Une opportunité d’objet Fullscreen (objet).

video

Uniquement pour la vidéo

Une opportunité d’objet Video (objet)

secure

Recommandé

Indique si l’impression nécessite des ressources créatives et un balisage via une URL HTTPS sécurisée, où 0 = non sécurisé, 1 = sécurisé (option recommandée). Si omis, l’état de sécurité est inconnu, mais la prise en charge de HTTP non sécurisé peut être supposée (entier)

el

Non

E-mail encodé en Base64 (chaîne)

ext

Non

Espace réservé aux extensions spécifiques à l’exchange

imp.banner

Attribut
Obligatoire ?
Description

w

Oui

Largeur de la bannière (entier)

h

Oui

Hauteur de la bannière (entier)

mimes

Non

Liste des types MIME pris en charge (tableau de chaînes). Nous prenons en charge : image/jpeg, image/jpg, image/png, image/png, image/gif, image/webp, video/mp4

ext

Non

Espace réservé aux extensions spécifiques à l’exchange (objet)

imp.banner.ext

Attribut
Obligatoire ?
Description

image_output

Non

Indique le format de sortie pour les bannières image* (chaîne)

video_output

Non

Indique le format de sortie pour les bannières vidéo* (chaîne)

*Définit le format du champ adm pour le format bannière. Les options sont xml ou html. La valeur par défaut est xml si le champ n’est pas fourni.

imp.instl

Attribut
Obligatoire ?
Description

instl

Oui

0 = clics sur lien direct/e-mail, 1 = popunder/interstitiel pleine page

imp.native (pour les annonces natives et les notifications push)

Attribut
Obligatoire ?
Description

request

Oui

Charge utile de la requête conforme à la spécification de publicité native - un chaîne encodée en JSON de la requête Native Ads incluant son native objet de niveau supérieur (objet JSON)

ver

Non

Version de l'API Dynamic Native Ads à laquelle request est conforme (chaîne)

imp.native.request

Attribut
Obligatoire ?
Description

ver

Oui

Version du balisage natif utilisée (chaîne)

context

Non

Le contexte dans lequel l'annonce apparaît. Dans ce cas, il s'agit de 1 (un contexte centré sur le contenu tel qu'un fil d'actualité, un article, une galerie d'images, une galerie vidéo ou similaire), facultatif (entier)

plcmttype

Oui

La conception/le format/la disposition de l'unité publicitaire proposée. Actuellement, nous prenons en charge 4 (Widget de recommandation) et 500 (Push Notification) (entier)

plcmtcnt

Non

Nombre de placements identiques dans cette mise en page. Max : 10 (entier) (entier)

assets

Oui

Un tableau de objets Asset. Toute réponse d'enchère doit respecter le tableau d'éléments exprimé dans la requête d'enchère (tableau d'objets JSON)

seq

Non

0 pour la première annonce, 1 pour la deuxième, et ainsi de suite. Notez que cela ne serait généralement PAS utilisé en combinaison avec plcmtcnt - soit vous enchérissez sur plusieurs emplacements identiques (dans ce cas plcmtcnt>1, seq=0), soit vous organisez des enchères séparées pour des éléments distincts du flux (dans ce cas plcmtcnt=1, seq=>=1)

imp.native.request.assets

Attribut
Obligatoire ?
Description

id

Oui

ID d’actif unique, attribué par l’exchange. Généralement un compteur pour le tableau (entier) 1 : ID d’actif image, 2 : ID d’actif titre, 3 : ID d’actif description

required

Non

Défini sur 1 si l'actif est requis ou 0 si l’actif est optionnel (entier)

plcmtcnt

Non

Le nombre d'emplacements identiques dans cette mise en page (entier)

img

Oui

Objet Image pour les actifs image** (objet JSON)

title

Non

Objet Title pour les actifs titre** (objet JSON)

data

Non

Objet Data pour le nom de la marque, la description, les notes, les prix, etc.* (objet JSON)

*Le nombre d’enchères reçues pour votre requête Native sera basé sur la valeur que vous définissez dans "plcmtcnt". Par exemple, une demande d’enchère avec "plcmtcnt":3 recevra 3 objets d’enchère différents. Vous pouvez trouver un exemple de cela dans la page d’exemple de réponse.

** Un seul des objets {img, title, data} doit être présent dans chaque objet d’actif

imp.native.request.assets.img

Attribut
Obligatoire ?
Description

type

Non

ID du type d'élément image pris en charge par l'éditeur. Nous prenons en charge : 1 (Image d'icône) (entier), 3 (Aperçu de grande image pour l'annonce) (entier)

w

Non

Largeur de l'image en pixels, facultatif (entier)

h

Non

Hauteur de l'image en pixels, facultatif (entier)

wmin

Oui

Largeur minimale demandée de l'image en pixels (entier)

hmin

Oui

Hauteur minimale demandée de l'image en pixels (entier)

*Dimensions de l’icône de notification push : 192px x 192px

imp.native.request.assets.title

Attribut
Obligatoire ?
Description

len

Oui

Longueur maximale du texte dans l'élément de titre. (entier)

imp.native.request.assets.data

Attribut
Obligatoire ?
Description

type

Oui

ID de type de l'élément pris en charge par l'éditeur (entier). Nous prenons en charge : 1 (sponsored - message « Sponsorisé par » où la réponse doit contenir le nom de la marque du sponsor), 2 (desc - texte descriptif associé au produit ou au service annoncé)

len

Non

Longueur maximale du texte dans la réponse de l'élément (entier)

imp.video

Attribut
Obligatoire ?
Description

mimes

Non

Liste des types mime pris en charge (tableau de chaînes)

protocols

Non

Liste des protocoles de réponse aux enchères vidéo pris en charge (tableau d'entiers)

skip

Non

Indique si le lecteur permettra de sauter la vidéo, où 0 = non, 1 = oui

skipafter

Non

Nombre de secondes pendant lesquelles une vidéo doit être lue avant que le saut ne soit activé ; applicable uniquement si l'annonce est skippable

skipmin

Non

Les vidéos dont la durée totale est supérieure à ce nombre de secondes peuvent être skippables ; applicable uniquement si l'annonce est skippable

Si vous fournissez seulement "skip" dans la requête mais pas "skipafter", la vidéo pourra être ignorée après 5 secondes. La réponse définira "skipoffset" à 5. Si vous fournissez "skip" mais pas "skipmin", la vidéo pourra être ignorée quelle que soit sa durée.

imp.ext

Attribut
Obligatoire ?
Description

video_cta

Non

Indique si des CTA doivent être fournis, où 0 = non, 1 = oui (1 par défaut)

Pour voir un exemple de CTA, consultez notre page d’exemple de réponse.

site

Attribut
Obligatoire ?
Description

id

Obligatoire

ID unique du site (chaîne)

domain

Obligatoire

Nom de domaine du site (chaîne)

nom

Obligatoire

Nom du site (chaîne)

cat

Non

ID de catégorie IAB (tableau de chaînes)

page

Recommandé

URL complète de la page où l'annonce sera affichée (chaîne)

keywords

Non

Les mots-clés peuvent être utilisés pour garantir que les zones publicitaires reçoivent le bon type de publicité. Les mots-clés doivent être une chaîne de mots séparés par des virgules.

ext

Non

Espace réservé pour les extensions spécifiques à l'échange d'OpenRTB.

site.ext

Attribut
Obligatoire ?
Description

exchangecat

Non

ID de catégorie ExoClick personnalisé (entier)

idzone

Non

ID de zone publicitaire ExoClick personnalisé (entier)

application

Attribut
Obligatoire ?
Description

id

Obligatoire

ID d’application unique (chaîne)

cat

Non

ID de catégorie IAB (tableau de chaînes)

keywords

Non

Les mots-clés peuvent être utilisés pour garantir que les zones publicitaires reçoivent le bon type de publicité. Les mots-clés doivent être une chaîne de mots séparés par des virgules (chaîne)

éditeur

Non

Détails sur l’éditeur (objet)

app.publisher

Attribut
Obligatoire ?
Description

domain

Recommandé

Domaine de niveau le plus élevé de l’éditeur (par ex. « publisher.com ») (chaîne)

device

Attribut
Obligatoire ?
Description

ua

Oui

Agent utilisateur du navigateur (chaîne)

geo

Non

Localisation de l'appareil supposée être la localisation actuelle de l'utilisateur, définie par un objet Geo.

ip

Oui

Adresse IP de l'utilisateur (chaîne)*

ipv6

Recommandé

Adresse IPv6 de l'utilisateur (chaîne)*

language

Recommandé

Langue du navigateur utilisant ISO-639-1 alpha-2 (chaîne)

os

Non

Système d'exploitation (chaîne)

js

Non

Prise en charge de JavaScript, où 0 = non, 1 = oui (entier)

ext

Non

Espace réservé pour les extensions spécifiques à l'échange d'OpenRTB

Vous devez inclure soit ip soit ipv6 dans votre requête, mais pas les deux. Si vous utilisez ipv6, supprimez l’attribut ip, et inversement. Inclure les deux peut provoquer des erreurs.

device.geo

Attribut
Obligatoire ?
Description

country

Non

Code pays ISO3

device.ext

Attribut
Obligatoire ?
Description

remote_addr

Non

Adresse IP principale de l'utilisateur (chaîne)

x_forwarded_for

Non

Adresse IP X-FORWARDED-FOR de l'utilisateur ou vide si non définie (chaîne)

user

Attribut
Obligatoire ?
Description

id

Oui

ID utilisateur unique (chaîne)

Si vous ne pouvez pas générer une chaîne d’ID utilisateur, vous pouvez la laisser vide (""). La requête recevra une réponse tant que l’objet "user" est inclus dans la requête.

ext

Attribut
Obligatoire ?
Description

sub

Non

L’ID de sous. Il doit s’agir d’un nombre compris entre un et dix chiffres : n’utilisez pas de zéros au début des IDs de sous.

export

Non

Le type de réponse peut être "json" ou "xml" (chaîne). La valeur par défaut est "json".

Exemples

Vous pouvez trouver une liste détaillée d’exemples de requêtes dans notre page d'exemple

Mis à jour

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