Zonas de respuesta
El JSON de respuesta de la API de colocación de anuncios contiene el zonas array y los renderizadores y usuario objetos.
En esta página explicaremos la zonas array, que contiene todos los detalles sobre el anuncio que ganó tu solicitud de anuncio.
El array contiene un objeto con los datos del anuncio para cada ID de zona solicitado.
idzone
El ID de la zona de anuncios.
type
El formato de anuncio utilizado, p. ej. banner.
data
Los datos del anuncio (objeto)
A continuación encontrarás una lista detallada de las propiedades devueltas para cada data objeto según los formatos de anuncio disponibles.
Banner
url
La URL a la que dirige el anuncio.
impression
La URL de impresión
image
La imagen original cargada para el anuncio.
optimum_image
Si la creatividad cargada es un GIF animado, esta es su versión MP4 optimizada, creada para usarla en el anuncio.
width
El ancho del anuncio en píxeles.
height
La altura del anuncio en píxeles.
media
Esto muestra qué tipo de banner es: imagen, HTML o vídeo: debería ser img_banner, html_banner o video_banner, respectivamente.
Ejemplos de respuesta de banner
Banner de imagen:
Banner HTML:
Banner de vídeo:
Banner fijo
url
La URL de clic
impression
La URL de impresión
image
La imagen original cargada para el anuncio.
optimum_image
En un banner fijo, si la creatividad cargada es un GIF animado, esta es su versión MP4 optimizada, creada para usarla en el anuncio.
width
El ancho del anuncio en píxeles.
height
La altura del anuncio en píxeles.
frequency_period
Cada cuántos minutos se muestra el anuncio.
v_pos
La posición vertical del anuncio.
h_pos
La posición horizontal del anuncio.
media
Esto muestra qué tipo de banner es: imagen, HTML o vídeo: debería ser img_banner, html_banner, o video_banner respectivamente.
Ejemplo de respuesta de banner fijo
Mensajes instantáneos
url
La URL de clic
impression
La URL de impresión
image
La URL de la imagen
optimum_image
Si la creatividad cargada es un GIF animado, esta es su versión MP4 optimizada, creada para usarla en el anuncio.
width
El ancho del anuncio en píxeles.
height
La altura del anuncio en píxeles.
frequency_period
Cada cuántos minutos se muestra el anuncio.
media
Esto muestra qué tipo de banner se utiliza: imagen, HTML o vídeo: debería ser img_banner, html_banner, o video_banner respectivamente.
Ejemplo de respuesta de mensaje instantáneo
Anuncios nativos
Cuando la respuesta devuelve un anuncio nativo, zones.data devolverá dos objetos: layout y ad_items
data.layout
widgetHeaderContentHtml
La URL de la marca 'Powered by' que se muestra.*
branding_logo
La URL del logotipo de marca que se muestra si está habilitado.*
branding_logo_hover
La URL del logotipo de marca que se muestra cuando el usuario pasa el cursor sobre él.*
itemsPerRow
El número de anuncios que se muestran en cada fila del widget.
itemsPerCol
El número de anuncios que se muestran en cada columna del widget.
font_family
La familia de fuente utilizada en el anuncio.
header_font_size
El tamaño de fuente utilizado en el encabezado de marca.
header_font_color
El color de la fuente utilizada en el encabezado de marca.
widget_background_color
El código hexadecimal del color de fondo utilizado para el widget.
widget_width
El ancho de todo el widget.
minimum_width_for_full_sized_layout
El ancho mínimo para un diseño de tamaño completo en píxeles.
item_height
La altura de cada anuncio individual.
item_padding
El relleno entre cada uno de los anuncios.
image_height
La altura de la imagen en cada anuncio.
image_width
El ancho de la imagen en cada anuncio.
text_margin_top
El tamaño en píxeles del margen superior del texto.
text_margin_bottom
El tamaño en píxeles del margen inferior del texto.
text_margin_left
El tamaño en píxeles del margen izquierdo del texto.
text_margin_right
El tamaño en píxeles del margen derecho del texto.
title_font_size
El tamaño de fuente del título de cada anuncio.
title_font_color
El color de fuente del título de cada anuncio.
title_font_weight
El grosor de fuente del título de cada anuncio.
title_decoration
Si el título está subrayado o no.
title_hover_color
El color de fuente cuando se pasa el cursor sobre el título.
title_hover_font_weight
El grosor de fuente cuando se pasa el cursor sobre el título.
title_hover_decoration
Si el título se subraya al pasar el cursor o no.
description_font_size
El tamaño de fuente de la descripción de cada anuncio.
description_font_color
El color de fuente de la descripción de cada anuncio.
description_font_weight
El grosor de fuente de la descripción de cada anuncio.
description_decoration
Si la descripción está subrayada o no.
description_hover_color
El color de fuente cuando se pasa el cursor sobre la descripción.
description_hover_font_weight
El grosor de fuente cuando se pasa el cursor sobre la descripción.
description_hover_decoration
Si la descripción se subraya al pasar el cursor o no.
open_in_new_window
Si el anuncio debe abrirse en una nueva ventana al hacer clic. 1=sí, 0=no.
mobile_responsive_type
El tipo de adaptabilidad al usar un dispositivo móvil (es decir, sin formato o compacto). 1=compacto, 0=no.
header_is_on_top
Si la marca debe mostrarse encima o debajo de los anuncios. 1=sí, 0=no.
header_text_align
La alineación horizontal del encabezado de marca.
title_enabled
Si el título está habilitado o no. 1=sí, 0=no.
description_enabled
Si la descripción está habilitada o no. 1=sí, 0=no.
image_border_size
El tamaño en píxeles del borde de la imagen.
image_border_color
El color hexadecimal del borde de la imagen.
text_align
La alineación del texto: izquierda, centro o derecha.
customcss_enabled
Si el CSS personalizado está habilitado o no. 1=sí, 0=no.
customcss
Si está habilitado, el CSS personalizado se mostrará aquí.
header_enabled
Si el encabezado está habilitado o no. 1=sí, 0=no.
mobile_breakpoint
El punto de ruptura en píxeles entre las vistas de escritorio y móvil de la zona de anuncios.
spacing_v
El espaciado vertical en píxeles entre los anuncios, configurado en Opciones avanzadas.
spacing_h
El espaciado horizontal en píxeles entre los anuncios, configurado en Opciones avanzadas.
zoom
Si el anuncio debe acercarse o alejarse al pasar el cursor.
mobile_rows
El número de filas de anuncios en el widget móvil.
mobile_cols
El número de columnas de anuncios en el widget móvil.
use_v2_script
Si la zona de anuncios se creó con la configuración V2 más reciente o con la v1 anterior.
text_enabled
Si el título y la descripción de texto deben mostrarse. 1=sí, 0=no.
mobile_image_width
El ancho de la imagen en cada anuncio en móvil.
mobile_text_box_size
El tamaño del cuadro de texto en móvil. Rango válido 50-500.
mobile_text_enabled
Si el título está habilitado o no en móvil. 1=sí, 0=no.
mobile_text_position
La posición del texto en móvil: inferior o derecha.
item_spacing_on_each_side
El relleno en cada lado de los anuncios, si se configuraron usando la antigua configuración v1.
text_position
Si el texto está posicionado en el lado izquierdo o derecho.
text_box_size
El tamaño del cuadro de texto en píxeles. Rango 50-500.
widget_height
La altura de todo el widget.
brand_enabled
Si la marca está habilitada o no.
brand_font_size
El tamaño de fuente de la marca.
brand_font_color
El color de fuente de la marca.
brand_font_weight
El grosor de fuente de la marca.
brand_decoration
Si la fuente está subrayada o no.
mobile_image_height
La altura de la imagen en cada anuncio en móvil.
publisherAdType
Qué tipo de anuncio nativo es, es decir, recommendation, exit o interstitial: native-recommendation, native-interstitial.
data.ad_items
idvariation
El ID de la variación.
image
La imagen original cargada para el anuncio.
url
La URL de clic.
impression
La URL de impresión.
title
El texto del título del anuncio.
description
El texto de la descripción del anuncio.
brand
El texto de la marca del anuncio.
original_url
La URL original de la página de destino.
image_position
La posición de la imagen del anuncio (cómo se recortará la imagen).
size
El tamaño del formato de anuncio seleccionado
iframe_url
Si se usa un iframe como variación, esta será la URL del iframe.
video_thumb_id
El identificador del recurso de miniatura de vídeo (si está presente) asociado con la creatividad del anuncio.
video_thumb_url
La URL del recurso de miniatura de vídeo (si está presente).
video_thumb_enabled
El estado del recurso de miniatura de vídeo (si está presente).
Ejemplo de respuesta de anuncios nativos
Vídeo outstream
url
La URL de clic
seguimiento
Un objeto con información de seguimiento.
vídeo
El archivo del anuncio de vídeo o el enlace VAST a cargar.
brandingEnabled
Indicador para habilitar el branding. Este valor actualmente no se usa
frequencyPeriod
Cada cuántos minutos se muestra el anuncio.
maximumWidth
Tamaño del ancho del vídeo.
isVast
Indica si la campaña ganadora es un anuncio de vídeo normal (false) o una campaña de enlace VAST (true).
ctaEnabled
Indicador para mostrar un CTA en el anuncio
cta
Un objeto que contiene los detalles del CTA
impression
La URL de impresión
data.tracking
Por el momento, el data.tracking objeto solo devuelve un progreso arreglo con objetos destinados a rastrear la reproducción del video. De estos objetos, el que tiene "offset": "00:00:10.000" es el que se debe llamar para registrar la visualización del video. Las propiedades de cada objeto se explican a continuación:
offset
Marcador de progreso en segundos o como porcentaje del anuncio de video reproducido
url
URL de seguimiento
data.cta
displayUrl
URL relacionada con la página de destino del anuncio
text
Texto que se utilizará en el elemento CTA
Ejemplo de respuesta de video outstream
Control deslizante de video
url
La URL de clic
seguimiento
Un objeto con información de seguimiento.
vídeo
El archivo del anuncio de vídeo o el enlace VAST a cargar.
screenDensity
Entero que indica la proporción del espacio máximo de pantalla que ocupa el anuncio en el dispositivo del usuario
onComplete
Indica el comportamiento del anuncio después de que el video haya terminado de reproducirse. "hide" significa que el anuncio debe ocultarse, mientras que "repeat" significa que el anuncio debe permanecer en la página para permitir que el usuario lo reproduzca de nuevo
closeAfter
Indica la cantidad de segundos necesarios antes de que se muestre el botón de cierre en el anuncio
brandingEnabled
Indicador para habilitar el branding. Esta propiedad actualmente no se usa
frequencyPeriod
Cada cuántos minutos se muestra el anuncio.
impression
La URL de impresión
isVast
Indica si la campaña ganadora es un anuncio de vídeo normal (false) o una campaña de enlace VAST (true).
ctaEnabled
Indicador para mostrar un CTA en el anuncio
cta
Un objeto que contiene los detalles del CTA
data.tracking
Por el momento, el data.tracking objeto solo devuelve un progreso arreglo con objetos destinados a rastrear la reproducción del video. De estos objetos, el que tiene "offset": "00:00:10.000" es el que se debe llamar para registrar la visualización del video. Las propiedades de cada objeto se explican a continuación:
offset
Marcador de progreso en segundos o como porcentaje del anuncio de video reproducido
url
URL de seguimiento
data.cta
displayUrl
URL relacionada con la página de destino del anuncio
text
Texto que se utilizará en el elemento CTA
Ejemplo de respuesta de control deslizante de video
Intersticiales de página completa
url
La URL de clic
impression
La URL de impresión
image
La imagen original cargada para el anuncio.
optimum_image
Si la creatividad cargada es un GIF animado, esta es su versión MP4 optimizada, creada para usarla en el anuncio.
width
El ancho del anuncio en píxeles.
height
La altura del anuncio en píxeles.
frequency_count
Cuántas veces puede mostrarse el anuncio
frequency_period
Con qué frecuencia, en minutos, se muestra el anuncio
frequency_trigger_type
Indicador para señalar si la frecuencia de este anuncio se basa en impresiones (0) o clics (1)
ad_trigger_method
Método de activación habilitado para esta zona de anuncios
ad_trigger_classes
Clases que deberían activar el anuncio, si las hay
first_trigger_clicks
Número de clics necesarios en la visita inicial del usuario para activar el anuncio
next_trigger_clicks
Número de clics necesarios después del primer disparo del anuncio para mostrarlo de nuevo
chrome_enabled
Indicador para señalar si esta zona de anuncios está habilitada para Chrome (1), deshabilitada (0) o habilitada exclusivamente para este navegador (2)
capping_enabled
Indicador para señalar si se debe aplicar capping a esta zona de anuncios o no
media
Esto muestra qué tipo de banner es: imagen, HTML o vídeo: debería ser img_banner, html_banner o video_banner, respectivamente.
Nota: la mayoría de las propiedades de la respuesta de Interstitial de página completa están relacionadas con el capping y la activación del anuncio. Como tú te encargas de renderizar el anuncio, depende de ti decidir si quieres prestar atención a estas propiedades o no.
Ejemplo de respuesta de Interstitial de página completa
Ten en cuenta que, aunque el ejemplo muestra un interstitial de página completa para escritorio, la respuesta para un interstitial de página completa móvil debería ser la misma, salvo por zone.type.
Notificación push en la página
url
La URL de clic
impression
La URL de impresión
image
La imagen original cargada para el anuncio.
optimum_image
Si la creatividad cargada es un GIF animado, esta es su versión MP4 optimizada, creada para usarla en el anuncio.
title
Título de la notificación
description
Descripción de la notificación
horizontal_position
Indica la posición horizontal en la página (izquierda, centro, derecha)
vertical_position
Indica la posición vertical en la página (arriba, medio, abajo)
delay
Número de segundos antes de que aparezca la notificación después de que se cargue la página
max_notifications_on_page
Número de notificaciones que pueden aparecer en la página al mismo tiempo
once_closed_hide_for
Duración en segundos durante la cual el anuncio permanece oculto una vez cerrado (necesita el consentimiento de cookies del usuario)
user_session_capping
Número de veces que se muestra el anuncio al usuario (necesita el consentimiento de cookies del usuario)
delay_between_notifications
Número de segundos antes de que aparezca la siguiente notificación después de que se cargue la anterior
Ejemplo de respuesta de notificación push en la página
Multi-formato
Una respuesta para una solicitud Multi-formato puede devolver resultados diferentes:
Si el anuncio ganador es una campaña nativa, entonces la respuesta contendrá un objeto de datos nativo estándar.
Si el anuncio ganador es una campaña de banner y tienes una Zona única en el diseño, entonces la respuesta contendrá un objeto de datos de banner estándar.
Si el anuncio ganador es una campaña de banner y elegiste un diseño con anuncios múltiples, entonces la respuesta contendrá un grupo objeto con las siguientes propiedades:
orientation
La orientación del diseño de múltiples zonas, que puede ser "horizontal" o "vertical"
ad_items
Arreglo que contiene los datos del anuncio de cada espacio del diseño.
Independientemente del resultado, la propiedad multizoneid se añadirá a la respuesta, indicando el ID de la zona de anuncios multi-formato al que corresponde esta respuesta.
Ejemplo de respuesta multi-formato
El siguiente ejemplo muestra el zonas objeto para una zona de anuncios multi-formato con un Horizontal x 3 diseño:
Anuncios display responsivos
Algunos formatos, como los banners y los intersticiales de página completa, pueden habilitar Anuncios display responsivos recibir demanda de campañas de anuncios nativos además de la demanda de sus formatos publicitarios originales. En estas situaciones, la respuesta contendrá el original_zone objeto que indica el tipo y los datos del formato original.
Aquí hay un ejemplo de un formato de anuncio banner:
Seguimiento de impresiones
Asegúrate de hacer una llamada GET a la URL de impresión para registrar las impresiones de tus solicitudes de anuncios. Una forma de lograrlo es creando un archivo de imagen invisible usando la URL de impresión como origen en la página donde se mostrará el anuncio, por ejemplo:
Última actualización
¿Te fue útil?

