Servicio de vídeo de formato largo

Los clientes de Direct Supply pueden integrar su inventario de vídeo de pod de anuncios de formato largo de la aplicación o la web con Prebid Server Premium (PSP) mediante el punto de /prebid/lfv conexión. Las duraciones de vídeo de formato largo son de al menos 30 minutos con posibles posiciones previas, medias y posteriores al rodaje.

Los clientes de Microsoft Monetize Ad Server no necesitan cambiar su integración actual en Microsoft Monetize, pueden ignorar el servicio de vídeo de formato largo y, en su lugar, pueden seguir los pasos de configuración de PSP.

Proceso de solicitud y respuesta

Los siguientes pasos describen el proceso de solicitud y respuesta de vídeo de formato largo:

  1. Los editores envían una solicitud de vídeo de formato largo al Bus de impresiones de Microsoft Monetize (ImpBus) a través del punto de /prebid/lfv conexión. Esta solicitud contiene POST valores para el pod de anuncios, como la duración del anuncio, el ancho y alto del vídeo, y propiedades opcionales como la categoría de marca para la separación competitiva.
  2. ImpBus desempaqueta la solicitud y determina el número de espacios publicitarios que se rellenarán dentro del pod de anuncios.
  3. Se recuperan las configuraciones de Monetize y ImpBus crea una solicitud OpenRTB con el número solicitado de espacios publicitarios.
  4. ImpBus envía la solicitud de OpenRTB a todos los postores de Microsoft Monetize, incluidos los socios de demanda de PSP y Microsoft Invest
    1. Los socios de demanda de Prebid devuelven pujas, cada una con una subcategoría de IAB única.
    2. Microsoft Invest y los licitadores externos tienen una categoría de marca única de Microsoft Monetize asociada a cada puja, que se convierte a una subcategoría de IAB.
  5. ImpBus ejecuta la subasta en el marketplace de Microsoft Monetize para determinar la puja ganadora de Microsoft Monetize.
  6. Basándose en la configuración del editor y del servidor de anuncios recuperada en el tercer paso, ImpBus traduce las subcategorías de IAB a las categorías principales del servidor de anuncios (Freewheel o Google Ad Manager).
    1. Para las pujas de Microsoft Monetize, ImpBus se traducirá de la categoría de Microsoft Monetize a la subcategoría de IAB y, por último, a la categoría de servidor de anuncios principal.
  7. Las pujas se desduplican en función de los valores de tupla para el cubo de precios, la categoría del servidor de anuncios principal y la duración.
  8. Para cada puja única, ImpBus almacena en caché el XML VAST único.
  9. Se generan pares de segmentación de clave-valor para cada puja de hb_pby hb_pb_cat_dur,hb_cache_id.
  10. ImpBus devuelve una respuesta JSON con pares clave-valor de segmentación Prebid y el identificador de caché.

Diagrama que ilustra el proceso de solicitud y respuesta.

API de REST

En la siguiente tabla se enumeran los parámetros necesarios y opcionales para enviar una solicitud de puja por vídeo de formato largo.

