Contenido

¿Cómo implemento los tags de Header Bidder en mi sitio?

Cuando la configuración de HB esté lista se podrá proceder a la implementación de los tags que se encuentran en la pestaña IMPLEMENTACIÓN.

• Implementación Display directa en el sitio
• Implementación Display mediante Google Tag Manager
• Implementación para espacios de Video Instream (VAST)
• Implementación mediante Prebid
• Implementación mediante Prebid Server
• Implementación Display en sitios  AMP

 ¿Cómo realizo una implementación Display directa en el sitio?

Para realizar una implementación directa en el sitio, primero debemos extraer el tag de la plataforma administrativa, y luego implementarlo en  nuestro sitio. En algunos casos excepcionales, quizá debamos aplicar algún modificador del tag.

Extracción del tag

Si deseamos implementar Header Bidder directamente en el sitio, debemos ir a la pestaña IMPLEMENTACIÓN (1), Luego dentro del cuadro Implementación para display(2) y seleccionar IMPLEMENTACION DIRECTA (3)  . Por último debemos copiar el código  que se mostrará debajo (4). El mismo código que se muestra en pantalla puede ser copiado también haciendo click en el ícono copiar que se encuentra en la esquina superior derecha (5).

Implementación del tag

Una vez extraído el tag, este código debe brindarse al webmaster para que sea implementado  en las páginas del sitio o los sitios a monetizar dentro del header del mismo, ANTES del comienzo del tag de DFP

Implementaciones especiales que requieran modificadores del tag

Si bien el tag fue diseñado para soportar la mayor flexibilidad de casos de implementación posibles, y es extraño que existan inconvenientes ante la correcta implementación,  existe la posibilidad  de que nuestro sitio utilice una naturaleza de ejecución alternativa a los métodos estandar del mercado. Esto podría llegar a ocasionar resultados finales diferentes a los deseados. En caso de presentarse cualquier tipo de dificultad de implementación, debemos contactar inmediatamente al equipo de soporte de E-Planning para que nos brinde su asistencia. La plataforma posee un acceso directo para ponernos en contacto con el equipo de Soporte mediante el icono de la parte superior derecha de la interfaz:

Luego de evaluar el caso, el equipo de soporte puede indicarnos aplicar  uno de los siguientes modificadores sobre el tag para optimizar su función:

usedivname

E-Planning Header Bidder identifica los espacios de DFP mediante su nombre. Sin embargo, existen métodos de implementación no habituales de DFP donde la detección de espacios mediante el nombre puede presentar inconvenientes. En estos casos, el modificador usedivname indica a E-Planning Header Bidder utilizar un método de identificación alternativo basado en el contenedor del espacio.

timeout

E-Planning aguarda hasta la renderización efectiva de espacios de DFP hasta que la pagina termine de cargar o hasta que todos los espacios definidos de DFP ejecuten su renderización en algún lugar efectivo del sitio. En algunos casos de implementación de DFP,  la renderización de los espacios definidos de DFP es condicional, por lo que esperarlos hasta la carga definitiva de la pagina es una perdida de tiempo innecesaria que demora la activación de la publicidad. Para evitar estos casos, E-Planning Header Bidder posee configurado un tiempo máximo de espera para la renderizacion de los slots antes de comenzar la subasta. En caso de ser necesario, este tiempo de espera puede ser modificado mediante el modificador timeout en milisegundos

ma

E-Planning identifica todos los slots definidos para DFP, pero aguarda su renderizacion efectiva para subastarlos. El modificador ma permite limitar el maximo de slots a subastar al numero definido en el ,mismo. En caso de definirse un valor N para este modificador, solo se consideraran los primeros N slots en ser definidos.

be

En ocasiones es necesario evitar que algún subconjunto de  slots sea subastado. Mediante el modificador be se puede especificar una lista de slots que serán ignorados por E-Planning HB y procederan con el tratamiento normal de DFP. Esto se puede especificar mediante un string que describa un json que enumere los identificadores de los slots, o mediante una expresión regular que matchee con los slots a filtrar. En este ultimo caso, la expresión debe delimitarse por el símbolo de admiración ("!").

gtimeout

 Desde que el tag de DFP inicia su ejecución hasta que este configura todas sus variables internas, existe una demora inferior a los 300 ms. Por defecto, E-Planning espera el tiempo mínimo necesario para que este complete su setup. En algunos casos, la implementación de DFP necesita tiempos mayores para configurarse antes de comenzar a funcionar. En estos casos, se puede extender el tiempo de espera de E-Planning Header Bidder mediante el modificador gtimeout.

