Compartir a través de


Servicio de vídeo de formulario largo

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

Los clientes de Microsoft Monetize Ad Server no necesitan cambiar su integración actual en Microsoft Monetize, pueden omitir 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

En los pasos siguientes se describe el proceso de solicitud y respuesta de vídeo de formato largo:

  1. Los publicadores envían una solicitud de vídeo de forma larga al Bus de impresión (ImpBus) de Microsoft Monetize a través del /prebid/lfv punto de conexión. Esta solicitud contiene POST valores para el pod de anuncios, como la duración del anuncio, el ancho y el 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 de anuncios que se rellenarán en el pod de anuncios.
  3. Las configuraciones de Monetize se recuperan y ImpBus crea una solicitud OpenRTB con el número solicitado de ranuras de anuncios.
  4. ImpBus envía la solicitud de OpenRTB a todos los pujadores de Monetización de Microsoft, incluidos los asociados de demanda de PSP y Microsoft Invest
    1. Los asociados de demanda de Prebid devuelven ofertas, cada una con una subcategoría IAB única.
    2. Microsoft Invest y los pujadores externos tienen una categoría de marca única de Microsoft Monetize asociada a todas las pujas que se convierten en una subcategoría IAB. Para obtener más información, consulte Servicio de asignación de categorías de Adserver.
  5. ImpBus ejecuta la subasta de Microsoft Monetize Marketplace para determinar la puja ganadora de Microsoft Monetize.
  6. En función de la configuración del publicador y del servidor de anuncios recuperada en el paso tres, ImpBus traduce las subcategorías de IAB a las categorías principales del servidor de anuncios (Freewheel o Google Ad Manager). Para obtener más información, consulte Servicio de asignación de categorías de Adserver.
    1. En el caso de las pujas de Monetización de Microsoft, ImpBus se traducirá de la categoría Monetizar de Microsoft a la subcategoría 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 ÚNICO XML VAST.
  9. Los pares de destino clave-valor se generan para cada puja para hb_pby hb_pb_cat_dur,hb_cache_id.
  10. ImpBus devuelve una respuesta JSON con pares clave-valor de destino de prebid y el identificador de caché.

Diagrama que muestra el proceso de solicitud y respuesta.

API de REST

