Definir etiqueta
Esta función define parámetros para una ubicación de anuncio. Tenga en cuenta que no se deben especificar más de 12 ubicaciones por página. Devuelve un Tag
object
objeto que se puede usar más adelante después de definir.
defineTag({params})
Los parámetros que se enumeran a continuación se pueden enviar como argumentos en la función .
Parámetro | Tipo | Descripción |
---|---|---|
member |
Número | El identificador de miembro de la selección de ubicación (invalida la configuración global de setPageOpts() ). |
invCode |
Cadena | El código de selección de ubicación de esta ubicación. |
tagId |
Número | Identificador de selección de ubicación de la ubicación. |
sizes |
Matriz de números | Uno o varios tamaños de ubicación en el formato [300,250] ({{height, width}}) para un solo tamaño y [[300,250],[728,90]] para varios tamaños.Si se especifica más de un tamaño, el primero es el tamaño de ubicación y el resto son tamaños de promoción. Nota: Se sizes permite o sizeMapping por espacio de anuncios, no ambos. |
sizeMapping |
Matriz de objetos | Especifica un conjunto de tamaños en función de un tamaño mínimo de ventanilla. Esto permite a un vendedor establecer los tamaños que se deben usar en función del tamaño de la ventanilla. Si el tamaño de la ventanilla es menor que el más pequeño minWidth proporcionado, no se solicitará ningún anuncio para la ranura del anuncio. Los tamaños se pasan en el formato [300,250] para un solo tamaño y [[300,250],[728,90]] para varios tamaños.Cada objeto de la matriz contiene dos parámetros: - minWidth : especifica el ancho mínimo de la ventanilla. Por ejemplo, minWidth: 1024 .- sizes : especifica el tamaño del anuncio. Por ejemplo, sizes: [[300,250],[300,600]] .Nota: Se sizes permite o sizeMapping por espacio de anuncios, no ambos. |
targetId |
Cadena | Identificador único de una ranura de anuncio específica, creada por el publicador o vendedor. Corresponde a una div etiqueta en el cuerpo de la página donde debería aparecer el anuncio. La div etiqueta id debe establecerse en el mismo valor que .targetId |
forceCreativeId |
Número | Especifica el identificador de una creatividad que se debe forzar para que aparezca en esta ubicación. Forzar una creatividad le permite obtener una vista previa de un anuncio en un sitio, realizar pruebas o certificaciones y crear hojas rasgadas. Propina: Las creatividades también se pueden forzar en la cadena de consulta de la dirección URL del sitio web en el formato ast_override_[parameter]=[value]:[creative_id] , donde reemplazará parameter , value y creative_id según sea necesario. Puede pasar varias [value]:[creative_id] combinaciones separadas por una coma (por ejemplo, https://test.example.com/demo.html?ast_override_ index = 2 : 40611315 , 3 : 40611316 ).Puede elegir una de las siguientes opciones para . parameter div Especifica un identificador div de destino de la ranura de anuncios que se va a invalidar. En value , escriba el identificador div al que desea forzar creative_id .Para invalidar el div con id. apn_ad_slot_1 con creative 40611315 :https://test.example.com/demo.html?ast_override_div=apn_ad_slot_1:40611315 index Especifica el número de índice de la ranura de anuncio que se va a invalidar, a partir de 0 . En value Escriba el número de índice al que desea forzar creative_id .Para invalidar la ubicación 3ª definida con la creatividad 40611315 :https://test.example.com/demo.html?ast_override_index=2:40611315 tag_id Especifica el identificador de etiqueta de la ranura de anuncio que se va a invalidar. En value escriba el tag_id en el que desea forzar creative_id . Si el tamaño de la ranura del anuncio y la creatividad no coinciden, la creatividad se seguirá representando, pero se mostrará un mensaje de advertencia. El creativo no serviría en esta ranura de anuncio en una subasta en vivo.Para invalidar tag_id 8011968 con la creatividad 40611315 :https://test.example.com/demo.html?ast_override_tag_id=8011968:40611315 inv_code Especifica el código de inventario de la ranura de anuncios que se va a invalidar. En value Escriba el código de inventario al que desea forzar creative_id . Si el tamaño de la ranura del anuncio y la creatividad no coinciden, la creatividad se seguirá representando, pero se mostrará un mensaje de advertencia. El creativo no serviría en esta ranura de anuncio en una subasta en vivo.Para invalidar 40611315 : con la creatividad 40611315 :https://test.example.com/demo.html?ast_override_inv_code=9123450:40611315 Propina: Los parámetros de cadena de consulta enumerados anteriormente invalidarán cualquier valor especificado en el forceCreativeId parámetro de la etiqueta de anuncio. |
allowSmallerSizes |
Booleano | Indica si se permiten tamaños de anuncios más pequeños de los definidos en sizes . |
allowedFormats |
Matriz de cadenas | Indica los formatos deseados. Las opciones incluyen ['video', 'banner', 'native, 'audio']. Si allowedFormats se invocan, invalidará los tipos de medios asignados en la configuración de ubicaciones de Microsoft Monetize. No invoque allowedFormats para usar un formato de anuncio, como interstitials , que no está incluido en las opciones predefinidas. |
rendererOptions |
Objeto | Especifica una o varias opciones que se pueden pasar al representador para la representación personalizada. |
position |
Cadena | Identifique la colocación como por encima o por debajo del pliegue. Valores posibles: above o below . |
disablePsa |
Booleano | Indica si esta ubicación debe deshabilitar la visualización de PSA. |
nobidIfUnsold |
Booleano | Indica que se debe devolver un anuncio en blanco si la ubicación no se vende en lugar de un anuncio predeterminado o PSA. |
keywords |
Objeto | Conjunto de pares clave-valor aplicables a esta ubicación. Los segmentos de cadena de consulta se definen mediante pares clave-valor en este objeto. Las palabras clave que contienen guiones deben estar rodeadas por comillas simples. El procedimiento recomendado consiste en incluir siempre palabras clave entre comillas simples. Se puede definir un máximo de 100 pares clave-valor por etiqueta. Para pasar datos personalizados, use cualquiera de las palabras clave: pt1, pt2, pt3, pt4, pt5, pt6, pt7, pt8, pt9 .Estas palabras clave se pueden usar para pasar datos personalizados a través de ubicaciones administradas a creativos administrados de terceros, por ejemplo, pt1=products:ipad,ios,iphone . |
trafficSourceCode |
Cadena | Especifica el origen de terceros de esta impresión. |
alwaysUseXDomainIframe |
Booleano | Indica si la creatividad del anuncio debe cargarse en un iframe entre dominios. Esto evitará la pérdida de datos y no permitirá que el creativo acceda directamente a la página primaria. Nota: Este parámetro ha quedado en desuso a favor de enableSafeFrame . |
privateSizes |
Matriz de números | Tamaños adicionales que permiten servir solo para ofertas o paquetes personalizados (cuando la oferta o el paquete permiten tamaños privados). En el formato [300,250] para un solo tamaño y [[300,250],[728,90]] para varios tamaños. |
supplyType |
Cadena | Indica el tipo de suministro para esta ubicación. Los valores posibles son mobile_web , mobile_app o web . |
pubClick |
Cadena | Especifica una dirección URL proporcionada por el publicador para el seguimiento de clics de terceros. Se trata simplemente de un marcador de posición en el que el publicador puede insertar su propio seguimiento de clics. Este parámetro debe usarse para un seguimiento no codificado. Se espera que este parámetro sea el último parámetro de la dirección URL. Tenga en cuenta que el seguimiento de clics colocado en este parámetro solo se activará si el creativo ganador de la subasta usa el seguimiento de clics de Xandr correctamente. Por ejemplo, pubClick=https://click.adserver.com/ . |
reserve |
Número | Especifica el precio de reserva para este inventario. Este parámetro invalidará un precio preestablecido y establecerá el piso duro si no se usa Yield Management. Se supone que el precio está en la moneda del publicador. Por ejemplo, reserve=5.00 .Nota: Esta opción no está disponible en Microsoft Monetize y debe anexarse manualmente a la etiqueta de selección de ubicación. |
extInvCode |
Cadena | Especifica un valor predefinido pasado a través del ext_inv_code campo del cuerpo de la solicitud que se puede usar en la generación de informes. El valor debe escribirse en el sistema antes de registrarlo. Para obtener más información, vea Servicio de código de inventario externo. Por ejemplo, ext_inv_code='10039' . |
native |
Objeto | Un anuncio nativo es una colección de recursos individuales. Pueden ser un título, una descripción o una imagen. Este parámetro es opcional. No es necesario especificarlo en defineTag . Cualquier campo del native objeto configurado como {required:true} será necesario en el objeto de respuesta de la oferta. Si no está presente, la oferta no se agrega a la subasta. Los recursos de anuncios nativos se enumeran a continuación. |
externalImpId |
Cadena | Especifica el identificador único de una subasta generada externamente. Por ejemplo, externalImpId:'bacbab02626452b097f6030b3c89ac05' . |
enableSafeFrame |
Booleano | Especifica si esta ubicación se proporcionará en un contenedor SafeFrame. Para obtener más información, consulte SafeFrame API Reference. |
setSafeFrameConfig |
Booleano | Permite la configuración de SafeFrame, un iframe administrado que proporciona protección adicional al consumidor y control de publicador más allá del proporcionado por un iframe estándar. Para obtener más información, consulte SafeFrame API Reference. |
initCollapsed |
Objeto | Inicializa el iframe del anuncio a un tamaño cero. La única opción para el expandBy campo es creativa. Esta configuración proporciona a la creatividad la responsabilidad de expandir la ranura del anuncio llamando a la función resizeAd. |
prebid |
Booleano | Indica que la etiqueta que se solicita es para una puja de encabezado o una subasta previa. Esto devolverá el cpm en el adObj adObj.cpm . Sin embargo, el anuncio no se representará. Se supone que otro servidor de anuncios representará el anuncio si gana esta puja. |
usePmtRule |
Booleano | Indica si las reglas de pago deben aplicarse a una oferta antes de enviar la oferta al servidor de anuncios. El valor predeterminado es false. |
resizeAdParentDiv |
Booleano | Si se establece esta propiedad en true, se forzará el cambio de tamaño del contenedor Div principal de la creatividad de anuncios. Esto resulta especialmente útil al cambiar el tamaño de las creatividades de trama segura de banner cuando el div primario no cambia de tamaño en algunos entornos. De forma predeterminada, esta opción está desactivada. Nota: El valor establecido aquí se puede invalidar durante una llamada resizeAd. Para obtener más información, consulte la página resizeAd. |
globalPlacementId |
Cadena | Proporciona una manera de que los publicadores especifiquen su propio identificador de publicador global para representar la ubicación. |
renderingManagement |
Objeto | Objeto que especifica valores para representar características relacionadas, que influyen en cómo se representan los anuncios en una página web. Estas opciones también se establecen en el nivel setPageOpts para que se apliquen a todas las ranuras de anuncios de la página. - insertWrapperDiv : cuando está habilitado, AST agrega un elemento div adicional entre el div de AST utif principal y el contenedor Iframe (o safeframe) de AST para todas las ranuras de anuncios. Esta opción es útil para los publicadores que desean personalizar o controlar aún más el contenido del contenedor de anuncios sin modificar el contenedor div principal.Valor predeterminado: false - sandboxAdIframe : cuando está habilitado, AST agrega y rellena el atributo de espacio aislado HTML para el contenedor Iframe (o safeframe) de AST para todas las ranuras de anuncios con los valores del parámetro adecuado sandboxAttributes .Valor predeterminado: false - sandboxAttributes : los valores de estos atributos se aplican al atributo de espacio aislado HTML para los contenedores de anuncios Iframe (o safeframe) de AST cuando la configuración adecuada andboxAdIframe se establece en true. Para ver los valores adecuados para incluir en esta matriz, consulte la documentación del espacio aislado HTML. Si está habilitado, se recomienda incluir al menos allow-same-origin y allow-scripts asegurarse de que el contenido del iframe puede funcionar correctamente (omitir estos valores puede dar lugar a algunas advertencias en la consola del explorador). |
rewardedAds |
Booleano | Indica si el usuario recibe una recompensa por ver el anuncio. El valor predeterminado es falso. Establezca en true si el usuario recibe una recompensa; de lo contrario, establezca en false. |
msft_tag |
Objeto | Objeto que especifica campos únicos para puntos de datos específicos de Microsoft. A continuación se muestra una lista de los campos admitidos: - msan_kv : acepta una cadena de datos que se pasa directamente a MSAN. |
Puede contener dos objetos secundarios denominados datos e imágenes. Consulte a continuación para obtener más información sobre estas propiedades.
Matriz de objetos con los siguientes campos disponibles:
-
type: <integer>
nota: debe ser mayor que 500. required: <true | false>
max_length: <integer>
Matriz de objeto con los siguientes campos disponibles:
-
type: <integer>
- Debe ser mayor que 500 required: <true | false>
size: {width: <integer>, height: <integer>}
min_size: {width: <integer>, height: <integer>}
mimes: [<string>, <string2>, ...]
required: <true | false>
max_length: <number>
Donde el campo marcado required: true
será necesario en el objeto de respuesta de la puja. Si max_length
se especifica, las respuestas de estos campos no deben superar el max_length
número.
required: <true | false>
max_length: <number>
Donde el campo marcado required: true
será necesario en el objeto de respuesta de la puja. Si max_length
se especifica, las respuestas de este campo no deben superar el max_length
número.
required: <true | false>
sizes: [
{ width: <number>, height: <number> }
]
aspect_ratios: [
{min_width: <number>, min_height: <number>, ratio_width: <number>, ratio_height: <number>}
]
Donde el campo marcado required: true
será necesario en el objeto de respuesta de la puja.
Si sizes
se especifica, la respuesta de la imagen debe coincidir exactamente con las dimensiones de ancho y alto especificadas.
Si aspect_ratios
se especifican como alternativa a los tamaños, la imagen debe coincidir al menos con las dimensiones y el valor mínimos de alto/ aspect_ratios
ancho definidos.
required: <true | false>
sizes: [
{ width: <number>, height: <number> }
]
aspect_ratios: [
{min_width: <number>, min_height: <number>, ratio_width: <number>, ratio_height: <number>}
]
Donde el campo marcado required: true
será necesario en el objeto de respuesta de la puja.
Si sizes
se especifica, la respuesta de la imagen debe coincidir exactamente con las dimensiones de ancho y alto especificadas.
Si aspect_ratios
se especifican como alternativa a sizes
, la imagen debe coincidir al menos con las dimensiones y el valor mínimos de alto/ aspect_ratios
ancho definidos.
required: <true | false>
max_length: <number>
Donde este campo marcado required: true
será necesario en el objeto de respuesta de la oferta. Si max_length
se especifica, las respuestas de estos campos no deben superar el max_length
número.
required: <true | false>
Cuando este campo esté marcado como required: true
, el parámetro será necesario en el objeto de respuesta de la oferta.
required: <true | false>
Cuando este campo esté marcado como required: true
, el parámetro será necesario en el objeto de respuesta de la oferta.
<true | false>
Si es true, el publicador admite un vínculo de privacidad. El vínculo de privacidad se enviará al publicador en la respuesta de la puja.
required: <true | false>
min_duration: <number>
max_duration: <number>
Donde el campo marcado required: true
será necesario en el objeto de respuesta de la puja.
min_duration
y max_duration
los valores se especifican en milisegundos.
min_duration
default = 0
required: <true | false>
required: <true | false>
required: <true | false>
required: <true | false>
required: <true | false>
required: <true | false>
required: <true | false>
required: <true | false>
required: <true | false>
required: <true | false>
Formato:
native: {
title: {required: true},
body: {required: false, max_length: 300},
image: {required: true},
icon: {
required: false,
sizes: [{ width: 50, height: 50 }]
},
sponsoredBy: {required: true},
cta: {required: true},
clickUrl: {required: true},
privacySupported: true,
desc2: {required: true},
rating: {required: false},
displayUrl: {required: false},
likes: {required: true},
downloads: {required: false},
price: {required: false},
salePrice: {required: false},
rating: {required: true},
phone: {required: false},
address: {required: false},
custom: {
data: [{
type: 501,
required: false
}],
images: [{
type: 505,
required: false
}]
}
}
apntag.defineTag({
member: 958,
invCode: 'ABC1234',
alwaysUseXDomainIframe: true,
tagId: 123456,
sizes: [[300,250]], // only 1 of sizes or sizeMapping is allowed
sizeMapping: [ // only 1 of sizes or sizeMapping is allowed
{
"minWidth": 1024,
"sizes": [[300,250],[300,600]]
},
{
"minWidth": 400,
"sizes": [[320,50]]
}
],
targetId: 'apn_ad_slot_1',
forceCreativeId: 23456786,
allowSmallerSizes : true,
allowedFormats : ['banner', 'video'],
initCollapsed: { expandBy: 'creative' },
position : 'above',
disablePsa : true,
noBidIfUnsold: true,
keywords: {
'genre': ['rock', 'pop']
},
trafficSourceCode: 'ssp1',
privateSizes : [[300,600]], // coming soon
supplyType : 'mobile_web',
pubClick : 'http://pubc1.com', // coming soon
pubClickEnc : 'http%3A%2F%2Fpubcl.com', // coming soon
reserve : 5.01,
extInvCode : 'extcode1',
externalImpId: 'bacbab02626452b097f6030b3c89ac05',
enableSafeFrame: true,
safeframeConfig: {
allowExpansionByPush:true,
allowExpansionByOverlay:true
},
rendererOptions: {
playerTechnology: [
"html5",
"flash"
],
adText: "Ad",
showMute: true,
showVolume: true,
showProgressBar: true,
allowFullscreen: true,
skippable: {
videoThreshold: 15,
videoOffset: 5,
skipLocation: "top-left",
skipText: "Video can be skipped in %%TIME%% seconds",
skipButtonText: "SKIP"
}
},
usePmtRule : false,
resizeAdParentDiv: true,
globalPlacementId: 'testId123',
renderingManagement: {
insertWrapperDiv: true,
sandboxAdIframe: true,
sandboxAttributes: ['allow-same-origin', 'allow-scripts', 'allow-presentation']
}
});