disableinitialload

En una ejecución normal, el tag de DFP realiza su setup, E-Planning Header Bidder detiene por unos milisegundos su ejecución, subasta los espacios y luego vuelve a activar solo aquellos espacios donde no hubo un mejor comprador. Sin embargo, existe la posibilidad de que en la implementación DFP se encuentre intencionalmente detenido. o no se desee reactivar hasta que un evento particular del sitio ocurra. En estos casos, el modificador disableinitialload indicara a E-Planning DFP no intervenir en la desactivación, activación y recarga de los espacios de DFP.

tip, tip<n>

En algunos casos, se desea mediante herramientas externas poder contabilizar los anuncios mostrados mediante Header Bidder. Este modificador permite incorporar un pixel de conteo que sera invocado cada vez que Header Bidder muestre anuncios. Se pueden incorporar mas urls de conteo externas utilizando un indice incremental a partir de 2 al final del modificador, quedando data-tip, data-tip2, data-tip3 .. data-tipN

ss

En una ejecución normal, E-Planning Header Bidder verifica los espacios implementados de DFP, y realiza un único request a sus servidores para subastarlos. Luego, en base al resultado de esa subasta, renderiza los anuncios ganadores de la subasta deteniendo DFP, o permite a DFP renderizar el slot.
Cuando se incorpora el modificador ss, se activa el modo "Single Slot". En esta modalidad, DFP es detenido, y los espacios deben ser activados manualmente invocando el metodo hbepl.callSingleSlot(<slot>), siendo <slot> una referencia a un slot de DFP. En el momento en que este método sea invocado, sera subastado el slot en cuestion, y según corresponda, renderizado el anuncio ganador o reactivada la renderización de DFP.

Esto permite realizar asincrónicamente la incorporación de espacios según vayan siendo requeridos por el sitio. 

dkt

Por defecto, nuestro Header Bidder captura todos los parámetros custom (Key, value) aplicados en los espacios de DFP, y los utiliza para optimizar la sincronización.  Existen implementaciones en donde estos parámetros se utilizan para la conexión entre la plataforma de un tercero con DFP, en cuyo caso el volumen de datos enviado es extenso. Incorporando el modificador dkt con valor "true", podemos forzar a EPL Header Bidder  para ignorar los parámetros custom de DFP y reducir la transferencia de datos necesaria.

↑ Regresar a la tabla de contenido ↑

¿Cómo realizo una Implementación Display mediante Google Tag Manager?

Google Tag Manager, aplica determinadas limitaciones que impiden el funcionamiento directo de un tag normal de Header Bidder.

Por este motivo, primero deberemos utilizar el tag especial diseñado para esta plataforma.

Extracción del tag

Si deseamos implementar Header Bidder mediante GTM, debemos ir a la pestaña IMPLEMENTACIÓN (1), Luego dentro del cuadro Implementación para display (2) y seleccionar GOOGLE TAG MANAGER (3)  . Por último debemos copiar el código  que se mostrará debajo (4). El mismo código que se muestra en pantalla puede ser copiado también haciendo click en el icono copiar que se encuentra en la esquina superior derecha (5).

Este tag es multiprotocolo, por lo que funcionara tanto en sitios http como https. Utilizando dinámicamente siempre el protocolo del sitio donde se implemente.

Carga del tag en GTM

1 Abrir el formulario de alta de un nuevo tag

•     1.A - Seleccionar Tags

•     1.B - Hacer click en NEW

2- En el campo Tag Configuration, hacer click en el icono para seleccionar el tipo de tag

3- Seleccionar tipo de tag HTML personalizado

4 - en el contenedor HTML, pegar el tag de Header Bidder para GTM

5 -  en el campo Triggering hacer click en el icono para seleccionar un trigger

6- En el listado de triggers seleccionar Página vista

7- Hacer click en SAVE para guardar el nuevo tag

8- En el caso de que sea la primera vez que el tag se guarde, nos solicitará colocar un nombre mas descriptivo

•         8.A Colocar un nombre mas descriptivo

•         8.B Hacer click en SAVE para guardar los cambios

9- Hacer click en SUBMIT para aplicar los cambios en producción

10- Incorporar la descripción de los cambios subidos a producción y publicarlos

•     10.A Colocar un nombre descriptivo a los cambios aplicados

•     10.B Colocar una descripción sobre los cambios aplicados (opcional)

•     10.C Hacer click en PUBLICAR para hacer efectivos los cambios.

↑ Regresar a la tabla de contenido ↑

¿Cómo realizo un refresh de los slots en una implementación display con monetización?