Parámetro Ámbito Tipo Descripción
app Obligatorio Objeto Objeto contenedor que describe la aplicación que mostrará los pods de anuncios. Si la aplicación no se incluye en la solicitud, el parámetro site debe estarlo.
auction_timeout_ms Opcional Entero Tiempo máximo en milisegundos para esperar a que finalice la subasta. El valor predeterminado es cero si no se da, lo que utiliza la configuración de tiempo de espera de la Configuración Global Premium del servidor Prebid del miembro.
bcat Opcional Matriz de cadena Categorías de anunciantes bloqueadas utilizando las categorías de contenido de IAB.
badv Opcional Matriz de cadena Lista bloqueada de anunciantes por sus dominios (por ejemplo, "ford.com").
cacheconfig Opcional Objeto Controles opcionales para tener información de caché de Prebid Server.
content Opcional Objeto Objeto contenedor que describe metadatos de contenido diversos que se pueden usar para establecer como destino el adPod(s)archivo .
cur Opcional Cadena Valor predeterminado: USD. Moneda permitida para las claves de segmentación en esta solicitud de puja mediante códigos alfa ISO-4217.
device Opcional Objeto Objeto contenedor que describe el dispositivo que se usa para la representación de vídeo.
eids Opcional Objeto La lista de identificadores de usuario unificados.
gpid Opcional Cadena Id. de emplazamiento global. Un identificador único para el espacio de anuncios en todas las plataformas. Para obtener más información sobre el espacio publicitario y el GPID de Prebid, consulta la documentación de Prebid.
includebrandcategory Opcional Objeto Objeto contenedor que describe las entradas de categoría de marca.
memberid Opcional (obligatorio si se utilizan códigos de inventario) Entero Id. de miembro del vendedor.
podconfig Obligatorio Objeto Objeto contenedor para describir todas las configuraciones del pod. Para obtener más información sobre el pod objeto, consulte la sección Configuración de pod a continuación.
pricegranularity Opcional (recomendado) Objeto Para obtener más información sobre el pricegranualrity objeto, consulte la sección Granularidad de precios a continuación. Para obtener una explicación más amplia sobre la configuración pricegranularityde , consulte la documentación de Prebid.
site Obligatorio Objeto Objeto contenedor que describe la página que envía el adpodrequestarchivo . Si site no se incluye, entonces el app parámetro debe estarlo.
user Opcional Objeto Objeto contenedor que describe el usuario del dispositivo.
video Opcional Objeto Objeto contenedor que describe el reproductor de vídeo.
xdyn_params Opcional Objeto Este objeto contiene parámetros específicos del licitador, de modo que cada clave es un nombre de licitador y el valor es un objeto JSON que contiene parámetros para ese licitador. Vea el ejemplo.

xdyn_params ejemplo

{
  "xdyn_params": {
    "appnexus": {
      "keywords": "key1=val1,key2=val2"
    }
  }
}

Aplicación

El app objeto admite los siguientes parámetros de solicitud.

Parámetro Ámbito Tipo Descripción
domain Obligatorio Cadena El dominio de la aplicación.
name Opcional Cadena El nombre de la aplicación.
bundle Opcional Cadena Un identificador de aplicación específico de la plataforma diseñado para ser único para la aplicación e independiente del intercambio. Debe ser un nombre de paquete o agrupación (por ejemplo, com.foo.mygame).
keywords Opcional Cadena Lista de palabras clave separadas por comas.
storeurl Opcional Cadena URL de la tienda de aplicaciones de una aplicación instalada.

Configuración de caché

El cache config objeto admite los siguientes parámetros de solicitud.

Parámetro Ámbito Tipo Descripción
ttl Opcional Entero Período de vida para una entrada de caché especificada en segundos.
disablecache Opcional Booleano La configuración predeterminada es false. Si se establece esta marca, la caché de PBS se deshabilita y la responsabilidad del almacenamiento en caché recae en el editor o en el proveedor del editor.

Contenido

El content objeto admite los siguientes parámetros de solicitud.

