Referencia de GPT

En esta referencia, se usa la notación de TypeScript para describir los tipos. En la siguiente tabla, se proporciona una explicación breve con un ejemplo.

Escribe una expresión
string	Es el tipo de cadena primitiva.
string[]	Un tipo de array, en el que los valores solo pueden ser cadenas.
number | string	Es un tipo de unión, en el que el valor puede ser un número o una cadena.
Array<number | string>	Es un tipo de array en el que los valores son de tipo complejo (unión).
[number, string]	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 ni valor de retorno.

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 indican una anotación de tipo. Las anotaciones de tipo describen los tipos que el elemento a la izquierda de los dos puntos puede aceptar o devolver. En la siguiente tabla, se muestran ejemplos de anotaciones de tipo que puedes ver en esta referencia.

Anotación de tipo
param: string	Indica que param acepta o devuelve un valor de cadena. Esta sintaxis se usa para variables, parámetros, propiedades y tipos de datos que se devuelven.
param?: number | string	Indica que param es opcional, pero acepta un número o una cadena cuando se especifica. Esta sintaxis se usa para parámetros y propiedades.
...params: Array<() => void>	Indica que params es un parámetro de REST que acepta funciones. Los parámetros de REST aceptan una cantidad ilimitada de valores del tipo especificado.

---

googletag

Es el espacio de nombres global que usa Google Publisher Tag para su API.

Espacios de nombres
config	Es la interfaz de configuración principal para los parámetros de configuración a nivel de la página.
enums	Este es el espacio de nombres que GPT usa para los tipos de enumeración.
events	Este es el espacio de nombres que usa GPT para los eventos.
secureSignals	Este es el espacio de nombres que usa GPT para administrar los indicadores seguros.

Interfaces
CommandArray	El array de comandos acepta una secuencia de funciones y las invoca en orden.
CompanionAdsService	Servicio de anuncios complementarios
PrivacySettingsConfig	Es el objeto de configuración para la configuración de privacidad.
PubAdsService	Servicio de anuncios del publicador
RequestHook	Es la función de devolución de llamada que se invoca antes de cada solicitud de anuncio cuando se registra a través de PubAdsService.registerRequestHook.
ResponseInformation	Es un objeto que representa una sola respuesta de anuncio.
RewardedPayload	Es un objeto que representa la recompensa asociada con un anuncio recompensado.
Service	Es la clase de servicio base que contiene métodos comunes para todos los servicios.
SizeMappingBuilder	Es un compilador para objetos de especificación de asignación de tamaño.
Slot	Slot es un objeto que representa un solo espacio publicitario en una página.

Alias de tipo
FluidSize	Es la cadena de tamaño en la que el contenedor de anuncios ocupa el 100% del ancho de su div superior y, luego, cambia su altura para que se ajuste al contenido de la creatividad.
GeneralSize	Es una configuración de tamaño válida para un espacio publicitario, que puede ser de uno o varios tamaños.
MultiSize	Es una lista de tamaños válidos individuales.
NamedSize	Son los tamaños con nombre que puede tener un espacio.
SingleSize	Es un solo tamaño válido para un espacio.
SingleSizeArray	Es un array de dos números que representan [ancho, alto].
SizeMapping	Es una asignación del tamaño del viewport a los tamaños de los anuncios.
SizeMappingArray	Es una lista de asignaciones de tamaño.

Variables
apiReady	Es una marca que indica que la API de GPT está cargada y lista para que se la llame.
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	Es la referencia al array de proveedores de indicadores seguros.

Funciones
companionAds	Muestra una referencia al CompanionAdsService.
defineOutOfPageSlot	Construye un espacio publicitario fuera de página con la ruta de acceso de la unidad de anuncios proporcionada.
defineSlot	Construye un espacio publicitario con una ruta de acceso y un tamaño de unidad de anuncios determinados, y lo asocia con el ID de un elemento div de la página que contendrá el anuncio.
destroySlots	Destruye los espacios determinados, lo que quita todos los objetos y las referencias relacionados de esos espacios de GPT.
disablePublisherConsole	Inhabilita la Consola para publicadores de Google.
display	Indica a los servicios de espacios publicitarios que rendericen el espacio.
enableServices	Habilita todos los servicios de GPT que se definieron para los espacios publicitarios de la página.
getConfig	Obtiene una copia inalterable de las opciones de configuración general de la página que se establecieron con setConfig.
getVersion	Devuelve la versión actual de GPT.
openConsole	Abre la Consola para publicadores de Google.
pubads	Devuelve una referencia al PubAdsService.
setAdIframeTitle	Establece el título de todos los iframes de contenedores de anuncios creados por PubAdsService a partir de este momento.
setConfig	Establece opciones de configuración general para la página.
sizeMapping	Crea un nuevo SizeMappingBuilder.

Alias de tipo

---

FluidSize

FluidSize: "fluid"

Es la cadena de tamaño en la que el contenedor de anuncios ocupa el 100% del ancho de su div superior y, luego, cambia su altura para que se ajuste al contenido de la creatividad. Es similar al comportamiento de los elementos de bloque normales de una página. Se usa para anuncios nativos y de banner (consulta el artículo relacionado).

---

GeneralSize

GeneralSize: SingleSize | MultiSize

Es una configuración de tamaño válida para un espacio publicitario, que puede ser de uno o varios tamaños.

---

MultiSize

MultiSize: SingleSize[]

Es una lista de tamaños válidos individuales.

---

NamedSize

NamedSize: FluidSize | [FluidSize]

Son los tamaños con nombre que puede tener un espacio. 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 con nombre válidos:

• fluid: El contenedor de anuncios ocupa el 100% del ancho de su div superior y, luego, cambia su altura para que se ajuste al contenido de la creatividad. Es similar al comportamiento de los elementos de bloque normales de una página. Se usa para anuncios nativos y de banner (consulta el artículo relacionado). Ten en cuenta que tanto fluid como ['fluid'] son formas aceptables de declarar un tamaño de espacio publicitario como flexible.

---

SingleSize

SingleSize: SingleSizeArray | NamedSize

Es un solo tamaño válido para un espacio.

---

SingleSizeArray

SingleSizeArray: [number, number]

Es un array de dos números que representan [ancho, alto].

---

SizeMapping

SizeMapping: [SingleSizeArray, GeneralSize]

Es una asignación del tamaño del viewport a los tamaños de los anuncios. Se utiliza para los anuncios responsivos.

---

SizeMappingArray

SizeMappingArray: SizeMapping[]

Es una lista de asignaciones de tamaño.

Variables

---

Const apiReady

apiReady: boolean | undefined

Es una marca que indica que la API de GPT está cargada y lista para que se la llame. Esta propiedad será simplemente undefined hasta que la API esté lista.

Ten en cuenta que la forma recomendada de controlar las operaciones asíncronas es usar googletag.cmd para poner en cola las devoluciones de llamada cuando GPT esté listo. Estas devoluciones de llamada no tienen que verificar googletag.apiReady, ya que se garantiza que se ejecutarán una vez que se configure la API.

---

Const cmd

cmd: ((this: typeof globalThis) => void)[] | CommandArray

Referencia a la cola de comandos global para la ejecución asíncrona de llamadas relacionadas con GPT.

La sintaxis de la etiqueta GPT en la página inicializa la variable googletag.cmd en un array de JavaScript vacío, y cmd.push es el método Array.push estándar que agrega un elemento al final del array. Cuando se carga el JavaScript de GPT, este busca en el array y ejecuta todas las funciones en orden. Luego, la secuencia de comandos reemplaza cmd por un objeto CommandArray cuyo método push se define para ejecutar el argumento de función que se le pasa. Este mecanismo permite que GPT reduzca la latencia percibida, ya que recupera el código JavaScript de forma asíncrona y, al mismo tiempo, permite que el navegador siga renderizando la página.

Ejemplo

JavaScript

googletag.cmd.push(() => {
  googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads());
});

TypeScript

googletag.cmd.push(() => {
  googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads());
});

---

Const pubadsReady

pubadsReady: boolean | undefined

Marca que indica que PubAdsService está habilitado, cargado y completamente operativo. Esta propiedad será simplemente undefined hasta que se llame a enableServices y se cargue e inicialice PubAdsService.

---

secureSignalProviders

secureSignalProviders: SecureSignalProvider[] | SecureSignalProvidersArray | undefined

Es una referencia al array de proveedores de indicadores seguros.

El array de proveedores de indicadores seguros acepta una secuencia de funciones de generación de indicadores y las invoca en orden. Su objetivo es reemplazar un array estándar que se usa para poner en cola las funciones que generan indicadores y que se invocarán una vez que se carguen las GPT.

Ejemplo

JavaScript

window.googletag = window.googletag || { cmd: [] };
googletag.secureSignalProviders = googletag.secureSignalProviders || [];
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: () => {
    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

• Cómo compartir indicadores seguros con los ofertantes

Funciones

---

companionAds

companionAds(): CompanionAdsService

Muestra una referencia al CompanionAdsService.

Muestra
CompanionAdsService	Es el servicio de anuncios complementarios.

---

defineOutOfPageSlot

defineOutOfPageSlot(adUnitPath: string, div?: string | OutOfPageFormat): Slot | null

Construye un espacio publicitario fuera de página con la ruta de unidad de anuncios proporcionada.

En el caso de los anuncios personalizados fuera de página, div es el ID del elemento div que contendrá el anuncio. Para obtener más detalles, consulta el artículo sobre creatividades fuera de página.

En el caso de los anuncios fuera de página administrados por GPT, div es un 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);

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

• Muestra un anuncio recompensado
• Muestra un anuncio intersticial para la Web
• Muestra un anuncio fijo
• Muestra un anuncio fuera de página

Parámetros
adUnitPath: string	La ruta de la unidad de anuncios completa con el código de red y el código de la unidad de anuncios.
Optional div: string | OutOfPageFormat	Es el ID del div que contendrá esta unidad de anuncios o OutOfPageFormat.

Muestra
Slot | null	Es el espacio recién creado o null si no se puede crear un espacio.

---

defineSlot

defineSlot(adUnitPath: string, size: GeneralSize, div?: string): Slot | null

Construye un espacio publicitario con una ruta de acceso y un tamaño de unidad de anuncios determinados, y lo asocia con el ID de un elemento div de la página que contendrá el anuncio.

Ejemplo

JavaScript

googletag.defineSlot("/1234567/sports", [728, 90], "div-1");

TypeScript

googletag.defineSlot("/1234567/sports", [728, 90], "div-1");

Consulta también

• Comienza a usar Google Publisher Tags

Parámetros
adUnitPath: string	La ruta de la unidad de anuncios completa con el código de red y el código de la unidad
size: GeneralSize	Ancho y altura del espacio publicitario agregado. Este es el tamaño que se usa en la solicitud de anuncio si no se proporciona una asignación de tamaño responsivo o si el tamaño del viewport es menor que el tamaño más pequeño proporcionado en la asignación.
Optional div: string	Es el ID del div que contendrá esta unidad de anuncios.

Muestra
Slot | null	Es el espacio recién creado o null si no se puede crear un espacio.

---

destroySlots

destroySlots(slots?: Slot[]): boolean

Destruye los espacios determinados, lo que quita todos los objetos y las referencias relacionados de esos espacios de GPT. Esta API no admite espacios de devolución ni espacios complementarios.

Cuando se llama a esta API en un espacio, se borra el anuncio y se quita el objeto de espacio del estado interno que mantiene GPT. Si se llama a más funciones en el objeto de espacio, se producirá 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 él. Cuando se llama a esta API, el div asociado con ese espacio queda disponible para su reutilización.

En particular, cuando se destruye un espacio, se quita el anuncio de la vista de página de larga duración de GPT, por lo que las solicitudes futuras no se verán afectadas por anuncios de bloqueo de página ni exclusiones competitivas que involucren este anuncio. Si no se llama a esta función antes de quitar el div de un espacio de la página, se producirá 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();

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
Optional slots: Slot[]	Es el array de espacios que se destruirán. El array es opcional; se destruirán todos los espacios si no se especifica.

Muestra
boolean	true si se destruyeron los espacios; de lo contrario, false.

---

disablePublisherConsole

disablePublisherConsole(): void

Inhabilita la Consola para publicadores de Google.

Consulta también

• Consola para publicadores de Google

---

pantalla

display(divOrSlot: string | Element | Slot): void

Indica a los servicios de espacios publicitarios que rendericen el espacio. Cada espacio publicitario solo debe mostrarse una vez por página. Todos los espacios deben estar definidos y tener un servicio asociado antes de que se muestren. La llamada de visualización no debe realizarse hasta que el elemento esté presente en el DOM. La forma habitual de lograrlo es colocarlo dentro de un bloque de secuencia de comandos en el elemento div que se nombra en la llamada de método.

Si se usa la arquitectura de solicitud única (SRA), todos los espacios publicitarios que no se hayan recuperado en el momento en que se llame a este método se recuperarán a la vez. Para forzar que no se muestre un espacio publicitario, se debe quitar todo el div.

Consulta también

• Comienza a usar Google Publisher Tags
• Muestra un anuncio de prueba
• Controla la carga y la actualización de anuncios

Parámetros
divOrSlot: string | Element | Slot	Es el ID del elemento div que contiene el espacio publicitario, el elemento div o el objeto de espacio. Si se proporciona un elemento div, debe tener un atributo "id" que coincida con el ID que se pasa a defineSlot.

---

enableServices

enableServices(): void

Habilita todos los servicios de GPT que se definieron para los espacios publicitarios de la página.

---

getConfig

getConfig(keys: string | string[]): Readonly<Pick<PageSettingsConfig, "adsenseAttributes" | "disableInitialLoad" | "targeting">>

Obtiene una copia inalterable de las opciones de configuración general de la página que se establecieron con setConfig.

Este método no admite todas las propiedades de setConfig(). Las propiedades admitidas son las siguientes:

• adsenseAttributes
• disableInitialLoad
• targeting

Ejemplo

JavaScript

// Get the value of the `targeting` setting.
const targetingConfig = googletag.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `disableInitialLoad` settings.
const config = googletag.getConfig(["adsenseAttributes", "disableInitialLoad"]);

TypeScript

// Get the value of the `targeting` setting.
const targetingConfig = googletag.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `disableInitialLoad` settings.
const config = googletag.getConfig(["adsenseAttributes", "disableInitialLoad"]);

Parámetros
keys: string | string[]	Son las claves de las opciones de configuración que se deben obtener.

Muestra
Readonly<Pick<PageSettingsConfig, "adsenseAttributes" | "disableInitialLoad" | "targeting">>	Es una copia inmutable de las opciones de configuración de la página.

---

getVersion

getVersion(): string

Devuelve la versión actual de GPT.

Consulta también

• Historial de versiones de GPT

Muestra
string	Es la cadena de la versión de GPT que se está ejecutando actualmente.

---

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();

TypeScript

// Calling with div ID.
googletag.openConsole("div-1");

// Calling without div ID.
googletag.openConsole();

Consulta también

• Consola para publicadores de Google

Parámetros
Optional div: string	Es el ID de div de un espacio publicitario. Este valor es opcional. Cuando se proporcione, la Consola para publicadores intentará abrirse con los detalles del espacio publicitario especificado a la vista.

---

pubads

pubads(): PubAdsService

Devuelve una referencia al PubAdsService.

Muestra
PubAdsService	Es el servicio de anuncios del publicador.

---

setAdIframeTitle

setAdIframeTitle(title: string): void

Establece el título de todos los iframes de contenedores de anuncios creados por PubAdsService, a partir de este punto.

Ejemplo

JavaScript

googletag.setAdIframeTitle("title");

TypeScript

googletag.setAdIframeTitle("title");

Parámetros
title: string	Es el título nuevo para todos los iframes de contenedores de anuncios.

---

setConfig

setConfig(config: PageSettingsConfig): void

Establece opciones de configuración general para la página.

Parámetros
config: PageSettingsConfig

---

sizeMapping

sizeMapping(): SizeMappingBuilder

Crea un nuevo SizeMappingBuilder.

Consulta también

• Tamaños de los anuncios: Anuncios responsivos

Muestra
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 las funciones que se invocarán una vez que se cargue GPT.

Métodos
push	Ejecuta la secuencia de funciones especificadas en los argumentos en orden.

Métodos

---

push

push(...f: ((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());
});

TypeScript

googletag.cmd.push(() => {
  googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads());
});

Parámetros
Rest ...f: ((this: typeof globalThis) => void)[]	Es una 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 valor this del contexto léxico adjunto.

Muestra
number	Es la cantidad de comandos procesados hasta el momento. Esto es compatible con el valor que muestra Array.push (la longitud actual del array).

---

googletag.CompanionAdsService

Extiende Service

Servicio de anuncios complementarios Los anuncios de video utilizan este servicio para mostrar anuncios complementarios.