En la tabla siguiente se enumeran los parámetros obligatorios y opcionales para enviar una solicitud de puja de 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 está incluida en la solicitud, el parámetro de sitio debe ser .
auction_timeout_ms Opcional Entero Tiempo máximo en milisegundos para esperar a que se complete la subasta. El valor predeterminado es cero si no se especifica, lo que usa la configuración de tiempo de espera de la configuración global premium del servidor de prebid del miembro.
bcat Opcional Matriz de cadena Categorías de anunciante bloqueadas mediante 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é del servidor de prebid.
content Opcional Objeto Objeto contenedor que describe metadatos de contenido varios que se pueden usar para establecer como destino .adPod(s)
cur Opcional Cadena Valor predeterminado: USD. Moneda permitida para las claves de destino 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 Lista de identificadores de usuario unificados.
gpid Opcional Cadena Identificador de ubicación global. Identificador único de la ranura de anuncios entre plataformas. Para obtener más información sobre la ranura del anuncio prebido y el GPID, consulte la documentación de Prebid.
includebrandcategory Opcional Objeto Objeto contenedor que describe las entradas de categoría de marca.
memberid Opcional (obligatorio si se usan códigos de inventario) Entero Id. de miembro del vendedor.
podconfig Obligatorio Objeto Objeto contenedor para describir todas las configuraciones de 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 del precio a continuación. Para obtener una explicación más amplia sobre la configuración pricegranularity, consulte la documentación de Prebid.
site Obligatorio Objeto Objeto contenedor que describe la página que envía .adpodrequest Si site no se incluye, el app parámetro debe ser .
user Opcional Objeto Objeto contenedor que describe al 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 Dominio de la aplicación.
name Opcional Cadena Nombre de la aplicación.
bundle Opcional Cadena 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 paquete o un nombre de paquete (por ejemplo, com.foo.mygame).
keywords Opcional Cadena Lista separada por comas de palabras clave.
storeurl Opcional Cadena Dirección URL de la Tienda de aplicaciones para 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 Tiempo de vida de 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 está deshabilitada y la responsabilidad del almacenamiento en caché es del publicador o del proveedor del publicador.

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 el audio.
artist Opcional Cadena Artista acreditado con el contenido.
airtime Opcional Entero Fecha y hora a la que se transmitió por primera vez el contenido.
cat Opcional Matriz de cadena Matriz de categorías de contenido de IAB que describen el productor de contenido. Consulte las especificaciones de IAB.
channel Opcional Cadena Nombre del canal en el que se emite el contenido.
contentrating Opcional Cadena Clasificación de contenido (por ejemplo, MPAA).
context Opcional Entero Tipo de contenido (juego, vídeo, texto, etc.). Consulte las especificaciones de IAB.
data Opcional Matriz de objetos Datos de contenido adicionales. Cada objeto Data representa un origen de datos diferente. Consulte las especificaciones de IAB.
embeddable Opcional Booleano Indicador de si el contenido se puede insertar (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 específicas del intercambio en OpenRTB.
genre Opcional Cadena Género que mejor describe el contenido (por ejemplo, rock, pop, etc.).
id Opcional Cadena Identificador que identifica de forma única el contenido.
isrc Opcional Cadena Código de grabación estándar internacional conforme a la norma 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 Longitud del contenido en segundos; adecuado para vídeo o audio.
livestream Opcional Booleano true = live, false = not live (por ejemplo, stream, live log).
network Opcional Cadena La empresa primaria de nivel superior o, si procede, una submarca que posee varios canales similares a tv, marcas de contenido d2c o propiedades digitales en las que se está viendo el contenido.
prodq Opcional Entero Calidad de producción. Consulte las especificaciones de IAB.
producer Opcional Objeto Detalles sobre el contenido producer. Consulte las especificaciones de IAB.
qagmediarating Opcional Entero Clasificación multimedia según las directrices de IQG. Consulte las especificaciones de IAB.
season Opcional Cadena Temporada de contenido (por ejemplo, "Temporada 3").
series Opcional Cadena Ejemplos de vídeo: "The Office" (televisión), "Star Wars" (película) o "Arby 'N' The Chief" (hecho para web).
Ejemplo que no es de vídeo: "Ecocéntrico" (blog de Time Magazine).
sourcerelationship Opcional Entero 0 = indirecto, 1 = directo.
title Opcional Cadena Título del contenido.
Ejemplos de vídeo: "Search Committee" (televisión), "A New Hope" (película) o "Endgame" (hecho para web).
Ejemplo que no es de 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 en el lado de compra.
userrating Opcional Cadena Clasificación por el usuario del contenido (por ejemplo, número de estrellas, me gusta, etc.).
videoquality Opcional entero; OBSOLESCENTE Nota:En desuso a favor de prodq. Calidad de vídeo. Consulte las especificaciones de 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 Agente de usuario del explorador.
dnt Opcional Entero Marca estándar "Do Not Track" establecida en el encabezado por el explorador. Los valores aceptados son:
- 0. El seguimiento no está restringido.
- 1. No realice el seguimiento.
lmt Opcional Entero La señal "Limitar el 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 según las directrices comerciales.
ip Opcional Cadena Dirección IP del dispositivo que realiza la solicitud de anuncio.
os Opcional Cadena Sistema operativo del dispositivo. Por ejemplo, "iOS".
h Opcional Entero Alto físico de la pantalla en píxeles.
w Opcional Entero Ancho físico de la pantalla en píxeles.
devicetype Opcional Entero 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 en la versión clara (es decir, no con hash).
didsha1 Opcional Cadena El identificador del dispositivo de hardware (por ejemplo, IMEI); hash a través de SHA1.
didmd5 Opcional Cadena El identificador del dispositivo de hardware (por ejemplo, IMEI); hash a través de MD5.
dpidsha1 Opcional Cadena El identificador de dispositivo de la plataforma (por ejemplo, id. de Android); hash a través de SHA1.
dpidmd5 Opcional Cadena El identificador de dispositivo de la plataforma (por ejemplo, id. de Android); hash a través de MD5.
macsha1 Opcional Cadena La dirección MAC del dispositivo; hash a través de SHA1.
macmd5 Opcional Cadena La dirección MAC del dispositivo; 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 Proveedor de origen o tecnología.
id Obligatorio Cadena Identificador de usuario único.
rti_partner Obligatorio Cadena Identificador de 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 Entero cuyo valor representa el servidor de anuncios usado 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 Dirección URL de la página donde se mostrará la impresión.
keywords Opcional Cadena Lista separada por comas de palabras clave.

Usuario

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

Parámetro Ámbito Tipo Descripción
buyeruid Opcional Entero El identificador de usuario de Monetizar de Microsoft, 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:masculino
- F:hembra
- 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 del RGPD del usuario. Para obtener más información, consulte la sección RGPD a continuación.
privacy Opcional Cadena Cadena de privacidad del usuario de 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: preinscripción
- 2: Midroll
- 3: Postroll
- 4: outstream
- 5: en banner
w Opcional Entero Ancho del reproductor de vídeo en píxeles independientes del dispositivo.
h Opcional Entero Alto del reproductor de vídeo en píxeles independientes del dispositivo.
mimes Opcional Matriz de cadena Matriz de tipos mime compatibles con reproductores de vídeo. Ejemplo: ["video/mp4"]
protocols Opcional Matriz de cadena Matriz 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

Vainas

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 determinada. Se recomienda ordenarlos secuencialmente con un incremento de uno.
adpoddurationsec Obligatorio Entero Duración de .adPod
placementid Obligatorio Entero Identificador de ubicación al que se relaciona un pod. Si placementid se omite entonces invcode y request.memberid son necesarios.
invcode Opcional Cadena Código de inventario al que se relaciona un pod. invcode Si se pasa, el vendedor también debe pasar su identificador de miembro en request.memberid.
Si invcode se omite, placementid es necesario.

Configuración del 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 en función del dominio del anunciante (adomain valor en las respuestas de puja de OpenRTB). Cuando se habilita, ninguna de las dos pujas seleccionadas puede tener el mismo dominio de anunciante.
perpodkeys Opcional Booleano Marca que indica si los valores de 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 se almacenan en caché sus pujas, lo que permite devolver valores idénticos hb_pb_cat_dur siempre y cuando se produzcan en pods diferentes. Agrega identificadores de instancia al valor para permitir que se devuelvan pujas 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 puja idéntica posterior. Por ejemplo, con perpodkeys la marca habilitada, una clave y un hb_pb_cat_dur valor que normalmente tendrían el siguiente aspecto: "hb_pb_cat_dur""15.00_airlines_30s"
En su lugar, tendrá el siguiente aspecto:
"hb_pb_cat_dur_pod1": "15.00_airlines_30s_p0"
pods Obligatorio Objeto Objeto contenedor para describir las adPod(s) 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

podconfig.durationrangesec es una matriz de enteros que representan las duraciones de la ranura del anuncio dentro del 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 cercano de la durationrangesec matriz. La duración mínima de la puja es cero. Con la configuración anterior, una oferta de 10 segundos se redondearía a quince segundos y una puja de 18 segundos se redondeaba a treinta.

Si requireexactduration se establece en true, solo se permitirán los anuncios que coincidan con la duración exacta de la durationrangesec matriz. Una vez más, con 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 se rechazaría.

Reglamento general de protección de datos (RGPD)

RGPD es una ley de privacidad de datos promulgada por la Unión Europea. El objetivo del RGPD es proporcionar medidas de privacidad y seguridad de datos más estrictas y divulgaciones más fáciles de usar e informes sobre 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, formada por una serie de números, que identifica el estado de consentimiento de un proveedor de tecnología de anuncios.

Granularidad del precio

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

Intervalos de granularidad de precios

Patameter Ámbito Tipo Descripción
max Opcional Float Longitud máxima del intervalo.
increment Opcional Float Cantidad que se va a incrementar a través del intervalo.

Respuesta

Los asociados de demanda devuelven una respuesta a la solicitud de puja del pod de anuncio en formato JSON.

Pod de anuncios

Parámetro Tipo Descripción
adpods Object Objeto contenedor que describe las respuestas del asociado de demanda de prebid para cada ad pod uno de los enviados en la solicitud original.
adpods[...].podid Entero Identificador del correspondiente ad pod.
adpods[...].targeting Objeto Objeto contenedor que describe las pujas de asociados de demanda prebid para este pod traducidas en claves de destino. Para obtener más detalles sobre el adpods.targeting objeto, consulte la tabla siguiente.

Segmentación de pods de anuncios

Parámetro Tipo Descripción
hb_deal Cadena Código de oferta o identificador de oferta externa de la puja asociada. Se omite si esta oferta no está asociada a una oferta.
hb_pb Cadena Clave de destino del cubo de precios. El modelo de cubos de precios se define mediante el valor pricegranularity de la solicitud y la configuración. El valor clave-valor del depósito de precios representa el precio de puja 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 de la creatividad de vídeo.
Por ejemplo:
adpods[...]targeting.hb_pb

Esto indicaría un depósito de precio 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 valor 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 pujas.
hb_cache_id Cadena El identificador de caché de prebid. Este valor se asigna al contenido de vídeo representado.

Nota:
Este valor clave-valor debe ser único en todas las pujas de todos los pods de una sola solicitud. La clave de caché creativa real será una concatenación de este valor y hb_pb_cat_dur. Dado hb_pb_cat_dur que debe ser único en todas las pujas, esto garantiza que la clave de caché creativa real 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 cada entrada de en targeting[...] una única respuesta.
hb_cache_host Cadena Nombre de host de la memoria caché donde se almacena la creatividad asociada 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 y rutas de integración compatibles con PSP