Parámetro Ámbito Tipo Descripción
album Opcional Cadena Álbum al que pertenece el contenido; Normalmente para audio.
artist Opcional Cadena Artista acreditado con el contenido.
airtime Opcional Entero La fecha y hora en que se emitió por primera vez el contenido.
cat Opcional Matriz de cadena Matriz de categorías de contenido de IAB que describen al productor de contenido. Consulta las especificaciones de la IAB.
channel Opcional Cadena Nombre del canal en el que se transmite el contenido.
contentrating Opcional Cadena Clasificación de contenido (por ejemplo, MPAA).
context Opcional Entero Tipo de contenido (juego, vídeo, texto, etc.). Consulta las especificaciones de la IAB.
data Opcional Matriz de objetos Datos de contenido adicionales. Cada objeto de datos representa un origen de datos diferente. Consulta las especificaciones de la IAB.
embeddable Opcional Booleano Indicador de si el contenido es insertable o no (por ejemplo, un reproductor de vídeo insertable), donde false = no, true = sí.
episode Opcional Entero Número de episodio.
ext Opcional Objeto Marcador de posición para extensiones de OpenRTB específicas de Exchange.
genre Opcional Cadena Género que mejor describe el contenido (por ejemplo, rock, pop, etc.).
id Opcional Cadena Identificador que identifica exclusivamente el contenido.
isrc Opcional Cadena International Standard Recording Code conforme a ISO-3901.
keywords Opcional Cadena Lista separada por comas de palabras clave que describen el contenido.
language Opcional Cadena Lenguaje de contenido mediante ISO-639-1-alpha-2.
len Opcional Entero Duración del contenido en segundos; Adecuado para vídeo o audio.
livestream Opcional Booleano true = en vivo, false = no en vivo (por ejemplo, transmisión, registro en vivo).
network Opcional Cadena La empresa matriz de primer nivel o, en su caso, una submarca que posee varios canales similares a la televisión, marcas de contenido d2c o propiedades digitales en las que se está visualizando el contenido.
prodq Opcional Entero Calidad de producción. Consulta las especificaciones de la IAB.
producer Opcional Objeto Detalles sobre el contenido producer. Consulta las especificaciones de la IAB.
qagmediarating Opcional Entero Clasificación de medios según las directrices de IQG. Consulta las especificaciones de la IAB.
season Opcional Cadena Temporada de contenido (por ejemplo, "Temporada 3").
series Opcional Cadena Ejemplos en vídeo: "The Office" (televisión), "Star Wars" (película) o "Arby 'N' The Chief" (hecha para web).
Ejemplo que no es vídeo: "Ecocéntrico" (blog de la revista Time).
sourcerelationship Opcional Entero 0 = indirecto, 1 = directo.
title Opcional Cadena Título del contenido.
Ejemplos en vídeo: "Search Committee" (televisión), "A New Hope" (película) o "Endgame" (hecha para la web).
Ejemplo que no es vídeo: "Por qué un glaciar antártico se está derritiendo tan rápidamente" (artículo de la revista Time).
url Opcional Cadena Dirección URL del contenido, para contextualización o revisión por parte de la compra.
userrating Opcional Cadena Valoración del contenido por parte del usuario (por ejemplo, número de estrellas, Me gusta, etc.).
videoquality Opcional entero; EN DESUSO Nota:Desusado a favor de prodq. Calidad de vídeo. Consulta las especificaciones de la IAB.
program_type Opcional Cadena Tipo de programa.

Dispositivo

El device objeto admite los siguientes parámetros de solicitud.

Parámetro Ámbito Tipo Descripción
ua Opcional Cadena El agente de usuario del explorador.
dnt Opcional Entero La marca estándar "No realizar seguimiento" establecida en el encabezado por el explorador. Los valores aceptados son:
- 0. El seguimiento no está restringido.
- 1. No rastrear.
lmt Opcional Entero La señal "Limitar seguimiento de anuncios" para dispositivos móviles (por ejemplo, iOS, Android). Los valores aceptados son:
- 0. El seguimiento no está restringido.
- 1. El seguimiento debe estar limitado por las directrices comerciales.
ip Opcional Cadena La dirección IP del dispositivo que realiza la solicitud de anuncio.
os Opcional Cadena El sistema operativo del dispositivo. Por ejemplo, "iOS".
h Opcional Entero La altura física de la pantalla en píxeles.
w Opcional Entero El ancho físico de la pantalla en píxeles.
devicetype Opcional Entero El tipo general de dispositivo. Los valores aceptados son:
- Mobile/Tablet
- Personal Computer
- Connected TV
- Phone
- Tablet
- Connected Device
- Set Top Box
ifa Opcional Cadena El identificador autorizado para el uso del anunciante sin cifrar (es decir, no con hash).
didsha1 Opcional Cadena El id. del dispositivo de hardware (por ejemplo, IMEI); Cifrado con hash a través de SHA1.
didmd5 Opcional Cadena El id. del dispositivo de hardware (por ejemplo, IMEI); con hash a través de MD5.
dpidsha1 Opcional Cadena El id. del dispositivo de plataforma (p. ej., id. de Android); Cifrado con hash a través de SHA1.
dpidmd5 Opcional Cadena El id. del dispositivo de plataforma (p. ej., id. de Android); con hash a través de MD5.
macsha1 Opcional Cadena La dirección MAC del dispositivo; Cifrado con hash a través de SHA1.
macmd5 Opcional Cadena La dirección MAC del dispositivo; con hash a través de MD5.