Métodos
addEventListener	Registra un objeto de escucha que te permite configurar y llamar a una función de JavaScript cuando se produce un evento de GPT específico en la página. Heredado del método Service.addEventListener
getSlots	Obtén la lista de horarios disponibles asociados con este servicio. Heredado del método Service.getSlots
removeEventListener	Quita un objeto de escucha registrado anteriormente. Heredado del método Service.removeEventListener
setRefreshUnfilledSlots	Establece si los espacios publicitarios complementarios que no se completaron se reabastecerán automáticamente.

Consulta también

• Anuncios complementarios para reproductores de audio y video

Métodos

---

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 en PubAdsService. Debido a restricciones de políticas, este método no está diseñado para rellenar espacios complementarios vacíos cuando se publica un video de Ad Exchange.

Ejemplo

JavaScript

googletag.companionAds().setRefreshUnfilledSlots(true);

TypeScript

googletag.companionAds().setRefreshUnfilledSlots(true);

Parámetros
value: boolean	true para rellenar automáticamente los espacios sin rellenar, false para dejarlos sin cambios.

---

googletag.PrivacySettingsConfig

Es el objeto de configuración para la configuración de privacidad.

Propiedades
childDirectedTreatment?	Indica si la página se debe tratar como dirigida a niños.
limitedAds?	Habilita la publicación para que se ejecute en el modo de anuncios limitados para ayudar a satisfacer las necesidades de cumplimiento de reglamentaciones de los publicadores.
nonPersonalizedAds?	Permite que la publicación se ejecute en el modo de anuncios no personalizados para ayudar a satisfacer las necesidades de cumplimiento de reglamentaciones de los publicadores.
restrictDataProcessing?	Habilita la publicación para que se ejecute en el modo de procesamiento restringido para ayudar a los publicadores a cumplir con las reglamentaciones.
tagForAgeTreatment?	Es el tratamiento de contenido restringido por edad, que indica si la solicitud de anuncio se debe tratar como contenido para niños, para adolescentes o no especificado.
trafficSource?	Indica si las solicitudes representan tráfico comprado u orgánico.
underAgeOfConsent?	Indica si se deben marcar las solicitudes de anuncios como provenientes de usuarios que no alcanzan la edad de consentimiento.

Consulta también

• Establece la configuración de privacidad

Propiedades

---

Optional childDirectedTreatment

childDirectedTreatment?: boolean

Indica si la página se debe tratar como dirigida a niños. Establécelo en null para borrar la configuración.

---

Optional limitedAds

limitedAds?: boolean

Habilita la publicación para que se ejecute en el modo de anuncios limitados para ayudar con las necesidades de cumplimiento de reglamentaciones del publicador.

Puedes indicar a GPT que solicite anuncios limitados de dos maneras:

• Automáticamente, mediante un indicador de una plataforma de administración de consentimiento del MTC v2.0 de IAB
• De forma manual, estableciendo el valor de este campo en true.

Solo se pueden configurar manualmente los anuncios limitados cuando se carga GPT desde la URL de anuncios limitados. Si intentas modificar este parámetro de configuración cuando se cargó GPT desde la URL estándar, se generará una advertencia de la Consola para publicadores.

Ten en cuenta que no es necesario habilitar manualmente los anuncios limitados cuando se usa una CMP.

Ejemplo

JavaScript

// Manually enable limited ads serving.
// GPT must be loaded from the limited ads URL to configure this setting.
googletag.pubads().setPrivacySettings({
  limitedAds: true,
});

TypeScript

// Manually enable limited ads serving.
// GPT must be loaded from the limited ads URL to configure this setting.
googletag.pubads().setPrivacySettings({
  limitedAds: true,
});

Consulta también

• Cómo mostrar un anuncio limitado

---

Optional nonPersonalizedAds

nonPersonalizedAds?: boolean

Permite que la publicación se ejecute en el modo de anuncios no personalizados para ayudar a satisfacer las necesidades de cumplimiento de reglamentaciones de los publicadores.

---

Optional restrictDataProcessing

restrictDataProcessing?: boolean

Habilita la publicación para que se ejecute en el modo de procesamiento restringido para ayudar a los publicadores a cumplir con las reglamentaciones.

---

Optional tagForAgeTreatment

tagForAgeTreatment?: TagForAgeTreatment

El tratamiento de contenido restringido por edad, que indica si la solicitud de anuncio se debe tratar como contenido para niños, adolescentes o no especificado.

Consulta a tu asesor legal para determinar la configuración de tratamiento de contenido según la edad para tus usuarios en función de tus requisitos legales y reglamentarios. Para obtener más información sobre este parámetro de configuración, consulta este artículo del Centro de ayuda.

Al establecer esta propiedad, certificas que esta notificación es precisa y que tienes autorización para actuar en nombre del propietario del sitio. Que comprendes que el abuso de este parámetro de configuración puede provocar el cierre de tu Cuenta de Google

Ejemplo

JavaScript

// Enable teen privacy treatment.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.TEEN,
});

// Clear age treatment configuration.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.UNSPECIFIED,
});

TypeScript

// Enable teen privacy treatment.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.TEEN,
});

// Clear age treatment configuration.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.UNSPECIFIED,
});

---

Optional trafficSource

trafficSource?: TrafficSource

Indica si las solicitudes representan tráfico comprado u orgánico. Este valor propaga la dimensión Fuente de tráfico en los informes de Ad Manager. Si no se establece, la fuente de tráfico se establece 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,
});

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,
});

---

Optional underAgeOfConsent

underAgeOfConsent?: boolean

Indica si se deben marcar las solicitudes de anuncios como provenientes de usuarios que no alcanzan la edad de consentimiento. Establécelo en null para borrar la configuración.

---

googletag.PubAdsService

Extiende Service

Servicio de anuncios del publicador Este servicio se usa para recuperar y mostrar anuncios de tu cuenta de Google Ad Manager.

Métodos
addEventListener	Registra un objeto de escucha que te permite configurar y llamar a una función de JavaScript cuando se produce un evento de GPT específico en la página. Heredado del método Service.addEventListener
clear	Quita los anuncios de los espacios determinados y los reemplaza por contenido en blanco.
clearCategoryExclusions	Obsoleto. Borra todas las etiquetas de exclusión de categorías de anuncios a nivel de la página.
clearTargeting	Obsoleto. Borra los parámetros de segmentación personalizada de una clave específica o de todas las claves.
collapseEmptyDivs	Obsoleto. Habilita la contracción de los divs de espacios publicitarios para que no ocupen espacio en la página cuando no haya contenido del anuncio para mostrar.
disableInitialLoad	Obsoleto. 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 de la unidad de anuncios proporcionados.
enableLazyLoad	Obsoleto. Habilita la carga diferida en GPT según lo define el objeto de configuración.
enableSingleRequest	Obsoleto. Habilita el modo de solicitud única para recuperar varios anuncios al mismo tiempo.
enableVideoAds	Obsoleto. Indica a GPT que habrá anuncios de video en la página.
get	Obsoleto. Devuelve el valor del atributo de AdSense asociado con la clave determinada.
getAttributeKeys	Obsoleto. Devuelve las claves de atributo que se configuraron en este servicio.
getSlots	Obtén la lista de horarios disponibles asociados con este servicio. Heredado del método Service.getSlots
getTargeting	Obsoleto. Devuelve un parámetro de segmentación de nivel de servicio personalizado específico que se haya establecido.
getTargetingKeys	Obsoleto. Devuelve la lista de todas las claves de segmentación personalizadas a nivel del servicio que se establecieron.
isInitialLoadDisabled	Obsoleto. PubAdsService.disableInitialLoad
refresh	Recupera y muestra anuncios nuevos para espacios específicos o todos los espacios de la página.
registerRequestHook	Registra un hook que se ejecutará en paralelo con otros hooks registrados antes de cada solicitud de anuncio en la página dentro de un tiempo de espera global.
removeEventListener	Quita un objeto de escucha registrado anteriormente. Heredado del método Service.removeEventListener
set	Obsoleto. Establece valores para los atributos de AdSense que se aplican a todos los espacios publicitarios del servicio de anuncios del publicador.
setCategoryExclusion	Obsoleto. Establece una exclusión de categoría de anuncio a nivel de la página para el nombre de etiqueta proporcionado.
setCentering	Obsoleto. Habilita o inhabilita el centrado horizontal de los anuncios.
setForceSafeFrame	Obsoleto. Configura si se debe forzar la renderización de todos los anuncios de la página con un contenedor de SafeFrame.
setLocation	Obsoleto. 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 configurar toda la configuración de privacidad desde una sola API con un objeto de configuración.
setPublisherProvidedId	Establece el valor del ID proporcionado por el publicador.
setSafeFrameConfig	Obsoleto. Establece las preferencias a nivel de la página para la configuración de SafeFrame.
setTargeting	Obsoleto. Establece parámetros de segmentación personalizada para una clave determinada que se aplican a todos los espacios publicitarios del servicio de anuncios de publicador.
setVideoContent	Obsoleto. Establece la información del contenido de video que se enviará junto con las solicitudes de anuncios para la segmentación y la exclusión de contenido.
updateCorrelator	Cambia el correlator que se envía con las solicitudes de anuncios, lo que inicia de manera efectiva una nueva vista de página.

Métodos

---

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, borrar un espacio quita el anuncio de la vista de página de larga duración de GPT, por lo que las solicitudes futuras no se verán influenciadas por anuncios de roadblock ni exclusiones de la competencia 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();

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
Optional slots: Slot[]	Es el array de espacios que se borrarán. El array es opcional; se borrarán todos los espacios si no se especifica.

Muestra
boolean	Devuelve true si se borraron los espacios; de lo contrario, devuelve false.

---

clearCategoryExclusions

clearCategoryExclusions(): PubAdsService

Borra todas las etiquetas de exclusión de categorías de anuncios a nivel de la página. Esto resulta útil si deseas actualizar el espacio publicitario.

Obsoleto: En su lugar, usa PageSettingsConfig.categoryExclusion.

Ejemplo

JavaScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.setConfig({
  categoryExclusion: ["AirlineAd"],
});

// Make ad requests. No ad with 'AirlineAd' label will be returned.

// Clear category exclusions so all ads can be returned.
googletag.setConfig({
  categoryExclusion: null,
});

// Make ad requests. Any ad can be returned.

TypeScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.setConfig({
  categoryExclusion: ["AirlineAd"],
});

// Make ad requests. No ad with 'AirlineAd' label will be returned.

// Clear category exclusions so all ads can be returned.
googletag.setConfig({
  categoryExclusion: null,
});

// Make ad requests. Any ad can be returned.

Consulta también

• Etiquetas personalizadas para bloquear anuncios

Muestra
PubAdsService	Es 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 para una clave específica o para todas las claves.

Obsoleto: Usa PageSettingsConfig.targeting en su lugar.

Ejemplo

JavaScript

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
    fruits: "apple",
  },
});

googletag.setConfig({
  targeting: {
    interests: null,
  },
});
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.setConfig({
  targeting: null,
});
// All targeting has been cleared.

TypeScript

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
    fruits: "apple",
  },
});

googletag.setConfig({
  targeting: {
    interests: null,
  },
});
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.setConfig({
  targeting: null,
});
// All targeting has been cleared.

Consulta también

• Segmentación por pares clave-valor

Parámetros
Optional key: string	Es la clave del parámetro de segmentación. La clave es opcional; se borrarán todos los parámetros de segmentación si no se especifica.

Muestra
PubAdsService	Es el objeto de servicio en el que se llamó al método.

---

collapseEmptyDivs

collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean

Habilita la contracción de los divs de espacios publicitarios para que no ocupen espacio en la página cuando no haya contenido del anuncio para mostrar. Este modo se debe configurar antes de que se habilite el servicio.

Obsoleto: En su lugar, usa PageSettingsConfig.collapseDiv.

Consulta también

• Contraer espacios publicitarios vacíos
• Minimiza el cambio de diseño

Parámetros
Optional collapseBeforeAdFetch: boolean	Indica si se deben contraer los espacios publicitarios incluso antes de que se recuperen los anuncios. Este parámetro es opcional. Si no se proporciona, se usará false como valor predeterminado.

Muestra
boolean	Devuelve true si se habilitó el modo de contracción de div y false si no es posible habilitar el modo de contracción porque se llamó al método después de que se habilitó el servicio.

---

disableInitialLoad

disableInitialLoad(): void

Inhabilita las solicitudes de anuncios durante la carga de la página, pero permite que se soliciten anuncios con una llamada a PubAdsService.refresh. Esto se debe configurar antes de habilitar el servicio. Se debe usar el modo asíncrono; de lo contrario, será imposible solicitar anuncios con refresh.

Obsoleto: Usa PageSettingsConfig.disableInitialLoad en su lugar.

Consulta también

• Controla la carga y la actualización de anuncios
• Controla el procesamiento por lotes de la SRA

---

pantalla

display(adUnitPath: string, size: GeneralSize, div?: string | Element, clickUrl?: string): void

Crea y muestra un espacio publicitario con la ruta y el tamaño de la unidad de anuncios proporcionados.

Este método es una forma abreviada de llamar a googletag.defineSlot seguido inmediatamente por googletag.display.

El comportamiento de este método depende de si la arquitectura de solicitud única (SRA) está habilitada:

• SRA habilitada: Todos los espacios publicitarios definidos hasta el momento de esta llamada se agruparán y solicitarán juntos.
• SRA inhabilitada (predeterminada): El espacio publicitario se solicitará de forma individual.

Nota: Cuando se llama a este método, se crea una instantánea del espacio y del 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 espacio o en el estado de la página después de que se llame a este método (incluidos la segmentación, la configuración de privacidad, el uso forzado de SafeFrame, etc.) solo se aplicará a las solicitudes de display() o refresh() posteriores.

Ejemplo

JavaScript

googletag.pubads().display("/1234567/sports", [728, 90], "div-1");

TypeScript

googletag.pubads().display("/1234567/sports", [728, 90], "div-1");

Consulta también

• Muestra un anuncio de prueba
• Controla la carga y la actualización de anuncios

Parámetros
adUnitPath: string	Es la ruta de acceso de la unidad de anuncios del espacio que se renderizará.
size: GeneralSize	Ancho y alto del espacio publicitario.
Optional div: string | Element	Es el ID del div que contiene el espacio o el elemento div en sí.
Optional clickUrl: string	Es la URL de clic que se usará en este espacio.

---

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 ver ejemplos más detallados, consulta el ejemplo de carga diferida.

Nota: La recuperación diferida en la SRA solo funciona si todos los espacios están fuera del margen de recuperación.

Obsoleto: Usa PageSettingsConfig.lazyLoad en su lugar.

Ejemplo

JavaScript

googletag.setConfig({
  lazyLoad: {
    // 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.setConfig({
  lazyLoad: {
    // 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

• Prácticas recomendadas para los anuncios: Prioriza los espacios publicitarios "importantes"
• Carga diferida

Parámetros

Optional config: {   fetchMarginPercent?: number;   mobileScaling?: number;   renderMarginPercent?: number; }

El objeto de configuración permite personalizar el comportamiento diferido. Cualquier configuración que se omita usará un valor predeterminado establecido por 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 Es la distancia mínima que debe haber entre un espacio publicitario y el viewport actual antes de que recuperemos el anuncio, expresada como un porcentaje del tamaño del viewport. Un valor de 0 significa "cuando el espacio ingresa al viewport", 100 significa "cuando el anuncio está a 1 viewport de distancia", y así sucesivamente. renderMarginPercent Es la distancia mínima que debe haber entre un espacio publicitario y el viewport actual antes de que rendericemos un anuncio. Esto permite recuperar previamente el anuncio, pero esperar para renderizar y descargar otros recursos secundarios. El valor funciona igual que fetchMarginPercent como un porcentaje del viewport. mobileScaling Es un multiplicador que se aplica a los márgenes en dispositivos móviles. Esto permite que los márgenes varíen en dispositivos móviles y 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 publicitarios de Publisher Ads se definan y agreguen al PubAdsService antes de habilitar el servicio. El modo de solicitud única se debe configurar antes de que se habilite el servicio.

Obsoleto: En su lugar, usa PageSettingsConfig.singleRequest.

Consulta también

• Prácticas recomendadas para los anuncios: Usa correctamente la arquitectura de solicitud única
• Controla el procesamiento por lotes de la SRA

Muestra
boolean	Devuelve true si se habilitó el modo de solicitud única y false si no es posible habilitarlo porque se llamó al método después de que se habilitó el servicio.

---

enableVideoAds

enableVideoAds(): void

Indica a GPT que habrá anuncios de video en la página. Esto habilita las 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.

Obsoleto: En su lugar, usa PageSettingsConfig.videoAds.

---

get

get(key: string): string

Devuelve el valor del atributo de AdSense asociado con la clave proporcionada.

Obsoleto: En su lugar, usa googletag.getConfig.

Ejemplo

JavaScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});

const adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
const pageUrl = adsenseConfig?.page_url || null;
// Returns 'http://www.example.com'.

TypeScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});

const adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
const pageUrl = adsenseConfig?.page_url || null;
// Returns 'http://www.example.com'.

Consulta también

• Atributos de AdSense

Parámetros
key: string	Es el nombre del atributo que se buscará.

Muestra
string	Es el valor actual de la clave de atributo o null si la clave no está presente.

---

getAttributeKeys

getAttributeKeys(): string[]

Muestra las claves de atributos que se configuraron en este servicio.

Obsoleto: En su lugar, usa googletag.getConfig.

Ejemplo

JavaScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
    document_language: "en",
  },
});

const adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
const adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].

TypeScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
    document_language: "en",
  },
});

const adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
const adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].

Muestra
string[]	Es un array de claves de atributos establecidas en este servicio. El orden no está definido.

---

getTargeting

getTargeting(key: string): string[]

Muestra un parámetro de segmentación personalizado específico a nivel del servicio que se haya establecido.

Obsoleto: En su lugar, usa googletag.getConfig.

Ejemplo

JavaScript

googletag.setConfig({
  targeting: {
    interests: "sports",
  },
});

const targetingConfig = googletag.getConfig("targeting").targeting;

// Get targeting for a specific key.
const targeting = targetingConfig?.["interests"] || [];
// Returns ['sports'].

const ageTargeting = targetingConfig?.["age"] || [];
// Returns [] (empty array).

TypeScript

googletag.setConfig({
  targeting: {
    interests: "sports",
  },
});

const targetingConfig = googletag.getConfig("targeting").targeting;

// Get targeting for a specific key.
const targeting = targetingConfig?.["interests"] || [];
// Returns ['sports'].

const ageTargeting = targetingConfig?.["age"] || [];
// Returns [] (empty array).

Parámetros
key: string	Es la clave de segmentación que se debe buscar.

Muestra
string[]	Son 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 del servicio que se configuraron.

Obsoleto: En su lugar, usa googletag.getConfig.

Ejemplo

JavaScript

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
  },
});

const targetingConfig = googletag.getConfig("targeting").targeting;
const keys = Object.keys(targetingConfig || {});
// Returns ['interests', 'colors'].

TypeScript

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
  },
});

const targetingConfig = googletag.getConfig("targeting").targeting;
const keys = Object.keys(targetingConfig || {});
// Returns ['interests', 'colors'].

Muestra
string[]	Es un array de claves de segmentación. El orden no está definido.

---

isInitialLoadDisabled

isInitialLoadDisabled(): boolean

Muestra si las solicitudes iniciales de anuncios se inhabilitaron correctamente con una llamada anterior a PubAdsService.disableInitialLoad.

Obsoleto: En su lugar, usa googletag.getConfig.

Muestra
boolean	Devuelve true si una llamada anterior a PubAdsService.disableInitialLoad se realizó correctamente; de lo contrario, devuelve false.

---

refresh

refresh(slots?: Slot[], options?: {
  changeCorrelator: boolean;
}): void

Recupera y muestra anuncios nuevos para espacios específicos o todos los espacios de la página. Solo funciona en el modo de renderización asíncrona.

Para que el comportamiento sea correcto en todos los navegadores, se debe llamar a refresh después de llamar a display para el espacio publicitario. Si se omite la llamada a display, es posible que la actualización se comporte de forma inesperada. Si lo deseas, puedes usar el método PubAdsService.disableInitialLoad para evitar que display recupere un anuncio.

Cuando se actualiza un espacio, se quita el anuncio anterior de la vista de página de larga duración de GPT, por lo que las solicitudes futuras no se verán afectadas por las publicaciones simultáneas garantizadas ni las exclusiones competitivas que involucren 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 });

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

• Controla la carga y la actualización de anuncios
• Actualiza los espacios publicitarios

Parámetros
Optional slots: Slot[]	Son los espacios que se actualizarán. El array es opcional; se actualizarán todos los espacios si no se especifica.
Optional options: {   changeCorrelator: boolean; }	Son las opciones de configuración asociadas con esta llamada de actualización. changeCorrelator Especifica si se debe generar o no un correlacionador nuevo para recuperar anuncios. Nuestros servidores de anuncios mantienen este valor de correlator por un período breve (actualmente, durante 30 segundos, pero está sujeto a cambios), de modo que las solicitudes con el mismo correlator que se reciban en un intervalo corto se considerarán como una sola vista de página. De forma predeterminada, se genera un correlacionador nuevo para cada actualización. Nota: Esta opción no tiene ningún efecto en la vista de página de larga duración de GPT, que refleja automáticamente los anuncios que se encuentran en la página y no tiene fecha de vencimiento.

---

registerRequestHook

registerRequestHook(hook: RequestHook, hookId: string): (() => void)

Experimental Registra un hook que se ejecutará en paralelo con otros hooks registrados antes de cada solicitud de anuncio en la página dentro de un tiempo de espera global.

Ejemplo

JavaScript

// Register a request hook.
const unregister = googletag.pubads().registerRequestHook(async ({ slots }) => {
  const someAsynchronousAction = Promise.resolve();
  await someAsynchronousAction;
  for (const slot of slots) {
    slot.setConfig({ targeting: { hookApplied: "true" } });
  }
}, "my-hook");

// Unregister the hook.
unregister();

TypeScript

// Register a request hook.
const unregister = googletag.pubads().registerRequestHook(async ({ slots }) => {
  const someAsynchronousAction = Promise.resolve();
  await someAsynchronousAction;
  for (const slot of slots) {
    slot.setConfig({ targeting: { hookApplied: "true" } });
  }
}, "my-hook");

// Unregister the hook.
unregister();

Parámetros
hook: RequestHook	Es una función que toma un objeto que contiene la lista de espacios solicitados y devuelve una promesa que se resuelve una vez que se completan todas las acciones asíncronas.
hookId: string	Un ID para etiquetar el hook y mejorar el diagnóstico.

Muestra
(() => void)	Una función para cancelar el registro del hook.

---

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 a este método más de una vez para la misma clave, se anularán los valores establecidos anteriormente para esa clave. Todos los valores se deben establecer antes de llamar a display o refresh.

Obsoleto: En su lugar, usa PageSettingsConfig.adsenseAttributes.

Ejemplo

JavaScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});

TypeScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});

Consulta también

• Atributos de AdSense

Parámetros
key: string	Es el nombre del atributo.
value: string	Valor del atributo.

Muestra
PubAdsService	Es 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 etiqueta proporcionado.

Obsoleto: En su lugar, usa PageSettingsConfig.categoryExclusion.

Ejemplo

JavaScript

// Label = AirlineAd.
googletag.setConfig({
  categoryExclusion: ["AirlineAd"],
});

TypeScript

// Label = AirlineAd.
googletag.setConfig({
  categoryExclusion: ["AirlineAd"],
});

Consulta también

• Etiquetas personalizadas para bloquear anuncios

Parámetros
categoryExclusion: string	Es la etiqueta de exclusión de categoría de anuncio que se agregará.

Muestra
PubAdsService	Es el objeto de servicio en el que se llamó al método.

---

setCentering

setCentering(centerAds: boolean): void

Habilita o inhabilita el centrado horizontal de los anuncios. El centrado está inhabilitado de forma predeterminada. En el archivo gpt_mobile.js heredado, el centrado está habilitado de forma predeterminada.

Se debe invocar este método antes de llamar a display o refresh, ya que solo se centrarán los anuncios que se soliciten después de llamar a este método.

Obsoleto: Usa PageSettingsConfig.centering en su lugar.

Ejemplo

JavaScript

// Make ads centered.
googletag.setConfig({
  centering: true,
});

TypeScript

// Make ads centered.
googletag.setConfig({
  centering: true,
});

Parámetros
centerAds: boolean	true para centrar los anuncios y false para alinearlos a la izquierda.

---

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): PubAdsService

Configura si se debe forzar la renderización de todos los anuncios de la página 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 que se realicen para los espacios respectivos.
• Si se especifica, el parámetro de configuración a nivel del espacio publicitario siempre anulará el parámetro de configuración a nivel de la 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 en false o se deja sin especificar, el anuncio se renderizará con un contenedor de SafeFrame según el tipo de creatividad y la selección realizada en la IU de Google Ad Manager.
• Esta API se debe utilizar con precaución, ya que podría afectar el comportamiento de las creatividades que intentan salir de sus iFrames o que dependen de que se rendericen directamente en la página de un publicador.

Obsoleto: Usa PageSettingsConfig.safeFrame en su lugar.

Ejemplo

JavaScript

googletag.setConfig({
  safeFrame: {
    forceSafeFrame: true,
  },
});

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    safeFrame: {
      forceSafeFrame: 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.setConfig({
  safeFrame: {
    forceSafeFrame: true,
  },
});

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setConfig({
    safeFrame: {
      forceSafeFrame: 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

• Renderiza creatividades con SafeFrame

Parámetros
forceSafeFrame: boolean	true para forzar que todos los anuncios de la página se rendericen en SafeFrames y false para cambiar el parámetro de configuración anterior a falso. Si estableces este valor en false cuando no se especificó antes, no cambiará nada.

Muestra
PubAdsService	Es el objeto de servicio en el que se llamó al método.

---

setLocation

setLocation(address: string): PubAdsService

Pasa información de ubicación de los sitios web para que puedas segmentar geográficamente las líneas de pedido para ubicaciones específicas.

Obsoleto: En su lugar, usa PageSettingsConfig.location.

Ejemplo

JavaScript

// Postal code:
googletag.setConfig({
  location: "10001,US",
});

TypeScript

// Postal code:
googletag.setConfig({
  location: "10001,US",
});

Parámetros
address: string	Dirección en formato libre.

Muestra
PubAdsService	Es el objeto de servicio en el que se llamó al método.

---

setPrivacySettings

setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService

Permite configurar todos los parámetros de privacidad desde una sola API con 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,
});

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

• Establece la configuración de privacidad
• Cómo mostrar un anuncio limitado

Parámetros
privacySettings: PrivacySettingsConfig	Es el objeto que contiene la configuración de privacidad.

Muestra
PubAdsService	Es 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 publicador.

Ejemplo

JavaScript

googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");

TypeScript

googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");

Consulta también

• Acerca de los identificadores proporcionados por el publicador

Parámetros
ppid: string	Es un ID alfanumérico proporcionado por el publicador. Debe tener entre 22 y 150 caracteres.

Muestra
PubAdsService	Es 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.

Estas preferencias a nivel de la página se anularán con las preferencias a nivel del espacio publicitario, si se especifican.

Obsoleto: Usa PageSettingsConfig.safeFrame en su lugar.

Ejemplo

JavaScript

googletag.setConfig({
  safeFrame: {
    forceSafeFrame: true,
    allowOverlayExpansion: true,
    allowPushExpansion: true,
    sandbox: true,
  },
});

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    safeFrame: {
      allowOverlayExpansion: false,
    },
  })
  .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.setConfig({
  safeFrame: {
    forceSafeFrame: true,
    allowOverlayExpansion: true,
    allowPushExpansion: true,
    sandbox: true,
  },
});

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setConfig({
    safeFrame: {
      allowOverlayExpansion: false,
    },
  })
  .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

• Renderiza creatividades con SafeFrame

Parámetros
config: SafeFrameConfig	Es el objeto de configuración.

Muestra
PubAdsService	Es 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 personalizada para una clave determinada que se aplican a todos los espacios publicitarios del servicio de anuncios del publicador. Si llamas a este método varias veces para la misma clave, se reemplazarán los valores anteriores. Estas claves se definen en tu cuenta de Google Ad Manager.

Obsoleto: En su lugar, usa PageSettingsConfig.targeting.

Ejemplo

JavaScript

// Example with a single value for a key.
googletag.setConfig({
  targeting: {
    interests: "sports",
  },
});

// Example with multiple values for a key inside in an array.
googletag.setConfig({
  targeting: {
    interests: ["sports", "music"],
  },
});

TypeScript

// Example with a single value for a key.
googletag.setConfig({
  targeting: {
    interests: "sports",
  },
});

// Example with multiple values for a key inside in an array.
googletag.setConfig({
  targeting: {
    interests: ["sports", "music"],
  },
});

Consulta también

• Segmentación por pares clave-valor

Parámetros
key: string	Es la clave del parámetro de segmentación.
value: string | string[]	Es el valor del parámetro de segmentación o el array de valores.

Muestra
PubAdsService	Es el objeto de servicio en el que se llamó al método.

---

setVideoContent

setVideoContent(videoContentId: string, videoCmsId: string): void

Establece la información del contenido de video que se enviará junto con las solicitudes de anuncios para la segmentación y la exclusión de contenido. Los anuncios de video se habilitarán automáticamente cuando se llame a este método. Para videoContentId y videoCmsId, usa los valores que se proporcionan al servicio de transferencia de contenido de Google Ad Manager.

Obsoleto: En su lugar, usa PageSettingsConfig.videoAds.

Consulta también

• Parámetros de URL de las etiquetas de anuncios de VAST

Parámetros
videoContentId: string	Es el ID del contenido de video.
videoCmsId: string	Es el ID del CMS del video.

---

updateCorrelator

updateCorrelator(): PubAdsService

Cambia el correlator que se envía con las solicitudes de anuncios, lo que inicia de manera 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 es único en 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, que refleja automáticamente los anuncios que se encuentran en la página y no tiene tiempo 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.

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.

Muestra
PubAdsService	Es el objeto de servicio en el que se llamó a la función.

---

googletag.RequestHook

Es la función de devolución de llamada que se invoca antes de cada solicitud de anuncio cuando se registra a través de PubAdsService.registerRequestHook.

---

googletag.ResponseInformation

Es un objeto que representa una sola respuesta de anuncio.

Propiedades
advertiserId	Es el ID del anunciante.
campaignId	El ID de la campaña.
creativeId	Es el ID de la creatividad.
creativeTemplateId	Es el ID de la plantilla del anuncio.
lineItemId	Es el ID de la línea de pedido.

Consulta también

• Slot.getResponseInformation

Propiedades

---

advertiserId

advertiserId: number

Es el ID del anunciante.

---

campaignId

campaignId: number

El ID de la campaña.

---

creativeId

creativeId: number

Es el ID de la creatividad.

---

creativeTemplateId

creativeTemplateId: number

Es el ID de la plantilla del anuncio.

---

lineItemId

lineItemId: number

Es el ID de la línea de pedido.

---

googletag.RewardedPayload

Es un objeto que representa la recompensa asociada con un anuncio recompensado.

Propiedades
amount	Es la cantidad de elementos incluidos en la recompensa.
type	Es el tipo de elemento que se incluye en la recompensa (por ejemplo, "moneda").

Consulta también

• Muestra un anuncio recompensado

Propiedades

---

amount

amount: number

Es la cantidad de elementos incluidos en la recompensa.

---

type

type: string

Es el tipo de elemento que se incluye en la recompensa (por ejemplo, "moneda").

---

googletag.Service

Es la clase de servicio base que contiene métodos comunes para todos los servicios.

Métodos
addEventListener	Registra un objeto de escucha que te permite configurar y llamar a una función de JavaScript cuando se produce un evento de GPT específico en la página.
getSlots	Obtén la lista de horarios disponibles asociados con este servicio.
removeEventListener	Quita un objeto de escucha registrado anteriormente.

Métodos

---

addEventListener

addEventListener<K extends keyof EventTypeMap>(eventType: K, listener: ((arg: EventTypeMap[K]) => void)): Service

Registra un objeto de escucha que te permite configurar y llamar a una función de JavaScript cuando se produce un evento de GPT específico en la página. Se admiten los siguientes eventos:

• events.GameManualInterstitialSlotClosedEvent
• events.GameManualInterstitialSlotReadyEvent
• events.ImpressionViewableEvent
• events.RewardedSlotClosedEvent
• events.RewardedSlotGrantedEvent
• events.RewardedSlotReadyEvent
• events.SlotOnloadEvent
• events.SlotRenderEndedEvent
• events.SlotRequestedEvent
• events.SlotResponseReceived
• events.SlotVisibilityChangedEvent

Se pasa un objeto del tipo de evento adecuado al objeto de escucha cuando se lo llama.

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.
  }
});

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

• Objetos de escucha de eventos de anuncios

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.

Muestra
Service	Es el objeto de servicio en el que se llamó al método.

---

getSlots

getSlots(): Slot[]

Obtén la lista de horarios disponibles asociados con este servicio.

Muestra
Slot[]	Son los espacios en el orden en que se agregaron al servicio.

---

removeEventListener

removeEventListener<K extends keyof EventTypeMap>(eventType: K, listener: ((event: EventTypeMap[K]) => void)): void

Quita un objeto de escucha registrado anteriormente.

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();
});

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

Es un compilador para objetos de especificación de asignación de tamaño. Este compilador se proporciona para ayudar a construir fácilmente especificaciones de tamaño.