Si deseamos realizar un refresh de los anuncios de la pagina, contemplando una nueva monetización mediante las fuentes de demanda de E-Planning Header Bidder, podemos hacerlo ejecutando el siguiente comando javascript:

hbepl.refresh()

Este método recargara todos los espacios de DFP con un nuevo valor de correlator, volviendo a subastarlos.

↑ Regresar a la tabla de contenido ↑

¿Cómo realizo una Implementación para espacios de Video Instream (VAST)?

El trafico de video instream producido por los reproductores de video, debe ser administrado mediante el protocolo de comunicación VAST, por lo que requiere un tipo de tag especial. El mismo, consta únicamente de una url con la cual el player establecerá comunicación para solicitar publicidad. Header Bidder, provee una solución de monetización que permite subastar también este trafico. Para esto, debemos proceder de la siguiente manera:

Extracción del tag

Para extraer el tag de Header Bidder Video, debemos ir a la pestaña IMPLEMENTACIÓN (1), Luego dentro del cuadro Implementación para video (2)  . Por último debemos copiar el código  que se mostrará debajo (3). El mismo código que se muestra en pantalla puede ser copiado también haciendo click en el icono copiar que se encuentra en la esquina superior derecha (4).

Implementación del tag

Para implementar el tag obtenido, debemos reemplazar los tags implementados del adserver que utilicemos por la un nuevo tag formado por el extraido  desde la plataforma de E-Planning inmediatamente continuado por el tag original.

TAG_ORIGINAL →  TAG_HB+TAG_ORIGINAL

↑ Regresar a la tabla de contenido ↑

¿Cómo realizo una implementación Display en sitios AMP?,

Para realizar una implementación en sitios AMP, primero debemos extraer el tag de la plataforma administrativa, y luego implementarlo dentro de los tags de espacio de DFP. Por ultimo, debemos implementar un lineitem de callback para renderizar el anuncio en caso de ganar.

Extracción del tag

Si deseamos implementar Header Bidder directamente en el sitio, debemos ir a la pestaña IMPLEMENTACIÓN (1), Luego dentro del cuadro Implementación para display(2) y seleccionar AMP (3)  . Por último debemos copiar el código  que se mostrará debajo (4). El mismo código que se muestra en pantalla puede ser copiado también haciendo click en el ícono copiar que se encuentra en la esquina superior derecha (5).

Implementación del tag

Una vez extraído el tag, este debe implementarse como atributo en los tags  AMP-AD de DFP que querramos monetizar. Se puede ver como desde su documentación oficial: AMP Real Time Config

<amp-ad width=300 height=250
    type="doubleclick"
    data-slot="/77069040/Right1"
    >
</amp-ad>

rtc-config='{"urls": ["https://ads.us.e-planning.net/hb/1/18f66/ADCID/HB_AMP/ROS?&e=ATTR(width)xATTR(height)!ATTR(data-slot)&ur=HREF"], "timeoutMillis": 750}'

<amp-ad width=300 height=250
    type="doubleclick"
    data-slot="/77069040/Right1"
    rtc-config='{"urls": ["https://ads.us.e-planning.net/hb/1/18f66/ADCID/HB_AMP/ROS?&e=ATTR(width)xATTR(height)!ATTR(data-slot)&ur=HREF"], "timeoutMillis": 750}'
    >
</amp-ad>

Implementación del lineitem de renderización en callback

Como ultimo paso para utilizar  Header Bidder en sitios AMP, debemos crear en nuestra cuenta DFP un lineitem de callback. Podemos ver un instructivo completo sobre como realizar esta activación desde este Link

↑ Regresar a la tabla de contenido ↑

¿Cómo realizo una Implementación mediante Prebid?