Eids

El eid objeto admite los siguientes parámetros de solicitud.

Parámetro Ámbito Tipo Descripción
source Obligatorio Cadena El origen o proveedor de tecnología.
id Obligatorio Cadena El identificador de usuario único.
rti_partner Obligatorio Cadena El id. del asociado.

Incluir categoría de marca

El includebrandcategory objeto admite los siguientes parámetros de solicitud.

Parámetro Ámbito Tipo Descripción
primaryadserver Opcional Entero Un entero cuyo valor representa el servidor de anuncios utilizado por el publicador. Los valores aceptados son:
- Freewheel
- Google Ad Manager

Site

El site objeto admite los siguientes parámetros de solicitud.

Parámetro Ámbito Tipo Descripción
page Obligatorio Cadena URL de la página donde se mostrará la impresión.
keywords Opcional Cadena Lista de palabras clave separadas por comas.

Usuario

El user objeto admite los siguientes parámetros de solicitud.

Parámetro Ámbito Tipo Descripción
buyeruid Opcional Entero El id. de usuario de Microsoft Monetize, si se conoce.
yob Opcional Entero El año de nacimiento del usuario como un entero de cuatro dígitos.
gender Opcional Entero El sexo del usuario. Los valores aceptados son:
- M: hombre
- F: mujer
- O: Se sabe que es otro.
keywords Opcional Cadena Lista de palabras clave que representan intereses o intenciones.
gdpr Opcional Objeto Objeto contenedor que describe la configuración de RGPD del usuario. Para obtener más información, consulte la sección GDPR a continuación.
privacy Opcional Cadena Cadena de privacidad del usuario de la CCPA.

Vídeo

El video objeto admite los siguientes parámetros de solicitud.

Parámetro Ámbito Tipo Descripción
context Opcional Entero Contexto en el que se mostrará el anuncio de vídeo.
- 0: Desconocido
- 1: Preroll
- 2: Midroll
- 3: Postroll
- 4: Outstream
- 5: En banner
w Opcional Entero El ancho del reproductor de vídeo en píxeles independientes del dispositivo.
h Opcional Entero La altura del reproductor de vídeo en píxeles independientes del dispositivo.
mimes Opcional Matriz de cadena Hay una gran variedad de reproductores de vídeo compatibles con tipos de mimo. Ejemplo: ["video/mp4"]
protocols Opcional Matriz de cadena Una variedad de protocolos de vídeo compatibles con el reproductor de vídeo. Los protocolos de vídeo aceptados son:
- VAST 1.0
- VAST 2.0
- VAST 3.0
- VAST 1.0 Wrapper
- VAST 2.0 Wrapper
- VAST 3.0 Wrapper
- VAST 4.0
- VAST 4.0 Wrapper
- DAAST 1.0
- DAAST 1.0 Wrapper

Pods

El pod objeto admite los siguientes parámetros de solicitud.

Parameeter Ámbito Tipo Descripción
podid Obligatorio Entero Identificador único del pod dentro de una solicitud particular. Se recomienda que estos se ordenen secuencialmente con un incremento de uno.
adpoddurationsec Obligatorio Entero La duración del adPodarchivo .
placementid Obligatorio Entero Identificador de emplazamiento con el que se relaciona un pod. Si placementid se omite entonces invcode y request.memberid son obligatorios.
invcode Opcional Cadena Código de inventario con el que se relaciona un pod. Si se invcode pasa, entonces el vendedor también debe pasar su ID de miembro en request.memberid.
Si invcode se omite, entonces placementid es obligatorio.

Configuración de pod

El pod config objeto admite los siguientes parámetros de solicitud.