Métodos
addSize	Agrega una asignación de un array de un solo tamaño (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ños a partir de las asignaciones agregadas a este compilador.

Consulta también

• Tamaños de los anuncios: Anuncios responsivos

Métodos

---

addSize

addSize(viewportSize: SingleSizeArray, slotSize: GeneralSize): SizeMappingBuilder

Agrega una asignación de un array de un solo tamaño (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]

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	Es el tamaño del viewport para esta entrada de asignación.
slotSize: GeneralSize	Son los tamaños del espacio para esta entrada de asignación.

Muestra
SizeMappingBuilder	Es una referencia a este compilador.

---

build

build(): SizeMappingArray

Compila una especificación de asignación de tamaño a partir de las asignaciones agregadas a este compilador.

Si se proporcionaron asignaciones no válidas, este método devolverá null. De lo contrario, devuelve una especificación en el formato correcto para pasar a Slot.defineSizeMapping.

Nota: El comportamiento del compilador después de llamar a este método no está definido.

Muestra
SizeMappingArray	Es el resultado que compiló este compilador. Puede ser nulo si se proporcionaron asignaciones de tamaño no válidas.

---

googletag.Slot

Slot es un objeto que representa un solo espacio publicitario en una página.

Métodos
addService	Agrega un servicio a este espacio publicitario.
clearCategoryExclusions	Obsoleto. Borra todas las etiquetas de exclusión de categorías de anuncios a nivel del espacio publicitario para este espacio.
clearTargeting	Obsoleto. Borra parámetros de segmentación específicos o todos los parámetros de segmentación personalizados a nivel del espacio publicitario para este espacio.
defineSizeMapping	Establece un array de asignaciones de un tamaño mínimo de viewport al tamaño de espacio publicitario para este espacio.
get	Obsoleto. Devuelve el valor del atributo de AdSense asociado con la clave proporcionada para este espacio.
getAdUnitPath	Devuelve 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	Obsoleto. Devuelve la lista de claves de atributos establecidas en este espacio.
getCategoryExclusions	Obsoleto. Devuelve las etiquetas de exclusión de categorías de anuncios para este espacio.
getConfig	Obtiene una copia inalterable de las opciones de configuración general del espacio que se estableció con setConfig.
getResponseInformation	Devuelve la información de la respuesta de solicitud de anuncio.
getSlotElementId	Devuelve el ID del espacio div proporcionado cuando se definió el espacio.
getTargeting	Obsoleto. Muestra un parámetro de segmentación personalizada específico establecido en este espacio.
getTargetingKeys	Obsoleto. Devuelve la lista de todas las claves de segmentación personalizada establecidas en este espacio.
set	Obsoleto. Establece un valor para un atributo de AdSense en este espacio publicitario.
setCategoryExclusion	Obsoleto. Establece una etiqueta de exclusión de categoría de anuncio a nivel del espacio publicitario en este espacio.
setClickUrl	Obsoleto. Establece la URL de clic a la que se redireccionará a los usuarios después de hacer clic en el anuncio.
setCollapseEmptyDiv	Obsoleto. Establece si el espacio div debe ocultarse cuando no hay ningún anuncio en él.
setConfig	Establece opciones de configuración generales para este espacio.
setForceSafeFrame	Obsoleto. Configura si los anuncios de este espacio deben renderizarse de forma forzada con un contenedor de SafeFrame.
setSafeFrameConfig	Obsoleto. Establece las preferencias a nivel del espacio publicitario para la configuración de SafeFrame.
setTargeting	Obsoleto. Establece un parámetro de segmentación personalizada para este espacio publicitario.
updateTargetingFromMap	Obsoleto. Establece parámetros de segmentación personalizada para este espacio publicitario a partir de un mapa de pares clave-valor en un objeto JSON.

Métodos

---

addService

addService(service: Service): Slot

Agrega un servicio a este espacio publicitario.

Ejemplo

JavaScript

googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());

TypeScript

googletag.defineSlot("/1234567/sports", [160, 600], "div")!.addService(googletag.pubads());

Consulta también

• Comienza a usar Google Publisher Tags
• Muestra un anuncio de prueba

Parámetros
service: Service	Es el servicio que se agregará.

Muestra
Slot	Es el objeto de espacio 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.

Obsoleto: En su lugar, usa SlotSettingsConfig.categoryExclusion.

Ejemplo

JavaScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    categoryExclusion: ["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.setConfig({
  categoryExclusion: null,
});

// 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")!
  .setConfig({
    categoryExclusion: ["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.setConfig({
  categoryExclusion: null,
});

// Make an ad request. Any ad can be returned for the slot.

Muestra
Slot	Es el objeto de espacio en el que se llamó al método.

---

clearTargeting

clearTargeting(key?: string): Slot

Borra parámetros de segmentación personalizados específicos o todos los parámetros de segmentación personalizados a nivel del espacio publicitario para este espacio.

Obsoleto: En su lugar, usa SlotSettingsConfig.targeting.

Ejemplo

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    targeting: {
      allow_expandable: "true",
      interests: ["sports", "music"],
      color: "red",
    },
  })
  .addService(googletag.pubads());

slot.setConfig({
  targeting: {
    color: null,
  },
});
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.setConfig({
  targeting: null,
});
// All targeting has been cleared.

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    targeting: {
      allow_expandable: "true",
      interests: ["sports", "music"],
      color: "red",
    },
  })
  .addService(googletag.pubads());

slot.setConfig({
  targeting: {
    color: null,
  },
});
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.setConfig({
  targeting: null,
});
// All targeting has been cleared.

Consulta también

• Segmentación por pares clave-valor

Parámetros
Optional key: string	Es la clave del parámetro de segmentación. La clave es opcional; se borrarán todos los parámetros de segmentación si no se especifica.

Muestra
Slot	Es el objeto de espacio en el que se llamó al método.

---

defineSizeMapping

defineSizeMapping(sizeMapping: SizeMappingArray): Slot

Establece un array de asignaciones de un tamaño mínimo de viewport al 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);

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

• Tamaños de los anuncios: Anuncios responsivos

Parámetros
sizeMapping: SizeMappingArray	Es un array de asignaciones de tamaño. Puedes usar SizeMappingBuilder para crearlo. Cada asignación de tamaño es un array de dos elementos: SingleSizeArray y GeneralSize.

Muestra
Slot	Es el objeto de espacio en el que se llamó al método.

---

get

get(key: string): string

Devuelve el valor del atributo de AdSense asociado con la clave proporcionada para este espacio. Para ver los atributos a nivel del servicio que hereda este espacio, usa PubAdsService.get.

Obsoleto: Usa googletag.Slot.getConfig en su lugar.

Ejemplo

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());

const adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
const pageUrl = adsenseConfig?.page_url || null;
// Returns 'http://www.example.com'.

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());

const adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
const pageUrl = adsenseConfig?.page_url || null;
// Returns 'http://www.example.com'.

Consulta también

• Atributos de AdSense

Parámetros
key: string	Es el nombre del atributo que se buscará.

Muestra
string	Es el valor actual de la clave de atributo o null si la clave no está presente.

---

getAdUnitPath

getAdUnitPath(): string

Devuelve 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'.

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

slot.getAdUnitPath();
// Returns '/1234567/sports'.

Muestra
string	Es la ruta de acceso de la unidad de anuncios.

---

getAttributeKeys

getAttributeKeys(): string[]

Devuelve la lista de claves de atributos establecidas en este espacio. Para ver las claves de los atributos a nivel del servicio que hereda este espacio, usa PubAdsService.getAttributeKeys.

Obsoleto: En su lugar, usa googletag.Slot.getConfig.

Ejemplo

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
      document_language: "en",
    },
  })
  .addService(googletag.pubads());

const adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
const adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
      document_language: "en",
    },
  })
  .addService(googletag.pubads());

const adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
const adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].

Muestra
string[]	Es un array de claves de atributos. El orden no está definido.

---

getCategoryExclusions

getCategoryExclusions(): string[]

Devuelve las etiquetas de exclusión de categorías de anuncios para este espacio.

Obsoleto: En su lugar, usa googletag.Slot.getConfig.

Ejemplo

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    categoryExclusion: ["AirlineAd", "TrainAd"],
  })
  .addService(googletag.pubads());

const exclusions = slot.getConfig("categoryExclusion")?.categoryExclusion || [];
// Returns ['AirlineAd', 'TrainAd'].

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    categoryExclusion: ["AirlineAd", "TrainAd"],
  })
  .addService(googletag.pubads());

const exclusions = slot.getConfig("categoryExclusion")?.categoryExclusion || [];
// Returns ['AirlineAd', 'TrainAd'].

Muestra
string[]	Son las etiquetas de exclusión de categorías de anuncios para este espacio o un array vacío si no se estableció ninguna.

---

getConfig

getConfig(keys: string | string[]): Readonly<Pick<SlotSettingsConfig, "adsenseAttributes" | "targeting" | "categoryExclusion">>

Obtiene una copia inalterable de las opciones de configuración general del espacio publicitario que se establecieron con setConfig.

Este método no admite todas las propiedades de setConfig(). Las propiedades admitidas son las siguientes:

• adsenseAttributes
• categoryExclusion
• targeting

Ejemplo

JavaScript

const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div");

// Get the value of the `targeting` setting.
const targetingConfig = slot.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `categoryExclusion` settings.
const config = slot.getConfig(["adsenseAttributes", "categoryExclusion"]);

TypeScript

const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!;

// Get the value of the `targeting` setting.
const targetingConfig = slot.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `categoryExclusion` settings.
const config = slot.getConfig(["adsenseAttributes", "categoryExclusion"]);

Parámetros
keys: string | string[]	Son las claves de las opciones de configuración que se deben obtener.

Muestra
Readonly<Pick<SlotSettingsConfig, "adsenseAttributes" | "targeting" | "categoryExclusion">>	Es una copia inalterable de las opciones de configuración del espacio.

---

getResponseInformation

getResponseInformation(): ResponseInformation

Devuelve la información de la respuesta de solicitud de anuncio. Esto se basa en la última respuesta del anuncio para el espacio. Si se llama a este método cuando el espacio no tiene ningún anuncio, se devolverá null.

Muestra
ResponseInformation	Es la información más reciente de la respuesta del anuncio o null si el espacio no tiene ningún anuncio.

---

getSlotElementId

getSlotElementId(): string

Devuelve el ID del espacio div proporcionado cuando se definió el espacio.

Ejemplo

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

slot.getSlotElementId();
// Returns 'div'.

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

slot.getSlotElementId();
// Returns 'div'.

Muestra
string	ID del espacio div.

---

getTargeting

getTargeting(key: string): string[]

Devuelve un parámetro de segmentación personalizada específico establecido en este espacio. No se incluyen los parámetros de segmentación a nivel del servicio.

Obsoleto: En su lugar, usa googletag.Slot.getConfig.

Ejemplo

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    targeting: {
      allow_expandable: "true",
    },
  })
  .addService(googletag.pubads());

const targetingConfig = slot.getConfig("targeting").targeting;

// Get targeting for a specific key.
const targeting = targetingConfig?.["allow_expandable"] || [];
// Returns ['true'].

const ageTargeting = targetingConfig?.["age"] || [];
// Returns [] (empty array).

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    targeting: {
      allow_expandable: "true",
    },
  })
  .addService(googletag.pubads());

const targetingConfig = slot.getConfig("targeting").targeting;

// Get targeting for a specific key.
const targeting = targetingConfig?.["allow_expandable"] || [];
// Returns ['true'].

const ageTargeting = targetingConfig?.["age"] || [];
// Returns [] (empty array).

Parámetros
key: string	Es la clave de segmentación que se debe buscar.

Muestra
string[]	Son los valores asociados con esta clave o un array vacío si no existe esa clave.

---

getTargetingKeys

getTargetingKeys(): string[]

Devuelve la lista de todas las claves de segmentación personalizada establecidas en este espacio. No se incluyen las claves de segmentación a nivel del servicio.

Obsoleto: En su lugar, usa googletag.Slot.getConfig.

Ejemplo

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    targeting: {
      allow_expandable: "true",
      interests: ["sports", "music"],
    },
  })
  .addService(googletag.pubads());

const targetingConfig = slot.getConfig("targeting").targeting;
const keys = Object.keys(targetingConfig || {});
// Returns ['interests', 'allow_expandable'].

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    targeting: {
      allow_expandable: "true",
      interests: ["sports", "music"],
    },
  })
  .addService(googletag.pubads());

const targetingConfig = slot.getConfig("targeting").targeting;
const keys = Object.keys(targetingConfig || {});
// Returns ['interests', 'allow_expandable'].

Muestra
string[]	Es un array de claves de segmentación. El orden 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 a nivel del servicio para esta clave.

Si se llama a este método más de una vez para la misma clave, se anularán los valores establecidos anteriormente para esa clave. Todos los valores se deben establecer antes de llamar a display o refresh.

Obsoleto: En su lugar, usa SlotSettingsConfig.adsenseAttributes.

Ejemplo

JavaScript

// Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());

TypeScript

// Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());

Consulta también

• Atributos de AdSense

Parámetros
key: string	Es el nombre del atributo.
value: string	Valor del atributo.

Muestra
Slot	Es el objeto de espacio 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.

Obsoleto: En su lugar, usa SlotSettingsConfig.categoryExclusion.

Ejemplo

JavaScript

// Label = AirlineAd.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    categoryExclusion: ["AirlineAd"],
  })
  .addService(googletag.pubads());

TypeScript

// Label = AirlineAd.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    categoryExclusion: ["AirlineAd"],
  })
  .addService(googletag.pubads());

Consulta también

• Etiquetas personalizadas para bloquear anuncios

Parámetros
categoryExclusion: string	Es la etiqueta de exclusión de categoría de anuncio que se agregará.

Muestra
Slot	Es el objeto de espacio 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 siguen registrando un clic incluso si se reemplaza la URL de clic. Cualquier 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 solo funciona para solicitudes que no son de SRA.

Obsoleto: En su lugar, usa SlotSettingsConfig.clickUrl.

Ejemplo

JavaScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    clickUrl: "http://www.example.com?original_click_url=",
  })
  .addService(googletag.pubads());

TypeScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    clickUrl: "http://www.example.com?original_click_url=",
  })
  .addService(googletag.pubads());

Parámetros
value: string	Es la URL de clic que se establecerá.

Muestra
Slot	Es el objeto de espacio 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 él. Esto anula la configuración a nivel del servicio.

Obsoleto: En su lugar, usa SlotSettingsConfig.collapseDiv.

Ejemplo

JavaScript

const slot1 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    collapseDiv: "BEFORE_FETCH",
  })
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

const slot2 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")
  .setConfig({
    collapseDiv: "ON_NO_FILL",
  })
  .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

const slot1 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setConfig({
    collapseDiv: "BEFORE_FETCH",
  })
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

const slot2 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")!
  .setConfig({
    collapseDiv: "ON_NO_FILL",
  })
  .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

• Contraer espacios publicitarios vacíos
• Minimiza el cambio de diseño

Parámetros
collapse: boolean	Indica si se debe contraer el espacio si no se devuelve ningún anuncio.
Optional collapseBeforeAdFetch: boolean	Indica si se debe contraer el espacio incluso antes de que se recupere un anuncio. Se ignora si el colapso no es true.

Muestra
Slot	Es el objeto de espacio en el que se llamó al método.

---

setConfig

setConfig(slotConfig: SlotSettingsConfig): Slot

Establece opciones de configuración generales para este espacio.

Parámetros
slotConfig: SlotSettingsConfig	Es el objeto de configuración.

Muestra
Slot	Es el objeto de espacio en el que se llamó al método.

---

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): Slot

Configura si los anuncios de este espacio publicitario deben renderizarse de forma forzada 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 que se realicen para los espacios respectivos.
• Si se especifica, el parámetro de configuración a nivel del espacio publicitario siempre anulará el parámetro de configuración a nivel de la 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 en false o se deja sin especificar, el anuncio se renderizará con un contenedor de SafeFrame según el tipo de creatividad y la selección realizada en la IU de Google Ad Manager.
• Esta API se debe utilizar con precaución, ya que podría afectar el comportamiento de las creatividades que intentan salir de sus iFrames o que dependen de que se rendericen directamente en la página de un publicador.

Obsoleto: Usa SlotSettingsConfig.safeFrame en su lugar.

Ejemplo

JavaScript

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

• Renderiza creatividades con SafeFrame

Parámetros
forceSafeFrame: boolean	true para forzar que todos los anuncios de este espacio se rendericen en SafeFrames y false para inhabilitar un parámetro de configuración a nivel de la página (si está presente). Si estableces este valor en false cuando no se especifica a nivel de la página, no cambiará nada.

Muestra
Slot	Es el objeto de espacio en el que se llamó al método.

---

setSafeFrameConfig

setSafeFrameConfig(config: SafeFrameConfig): Slot

Establece las preferencias a nivel del espacio publicitario 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 del espacio publicitario, si se especifican, anularán las preferencias a nivel de la página.