E-Planning Header Bidder puede ser implementado en publishers que utilicen Prebid (http://prebid.org) como una nueva fuente de demanda.

Obtener soporte para E-Planning Header Bidder en Prebid

Para que la implementación de Prebid tenga soporte para E-Planning Header Bidder, se debe incluir en la librería de Prebid el adapter de E-Planning al momento de su descarga.

Para esto, en el momento de  ingresar al  Sitio de descarga de la libreria de Prebid, debemos incluir en la selección de las fuentes de demanda que se quieran utilizar, la fuente E-Planning.

Luego, la librería debe ser hosteada en en servidor prebid server utilizado, tal como lo indica su  documentación oficial

Obtención  de mi id de cliente único de Header Bidder

Para obtener el id único de cliente, debemos desde la plataforma acceder a IMPLEMENTACIÓN (1), luego en la sección Implementación para display (2) seleccionar la pestaña PREBID (3), donde podremos ver nuestro id único de cliente (4)

Declaración de los placements en mi sitio para ser monetizados también  por E-Planning HB

Siguiendo el ejemplo de la documentación oficial de Prebid, se debe agregar en cada placement que se quiera implementar el bidder 'eplanning' y cuyo objeto de configuracion cuente con el parámetro  'ci', cuyo valor se corresponda con el id de cliente unico de Header Bidder. 

 pbjs.que.push(function() {
	var adUnits = [
		{
			code: 'div-gpt-ad-1438287399331-0',
			sizes: [
				[300, 250],
				[300, 600]
			],
			bids: [
				{ 
					bidder: 'appnexus',
					params: { placementId: '4799418'}
				},
				{
					bidder: 'eplanning',
					params: { ci: '18f66' }
				}
			]
		}
	];
});

↑ Regresar a la tabla de contenido ↑

Cómo realizo una Implementación mediante Prebid Server?

E-Planning Header Bidder puede ser implementado en publishers que utilicen  Prebid  Server (http://prebid.org/prebid-server) como una nueva fuente de demanda.

Obtener soporte para E-Planning Header Bidder en Prebid Server

Para que la implementación de Prebid server tenga soporte para E-Planning Header Bidder, se debe incluir en la librería de Prebid el adapter de E-Planning , pero ademas, se bebe incluir el adapter  Prebid Server

Luego, la librería debe ser hosteada en en servidor Prebid Server utilizado, tal como lo indica su  documentación oficial

Obtención  de mi id de cliente único de Header Bidder

Para obtener el id único de cliente, debemos desde la plataforma acceder a IMPLEMENTACIÓN (1), luego en la sección Implementación para display (2) seleccionar la pestaña PREBID (3), donde podremos ver nuestro id único de cliente (4)

Declaración E-Planning HB como participe de Prebid Server

Para que E-Planning HB participe de la subasta Prebid Server, se debe incluir  'eplanning' dentro de la lista definida en el atributo bidders del objeto s2sConfig. 

pbjs.setConfig({
        s2sConfig: {
            accountId: '1',
            enabled: true,
            bidders: ['eplanning', 'AppNexus'],
            timeout: 1000,
            adapter: 'prebidServer',
            endpoint: 'https://prebid.adnxs.com/pbs/v1/openrtb2/auction',
            syncEndpoint: 'https://prebid.adnxs.com/pbs/v1/cookie_sync'
        }
    });

Declaración de los placements en mi servidor Prebid Server para ser monetizados también  por E-Planning HB

Si no se contaba con uno, primero, debemos crear un nuevo archivo Stored Request especifico para la configuración de  E-Planning:

stored_requests/data/by_id/stored_imps/<id>.json

Siendo <id> un identificador arbitrario que asignaremos  para el Stored Request.

En el mismo, se debe incorporar  el json de configuración del Stored Request, según lo indica su documentación oficial, asegurándonos de definir correctamente los tamaños a subastar, el dominio y la granularidad de subasta.

 {
    "imp": [
        {
            "ext": {
                "eplanning": {
                    "ci": "18f66"
                }
            },
            "banner": {
                "format": [
                    {
                        "h": 250,
                        "w": 300
                    },
                    {
                        "h": 90,
                        "w": 728
                    }
                ]
            },
            "id": "test-imp-id"
        }
    ],
    "ext": {
        "prebid": {
            "cache": {
                "bids": {}
            },
            "targeting": {
                "pricegranularity": "dense"
            }
        }
    },
    "id": "test-request-id-1",
    "site": {
        "page": "mydomain.com"
    }

}

En caso de que ya contáramos con uno existente, debemos modificar su configuración para incorporar en el placement  el bidder 'eplanning' y cuyo objeto de configuración cuente con el parámetro  'ci', cuyo valor se corresponda con el id de cliente unico de Header Bidder. 

 {
    "imp": [
        {
            "ext": {
				"appnexus": {
                    "placementId": '4799418'
                },
                "eplanning": {
                    "ci": "18f66"
                }
            },
            "banner": {
                "format": [
                    {
                        "h": 250,
                        "w": 300
                    },
                    {
                        "h": 90,
                        "w": 728
                    }
                ]
            },
            "id": "test-imp-id"
        }
    ],
    "ext": {
        "prebid": {
            "cache": {
                "bids": {}
            },
            "targeting": {
                "pricegranularity": "dense"
            }
        }
    },
    "id": "123456789",
    "site": {
        "page": "mydomain.com"
    }

}

↑ Regresar a la tabla de contenido ↑

¿Cómo doy soporte  AMP a Prebid Server?

Para dar soporte AMP a Prebid Server,  se deben cumplir dos etapas, la sincronizacion de usuarios, y la configuracion rtb de los slots.

Sincronización de usuarios en Prebid Server

Para sincronizar los usuarios en prebid server, es necesario dar soporte al componente amp-iframe implementando en el header de la pagina el tag de la libreria correspondiente.

<script async custom-element="amp-iframe" src="https://cdn.ampproject.org/v0/amp-iframe-0.1.js"></script>

<html amp lang="en">
<head>
	<meta charset="utf-8">
    <script async src="https://cdn.ampproject.org/v0.js"></script>
    <script async custom-element="amp-iframe" src="https://cdn.ampproject.org/v0/amp-iframe-0.1.js"></script>
    <title>Hello, AMPs</title>
	
...

Luego, al inicio del body, se debe implementar el siguiente código:

<amp-iframe width="1" title="User Sync" height="1" sandbox="allow-scripts allow-same-origin" frameborder="0" src="https://ads.us.e-planning.net/uspd/1/?du=https%3A%2F%2Fads.us.e-planning.net%2Fgetuid%2F1%2F5a1ad71d2d53a0f5%3Fhttps%3A%2F%2Fib.adnxs.com%2Fprebid%2Fsetuid%3Fbidder%3Deplanning%26gdpr%3D0%26gdpr_consent%3D%26uid%3D%24UID"><amp-img layout="fill" src="data:image/gif;base64,R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==" placeholder></amp-img></amp-iframe>

<!doctype html>
<html amp lang="en">
<head>
	<meta charset="utf-8">
    <script async src="https://cdn.ampproject.org/v0.js"></script>
    <script async custom-element="amp-iframe" src="https://cdn.ampproject.org/v0/amp-iframe-0.1.js"></script>
    <title>Hello, AMPs</title>
	<link rel="canonical" href="https://amp.dev/documentation/guides-and-tutorials/start/create/basic_markup/">
    <meta name="viewport" content="width=device-width,minimum-scale=1,initial-scale=1">
	<style amp-boilerplate>body{-webkit-animation:-amp-start 8s steps(1,end) 0s 1 normal both;-moz-animation:-amp-start 8s steps(1,end) 0s 1 normal both;-ms-animation:-amp-start 8s steps(1,end) 0s 1 normal both;animation:-amp-start 8s steps(1,end) 0s 1 normal both}@-webkit-keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}@-moz-keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}@-ms-keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}@-o-keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}@keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}</style>
	<noscript><style amp-boilerplate>body{-webkit-animation:none;-moz-animation:none;-ms-animation:none;animation:none}</style></noscript>
  </head>
  <body>
    <h1>Pixel Sync AMP</h1>

	<amp-iframe width="1" title="User Sync"
	  height="1"
	  sandbox="allow-scripts allow-same-origin"
	  frameborder="0"
	  src="https://ads.us.e-planning.net/uspd/1/?du=https%3A%2F%2Fads.us.e-planning.net%2Fgetuid%2F1%2F5a1ad71d2d53a0f5%3Fhttps%3A%2F%2Fib.adnxs.com%2Fprebid%2Fsetuid%3Fbidder%3Deplanning%26gdpr%3D0%26gdpr_consent%3D%26uid%3D%24UID">
	  <amp-img layout="fill" src="data:image/gif;base64,R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==" placeholder></amp-img>
	</amp-iframe>
  </body>
</html>
</body>
</html>

Configuración RTB de los slots

Una vez implementado el código de sincronización de los usuarios, debe implementarse como atributo en cada uno de los tags  AMP-AD de DFP que queramos monetizar, la configuración AMP Real Time Config de Prebid Server. La misma, consta de indicar el vendor PrebidAppNexus, cuyo objeto de configuración debe contener el atributo PLACEMENT_ID con valor respectivo al id indicado en el Stored Request configurado.

<amp-ad width=300 height=250
    type="doubleclick"
    data-slot="/77069040/Right1"
    >
</amp-ad>

<amp-ad width=300 height=250
    type="doubleclick"
    data-slot="/77069040/Right1"
    rtc-config='{"vendors": {"PrebidAppNexus": {"PLACEMENT_ID": "123456789"}}, "timeoutMillis": 950}'
    >
</amp-ad>

↑ Regresar a la tabla de contenido ↑ 

Contenido

 #la tabla de contenidos se llena automáticamente verificando los estilos de titulo (Titulo1, Titulo2, ... Titulo7)