Parámetro Ámbito Tipo Descripción
adomaindedupe Opcional Booleano Marca que indica si se debe desduplicar o no en función del dominio del anunciante (adomain valor en las respuestas de pujas de OpenRTB). Cuando se habilita, no hay dos pujas seleccionadas que tengan el mismo dominio de anunciante.
perpodkeys Opcional Booleano Marca que indica si los valores clave en respuesta deben configurarse para la separación competitiva por pod. Valores predeterminados de false. Cuando esta marca está habilitada, se agrega un _podX identificador a los nombres de clave devueltos, donde X comienza en 1 y aumenta en 1 para cada pod posterior.
Cada pod tiene un valor diferente hb_cache_id con el que sus pujas se almacenan en caché, lo que permite devolver valores idénticos hb_pb_cat_dur siempre que se produzcan en pods diferentes. Agrega identificadores de instancia al valor para permitir que se devuelvan ofertas similares incluso en los mismos pods. Los identificadores de instancia de los valores serán un postfijo de _pX donde X comienza en 0 y aumenta en 1 por cada oferta idéntica posterior. Por ejemplo, con perpodkeys la marca habilitada, una clave y un valor que normalmente tendrían el hb_pb_cat_dur siguiente aspecto: "hb_pb_cat_dur""15.00_airlines_30s"
En su lugar, tendrá este aspecto:
"hb_pb_cat_dur_pod1": "15.00_airlines_30s_p0"
pods Obligatorio Objeto Objeto contenedor para describir los adPodobjetos que se van a solicitar.
durationrangesec Obligatorio Entero Intervalo de duraciones de anuncios permitidas en la respuesta. Para obtener más detalles sobre el intervalo de duración, consulte la sección Intervalo de duración a continuación.
requireexactduration Opcional Booleano Marca que indica si los anuncios enviados deben cumplir el requisito de duración exacta. La configuración predeterminada es false.

Intervalo de duración

Es podconfig.durationrangesec una matriz de enteros que representan la duración del espacio publicitario en el pod de anuncios:

podconfig.durationrangesec = [15, 30];

Nota:

Si requireexactduration se establece en false, la duración del anuncio se redondeará al valor más próximo de la durationrangesec matriz. La duración mínima de la puja es cero. Usando la configuración anterior, una oferta de 10 segundos se redondearía a quince segundos y una oferta de 18 segundos se redondearía a treinta.

Si requireexactduration se establece en true, solo se permitirán los anuncios cuya duración exacta coincida con la durationrangesec matriz. De nuevo, usando el ejemplo anterior, se permitiría un anuncio enviado con una duración de quince segundos, mientras que un anuncio enviado con una duración de 18 segundos sería rechazado.

Reglamento general de protección de datos (RGPD)

GDPR es una ley de privacidad de datos promulgada por la Unión Europea. El objetivo de GDPR es proporcionar medidas de privacidad y seguridad de datos más estrictas, así como divulgaciones e informes más fáciles de usar sobre las prácticas de protección de datos.

Parámetro Ámbito Tipo Descripción
user.gdpr Opcional Objeto Objeto contenedor que describe la configuración del RGPD.
gdpr.consentrequired Opcional Booleano Marca que indica si el RGPD está en vigor.
gdpr.consentstring Opcional Cadena Cadena, compuesta por una serie de números, que identifica el estado de consentimiento de un proveedor de tecnología publicitaria.

Granularidad del precio

Parámetro Ámbito Tipo Descripción
precision Opcional Entero Si se omite la precisión, el valor predeterminado será. Consulte la documentación de Prebid.
ranges Opcional Objeto Objeto contenedor que describe el intervalo de granularidad de precios.

Intervalos de granularidad de precios

Patámetro Ámbito Tipo Descripción
max Opcional Float La longitud máxima del rango.
increment Opcional Float La cantidad que se va a incrementar a través del intervalo.

Respuesta

Demand partners devuelve una respuesta a la solicitud de puja del pod de anuncios en formato JSON.

Pod de anuncios

Parámetro Tipo Descripción
adpods Object Objeto contenedor que describe las respuestas del partner de demanda de Prebid para cada ad pod una de las respuestas enviadas en la solicitud original.
adpods[...].podid Entero El id. del archivo ad pod.
adpods[...].targeting Objeto Objeto contenedor que describe las pujas de los partners de demanda previas a la puja para este pod traducidas en claves de segmentación. Para obtener más información sobre el adpods.targeting objeto, consulte la siguiente tabla .

Segmentación de pods de anuncios