Obsoleto: Usa SlotSettingsConfig.safeFrame en su lugar.

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");

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

• Renderiza creatividades con SafeFrame

Parámetros
config: SafeFrameConfig	Es el objeto de configuración.

Muestra
Slot	Es el objeto de espacio 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. 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.

Obsoleto: En su lugar, usa SlotSettingsConfig.targeting.

Ejemplo

JavaScript

const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div");
slot.addService(googletag.pubads());

// Example with a single value for a key.
slot.setConfig({
  targeting: {
    allow_expandable: "true",
  },
});

// Example with multiple values for a key inside in an array.
slot.setConfig({
  targeting: {
    interests: ["sports", "music"],
  },
});

TypeScript

const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!;
slot.addService(googletag.pubads());

// Example with a single value for a key.
slot.setConfig({
  targeting: {
    allow_expandable: "true",
  },
});

// Example with multiple values for a key inside in an array.
slot.setConfig({
  targeting: {
    interests: ["sports", "music"],
  },
});

Consulta también

• Segmentación por pares clave-valor

Parámetros
key: string	Es la clave del parámetro de segmentación.
value: string | string[]	Es el valor del parámetro de segmentación o el array de valores.

Muestra
Slot	Es el objeto de espacio en el que se llamó al método.

---

updateTargetingFromMap

updateTargetingFromMap(map: {
  [adUnitPath: string]: string | string[];
}): Slot

Establece parámetros de segmentación personalizada para este espacio publicitario a partir de un mapa de pares clave-valor en un objeto JSON. Esto es lo mismo que llamar a Slot.setTargeting para todos los pares clave-valor 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á cualquier valor anterior, no se combinará.
• Los valores que se establezcan aquí reemplazarán los parámetros de segmentación establecidos a nivel del servicio.

Obsoleto: Usa SlotSettingsConfig.targeting en su lugar.

Ejemplo

JavaScript

const 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[]; }	Es el mapa de pares clave-valor del parámetro de segmentación.

Muestra
Slot	Es el objeto de espacio en el que se llamó al método.

---

googletag.config

Es la interfaz de configuración principal para los parámetros de configuración a nivel de la página.

Interfaces
AdExpansionConfig	Es la configuración para controlar la expansión de anuncios.
AdSenseAttributesConfig	Son parámetros de configuración para controlar el comportamiento de los anuncios de AdSense.
AutoRefreshConfig	Son los parámetros de configuración de la actualización automática.
ContinueButtonConfig	Parámetros para configurar el comportamiento del botón Continuar.
InterstitialConfig	Es un objeto que define el comportamiento de un solo espacio publicitario intersticial.
LazyLoadConfig	Parámetros de configuración para controlar el uso de la carga diferida en GPT.
PageSettingsConfig	Es la interfaz de configuración principal para los parámetros de configuración a nivel de la página.
PrivacyTreatmentsConfig	Es la configuración para controlar los tratamientos de privacidad del publicador.
PublisherProvidedSignalsConfig	Es el objeto de configuración de los indicadores proporcionados por el publicador (PPS).
SafeFrameConfig	Es la configuración para controlar SafeFrame en GPT.
SlotSettingsConfig	Es la interfaz de configuración principal para los parámetros de configuración a nivel del espacio publicitario.
TaxonomyData	Es un objeto que contiene los valores de una sola taxonomía.
VideoAdsConfig	Es la configuración para establecer los parámetros relacionados con los anuncios de video.

Alias de tipo
CollapseDivBehavior	Son los valores admitidos para controlar el comportamiento de contracción de los espacios publicitarios.
InterstitialTrigger	Son los activadores de anuncios intersticiales compatibles.
PrivacyTreatment	Tratamientos de privacidad del publicador admitidos
Taxonomy	Taxonomías admitidas para los indicadores proporcionados por el publicador (PPS)

Alias de tipo

---

CollapseDivBehavior

CollapseDivBehavior: "DISABLED" | "BEFORE_FETCH" | "ON_NO_FILL"

Son los valores admitidos para controlar el comportamiento de contracción de los espacios publicitarios.

Consulta también

• PageSettingsConfig.collapseDiv
• SlotSettingsConfig.collapseDiv

---

InterstitialTrigger

InterstitialTrigger: "unhideWindow" | "navBar" | "inactivity" | "endOfArticle" | "continueReading" | "backward"

Son los activadores de anuncios intersticiales compatibles.

Nota: A partir del 15 de junio de 2026, el activador backward dejará de ser compatible y habilitarlo no tendrá ningún efecto. Consulta las notas de la versión de GPT para obtener más información.

---

PrivacyTreatment

PrivacyTreatment: "disablePersonalization"

Tratamientos de privacidad del publicador admitidos

---

Taxonomía

Taxonomy: "IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"

Taxonomías admitidas para los indicadores proporcionados por el publicador (PPS)

Consulta también

• Taxonomía de público de IAB 1.1
• Taxonomía de contenido de IAB 2.2

---

googletag.config.AdExpansionConfig

Es la configuración para controlar la expansión de anuncios.

Propiedades
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 },
});

TypeScript

// Enable ad slot expansion across the entire page.
googletag.setConfig({
  adExpansion: { enabled: true },
});

Propiedades

---

Optional habilitado

enabled?: boolean

Indica si la expansión de anuncios está habilitada o inhabilitada.

Si se establece este valor, se anula el valor predeterminado configurado en Google Ad Manager.

Consulta también

• Expande los anuncios en computadoras y tablets
• Expande los anuncios en la Web móvil (pantalla parcial)

---

googletag.config.AdSenseAttributesConfig

Son parámetros de configuración para controlar el comportamiento de los anuncios de AdSense.

Estos atributos se pueden usar para anular la configuración del servidor en cada solicitud.

Propiedades
adsense_ad_format?	Es el formato del anuncio de AdSense.
adsense_channel_ids?	Son los IDs de los canales de AdSense.
adsense_test_mode?	Indica si el modo de prueba está habilitado o no.
document_language?	Es el idioma de la página en la que se muestran los anuncios.
page_url?	Es la URL de la página en la que se muestran los anuncios.

Consulta también

• PageSettingsConfig.adsenseAttributes
• SlotSettingsConfig.adsenseAttributes

Propiedades

---

Optional adsense_ad_format

adsense_ad_format?: "120x240_as" | "120x600_as" | "125x125_as" | "160x600_as" | "180x150_as" | "200x200_as" | "234x60_as" | "250x250_as" | "300x250_as" | "336x280_as" | "468x60_as" | "728x90_as"

Es el formato del anuncio de AdSense.

---

Optional adsense_channel_ids

adsense_channel_ids?: string

Son los IDs de canal de AdSense.

Los valores permitidos son los IDs de canal separados por "+".

Ejemplo: 271828183+314159265

Consulta también

• Cómo realizar un seguimiento del rendimiento de las unidades de anuncios con canales personalizados

---

Optional adsense_test_mode

adsense_test_mode?: "on"

Indica si el modo de prueba está habilitado o no.

Cuando se establece en on, los anuncios se marcan como solo de prueba y no se incluirán en el recuento ni en la facturación. Este parámetro de configuración debe estar inhabilitado para el tráfico de producción que no sea de prueba.

---

Optional document_language

document_language?: string

Es el idioma de la página en la que se muestran los anuncios.

Los valores permitidos son códigos de idioma ISO 639-1 válidos.

Ejemplo: en

Consulta también

• Lista de códigos de idioma ISO 639

---

Optional page_url

page_url?: string

Es la URL de la página en la que se muestran los anuncios.

Los valores permitidos son URLs válidas.

Ejemplo: http://www.example.com

---

googletag.config.AutoRefreshConfig

Son los parámetros de configuración de la actualización automática.

Propiedades
backForwardCache?	Indica si GPT actualizará automáticamente un espacio publicitario con Vista activa cuando se restablezca la página desde la memoria caché atrás/adelante.
heavyAds?	Indica si GPT actualizará automáticamente un espacio publicitario si se activa la intervención de anuncios pesados de Chrome en el iframe del anuncio del espacio.

Propiedades

---

Optional backForwardCache

backForwardCache?: boolean

Indica si GPT actualizará automáticamente un espacio publicitario con Vista activa cuando se restablezca la página desde la memoria caché atrás/adelante. El valor predeterminado es true.

Ejemplo

JavaScript

// Set the auto refresh configuration, disabling auto refresh on
// back/forward cache restore.
googletag.setConfig({ autoRefresh: { backForwardCache: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });

TypeScript

// Set the auto refresh configuration, disabling auto refresh on
// back/forward cache restore.
googletag.setConfig({ autoRefresh: { backForwardCache: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });

Consulta también

• Memoria caché atrás/adelante

---

Optional heavyAds

heavyAds?: boolean

Indica si GPT actualizará automáticamente un espacio publicitario si se activa la intervención de anuncios pesados de Chrome en el iframe del anuncio del espacio. El valor predeterminado es true.

Ejemplo

JavaScript

// Set the auto refresh configuration, disabling auto refresh on heavy
// ad intervention.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });

TypeScript

// Set the auto refresh configuration, disabling auto refresh on heavy
// ad intervention.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });

Consulta también

• Información sobre las intervenciones de anuncios pesados de Chrome

---

googletag.config.ContinueButtonConfig

Parámetros para configurar el comportamiento del botón Continuar.

Propiedades
backgroundColor?	Es el color de fondo del botón.
font?	Es la familia de fuentes del texto del botón.
fontColor?	Es el color del texto del botón.
freqCapIntervalMinutes?	Es el intervalo de limitación de frecuencia en minutos.
targetId?	Es el ID del elemento HTML en el que se renderizará o activará el botón Continuar.

Consulta también

• SlotSettingsConfig.continueButton

Propiedades

---

Optional backgroundColor

backgroundColor?: string

Es el color de fondo del botón.

Ejemplo: 'blue', '#94B1FF'

---

Optional fuente

font?: string

Es la familia de fuentes del texto del botón.

Ejemplo: 'Arial'

---

Optional fontColor

fontColor?: string

Es el color del texto del botón.

Ejemplo: 'white', '#B73B87'

---

Optional freqCapIntervalMinutes

freqCapIntervalMinutes?: number

Es el intervalo de limitación de frecuencia en minutos.

Debe ser un número entero mayor o igual que 1.

---

Optional targetId

targetId?: string

Es el ID del elemento HTML en el que se renderizará o activará el botón Continuar.

---

googletag.config.InterstitialConfig

Es un objeto que define el comportamiento de un solo espacio publicitario intersticial.

Propiedades
requireStorageAccess?	Indica si se requiere consentimiento para acceder al almacenamiento local para mostrar este anuncio intersticial.
triggers?	Es la configuración del activador de anuncios intersticiales para este anuncio intersticial.

Propiedades

---

Optional requireStorageAccess

requireStorageAccess?: boolean

Indica si se requiere el consentimiento de almacenamiento local para mostrar este anuncio intersticial.

GPT usa el almacenamiento local para aplicar una limitación de frecuencia para los anuncios intersticiales. Sin embargo, los usuarios que no proporcionaron el consentimiento de almacenamiento local siguen siendo aptos para que se les muestren anuncios intersticiales. Si estableces esta propiedad en true, se inhabilita el comportamiento predeterminado y se garantiza que los anuncios intersticiales solo se muestren a los usuarios que otorgaron su consentimiento para el almacenamiento local.

Ejemplo

JavaScript

// Opt out of showing interstitials to users
// without local storage consent.
const interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
);

interstitialSlot.setConfig({
  interstitial: {
    requireStorageAccess: true, // defaults to false
  },
});

TypeScript

// Opt out of showing interstitials to users
// without local storage consent.
const interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
)!;

interstitialSlot.setConfig({
  interstitial: {
    requireStorageAccess: true, // defaults to false
  },
});

Consulta también

• Coordina anuncios intersticiales para la Web

---

Optional activadores

triggers?: Partial<Record<InterstitialTrigger, boolean>>

Es la configuración del activador de anuncios intersticiales para este anuncio intersticial.

Si estableces el valor de un activador de anuncios intersticiales en true, se habilitará, y si lo estableces en false, 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,
    },
  },
});

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

• Muestra un anuncio intersticial para la Web

---

googletag.config.LazyLoadConfig

Parámetros de configuración para controlar el uso de la carga diferida en GPT.

Propiedades
fetchMarginPercent?	Es la distancia mínima desde el viewport actual que debe tener un espacio antes de que solicitemos un anuncio, expresada como un porcentaje del tamaño del viewport.
mobileScaling?	Es un multiplicador que se aplica a los márgenes en dispositivos móviles.
renderMarginPercent?	Es la distancia mínima desde el viewport actual que debe tener un espacio publicitario antes de que rendericemos un anuncio, expresada como un porcentaje del tamaño del viewport.

Consulta también

• PageSettingsConfig.lazyLoad

Propiedades

---

Optional fetchMarginPercent

fetchMarginPercent?: number

Es la distancia mínima que debe haber entre un espacio publicitario y el viewport actual antes de que solicitemos un anuncio, expresada como un porcentaje del tamaño del viewport.

Este parámetro de configuración se usa junto con renderMarginPercent y permite realizar la carga previa de un anuncio, pero esperar para renderizar y descargar otros recursos secundarios. Por lo tanto, este valor siempre debe ser mayor o igual que renderMarginPercent.

Un valor de 0 significa "cuando el espacio publicitario ingresa al viewport", 100 significa "cuando el anuncio está a 1 viewport de distancia", etcétera.

---

Optional mobileScaling

mobileScaling?: number

Es un multiplicador que se aplica a los márgenes en dispositivos móviles. Este multiplicador se aplica tanto a fetchMarginPercent como a renderMarginPercent.

Esto permite establecer diferentes márgenes para dispositivos móviles y computadoras de escritorio, donde los tamaños de viewport y las velocidades de desplazamiento pueden ser diferentes. 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 publicitario con respecto al viewport antes de que se recupere y renderice.

---

Optional renderMarginPercent

renderMarginPercent?: number

Es la distancia mínima desde el viewport actual que debe tener un espacio antes de que rendericemos un anuncio, expresada como un porcentaje del tamaño del viewport.

Cuando se usa junto con fetchMarginPercent, este parámetro de configuración permite recuperar previamente un anuncio, pero esperar para renderizar y descargar otros recursos secundarios. Por lo tanto, este valor siempre debe ser menor o igual que fetchMarginPercent.

Un valor de 0 significa "cuando el espacio publicitario ingresa al viewport", 100 significa "cuando el anuncio está a 1 viewport de distancia", y así sucesivamente.

---

googletag.config.PageSettingsConfig

Es la interfaz de configuración principal para los parámetros de configuración a nivel de la página.

Permite configurar varias funciones con una sola llamada a la API.

Todas las propiedades que se indican a continuación son ejemplos y no reflejan las funciones reales que utilizan setConfig. Para ver el conjunto de funciones, consulta los campos dentro del tipo PageSettingsConfig que se muestra a continuación.

Ejemplos:

• Solo se modifican las funciones especificadas en la llamada a googletag.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 googletag.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
        }
    });

• Todos los parámetros de configuración de un atributo se pueden borrar pasando 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,
    });

Propiedades
adExpansion?	Es la configuración para controlar la expansión de anuncios.
adsenseAttributes?	Es el parámetro de configuración para establecer los atributos de AdSense.
adYield?	Obsoleto.
autoRefresh?	Es el parámetro de configuración para establecer el comportamiento de la actualización automática de anuncios.
categoryExclusion?	Es el parámetro de configuración para establecer exclusiones de categorías de anuncios.
centering?	Es el parámetro de configuración para controlar el centrado horizontal de los anuncios.
collapseDiv?	Es el parámetro de configuración para controlar el comportamiento de contracción de los espacios publicitarios.
disableInitialLoad?	Es el parámetro de configuración para controlar cuándo se solicitan los anuncios.
lazyLoad?	Parámetros de configuración para controlar el uso de la carga diferida en GPT.
location?	Es el parámetro de configuración para segmentar geográficamente las líneas de pedido a ubicaciones geográficas.
pps?	Configuración para controlar los indicadores proporcionados por el publicador (PPS)
privacyTreatments?	Es la configuración para controlar los tratamientos de privacidad del publicador.
requestHookTimeoutMs?	Es el parámetro de configuración para controlar el tiempo máximo que GPT esperará a que se completen todos los hooks de solicitud registrados antes de continuar con una solicitud de anuncio.
safeFrame?	Parámetros de configuración para controlar el uso de SafeFrame en GPT.
singleRequest?	Es el parámetro de configuración para habilitar o inhabilitar la arquitectura de solicitud única (SRA).
targeting?	Es el parámetro de configuración para controlar la segmentación por pares clave-valor.
threadYield?	Es el parámetro de configuración para controlar si GPT debe ceder el subproceso de JS cuando solicita y renderiza creatividades.
videoAds?	Es la configuración para controlar los anuncios de video.

