Open RTB Bid Request Specifications
En esta página se explica cómo presentar solicitudes de ofertas
Encabezados de solicitud de ofertas
- Cabecera HTTP de la versión OpenRTB: x-openrtb-version: 2.4
- Cabecera HTTP Keep-Alive: Conexión: Keep-Alive
- Contenido JSON: Content-Type: application/json
The following objects should be sent encoded as JSON in the request body:
Solicitud de oferta
| Atributo | ¿Es necesario? | Descripción |
|---|
| en | Sí | Tipo de subasta, primer precio = 1 (int) |
| id | Sí | ID único de solicitud de oferta (cadena) |
| imp | Sí | Matriz de objetos Imp que representan las impresiones ofrecidas(objeto). |
| sitio | Sí | Detalles a través de un objeto Site sobre el sitio web(objeto) del editor. |
| dispositivo | Sí | Detalles a través de un objeto Device sobre el dispositivo del usuario al que se entregará la impresión(objeto). |
| usuario | No | Detalles a través de un objeto Usuario sobre el usuario humano del dispositivo; la audiencia(objeto) publicitaria. |
| ext | No | Marcador de posición para extensiones de OpenRTB. |
imp
| Atributo | ¿Es necesario? | Descripción |
|---|
| id | Sí | ID de impresión único dentro de esta solicitud de oferta (cadena) |
| bidfloor | No | Oferta mínima para esta impresión (CPM) / clic (CPC) y moneda de la cuenta (flotante) |
| bidfloorcur | No | Moneda para el valor mínimo de puja especificado mediante códigos alfa ISO-4217 (cadena) |
| nativo | Sólo para imps nativos y push | Una oportunidad de objeto nativo (objeto). |
| banner | Sólo para banner imps | Una oportunidad de objeto Banner (objeto). |
| instl | Sólo para imágenes emergentes, enlaces directos y clics por correo electrónico | Una oportunidad de objeto a pantalla completa (objeto). |
| vídeo | Sólo para vídeo | A Video objeto oportunidad (objeto) |
| seguro | Recomendado | Bandera para indicar si la impresión requiere activos creativos y marcado de URL HTTPS seguros, donde 0 = no seguro, 1 = seguro (opción recomendada). Si se omite, se desconoce el estado seguro, pero se puede suponer la compatibilidad con HTTP no seguro (entero) |
| el | No | Correo electrónico codificado en Base64 (cadena) |
| ext | No | Marcador de posición para extensiones específicas de intercambio |
imp.banner
| Atributo | ¿Es necesario? | Descripción |
|---|
| w | Sí | Anchura del banner (entero) |
| h | Sí | Altura del banner (entero) |
| mimos | No | Lista de tipos mime admitidos (matriz de cadenas). Soportamos: image/jpeg, image/jpg, image/png, image/png, image/gif, image/webp, video/mp4 |
| ext | No | Marcador de posición para extensiones específicas del intercambio (objeto) |
imp.banner.ext
| Atributo | ¿Es necesario? | Descripción |
|---|
| salida_de_imagen | No | Indica el formato de salida de los banners de imagen* (cadena) |
| salida_de_vídeo | No | Indica el formato de salida de los banners de vídeo* (cadena) |
*Define el formato del campo adm para el formato del banner. Las opciones son xml o html. El valor por defecto es xml en caso de que no se proporcione el campo.
imp.instl
| Atributo | ¿Es necesario? | Descripción |
|---|
| instl | Sí | 0 = clic en enlace directo/email, 1 = popunder |
imp.native (para anuncios nativos y de notificaciones push)
| Atributo | ¿Es necesario? | Descripción |
|---|
| solicitar | Sí | Carga útil de la solicitud conforme a la especificación de anuncios nativos: una cadena codificada JSON de la solicitud de anuncios nativos, incluido su objeto nativo de nivel superior (objeto JSON) |
| ver | No | Versión de la API de Dynamic Native Ads a la que se ajusta request (cadena) |
imp.solicitud.nativa
| Atributo | ¿Es necesario? | Descripción |
|---|
| ver | Sí | Versión del marcado nativo en uso (cadena) |
| contexto | No | El contexto en el que aparece el anuncio. En este caso es 1 (Contexto centrado en el contenido como newsfeed, artículo, galería de imágenes, galería de vídeos o similar), opcional (entero) |
| plcmttype | Sí | El diseño/formato/disposición del bloque de anuncios que se ofrece. Actualmente admitimos 4 (Widget de recomendación) y 500 (Notificación push) (número entero) |
| plcmtcnt | No | El número de colocaciones idénticas en esta Disposición. Máx: 10 (entero) (entero) |
| activos | Sí | Una matriz de objetos de activos. Toda respuesta de oferta debe ajustarse a la matriz de elementos expresada en la solicitud de oferta (matriz de objetos JSON) |
| seq | No | 0 para el primer anuncio, 1 para el segundo, y así sucesivamente. Tenga en cuenta que, por lo general, NO debe utilizarse en combinación con plcmtcnt: o bien está subastando varias ubicaciones idénticas (en cuyo caso plcmtcnt>1, seq=0) o bien está celebrando subastas separadas para distintos artículos de la fuente (en cuyo caso plcmtcnt=1, seq=>=1) |
imp.native.request.assets
| Atributo | ¿Es necesario? | Descripción |
|---|
| id | Sí | ID único del activo, asignado por el intercambio. Normalmente un contador para la matriz (entero) 1: ID de activo de imagen, 2: ID de activo de título, 3: ID de activo de descripción |
| obligatorio | No | Valor 1 si el activo es obligatorio o 0 si es opcional (entero) |
| plcmtcnt | No | Número de colocaciones idénticas en este Layout (entero) |
| img | Sí | Objeto de imagen para activos de imagen** (objeto JSON) |
| título | No | Objeto de título para los activos de título** (objeto JSON) |
| datos | No | Objeto de datos para nombre de marca, descripción, valoraciones, precios, etc.* (objeto JSON) |
*La cantidad de pujas recibidas por su solicitud Nativa se basará en el valor que usted establezca en "plcmtcnt". Por ejemplo, una petición de oferta con "plcmtcnt":3 recibirá 3 objetos de oferta diferentes. Puede encontrar un ejemplo de esto en la página Response example page.
** Sólo uno de los objetos {img, title, data} debe estar presente en cada objeto asset
imp.native.request.assets.img
| Atributo | ¿Es necesario? | Descripción |
|---|
| tipo | No | Tipo ID del elemento de imagen soportado por el editor. Admitimos: 1 (Icono de imagen) (entero), 3 (Vista previa de imagen grande para el anuncio) (entero) |
| w | No | Anchura de la imagen en píxeles, opcional (entero) |
| h | No | Altura de la imagen en píxeles, opcional (entero) |
| wmin | Sí | Anchura mínima solicitada de la imagen en píxeles (entero) |
| hmin | Sí | La altura mínima solicitada de la imagen en píxeles (entero) |
*Dimensiones del icono de notificación push: 192px x 192px
imp.native.request.assets.title
| Atributo | ¿Es necesario? | Descripción |
|---|
| len | Sí | Longitud máxima del texto en el elemento título. (entero) |
imp.native.request.assets.data
| Atributo | ¿Es necesario? | Descripción |
|---|
| tipo | Sí | ID de tipo del elemento admitido por el editor (entero). Se admiten: 1 (patrocinado - Mensaje patrocinado por donde la respuesta debe contener la marca del patrocinador), 2 (desc - Texto descriptivo asociado al producto o servicio anunciado) |
| len | No | Longitud máxima del texto en la respuesta del elemento (entero) |
imp.video
| Atributo | ¿Es necesario? | Descripción |
|---|
| mimos | No | Lista de tipos mime admitidos (matriz de cadenas) |
| protocolos | No | Lista de protocolos de respuesta de oferta de vídeo admitidos (matriz int) |
| omitir | No | Indica si el reproductor permitirá saltar el vídeo, donde 0 = no, 1 = sí |
| skipafter | No | Número de segundos que debe reproducirse un vídeo antes de que se active el salto; sólo se aplica si el anuncio se puede saltar |
| skipmin | No | Los vídeos con una duración total superior a este número de segundos pueden omitirse; sólo aplicable si el anuncio es omisible |
Nota: Si sólo proporciona "skip" en la solicitud, pero no "skipafter", el vídeo podrá saltarse transcurridos 5 segundos. La respuesta establecerá "skipoffset" en 5. Si proporciona "skip" pero no "skipmin", el vídeo se podrá omitir independientemente de su duración.
imp.ext
| Atributo | ¿Es necesario? | Descripción |
|---|
| video_cta | No | Indica si se deben proporcionar CTAs, donde 0 = no, 1 = sí (por defecto 1) |
To see an example of CTA, please check our Response example page.
sitio
| Atributo | ¿Es necesario? | Descripción |
|---|
| id | Requerido | ID único del sitio (cadena) |
| dominio | Requerido | Nombre de dominio del sitio (cadena) |
| nombre | Requerido | Nombre del sitio (cadena) |
| cat | No | ID de categoría IAB (matriz de cadenas) |
| página | Recomendado | URL completa de la página donde se mostrará el anuncio (cadena) |
| palabras clave | No | Las palabras clave pueden utilizarse para garantizar que las zonas de anuncios reciban el tipo de publicidad adecuado. Las palabras clave deben ser una cadena de palabras separadas por comas. |
| ext | No | Marcador de posición para extensiones de OpenRTB específicas del intercambio. |
sitio.ext
| Atributo | ¿Es necesario? | Descripción |
|---|
| exchangecat | No | ID de categoría personalizada de ExoClick (entero) |
| idzone | No | ID de zona publicitaria personalizada de ExoClick (número entero) |
aplicación
| Atributo | ¿Es necesario? | Descripción |
|---|
| id | Requerido | ID único de la aplicación (cadena) |
| cat | No | ID de categoría IAB (matriz de cadenas) |
| palabras clave | No | Las palabras clave pueden utilizarse para garantizar que las zonas de anuncios reciban el tipo de publicidad adecuado. Las palabras clave deben ser una cadena de palabras separadas por comas (cadena) |
| editor | No | Información sobre el editor (objeto) |
Nota: No se puede enviar el objeto "app" junto con "site" o viceversa.
editor.app
| Atributo | ¿Es necesario? | Descripción |
|---|
| dominio | Recomendado | Dominio de nivel superior del editor (por ejemplo, "editor.com") (cadena) |
dispositivo
| Atributo | ¿Es necesario? | Descripción |
|---|
| ua | Sí | Agente de usuario del navegador (cadena) |
| geo | No | Se supone que la ubicación del dispositivo es la ubicación actual del usuario definida por un objeto Geo. |
| ip | Sí | Dirección IP del usuario (cadena)* |
| ipv6 | Recomendado | Dirección IPv6 del usuario (cadena)* |
| idioma | Recomendado | Idioma del navegador que utiliza ISO-639-1-alfa-2 (cadena) |
| os | No | Sistema operativo (cadena) |
| js | No | Compatibilidad con JavaScript, donde 0 = no, 1 = sí (número entero) |
| ext | No | Marcador de posición para extensiones específicas de OpenRTB |
Nota: Sólo necesita incluir ip o ipv6 en su solicitud, no ambos. Si utiliza ipv6, elimine el atributo ip, y viceversa. Incluir ambos puede causar errores.
dispositivo.geo
| Atributo | ¿Es necesario? | Descripción |
|---|
| país | No | País ISO3 |
dispositivo.ext
| Atributo | ¿Es necesario? | Descripción |
|---|
| dirección_remota | No | Dirección IP principal del usuario (cadena) |
| x_reenviado_para | No | Dirección IP X-FORWARDED-FOR del usuario o vacía si no está configurada (cadena) |
usuario
| Atributo | ¿Es necesario? | Descripción |
|---|
| id | Sí | ID de usuario único (cadena) |
Nota: Si no puede generar una cadena de ID de usuario, puede dejarla vacía (""). La solicitud obtendrá respuesta siempre que se incluya el objeto "usuario" en la solicitud.
ext
| Atributo | ¿Es necesario? | Descripción |
|---|
| sub | No | El Sub ID. Debe ser un número de entre seis y diez dígitos: No utilice ceros al principio de las subidentificaciones. |
| exportar | No | El tipo de respuesta puede ser "json" o "xml" (cadena). Por defecto es "json". |
Nota: Los Sub IDs deben ser un número entre 1 y Int32: No utilice ceros al principio de los Sub IDs.
Ejemplos
Encontrará una lista detallada de ejemplos de solicitudes en nuestra página de ejemplos