Parámetro Tipo Descripción
hb_deal Cadena Código de oferta o id. de oferta externa de la oferta asociada. Se omite si esta oferta no está asociada a una oferta.
hb_pb Cadena La clave de segmentación del cubo de precios. El modelo de creación de depósitos de precios se define por la granularidad de precios de la solicitud y la configuración. El valor clave de destino del cubo de precios representa el precio de oferta redondeado.
hb_pb_cat_dur Cadena El valor de esta clave representa la concatenación de tres valores, el cubo de precios (), el código de categoría creativa y la duración del vídeo creativo.
Por ejemplo:
adpods[...]targeting.hb_pb

Esto indicaría un cubo de precios de 12,00 USD (si la moneda estuviera en dólares estadounidenses), un código de categoría de 135 (en el dominio del servidor de anuncios principal, como Freewheel o Google Ad Manager) y una duración de treinta segundos.

Nota: Este par clave-valor debe ser único en todas las pujas correspondientes a su pod de anuncio correspondiente. Si hay dos valores idénticos hb_pb_cat_dur , ImpBus eliminará una de las ofertas.
hb_cache_id Cadena El id. de caché de Prebid. Este valor se asigna al contenido de vídeo representado.

Nota:
Este par clave-valor debe ser único en todas las pujas de todos los pods de una sola solicitud. La clave real de caché creativa será una concatenación de este valor y hb_pb_cat_dur. Dado hb_pb_cat_dur que debe ser única en todas las pujas, esto garantiza que la clave real de la caché creativa será única. La clave de caché real se creará mediante macros, como se muestra a continuación:
${ hb_pb_cat_dur }_${ hb_cache_id }

El hb_cache_id valor será el mismo para todas las entradas de targeting[...] una sola respuesta.
hb_cache_host Cadena El nombre de host de la memoria caché donde se almacena el recurso creativo asociado a esta puja.

Ejemplo

Ejemplo de código

curl -X "POST" -H "Content-Type: application/json" -d 

{
   "podconfig":{
      "durationrangesec":[
         30
      ],
      "requireexactduration":false,
      "pods":[
         {
            "podid":1,
            "adpoddurationsec":60,
            "placementid":14997137
         }
      ]
   },
   "site":{
      "page":"https://www.foobar.com/1234.md"
   },
   "user":{
      "yob":1982,
      "gender":"M"
   },
   "device":{
      "ua":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_6_8) AppleWebKit/537.13 (KHTML, like Gecko) Version/5.1.7 Safari/534.57.2",
      "ip":"123.145.167.10",
      "devicetype":1,
      "ifa":"AA000DFE74168477C70D291f574D344790E0BB11"
   },
   "includebrandcategory":{
      "primaryadserver":1
   },
   "video":{
      "w":640,
      "h":480,
      "mimes":[
         "video/mp4"
      ],
      "protocols":[
         2,
         3
      ]
   },
   "content":{
      "episode":6,
      "title":"episodeName",
      "series":"TvName",
      "season":"season3",
      "len":900,
      "livestream":false,
      "genre":"comedy",
      "program_type":"series",
      "contentrating":"GA",
      "id":"ABCDEF12345678",
      "language":"EN",
      "network":"XTV",
      "channel":"XandrTV",
      "airtime":1657827359,
      "album":"showads",
      "cat":[
         "IAB1-7",
         "IAB19-18"
      ],
      "context":1,
      "embeddable":false,
      "isrc":"USXND2100112",
      "keywords":"prizeworth=5000,gameshow,edu=true",
      "prodq":"prosumer",
      "qagmediarating":1,
      "sourcerelationship":true,
      "url":"https://tvname.xandrtv.com/overview",
      "userrating":"4/5 recommended",
      "producer":{
         "id":"xndtv5401",
         "name":"XandrTV",
         "cat":[
            "IAB1-7",
            "IAB19-18"
         ],
         "domain":"xandrtv.com"
      },
      "data":[
         {
            "id":"xandr",
            "name":"xndtv",
            "segment":[
               {
                  "id":"11854",
                  "name":"repeat viewers",
                  "value":"973"
               }
            ]
         }
      ]
   },
   "pricegranularity":{
      "precision":2,
      "ranges":[
         {
            "max":30.00,
            "increment":1.00
         }
      ]
   }
}

Formatos compatibles con PSP y rutas de integración