Propiedades

---

Optional adExpansion

adExpansion?: AdExpansionConfig

Es la configuración para controlar la expansión de anuncios.

---

Optional adsenseAttributes

adsenseAttributes?: AdSenseAttributesConfig

Es el parámetro de configuración para establecer los atributos de AdSense.

Los atributos de AdSense que se establezcan con este parámetro de configuración se aplicarán a todos los espacios publicitarios de la página. Este parámetro de configuración se puede llamar varias veces para definir varios valores de atributos o reemplazar los valores existentes.

Los cambios en los atributos de AdSense solo se aplican a las solicitudes de anuncios solicitadas después de que se llama a este método. Por ese motivo, se recomienda llamar a este método antes de cualquier llamada a googletag.display o PubAdsService.refresh.

Ejemplo

JavaScript

// Set the document language and page URL.
googletag.setConfig({
  adsenseAttributes: { document_language: "en", page_url: "http://www.example.com" },
});

// Clear the page URL only.
googletag.setConfig({ adsenseAttributes: { page_url: null } });

// Clear all AdSense attributes.
googletag.setConfig({ adsenseAttributes: null });

TypeScript

// Set the document language and page URL.
googletag.setConfig({
  adsenseAttributes: { document_language: "en", page_url: "http://www.example.com" },
});

// Clear the page URL only.
googletag.setConfig({ adsenseAttributes: { page_url: null } });

// Clear all AdSense attributes.
googletag.setConfig({ adsenseAttributes: null });

---

Optional adYield

adYield?: "DISABLED" | "ENABLED_ALL_SLOTS"

Obsoleto: Usa threadYield en su lugar. Se quitará en un futuro cercano.

---

Optional autoRefresh

autoRefresh?: AutoRefreshConfig

Es el parámetro de configuración para establecer el comportamiento de la actualización automática de anuncios.

Ejemplo

JavaScript

// Set the auto refresh configuration.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration.
googletag.setConfig({ autoRefresh: null });

TypeScript

// Set the auto refresh configuration.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration.
googletag.setConfig({ autoRefresh: null });

---

Optional categoryExclusion

categoryExclusion?: string[]

Es el parámetro de configuración para establecer exclusiones de categorías de anuncios.

Ejemplo

JavaScript

// Label = AirlineAd.
googletag.setConfig({ categoryExclusion: ["AirlineAd"] });

// Clearing category exclusion setting.
googletag.setConfig({ categoryExclusion: null });

TypeScript

// Label = AirlineAd.
googletag.setConfig({ categoryExclusion: ["AirlineAd"] });

// Clearing category exclusion setting.
googletag.setConfig({ categoryExclusion: null });

Consulta también

• Etiquetas personalizadas para bloquear anuncios

---

Optional centering

centering?: boolean

Es el parámetro de configuración para controlar el centrado horizontal de los anuncios. La opción de centrado está inhabilitada de forma predeterminada.

Los cambios en el centrado horizontal solo se aplican a las solicitudes de anuncios solicitadas después de que se llama a este método. Por ese motivo, se recomienda llamar a este método antes de cualquier llamada a googletag.display o PubAdsService.refresh.

Ejemplo

JavaScript

// Make ads centered.
googletag.setConfig({ centering: true });

// Clear the centering setting.
googletag.setConfig({ centering: null });

TypeScript

// Make ads centered.
googletag.setConfig({ centering: true });

// Clear the centering setting.
googletag.setConfig({ centering: null });

---

Optional collapseDiv

collapseDiv?: CollapseDivBehavior

Es el parámetro de configuración para controlar el comportamiento de contracción de los espacios publicitarios.

Un espacio publicitario contraído no ocupa espacio en la página.

Valores admitidos:

• null (predeterminado): El espacio no se contraerá.
• DISABLED: El espacio no se contraerá, independientemente de si se devuelve un anuncio o no.
• BEFORE_FETCH: El espacio publicitario comenzará contraído y se expandirá cuando se devuelva un anuncio.
• ON_NO_FILL: El espacio publicitario comenzará expandido y se contraerá si no se devuelve ningún anuncio.

Ejemplo

JavaScript

// Collapse the div for this slot if no ad is returned.
googletag.setConfig({ collapseDiv: "ON_NO_FILL" });

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
googletag.setConfig({ collapseDiv: "BEFORE_FETCH" });

// Do not collapse the div for this slot.
googletag.setConfig({ collapseDiv: "DISABLED" });

// Clear the collapse setting.
googletag.setConfig({ collapseDiv: null });

TypeScript

// Collapse the div for this slot if no ad is returned.
googletag.setConfig({ collapseDiv: "ON_NO_FILL" });

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
googletag.setConfig({ collapseDiv: "BEFORE_FETCH" });

// Do not collapse the div for this slot.
googletag.setConfig({ collapseDiv: "DISABLED" });

// Clear the collapse setting.
googletag.setConfig({ collapseDiv: null });

Consulta también

• Contraer espacios publicitarios vacíos
• Minimiza el cambio de diseño

---

Optional disableInitialLoad

disableInitialLoad?: boolean

Es un parámetro de configuración para controlar cuándo se solicitan los anuncios.

De forma predeterminada, el método googletag.display registra los espacios publicitarios y solicita anuncios para ellos. Sin embargo, hay ocasiones en las que puede ser preferible separar estas acciones para controlar con mayor precisión cuándo se carga el contenido del anuncio.

Si habilitas este parámetro de configuración, no se solicitarán anuncios para los espacios registrados cuando se llame al método display(). En su lugar, se debe realizar una llamada independiente a PubAdsService.refresh para iniciar una solicitud de anuncio.

Se debe llamar a este método antes de llamar a googletag.enableServices.

Ejemplo

JavaScript

// Prevent requesting ads when `display()` is called.
googletag.setConfig({ disableInitialLoad: true });

TypeScript

// Prevent requesting ads when `display()` is called.
googletag.setConfig({ disableInitialLoad: true });

Consulta también

• Controla la carga y la actualización de anuncios
• Controla el procesamiento por lotes de la SRA

---

Optional lazyLoad

lazyLoad?: LazyLoadConfig

Es la configuración para controlar el uso de la carga diferida en GPT.

La carga diferida es una técnica que permite retrasar la solicitud y la renderización de anuncios hasta que se acerquen al viewport del usuario. Para ver un ejemplo más detallado, consulta el ejemplo de carga diferida.

Nota: Si singleRequest está habilitada, la recuperación diferida solo funciona cuando todos los espacios están fuera del margen de recuperación.

Cualquier parámetro de configuración de carga diferida que no se especifique cuando se llame a setConfig() usará un valor predeterminado establecido por Google. Estos valores predeterminados se pueden ajustar con el tiempo. Para inhabilitar un parámetro de configuración en particular, establece el valor en null.

Ejemplo

JavaScript

// Enable lazy loading.
googletag.setConfig({
  lazyLoad: {
    // Fetch slots within 5 viewports.
    fetchMarginPercent: 500,
    // Render slots within 2 viewports.
    renderMarginPercent: 200,
    // Double the above values on mobile.
    mobileScaling: 2.0,
  },
});

// Clear fetch margin only.
googletag.setConfig({
  lazyLoad: { fetchMarginPercent: null },
});

// Clear all lazy loading settings.
googletag.setConfig({ lazyLoad: null });

TypeScript

// Enable lazy loading.
googletag.setConfig({
  lazyLoad: {
    // Fetch slots within 5 viewports.
    fetchMarginPercent: 500,
    // Render slots within 2 viewports.
    renderMarginPercent: 200,
    // Double the above values on mobile.
    mobileScaling: 2.0,
  },
});

// Clear fetch margin only.
googletag.setConfig({
  lazyLoad: { fetchMarginPercent: null },
});

// Clear all lazy loading settings.
googletag.setConfig({ lazyLoad: null });

Consulta también

• Prácticas recomendadas para los anuncios: Prioriza los espacios publicitarios "importantes"
• Carga diferida

---

Optional Ubicación

location?: string

Es el parámetro de configuración para segmentar geográficamente las líneas de pedido a ubicaciones geográficas.

Ejemplo

JavaScript

// Geo-target line items to US postal code 10001.
googletag.setConfig({ location: "10001,US" });

// Clear the location setting.
googletag.setConfig({ location: null });

TypeScript

// Geo-target line items to US postal code 10001.
googletag.setConfig({ location: "10001,US" });

// Clear the location setting.
googletag.setConfig({ location: null });

Consulta también

• Segmenta publicaciones para ubicaciones geográficas

---

Optional pps

pps?: PublisherProvidedSignalsConfig

Configuración para controlar los indicadores proporcionados por el publicador (PPS)

---

Optional privacyTreatments

privacyTreatments?: PrivacyTreatmentsConfig

Es la configuración para controlar los tratamientos de privacidad del publicador.

---

Optional Experimental requestHookTimeoutMs

requestHookTimeoutMs?: number | "auto"

Es el parámetro de configuración para controlar el tiempo máximo que GPT esperará a que se completen todos los hooks de solicitud registrados antes de continuar con una solicitud de anuncio.

Todos los hooks de solicitud registrados se ejecutan en paralelo. Este tiempo de espera define el límite superior de la duración de la pausa del proceso de solicitud de anuncio mientras se espera que se completen esas ejecuciones paralelas.

Valores admitidos:

• Número positivo en milisegundos: Es el período de espera personalizado.
• 'auto': GPT usa un tiempo de espera optimizado por Google.
• null: Inhabilita los tiempos de espera (GPT espera de forma indefinida a que se completen los hooks).

Ejemplo

JavaScript

// Set a 1000ms timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: 1000 });

// Use a Google-optimized timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: "auto" });

// Clear the timeout.
googletag.setConfig({ requestHookTimeoutMs: null });

TypeScript

// Set a 1000ms timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: 1000 });

// Use a Google-optimized timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: "auto" });

// Clear the timeout.
googletag.setConfig({ requestHookTimeoutMs: null });

---

Optional safeFrame

safeFrame?: SafeFrameConfig

Configuración para controlar el uso de SafeFrame en GPT.

Los valores configurados a través de este parámetro se aplicarán a todos los espacios publicitarios de la página. Los espacios publicitarios individuales pueden anular estos valores a través de SlotSettingsConfig.safeFrame.

Ejemplo

JavaScript

// Force SafeFrame for all ads on the page.
googletag.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion.
googletag.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting.
googletag.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings.
googletag.setConfig({ safeFrame: null });

TypeScript

// Force SafeFrame for all ads on the page.
googletag.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion.
googletag.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting.
googletag.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings.
googletag.setConfig({ safeFrame: null });

---

Optional singleRequest

singleRequest?: boolean

Es el parámetro de configuración para habilitar o inhabilitar la arquitectura de solicitud única (SRA).

Cuando se habilita la SRA, todos los espacios publicitarios definidos antes de una llamada a googletag.display o PubAdsService.refresh se agruparán en una sola solicitud de anuncio. Esto proporciona beneficios de rendimiento, pero también es necesario para garantizar que se respeten las publicidades simultáneas y las exclusiones competitivas.

Cuando se inhabilita la SRA, cada espacio publicitario se solicita de forma individual. Este es el comportamiento predeterminado de GPT.

Se debe llamar a este método antes de llamar a googletag.enableServices.

Ejemplo

JavaScript

// Enable Single Request Architecture.
googletag.setConfig({ singleRequest: true });

TypeScript

// Enable Single Request Architecture.
googletag.setConfig({ singleRequest: true });

Consulta también

• Acerca de las publicaciones simultáneas garantizadas
• Prácticas recomendadas para los anuncios: Usa correctamente la arquitectura de solicitud única
• Controla el procesamiento por lotes de la SRA

---

Segmentación por Optional

targeting?: Record<string, string | string[]>

Es el parámetro de configuración para controlar la segmentación por pares clave-valor.

La segmentación configurada a través de este parámetro se aplicará a todos los espacios publicitarios de la página. Se puede llamar a este parámetro de configuración varias veces para definir varios pares clave-valor de segmentación o reemplazar los valores existentes. Las claves de segmentación se definen en tu cuenta de Google Ad Manager.

Ejemplo

JavaScript

// Setting a single targeting key-value.
googletag.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key
googletag.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
googletag.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
googletag.setConfig({ targeting: { interests: null } });

TypeScript

// Setting a single targeting key-value.
googletag.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key
googletag.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
googletag.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
googletag.setConfig({ targeting: { interests: null } });

Consulta también

• Segmentación por pares clave-valor

---

Optional threadYield

threadYield?: "DISABLED" | "ENABLED_ALL_SLOTS"

Es el parámetro de configuración para controlar si GPT debe ceder el subproceso de JS cuando solicita y renderiza creatividades.

GPT solo cederá el subproceso para los navegadores que admitan la API de Scheduler.postTask o Scheduler.yield.

Valores admitidos:

• null (predeterminado): GPT cederá el subproceso de JS para los espacios que estén fuera del viewport.
• ENABLED_ALL_SLOTS: GPT producirá el subproceso de JS para todos los espacios, independientemente de si el espacio está dentro del viewport.
• DISABLED: GPT no cederá el subproceso de JS.

Ejemplo

JavaScript

// Disable yielding.
googletag.setConfig({ threadYield: "DISABLED" });

// Enable yielding for all slots.
googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" });

// Enable yielding only for slots outside of the viewport (default).
googletag.setConfig({ threadYield: null });

TypeScript

// Disable yielding.
googletag.setConfig({ threadYield: "DISABLED" });

// Enable yielding for all slots.
googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" });

// Enable yielding only for slots outside of the viewport (default).
googletag.setConfig({ threadYield: null });

Consulta también

• Programador

---

Optional videoAds

videoAds?: VideoAdsConfig

Configuración para controlar los anuncios de video.

Ejemplo

JavaScript

// Enable video ads and set video content and content source IDs.
googletag.setConfig({
  videoAds: {
    enableVideoAds: true,
    videoContentId: "e1eGlRL7ju8",
    videoCmsId: "1234567",
  },
});

TypeScript

// Enable video ads and set video content and content source IDs.
googletag.setConfig({
  videoAds: {
    enableVideoAds: true,
    videoContentId: "e1eGlRL7ju8",
    videoCmsId: "1234567",
  },
});

Consulta también

• Transferencia de contenido de video

---

googletag.config.PrivacyTreatmentsConfig

Es la configuración para controlar los tratamientos de privacidad del publicador.

Propiedades
treatments	Es un array de tratamientos de privacidad del publicador que se habilitarán.

Propiedades

---

tratamientos

treatments: "disablePersonalization"[]

Es un array de tratamientos de privacidad del publicador que se habilitarán.

Ejemplo

JavaScript

// 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

Es el objeto de configuración de los indicadores proporcionados por el publicador (PPS).

Propiedades
taxonomies	Es un objeto que contiene asignaciones de Taxonomy o un valor nulo para borrar la configuración.

Ejemplo

JavaScript

googletag.setConfig({
  pps: {
    taxonomies: {
      IAB_AUDIENCE_1_1: { values: ["6", "626"] },
      // '6' = 'Demographic | Age Range | 30-34'
      // '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 | 30-34'
      // '626' = 'Interest | Sports | Darts'
      IAB_CONTENT_2_2: { values: ["48", "127"] },
      // '48' = 'Books and Literature | Fiction'
      // '127' = 'Careers | Job Search'
    },
  },
});

Consulta también

• Acerca de los indicadores proporcionados por el publicador (beta)
• Taxonomía de público de IAB 1.1
• Taxonomía de contenido de IAB 2.2

Propiedades

---

taxonomías

taxonomies: Partial<Record<Taxonomy, TaxonomyData>>

Es un objeto que contiene asignaciones de Taxonomy o un valor nulo para borrar la configuración.

---

googletag.config.SafeFrameConfig

Es la configuración para controlar SafeFrame en GPT.

Propiedades
allowOverlayExpansion?	Indica si SafeFrame debe permitir que el contenido del anuncio se expanda superponiéndose al contenido de la página.
allowPushExpansion?	Indica si SafeFrame debe permitir que el contenido del anuncio se expanda desplazando el contenido de la página.
forceSafeFrame?	Indica si se debe forzar la renderización de los anuncios con un contenedor de SafeFrame.
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 aleatorizados para las creatividades de reservación.

Consulta también

• PageSettingsConfig.safeFrame
• SlotSettingsConfig.safeFrame

Propiedades

---

Optional allowOverlayExpansion

allowOverlayExpansion?: boolean

Indica si SafeFrame debe permitir que el contenido del anuncio se expanda superponiéndose al contenido de la página.

---

Optional allowPushExpansion

allowPushExpansion?: boolean

Indica si SafeFrame debe permitir que el contenido del anuncio se expanda desplazando el contenido de la página.

---

Optional forceSafeFrame

forceSafeFrame?: boolean

Indica si se debe forzar la renderización de los anuncios con un contenedor de SafeFrame.

---

