_MACROS
Las MACROS son comandos que se utilizan para ser remplazados por nuestra plataforma por valores dinámicos al momento de enviar los datos de un anuncio al explorador de internet del usuario. Este documento lista todas las disponibles en E-Planning.
Contenido
- 1 ¿Qué uso puedo darles a las MACROS?
- 2 ¿En dónde puedo utilizar las MACROS?
- 3 ¿Cuáles son las macros disponibles actualmente?
- 3.1 Macros disponibles en tags de terceros y anuncios a partir de templates
- 3.1.1 $AD_ID
- 3.1.2 $CAMPAIGN_ID
- 3.1.3 $CLIENT_IP
- 3.1.4 $DOCUMENT_URL
- 3.1.5 $ENC_DOCUMENT_URL
- 3.1.6 $ENC_IMPTRACKURL
- 3.1.7 $ENC_LINKURL
- 3.1.8 $IMPTRACKURL
- 3.1.9 $LINKURL
- 3.1.10 $RANDOM
- 3.1.11 $SITE_ID
- 3.1.12 $SPACE_ID
- 3.1.13 $UAGENT
- 3.1.14 $KW_<keyword>
- 3.1.15 $ENC_KW_<keyword>
- 3.1.16 $KWT_<keyword>
- 3.1.17 $ENC_KWT_<keyword>
- 3.2 Macros extra disponibles en en tags de terceros y anuncios a partir de templates segmentados para eventos deportivos
- 3.2.1 $LOCAL_TEAM
- 3.2.2 $VISITOR_TEAM
- 3.2.3 $SCORE_LOCAL_TEAM
- 3.2.4 $SCORE_VISITOR_TEAM
- 3.2.5 $LOCAL_TEAM_<match_id>
- 3.2.6 $VISITOR_TEAM_<match_id>
- 3.2.7 $SCORE_LOCAL_TEAM_<match_id>
- 3.2.8 $SCORE_VISITOR_TEAM_<match_id>
- 3.3 Macros extra disponibles en los casos Rich Media de tags de terceros y anuncios a partir de templates
- 3.3.1 $RM_AD_BEGINNING
- 3.3.2 $RM_COMPLETED_AD
- 3.3.3 $RM_START_AD
- 3.3.4 $RM_PLAY_VIDEO
- 3.3.5 $RM_STOP_VIDEO
- 3.3.6 $RM_RESTART_AD
- 3.3.7 $RM_STOP_AUDIO
- 3.3.8 $RM_PLAY_AUDIO
- 3.3.9 $RM_CLOSE_AD
- 3.3.10 $RM_EXPAND_BANNER_AREA
- 3.3.11 $RM_SHRINK_BANNER_AREA
- 3.3.12 $RM_DELAYS_IN_VIDEO
- 3.3.13 $RM_AD_NOT_FOUND
- 3.3.14 $RM_OPEN_FULL_SCREEN
- 3.3.15 $RM_EXIT_FULL_SCREEN
- 3.3.16 $RM_SKIP_AD
- 3.3.17 $RM_PROGRESS_FIRST_QUARTILE
- 3.3.18 $RM_PROGRESS_MIDPOINT
- 3.3.19 $RM_PROGRESS_THIRD_QUARTILE
- 3.3.20 $RM_CUSTOM_ACTION_<n>
- 3.4 Macros disponibles en URL de conteo de impresiones, URL de conteo de Clicks, y URL de destino
- 3.4.1 $ad_id
- 3.4.2 $campaign_id
- 3.4.3 $client_ip
- 3.4.4 $document_url
- 3.4.5 $enc_document_url
- 3.4.6 $random
- 3.4.7 $site_id
- 3.4.8 $order_id
- 3.4.9 $space_id
- 3.4.10 $uagent
- 3.4.11 $kw_<keyword>
- 3.4.12 $enc_kw_<keyword>
- 3.4.13 $kwt_<keyword>
- 3.4.14 $enc_kwt_<keyword>
- 3.4.15 $ccid
- 3.4.16 $nccid
- 3.4.17 $country
- 3.4.18 $network
- 3.4.19 $uid
- 3.4.20 $click_id
- 3.5 Macros disponibles en pixels de conversión de terceros
- 3.5.1 $ptv
- 3.6 Macros disponibles en Anuncios Dinamicos DCO
- 3.6.1 $PBRAND
- 3.6.2 $LC_PBRAND
- 3.6.3 $PNAME
- 3.6.4 $LC_PNAME
- 3.6.5 $PCATEGORY
- 3.6.6 $LC_PCATEGORY
- 3.6.7 $PCATEGORY<n>
- 3.6.8 $LC_PCATEGORY<n>
- 3.1 Macros disponibles en tags de terceros y anuncios a partir de templates
¿Qué uso puedo darles a las MACROS?
El uso de las MACROS es para la inserción automática de valores que dinámicamente definen su valor dependiendo del contexto donde se esta mostrando una publicidad, brindando identificadores de un anuncio, urls de conteo, entre otros.
↑ Regresar a la tabla de contenido ↑
¿En dónde puedo utilizar las MACROS?
Las Macros pueden utilizarse en los siguientes casos:
Anuncio a partir de Template
Tags de terceros
Anuncios Dinámicos DCO
URL de conteo de impresiones
URL de Conteo de Clicks
URL de Destino
pixels de conversion de terceros
↑ Regresar a la tabla de contenido ↑
¿Cuáles son las macros disponibles actualmente?
Las macros disponibles actualmente dependen del caso de uso. A continuación, detallaremos cada uno de ellos.
Atención
Las macros son sensibles a mayúsculas y minúsculas. Es importante al utilizar una macro que esta sea escrita exactamente como se describe en su caso de uso.
↑ Regresar a la tabla de contenido ↑
Macros disponibles en tags de terceros y anuncios a partir de templates
$AD_ID
Si dentro de un tag de terceros escribimos el texto $AD_ID, al momento de mostrarse el tag este texto sera reemplazado automáticamente por el id del anuncio que E-Planning le asigno al momento de crearlo.
$CAMPAIGN_ID
Si dentro de un tag de terceros escribimos el texto $CAMPAIGN_ID, al momento de mostrarse el tag este texto sera reemplazado automáticamente por el id de la pauta de E-Planning en la que el anuncio mostrado esta cargado.
$CLIENT_IP
Si dentro de un tag de terceros escribimos el texto $CLIENT_IP, al momento de mostrarse el tag este texto sera reemplazado automáticamente por la ip del usuario que esta viendo el anuncio en ese momento.
$DOCUMENT_URL
Si dentro de un tag de terceros escribimos el texto $DOCUMENT_URL, al momento de mostrarse el tag este texto sera reemplazado automáticamente por la url completa de la pagina donde este anuncio esta mostrándose (incluyendo protocolo ruta y parámetros) .
$ENC_DOCUMENT_URL
Si dentro de un tag de terceros escribimos el texto $ENC_DOCUMENT_URL, al momento de mostrarse el tag este texto sera reemplazado automáticamente por la url completa y encodeada en codigo URI de la pagina donde este anuncio esta mostrándose (incluyendo protocolo ruta y parámetros) .
$ENC_IMPTRACKURL
Si dentro de un tag de terceros escribimos el texto $ENC_IMPTRACKURL, al momento de mostrarse el tag este texto sera reemplazado automáticamente por una url de conteo encodeada en código URI. Y la impresion del tag no se contabilizara hasta que esta url se llame.
Atención
Esta url cambia cada vez que se solicita la pieza, siendo unica en cada caso. Cada vez que el tag se muestra el reemplazo sera por una url diferente, y cada url diferente solo contabilizara una impresion por mas que se invoque múltiples veces
Atención
En E-Planning DSP la cuenta requiere una activación especial por el equipo de E-Planning para que esta macro funcione.
$ENC_LINKURL
Si dentro de un tag de terceros escribimos el texto $ENC_LINKURL, al momento de mostrarse el tag este texto sera reemplazado automáticamente por una url encodeada en código URI que al requerirse contabiliza un click en la pieza y redirige al destino de click definido al cargarla en E-Planning
Atención
Esta url cambia cada vez que se solicita la pieza, siendo unica en cada caso. Cada vez que el tag se muestra el reemplazo sera por una url diferente, y cada url diferente solo contabilizara un click por mas que se invoque múltiples veces. Aunque siempre redirigirá al destino del click en la pieza.
$IMPTRACKURL
Si dentro de un tag de terceros escribimos el texto $IMPTRACKURL, al momento de mostrarse el tag este texto sera reemplazado automáticamente por una url de conteo. Y la impresion del tag no se contabilizara hasta que esta url se llame.
Atención
Esta url cambia cada vez que se solicita la pieza, siendo unica en cada caso. Cada vez que el tag se muestra el reemplazo sera por una url diferente, y cada url diferente solo contabilizara una impresion por mas que se invoque múltiples veces
Atención
En E-Planning DSP la cuenta requiere una activación especial por el equipo de E-Planning para que esta macro funcione. Al activarse, disminuirá la prioridad de las campañas que utilicen esta macro en la competencia por la compra de las impresiones.
$LINKURL
Si dentro de un tag de terceros escribimos el texto $LINKURL, al momento de mostrarse el tag este texto sera reemplazado automáticamente por una url que al requerirse contabiliza un click en la pieza y redirige al destino del click definido al cargarla en E-Planning.
Atención
Esta url cambia cada vez que se solicita la pieza, siendo unica en cada caso. Cada vez que el tag se muestra el reemplazo sera por una url diferente, y cada url diferente solo contabilizara un click por mas que se invoque múltiples veces. Aunque siempre redirigirá al destino del click en la pieza.
$RANDOM
Si dentro de un tag de terceros escribimos el texto $RANDOM, al momento de mostrarse el tag este texto sera reemplazado automáticamente por un numero aleatorio de 10 digitos que sera diferente cada vez .
$SITE_ID
Si dentro de un tag de terceros escribimos el texto $SITE_ID, al momento de mostrarse el tag este texto sera reemplazado automáticamente por el id del sitio donde se este mostrando. El id es definido en E-Planning al momento de crear el sitio.
$SPACE_ID
Si dentro de un tag de terceros escribimos el texto $SPACE_ID, al momento de mostrarse el tag este texto sera reemplazado automáticamente por el id del espacio donde se este mostrando. El id es definido en E-Planning al momento de crear el espacio.
$UAGENT
Si dentro de un tag de terceros escribimos el texto $UAGENT, al momento de mostrarse el tag este texto sera reemplazado automáticamente por el user agent que el explorador del usuario defina.
$KW_<keyword>
Si dentro de un tag de terceros escribimos el texto $KW_ seguido inmediatamente por el identificador de una keyword definida en E-Planning que NO sea de tipo tabla de datos, al momento de mostrarse el tag este texto sera reemplazado automáticamente por el valor que esa keyword tiene al momento de realizarse la impresión.
$ENC_KW_<keyword>
Si dentro de un tag de terceros escribimos el texto $ENC_KW_ seguido inmediatamente por el identificador de una keyword definida en E-Planning que NO sea de tipo tabla de datos, al momento de mostrarse el tag este texto sera reemplazado automáticamente por el valor que esa keyword tiene al momento de realizarse la impresión en código URI.
$KWT_<keyword>
Si dentro de un tag de terceros escribimos el texto $KWT_ seguido inmediatamente por el identificador de una keyword definida en E-Planning que sea de tipo tabla de datos, al momento de mostrarse el tag este texto sera reemplazado automáticamente por el valor de la tabla de datos correspondiente al indice que esa keyword tiene al momento de realizarse la impresión.
$ENC_KWT_<keyword>
Si dentro de un tag de terceros escribimos el texto $ENC_KWT_ seguido inmediatamente por el identificador de una keyword definida en E-Planning que sea de tipo tabla de datos, al momento de mostrarse el tag este texto sera reemplazado automáticamente por el valor de la tabla de datos correspondiente al indice que esa keyword tiene al momento de realizarse la impresión en código URI.
↑ Regresar a la tabla de contenido ↑
Macros extra disponibles en en tags de terceros y anuncios a partir de templates segmentados para eventos deportivos
En los casos detags de terceros y anuncios a partir de templates segmentados para eventos deportivos, estaran disponibles TODAS las macros disponibles en tags de terceros y anuncios a partir de templates estandar(No Rich Media). Pero ademas, se incorporan las siguientes:
$LOCAL_TEAM
Al escribir dentro del tag de tercero o código del anuncio el texto $LOCAL_TEAM, este texto sera reemplazado automáticamente por el nombre del equipo local del evento deportivo para el cual fue segmentada la campaña.
$VISITOR_TEAM
Al escribir dentro del tag de tercero o código del anuncio el texto $VISITOR_TEAM, este texto sera reemplazado automáticamente por el nombre del equipo visitante del evento deportivo para el cual fue segmentada la campaña.
$SCORE_LOCAL_TEAM
Al escribir dentro del tag de tercero o código del anuncio el texto $SCORE_LOCAL_TEAM, este texto sera reemplazado automáticamente por la cantidad de anotaciones que lleva realizadas el equipo local en ese momento en dicho evento.
$SCORE_VISITOR_TEAM
Al escribir dentro del tag de tercero o código del anuncio el texto $SCORE_VISITOR_TEAM, este texto sera reemplazado automáticamente por la cantidad de anotaciones que lleva realizadas el equipo visitante en ese momento en dicho evento.
$LOCAL_TEAM_<match_id>
Al escribir dentro del tag de tercero o código del anuncio el texto $LOCAL_TEAM_ seguido inmediatamente por el identificador de un evento deportivo (match_id) , este texto sera reemplazado automáticamente por el nombre del equipo local del evento deportivo respectivo de dicho identificador.
$VISITOR_TEAM_<match_id>
Al escribir dentro del tag de tercero o código del anuncio el texto $VISITOR_TEAM_ seguido inmediatamente por el identificador de un evento deportivo (match_id) , este texto sera reemplazado automáticamente por el nombre del equipo visitante del evento deportivo respectivo de dicho identificador.
$SCORE_LOCAL_TEAM_<match_id>
Al escribir dentro del tag de tercero o código del anuncio el texto $SCORE_LOCAL_TEAM_ seguido inmediatamente por el identificador de un evento deportivo (match_id) , este texto sera reemplazado automáticamente por la cantidad de anotaciones que lleva realizadas el equipo local en ese momento en el evento respectivo de dicho identificador.
$SCORE_VISITOR_TEAM_<match_id>
Al escribir dentro del tag de tercero o código del anuncio el texto $SCORE_VISITOR_TEAM, _ seguido inmediatamente por el identificador de un evento deportivo (match_id) , este texto sera reemplazado automáticamente por la cantidad de anotaciones que lleva realizadas el equipo visitante en ese momento en el evento respectivo de dicho identificador.
↑ Regresar a la tabla de contenido ↑
Macros extra disponibles en los casos Rich Media de tags de terceros y anuncios a partir de templates
En los casos Rich Media de los tags de terceros y anuncios a partir de templates, están disponibles TODAS las macros disponibles en tags de terceros y anuncios a partir de templates estandar(No Rich Media). Pero ademas, se incorporan las siguientes:
$RM_AD_BEGINNING
Al escribir dentro del tag de tercero o código del anuncio el texto $RM_AD_BEGINNING, este texto sera reemplazado automáticamente por una url que al requerirse indicara al adserver que debe considerar que el anuncio pudo iniciar sus funciones sin inconvenientes. Dado que por definición, una impresión Rich Media se corresponde con el inicio de reproducción de una pieza, la impresión se contabilizara recién en el momento en que este llamado se realice. Ademas, siendo que este llamado indica el correcto inicio de funciones, hasta que no se realice se ignoraran todas las métricas de eventos Rich Media de la pieza.
Atención
La ausencia del llamado a esta url por parte del tag de terceros o anuncio a partir de template afectara severamente la contabilización de acciones.
Esta url cambia cada vez que se solicita la pieza, siendo única en cada caso. Cada vez que el tag se muestra el reemplazo sera por una url diferente, y cada url diferente solo contabilizara una vez por mas que se invoque múltiples veces.
$RM_COMPLETED_AD
Al escribir dentro del tag de tercero o código del anuncio el texto $RM_COMPLETED_AD, este texto sera reemplazado automáticamente por una url que al requerirse contabilizara en la pieza la métrica Rich Media Anuncio completo (el anuncio finalizó su reproducción)
Atención
Esta url cambia cada vez que se solicita la pieza, siendo única en cada caso. El llamado a esta url no tendrá efecto si se hace entes de haber indicado el inicio de funciones correcto del anuncio mediante la url que se reemplaza en la macro $RM_AD_BEGINNING
$RM_START_AD
Al escribir dentro del tag de tercero o código del anuncio el texto $RM_START_AD, este texto sera reemplazado automáticamente por una url que al requerirse contabilizara en la pieza la métrica Rich Media Anuncio encendido (el anuncio comenzó su reproducción)
Atención
Esta url cambia cada vez que se solicita la pieza, siendo única en cada caso. El llamado a esta url no tendrá efecto si se hace entes de haber indicado el inicio de funciones correcto del anuncio mediante la url que se reemplaza en la macro $RM_AD_BEGINNING
$RM_PLAY_VIDEO
Al escribir dentro del tag de tercero o código del anuncio el texto $RM_PLAY_VIDEO, este texto sera reemplazado automáticamente por una url que al requerirse contabilizara en la pieza la métrica Rich Media Reproducir video (el video del anuncio comenzó su reproducción)
Atención
Esta url cambia cada vez que se solicita la pieza, siendo única en cada caso. El llamado a esta url no tendra efecto si se hace entes de haber indicado el inicio de funciones correcto del anuncio mediante la url que se reemplaza en la macro $RM_AD_BEGINNING
$RM_STOP_VIDEO
Al escribir dentro del tag de tercero o código del anuncio el texto $RM_STOP_VIDEO, este texto sera reemplazado automáticamente por una url que al requerirse contabilizara en la pieza la métrica Rich Media Detener video (el video del anuncio detuvo su reproducción)
Atención
Esta url cambia cada vez que se solicita la pieza, siendo única en cada caso. El llamado a esta url no tendrá efecto si se hace entes de haber indicado el inicio de funciones correcto del anuncio mediante la url que se reemplaza en la macro $RM_AD_BEGINNING
$RM_RESTART_AD
Al escribir dentro del tag de tercero o codigo del anuncio el texto $RM_RESTART_AD, este texto sera reemplazado automáticamente por una url que al requerirse contabilizara en la pieza la metrica Rich Media Reiniciar Anuncio (El anuncio reinició su reproducción)
Atención
Esta url cambia cada vez que se solicita la pieza, siendo unica en cada caso. El llamado a esta url no tendra efecto si se hace entes de haber indicado el inicio de funciones correcto del anuncio mediante la url que se reemplaza en la macro $RM_AD_BEGINNING
$RM_STOP_AUDIO
Al escribir dentro del tag de tercero o codigo del anuncio el texto $RM_STOP_AUDIO, este texto sera reemplazado automáticamente por una url que al requerirse contabilizara en la pieza la metrica Rich Media Detener audio (El audio del anuncio detuvo su reproducción)
Atención