Establecer opciones de página
Esta función establece las ubicaciones de las opciones de nivel de página.
setPageOpts ({parameters})
Los parámetros que se enumeran a continuación se pueden enviar como argumentos en la función .
Parámetros
Parámetro | Tipo | Descripción |
---|---|---|
dsa |
objeto | Objeto que especifica la configuración junto con la Ley de Servicios Digitales (DSA). Consulte DSA Object (Objeto DSA) para obtener más información a continuación. |
msft |
objeto | Objeto que contiene valores de solicitud únicos para Microsoft. Consulte los detalles del objeto MSFT a continuación. |
member |
número | Identificador de miembro. |
publisherId |
número |
publisherId se puede usar cuando se usa un código de inventario. Esto garantiza que se usa el publicador adecuado para ayudar a elegir la ubicación predeterminada correcta. |
user |
objeto | Objeto que especifica información sobre un usuario externo. Consulte detalles del objeto de usuario a continuación. |
keywords |
objeto | Conjunto de pares clave-valor aplicables a todas las ranuras de anuncios de esta página. Los segmentos de cadena de consulta se definen mediante pares clave-valor en este objeto. Las palabras clave que contienen guiones deben incluirse entre comillas simples. El procedimiento recomendado consiste en rodear siempre palabras clave con comillas simples. Se puede definir un máximo de 100 pares clave-valor en el nivel de página. Cada etiqueta puede tener hasta 100 pares clave-valor adicionales definidos. |
disablePsa |
Booleano | Indica si todas las ubicaciones deben deshabilitar la visualización de PSA. Un valor de true deshabilitará todas las PSA globalmente. |
device |
objeto | Objeto complejo que declara e invalida el tipo de dispositivo, tal como se rellena en la solicitud de puja de Xandr. Consulte Detalles del objeto de dispositivo a continuación. |
enableSafeFrame |
Booleano | Especifica si todos los anuncios se enviarán en un contenedor SafeFrame. Para obtener más información, consulte la Referencia de la API de SafeFrame. |
app |
objeto | Objeto complejo que rellena la información de la aplicación. Es un objeto que contiene información relacionada con la aplicación. Consulte Detalles del objeto de aplicación a continuación. |
consentManagement |
objeto | Especifica si la administración de consentimientos está habilitada para cumplir con los requisitos de transparencia, notificación y elección/consentimiento en virtud de la ley de privacidad del estado de EE. UU. a través de la Plataforma global de privacidad, el RGPD y la Directiva ePrivacy. La administración del consentimiento está habilitada de forma predeterminada. Consulte los detalles del objeto de administración de consentimiento a continuación. |
auctionTimeout |
número | Cantidad de tiempo, en milisegundos, para esperar a que un licitador responda a una solicitud de puja. |
geoOverride |
objeto | Proporciona la capacidad de invalidar la ubicación geográfica basada en IP. Consulte Detalles de objetos de invalidación geográfica a continuación. |
schain |
objeto | Permite a los publicadores especificar su objeto de cadena de suministro para la solicitud que realizaron al servidor de anuncios. Puede encontrar más información sobre la especificación del objeto de cadena de suministro y su estructura con estos vínculos: - https://iabtechlab.com/sellers-json/ - https://github.com/InteractiveAdvertisingBureau/openrtb/blob/master/supplychainobject.md |
us_privacy |
string | Cadena que se ajusta a los requisitos del marco de cumplimiento de IAB CCPA . Vea el ejemplo de código para este campo a continuación. Advertencia: Este parámetro está previsto que esté en desuso en una fecha futura. |
pageUrl |
string | Este campo está establecido para admitir aplicaciones web progresivas que usan AST para mostrar anuncios en sus aplicaciones. El marco de desarrollo genera un referenciador no válido, bloqueado por nuestras reglas de IQ. Los publicadores que usan AST en sus aplicaciones de iOS deben establecer este campo para invalidar la información de referencia de url de página predeterminada (normalmente derivada por AST), por el valor HTTP(s) que consideren que representa mejor la página. Esta característica está diseñada principalmente para entornos móviles en los que la información del referenciador puede no reflejar las direcciones URL de página HTTP típicas. La característica solo se activará cuando se cargue la etiqueta AST en una vista web de la aplicación iOS. |
trackingManagement |
objeto | Objeto que especifica valores para realizar un seguimiento de las características relacionadas con la subasta y las creatividades (visibilidad, usersync, etc.). Consulte los detalles del objeto TrackingManagement a continuació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. Consulte los detalles del objeto RenderingManagement a continuación. |
content |
objeto | Objeto que especifica información sobre el contenido donde se mostrarán los anuncios. Consulte Objeto de contenido para obtener más información a continuación. |
Objetos
App (objeto)
Especifica información sobre la aplicación.
Parámetro | Tipo | Descripción |
---|---|---|
appid |
objeto | Objeto que define la información de identificación de la aplicación. |
Aquí le mostramos un ejemplo:
apntag.setPageOpts({
app: {
appid: 'com.mypackage.myapp'
}
});
DSA (objeto)
Especifica información relacionada con la Ley de servicios digitales. Para ver los valores ideales que se usarán para cada uno de los campos, consulte la especificación de IAB.
Parámetro | Tipo | Descripción |
---|---|---|
dsarequired |
número | Marca para indicar si la información de DSA debe estar disponible. |
pubrender |
número | Marca para indicar si el publicador representará la información de transparencia de DSA. |
transparency |
Matriz de objetos | Matriz de objetos de las entidades que aplicaron parámetros de usuario y los parámetros que aplicaron. |
MSFT (objeto)
Especifica información y configuración únicas para Microsoft.
Parámetro | Tipo | Descripción |
---|---|---|
toptout |
número | Número que representa el estado de las opciones de exclusión de MSFT del usuario final (por ejemplo 0 , , 1 , etc.) |
Schain (objeto)
La característica de AST permite a los publicadores realizar una comprobación de sintaxis opcional en el schain que especifican en el parámetro de configuración. Los criterios de sintaxis se basan en la especificación de IAB para el objeto schain.
- Si el publicador habilita la opción strict, el objeto config schain se comprobará exactamente y si hay un error en la estructura, se producirá un mensaje de error de AST en la consola y el objeto schain no se incluirá en la solicitud al adserver.
- Si el publicador habilita la opción relaxed, se comprobará el objeto config schain. Si hay algún error, se mostrará un mensaje de advertencia en la consola del explorador, pero el objeto schain se seguirá incluyendo en la solicitud al adserver.
- Si el publicador habilita la opción off, el objeto config schain no se comprobará en absoluto. Simplemente se incluirá en la solicitud al adserver, independientemente de si se ha formateado correctamente o no.
Nota:
Debe tener habilitada la marca de depuración de AST para ver los mensajes en la consola.
Aquí le mostramos un ejemplo:
schain: {
validation: 'strict', // strict, relaxed, or off - strict is default
config: {
ver: '1.0',
complete: 0,
nodes: [{
asi: 'testasi.com',
sid: 'test123sid',
hp: 1
}]
}
}
User (objeto)
Especifica información sobre un usuario externo al que se mostrarán los anuncios.
Parámetro | Tipo | Descripción |
---|---|---|
age |
número | La edad del usuario. |
dnt |
Booleano | No realice un seguimiento de la marca. Indica si las cookies de seguimiento deben deshabilitarse para esta subasta: - true (deshabilitar cookies)- false (Valor predeterminado)Nota: Cuando dnt:true , los datos de usuario no estarán disponibles a lo largo de la subasta, independientemente del envío de UID externo o UUID Xandr. El identificador aparecería como -1 en LLD, que representa la exclusión. |
externalUid |
string | Especifica una cadena que corresponde a un identificador de usuario externo para este usuario. Advertencia: externalUid solo se debe usar en entornos sin cookies. La aplicación fuera de esto puede dar lugar a una disminución de la tasa de coincidencias de usuarios (que afecta a la retargeting) o al aumento de la lista de bloqueos de usuarios a lo largo del tiempo. |
gender |
string | Especifica el género del usuario: - 0 :desconocido- 1 :masculino- 2 :hembra |
language |
string | El código ANSI de dos letras para el idioma de este usuario; por ejemplo, EN . |
segments |
matriz de números | Especifica los segmentos a los que el usuario es miembro. |
userIds |
matriz de objetos | Matriz que contiene objetos que contienen parámetros userId. Consulte Detalles del objeto de id . de usuario a continuación para obtener definiciones. |
coppa |
booleano | Cuando se habilita, esto incluye la marca coppa a la solicitud de subasta. |
User ID (objeto)
Parámetro | Tipo | Descripción |
---|---|---|
id |
string | Identificador nativo de la cookie o plataforma |
type |
string | Valor de origen del proveedor que proporciona el identificador incluido. Soluciones de identidad admitidas: - criteo : solución de identidad de criteo.- liveramp : solución de identidad de Liveramp.- netid : identificador de publicidad habilitado para dispositivos cruzados europeos.- ttd : la solución de identidad de trade desk 1.0.- uid2 : solución de identidad uid2. |
extendedIDs |
type | El publicador definió identificadores de primera entidad. |
eids |
matriz de objetos | El valor de eids solo es compatible con el tipo extendedIDs (todos los demás tipos definidos deben usar la cadena de identificador existente definida anteriormente). Los objetos dentro de esta matriz de eids tienen 2 parámetros, id y source: - id : idéntico al valor de id. existente en su propósito y descripción. - source : el proveedor de origen o tecnología utilizado por el publicador para controlar el identificador de primera entidad; generalmente expresado como un dominio. Consulte el ejemplo siguiente. |
Paso de identificadores universales en Monetize
Puede pasar un identificador universal para monetizar mediante AST.js
uno de los dos métodos: el método de identificador asignado (anterior) o el extendedIDs
método (más reciente).
Método de identificador asignado
Este método permite pasar un número limitado de identificadores universales. La lista de identificadores admitidos se codifica de forma rígida en el AST.js
código. Use este método cuando los identificadores universales se encuentra entre los tipos admitidos.
JSON de ejemplo
{
"type": "liveramp",
"id": "0d7e95c7-4783-4278-acf9-99809d0c5a61"
}
ExtendedIDs
método
El extendedIDs
método es más flexible y admite todos los identificadores universales y los identificadores proporcionados por el publicador (PPID). Use este método para pasar los identificadores dinámicamente.
JSON de ejemplo
{
"type": "extendedIDs",
"eids": [
{
"source": "liveramp.com",
"id": "2d7e95c7-4783-4278-acf9-99809d0c5a62"
}
]
}
En este ejemplo:
-
source
es el dominio o proveedor que administra el identificador universal. -
id
es el identificador proporcionado por el origen.
El extendedIDs
método se recomienda para todos los formatos de identificadores universales actuales y futuros. Ofrece flexibilidad para los publicadores que quieren controlar varias soluciones de identificador de primer fabricante.
Elegir el método correcto
- Use el método de identificador asignado solo si la asignación heredada
AST.js
admite el identificador universal. - Use el
extendedIDs
método para una compatibilidad más amplia y pruebas futuras.
Nota:
Puede planear la migración al método para garantizar la extendedIDs
compatibilidad con todas las soluciones de identidad actuales y futuras.
Device (objeto)
Especifica un dispositivo móvil en el que se mostrarán los anuncios.
Parámetro | Tipo | Descripción |
---|---|---|
deviceId |
objeto | Objeto que define la información de identificación del dispositivo; incluye los parámetros siguientes: - idfa : el identificador de publicidad de Apple para dispositivos iOS que ejecutan iOS 6+.- aaid : el identificador de publicidad de Google para dispositivos Android recuperado de los servicios de Google Play.- sha1udid : el hash SHA1 de ANDROID_ID .- md5udid : el hash MD5 de ANDROID_ID .- windowsadid - El identificador de microsoft advertising para dispositivos Windows. |
deviceType |
string | Especifica el tipo de dispositivo en el que se mostrará el anuncio (como phone o tablet ). |
useragent |
string | Cadena del agente de usuario desde el explorador del dispositivo. |
geo |
objeto | Objeto que define la ubicación del dispositivo; incluye los parámetros siguientes: - lat : latitud del dispositivo (un número, como 45.5 ).- lng : longitud del dispositivo (un número, como -122.7 ).- country : país del dispositivo. Usa los códigos ISO 3166-1 alfa-3 de tres caracteres.- region : región del dispositivo.- city : ciudad del dispositivo.- zip : código POSTAL del dispositivo. |
ip |
string | Dirección IP del dispositivo. |
make |
string | El modelo de dispositivo; por ejemplo, Apple . |
model |
string | El dispositivo hace; por ejemplo, iPhone . |
os |
string | Sistema operativo del dispositivo. |
osVersion |
string | Versión del sistema operativo del dispositivo. |
carrier |
string | El operador del dispositivo. |
connectionType |
número | Tipo de conexión: - 0 :Desconocido- 1 : WiFi- 2 :WAN |
mcc |
string | Código de país móvil, tal y como especifica la UIT. |
mnc |
string | Código de red móvil, tal y como especifica la UIT. |
devTime |
número | La hora en el dispositivo (en tiempo UNIX). |
Content (objeto)
Parámetro | Tipo | Descripción |
---|---|---|
language |
string | Código ANSI de dos letras para el idioma de este usuario. Por ejemplo, 'EN' . |
TrackingManagement (objeto)
Parámetro | Tipo | Descripción |
---|---|---|
native |
objeto | Objeto que contiene configuraciones relacionadas con tipos nativos específicamente. |
native.loadViewabilityScriptAt |
string | Valores permitidos: - impression - adresponse Valor predeterminado: adresponse El tiempo de respuesta se registra cuando AST recibe el anuncio. Es el entorno histórico. El nuevo tiempo de impresión se registra más cerca del evento de impresión. Esto puede ser más deseable para determinados publicadores que dependen de métricas de visualización nativas. |
userSync |
objeto | Objeto que contiene la configuración relacionada con la característica AST userSync . |
RenderingManagement (objeto)
Parámetro | Tipo | Descripción |
---|---|---|
insertWrapperDiv |
booleano | 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 |
booleano | 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 mediante los valores del parámetro adecuado sandboxAttributes .Valor predeterminado: false |
sandboxAttributes |
matriz de cadenas | 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). |
userSync (objeto)
Nota:
Para obtener más información sobre el userSync
objeto, vaya a la página Sincronización de usuario.
Parámetro | Tipo | Descripción |
---|---|---|
syncEnabled |
booleano | Habilita o deshabilita la lógica en AST que carga el userSync script una vez finalizada la subasta.Valor predeterminado: true |
syncDelay |
número | Especifica la cantidad de tiempo (en milisegundos) que AST espera después de que finalice la subasta antes de cargar el userSync script.Valor predeterminado: 3000 |
publisherId |
número | Identificador numérico de la entidad de publicador utilizada para la subasta en esta página. Incluye el valor que se pasa al userSync script, que proporciona más información de bajada. |
sellerId |
número | Identificador numérico de la entidad de vendedor utilizada para la subasta en esta página. Incluye el valor que se pasa al userSync script, que proporciona más información de bajada. |
Este es un ejemplo
apntag.setPageOpts({
member: 958,
user: {
age: 25,
externalUid: '10',
userIds: [{ "type": "criteo", "id": "_fl7bV96WjZsbiUyQnJlQ3g4ckh5a1N", }, // Criteo Identifier
{ "type": "ttd", "id": "00000111-91b1-49b2-ae37-17a8173dc36f" }, // Trade Desk Identifier
{ "type": "netid", "id": "999888777" }, // NetID Identifier
{ "type": "liveramp", "id": "AjfowMv4ZHZQJFM8TpiUnYEyA81Vdgg" }, //Liveramps's Identifier
{ "type": "uid2", "id": "234123424" }, //UID2's Identifier
{ "type": "extendedIDs", "eids": [{ "id": "abc123def345", "source": "mySampleDomain.com" }] }, // publisher first party IDs
],
segments: [1, 2],
gender: 0,
dnt: true,
language: 'EN'
}
keywords: {
genre: ['rock', 'pop']
},
disablePsa : true,
enableSafeFrame : true,
device : {
deviceId : {
idfa : 'String',
aaid : 'String',
md5udid : 'String',
sha1udid : 'String'
},
deviceType : 'String',
useragent : 'String',
geo : {
lat : 0.4,
lng : 0.5,
country : 'USA',
region : 'String',
city : 'String',
zip : 'String'
},
ip : 'String',
make : 'String',
model : 'String',
os : 'String',
osVersion : 'String',
carrier : 'String',
connectionType : 0,
mcc : 'String',
mnc : 'String',
devTime : 12345
},
auctionTimeout: 3000,
pageUrl: 'http://www.samplesite.com/testpage.html',
trackingManagement: {
native: {
loadViewabilityScriptAt: 'impression'
},
renderingManagement: {
insertWrapperDiv: true,
sandboxAdIframe: true,
sandboxAttributes: ['allow-same-origin', 'allow-scripts', 'allow-presentation']
},
userSync: {
syncEnabled: true,
syncDelay: 4000,
publisherId: 12345,
sellerId: 123
}
}
});
Objeto de invalidación geográfica
Use este objeto para invalidar la información geográfica de la subasta. El código de país y el código postal proporcionados se usarán para buscar todos los atributos geográficos para determinar la ubicación.
Campo | Tipo | Descripción |
---|---|---|
countryCode |
string | Obligatorio. Código de país de dos caracteres. |
zip |
string | Obligatorio. El código postal debe tener al menos un carácter. |
Este es un ejemplo
apntag.setPageOpts({
... // other settings
geoOverride: {
countryCode: 'US',
zip: '10000'
}
})
Objeto de administración de consentimiento
Use este objeto para especificar si la administración de consentimientos está habilitada para el cumplimiento de los requisitos de transparencia, notificación y elección/consentimiento según las leyes de privacidad del estado de EE. UU., RGPD, la Directiva de privacidad ePrivacy y el Mecanismo de señal de usuario de privacidad (USP) de IAB, que actualmente cubre la Ley de privacidad de los consumidores de California (CCPA). La administración del consentimiento está habilitada de forma predeterminada.
Advertencia
Para que nuestros clientes cumplan sus requisitos de transparencia, notificación y elección/consentimiento en virtud de las leyes de privacidad del estado de EE. UU., el RGPD, la directiva ePrivacy existente, Xandr apoya la Plataforma global de privacidad (GPP) y el marco de consentimiento de transparencia de IAB Europa (el mecanismo de señal de usuario de privacidad (USP) de IAB quedará en desuso en 2023).
Esta es una referencia para los publicadores que usan AST para mostrar aviso, transparencia y elección a los usuarios finales ubicados dentro de las regiones cubiertas por las directivas mencionadas anteriormente y señalar a proveedores aprobados y, cuando sea necesario, pasar el consentimiento a los orígenes de Xandr y de demanda y a sus proveedores a través de la plataforma de Xandr.
Este recurso no debe interpretarse como asesoramiento legal y Xandr no garantiza el cumplimiento de ninguna ley o reglamento. Tenga en cuenta que, dado que cada empresa y su recopilación, uso y almacenamiento de datos personales son diferentes, también debe buscar asesoramiento legal independiente en relación con las obligaciones establecidas en la normativa europea, incluidos el RGPD y la directiva ePrivacy existente. Solo un abogado puede proporcionarle asesoramiento legal específicamente adaptado a su situación. Nada en esta guía está pensado para proporcionarle, o debe usarse como sustituto de, asesoramiento legal adaptado a su negocio.
Tenga en cuenta que nuestra parte de las directivas de servicio (para comprar, vender y proveedores de datos) incluye obligaciones específicas de privacidad de las que debe tener en cuenta.
Parámetro | Tipo | Descripción | Predeterminada |
---|---|---|---|
disabled |
Booleano | Establézcalo en true para deshabilitar la funcionalidad de administración de consentimiento. | False |
timeout |
Entero | Cantidad de tiempo (en milisegundos) para esperar a que el CMP responda. | 10000 |
Deshabilitación de la administración del consentimiento
Xandr proporciona la opción de deshabilitar toda la administración de consentimientos o individuales según las necesidades del usuario.
Opciones | Ejemplos |
---|---|
Deshabilitar toda la administración de consentimiento | //disables all consent management apntag.setPageOpts({ ... // other settings consentManagement: { disabled: true, timeout: 10000 } }) |
Deshabilitar solo RGPD | apntag.setPageOpts({ consentManagement: { timeout: 5000, tcf : { disabled: true } } }); |
Deshabilitar solo GPP | apntag.setPageOpts({ consentManagement: { timeout: 5000, gpp : { disabled: true } } }); |
A continuación se describe la funcionalidad de AST para admitir el cumplimiento de GPP y RGPD cuando consentManagement
está habilitado:
- Durante la llamada a la función Etiquetas de carga, la etiqueta AST intentará capturar los datos de consentimiento de las plataformas de administración de consentimiento (CMP) compatibles con IAB.
- Cuando es el momento de que la etiqueta AST llame a ImpBus, la información de consentimiento se incluye en la
/ut
POST
solicitud. En concreto, la información de consentimiento se almacena en elPOST
objeto de datos del objeto como:
Nota:
El proceso de creación de solicitudes se pausa durante la ejecución anterior con el fin de permitir que los nuevos usuarios puedan completar su información de consentimiento. El proceso dejará de esperar después de un período de tiempo de espera especificado (10 segundos predeterminado) y finalizará la compilación de la solicitud.
gdpr_consent : {
consent_string: 'abc123',
consent_required: true|false
},
us_privacy: "1YNY"
Cuando se produce un error en la captura de CMP o expira el período de tiempo de espera, el consentManagement
código registrará un mensaje de advertencia en la consola del explorador, empaquetará un objeto de consentimiento de la siguiente manera e lo incluirá en la solicitud AST como se describe.
gdpr_consent : {
consent_string: undefined,
consent_required: undefined
},
gpp_sid: [5]
Cuando AST detecta TCF 2.0, se basará en los eventos generados por el CMP. La cadena de consentimiento se recuperará cuando se cumpla alguna de las condiciones siguientes:
El evento generado es
useractioncomplete
otcloaded
.El evento generado es
cmpuishown
ypurposeOneTreatment
la marca se establecetrue
en en la cadena TCF disponible.El único evento generado es
cmpuishown
y se produce un tiempo de espera.En TCF v2.0 si la
gdprApplies
marca está establecidatrue
en y no se concede el consentimiento del propósito uno, AST no incluirá cookies en la/ut
POST
solicitud.
Plataforma de privacidad global
Con el fin de cumplir con varias leyes de privacidad del estado de EE. UU., Xandr admite la Plataforma de privacidad global. Cuando AST detecta GPP, se basará en los eventos generados por el CMP. La cadena GPP se recuperará cuando se cumpla alguna de las condiciones siguientes:
- Se ha producido el evento
sectionChange
: se llama a este evento cada vez que cambia el estado o el contenido de una sección (por ejemplo, se obtiene el consentimiento). -
cmpStatus
Se carga y nocmpDisplayStatus
es igual a visible: esto significa que el código CMP ha terminado de cargarse (fuera de la fase de código auxiliar) y el CMP no es visible para el usuario final (lo que normalmente significa que el CMP tiene información de consentimiento previa disponible).