Optional zona de pruebas

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 a false). Ten en cuenta que el atributo de zona de pruebas inhabilita los complementos (p.ej., Flash).

---

Optional useUniqueDomain

useUniqueDomain?: boolean

Indica si SafeFrame debe usar subdominios aleatorizados para las creatividades de reservación. Pasa null para borrar el valor almacenado.

Nota: Esta función está habilitada de forma predeterminada.

Obsoleta: Ya no es posible inhabilitar esta función. Establecer useUniqueDomain no tiene ningún efecto.

Consulta también

• Renderiza creatividades con SafeFrame

---

googletag.config.SlotSettingsConfig

Es la interfaz de configuración principal para los parámetros de configuración a nivel del espacio.

Permite establecer varias funciones con una sola llamada a la API para un solo espacio.

Todas las propiedades que se indican a continuación son ejemplos y no reflejan las funciones reales que utilizan setConfig. Para ver el conjunto de funciones, consulta los campos dentro del tipo SlotSettingsConfig que se muestra a continuación.

Ejemplos:

• Solo se modifican los atributos especificados en la llamada a 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
        }
    });

• Todos los parámetros de configuración de un atributo se pueden borrar pasando 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,
    });

Propiedades
adExpansion?	Es la configuración para establecer la expansión de anuncios.
adsenseAttributes?	Es el parámetro de configuración para establecer los atributos de AdSense.
categoryExclusion?	Es el parámetro de configuración para establecer exclusiones de categorías de anuncios.
clickUrl?	Es el parámetro de configuración para establecer la URL a la que se redireccionará a los usuarios después de que hagan clic en el anuncio.
collapseDiv?	Es el parámetro para configurar el comportamiento de contracción del espacio publicitario.
continueButton?	Es la configuración para establecer el comportamiento del botón de continuar en los anuncios en contenido pausado.
interstitial?	Son los parámetros de configuración que establecen el comportamiento de los espacios publicitarios intersticiales.
safeFrame?	Es la configuración para establecer el uso de SafeFrame en GPT.
targeting?	Es el parámetro para configurar la segmentación por pares clave-valor.

Propiedades

---

Optional adExpansion

adExpansion?: AdExpansionConfig

Es la configuración para establecer la expansión de anuncios.

Consulta también

• Expansión de anuncios

---

Optional adsenseAttributes

adsenseAttributes?: AdSenseAttributesConfig

Es el parámetro de configuración para establecer los atributos de AdSense.

Los atributos de AdSense que se establezcan con este parámetro de configuración solo se aplicarán al espacio publicitario. Este parámetro de configuración se puede llamar varias veces para definir varios valores de atributos o reemplazar los valores existentes.

Los cambios en los atributos de AdSense solo se aplican a las solicitudes de anuncios solicitadas después de que se llama a este método. Por ese motivo, se recomienda llamar a este método antes de cualquier llamada a googletag.display o PubAdsService.refresh.

Ejemplo

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Set the AdSense ad format and channel IDs.
slot.setConfig({
  adsenseAttributes: {
    adsense_ad_format: "120x240_as",
    adsense_channel_ids: "271828183+314159265",
  },
});

// Clear the AdSense channel IDs only.
slot.setConfig({ adsenseAttributes: { adsense_channel_ids: null } });

// Clear all AdSense attributes.
slot.setConfig({ adsenseAttributes: null });

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Set the AdSense ad format and channel IDs.
slot.setConfig({
  adsenseAttributes: {
    adsense_ad_format: "120x240_as",
    adsense_channel_ids: "271828183+314159265",
  },
});

// Clear the AdSense channel IDs only.
slot.setConfig({ adsenseAttributes: { adsense_channel_ids: null } });

// Clear all AdSense attributes.
slot.setConfig({ adsenseAttributes: null });

---

Optional categoryExclusion

categoryExclusion?: string[]

Es el parámetro de configuración para establecer exclusiones de categorías de anuncios.

Ejemplo

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Label = AirlineAd
slot.setConfig({
  categoryExclusion: ["AirlineAd"],
});

// Clearing category exclusion setting.
slot.setConfig({ categoryExclusion: null });

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Label = AirlineAd
slot.setConfig({
  categoryExclusion: ["AirlineAd"],
});

// Clearing category exclusion setting.
slot.setConfig({ categoryExclusion: null });

Consulta también

• Etiquetas personalizadas para bloquear anuncios

---

Optional clickUrl

clickUrl?: string

Es el parámetro de configuración para establecer la URL a la que se redireccionará a los usuarios después de que hagan clic en el anuncio.

Los servidores de Google Ad Manager siguen registrando un clic incluso si se reemplaza la URL de clic. Cualquier URL de página de destino asociada con la creatividad que se publica se agrega al valor proporcionado. Si estableces este valor más de una vez, se reemplazará cualquier valor configurado anteriormente. Si se pasa null, se borrará el valor.

Nota: Este parámetro de configuración solo se aplica a las solicitudes que no son de SRA.

Ejemplo

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Sets the click URL to 'http://www.example.com?original_click_url='.
slot.setConfig({
  clickUrl: "http://www.example.com?original_click_url=",
});

// Clears the click URL.
slot.setConfig({
  clickUrl: null,
});

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Sets the click URL to 'http://www.example.com?original_click_url='.
slot.setConfig({
  clickUrl: "http://www.example.com?original_click_url=",
});

// Clears the click URL.
slot.setConfig({
  clickUrl: null,
});

---

Optional collapseDiv

collapseDiv?: CollapseDivBehavior

Es el parámetro de configuración para establecer el comportamiento de contracción del espacio publicitario.

Un espacio publicitario contraído no ocupa espacio en la página.

Valores admitidos:

• null (predeterminado): El espacio no se contraerá.
• DISABLED: El espacio no se contraerá, independientemente de si se devuelve un anuncio o no.
• BEFORE_FETCH: El espacio publicitario comenzará contraído y se expandirá cuando se devuelva un anuncio.
• ON_NO_FILL: El espacio publicitario comenzará expandido y se contraerá si no se devuelve ningún anuncio.

Ejemplo

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Collapse the div for this slot if no ad is returned.
slot.setConfig({
  collapseDiv: "ON_NO_FILL",
});

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
slot.setConfig({
  collapseDiv: "BEFORE_FETCH",
});

// Do not collapse the div for this slot.
slot.setConfig({
  collapseDiv: "DISABLED",
});

// Clear the collapse setting.
slot.setConfig({
  collapseDiv: null,
});

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Collapse the div for this slot if no ad is returned.
slot.setConfig({
  collapseDiv: "ON_NO_FILL",
});

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
slot.setConfig({
  collapseDiv: "BEFORE_FETCH",
});

// Do not collapse the div for this slot.
slot.setConfig({
  collapseDiv: "DISABLED",
});

// Clear the collapse setting.
slot.setConfig({
  collapseDiv: null,
});

Consulta también

• Contraer espacios publicitarios vacíos
• Minimiza el cambio de diseño

---

Optional continueButton

continueButton?: ContinueButtonConfig

Parámetros de configuración para establecer el comportamiento del botón de continuar en los anuncios en contenido pausado.

Estos parámetros de configuración permiten personalizar el aspecto y el comportamiento de las interacciones de salir y seguir leyendo asociadas con los formatos de contenido pausado.

Cualquier parámetro de configuración del botón de continuar que no se especifique cuando se llame a setConfig() usará un valor predeterminado establecido por Google.

Para inhabilitar o borrar todos los parámetros de configuración del botón de continuar, pasa null.

Ejemplo

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());
// Configure continue button settings.
slot.setConfig({
  continueButton: {
    font: "Arial",
    fontColor: "white",
    backgroundColor: "blue",
    targetId: "target-div-id",
    freqCapIntervalMinutes: 20,
  },
});

// Clear continue button settings.
slot.setConfig({ continueButton: null });

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());
// Configure continue button settings.
slot.setConfig({
  continueButton: {
    font: "Arial",
    fontColor: "white",
    backgroundColor: "blue",
    targetId: "target-div-id",
    freqCapIntervalMinutes: 20,
  },
});

// Clear continue button settings.
slot.setConfig({ continueButton: null });

---

Anuncio intersticial de Optional

interstitial?: InterstitialConfig

Son parámetros de configuración que establecen el comportamiento de los espacios publicitarios intersticiales.

Consulta también

• Coordina anuncios intersticiales para la Web

---

Optional safeFrame

safeFrame?: SafeFrameConfig

Parámetros para configurar el uso de SafeFrame en GPT.

Los valores configurados a través de este parámetro solo se aplicarán al espacio publicitario y anularán los valores establecidos a través de PageSettingsConfig.safeFrame.

Ejemplo

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Force SafeFrame for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion for the slot.
slot.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings for the slot.
slot.setConfig({ safeFrame: null });

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Force SafeFrame for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion for the slot.
slot.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings for the slot.
slot.setConfig({ safeFrame: null });

---

Segmentación por Optional

targeting?: Record<string, string | string[]>

Es el parámetro para configurar la segmentación por pares clave-valor.

La segmentación configurada con este parámetro solo se aplicará al espacio publicitario. Se puede llamar a este parámetro de configuración varias veces para definir varios pares clave-valor de segmentación o reemplazar los valores existentes. Las claves de segmentación se definen en tu cuenta de Google Ad Manager.

Ejemplo

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Setting a single targeting key-value.
slot.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key.
slot.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
slot.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
slot.setConfig({ targeting: { interests: null } });

// Clear all targeting keys.
slot.setConfig({ targeting: null });

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Setting a single targeting key-value.
slot.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key.
slot.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
slot.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
slot.setConfig({ targeting: { interests: null } });

// Clear all targeting keys.
slot.setConfig({ targeting: null });

Consulta también

• Segmentación por pares clave-valor

---

googletag.config.TaxonomyData

Es un objeto que contiene los valores de una sola taxonomía.

Propiedades
values	Es una lista de valores de Taxonomy.

Propiedades

---

values

values: readonly string[]

Es una lista de valores de Taxonomy.

---

googletag.config.VideoAdsConfig

Es la configuración para establecer los parámetros relacionados con los anuncios de video.

Propiedades
enableVideoAds	Indica si habrá anuncios de video en la página.
videoCmsId?	Es el ID de la fuente del contenido de video.
videoContentId?	Es el ID del contenido de video.

Consulta también

• PageSettingsConfig.videoAds

Propiedades

---

enableVideoAds

enableVideoAds: boolean

Indica si habrá anuncios de video en la página.

Cuando se establece en true, se habilitan las restricciones de exclusión de contenido en los anuncios gráficos y de video.

Si se conoce el contenido de video, establece videoContentId y videoCmsId en los valores proporcionados al servicio de transferencia de contenido de Google Ad Manager para utilizar la exclusión de contenido en los anuncios gráficos.

---

Optional videoCmsId

videoCmsId?: string

Es el ID de la fuente del contenido de video.

Este es un valor único que asigna el servicio de transferencia de contenido de Google Ad Manager para identificar la fuente del contenido de video que especifica videoContentId.

Consulta también

• cmsid (ID de la fuente del contenido)

---

Optional videoContentId

videoContentId?: string

Es el ID del contenido de video.

Este es un valor único que identifica un video en particular de la fuente de contenido que especifica videoCmsId. Este valor lo asigna el CMS que aloja tu contenido de video.

Consulta también

• vid (ID de video)

---

googletag.enums

Este es el espacio de nombres que GPT usa para los tipos de enumeración.

Enumeraciones
OutOfPageFormat	Formatos fuera de página compatibles con GPT
TagForAgeTreatment	Configuración del tratamiento de contenido según la edad que admite GPT.
TrafficSource	Fuentes de tráfico compatibles con GPT

Enumeraciones

---

OutOfPageFormat

OutOfPageFormat

Formatos fuera de página compatibles con GPT

Consulta también

• defineOutOfPageSlot

Miembros de la enumeración
AD_INTENTS	Formato de intenciones de anuncios
BOTTOM_ANCHOR	Es el formato fijo en el que el espacio publicitario se adhiere a la parte inferior del viewport.
GAME_MANUAL_INTERSTITIAL	Formato de anuncio intersticial manual para juegos. Nota: El anuncio intersticial manual para juegos es un formato de acceso limitado.
INTERSTITIAL	Formato de creatividad de anuncio intersticial para la Web.
LEFT_SIDE_RAIL	Formato de anuncio lateral izquierdo.
REWARDED	Formato recompensado
RIGHT_SIDE_RAIL	Formato de anuncio lateral derecho.
TOP_ANCHOR	Es el formato de anuncio fijo en el que el espacio publicitario se adhiere a la parte superior del viewport.

---

TagForAgeTreatment

TagForAgeTreatment

Parámetros de configuración del tratamiento según la edad que admite GPT.

Consulta también

• PrivacySettingsConfig.tagForAgeTreatment

Miembros de la enumeración
CHILD	Indica que las solicitudes de anuncios deben recibir el tratamiento de contenido para NIÑOS.
TEEN	Indica que las solicitudes de anuncios deben recibir el tratamiento de contenido para adolescentes (TEEN).
UNSPECIFIED	Valor predeterminado Indica que no se aplica ningún indicador específico de tratamiento de contenido con restricción de edad a la solicitud de anuncio.

---

TrafficSource

TrafficSource

Fuentes de tráfico compatibles con GPT

Consulta también

• PrivacySettingsConfig.trafficSource

Miembros de la enumeración
ORGANIC	Entradas de URL directas, búsquedas en el sitio o descargas de apps
PURCHASED	Tráfico redirigido desde propiedades que no son propias (adquiridas, o bien alguna otra actividad incentivada)

---

googletag.events

Este es el espacio de nombres que usa GPT para los eventos. Tu código puede reaccionar a estos eventos con Service.addEventListener.

Interfaces
Event	Es la interfaz base para todos los eventos de GPT.
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.
GameManualInterstitialSlotClosedEvent	Este evento se activa cuando el usuario cierra un espacio de anuncio intersticial manual de juegos.
GameManualInterstitialSlotReadyEvent	Este evento se activa cuando un espacio intersticial manual en juegos está listo para mostrarse al usuario.
ImpressionViewableEvent	Este evento se activa cuando una impresión se vuelve visible, según los criterios de Vista activa.
RewardedSlotClosedEvent	Este evento se activa cuando el usuario cierra un espacio publicitario recompensado.
RewardedSlotGrantedEvent	Este evento se activa cuando se otorga una recompensa por ver un anuncio recompensado.
RewardedSlotReadyEvent	Este evento se activa cuando un anuncio recompensado está listo para mostrarse.
RewardedSlotVideoCompletedEvent	Este evento se activa cuando un anuncio de video recompensado termina de reproducirse.
SlotOnloadEvent	Este evento se activa cuando el iframe de la creatividad activa su evento de carga.
SlotRenderEndedEvent	Este evento se activa cuando el código de la creatividad se inserta en un espacio publicitario.
SlotRequestedEvent	Este evento se activa cuando se solicita un anuncio para un espacio publicitario en particular.
SlotResponseReceived	Este evento se activa cuando se recibe una respuesta de anuncio para un espacio publicitario específico.
SlotVisibilityChangedEvent	Este evento se activa cada vez que cambia el porcentaje en pantalla del área de un espacio publicitario.

---

googletag.events.Event

Es la interfaz base para todos los eventos de GPT. Todos los eventos de GPT que se indican a continuación tendrán los siguientes campos.

Propiedades
serviceName	Es el nombre del servicio que activó el evento.
slot	Es el espacio publicitario que activó el evento.

Consulta también

• Objetos de escucha de eventos de anuncios

Propiedades

---

serviceName

serviceName: string

Es el nombre del servicio que activó el evento.

---

slot

slot: Slot

Es el espacio publicitario 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.

Propiedades
gameManualInterstitialSlotClosed	Alias de events.GameManualInterstitialSlotClosedEvent.
gameManualInterstitialSlotReady	Alias de events.GameManualInterstitialSlotReadyEvent.
impressionViewable	Alias de events.ImpressionViewableEvent.
rewardedSlotClosed	Alias de events.RewardedSlotClosedEvent.
rewardedSlotGranted	Alias de events.RewardedSlotGrantedEvent.
rewardedSlotReady	Alias de events.RewardedSlotReadyEvent.
rewardedSlotVideoCompleted	Alias de events.RewardedSlotVideoCompletedEvent.
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.

Propiedades

---

gameManualInterstitialSlotClosed

gameManualInterstitialSlotClosed: GameManualInterstitialSlotClosedEvent

Alias de events.GameManualInterstitialSlotClosedEvent.

---

gameManualInterstitialSlotReady

gameManualInterstitialSlotReady: GameManualInterstitialSlotReadyEvent

Alias de events.GameManualInterstitialSlotReadyEvent.

---

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.

---

rewardedSlotVideoCompleted

rewardedSlotVideoCompleted: RewardedSlotVideoCompletedEvent

Alias de events.RewardedSlotVideoCompletedEvent.

