En esta referencia, se usa la notación TypeScript para describir los tipos. En la siguiente tabla, se proporciona una explicación breve por ejemplo.
Expresión de tipo | |
---|---|
string |
Es el tipo de cadena primitivo. |
string[] |
Un tipo de array, en el que los valores pueden ser solo cadenas. |
number | string |
Un tipo de unión, donde el valor puede ser un número o una string. |
Array<number | string> |
Un tipo de array, en el que los valores son un tipo complejo (unión). |
[number, string] |
Es un tipo de tupla, en el que el valor es un array de dos elementos que debe contener un número y una cadena en ese orden. |
Slot |
Un tipo de objeto, en el que el valor es una instancia de googletag.Slot . |
() => void |
Un tipo de función sin argumentos definidos y sin valor que se muestra. |
Para obtener más información sobre los tipos y las expresiones de tipo admitidos, consulta el Manual de TypeScript .
Anotaciones de tipos
Los dos puntos después de una variable, un nombre de parámetro, un nombre de propiedad o una firma de función denotan una anotación de tipo. Las anotaciones de tipos describen los tipos que el elemento a la izquierda de los dos puntos puede aceptar o mostrar. En la siguiente tabla, se muestran ejemplos de anotaciones de tipo que puedes ver en esta referencia.
Anotación de tipos | |
---|---|
param: string |
Indica que param acepta o muestra un valor de cadena. Esta sintaxis se usa para variables, parámetros, propiedades y tipos de datos que se muestran.
|
param?: number | string |
Indica que param es opcional, pero acepta un número o una string cuando se especifica. Esta sintaxis se utiliza para los parámetros y las propiedades.
|
...params: Array<() => void> |
Indica que params es un
parámetro de resto
que acepta funciones. Los parámetros de resto aceptan una cantidad no delimitada de valores del tipo especificado.
|
Definiciones de tipos
Tipos | |
---|---|
|
SingleSize | MultiSize
|
Es una configuración de tamaño válida para una ranura, que puede ser de uno o varios tamaños. |
|
|
SingleSize[]
|
Es una lista de tamaños válidos únicos. |
|
|
"fluid" | ["fluid"]
|
Tamaños con nombre que puede tener una ranura. En la mayoría de los casos, el tamaño es un rectángulo de tamaño fijo, pero hay algunos casos en los que necesitamos otros tipos de especificaciones de tamaño. Solo los siguientes son tamaños válidos con nombre:
|
|
|
SingleSizeArray | NamedSize
|
Es un tamaño válido único para una ranura. |
|
|
[number, number]
|
Matriz de dos números que representan [ancho, altura] |
|
|
[SingleSizeArray, GeneralSize]
|
Es una asignación del tamaño del viewport a los tamaños de los anuncios. Se usa para los anuncios responsivos. |
|
|
SizeMapping[]
|
Una lista de asignaciones de tamaño. |
|
|
"unhideWindow" | "navBar"
|
Activadores de anuncios intersticiales admitidos. |
|
|
"disablePersonalization"
|
Tratamiento de privacidad del publicador admitido. |
|
|
"IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"
|
Taxonomías admitidas para los indicadores proporcionados por el publicador (PPS). |
|
|
BidderSignalProvider | PublisherSignalProvider
|
Es una interfaz que permite mostrar un indicador seguro de un ofertante o proveedor específico. Se debe proporcionar una de las siguientes propiedades: |
Tipos de enumeración
Enumeradores | |
---|---|
googletag.enums.OutOfPageFormat
|
Formatos fuera de página compatibles con GPT.
|
googletag.enums.TrafficSource
|
Fuentes de tráfico que admite GPT.
|
googletag.enums.OutOfPageFormat
-
Formatos fuera de página compatibles con GPT.
-
- Consulta también
googletag.enums.TrafficSource
-
Fuentes de tráfico que admite GPT.
-
- Consulta también
googletag
El espacio de nombres global que usa Google Publisher Tag para su API.
Resumen de variables | |
---|---|
apiReady
|
Marca que indica que la API de GPT está cargada y lista para llamarse.
|
cmd
|
Referencia a la cola de comandos global para la ejecución asíncrona de llamadas relacionadas con GPT.
|
pubadsReady
|
Marca que indica que
PubAdsService está habilitado, cargado y completamente operativo
|
secureSignalProviders
|
Referencia al array de proveedores de indicadores seguros.
|
Resumen de funciones | |
---|---|
companionAds
|
Devuelve una referencia a
CompanionAdsService .
|
defineOutOfPageSlot
|
Construye un espacio publicitario fuera de página con la ruta de unidad de anuncios determinada.
|
defineSlot
|
Construye un espacio publicitario con una ruta y un tamaño determinados de la unidad de anuncios, y lo asocia con el ID de un elemento div en la página que contendrá el anuncio.
|
destroySlots
|
Destruye las ranuras determinadas y quita de GPT todos los objetos relacionados y las referencias de esas ranuras.
|
disablePublisherConsole
|
Inhabilita la Consola para editores de Google.
|
display
|
Indica a los servicios de ranura que rendericen la ranura.
|
enableServices
|
Habilita todos los servicios de GPT que se definieron para espacios publicitarios en la página.
|
getVersion
|
Muestra la versión actual de GPT.
|
openConsole
|
Abre la Consola para publicadores de Google.
|
pubads
|
Devuelve una referencia a
PubAdsService .
|
setAdIframeTitle
|
A partir de este momento, establece el título para todos los iframes de contenedores de anuncios creados por
PubAdsService .
|
setConfig
|
Establece las opciones de configuración generales de la página.
|
sizeMapping
|
Crea un
SizeMappingBuilder nuevo.
|
googletag.apiReady
-
apiReady: boolean | undefined
-
Marca que indica que la API de GPT está cargada y lista para llamarse. Esta propiedad solo será
undefined
hasta que la API esté lista.
Ten en cuenta que la forma recomendada de manejar los datos asíncronos es usar googletag.cmd para poner en cola las devoluciones de llamada cuando GPT esté listo. No es necesario que estas devoluciones de llamada verifiquen googletag.apiReady, ya que se garantiza que se ejecutarán una vez que se configure la API. -
- Ejemplo
-
JavaScript
if (window.googletag && googletag.apiReady) { // GPT API can be called safely. }
JavaScript (heredado)
if (window.googletag && googletag.apiReady) { // GPT API can be called safely. }
TypeScript
if (window.googletag && googletag.apiReady) { // GPT API can be called safely. }
googletag.cmd
-
cmd: Array<(this: typeof globalThis) => void> | CommandArray
-
Referencia a la cola de comandos global para la ejecución asíncrona de llamadas relacionadas con GPT.
La variablegoogletag.cmd
se inicializa en un array de JavaScript vacío en la sintaxis de la etiqueta GPT en la página ycmd.push
es el métodoArray.push
estándar que agrega un elemento al final de la matriz. Cuando se carga el código JavaScript de GPT, este analiza el array y ejecuta todas las funciones en orden. Luego, la secuencia de comandos reemplazacmd
por un objetoCommandArray
cuyo método de envío se define para ejecutar el argumento de la función que se le pasó. Este mecanismo permite que GPT reduzca la latencia percibida gracias a la recuperación de JavaScript de forma asíncrona mientras permite que el navegador continúe renderizando la página. -
- Ejemplo
-
JavaScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
JavaScript (heredado)
googletag.cmd.push(function () { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
TypeScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads()); });
googletag.pubadsReady
-
pubadsReady: boolean | undefined
-
Marca que indica que
PubAdsService
está habilitado, cargado y completamente operativo Esta propiedad simplemente seráundefined
hasta que se llame aenableServices
y se cargue y se inicialicePubAdsService
. -
googletag.secureSignalProviders
-
secureSignalProviders: SecureSignalProvider[] | SecureSignalProvidersArray | undefined
-
Referencia al array de proveedores de indicadores seguros.
El array de proveedores de indicadores seguros acepta una secuencia de funciones que generan señales y las invoca en orden. Su objetivo es reemplazar un array estándar que se usa para poner en cola funciones generadoras de indicadores que se invocarán una vez que se cargue GPT. -
- Ejemplo
-
JavaScript
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { return Promise.resolve("signal"); }, });
JavaScript (heredado)
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: function () { return Promise.resolve("signal"); }, });
TypeScript
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { return Promise.resolve("signal"); }, });
- Consulta también
googletag.companionAds
-
companionAds(): CompanionAdsService
-
Devuelve una referencia a
CompanionAdsService
. -
-
Devuelve CompanionAdsService
El servicio de anuncios complementarios
googletag.defineOutOfPageSlot
-
defineOutOfPageSlot(adUnitPath: string, div?: string | OutOfPageFormat): Slot | null
-
Construye un espacio publicitario fuera de página con la ruta de la unidad de anuncios especificada.
En el caso de los anuncios fuera de página personalizados,div
es el ID del elemento div que contendrá el anuncio. Para obtener más información, consulta el artículo sobre las creatividades fuera de página.
En el caso de los anuncios fuera de página administrados por GPT,div
es un formato de OutOfPageFormat compatible. -
- Ejemplo
-
JavaScript
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
JavaScript (heredado)
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
TypeScript
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
- Consulta también
-
Parámetros adUnitPath: string
Ruta de acceso completa de la unidad de anuncios con el código de red y de la unidad de anuncios.div?: string | OutOfPageFormat
Es el ID del elemento div que contendrá esta unidad de anuncios o OutOfPageFormat. -
Devuelve Slot | null
El espacio que se acaba de crear onull
si no se puede crear uno.
googletag.defineSlot
-
defineSlot(adUnitPath: string, size: GeneralSize, div?: string): Slot | null
-
Construye un espacio publicitario con una ruta y un tamaño determinados de la unidad de anuncios, y lo asocia con el ID de un elemento div en la página que contendrá el anuncio.
-
- Ejemplo
-
JavaScript
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
JavaScript (heredado)
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
TypeScript
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
- Consulta también
-
Parámetros adUnitPath: string
Ruta de acceso completa de la unidad de anuncios con el código de red y de la unidad.size: GeneralSize
Ancho y altura de la ranura agregada. Es el tamaño que se usa en la solicitud de anuncio si no se proporciona una asignación de tamaño responsivo o el tamaño del viewport es menor que el tamaño más pequeño proporcionado en la asignación.div?: string
Es el ID del elemento div que contendrá esta unidad de anuncios. -
Devuelve Slot | null
El espacio que se acaba de crear onull
si no se puede crear uno.
googletag.destroySlots
-
destroySlots(slots?: Slot[]): boolean
-
Destruye las ranuras determinadas y quita de GPT todos los objetos relacionados y las referencias de esas ranuras. Esta API no admite ranuras de devoluciones ni complementarias.
Cuando se llama a esta API en un espacio publicitario, se borra el anuncio y se quita el objeto de espacio publicitario del estado interno que mantiene GPT. La llamada a más funciones en el objeto de ranura dará como resultado un comportamiento indefinido. Ten en cuenta que es posible que el navegador no libere la memoria asociada con ese espacio si la página del publicador mantiene una referencia a ella. Si se llama a esta API, el elemento div asociado con ese espacio disponible se podrá volver a usar.
En particular, cuando se destruye un espacio publicitario, se quita el anuncio de la vista de página de larga duración de GPT, de modo que las solicitudes futuras no se verán afectadas por las publicidades simultáneas ni las exclusiones competitivas que involucren este anuncio. Si no se llama a esta función antes de quitar el div de un espacio publicitario de la página, se generará un comportamiento indefinido. -
- Ejemplo
-
JavaScript
// The calls to construct an ad and display contents. const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to destroy only slot1. googletag.destroySlots([slot1]); // This call to destroy both slot1 and slot2. googletag.destroySlots([slot1, slot2]); // This call to destroy all slots. googletag.destroySlots();
JavaScript (heredado)
// The calls to construct an ad and display contents. var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to destroy only slot1. googletag.destroySlots([slot1]); // This call to destroy both slot1 and slot2. googletag.destroySlots([slot1, slot2]); // This call to destroy all slots. googletag.destroySlots();
TypeScript
// The calls to construct an ad and display contents. const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!; googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!; googletag.display("div-2"); // This call to destroy only slot1. googletag.destroySlots([slot1]); // This call to destroy both slot1 and slot2. googletag.destroySlots([slot1, slot2]); // This call to destroy all slots. googletag.destroySlots();
-
Parámetros slots?: Slot[]
Es el array de ranuras que se destruirán. El array es opcional; si no se especifica, se destruirán todas las ranuras. -
Devuelve boolean
true
si se destruyeron ranuras,false
de lo contrario.
googletag.disablePublisherConsole
-
disablePublisherConsole(): void
-
Inhabilita la Consola para editores de Google.
-
- Consulta también
googletag.display
-
display(divOrSlot: string | Element | Slot): void
-
Indica a los servicios de ranura que rendericen la ranura. Cada espacio publicitario debe mostrarse solo una vez por página. Todas las ranuras se deben definir y tener un servicio asociado antes de mostrarse. La llamada a la pantalla no debe ocurrir hasta que el elemento esté presente en el DOM. La forma habitual de lograrlo es colocarla dentro de un bloque de secuencia de comandos dentro del elemento div mencionado en la llamada de método.
Si se usa la arquitectura de solicitud única (SRA), todos los espacios publicitarios no recuperados en el momento en que se llama a este método se recuperarán de una sola vez. Para forzar que un espacio publicitario no se muestre, se debe quitar todo el elemento div. -
- Ejemplo
-
JavaScript
googletag.cmd.push(() => { googletag.display("div-1"); });
JavaScript (heredado)
googletag.cmd.push(function () { googletag.display("div-1"); });
TypeScript
googletag.cmd.push(() => { googletag.display("div-1"); });
- Consulta también
-
Parámetros divOrSlot: string | Element | Slot
Es el ID del elemento div que contiene el espacio publicitario o el elemento div, o bien el objeto de espacio publicitario. Si se proporciona un elemento div, este debe tener un atributo 'id' que coincida con el ID que se pasó adefineSlot
.
googletag.enableServices
-
enableServices(): void
-
Habilita todos los servicios de GPT que se definieron para espacios publicitarios en la página.
-
googletag.getVersion
-
getVersion(): string
-
Muestra la versión actual de GPT.
-
- Consulta también
-
Devuelve string
Es la cadena de versión de GPT que se está ejecutando actualmente.
googletag.openConsole
-
openConsole(div?: string): void
-
Abre la Consola para publicadores de Google.
-
- Ejemplo
-
JavaScript
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
JavaScript (heredado)
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
TypeScript
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
- Consulta también
-
Parámetros div?: string
Un ID de div del espacio publicitario Este valor es opcional. Si se proporciona, la Consola para editores intentará abrirse con los detalles del espacio publicitario especificado a la vista.
googletag.pubads
-
pubads(): PubAdsService
-
Devuelve una referencia a
PubAdsService
. -
-
Devuelve PubAdsService
El servicio de anuncios del publicador
googletag.setAdIframeTitle
-
setAdIframeTitle(title: string): void
-
A partir de este momento, establece el título para todos los iframes de contenedores de anuncios creados por
PubAdsService
. -
- Ejemplo
-
JavaScript
googletag.setAdIframeTitle("title");
JavaScript (heredado)
googletag.setAdIframeTitle("title");
TypeScript
googletag.setAdIframeTitle("title");
-
Parámetros title: string
Es el nuevo título para todos los iframes de contenedores de anuncios.
googletag.setConfig
-
setConfig(config: PageSettingsConfig): void
-
Establece las opciones de configuración generales de la página.
-
-
Parámetros config: PageSettingsConfig
googletag.sizeMapping
-
sizeMapping(): SizeMappingBuilder
-
Crea un
SizeMappingBuilder
nuevo. -
- Consulta también
-
Devuelve SizeMappingBuilder
Un compilador nuevo.
googletag.CommandArray
El array de comandos acepta una secuencia de funciones y las invoca en orden. Su objetivo es reemplazar un array estándar que se usa para poner en cola funciones que se invocarán una vez que se cargue GPT.
Resumen de métodos | |
---|---|
push
|
Ejecuta la secuencia de funciones especificadas en los argumentos en orden.
|
push
-
push(...f: Array<(this: typeof globalThis) => void>): number
-
Ejecuta la secuencia de funciones especificadas en los argumentos en orden.
-
- Ejemplo
-
JavaScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
JavaScript (heredado)
googletag.cmd.push(function () { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
TypeScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads()); });
-
Parámetros ...f: Array<(this: typeof globalThis) => void>
Función de JavaScript que se ejecutará. La vinculación del entorno de ejecución siempre seráglobalThis
. Considera pasar una función de flecha para retener el valorthis
del contexto léxico que lo contiene. -
Devuelve number
La cantidad de comandos procesados hasta el momento. Esto es compatible con el valor que se muestra deArray.push
(la longitud actual del array).
googletag.CompanionAdsService
Extiende
Servicio de anuncios complementarios. Los anuncios de video usan este servicio para mostrar anuncios complementarios.
Resumen de métodos | |
---|---|
addEventListener
|
Registra un objeto de escucha que te permite configurar una función de JavaScript y llamarla cuando ocurre un evento de GPT específico en la página.
Heredado de
|
getSlots
|
Obtén la lista de ranuras asociadas con este servicio.
Heredado de
|
removeEventListener
|
Quita un objeto de escucha registrado previamente.
Heredado de
|
setRefreshUnfilledSlots
|
Establece si los espacios publicitarios complementarios que no se completaron se reabastecerán automáticamente.
|
- Consulta también
setRefreshUnfilledSlots
-
setRefreshUnfilledSlots(value: boolean): void
-
Establece si los espacios complementarios que no se completaron se reabastecerán automáticamente.
Se puede llamar a este método varias veces durante el ciclo de vida de la página para activar y desactivar el reabastecimiento. Solo se reabastecerán los espacios que también estén registrados conPubAdsService
. Debido a restricciones de la política, este método no se diseñó para llenar espacios vacíos complementarios cuando se publique un video de Ad Exchange. -
- Ejemplo
-
JavaScript
googletag.companionAds().setRefreshUnfilledSlots(true);
JavaScript (heredado)
googletag.companionAds().setRefreshUnfilledSlots(true);
TypeScript
googletag.companionAds().setRefreshUnfilledSlots(true);
-
Parámetros value: boolean
true
para reabastecer automáticamente los horarios disponibles sin completar,false
para dejarlos sin cambios.
googletag.PrivacySettingsConfig
Objeto de configuración para los parámetros de privacidad.
Resumen de la propiedad | |
---|---|
childDirectedTreatment
|
Indica si la página se debe tratar como dirigida a niños.
|
limitedAds
|
Permite que la publicación se publique en el modo de anuncios limitados para ayudar a los publicadores a satisfacer las necesidades de cumplimiento de las normativas.
|
nonPersonalizedAds
|
Permite que la publicación se publique en el modo de anuncios no personalizados para satisfacer las necesidades de cumplimiento de las normativas del publicador.
|
restrictDataProcessing
|
Permite que la publicación se ejecute en el modo de procesamiento restringido para ayudar con las necesidades de cumplimiento de las normativas del publicador.
|
trafficSource
|
Indica si las solicitudes representan tráfico orgánico o comprado.
|
underAgeOfConsent
|
Indica si se deben marcar las solicitudes de anuncios como provenientes de usuarios que no alcanzan la edad de consentimiento.
|
- Consulta también
childDirectedTreatment
-
childDirectedTreatment: null | boolean
-
Indica si la página se debe tratar como dirigida a niños. Configúralo en
null
para borrar la configuración. -
limitedAds
-
limitedAds: boolean
-
Permite que la publicación se publique en el modo de anuncios limitados para ayudar a los publicadores a satisfacer las necesidades de cumplimiento de las normativas. Cuando se habilita, la biblioteca de GPT se puede solicitar de manera opcional desde una URL de anuncios limitados sin cookies.
-
- Consulta también
nonPersonalizedAds
-
nonPersonalizedAds: boolean
-
Permite que la publicación se publique en el modo de anuncios no personalizados para satisfacer las necesidades de cumplimiento de las normativas del publicador.
-
restrictDataProcessing
-
restrictDataProcessing: boolean
-
Permite que la publicación se ejecute en el modo de procesamiento restringido para ayudar con las necesidades de cumplimiento de las normativas del publicador.
-
trafficSource
-
trafficSource: TrafficSource
-
Indica si las solicitudes representan tráfico orgánico o comprado. Este valor propaga la dimensión Fuente de tráfico en los informes de Ad Manager. Si no la estableces, la fuente de tráfico se establecerá de forma predeterminada en
undefined
en los informes. -
- Ejemplo
-
JavaScript
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
JavaScript (heredado)
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
TypeScript
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
underAgeOfConsent
-
underAgeOfConsent: null | boolean
-
Indica si se deben marcar las solicitudes de anuncios como provenientes de usuarios que no alcanzan la edad de consentimiento. Configúralo en
null
para borrar la configuración. -
googletag.PubAdsService
Extiende
Servicio de anuncios de publicadores. Este servicio se usa para recuperar y mostrar anuncios de tu cuenta de Google Ad Manager.
Resumen de métodos | |
---|---|
addEventListener
|
Registra un objeto de escucha que te permite configurar una función de JavaScript y llamarla cuando ocurre un evento de GPT específico en la página.
Heredado de
|
clear
|
Quita los anuncios de los espacios determinados y los reemplaza por contenido en blanco.
|
clearCategoryExclusions
|
Borra todas las etiquetas de exclusión de categorías de anuncios a nivel de la página.
|
clearTargeting
|
Borra los parámetros de segmentación personalizada de una clave específica o de todas las claves.
|
collapseEmptyDivs
|
Permite contraer los elementos div del espacio publicitario para que no ocupen espacio en la página cuando no hay contenido del anuncio para mostrar.
|
disableInitialLoad
|
Inhabilita las solicitudes de anuncios cuando se carga la página, pero permite que se soliciten anuncios con una llamada a
PubAdsService.refresh .
|
display
|
Construye y muestra un espacio publicitario con la ruta y el tamaño determinados de la unidad de anuncios.
|
enableLazyLoad
|
Habilita la carga diferida en GPT según lo define el objeto de configuración.
|
enableSingleRequest
|
Habilita el modo de solicitud única para recuperar varios anuncios al mismo tiempo.
|
enableVideoAds
|
Le indica a GPT que los anuncios de video estarán presentes en la página.
|
get
|
Muestra el valor del atributo de AdSense asociado con la clave determinada.
|
getAttributeKeys
|
Muestra las claves de atributo que se configuraron en este servicio.
|
getSlots
|
Obtén la lista de ranuras asociadas con este servicio.
Heredado de
|
getTargeting
|
Muestra un parámetro de segmentación personalizado a nivel de servicio específico que se estableció.
|
getTargetingKeys
|
Muestra la lista de todas las claves de segmentación personalizadas a nivel de servicio que se establecieron.
|
isInitialLoadDisabled
|
Muestra si una llamada anterior de
PubAdsService.disableInitialLoad inhabilitó correctamente las solicitudes iniciales de anuncios.
|
refresh
|
Recupera y muestra anuncios nuevos para espacios específicos o para todos los espacios de la página.
|
removeEventListener
|
Quita un objeto de escucha registrado previamente.
Heredado de
|
set
|
Establece los valores de los atributos de AdSense que se aplican a todos los espacios publicitarios del servicio de anuncios del publicador.
|
setCategoryExclusion
|
Establece una exclusión de categoría de anuncio a nivel de la página para el nombre de la etiqueta determinado.
|
setCentering
|
Habilita o inhabilita el centro horizontal de los anuncios.
|
setForceSafeFrame
|
Establece si todos los anuncios de la página se deben renderizar de manera forzosa con un contenedor de SafeFrame.
|
setLocation
|
Pasa la información de ubicación de los sitios web para que puedas segmentar geográficamente las líneas de pedido para ubicaciones específicas.
|
setPrivacySettings
|
Permite la configuración de todos los parámetros de privacidad desde una sola API a través de un objeto de configuración.
|
setPublisherProvidedId
|
Establece el valor del ID proporcionado por el editor.
|
setSafeFrameConfig
|
Establece las preferencias a nivel de la página para la configuración de SafeFrame.
|
setTargeting
|
Establece parámetros de segmentación personalizados para una clave determinada que se aplican a todos los espacios publicitarios del servicio de anuncios del publicador.
|
setVideoContent
|
Configura la información del contenido de video que se enviará junto con las solicitudes de anuncios para fines de segmentación y exclusión de contenido.
|
updateCorrelator
|
Cambia el correlator que se envía con las solicitudes de anuncios y comienza de forma efectiva una nueva vista de página.
|
clear
-
clear(slots?: Slot[]): boolean
-
Quita los anuncios de los espacios determinados y los reemplaza por contenido en blanco. Los espacios se marcarán como no recuperados.
En particular, si se borra un espacio, se quita el anuncio de la vista de página de larga duración de GPT, de modo que las próximas solicitudes no se verán influenciadas por las publicidades simultáneas ni las exclusiones competitivas que involucren este anuncio. -
- Ejemplo
-
JavaScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to clear only slot1. googletag.pubads().clear([slot1]); // This call to clear both slot1 and slot2. googletag.pubads().clear([slot1, slot2]); // This call to clear all slots. googletag.pubads().clear();
JavaScript (heredado)
var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to clear only slot1. googletag.pubads().clear([slot1]); // This call to clear both slot1 and slot2. googletag.pubads().clear([slot1, slot2]); // This call to clear all slots. googletag.pubads().clear();
TypeScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!; googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!; googletag.display("div-2"); // This call to clear only slot1. googletag.pubads().clear([slot1]); // This call to clear both slot1 and slot2. googletag.pubads().clear([slot1, slot2]); // This call to clear all slots. googletag.pubads().clear();
-
Parámetros slots?: Slot[]
El array de ranuras que se borrarán. El array es opcional; se borrarán todas las ranuras si no se especifica. -
Devuelve boolean
Muestratrue
si se borraron las ranuras, de lo contrario, muestrafalse
.
clearCategoryExclusions
-
clearCategoryExclusions(): PubAdsService
-
Borra todas las etiquetas de exclusión de categorías de anuncios a nivel de la página. Esto es útil si deseas actualizar la ranura.
-
- Ejemplo
-
JavaScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
JavaScript (heredado)
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
TypeScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
- Consulta también
-
Devuelve PubAdsService
El objeto de servicio en el que se llamó al método.
clearTargeting
-
clearTargeting(key?: string): PubAdsService
-
Borra los parámetros de segmentación personalizada de una clave específica o de todas las claves.
-
- Ejemplo
-
JavaScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
JavaScript (heredado)
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
TypeScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
- Consulta también
-
Parámetros key?: string
Clave del parámetro de segmentación. La clave es opcional. Si no se especifica, se borrarán todos los parámetros de segmentación. -
Devuelve PubAdsService
El objeto de servicio en el que se llamó al método.
collapseEmptyDivs
-
collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean
-
Permite contraer los elementos div del espacio publicitario para que no ocupen espacio en la página cuando no hay contenido del anuncio para mostrar. Debes configurar este modo antes de habilitar el servicio.
-
- Consulta también
-
Parámetros collapseBeforeAdFetch?: boolean
Si se deben contraer los espacios disponibles incluso antes de que se recuperen los anuncios. Este parámetro es opcional; si no se proporciona, se usaráfalse
como valor predeterminado. -
Devuelve boolean
Muestratrue
si el modo de contracción div estaba habilitado yfalse
si es imposible habilitar el modo de contracción porque se llamó al método después de habilitar el servicio.
disableInitialLoad
-
disableInitialLoad(): void
-
Inhabilita las solicitudes de anuncios cuando se carga la página, pero permite que se soliciten anuncios con una llamada a
PubAdsService.refresh
. Se debe configurar antes de habilitar el servicio. Debes utilizar el modo asíncrono; de lo contrario, no será posible solicitar anuncios conrefresh
.
display
-
display(adUnitPath: string, size: GeneralSize, div?: string | Element, clickUrl?: string): void
-
Construye y muestra un espacio publicitario con la ruta y el tamaño determinados de la unidad de anuncios. Este método no funciona con el modo de solicitud única.
Nota: Cuando se llama a este método, se crea una instantánea del espacio y el estado de la página para garantizar la coherencia cuando se envía la solicitud de anuncio y se renderiza la respuesta. Cualquier cambio que se realice en el estado de la página o el espacio publicitario después de llamar a este método (incluida la segmentación, la configuración de privacidad, la fuerza de SafeFrame, etc.) solo se aplicarán a las solicitudesdisplay()
orefresh()
posteriores. -
- Ejemplo
-
JavaScript
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
JavaScript (heredado)
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
TypeScript
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
- Consulta también
-
Parámetros adUnitPath: string
Es la ruta de acceso de la unidad de anuncios del espacio que se renderizará.size: GeneralSize
Ancho y altura de la ranura.div?: string | Element
Es el ID del elemento div que contiene el espacio publicitario o el elemento div.clickUrl?: string
Es la URL de clic que se usará en este espacio publicitario.
enableLazyLoad
-
enableLazyLoad(config?: { fetchMarginPercent: number, mobileScaling: number, renderMarginPercent: number }): void
-
Habilita la carga diferida en GPT según lo define el objeto de configuración. Para obtener ejemplos más detallados, consulta la muestra de carga diferida.
Nota: La recuperación diferida en SRA solo funciona si todos los espacios se encuentran fuera del margen de recuperación. -
- Ejemplo
-
JavaScript
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
JavaScript (heredado)
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
TypeScript
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
- Consulta también
-
Parámetros config?: { fetchMarginPercent: number, mobileScaling: number, renderMarginPercent: number }
El objeto de configuración permite personalizar el comportamiento diferido. Cualquier configuración omitida usará un conjunto predeterminado de Google que se ajustará con el tiempo. Para inhabilitar un parámetro de configuración en particular, como un margen de recuperación, establece el valor en-1
.fetchMarginPercent
La distancia mínima entre el viewport actual y el espacio publicitario debe ser antes de que recuperemos el anuncio, expresado como un porcentaje del tamaño del viewport. El valor 0 significa "cuando el espacio ingresa al viewport", 100 significa "cuando el anuncio está a 1 viewport de distancia", y así sucesivamente.renderMarginPercent
La distancia mínima a la que debe haber un espacio el viewport actual antes de renderizar un anuncio. De esta manera, se puede realizar una carga previa del anuncio, pero se debe esperar para renderizar y descargar otros subrecursos. El valor funciona comofetchMarginPercent
como un porcentaje de viewport.mobileScaling
Es un multiplicador que se aplica a los márgenes en los dispositivos móviles. Esto permite variar los márgenes en los dispositivos móviles y las computadoras de escritorio. Por ejemplo, un valor de 2.0 multiplicará todos los márgenes por 2 en los dispositivos móviles, lo que aumentará la distancia mínima que puede tener un espacio antes de la recuperación y la renderización.
enableSingleRequest
-
enableSingleRequest(): boolean
-
Habilita el modo de solicitud única para recuperar varios anuncios al mismo tiempo. Esto requiere que todos los espacios de anuncios del publicador se definan y se agreguen a PubAdsService antes de habilitar el servicio. El modo de solicitud única debe configurarse antes de habilitar el servicio.
-
Devuelve boolean
Muestratrue
si el modo de solicitud única estaba habilitado yfalse
si es imposible habilitar el modo de solicitud única porque se llamó al método después de habilitar el servicio.
enableVideoAds
-
enableVideoAds(): void
-
Le indica a GPT que los anuncios de video estarán presentes en la página. Esto permite establecer restricciones de exclusión competitiva en los anuncios gráficos y de video. Si se conoce el contenido de video, llama a
PubAdsService.setVideoContent
para poder usar la exclusión de contenido para los anuncios gráficos. -
get
-
get(key: string): null | string
-
Muestra el valor del atributo de AdSense asociado con la clave determinada.
-
- Ejemplo
-
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
JavaScript (heredado)
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
TypeScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
- Consulta también
-
Parámetros key: string
Es el nombre del atributo que se debe buscar. -
Devuelve null | string
El valor actual de la clave de atributo onull
si la clave no está presente.
getAttributeKeys
-
getAttributeKeys(): string[]
-
Muestra las claves de atributo que se configuraron en este servicio.
-
- Ejemplo
-
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
JavaScript (heredado)
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
TypeScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
-
Devuelve string[]
Es el array de claves de atributo configuradas en este servicio. El ordenamiento no está definido.
getTargeting
-
getTargeting(key: string): string[]
-
Muestra un parámetro de segmentación personalizado a nivel de servicio específico que se estableció.
-
- Ejemplo
-
JavaScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
JavaScript (heredado)
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
TypeScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
-
Parámetros key: string
La clave de segmentación que se debe buscar. -
Devuelve string[]
Los valores asociados con esta clave o un array vacío si no existe esa clave.
getTargetingKeys
-
getTargetingKeys(): string[]
-
Muestra la lista de todas las claves de segmentación personalizadas a nivel de servicio que se establecieron.
-
- Ejemplo
-
JavaScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().getTargetingKeys(); // Returns ['interests', 'colors'].
JavaScript (heredado)
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().getTargetingKeys(); // Returns ['interests', 'colors'].
TypeScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().getTargetingKeys(); // Returns ['interests', 'colors'].
-
Devuelve string[]
Es el array de claves de segmentación. El ordenamiento no está definido.
isInitialLoadDisabled
-
isInitialLoadDisabled(): boolean
-
Muestra si una llamada anterior de
PubAdsService.disableInitialLoad
inhabilitó correctamente las solicitudes iniciales de anuncios. -
-
Devuelve boolean
Muestratrue
si una llamada anterior aPubAdsService.disableInitialLoad
se realizó correctamente; de lo contrario, muestrafalse
.
refresh
-
refresh(slots?: null | Slot[], options?: { changeCorrelator: boolean }): void
-
Recupera y muestra anuncios nuevos para espacios específicos o para todos los espacios de la página. Solo funciona en modo de renderización asíncrona.
Para un comportamiento adecuado en todos los navegadores, la llamada arefresh
debe estar precedida por una llamada adisplay
en el espacio publicitario. Si se omite la llamada adisplay
, es posible que la actualización se comporte de forma inesperada. Si lo desea, se puede usar el métodoPubAdsService.disableInitialLoad
para evitar quedisplay
recupere un anuncio.
Cuando se actualiza un espacio publicitario, se quita el anuncio anterior de la vista de página de larga duración de GPT, de modo que las solicitudes futuras no se vean influenciadas por las publicidades simultáneas o las exclusiones competitivas relacionadas con ese anuncio. -
- Ejemplo
-
JavaScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
JavaScript (heredado)
var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
TypeScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!; googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!; googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
- Consulta también
-
Parámetros slots?: null | Slot[]
Las ranuras que se deben actualizar. El array es opcional; todas las ranuras se actualizarán si no se especifica.options?: { changeCorrelator: boolean }
Opciones de configuración asociadas con esta llamada de actualización.changeCorrelator
Especifica si se debe generar un nuevo correlator para recuperar anuncios. Nuestros servidores de anuncios conservan este valor de correlator por un período breve (actualmente durante 30 segundos, pero sujeto a cambios), de modo que las solicitudes con el mismo correlator que se reciban muy juntas se considerarán vistas de una sola página. De forma predeterminada, se genera un correlator nuevo para cada actualización.
Nota: Esta opción no afecta la vista de página de larga duración de GPT, que refleja automáticamente los anuncios que se encuentran actualmente en la página y no tiene fecha de vencimiento.
set
-
set(key: string, value: string): PubAdsService
-
Establece valores para los atributos de AdSense que se aplican a todos los espacios publicitarios del servicio de anuncios del publicador.
Si se llama más de una vez para la misma clave, se anularán los valores establecidos anteriormente para esa clave. Se deben configurar todos los valores antes de llamar adisplay
orefresh
. -
- Ejemplo
-
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF");
JavaScript (heredado)
googletag.pubads().set("adsense_background_color", "#FFFFFF");
TypeScript
googletag.pubads().set("adsense_background_color", "#FFFFFF");
- Consulta también
-
Parámetros key: string
Es el nombre del atributo.value: string
Valor del atributo. -
Devuelve PubAdsService
El objeto de servicio en el que se llamó al método.
setCategoryExclusion
-
setCategoryExclusion(categoryExclusion: string): PubAdsService
-
Establece una exclusión de categoría de anuncio a nivel de la página para el nombre de la etiqueta determinado.
-
- Ejemplo
-
JavaScript
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
JavaScript (heredado)
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
TypeScript
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
- Consulta también
-
Parámetros categoryExclusion: string
La etiqueta de exclusión de categoría de anuncios que se agregará. -
Devuelve PubAdsService
El objeto de servicio en el que se llamó al método.
setCentering
-
setCentering(centerAds: boolean): void
-
Habilita o inhabilita el centro horizontal de los anuncios. El centrado está inhabilitado de forma predeterminada. En la versión heredada de gpt_mobile.js, el centrado está habilitado de forma predeterminada.
Este método se debe invocar antes de llamar adisplay
orefresh
, ya que solo se centrarán los anuncios que se soliciten después de llamar a este método. -
- Ejemplo
-
JavaScript
// Make ads centered. googletag.pubads().setCentering(true);
JavaScript (heredado)
// Make ads centered. googletag.pubads().setCentering(true);
TypeScript
// Make ads centered. googletag.pubads().setCentering(true);
-
Parámetros centerAds: boolean
true
para centrar los anuncios yfalse
para alinearlos a la izquierda.
setForceSafeFrame
-
setForceSafeFrame(forceSafeFrame: boolean): PubAdsService
-
Determina si todos los anuncios de la página se deben renderizar de manera forzosa con un contenedor de SafeFrame.
Ten en cuenta lo siguiente cuando uses esta API:- Este parámetro de configuración solo se aplicará a las solicitudes de anuncios posteriores realizadas para los espacios respectivos.
- Si se especifica, la configuración a nivel de espacio publicitario siempre anulará la configuración a nivel de página.
- Si se establece en
true
(a nivel del espacio publicitario o de la página), el anuncio siempre se renderizará con un contenedor de SafeFrame independientemente de la opción que se elija en la IU de Google Ad Manager. - Sin embargo, si se establece como
false
o no se especifica, el anuncio se renderizará con un contenedor de SafeFrame, según el tipo de creatividad y la selección que se haya realizado en la IU de Google Ad Manager. - Esta API debe usarse con precaución, ya que podría afectar el comportamiento de las creatividades que intenten salir de sus iFrames o dependan de que se rendericen directamente en una página del publicador.
-
- Ejemplo
-
JavaScript
googletag.pubads().setForceSafeFrame(true); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setForceSafeFrame(false) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript (heredado)
googletag.pubads().setForceSafeFrame(true); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setForceSafeFrame(false) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
TypeScript
googletag.pubads().setForceSafeFrame(true); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setForceSafeFrame(false) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
- Consulta también
-
Parámetros forceSafeFrame: boolean
true
para forzar que todos los anuncios de la página se dibujen en SafeFrames yfalse
para cambiar la configuración anterior a falsa. Establecer este parámetro enfalse
cuando no se especifica antes no cambiará nada. -
Devuelve PubAdsService
El objeto de servicio en el que se llamó a la función.
setLocation
-
setLocation(address: string): PubAdsService
-
Pasa la información de ubicación de los sitios web para que puedas segmentar geográficamente las líneas de pedido para ubicaciones específicas.
-
- Ejemplo
-
JavaScript
// Postal code: googletag.pubads().setLocation("10001,US");
JavaScript (heredado)
// Postal code: googletag.pubads().setLocation("10001,US");
TypeScript
// Postal code: googletag.pubads().setLocation("10001,US");
-
Parámetros address: string
Dirección en formato libre. -
Devuelve PubAdsService
El objeto de servicio en el que se llamó al método.
setPrivacySettings
-
setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService
-
Permite la configuración de todos los parámetros de privacidad desde una sola API a través de un objeto de configuración.
-
- Ejemplo
-
JavaScript
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
JavaScript (heredado)
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
TypeScript
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
- Consulta también
-
Parámetros privacySettings: PrivacySettingsConfig
Objeto que contiene la configuración de la configuración de privacidad -
Devuelve PubAdsService
El objeto de servicio en el que se llamó a la función.
setPublisherProvidedId
-
setPublisherProvidedId(ppid: string): PubAdsService
-
Establece el valor del ID proporcionado por el editor.
-
- Ejemplo
-
JavaScript
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
JavaScript (heredado)
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
TypeScript
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
- Consulta también
-
Parámetros ppid: string
Es un ID alfanumérico que proporciona el editor. Debe tener entre 32 y 150 caracteres. -
Devuelve PubAdsService
El objeto de servicio en el que se llamó al método.
setSafeFrameConfig
-
setSafeFrameConfig(config: SafeFrameConfig): PubAdsService
-
Establece las preferencias a nivel de la página para la configuración de SafeFrame. Se ignorarán las claves no reconocidas en el objeto de configuración. Se ignorará toda la configuración si se pasa un valor no válido para una clave reconocida.
Si se especifican, se anularán las preferencias a nivel de la página. -
- Ejemplo
-
JavaScript
googletag.pubads().setForceSafeFrame(true); const pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; const slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript (heredado)
googletag.pubads().setForceSafeFrame(true); var pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; var slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
TypeScript
googletag.pubads().setForceSafeFrame(true); const pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; const slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
- Consulta también
-
Parámetros config: SafeFrameConfig
El objeto de configuración. -
Devuelve PubAdsService
El objeto de servicio en el que se llamó al método.
setTargeting
-
setTargeting(key: string, value: string | string[]): PubAdsService
-
Establece parámetros de segmentación personalizados para una clave determinada que se aplican a todos los espacios publicitarios del servicio de anuncios del publicador. Si llamas a esta función varias veces para la misma clave, se reemplazarán los valores anteriores. Estas claves se definen en tu cuenta de Google Ad Manager.
-
- Ejemplo
-
JavaScript
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
JavaScript (heredado)
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
TypeScript
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
- Consulta también
-
Parámetros key: string
Clave del parámetro de segmentación.value: string | string[]
Valor del parámetro de segmentación o array de valores. -
Devuelve PubAdsService
El objeto de servicio en el que se llamó al método.
setVideoContent
-
setVideoContent(videoContentId: string, videoCmsId: string): void
-
Configura la información del contenido de video que se enviará junto con las solicitudes de anuncios para fines de segmentación y exclusión de contenido. Los anuncios de video se habilitarán automáticamente cuando se invoque este método. Para
videoContentId
yvideoCmsId
, usa los valores que se proporcionan al servicio de transferencia de contenido de Google Ad Manager. -
- Consulta también
-
Parámetros videoContentId: string
Indica el ID de contenido de video.videoCmsId: string
Es el ID de CMS del video.
updateCorrelator
-
updateCorrelator(): PubAdsService
-
Cambia el correlator que se envía con las solicitudes de anuncios y comienza de forma efectiva una nueva vista de página. El correlator es el mismo para todas las solicitudes de anuncios que provienen de una vista de página y son únicos para todas las vistas de página. Solo se aplica al modo asíncrono.
Nota: Esto no afecta la vista de página de larga duración de GPT, la cual refleja automáticamente los anuncios que se muestran en la página y no tiene fecha de vencimiento. -
- Ejemplo
-
JavaScript
// Assume that the correlator is currently 12345. All ad requests made // by this page will currently use that value. // Replace the current correlator with a new correlator. googletag.pubads().updateCorrelator(); // The correlator will now be a new randomly selected value, different // from 12345. All subsequent ad requests made by this page will use // the new value.
JavaScript (heredado)
// Assume that the correlator is currently 12345. All ad requests made // by this page will currently use that value. // Replace the current correlator with a new correlator. googletag.pubads().updateCorrelator(); // The correlator will now be a new randomly selected value, different // from 12345. All subsequent ad requests made by this page will use // the new value.
TypeScript
// Assume that the correlator is currently 12345. All ad requests made // by this page will currently use that value. // Replace the current correlator with a new correlator. googletag.pubads().updateCorrelator(); // The correlator will now be a new randomly selected value, different // from 12345. All subsequent ad requests made by this page will use // the new value.
-
Devuelve PubAdsService
El objeto de servicio en el que se llamó a la función.
googletag.ResponseInformation
Es un objeto que representa una sola respuesta de anuncio.
Resumen de la propiedad | |
---|---|
advertiserId
|
Es el ID del anunciante.
|
campaignId
|
El ID de la campaña.
|
creativeId
|
Es el ID de la creatividad.
|
creativeTemplateId
|
El ID de plantilla del anuncio.
|
lineItemId
|
El ID de la línea de pedido.
|
- Consulta también
advertiserId
-
advertiserId: null | number
-
Es el ID del anunciante.
-
campaignId
-
campaignId: null | number
-
El ID de la campaña.
-
creativeId
-
creativeId: null | number
-
Es el ID de la creatividad.
-
creativeTemplateId
-
creativeTemplateId: null | number
-
El ID de plantilla del anuncio.
-
lineItemId
-
lineItemId: null | number
-
El ID de la línea de pedido.
-
googletag.RewardedPayload
Es un objeto que representa la recompensa asociada con un anuncio recompensado.
Resumen de la propiedad | |
---|---|
amount
|
Es la cantidad de elementos incluidos en la recompensa.
|
type
|
Indica el tipo de elemento incluido en la recompensa (por ejemplo, "moneda").
|
- Consulta también
amount
-
amount: number
-
Es la cantidad de elementos incluidos en la recompensa.
-
type
-
type: string
-
Indica el tipo de elemento incluido en la recompensa (por ejemplo, "moneda").
-
googletag.SafeFrameConfig
Objeto de configuración para contenedores de SafeFrame.
Resumen de la propiedad | |
---|---|
allowOverlayExpansion
|
Indica si SafeFrame debe permitir que el contenido de los anuncios se expanda al superponer el contenido de la página.
|
allowPushExpansion
|
Indica si SafeFrame debe permitir que el contenido de los anuncios se expanda al enviar el contenido de la página.
|
sandbox
|
Indica si SafeFrame debe usar el atributo de zona de pruebas de HTML5 para evitar la navegación de nivel superior sin interacción del usuario.
|
useUniqueDomain
|
Obsoleto.
Indica si SafeFrame debe usar subdominios aleatorios para las creatividades de reservación.
|
- Consulta también
allowOverlayExpansion
-
allowOverlayExpansion: boolean
-
Indica si SafeFrame debe permitir que el contenido de los anuncios se expanda al superponer el contenido de la página.
-
allowPushExpansion
-
allowPushExpansion: boolean
-
Indica si SafeFrame debe permitir que el contenido de los anuncios se expanda al enviar el contenido de la página.
-
sandbox
-
sandbox: boolean
-
Indica si SafeFrame debe usar el atributo de zona de pruebas de HTML5 para evitar la navegación de nivel superior sin interacción del usuario. El único valor válido es
true
(no se puede forzar afalse
). Ten en cuenta que el atributo de zona de pruebas inhabilita los complementos (p.ej., Flash). -
useUniqueDomain
-
useUniqueDomain: null | boolean
-
Indica si SafeFrame debe usar subdominios aleatorios para las creatividades de reservación. Pasa
null
para borrar el valor almacenado.
Nota: Esta función está habilitada de forma predeterminada. -
- Consulta también
googletag.Service
Es la clase de servicio base que contiene métodos comunes para todos los servicios.
Resumen de métodos | |
---|---|
addEventListener
|
Registra un objeto de escucha que te permite configurar una función de JavaScript y llamarla cuando ocurre un evento de GPT específico en la página.
|
getSlots
|
Obtén la lista de ranuras asociadas con este servicio.
|
removeEventListener
|
Quita un objeto de escucha registrado previamente.
|
addEventListener
-
addEventListener<K extends keyof EventTypeMap>(eventType: K, listener: (arg: EventTypeMap[K]) => void): Service
-
Registra un objeto de escucha que te permite configurar una función de JavaScript y llamarla cuando ocurre un evento de GPT específico en la página. Se admiten los siguientes eventos:
Cuando se lo llama, se pasa un objeto del tipo de evento adecuado al objeto de escucha. -
- Ejemplo
-
JavaScript
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", (event) => { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { if (event.slot === targetSlot) { // Slot specific logic. } });
JavaScript (heredado)
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", function (event) { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", function (event) { if (event.slot === targetSlot) { // Slot specific logic. } });
TypeScript
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", (event) => { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { if (event.slot === targetSlot) { // Slot specific logic. } });
- Consulta también
-
Parámetros eventType: K
Es una cadena que representa el tipo de evento que genera GPT. Los tipos de eventos distinguen mayúsculas de minúsculas.listener: (arg: EventTypeMap[K]) => void
Es una función que toma un solo argumento de objeto de evento. -
Devuelve Service
El objeto de servicio en el que se llamó al método.
getSlots
removeEventListener
-
removeEventListener<K extends keyof EventTypeMap>(eventType: K, listener: (event: EventTypeMap[K]) => void): void
-
Quita un objeto de escucha registrado previamente.
-
- Ejemplo
-
JavaScript
googletag.cmd.push(() => { // Define a new ad slot. googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. const onViewableListener = (event) => { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(() => { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
JavaScript (heredado)
googletag.cmd.push(function () { // Define a new ad slot. googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. var onViewableListener = function (event) { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(function () { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
TypeScript
googletag.cmd.push(() => { // Define a new ad slot. googletag .defineSlot("/6355419/Travel", [728, 90], "div-for-slot")! .addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. const onViewableListener = (event: googletag.events.ImpressionViewableEvent) => { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(() => { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
-
Parámetros eventType: K
Es una cadena que representa el tipo de evento que genera GPT. Los tipos de eventos distinguen mayúsculas de minúsculas.listener: (event: EventTypeMap[K]) => void
Es una función que toma un solo argumento de objeto de evento.
googletag.SizeMappingBuilder
Compilador para objetos de especificación de asignación de tamaño. Este compilador se proporciona para ayudar a crear especificaciones de tamaño con facilidad.
Resumen de métodos | |
---|---|
addSize
|
Agrega una asignación de un array de tamaño único (que representa el viewport) a un array de uno o varios tamaños que representa el espacio.
|
build
|
Compila una especificación de mapa de tamaño a partir de las asignaciones agregadas a este compilador.
|
- Consulta también
addSize
-
addSize(viewportSize: SingleSizeArray, slotSize: GeneralSize): SizeMappingBuilder
-
Agrega una asignación de un array de tamaño único (que representa el viewport) a un array de uno o varios tamaños que representa el espacio.
-
- Ejemplo
-
JavaScript
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 640x480 .build(); // Mapping 2 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], []) .addSize([640, 480], [120, 60]) .addSize([0, 0], []) .build(); // Mapping 2 will not show any ads for the following viewport sizes: // [1024, 768] > size >= [980, 690] and // [640, 480] > size >= [0, 0]
JavaScript (heredado)
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 640x480 .build(); // Mapping 2 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], []) .addSize([640, 480], [120, 60]) .addSize([0, 0], []) .build(); // Mapping 2 will not show any ads for the following viewport sizes: // [1024, 768] > size >= [980, 690] and // [640, 480] > size >= [0, 0]
TypeScript
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 640x480 .build(); // Mapping 2 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], []) .addSize([640, 480], [120, 60]) .addSize([0, 0], []) .build(); // Mapping 2 will not show any ads for the following viewport sizes: // [1024, 768] > size >= [980, 690] and // [640, 480] > size >= [0, 0]
-
Parámetros viewportSize: SingleSizeArray
El tamaño del viewport para esta entrada de asignación.slotSize: GeneralSize
Los tamaños del espacio para esta entrada de asignación. -
Devuelve SizeMappingBuilder
Es una referencia a este compilador.
build
-
build(): null | SizeMappingArray
-
Compila una especificación de mapa de tamaño a partir de las asignaciones agregadas a este compilador.
Si se proporcionaron asignaciones no válidas, este método mostraránull
. De lo contrario, muestra una especificación en el formato correcto para pasar aSlot.defineSizeMapping
.
Nota: El comportamiento del compilador después de llamar a este método no está definido. -
-
Devuelve null | SizeMappingArray
Es el resultado que compiló este compilador. Puede ser nulo si se proporcionaron asignaciones de tamaño no válidas.
googletag.Slot
El espacio publicitario es un objeto que representa un único espacio publicitario en una página.
Resumen de métodos | |
---|---|
addService
|
Agrega un
Service a este espacio publicitario.
|
clearCategoryExclusions
|
Borra todas las etiquetas de exclusión de categorías de anuncios a nivel del espacio publicitario para este espacio.
|
clearTargeting
|
Se borran todos los parámetros de segmentación personalizados a nivel del espacio publicitario o específicos para este espacio.
|
defineSizeMapping
|
Establece un array de asignaciones desde un tamaño mínimo de viewport hasta el tamaño de espacio para este espacio.
|
get
|
Muestra el valor del atributo de AdSense asociado a la clave determinada para este espacio publicitario.
|
getAdUnitPath
|
Muestra la ruta de acceso completa de la unidad de anuncios, con el código de red y la ruta de acceso de la unidad de anuncios.
|
getAttributeKeys
|
Muestra la lista de claves de atributo configuradas en este espacio.
|
getCategoryExclusions
|
Devuelve las etiquetas de exclusión de categorías de anuncios de este espacio publicitario.
|
getResponseInformation
|
Muestra la información de la respuesta del anuncio.
|
getSlotElementId
|
Muestra el ID de la ranura
div que se proporcionó cuando se definió.
|
getTargeting
|
Muestra un parámetro de segmentación personalizado específico configurado en este espacio publicitario.
|
getTargetingKeys
|
Muestra la lista de todas las claves de segmentación personalizadas configuradas en este espacio publicitario.
|
set
|
Establece un valor para un atributo de AdSense en este espacio publicitario.
|
setCategoryExclusion
|
Establece una etiqueta de exclusión de categoría de anuncio a nivel del espacio publicitario en este espacio.
|
setClickUrl
|
Establece la URL de clic a la que se redireccionará a los usuarios después de hacer clic en el anuncio.
|
setCollapseEmptyDiv
|
Establece si el espacio
div debe ocultarse cuando no hay ningún anuncio en el espacio.
|
setConfig
|
Establece las opciones de configuración generales para esta ranura.
|
setForceSafeFrame
|
Determina si los anuncios de este espacio publicitario se deben renderizar de manera forzosa con un contenedor de SafeFrame.
|
setSafeFrameConfig
|
Establece las preferencias a nivel de ranura para la configuración de SafeFrame.
|
setTargeting
|
Establece un parámetro de segmentación personalizada para este espacio publicitario.
|
updateTargetingFromMap
|
Establece parámetros de segmentación personalizados para este espacio publicitario a partir de un mapa clave-valor en un objeto JSON.
|
addService
-
Agrega un
Service
a este espacio publicitario. -
- Ejemplo
-
JavaScript
googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());
JavaScript (heredado)
googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());
TypeScript
googletag.defineSlot("/1234567/sports", [160, 600], "div")!.addService(googletag.pubads());
- Consulta también
-
Parámetros service: Service
El servicio que se agregará. -
Devuelve Slot
Es el objeto de ranura en el que se llamó al método.
clearCategoryExclusions
-
clearCategoryExclusions(): Slot
-
Borra todas las etiquetas de exclusión de categorías de anuncios a nivel del espacio publicitario para este espacio.
-
- Ejemplo
-
JavaScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.clearCategoryExclusions(); // Make an ad request. Any ad can be returned for the slot.
JavaScript (heredado)
// Set category exclusion to exclude ads with 'AirlineAd' labels. var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.clearCategoryExclusions(); // Make an ad request. Any ad can be returned for the slot.
TypeScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.clearCategoryExclusions(); // Make an ad request. Any ad can be returned for the slot.
-
Devuelve Slot
Es el objeto de ranura en el que se llamó al método.
clearTargeting
-
clearTargeting(key?: string): Slot
-
Se borran todos los parámetros de segmentación personalizados a nivel del espacio publicitario o específicos para este espacio.
-
- Ejemplo
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
JavaScript (heredado)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
- Consulta también
-
Parámetros key?: string
Clave del parámetro de segmentación. La clave es opcional. Si no se especifica, se borrarán todos los parámetros de segmentación. -
Devuelve Slot
Es el objeto de ranura en el que se llamó al método.
defineSizeMapping
-
defineSizeMapping(sizeMapping: SizeMappingArray): Slot
-
Establece un array de asignaciones desde un tamaño mínimo de viewport hasta el tamaño de espacio para este espacio.
-
- Ejemplo
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); const mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ] ) .build(); slot.defineSizeMapping(mapping);
JavaScript (heredado)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); var mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ] ) .build(); slot.defineSizeMapping(mapping);
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); const mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ] ) .build(); slot.defineSizeMapping(mapping!);
- Consulta también
-
Parámetros sizeMapping: SizeMappingArray
Array de asignaciones de tamaño. Puedes usarSizeMappingBuilder
para crearla. Cada asignación de tamaño es un array de dos elementos:SingleSizeArray
yGeneralSize
. -
Devuelve Slot
Es el objeto de ranura en el que se llamó al método.
get
-
get(key: string): null | string
-
Muestra el valor del atributo de AdSense asociado a la clave determinada para este espacio publicitario. Para ver los atributos de nivel de servicio que hereda este espacio, usa
PubAdsService.get
. -
- Ejemplo
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
JavaScript (heredado)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
- Consulta también
-
Parámetros key: string
Es el nombre del atributo que se debe buscar. -
Devuelve null | string
El valor actual de la clave de atributo onull
si la clave no está presente.
getAdUnitPath
-
getAdUnitPath(): string
-
Muestra la ruta de acceso completa de la unidad de anuncios, con el código de red y la ruta de acceso de la unidad de anuncios.
-
- Ejemplo
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
JavaScript (heredado)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
-
Devuelve string
Ruta de acceso de la unidad de anuncios.
getAttributeKeys
-
getAttributeKeys(): string[]
-
Muestra la lista de claves de atributo configuradas en este espacio. Para ver las claves de los atributos de nivel de servicio que hereda este espacio, usa
PubAdsService.getAttributeKeys
. -
- Ejemplo
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .set("adsense_border_color", "#AABBCC") .addService(googletag.pubads()); slot.getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
JavaScript (heredado)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .set("adsense_border_color", "#AABBCC") .addService(googletag.pubads()); slot.getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .set("adsense_border_color", "#AABBCC") .addService(googletag.pubads()); slot.getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
-
Devuelve string[]
Arreglo de claves de atributo. El ordenamiento no está definido.
getCategoryExclusions
-
getCategoryExclusions(): string[]
-
Devuelve las etiquetas de exclusión de categorías de anuncios de este espacio publicitario.
-
- Ejemplo
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
JavaScript (heredado)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
-
Devuelve string[]
Las etiquetas de exclusión de categoría de anuncios de este espacio publicitario o un array vacío si no se estableció ninguna.
getResponseInformation
-
getResponseInformation(): null | ResponseInformation
-
Muestra la información de la respuesta del anuncio. Se basa en la última respuesta de anuncio del espacio. Si se llama a este método cuando el espacio no tiene ningún anuncio, se mostrará
null
. -
-
Devuelve null | ResponseInformation
La información más reciente de la respuesta de anuncios onull
si el espacio no tiene ningún anuncio
getSlotElementId
-
getSlotElementId(): string
-
Muestra el ID de la ranura
div
que se proporcionó cuando se definió. -
- Ejemplo
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div-1'.
JavaScript (heredado)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div-1'.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div-1'.
-
Devuelve string
ID de la ranuradiv
.
getTargeting
-
getTargeting(key: string): string[]
-
Muestra un parámetro de segmentación personalizado específico configurado en este espacio publicitario. No se incluyen los parámetros de segmentación a nivel de servicio.
-
- Ejemplo
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
JavaScript (heredado)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
-
Parámetros key: string
La clave de segmentación que se debe buscar. -
Devuelve string[]
Los valores asociados con esta clave o un array vacío si no existe esa clave.
getTargetingKeys
-
getTargetingKeys(): string[]
-
Muestra la lista de todas las claves de segmentación personalizadas configuradas en este espacio publicitario. No se incluyen las claves de segmentación a nivel del servicio.
-
- Ejemplo
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .addService(googletag.pubads()); slot.getTargetingKeys(); // Returns ['interests', 'allow_expandable'].
JavaScript (heredado)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .addService(googletag.pubads()); slot.getTargetingKeys(); // Returns ['interests', 'allow_expandable'].
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .addService(googletag.pubads()); slot.getTargetingKeys(); // Returns ['interests', 'allow_expandable'].
-
Devuelve string[]
Es el array de claves de segmentación. El ordenamiento no está definido.
set
-
set(key: string, value: string): Slot
-
Establece un valor para un atributo de AdSense en este espacio publicitario. Esto anulará cualquier valor establecido en el nivel de servicio para esta clave.
Si llamas a este método más de una vez para la misma clave, se anularán los valores establecidos para esa clave. Se deben configurar todos los valores antes de llamar adisplay
orefresh
. -
- Ejemplo
-
JavaScript
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
JavaScript (heredado)
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
TypeScript
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
- Consulta también
-
Parámetros key: string
Es el nombre del atributo.value: string
Valor del atributo. -
Devuelve Slot
Es el objeto de ranura en el que se llamó al método.
setCategoryExclusion
-
setCategoryExclusion(categoryExclusion: string): Slot
-
Establece una etiqueta de exclusión de categoría de anuncio a nivel del espacio publicitario en este espacio.
-
- Ejemplo
-
JavaScript
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
JavaScript (heredado)
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
TypeScript
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
- Consulta también
-
Parámetros categoryExclusion: string
La etiqueta de exclusión de categoría de anuncios que se agregará. -
Devuelve Slot
Es el objeto de ranura en el que se llamó al método.
setClickUrl
-
setClickUrl(value: string): Slot
-
Establece la URL de clic a la que se redireccionará a los usuarios después de hacer clic en el anuncio.
Los servidores de Google Ad Manager aún registran un clic, incluso si se reemplaza la URL de clic. Toda URL de página de destino asociada con la creatividad que se publica se agrega al valor proporcionado. Las llamadas posteriores reemplazan el valor. Esto funciona solo para solicitudes que no sean de SRA. -
- Ejemplo
-
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
JavaScript (heredado)
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
TypeScript
googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
-
Parámetros value: string
La URL de clic que se establecerá. -
Devuelve Slot
Es el objeto de ranura en el que se llamó al método.
setCollapseEmptyDiv
-
setCollapseEmptyDiv(collapse: boolean, collapseBeforeAdFetch?: boolean): Slot
-
Establece si el espacio
div
debe ocultarse cuando no hay ningún anuncio en el espacio. Esto anula la configuración del nivel de servicio. -
- Ejemplo
-
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2") .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
JavaScript (heredado)
googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2") .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
TypeScript
googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2")! .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
- Consulta también
-
Parámetros collapse: boolean
Indica si se debe contraer el espacio publicitario cuando no se muestra ningún anuncio.collapseBeforeAdFetch?: boolean
Si se debe contraer el espacio publicitario incluso antes de que se recupere un anuncio. Se ignora si la contracción no estrue
. -
Devuelve Slot
Es el objeto de ranura en el que se llamó al método.
setConfig
-
setConfig(slotConfig: SlotSettingsConfig): void
-
Establece las opciones de configuración generales para esta ranura.
-
-
Parámetros slotConfig: SlotSettingsConfig
El objeto de configuración.
setForceSafeFrame
-
setForceSafeFrame(forceSafeFrame: boolean): Slot
-
Determina si se debe forzar la renderización de los anuncios en este espacio publicitario con un contenedor de SafeFrame.
Ten en cuenta lo siguiente cuando uses esta API:- Este parámetro de configuración solo se aplicará a las solicitudes de anuncios posteriores realizadas para los espacios respectivos.
- Si se especifica, la configuración a nivel de espacio publicitario siempre anulará la configuración a nivel de página.
- Si se establece en
true
(a nivel del espacio publicitario o de la página), el anuncio siempre se renderizará con un contenedor de SafeFrame independientemente de la opción que se elija en la IU de Google Ad Manager. - Sin embargo, si se establece como
false
o no se especifica, el anuncio se renderizará con un contenedor de SafeFrame, según el tipo de creatividad y la selección que se haya realizado en la IU de Google Ad Manager. - Esta API debe usarse con precaución, ya que podría afectar el comportamiento de las creatividades que intenten salir de sus iFrames o dependan de que se rendericen directamente en una página del publicador.
-
- Ejemplo
-
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setForceSafeFrame(true) .addService(googletag.pubads());
JavaScript (heredado)
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setForceSafeFrame(true) .addService(googletag.pubads());
TypeScript
googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setForceSafeFrame(true) .addService(googletag.pubads());
- Consulta también
-
Parámetros forceSafeFrame: boolean
true
para forzar que todos los anuncios de este espacio publicitario se dibujen en SafeFrames yfalse
para inhabilitar una configuración a nivel de la página (si existe). Establecer este parámetro enfalse
cuando no se especifica a nivel de la página no cambiará nada. -
Devuelve Slot
Es el objeto de ranura en el que se llamó al método.
setSafeFrameConfig
-
setSafeFrameConfig(config: null | SafeFrameConfig): Slot
-
Establece las preferencias a nivel de ranura para la configuración de SafeFrame. Se ignorarán las claves no reconocidas en el objeto de configuración. Se ignorará toda la configuración si se pasa un valor no válido para una clave reconocida.
Estas preferencias a nivel de espacio publicitario, si se especifican, anularán cualquier preferencia a nivel de página. -
- Ejemplo
-
JavaScript
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript (heredado)
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
TypeScript
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
- Consulta también
-
Parámetros config: null | SafeFrameConfig
El objeto de configuración. -
Devuelve Slot
Es el objeto de ranura en el que se llamó al método.
setTargeting
-
setTargeting(key: string, value: string | string[]): Slot
-
Establece un parámetro de segmentación personalizada para este espacio publicitario. Si llamas a este método varias veces para la misma clave, se reemplazarán los valores anteriores. Los valores que se establezcan aquí reemplazarán los parámetros de segmentación establecidos a nivel del servicio. Estas claves se definen en tu cuenta de Google Ad Manager.
-
- Ejemplo
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
JavaScript (heredado)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
- Consulta también
-
Parámetros key: string
Clave del parámetro de segmentación.value: string | string[]
Valor del parámetro de segmentación o array de valores. -
Devuelve Slot
Es el objeto de ranura en el que se llamó al método.
updateTargetingFromMap
-
updateTargetingFromMap(map: { [adUnitPath: string]: string | string[] }): Slot
-
Establece parámetros de segmentación personalizados para este espacio publicitario a partir de un mapa clave-valor en un objeto JSON. Esto es lo mismo que llamar a
Slot.setTargeting
para todos los valores clave del objeto. Estas claves se definen en tu cuenta de Google Ad Manager.
Notas:- En caso de reemplazo, solo se conservará el último valor.
- Si el valor es un array, se reemplazará el valor anterior, no se combinará.
- Los valores que se establezcan aquí reemplazarán los parámetros de segmentación establecidos a nivel del servicio.
-
- Ejemplo
-
JavaScript
const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div"); slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
JavaScript (heredado)
var slot = googletag.defineSlot("/1234567/sports", [160, 600], "div"); slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
TypeScript
const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!; slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
-
Parámetros map: { [adUnitPath: string]: string | string[] }
Mapa clave-valor del parámetro de segmentación. -
Devuelve Slot
Es el objeto de ranura en el que se llamó al método.
googletag.config.AdExpansionConfig
Configuración para controlar la expansión de anuncios.
Resumen de la propiedad | |
---|---|
enabled
|
Indica si la expansión de anuncios está habilitada o inhabilitada.
|
- Ejemplo
-
JavaScript
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
JavaScript (heredado)
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
TypeScript
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
enabled
-
enabled: boolean
-
Indica si la expansión de anuncios está habilitada o inhabilitada.
Si estableces este valor, se anulará la configuración predeterminada en Google Ad Manager.
googletag.config.ComponentAuctionConfig
Es un objeto que representa una subasta de un solo componente en una subasta de anuncios en el dispositivo.
Resumen de la propiedad | |
---|---|
auctionConfig
|
Un objeto de configuración de subasta para la subasta de este componente.
|
configKey
|
Es la clave de configuración asociada con la subasta de este componente.
|
auctionConfig
-
auctionConfig: null | { auctionSignals: unknown, decisionLogicUrl: string, interestGroupBuyers: string[], perBuyerExperimentGroupIds: { [buyer: string]: number }, perBuyerGroupLimits: { [buyer: string]: number }, perBuyerSignals: { [buyer: string]: unknown }, perBuyerTimeouts: { [buyer: string]: number }, seller: string, sellerExperimentGroupId: number, sellerSignals: unknown, sellerTimeout: number, trustedScoringSignalsUrl: string }
-
Un objeto de configuración de subasta para la subasta de este componente.
Si este valor se establece ennull
, se borrará cualquier configuración existente para laconfigKey
especificada. -
- Ejemplo
-
JavaScript
const componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicUrl's origin seller: "https://testSeller.com", decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]); // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
JavaScript (heredado)
var componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicUrl's origin seller: "https://testSeller.com", decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; var auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]); // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
TypeScript
const componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicUrl's origin seller: "https://testSeller.com", decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600])!; // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
- Consulta también
configKey
-
configKey: string
-
La clave de configuración asociada con la subasta de este componente.
Este valor no debe estar vacío y debe ser único. Si dos objetosComponentAuctionConfig
comparten el mismo valor de configKey, el último que se configure reemplazará los parámetros de configuración anteriores. -
googletag.config.InterstitialConfig
Es un objeto que define el comportamiento de un solo espacio publicitario intersticial.
Resumen de la propiedad | |
---|---|
triggers
|
La configuración del activador de anuncios intersticiales para este anuncio intersticial.
|
triggers
-
triggers: Partial<Record<InterstitialTrigger, boolean>>
-
La configuración del activador de anuncios intersticiales para este anuncio intersticial.
Si estableces el valor de un activador de anuncio intersticial entrue
, se habilitará yfalse
se inhabilitará. Esto anulará los valores predeterminados configurados en Google Ad Manager. -
- Ejemplo
-
JavaScript
// Define a GPT managed web interstitial ad slot. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL ); // Enable optional interstitial triggers. // Change this value to false to disable. const enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
JavaScript (heredado)
// Define a GPT managed web interstitial ad slot. var interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL ); // Enable optional interstitial triggers. // Change this value to false to disable. var enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
TypeScript
// Define a GPT managed web interstitial ad slot. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL )!; // Enable optional interstitial triggers. // Change this value to false to disable. const enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
- Consulta también
googletag.config.PageSettingsConfig
Interfaz de configuración principal para la configuración a nivel de página.
Permite configurar varias funciones con una sola llamada a la API.
Todas las propiedades que aparecen a continuación son ejemplos y no reflejan funciones reales que utilizan setConfig. Para ver el conjunto de funciones, consulta los campos del tipo PageSettingsConfig a continuación.
Ejemplos:
- Solo se modifican las funciones especificadas en la llamada
setConfig
.// Configure feature alpha. googletag.setConfig({ alpha: {...} }); // Configure feature bravo. Feature alpha is unchanged. googletag.setConfig({ bravo: {...} });
- Todos los parámetros de configuración de una función determinada se actualizan con cada llamada a
setConfig
.// Configure feature charlie to echo = 1, foxtrot = true. googletag.setConfig({ charlie: { echo: 1, foxtrot: true, } }); // Update feature charlie to echo = 2. Since foxtrot was not specified, // the value is cleared. googletag.setConfig({ charlie: { echo: 2 } });
- Para borrar todos los parámetros de configuración de un componente, pasa
null
.// Configure features delta, golf, and hotel. googletag.setConfig({ delta: {...}, golf: {...}, hotel: {...}, }); // Feature delta and hotel are cleared, but feature golf remains set. googletag.setConfig({ delta: null, hotel: null, });
Resumen de la propiedad | |
---|---|
adExpansion
|
Configuración para controlar la expansión de anuncios.
|
pps
|
Es la configuración para controlar los indicadores proporcionados por el publicador (PPS).
|
privacyTreatments
|
Es la configuración para controlar los tratamientos de privacidad del publicador.
|
adExpansion
-
adExpansion: null | AdExpansionConfig
-
Configuración para controlar la expansión de anuncios.
-
pps
-
pps: null | PublisherProvidedSignalsConfig
-
Es la configuración para controlar los indicadores proporcionados por el publicador (PPS).
-
privacyTreatments
-
privacyTreatments: null | PrivacyTreatmentsConfig
-
Es la configuración para controlar los tratamientos de privacidad del publicador.
-
googletag.config.PrivacyTreatmentsConfig
Es la configuración para controlar los tratamientos de privacidad del publicador.
Resumen de la propiedad | |
---|---|
treatments
|
Una variedad de tratamientos de privacidad para publicadores que se pueden habilitar.
|
treatments
-
treatments: "disablePersonalization"[]
-
Una variedad de tratamientos de privacidad para publicadores que se pueden habilitar.
-
- Ejemplo
-
JavaScript
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
JavaScript (heredado)
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
TypeScript
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
googletag.config.PublisherProvidedSignalsConfig
Objeto de configuración de indicadores proporcionados por el publicador (PPS).
Resumen de la propiedad | |
---|---|
taxonomies
|
Un objeto que contiene asignaciones de Taxonomía.
|
- Ejemplo
-
JavaScript
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 18-20' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
JavaScript (heredado)
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 18-20' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
TypeScript
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 18-20' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
- Consulta también
taxonomies
-
taxonomies: Partial<Record<Taxonomy, TaxonomyData>>
-
Un objeto que contiene asignaciones de Taxonomía.
-
googletag.config.SlotSettingsConfig
Interfaz de configuración principal para los ajustes a nivel de ranura.
Permite configurar varias funciones con una sola llamada a la API para una sola ranura.
Todas las propiedades que se muestran a continuación son ejemplos y no reflejan atributos reales que utilizan setConfig. Para ver el conjunto de atributos, consulta los campos del tipo SlotSettingsConfig que se muestran a continuación.
Ejemplos:
- Solo se modifican las funciones especificadas en la llamada
Slot.setConfig
.const slot = googletag.defineSlot("/1234567/example", [160, 600]); // Configure feature alpha. slot.setConfig({ alpha: {...} }); // Configure feature bravo. Feature alpha is unchanged. slot.setConfig({ bravo: {...} });
- Todos los parámetros de configuración de una función determinada se actualizan con cada llamada a
Slot.setConfig
.// Configure feature charlie to echo = 1, foxtrot = true. slot.setConfig({ charlie: { echo: 1, foxtrot: true, } }); // Update feature charlie to echo = 2. Since foxtrot was not specified, // the value is cleared. slot.setConfig({ charlie: { echo: 2 } });
- Para borrar todos los parámetros de configuración de un componente, pasa
null
.// Configure features delta, golf, and hotel. slot.setConfig({ delta: {...}, golf: {...}, hotel: {...}, }); // Feature delta and hotel are cleared, but feature golf remains set. slot.setConfig({ delta: null, hotel: null, });
Resumen de la propiedad | |
---|---|
adExpansion
|
Configuración para controlar la expansión de anuncios.
|
componentAuction
|
Es una matriz de subastas de componentes que se incluirá en una subasta de anuncios en el dispositivo.
|
interstitial
|
Son parámetros de configuración que controlan el comportamiento de los espacios publicitarios intersticiales.
|
adExpansion
-
adExpansion: AdExpansionConfig
-
Configuración para controlar la expansión de anuncios.
-
componentAuction
-
componentAuction: ComponentAuctionConfig[]
-
Es una matriz de subastas de componentes que se incluirá en una subasta de anuncios en el dispositivo.
-
interstitial
-
interstitial: InterstitialConfig
-
Son parámetros de configuración que controlan el comportamiento de los espacios publicitarios intersticiales.
-
googletag.config.TaxonomyData
Un objeto que contiene los valores de una sola Taxonomía.
Resumen de la propiedad | |
---|---|
values
|
Una lista de los valores de la taxonomía.
|
values
-
values: string[]
-
Una lista de los valores de la taxonomía.
-
googletag.events.Event
Interfaz base para todos los eventos de GPT. Todos los eventos de GPT que se indican a continuación tendrán los campos que se indican a continuación.
Resumen de la propiedad | |
---|---|
serviceName
|
Nombre del servicio que activó el evento.
|
slot
|
El espacio que activó el evento
|
- Consulta también
serviceName
-
serviceName: string
-
Nombre del servicio que activó el evento.
-
slot
-
slot: Slot
-
El espacio que activó el evento
-
googletag.events.EventTypeMap
Este es un seudotipo que asigna un nombre de evento a su tipo de objeto de evento correspondiente para Service.addEventListener
y Service.removeEventListener
. Se documenta solo con fines de referencia y seguridad de tipos.
Resumen de la propiedad | |
---|---|
impressionViewable
|
Alias de
events.ImpressionViewableEvent .
|
rewardedSlotClosed
|
Alias de
events.RewardedSlotClosedEvent .
|
rewardedSlotGranted
|
Alias de
events.RewardedSlotGrantedEvent .
|
rewardedSlotReady
|
Alias de
events.RewardedSlotReadyEvent .
|
slotOnload
|
Alias de
events.SlotOnloadEvent .
|
slotRenderEnded
|
Alias de
events.SlotRenderEndedEvent .
|
slotRequested
|
Alias de
events.SlotRequestedEvent .
|
slotResponseReceived
|
Alias de
events.SlotResponseReceived .
|
slotVisibilityChanged
|
Alias de
events.SlotVisibilityChangedEvent .
|
impressionViewable
-
impressionViewable: ImpressionViewableEvent
-
Alias de
events.ImpressionViewableEvent
. -
rewardedSlotClosed
-
rewardedSlotClosed: RewardedSlotClosedEvent
-
Alias de
events.RewardedSlotClosedEvent
. -
rewardedSlotGranted
-
rewardedSlotGranted: RewardedSlotGrantedEvent
-
Alias de
events.RewardedSlotGrantedEvent
. -
rewardedSlotReady
-
rewardedSlotReady: RewardedSlotReadyEvent
-
Alias de
events.RewardedSlotReadyEvent
. -
slotOnload
-
slotOnload: SlotOnloadEvent
-
Alias de
events.SlotOnloadEvent
. -
slotRenderEnded
-
slotRenderEnded: SlotRenderEndedEvent
-
Alias de
events.SlotRenderEndedEvent
. -
slotRequested
-
slotRequested: SlotRequestedEvent
-
Alias de
events.SlotRequestedEvent
. -
slotResponseReceived
-
slotResponseReceived: SlotResponseReceived
-
Alias de
events.SlotResponseReceived
. -
slotVisibilityChanged
-
slotVisibilityChanged: SlotVisibilityChangedEvent
-
Alias de
events.SlotVisibilityChangedEvent
. -
googletag.events.ImpressionViewableEvent
Extiende
Este evento se activa cuando una impresión se hace visible, según los criterios de Vista activa.
Resumen de la propiedad | |
---|---|
serviceName
|
Nombre del servicio que activó el evento.
Heredado de
|
slot
|
El espacio que activó el evento
Heredado de
|
- Ejemplo
-
JavaScript
// This listener is called when an impression becomes viewable. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("impressionViewable", (event) => { const slot = event.slot; console.log("Impression for slot", slot.getSlotElementId(), "became viewable."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (heredado)
// This listener is called when an impression becomes viewable. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("impressionViewable", function (event) { var slot = event.slot; console.log("Impression for slot", slot.getSlotElementId(), "became viewable."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when an impression becomes viewable. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("impressionViewable", (event) => { const slot = event.slot; console.log("Impression for slot", slot.getSlotElementId(), "became viewable."); if (slot === targetSlot) { // Slot specific logic. } });
- Consulta también
googletag.events.RewardedSlotClosedEvent
Extiende
Este evento se activa cuando el usuario cierra un espacio publicitario recompensado. Se puede activar antes o después de que se haya otorgado la recompensa. Para determinar si se otorgó una recompensa, usa events.RewardedSlotGrantedEvent
en su lugar.
Resumen de la propiedad | |
---|---|
serviceName
|
Nombre del servicio que activó el evento.
Heredado de
|
slot
|
El espacio que activó el evento
Heredado de
|
- Ejemplo
-
JavaScript
// This listener is called when the user closes a rewarded ad slot. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotClosed", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (heredado)
// This listener is called when the user closes a rewarded ad slot. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotClosed", function (event) { var slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when the user closes a rewarded ad slot. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotClosed", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed."); if (slot === targetSlot) { // Slot specific logic. } });
- Consulta también
googletag.events.RewardedSlotGrantedEvent
Extiende
Este evento se activa cuando se otorga una recompensa por ver un anuncio recompensado. Si se cierra el anuncio antes de que se cumplan los criterios para otorgar una recompensa, este evento no se activará.
Resumen de la propiedad | |
---|---|
payload
|
Es un objeto que contiene información sobre la recompensa que se otorgó.
|
serviceName
|
Nombre del servicio que activó el evento.
Heredado de
|
slot
|
El espacio que activó el evento
Heredado de
|
- Ejemplo
-
JavaScript
// This listener is called whenever a reward is granted for a // rewarded ad. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotGranted", (event) => { const slot = event.slot; console.group("Reward granted for slot", slot.getSlotElementId(), "."); // Log details of the reward. console.log("Reward type:", event.payload?.type); console.log("Reward amount:", event.payload?.amount); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (heredado)
// This listener is called whenever a reward is granted for a // rewarded ad. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotGranted", function (event) { var _a, _b; var slot = event.slot; console.group("Reward granted for slot", slot.getSlotElementId(), "."); // Log details of the reward. console.log("Reward type:", (_a = event.payload) === null || _a === void 0 ? void 0 : _a.type); console.log( "Reward amount:", (_b = event.payload) === null || _b === void 0 ? void 0 : _b.amount ); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called whenever a reward is granted for a // rewarded ad. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotGranted", (event) => { const slot = event.slot; console.group("Reward granted for slot", slot.getSlotElementId(), "."); // Log details of the reward. console.log("Reward type:", event.payload?.type); console.log("Reward amount:", event.payload?.amount); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
- Consulta también
payload
-
payload: null | RewardedPayload
-
Es un objeto que contiene información sobre la recompensa que se otorgó.
-
googletag.events.RewardedSlotReadyEvent
Extiende
Este evento se activa cuando un anuncio recompensado está listo para mostrarse. El publicador es responsable de presentar al usuario una opción para ver el anuncio antes de mostrarlo.
Resumen de la propiedad | |
---|---|
serviceName
|
Nombre del servicio que activó el evento.
Heredado de
|
slot
|
El espacio que activó el evento
Heredado de
|
Resumen de métodos | |
---|---|
makeRewardedVisible
|
Muestra el anuncio recompensado.
|
- Ejemplo
-
JavaScript
// This listener is called when a rewarded ad slot becomes ready to be // displayed. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotReady", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed."); // Replace with custom logic. const userHasConsented = true; if (userHasConsented) { event.makeRewardedVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (heredado)
// This listener is called when a rewarded ad slot becomes ready to be // displayed. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotReady", function (event) { var slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed."); // Replace with custom logic. var userHasConsented = true; if (userHasConsented) { event.makeRewardedVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a rewarded ad slot becomes ready to be // displayed. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotReady", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed."); // Replace with custom logic. const userHasConsented = true; if (userHasConsented) { event.makeRewardedVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
- Consulta también
makeRewardedVisible
-
makeRewardedVisible(): void
-
Muestra el anuncio recompensado. No se debe llamar a este método hasta que el usuario dé su consentimiento para ver el anuncio.
-
googletag.events.SlotOnloadEvent
Extiende
Este evento se activa cuando el iframe de la creatividad activa su evento de carga. Cuando se renderizan anuncios rich media en el modo de renderización sincronizada, no se usa iframe, por lo que no se activará ningún SlotOnloadEvent
.
Resumen de la propiedad | |
---|---|
serviceName
|
Nombre del servicio que activó el evento.
Heredado de
|
slot
|
El espacio que activó el evento
Heredado de
|
- Ejemplo
-
JavaScript
// This listener is called when a creative iframe load event fires. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { const slot = event.slot; console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (heredado)
// This listener is called when a creative iframe load event fires. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", function (event) { var slot = event.slot; console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a creative iframe load event fires. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { const slot = event.slot; console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded."); if (slot === targetSlot) { // Slot specific logic. } });
- Consulta también
googletag.events.SlotRenderEndedEvent
Extiende
Este evento se activa cuando se inserta el código de la creatividad en un espacio publicitario. Este evento ocurrirá antes de que se recuperen los recursos de la creatividad, por lo que es posible que la creatividad aún no sea visible. Si necesitas saber cuándo terminaron de cargarse todos los recursos de creatividad de un espacio, puedes usar events.SlotOnloadEvent
en su lugar.
Resumen de la propiedad | |
---|---|
advertiserId
|
Es el ID del anunciante del anuncio renderizado.
|
campaignId
|
Es el ID de campaña del anuncio renderizado.
|
companyIds
|
Son los IDs de las empresas que ofertan por el anuncio de reabastecimiento renderizado.
|
creativeId
|
Es el ID de la creatividad del anuncio de reserva renderizado.
|
creativeTemplateId
|
Es el ID de la plantilla de creatividades del anuncio de reserva renderizado.
|
isBackfill
|
Indica si un anuncio era un anuncio de reabastecimiento.
|
isEmpty
|
Indica si se mostró un anuncio para el espacio publicitario.
|
labelIds
|
IDs de etiqueta del anuncio renderizado.
|
lineItemId
|
Es el ID de línea de pedido del anuncio de reserva renderizado.
|
serviceName
|
Nombre del servicio que activó el evento.
Heredado de
|
size
|
Indica el tamaño en píxeles de la creatividad renderizada.
|
slot
|
El espacio que activó el evento
Heredado de
|
slotContentChanged
|
Indica si el contenido del espacio publicitario se modificó con el anuncio renderizado.
|
sourceAgnosticCreativeId
|
Es el ID de la creatividad del anuncio de reabastecimiento o de reserva renderizado.
|
sourceAgnosticLineItemId
|
Es el ID de línea de pedido del anuncio de reservación o reabastecimiento renderizado.
|
yieldGroupIds
|
IDs de los grupos de rendimiento del anuncio de reabastecimiento renderizado.
|
- Ejemplo
-
JavaScript
// This listener is called when a slot has finished rendering. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", (event) => { const slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Label IDs:", event.labelIds); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (heredado)
// This listener is called when a slot has finished rendering. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", function (event) { var slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Label IDs:", event.labelIds); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a slot has finished rendering. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", (event) => { const slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Label IDs:", event.labelIds); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
- Consulta también
advertiserId
-
advertiserId: null | number
-
Es el ID del anunciante del anuncio renderizado. El valor es
null
para los espacios vacíos, los anuncios de reabastecimiento y las creatividades que renderizan servicios distintos dePubAdsService
. -
campaignId
-
campaignId: null | number
-
Es el ID de campaña del anuncio renderizado. El valor es
null
para los espacios vacíos, los anuncios de reabastecimiento y las creatividades que renderizan servicios distintos dePubAdsService
. -
companyIds
-
companyIds: null | number[]
-
Son los IDs de las empresas que ofertan por el anuncio de reabastecimiento renderizado. El valor es
null
para los espacios vacíos, los anuncios de reservación y las creatividades que renderizan servicios distintos dePubAdsService
. -
creativeId
-
creativeId: null | number
-
Es el ID de la creatividad del anuncio de reserva renderizado. El valor es
null
para los espacios vacíos, los anuncios de reabastecimiento y las creatividades que renderizan servicios distintos dePubAdsService
. -
creativeTemplateId
-
creativeTemplateId: null | number
-
Es el ID de la plantilla de creatividades del anuncio de reserva renderizado. El valor es
null
para los espacios vacíos, los anuncios de reabastecimiento y las creatividades que renderizan servicios distintos dePubAdsService
. -
isBackfill
-
isBackfill: boolean
-
Indica si un anuncio era un anuncio de reabastecimiento. El valor es
true
si el anuncio era un anuncio de reabastecimiento, de lo contrario,false
. -
isEmpty
-
isEmpty: boolean
-
Indica si se mostró un anuncio para el espacio publicitario. El valor es
true
si no se muestra ningún anuncio, de lo contrario,false
. -
labelIds
-
labelIds: null | number[]
-
IDs de etiqueta del anuncio renderizado. El valor es
null
para los espacios vacíos, los anuncios de reabastecimiento y las creatividades que renderizan servicios distintos dePubAdsService
. -
lineItemId
-
lineItemId: null | number
-
Es el ID de línea de pedido del anuncio de reserva renderizado. El valor es
null
para los espacios vacíos, los anuncios de reabastecimiento y las creatividades que renderizan servicios distintos dePubAdsService
. -
size
-
size: null | string | number[]
-
Indica el tamaño en píxeles de la creatividad renderizada. Ejemplo:
[728, 90]
. El valor esnull
para los espacios publicitarios vacíos. -
slotContentChanged
-
slotContentChanged: boolean
-
Indica si el contenido del espacio publicitario se modificó con el anuncio renderizado. El valor es
true
si se modificó el contenido, de lo contrario,false
. -
sourceAgnosticCreativeId
-
sourceAgnosticCreativeId: null | number
-
Es el ID de la creatividad del anuncio de reabastecimiento o de reserva renderizado. El valor es
null
si el anuncio no es una reserva o un reabastecimiento de línea de pedido, o si la creatividad se renderiza mediante servicios que no sonPubAdsService
. -
sourceAgnosticLineItemId
-
sourceAgnosticLineItemId: null | number
-
Es el ID de línea de pedido del anuncio de reservación o reabastecimiento renderizado. El valor es
null
si el anuncio no es una reserva o un reabastecimiento de línea de pedido, o si la creatividad se renderiza mediante servicios que no sonPubAdsService
. -
yieldGroupIds
-
yieldGroupIds: null | number[]
-
IDs de los grupos de rendimiento del anuncio de reabastecimiento renderizado. El valor es
null
para los espacios vacíos, los anuncios de reservación y las creatividades que renderizan servicios distintos dePubAdsService
. -
googletag.events.SlotRequestedEvent
Extiende
Este evento se activa cuando se solicita un anuncio para un espacio específico.
Resumen de la propiedad | |
---|---|
serviceName
|
Nombre del servicio que activó el evento.
Heredado de
|
slot
|
El espacio que activó el evento
Heredado de
|
- Ejemplo
-
JavaScript
// This listener is called when the specified service issues an ad // request for a slot. Each slot will fire this event, even though they // may be batched together in a single request if single request // architecture (SRA) is enabled. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRequested", (event) => { const slot = event.slot; console.log("Slot", slot.getSlotElementId(), "has been requested."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (heredado)
// This listener is called when the specified service issues an ad // request for a slot. Each slot will fire this event, even though they // may be batched together in a single request if single request // architecture (SRA) is enabled. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRequested", function (event) { var slot = event.slot; console.log("Slot", slot.getSlotElementId(), "has been requested."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when the specified service issues an ad // request for a slot. Each slot will fire this event, even though they // may be batched together in a single request if single request // architecture (SRA) is enabled. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRequested", (event) => { const slot = event.slot; console.log("Slot", slot.getSlotElementId(), "has been requested."); if (slot === targetSlot) { // Slot specific logic. } });
- Consulta también
googletag.events.SlotResponseReceived
Extiende
Este evento se activa cuando se recibe una respuesta de anuncio para un espacio en particular.
Resumen de la propiedad | |
---|---|
serviceName
|
Nombre del servicio que activó el evento.
Heredado de
|
slot
|
El espacio que activó el evento
Heredado de
|
- Ejemplo
-
JavaScript
// This listener is called when an ad response has been received // for a slot. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", (event) => { const slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (heredado)
// This listener is called when an ad response has been received // for a slot. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", function (event) { var slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when an ad response has been received // for a slot. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", (event) => { const slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
- Consulta también
googletag.events.SlotVisibilityChangedEvent
Extiende
Este evento se activa cada vez que cambia el porcentaje en pantalla del área de un espacio publicitario. El evento está limitado y no se activará más de una vez cada 200 ms.
Resumen de la propiedad | |
---|---|
inViewPercentage
|
Es el porcentaje del área visible del anuncio.
|
serviceName
|
Nombre del servicio que activó el evento.
Heredado de
|
slot
|
El espacio que activó el evento
Heredado de
|
- Ejemplo
-
JavaScript
// This listener is called whenever the on-screen percentage of an // ad slot's area changes. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotVisibilityChanged", (event) => { const slot = event.slot; console.group("Visibility of slot", slot.getSlotElementId(), "changed."); // Log details of the event. console.log("Visible area:", `${event.inViewPercentage}%`); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (heredado)
// This listener is called whenever the on-screen percentage of an // ad slot's area changes. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotVisibilityChanged", function (event) { var slot = event.slot; console.group("Visibility of slot", slot.getSlotElementId(), "changed."); // Log details of the event. console.log("Visible area:", "".concat(event.inViewPercentage, "%")); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called whenever the on-screen percentage of an // ad slot's area changes. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotVisibilityChanged", (event) => { const slot = event.slot; console.group("Visibility of slot", slot.getSlotElementId(), "changed."); // Log details of the event. console.log("Visible area:", `${event.inViewPercentage}%`); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
- Consulta también
inViewPercentage
-
inViewPercentage: number
-
Es el porcentaje del área visible del anuncio. El valor es un número entre 0 y 100.
-
googletag.secureSignals.BidderSignalProvider
Devuelve un indicador seguro para un ofertante específico.
Un proveedor de indicadores seguros de ofertante consta de 2 partes:
- Una función de colector, que muestra un
Promise
que se resuelve en un indicador seguro. - Un
id
que identifica al ofertante asociado con el indicador
secureSignals.PublisherSignalProvider
en su lugar.
Resumen de la propiedad | |
---|---|
collectorFunction
|
.
|
id
|
Es un identificador único para el recopilador asociado con este indicador seguro, como se registra en Google Ad Manager.
|
- Ejemplo
-
JavaScript
// id is provided googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
JavaScript (heredado)
// id is provided googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: function () { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
TypeScript
// id is provided googletag.secureSignalProviders!.push({ id: "collector123", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
- Consulta también
collectorFunction
-
collectorFunction: () => Promise<string>
-
id
-
id: string
-
Es un identificador único para el recopilador asociado con este indicador seguro, como se registra en Google Ad Manager.
-
googletag.secureSignals.PublisherSignalProvider
Muestra un indicador seguro de un publicador específico.
Un proveedor de indicadores del publicador consta de 2 partes:
- Una función de colector, que muestra un
Promise
que se resuelve en un indicador seguro. - Es un
networkCode
que identifica el publicador asociado con el indicador.
secureSignals.BidderSignalProvider
en su lugar.
Resumen de la propiedad | |
---|---|
collectorFunction
|
.
|
networkCode
|
Es el código de red (como se ve en la ruta de la unidad de anuncios) del publicador asociado con este indicador seguro.
|
- Ejemplo
-
JavaScript
// networkCode is provided googletag.secureSignalProviders.push({ networkCode: "123456", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
JavaScript (heredado)
// networkCode is provided googletag.secureSignalProviders.push({ networkCode: "123456", collectorFunction: function () { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
TypeScript
// networkCode is provided googletag.secureSignalProviders!.push({ networkCode: "123456", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
- Consulta también
collectorFunction
-
collectorFunction: () => Promise<string>
-
networkCode
-
networkCode: string
-
Es el código de red (como se ve en la ruta de la unidad de anuncios) del publicador asociado con este indicador seguro.
-
googletag.secureSignals.SecureSignalProvidersArray
Una interfaz para administrar indicadores seguros.
Resumen de métodos | |
---|---|
clearAllCache
|
Borra todas las señales almacenadas en caché del almacenamiento local.
|
push
|
Agrega un
secureSignals.SecureSignalProvider nuevo al array del proveedor de indicadores y comienza el proceso de generación de indicadores.
|
clearAllCache
-
clearAllCache(): void
-
Borra todas las señales almacenadas en caché del almacenamiento local.
-
push
-
push(provider: SecureSignalProvider): void
-
Agrega un
secureSignals.SecureSignalProvider
nuevo al array del proveedor de indicadores y comienza el proceso de generación de indicadores. -
-
Parámetros provider: SecureSignalProvider
El objetosecureSignals.SecureSignalProvider
que se agregará al array.