---

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.GameManualInterstitialSlotClosedEvent

Extiende Event

Este evento se activa cuando el usuario cierra un espacio intersticial manual para juegos.

Nota: El anuncio intersticial manual para juegos tiene un formato de acceso limitado.

Propiedades
serviceName	Es el nombre del servicio que activó el evento. Heredado de la propiedad Event.serviceName
slot	Es el espacio publicitario que activó el evento. Heredado de la propiedad Event.slot

Ejemplo

JavaScript

// This listener is called when a game manual interstitial slot is closed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => {
    const slot = event.slot;
    console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

TypeScript

// This listener is called when a game manual interstitial slot is closed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => {
    const slot = event.slot;
    console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

Consulta también

• Objetos de escucha de eventos de anuncios
• Muestra un anuncio intersticial manual en juegos

---

googletag.events.GameManualInterstitialSlotReadyEvent

Extiende Event

Este evento se activa cuando un espacio publicitario intersticial manual en juegos está listo para mostrarse al usuario.

Nota: El anuncio intersticial manual en juegos es un formato de acceso limitado.

Propiedades
serviceName	Es el nombre del servicio que activó el evento. Heredado de la propiedad Event.serviceName
slot	Es el espacio publicitario que activó el evento. Heredado de la propiedad Event.slot

Métodos
makeGameManualInterstitialVisible	Muestra el anuncio intersticial manual en juegos al usuario.

Ejemplo

JavaScript

// This listener is called when a game manual interstitial slot is ready to
// be displayed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => {
    const slot = event.slot;
    console.log(
      "Game manual interstital slot",
      slot.getSlotElementId(),
      "is ready to be displayed.",
    );

    // Replace with custom logic.
    const displayGmiAd = true;
    if (displayGmiAd) {
      event.makeGameManualInterstitialVisible();
    }

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

TypeScript

// This listener is called when a game manual interstitial slot is ready to
// be displayed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => {
    const slot = event.slot;
    console.log(
      "Game manual interstital slot",
      slot.getSlotElementId(),
      "is ready to be displayed.",
    );

    // Replace with custom logic.
    const displayGmiAd = true;
    if (displayGmiAd) {
      event.makeGameManualInterstitialVisible();
    }

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

Consulta también

• Objetos de escucha de eventos de anuncios
• Muestra un anuncio intersticial manual en juegos

Métodos

---

makeGameManualInterstitialVisible

makeGameManualInterstitialVisible(): boolean

Muestra el anuncio intersticial manual en juegos al usuario. Muestra si el anuncio se mostró correctamente.

Muestra
boolean

---

googletag.events.ImpressionViewableEvent

Extiende Event

Este evento se activa cuando una impresión se vuelve visible, según los criterios de Vista activa.

Propiedades
serviceName	Es el nombre del servicio que activó el evento. Heredado de la propiedad Event.serviceName
slot	Es el espacio publicitario que activó el evento. Heredado de la propiedad Event.slot

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.
  }
});

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

• Objetos de escucha de eventos de anuncios

---

googletag.events.RewardedSlotClosedEvent

Extiende Event

Este evento se activa cuando el usuario cierra un espacio publicitario recompensado. Se puede activar antes o después de que se otorgue una recompensa. Para determinar si se otorgó una recompensa, usa events.RewardedSlotGrantedEvent.

Propiedades
serviceName	Es el nombre del servicio que activó el evento. Heredado de la propiedad Event.serviceName
slot	Es el espacio publicitario que activó el evento. Heredado de la propiedad Event.slot

Ejemplo

JavaScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the user closes a rewarded ad slot.
  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.
    }
  });
}

TypeScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the user closes a rewarded ad slot.
  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

• Objetos de escucha de eventos de anuncios
• Muestra un anuncio recompensado

---

googletag.events.RewardedSlotGrantedEvent

Extiende Event

Este evento se activa cuando se otorga una recompensa por ver un anuncio recompensado. Si el anuncio se cierra antes de que se cumplan los criterios para otorgar una recompensa, no se activará este evento.

Propiedades
payload	Es un objeto que contiene información sobre la recompensa que se otorgó.
serviceName	Es el nombre del servicio que activó el evento. Heredado de la propiedad Event.serviceName
slot	Es el espacio publicitario que activó el evento. Heredado de la propiedad Event.slot

Ejemplo

JavaScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  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.
    }
  });
}

TypeScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  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

• Objetos de escucha de eventos de anuncios
• Muestra un anuncio recompensado

Propiedades

---

payload

payload: RewardedPayload

Es un objeto que contiene información sobre la recompensa que se otorgó.

---

googletag.events.RewardedSlotReadyEvent

Extiende Event

Este evento se activa cuando un anuncio recompensado está listo para mostrarse. El publicador es responsable de presentarle al usuario una opción para ver el anuncio antes de mostrarlo.

Propiedades
serviceName	Es el nombre del servicio que activó el evento. Heredado de la propiedad Event.serviceName
slot	Es el espacio publicitario que activó el evento. Heredado de la propiedad Event.slot

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.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  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.
    }
  });
}

TypeScript

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  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

• Objetos de escucha de eventos de anuncios
• Muestra un anuncio recompensado

Métodos

---

makeRewardedVisible

makeRewardedVisible(): boolean

Muestra el anuncio recompensado. No se debe llamar a este método hasta que el usuario haya dado su consentimiento para ver el anuncio.

Muestra
boolean	Indica si el anuncio recompensado se mostró correctamente.

---

googletag.events.RewardedSlotVideoCompletedEvent

Extiende Event

Este evento se activa cuando un anuncio de video recompensado termina de reproducirse.

Propiedades
serviceName	Es el nombre del servicio que activó el evento. Heredado de la propiedad Event.serviceName
slot	Es el espacio publicitario que activó el evento. Heredado de la propiedad Event.slot

Ejemplo

JavaScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the video in a rewarded ad slot has
  // finished playing.
  googletag.pubads().addEventListener("rewardedSlotVideoCompleted", (event) => {
    const slot = event.slot;
    console.log("Video in rewarded ad slot", slot.getSlotElementId(), "has finished playing.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

TypeScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the video in a rewarded ad slot has
  // finished playing.
  googletag.pubads().addEventListener("rewardedSlotVideoCompleted", (event) => {
    const slot = event.slot;
    console.log("Video in rewarded ad slot", slot.getSlotElementId(), "has finished playing.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

Consulta también

• Objetos de escucha de eventos de anuncios
• Muestra un anuncio recompensado

---

googletag.events.SlotOnloadEvent

Extiende Event

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 síncrona, no se usa ningún iframe, por lo que no se activará ningún SlotOnloadEvent.

Propiedades
serviceName	Es el nombre del servicio que activó el evento. Heredado de la propiedad Event.serviceName
slot	Es el espacio publicitario que activó el evento. Heredado de la propiedad Event.slot

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.
  }
});

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

• Objetos de escucha de eventos de anuncios

---

googletag.events.SlotRenderEndedEvent

Extiende Event

Este evento se activa cuando el código de la creatividad se inserta 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 se terminaron de cargar todos los recursos de creatividad de un espacio publicitario, considera usar events.SlotOnloadEvent.

Propiedades
advertiserId	Es el ID del anunciante del anuncio renderizado.
campaignId	Es el ID de la campaña del anuncio renderizado.
companyIds	Son los IDs de las empresas que ofertaron por el anuncio de reabastecimiento renderizado.
creativeId	Es el ID de creatividad del anuncio de reservación renderizado.
creativeTemplateId	Es el ID de la plantilla de creatividad del anuncio de reservación renderizado.
isBackfill	Indica si un anuncio era de reabastecimiento.
isEmpty	Indica si se devolvió un anuncio para el espacio publicitario.
labelIds	Obsoleto.
lineItemId	Es el ID de artículo pedido del anuncio de reservación renderizado.
responseIdentifier	El identificador de respuesta es un identificador único para la respuesta de solicitud de anuncio.
serviceName	Es el nombre del servicio que activó el evento. Heredado de la propiedad Event.serviceName
size	Indica el tamaño en píxeles de la creatividad renderizada.
slot	Es el espacio publicitario que activó el evento. Heredado de la propiedad Event.slot
slotContentChanged	Indica si el contenido del espacio publicitario se cambió con el anuncio renderizado.
sourceAgnosticCreativeId	Es el ID de la creatividad del anuncio de reservación o reabastecimiento renderizado.
sourceAgnosticLineItemId	Es el ID de artículo pedido del anuncio de reservación o reabastecimiento renderizado.
yieldGroupIds	Son los 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("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("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

• Objetos de escucha de eventos de anuncios

Propiedades

---

advertiserId

advertiserId: 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 renderizadas por servicios que no sean PubAdsService.

---

campaignId

campaignId: number

Es el ID de la campaña del anuncio renderizado. El valor es null para los espacios vacíos, los anuncios de reabastecimiento y las creatividades renderizadas por servicios que no sean PubAdsService.

---

companyIds

companyIds: number[]

Son los IDs de las empresas que ofertaron por el anuncio de reabastecimiento renderizado. El valor es null para los espacios vacíos, los anuncios de reservación y las creatividades renderizadas por servicios que no sean PubAdsService.

---

creativeId

creativeId: number

Es el ID de creatividad del anuncio de reservación renderizado. El valor es null para los espacios vacíos, los anuncios de reabastecimiento y las creatividades renderizadas por servicios que no sean PubAdsService.

---

creativeTemplateId

creativeTemplateId: number

Es el ID de la plantilla de creatividad del anuncio de reservación renderizado. El valor es null para los espacios vacíos, los anuncios de reabastecimiento y las creatividades renderizadas por servicios que no sean PubAdsService.

---

isBackfill

isBackfill: boolean

Indica si un anuncio era de reabastecimiento. El valor es true si el anuncio era de reabastecimiento; de lo contrario, es false.

---

isEmpty

isEmpty: boolean

Indica si se devolvió un anuncio para el espacio publicitario. El valor es true si no se devolvió ningún anuncio; de lo contrario, es false.

---

labelIds

labelIds: number[]

Obsoleto: Este campo ya no se propaga.

---

lineItemId

lineItemId: number

Es el ID de artículo pedido del anuncio de reservación renderizado. El valor es null para los espacios vacíos, los anuncios de reabastecimiento y las creatividades renderizadas por servicios que no sean PubAdsService.

---

responseIdentifier

responseIdentifier: string

El identificador de respuesta es un identificador único para la respuesta de solicitud de anuncio. Este valor se puede utilizar para identificar y bloquear el anuncio en el Centro de revisión de anuncios (ARC).

---

size

size: string | number[]

Indica el tamaño en píxeles de la creatividad renderizada. Ejemplo: [728, 90]. El valor es null para los espacios publicitarios vacíos.

---

slotContentChanged

slotContentChanged: boolean

Indica si el contenido del espacio publicitario se cambió con el anuncio renderizado. El valor es true si se modificó el contenido; de lo contrario, es false.

---

sourceAgnosticCreativeId

sourceAgnosticCreativeId: number

Es el ID de la creatividad del anuncio de reservación o reabastecimiento renderizado. El valor es null si el anuncio no es un reabastecimiento de línea de pedido o de reservación, o si la creatividad se renderiza con servicios que no son PubAdsService.

---

sourceAgnosticLineItemId

sourceAgnosticLineItemId: number

Es el ID de artículo pedido del anuncio de reservación o reabastecimiento renderizado. El valor es null si el anuncio no es un reabastecimiento de línea de pedido o de reservación, o si la creatividad se renderiza con servicios que no son PubAdsService.

---

yieldGroupIds

yieldGroupIds: number[]

Son los 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 renderizadas por servicios que no sean PubAdsService.

---

googletag.events.SlotRequestedEvent

Extiende Event

Este evento se activa cuando se solicita un anuncio para un espacio publicitario en particular.

Propiedades
serviceName	Es el nombre del servicio que activó el evento. Heredado de la propiedad Event.serviceName
slot	Es el espacio publicitario que activó el evento. Heredado de la propiedad Event.slot

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.
  }
});

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

• Objetos de escucha de eventos de anuncios

---

googletag.events.SlotResponseReceived

Extiende Event

Este evento se activa cuando se recibe una respuesta de anuncio para un espacio publicitario específico.

Propiedades
serviceName	Es el nombre del servicio que activó el evento. Heredado de la propiedad Event.serviceName
slot	Es el espacio publicitario que activó el evento. Heredado de la propiedad Event.slot

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.
  }
});

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

• Objetos de escucha de eventos de anuncios

---

googletag.events.SlotVisibilityChangedEvent

Extiende Event

Este evento se activa cada vez que cambia el porcentaje en pantalla del área de un espacio publicitario. El evento se limita y no se activará más de una vez cada 200 ms.

Propiedades
inViewPercentage	Es el porcentaje del área del anuncio que es visible.
serviceName	Es el nombre del servicio que activó el evento. Heredado de la propiedad Event.serviceName
slot	Es el espacio publicitario que activó el evento. Heredado de la propiedad Event.slot

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.
  }
});

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

• Objetos de escucha de eventos de anuncios

Propiedades

---

inViewPercentage

inViewPercentage: number

Es el porcentaje del área del anuncio que es visible. El valor es un número entre 0 y 100.

---

googletag.secureSignals

Este es el espacio de nombres que usa GPT para administrar los indicadores seguros.

Interfaces
BidderSignalProvider	Devuelve un indicador seguro para un ofertante específico.
PublisherSignalProvider	Devuelve un indicador seguro para un publicador específico.
SecureSignalProvidersArray	Es una interfaz para administrar indicadores seguros.

Alias de tipo
SecureSignalProvider	Es la interfaz para devolver un indicador seguro para un ofertante o proveedor específico.

Alias de tipo

---

SecureSignalProvider

SecureSignalProvider: BidderSignalProvider | PublisherSignalProvider

Es la interfaz para devolver un indicador seguro para un ofertante o proveedor específico. Se debe proporcionar id o networkCode, pero no ambos.

---

googletag.secureSignals.BidderSignalProvider

Devuelve un indicador seguro para un ofertante específico.

Un proveedor de indicadores seguros de ofertante consta de 2 partes:

1. Es una función de recopilador que devuelve un objeto Promise que se resuelve en un indicador seguro.
2. Un id que identifica al ofertante asociado con el indicador

Para devolver un indicador seguro para un publicador, usa secureSignals.PublisherSignalProvider en su lugar.

Propiedades
collectorFunction	Es una función que devuelve un Promise que se resuelve en un indicador seguro.
id	Es un identificador único para el recopilador asociado con este indicador seguro, según se registró en Google Ad Manager.

Ejemplo

JavaScript

// id is provided
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: () => {
    // ...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

• Cómo compartir indicadores seguros con los ofertantes

Propiedades

---

collectorFunction

collectorFunction: (() => Promise<string>)

Es una función que devuelve un Promise que se resuelve en un indicador seguro.

---

id

id: string

Es un identificador único para el recopilador asociado con este indicador seguro, según se registró en Google Ad Manager.

---

googletag.secureSignals.PublisherSignalProvider

Devuelve un indicador seguro para un publicador específico.

Un proveedor de indicadores del publicador consta de 2 partes:

1. Es una función de recopilador que devuelve un objeto Promise que se resuelve en un indicador seguro.
2. Un networkCode que identifica al publicador asociado con el indicador

Para devolver un indicador seguro para un ofertante, usa secureSignals.BidderSignalProvider en su lugar.

Propiedades
collectorFunction	Es una función que devuelve un Promise que se resuelve en un indicador seguro.
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");
  },
});

TypeScript

// networkCode is provided
googletag.secureSignalProviders!.push({
  networkCode: "123456",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

Consulta también

• Cómo compartir indicadores seguros con los ofertantes

Propiedades

---

collectorFunction

collectorFunction: (() => Promise<string>)

Es una función que devuelve un Promise que se resuelve en un indicador seguro.

---

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

Es una interfaz para administrar indicadores seguros.

Métodos
clearAllCache	Borra todos los indicadores de todos los recopiladores de la caché.
push	Agrega un nuevo secureSignals.SecureSignalProvider al array de proveedores de indicadores y comienza el proceso de generación de indicadores.

Métodos

---

clearAllCache

clearAllCache(): void

Borra todos los indicadores de todos los recopiladores de la caché.

Si se llama a este método, es posible que se reduzca la probabilidad de que se incluyan indicadores en las solicitudes de anuncios para las vistas de página actuales y, posiblemente, posteriores. Por lo tanto, solo se debe llamar cuando se producen cambios de estado significativos, como eventos que indican un usuario nuevo (inicio o cierre de sesión, registro, etcétera).

---

push

push(provider: SecureSignalProvider): void

Agrega un nuevo secureSignals.SecureSignalProvider al array de proveedores de indicadores y comienza el proceso de generación de indicadores.

Parámetros
provider: SecureSignalProvider	Es el objeto secureSignals.SecureSignalProvider que se agregará al array.