Referencia de GPT

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

Expresión de tipo
string Es el tipo de cadena primitiva.
string[] Es 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 un tipo complejo (unión).
[number, string] Es un tipo de tupla en el que el valor es un array de dos elementos que debe contener un número y una cadena en ese orden.
Slot Es un tipo de objeto en el que el valor es una instancia de googletag.Slot.
() => void Es un tipo de función sin argumentos definidos y sin 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 denotan 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 las 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 los parámetros y las propiedades.
...params: Array<() => void> Indica que params es un parámetro de resto que acepta funciones. Los parámetros de resto aceptan una cantidad ilimitada de valores del tipo especificado.

googletag

Es el espacio de nombres global que usa la etiqueta de Google Publisher 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 GPT usa para los eventos.
secureSignals
Este es el espacio de nombres que usa GPT para administrar 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 para publicadores.
ResponseInformation
Es un objeto que representa una sola respuesta del anuncio.
RewardedPayload
Objeto que representa la recompensa asociada con un anuncio recompensado.
Service
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ños.
Slot
Slot es un objeto que representa un solo espacio publicitario en una página.
Alias de tipo
GeneralSize
Es una configuración de tamaño válida para un espacio, que puede ser de uno o varios tamaños.
MultiSize
Es una lista de tamaños válidos únicos.
NamedSize
Son los tamaños con nombre que puede tener una ranura.
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ños.
Variables
apiReady
Es una marca que indica que la API de GPT se cargó y está lista para llamarse.
cmd
Es una referencia a la cola de comandos global para la ejecución asíncrona de llamadas relacionadas con GPT.
pubadsReady
Es una marca que indica que PubAdsService está habilitado, cargado y en pleno funcionamiento.
secureSignalProviders
Es una referencia al array de proveedores de indicadores seguros.
Funciones
companionAds
Devuelve una referencia a CompanionAdsService.
defineOutOfPageSlot
Construye un espacio publicitario fuera de página con la ruta de acceso de la unidad de anuncios proporcionada.
defineSlot
Construye una unidad de anuncios con una ruta y un tamaño determinados, y la asocia con el ID de un elemento div en la página que contendrá el anuncio.
destroySlots
Destruye los segmentos proporcionados y quita todos los objetos y las referencias relacionados de esos segmentos de GPT.
disablePublisherConsole
Inhabilita la Consola para publicadores de Google.
display
Indica a los servicios de ranuras que rendericen la ranura.
enableServices
Habilita todos los servicios de GPT que se definieron para los espacios publicitarios de la página.
getConfig
Obtiene las opciones de configuración generales para el conjunto de páginas establecido por setConfig.
getVersion
Devuelve la versión actual de GPT.
openConsole
Abre la Consola para publicadores de Google.
pubads
Devuelve una referencia a PubAdsService.
setAdIframeTitle
Establece el título para todos los elementos iframe del contenedor de anuncios creados por PubAdsService, a partir de este punto.
setConfig
Establece opciones de configuración generales para la página.
sizeMapping
Crea un nuevo SizeMappingBuilder.

Alias de tipo

GeneralSize

GeneralSize: SingleSize | MultiSize
Es una configuración de tamaño válida para un espacio, que puede ser de uno o varios tamaños.

MultiSize

MultiSize: SingleSize[]
Es una lista de tamaños válidos únicos.

NamedSize

NamedSize: "fluid" | ["fluid"]
Son los tamaños con nombre que puede tener una ranura. En la mayoría de los casos, el tamaño es un rectángulo de tamaño fijo, pero hay algunos casos en los que necesitamos otros tipos de especificaciones de tamaño. Solo son válidos los siguientes tamaños con nombre:
  • Flexible: El contenedor de anuncios ocupa el 100% del ancho del elemento div principal y, luego, cambia el tamaño de su altura para que se ajuste al contenido de la creatividad. Se comporta de manera similar a los elementos de bloque normales en una página. Se usa para los anuncios nativos (consulta el artículo relacionado). Ten en cuenta que tanto fluid como ['fluid'] son formas aceptables de declarar el tamaño de una ranura como fluido.

SingleSize

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

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

SizeMappingArray

SizeMappingArray: SizeMapping[]
Es una lista de asignaciones de tamaños.

Variables

Const apiReady

apiReady: boolean | undefined
Es una marca que indica que la API de GPT se cargó y está lista para llamarse. Esta propiedad será simplemente undefined hasta que la API esté lista.

Ten en cuenta que la forma recomendada de controlar la asincronía es usar googletag.cmd para poner en cola las devoluciones de llamada para cuando GPT esté listo. No es necesario que estas devoluciones de llamada verifiquen googletag.apiReady, ya que se garantiza que se ejecutarán una vez que se configure la API.

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 variable googletag.cmd se inicializa en un array de JavaScript vacío con la sintaxis de la etiqueta de GPT en la página, y cmd.push es el método Array.push estándar que agrega un elemento al final del array. Cuando se carga el código JavaScript de GPT, se revisa el array y se ejecutan 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 recuperando 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());
});

JavaScript (heredado)

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

TypeScript

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

Const pubadsReady

pubadsReady: boolean | undefined
Es una marca que indica que PubAdsService está habilitado, cargado y en pleno funcionamiento. 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. Está diseñado para reemplazar un array estándar que se usa para poner en cola funciones de generación de indicadores que se invocarán una vez que se cargue GPT.
Ejemplo

JavaScript

window.googletag = window.googletag || { cmd: [] };
googletag.secureSignalProviders = googletag.secureSignalProviders || [];
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: () => {
    return Promise.resolve("signal");
  },
});

JavaScript (heredado)

window.googletag = window.googletag || { cmd: [] };
googletag.secureSignalProviders = googletag.secureSignalProviders || [];
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: function () {
    return Promise.resolve("signal");
  },
});

TypeScript

window.googletag = window.googletag || { cmd: [] };
googletag.secureSignalProviders = googletag.secureSignalProviders || [];
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: () => {
    return Promise.resolve("signal");
  },
});
Consulta también

Funciones

companionAds

companionAds(): CompanionAdsService
Devuelve una referencia a CompanionAdsService.
Muestra
CompanionAdsServiceServicio de anuncios complementarios

defineOutOfPageSlot

defineOutOfPageSlot(adUnitPath: string, div?: string | OutOfPageFormat): Slot | null
Construye un espacio publicitario fuera de página con la ruta de acceso a la unidad de anuncios proporcionada.

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

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

JavaScript (heredado)

// Define a custom out-of-page ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", "div-1");

// Define a GPT managed web interstitial ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);

TypeScript

// Define a custom out-of-page ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", "div-1");

// Define a GPT managed web interstitial ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
Consulta también
Parámetros
adUnitPath: stringRuta de unidad de anuncios completa con el código de red y el código de unidad de anuncios.
Optional div: string | OutOfPageFormatEs el ID de la división que contendrá esta unidad de anuncios o este OutOfPageFormat.
Muestra
Slot | nullEs la ranura recién creada o null si no se puede crear una ranura.

defineSlot

defineSlot(adUnitPath: string, size: GeneralSize, div?: string): Slot | null
Construye una unidad de anuncios con una ruta y un tamaño determinados, y la asocia con el ID de un elemento div en la página que contendrá el anuncio.
Ejemplo

JavaScript

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

JavaScript (heredado)

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

TypeScript

googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
Consulta también
Parámetros
adUnitPath: stringRuta de unidad de anuncios completa con el código de red y el código de unidad.
size: GeneralSizeAncho y altura de la ranura agregada. Este es el tamaño que se usa en la solicitud de anuncio si no se proporciona una asignación de tamaño responsiva o si el tamaño del viewport es más pequeño que el tamaño más pequeño proporcionado en la asignación.
Optional div: stringID del div que contendrá esta unidad de anuncios.
Muestra
Slot | nullEs la ranura recién creada o null si no se puede crear una ranura.

destroySlots

destroySlots(slots?: Slot[]): boolean
Destruye los segmentos proporcionados y quita todos los objetos y las referencias relacionados de esos segmentos de GPT. Esta API no admite espacios de devolución ni espacios complementarios.

Si se llama a esta API en un espacio, se borra el anuncio y se quita el objeto del espacio del estado interno que mantiene GPT. Llamar a más funciones en el objeto de ranura generará un comportamiento indefinido. Ten en cuenta que es posible que el navegador no libere la memoria asociada a ese espacio si la página del publicador mantiene una referencia a él. Llamar a esta API hace que el div asociado a ese espacio esté disponible para su reutilización.

En particular, destruir 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 afectadas por bloqueos de ruta ni exclusiones de la competencia que involucren a este anuncio. Si no se llama a esta función antes de quitar el div de una ranura 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();

JavaScript (heredado)

// The calls to construct an ad and display contents.
var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to destroy only slot1.
googletag.destroySlots([slot1]);

// This call to destroy both slot1 and slot2.
googletag.destroySlots([slot1, slot2]);

// This call to destroy all slots.
googletag.destroySlots();

TypeScript

// The calls to construct an ad and display contents.
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!;
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!;
googletag.display("div-2");

// This call to destroy only slot1.
googletag.destroySlots([slot1]);

// This call to destroy both slot1 and slot2.
googletag.destroySlots([slot1, slot2]);

// This call to destroy all slots.
googletag.destroySlots();
Parámetros
Optional slots: Slot[]Es el array de espacios vacíos que se destruirán. El array es opcional; si no se especifica, se destruirán todos los espacios.
Muestra
booleantrue si se destruyeron ranuras, false en caso contrario.

disablePublisherConsole

disablePublisherConsole(): void
Inhabilita la Consola para publicadores de Google.
Consulta también

pantalla

display(divOrSlot: string | Element | Slot): void
Indica a los servicios de ranuras que rendericen la ranura. Cada espacio publicitario solo debe mostrarse una vez por página. Todas las ranuras deben definirse y tener un servicio asociado antes de mostrarse. La llamada de visualización no debe ocurrir hasta que el elemento esté presente en el DOM. La forma habitual de lograrlo es colocarlo dentro de un bloque de secuencia de comandos dentro del elemento div que se nombra en la llamada al método.

Si se utiliza la arquitectura de solicitud única (SRA), todos los espacios publicitarios no recuperados en el momento en que se llama a este método se recuperarán de una sola vez. Para forzar que no se muestre un espacio publicitario, se debe quitar todo el elemento div.
Consulta también
Parámetros
divOrSlot: string | Element | SlotEs 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 pasó 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[]): Pick<PageSettingsConfig, "adsenseAttributes" | "disableInitialLoad" | "targeting">
Obtiene las opciones de configuración generales de la página establecidas por setConfig.

Este método no admite todas las propiedades de setConfig(). Las propiedades admitidas son las siguientes:
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"]);

JavaScript (heredado)

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

// Get the value of the `adsenseAttributes` and `disableInitialLoad` settings.
var 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 obtendrán.
Muestra
Pick<PageSettingsConfig, "adsenseAttributes" | "disableInitialLoad" | "targeting">Son las opciones de configuración de la ranura.

getVersion

getVersion(): string
Devuelve la versión actual de GPT.
Consulta también
Muestra
stringEs la cadena de 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();

JavaScript (heredado)

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

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

TypeScript

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

// Calling without div ID.
googletag.openConsole();
Consulta también
Parámetros
Optional div: stringEs el ID de un elemento div de 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 a PubAdsService.
Muestra
PubAdsServiceEs el servicio de Publisher Ads.

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

JavaScript (heredado)

googletag.setAdIframeTitle("title");

TypeScript

googletag.setAdIframeTitle("title");
Parámetros
title: stringEs el título nuevo para todos los elementos iframe del contenedor de anuncios.

setConfig

setConfig(config: PageSettingsConfig): void
Establece opciones de configuración generales para la página.
Parámetros
config: PageSettingsConfig

sizeMapping

sizeMapping(): SizeMappingBuilder
Crea un nuevo SizeMappingBuilder.
Consulta también
Muestra
SizeMappingBuilderUn nuevo compilador.

googletag.CommandArray

El array de comandos acepta una secuencia de funciones y las invoca en orden. Está diseñado para 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());
});

JavaScript (heredado)

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

TypeScript

googletag.cmd.push(() => {
  googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads());
});
Parámetros
Rest ...f: ((this: typeof globalThis) => void)[]Es una función de JavaScript que se ejecutará. La vinculación en el tiempo de ejecución siempre será globalThis. Considera pasar una función de flecha para conservar el valor de this del contexto léxico circundante.
Muestra
numberEs la cantidad de comandos procesados hasta el momento. Esto es compatible con el valor de retorno de 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 ocurre un evento de GPT específico en la página.
getSlots
Obtén la lista de ranuras asociadas a este servicio.
removeEventListener
Quita un objeto de escucha registrado anteriormente.
setRefreshUnfilledSlots
Establece si los espacios publicitarios complementarios que no se completaron se reabastecerán automáticamente.
Consulta también

Métodos

setRefreshUnfilledSlots

setRefreshUnfilledSlots(value: boolean): void
Establece si los espacios publicitarios 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 publicitarios que también estén registrados en PubAdsService. Debido a las restricciones de políticas, este método no está diseñado para completar espacios complementarios vacíos cuando se publica un video de Ad Exchange.
Ejemplo

JavaScript

googletag.companionAds().setRefreshUnfilledSlots(true);

JavaScript (heredado)

googletag.companionAds().setRefreshUnfilledSlots(true);

TypeScript

googletag.companionAds().setRefreshUnfilledSlots(true);
Parámetros
value: booleantrue para completar automáticamente los espacios vacíos, 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 contenido dirigido a niños.
limitedAds?
Habilita la publicación para que se ejecute en el modo de anuncios limitados y, así, satisfacer las necesidades de cumplimiento de las 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 reglamentario de los publicadores.
restrictDataProcessing?
Permite que la publicación se ejecute en el modo de procesamiento restringido para ayudar a los publicadores a cumplir con los requisitos reglamentarios.
trafficSource?
Indica si las solicitudes representan tráfico comprado o tráfico 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

Propiedades

Optional childDirectedTreatment

childDirectedTreatment?: boolean
Indica si la página se debe tratar como contenido dirigido a niños. Configúralo como null para borrar la configuración.

Optional limitedAds

limitedAds?: boolean
Permite que la publicación se ejecute en el modo de anuncios limitados para ayudar a los publicadores a cumplir con los requisitos reglamentarios.

Puedes indicarle a GPT que solicite anuncios limitados de dos maneras:
  • Automáticamente, a través de 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
La configuración manual de los anuncios limitados solo es posible 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,
});

JavaScript (heredado)

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

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 reglamentario de los publicadores.

Optional restrictDataProcessing

restrictDataProcessing?: boolean
Permite que la publicación se ejecute en el modo de procesamiento restringido para ayudar a los publicadores a cumplir con los requisitos reglamentarios.

Optional trafficSource

trafficSource?: TrafficSource
Indica si las solicitudes representan tráfico comprado o tráfico orgánico. Este valor completa la dimensión Fuente de tráfico en los informes de Ad Manager. Si no se configura, 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,
});

JavaScript (heredado)

// Indicate requests represent organic traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.ORGANIC,
});

// Indicate requests represent purchased traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.PURCHASED,
});

TypeScript

// Indicate requests represent organic traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.ORGANIC,
});

// Indicate requests represent purchased traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.PURCHASED,
});

Optional underAgeOfConsent

underAgeOfConsent?: boolean
Indica si se deben marcar las solicitudes de anuncios como provenientes de usuarios que no alcanzan la edad de consentimiento. Configúralo como null para borrar la configuración.

googletag.PubAdsService

Extiende Service
Servicio de Anuncios para publicadores. 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 ocurre un evento de GPT específico en la página.
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 personalizados para una clave específica o para todas las claves.
collapseEmptyDivs
Obsoleto. Habilita la contracción de los elementos div de espacios para que no ocupen espacio en la página cuando no haya contenido del anuncio para mostrar.
disableInitialLoad
Obsoleto. Inhabilita las solicitudes de anuncios en la carga de 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 de acceso 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 ranuras asociadas a este servicio.
getTargeting
Obsoleto. Devuelve un parámetro de segmentación personalizado específico a nivel del servicio que se configuró.
getTargetingKeys
Obsoleto. Devuelve la lista de todas las claves de segmentación personalizadas a nivel del servicio que se configuraron.
isInitialLoadDisabled
Obsoleto. Devuelve un valor que indica si se inhabilitaron correctamente las solicitudes iniciales de anuncios con una llamada anterior a PubAdsService.disableInitialLoad.
refresh
Recupera y muestra anuncios nuevos para espacios específicos o todos los espacios de la página.
removeEventListener
Quita un objeto de escucha registrado anteriormente.
set
Obsoleto. Establece valores para los atributos de AdSense que se aplican a todos los espacios publicitarios del servicio Publisher Ads.
setCategoryExclusion
Obsoleto. Establece una exclusión de categoría de anuncio a nivel de la página para el nombre de etiqueta determinado.
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 información de ubicación de los sitios web para que puedas segmentar geográficamente las líneas de pedido hacia ubicaciones específicas.
setPrivacySettings
Permite configurar todos los parámetros de 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 personalizados para una clave determinada que se aplican a todos los espacios publicitarios del servicio de Publisher Ads.
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 correlacionador que se envía con las solicitudes de anuncios, lo que inicia una nueva vista de página.

Métodos

borrar

clear(slots?: Slot[]): boolean
Quita los anuncios de los espacios determinados y los reemplaza por contenido en blanco. Las ranuras se marcarán como no recuperadas.

En particular, borrar una ranura 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 bloqueos ni exclusiones competitivas que involucren este anuncio.
Ejemplo

JavaScript

const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to clear only slot1.
googletag.pubads().clear([slot1]);

// This call to clear both slot1 and slot2.
googletag.pubads().clear([slot1, slot2]);

// This call to clear all slots.
googletag.pubads().clear();

JavaScript (heredado)

var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to clear only slot1.
googletag.pubads().clear([slot1]);

// This call to clear both slot1 and slot2.
googletag.pubads().clear([slot1, slot2]);

// This call to clear all slots.
googletag.pubads().clear();

TypeScript

const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!;
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!;
googletag.display("div-2");

// This call to clear only slot1.
googletag.pubads().clear([slot1]);

// This call to clear both slot1 and slot2.
googletag.pubads().clear([slot1, slot2]);

// This call to clear all slots.
googletag.pubads().clear();
Parámetros
Optional slots: Slot[]Es el array de ranuras que se borrarán. El array es opcional; si no se especifica, se borrarán todos los espacios.
Muestra
booleanDevuelve true si se borraron los segmentos, y false en caso contrario.

clearCategoryExclusions

clearCategoryExclusions(): PubAdsService
Borra todas las etiquetas de exclusión de categorías de anuncios a nivel de la página. Esto es útil si deseas actualizar la ranura.
Ejemplo

JavaScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.pubads().setCategoryExclusion("AirlineAd");

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

// Clear category exclusions so all ads can be returned.
googletag.pubads().clearCategoryExclusions();

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

JavaScript (heredado)

// Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.pubads().setCategoryExclusion("AirlineAd");

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

// Clear category exclusions so all ads can be returned.
googletag.pubads().clearCategoryExclusions();

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

TypeScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.pubads().setCategoryExclusion("AirlineAd");

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

// Clear category exclusions so all ads can be returned.
googletag.pubads().clearCategoryExclusions();

// Make ad requests. Any ad can be returned.
Consulta también
Muestra
PubAdsServiceEs el objeto de servicio en el que se llamó al método.

clearTargeting

clearTargeting(key?: string): PubAdsService
Borra los parámetros de segmentación personalizados para una clave específica o para todas las claves.
Ejemplo

JavaScript

googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");
googletag.pubads().setTargeting("fruits", "apple");

googletag.pubads().clearTargeting("interests");
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.pubads().clearTargeting();
// All targeting has been cleared.

JavaScript (heredado)

googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");
googletag.pubads().setTargeting("fruits", "apple");

googletag.pubads().clearTargeting("interests");
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.pubads().clearTargeting();
// All targeting has been cleared.

TypeScript

googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");
googletag.pubads().setTargeting("fruits", "apple");

googletag.pubads().clearTargeting("interests");
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.pubads().clearTargeting();
// All targeting has been cleared.
Consulta también
Parámetros
Optional key: stringEs la clave del parámetro de segmentación. La clave es opcional. Si no se especifica, se borrarán todos los parámetros de segmentación.
Muestra
PubAdsServiceEs el objeto de servicio en el que se llamó al método.

collapseEmptyDivs

collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean
Permite contraer los elementos div de los espacios para que no ocupen espacio en la página cuando no haya contenido del anuncio para mostrar. Este modo se debe establecer antes de habilitar el servicio.
Consulta también
Parámetros
Optional collapseBeforeAdFetch: booleanIndica si se deben contraer los espacios incluso antes de que se recuperen los anuncios. Este parámetro es opcional. Si no se proporciona, se usará false como valor predeterminado.
Muestra
booleanDevuelve true si se habilitó el modo de contraer la división y false si es imposible habilitar el modo de contraer porque se llamó al método después de que se habilitó el servicio.

disableInitialLoad

disableInitialLoad(): void
Inhabilita las solicitudes de anuncios cuando se carga la página, pero permite que se soliciten anuncios con una llamada a PubAdsService.refresh. Este parámetro se debe configurar antes de habilitar el servicio. Se debe usar el modo asíncrono. De lo contrario, será imposible solicitar anuncios con refresh.
Consulta también

pantalla

display(adUnitPath: string, size: GeneralSize, div?: string | Element, clickUrl?: string): void
Construye y muestra un espacio publicitario con la ruta de acceso y el tamaño de la unidad de anuncios proporcionados. Este método no funciona con el modo de solicitud única.

Nota: Cuando se llama a este método, se crea una instantánea del estado de la ranura y la página para garantizar la coherencia cuando se envía la solicitud de anuncio y se renderiza la respuesta. Cualquier cambio que se realice en el estado de la ranura o la página después de que se llame a este método (incluida la segmentación, la configuración de privacidad, la aplicación forzada de SafeFrame, etcétera) solo se aplicará a las solicitudes posteriores de display() o refresh().
Ejemplo

JavaScript

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

JavaScript (heredado)

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

TypeScript

googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
Consulta también
Parámetros
adUnitPath: stringEs la ruta de acceso a la unidad de anuncios del espacio que se renderizará.
size: GeneralSizeAncho y altura de la ranura.
Optional div: string | ElementEs el ID de la división que contiene el espacio o el elemento de división en sí.
Optional clickUrl: stringEs 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.
Ejemplo

JavaScript

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

JavaScript (heredado)

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

TypeScript

googletag.pubads().enableLazyLoad({
  // Fetch slots within 5 viewports.
  fetchMarginPercent: 500,
  // Render slots within 2 viewports.
  renderMarginPercent: 200,
  // Double the above values on mobile.
  mobileScaling: 2.0,
});
Consulta también
Parámetros
Optional config: {
  fetchMarginPercent?: number;
  mobileScaling?: number;
  renderMarginPercent?: number;
}		El objeto de configuración permite personalizar el comportamiento de carga diferida. Las configuraciones omitidas usarán un conjunto 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 desde el viewport actual a la que debe estar un espacio antes de que recuperemos el anuncio, expresada como un porcentaje del tamaño del viewport. Un valor de 0 significa "cuando la ranura ingresa en el viewport", 100 significa "cuando el anuncio está a 1 viewport de distancia", y así sucesivamente.
  • renderMarginPercent

    Es la distancia mínima desde el viewport actual a la que debe estar una posición antes de que rendericemos un anuncio. Esto permite realizar la recuperación previa del anuncio, pero espera para renderizar y descargar otros recursos secundarios. El valor funciona igual que fetchMarginPercent como porcentaje de la ventana gráfica.
  • mobileScaling

    Es un multiplicador que se aplica a los márgenes en dispositivos móviles. Esto permite variar los márgenes 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 una ranura antes de recuperar y renderizar.

enableSingleRequest

enableSingleRequest(): boolean
Habilita el modo de solicitud única para recuperar varios anuncios al mismo tiempo. Esto requiere que todos los espacios de anuncios de publicador se definan y agreguen a PubAdsService antes de habilitar el servicio. El modo de solicitud única se debe establecer antes de habilitar el servicio.
Consulta también
Muestra
booleanDevuelve true si se habilitó el modo de solicitud única y false si es imposible habilitar el modo de solicitud única 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 de la competencia en los anuncios gráficos y de video. Si se conoce el contenido del video, llama a PubAdsService.setVideoContent para poder usar la exclusión de contenido para los anuncios gráficos.

get

get(key: string): string
Devuelve el valor del atributo de AdSense asociado a la clave determinada.
Ejemplo

JavaScript

googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().get("adsense_background_color");
// Returns '#FFFFFF'.

JavaScript (heredado)

googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().get("adsense_background_color");
// Returns '#FFFFFF'.

TypeScript

googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().get("adsense_background_color");
// Returns '#FFFFFF'.
Consulta también
Parámetros
key: stringNombre del atributo que se buscará.
Muestra
stringValor actual de la clave del atributo o null si la clave no está presente.

getAttributeKeys

getAttributeKeys(): string[]
Devuelve las claves de atributo que se configuraron en este servicio.
Ejemplo

JavaScript

googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().set("adsense_border_color", "#AABBCC");
googletag.pubads().getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].

JavaScript (heredado)

googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().set("adsense_border_color", "#AABBCC");
googletag.pubads().getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].

TypeScript

googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().set("adsense_border_color", "#AABBCC");
googletag.pubads().getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].
Muestra
string[]Es un array de claves de atributos establecidas en este servicio. El orden no está definido.

getTargeting

getTargeting(key: string): string[]
Devuelve un parámetro de segmentación personalizado específico a nivel del servicio que se configuró.
Ejemplo

JavaScript

googletag.pubads().setTargeting("interests", "sports");

googletag.pubads().getTargeting("interests");
// Returns ['sports'].

googletag.pubads().getTargeting("age");
// Returns [] (empty array).

JavaScript (heredado)

googletag.pubads().setTargeting("interests", "sports");

googletag.pubads().getTargeting("interests");
// Returns ['sports'].

googletag.pubads().getTargeting("age");
// Returns [] (empty array).

TypeScript

googletag.pubads().setTargeting("interests", "sports");

googletag.pubads().getTargeting("interests");
// Returns ['sports'].

googletag.pubads().getTargeting("age");
// Returns [] (empty array).
Parámetros
key: stringEs 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 tal clave.

getTargetingKeys

getTargetingKeys(): string[]
Devuelve la lista de todas las claves de segmentación personalizadas a nivel del servicio que se configuraron.
Ejemplo

JavaScript

googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");

googletag.pubads().getTargetingKeys();
// Returns ['interests', 'colors'].

JavaScript (heredado)

googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");

googletag.pubads().getTargetingKeys();
// Returns ['interests', 'colors'].

TypeScript

googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");

googletag.pubads().getTargetingKeys();
// Returns ['interests', 'colors'].
Muestra
string[]Es un array de claves de segmentación. El orden no está definido.

isInitialLoadDisabled

isInitialLoadDisabled(): boolean
Devuelve si una llamada anterior a PubAdsService.disableInitialLoad inhabilitó correctamente las solicitudes iniciales de anuncios.
Muestra
booleanDevuelve 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íncrono.

Para que funcione correctamente en todos los navegadores, la llamada a refresh debe estar precedida por una llamada a display la ranura del anuncio. 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 los bloqueos ni las exclusiones de la competencia que involucren a ese anuncio.
Ejemplo

JavaScript

const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to refresh fetches a new ad for slot1 only.
googletag.pubads().refresh([slot1]);

// This call to refresh fetches a new ad for both slot1 and slot2.
googletag.pubads().refresh([slot1, slot2]);

// This call to refresh fetches a new ad for each slot.
googletag.pubads().refresh();

// This call to refresh fetches a new ad for slot1, without changing
// the correlator.
googletag.pubads().refresh([slot1], { changeCorrelator: false });

// This call to refresh fetches a new ad for each slot, without
// changing the correlator.
googletag.pubads().refresh(null, { changeCorrelator: false });

JavaScript (heredado)

var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to refresh fetches a new ad for slot1 only.
googletag.pubads().refresh([slot1]);

// This call to refresh fetches a new ad for both slot1 and slot2.
googletag.pubads().refresh([slot1, slot2]);

// This call to refresh fetches a new ad for each slot.
googletag.pubads().refresh();

// This call to refresh fetches a new ad for slot1, without changing
// the correlator.
googletag.pubads().refresh([slot1], { changeCorrelator: false });

// This call to refresh fetches a new ad for each slot, without
// changing the correlator.
googletag.pubads().refresh(null, { changeCorrelator: false });

TypeScript

const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!;
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!;
googletag.display("div-2");

// This call to refresh fetches a new ad for slot1 only.
googletag.pubads().refresh([slot1]);

// This call to refresh fetches a new ad for both slot1 and slot2.
googletag.pubads().refresh([slot1, slot2]);

// This call to refresh fetches a new ad for each slot.
googletag.pubads().refresh();

// This call to refresh fetches a new ad for slot1, without changing
// the correlator.
googletag.pubads().refresh([slot1], { changeCorrelator: false });

// This call to refresh fetches a new ad for each slot, without
// changing the correlator.
googletag.pubads().refresh(null, { changeCorrelator: false });
Consulta también
Parámetros
Optional slots: Slot[]Son las ranuras que se actualizarán. El array es opcional. Si no se especifica, se actualizarán todos los espacios.
Optional options: {
  changeCorrelator: boolean;
}		Son las opciones de configuración asociadas a esta llamada de actualización.
  • changeCorrelator

    Especifica si se debe generar un correlacionador nuevo para recuperar anuncios. Nuestros servidores de anuncios mantienen este valor de correlator brevemente (actualmente durante 30 segundos, pero sujeto a cambios), de modo que las solicitudes con el mismo correlator que se reciben en un período cercano se considerarán 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 actualmente en la página y no tiene fecha de vencimiento.

set

set(key: string, value: string): PubAdsService
Establece valores para los atributos de AdSense que se aplican a todos los espacios publicitarios del servicio Publisher Ads.

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

JavaScript

googletag.pubads().set("adsense_background_color", "#FFFFFF");

JavaScript (heredado)

googletag.pubads().set("adsense_background_color", "#FFFFFF");

TypeScript

googletag.pubads().set("adsense_background_color", "#FFFFFF");
Consulta también
Parámetros
key: stringEs el nombre del atributo.
value: stringValor del atributo.
Muestra
PubAdsServiceEs 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 determinado.
Ejemplo

JavaScript

// Label = AirlineAd.
googletag.pubads().setCategoryExclusion("AirlineAd");

JavaScript (heredado)

// Label = AirlineAd.
googletag.pubads().setCategoryExclusion("AirlineAd");

TypeScript

// Label = AirlineAd.
googletag.pubads().setCategoryExclusion("AirlineAd");
Consulta también
Parámetros
categoryExclusion: stringEs la etiqueta de exclusión de categorías de anuncios que se agregará.
Muestra
PubAdsServiceEs el objeto de servicio en el que se llamó al método.

setCentering

setCentering(centerAds: boolean): void
Habilita e 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.
Ejemplo

JavaScript

// Make ads centered.
googletag.pubads().setCentering(true);

JavaScript (heredado)

// Make ads centered.
googletag.pubads().setCentering(true);

TypeScript

// Make ads centered.
googletag.pubads().setCentering(true);
Parámetros
centerAds: booleantrue para centrar los anuncios y false para alinearlos a la izquierda.

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): PubAdsService
Configura si todos los anuncios de la página deben renderizarse de forma obligatoria con un contenedor de SafeFrame.

Ten en cuenta lo siguiente cuando uses esta API:
  • Este parámetro de configuración solo tendrá efecto en las solicitudes de anuncios subsiguientes que se realicen para los espacios respectivos.
  • Si se especifica, el parámetro de configuración a nivel del espacio siempre anulará el parámetro de configuración a nivel de la página.
  • Si se configura como true (a nivel del espacio o de la página), el anuncio siempre se renderizará con un contenedor de SafeFrame, independientemente de la elección que se realice en la IU de Google Ad Manager.
  • Sin embargo, si se establece en false o no se especifica, 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 usar con precaución, ya que podría afectar el comportamiento de las creatividades que intentan salir de sus elementos iframe o que dependen de que se rendericen directamente en la página de un publicador.
Ejemplo

JavaScript

googletag.pubads().setForceSafeFrame(true);

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setForceSafeFrame(false)
  .addService(googletag.pubads());

// The following slot will have SafeFrame forced.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

JavaScript (heredado)

googletag.pubads().setForceSafeFrame(true);

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setForceSafeFrame(false)
  .addService(googletag.pubads());

// The following slot will have SafeFrame forced.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

TypeScript

googletag.pubads().setForceSafeFrame(true);

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setForceSafeFrame(false)
  .addService(googletag.pubads());

// The following slot will have SafeFrame forced.
googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");
Consulta también
Parámetros
forceSafeFrame: booleantrue 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 configuras este parámetro como false cuando no se especificó antes, no cambiará nada.
Muestra
PubAdsServiceEs el objeto de servicio en el que se llamó al método.

setLocation

setLocation(address: string): PubAdsService
Pasa información de ubicación de sitios web para que puedas segmentar geográficamente las líneas de pedido para ubicaciones específicas.
Ejemplo

JavaScript

// Postal code:
googletag.pubads().setLocation("10001,US");

JavaScript (heredado)

// Postal code:
googletag.pubads().setLocation("10001,US");

TypeScript

// Postal code:
googletag.pubads().setLocation("10001,US");
Parámetros
address: stringDirección en formato libre.
Muestra
PubAdsServiceEs el objeto de servicio en el que se llamó al método.

setPrivacySettings

setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService
Permite configurar todos los parámetros de configuración 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,
});

JavaScript (heredado)

googletag.pubads().setPrivacySettings({
  restrictDataProcessing: true,
});

// Set multiple privacy settings at the same time.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: true,
  underAgeOfConsent: true,
});

// Clear the configuration for childDirectedTreatment.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: null,
});

TypeScript

googletag.pubads().setPrivacySettings({
  restrictDataProcessing: true,
});

// Set multiple privacy settings at the same time.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: true,
  underAgeOfConsent: true,
});

// Clear the configuration for childDirectedTreatment.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: null,
});
Consulta también
Parámetros
privacySettings: PrivacySettingsConfigObjeto que contiene la configuración de privacidad.
Muestra
PubAdsServiceEs 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");

JavaScript (heredado)

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

TypeScript

googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
Consulta también
Parámetros
ppid: stringEs un ID alfanumérico proporcionado por el publicador. Debe tener entre 32 y 150 caracteres.
Muestra
PubAdsServiceEs 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, si se especifican.
Ejemplo

JavaScript

googletag.pubads().setForceSafeFrame(true);

const pageConfig = {
  allowOverlayExpansion: true,
  allowPushExpansion: true,
  sandbox: true,
};

const slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

// The following slot will not allow for expansion by overlay.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setSafeFrameConfig(slotConfig)
  .addService(googletag.pubads());

// The following slot will inherit the page level settings, and hence
// would allow for expansion by overlay.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

JavaScript (heredado)

googletag.pubads().setForceSafeFrame(true);

var pageConfig = {
  allowOverlayExpansion: true,
  allowPushExpansion: true,
  sandbox: true,
};

var slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

// The following slot will not allow for expansion by overlay.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setSafeFrameConfig(slotConfig)
  .addService(googletag.pubads());

// The following slot will inherit the page level settings, and hence
// would allow for expansion by overlay.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

TypeScript

googletag.pubads().setForceSafeFrame(true);

const pageConfig = {
  allowOverlayExpansion: true,
  allowPushExpansion: true,
  sandbox: true,
};

const slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

// The following slot will not allow for expansion by overlay.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setSafeFrameConfig(slotConfig)
  .addService(googletag.pubads());

// The following slot will inherit the page level settings, and hence
// would allow for expansion by overlay.
googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");
Consulta también
Parámetros
config: SafeFrameConfigEs el objeto de configuración.
Muestra
PubAdsServiceEs el objeto de servicio en el que se llamó al método.

setTargeting

setTargeting(key: string, value: string | string[]): PubAdsService
Establece parámetros de segmentación personalizados para una clave determinada que se aplican a todos los espacios publicitarios del servicio de Publisher Ads. Si se llama 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.
Ejemplo

JavaScript

// Example with a single value for a key.
googletag.pubads().setTargeting("interests", "sports");

// Example with multiple values for a key inside in an array.
googletag.pubads().setTargeting("interests", ["sports", "music"]);

JavaScript (heredado)

// Example with a single value for a key.
googletag.pubads().setTargeting("interests", "sports");

// Example with multiple values for a key inside in an array.
googletag.pubads().setTargeting("interests", ["sports", "music"]);

TypeScript

// Example with a single value for a key.
googletag.pubads().setTargeting("interests", "sports");

// Example with multiple values for a key inside in an array.
googletag.pubads().setTargeting("interests", ["sports", "music"]);
Consulta también
Parámetros
key: stringEs la clave del parámetro de segmentación.
value: string | string[]Es el valor del parámetro de segmentación o un array de valores.
Muestra
PubAdsServiceEs 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. En el caso de videoContentId y videoCmsId, usa los valores que se proporcionan al servicio de transferencia de contenido de Google Ad Manager.
Consulta también
Parámetros
videoContentId: stringEs el ID de contenido del video.
videoCmsId: stringEs el ID del CMS de video.

updateCorrelator

updateCorrelator(): PubAdsService
Cambia el correlacionador que se envía con las solicitudes de anuncios, lo que inicia una nueva vista de página. El correlator es el mismo para todas las solicitudes de anuncios que provienen de una página vista y es único en todas las páginas vistas. 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 realmente se encuentran en la página y no tiene fecha de vencimiento.
Ejemplo

JavaScript

// Assume that the correlator is currently 12345. All ad requests made
// by this page will currently use that value.

// Replace the current correlator with a new correlator.
googletag.pubads().updateCorrelator();

// The correlator will now be a new randomly selected value, different
// from 12345. All subsequent ad requests made by this page will use
// the new value.

JavaScript (heredado)

// Assume that the correlator is currently 12345. All ad requests made
// by this page will currently use that value.

// Replace the current correlator with a new correlator.
googletag.pubads().updateCorrelator();

// The correlator will now be a new randomly selected value, different
// from 12345. All subsequent ad requests made by this page will use
// the new value.

TypeScript

// Assume that the correlator is currently 12345. All ad requests made
// by this page will currently use that value.

// Replace the current correlator with a new correlator.
googletag.pubads().updateCorrelator();

// The correlator will now be a new randomly selected value, different
// from 12345. All subsequent ad requests made by this page will use
// the new value.
Muestra
PubAdsServiceEs el objeto de servicio en el que se llamó a la función.

googletag.ResponseInformation

Es un objeto que representa una sola respuesta del 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 del concepto.
Consulta también

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 del concepto.

googletag.RewardedPayload

Objeto que representa la recompensa asociada a un anuncio recompensado
Propiedades
amount
Es la cantidad de artículos incluidos en la recompensa.
type
Es el tipo de elemento incluido en la recompensa (por ejemplo, "moneda").
Consulta también

Propiedades

amount

amount: number
Es la cantidad de artículos incluidos en la recompensa.

type

type: string
Es el tipo de elemento incluido en la recompensa (por ejemplo, "moneda").

googletag.Service

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 ocurre un evento de GPT específico en la página.
getSlots
Obtén la lista de ranuras asociadas a 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 ocurre un evento de GPT específico en la página. Se admiten los siguientes eventos: Cuando se llama al objeto de escucha, se le pasa un objeto del tipo de evento adecuado.
Ejemplo

JavaScript

// 1. Adding an event listener for the PubAdsService.
googletag.pubads().addEventListener("slotOnload", (event) => {
  console.log("Slot has been loaded:");
  console.log(event);
});

// 2. Adding an event listener with slot specific logic.
// Listeners operate at service level, which means that you cannot add
// a listener for an event for a specific slot only. You can, however,
// programmatically filter a listener to respond only to a certain ad
// slot, using this pattern:
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", (event) => {
  if (event.slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (heredado)

// 1. Adding an event listener for the PubAdsService.
googletag.pubads().addEventListener("slotOnload", function (event) {
  console.log("Slot has been loaded:");
  console.log(event);
});

// 2. Adding an event listener with slot specific logic.
// Listeners operate at service level, which means that you cannot add
// a listener for an event for a specific slot only. You can, however,
// programmatically filter a listener to respond only to a certain ad
// slot, using this pattern:
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", function (event) {
  if (event.slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// 1. Adding an event listener for the PubAdsService.
googletag.pubads().addEventListener("slotOnload", (event) => {
  console.log("Slot has been loaded:");
  console.log(event);
});

// 2. Adding an event listener with slot specific logic.
// Listeners operate at service level, which means that you cannot add
// a listener for an event for a specific slot only. You can, however,
// programmatically filter a listener to respond only to a certain ad
// slot, using this pattern:
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", (event) => {
  if (event.slot === targetSlot) {
    // Slot specific logic.
  }
});
Consulta también
Parámetros
eventType: KEs una cadena que representa el tipo de evento generado por GPT. Los tipos de eventos distinguen mayúsculas de minúsculas.
listener: ((arg: EventTypeMap[K]) => void)Función que toma un solo argumento de objeto de evento.
Muestra
ServiceEs el objeto de servicio en el que se llamó al método.

getSlots

getSlots(): Slot[]
Obtén la lista de ranuras asociadas a este servicio.
Muestra
Slot[]Son las posiciones 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 previamente.
Ejemplo

JavaScript

googletag.cmd.push(() => {
  // Define a new ad slot.
  googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads());

  // Define a new function that removes itself via removeEventListener
  // after the impressionViewable event fires.
  const onViewableListener = (event) => {
    googletag.pubads().removeEventListener("impressionViewable", onViewableListener);
    setTimeout(() => {
      googletag.pubads().refresh([event.slot]);
    }, 30000);
  };

  // Add onViewableListener as a listener for impressionViewable events.
  googletag.pubads().addEventListener("impressionViewable", onViewableListener);
  googletag.enableServices();
});

JavaScript (heredado)

googletag.cmd.push(function () {
  // Define a new ad slot.
  googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads());

  // Define a new function that removes itself via removeEventListener
  // after the impressionViewable event fires.
  var onViewableListener = function (event) {
    googletag.pubads().removeEventListener("impressionViewable", onViewableListener);
    setTimeout(function () {
      googletag.pubads().refresh([event.slot]);
    }, 30000);
  };

  // Add onViewableListener as a listener for impressionViewable events.
  googletag.pubads().addEventListener("impressionViewable", onViewableListener);
  googletag.enableServices();
});

TypeScript

googletag.cmd.push(() => {
  // Define a new ad slot.
  googletag
    .defineSlot("/6355419/Travel", [728, 90], "div-for-slot")!
    .addService(googletag.pubads());

  // Define a new function that removes itself via removeEventListener
  // after the impressionViewable event fires.
  const onViewableListener = (event: googletag.events.ImpressionViewableEvent) => {
    googletag.pubads().removeEventListener("impressionViewable", onViewableListener);
    setTimeout(() => {
      googletag.pubads().refresh([event.slot]);
    }, 30000);
  };

  // Add onViewableListener as a listener for impressionViewable events.
  googletag.pubads().addEventListener("impressionViewable", onViewableListener);
  googletag.enableServices();
});
Parámetros
eventType: KEs una cadena que representa el tipo de evento generado por GPT. Los tipos de eventos distinguen mayúsculas de minúsculas.
listener: ((event: EventTypeMap[K]) => void)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ños. Este compilador se proporciona para ayudar a crear especificaciones de tamaño con facilidad.
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

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 &lt; 640x480
  .build();

// Mapping 2
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [])
  .addSize([640, 480], [120, 60])
  .addSize([0, 0], [])
  .build();

// Mapping 2 will not show any ads for the following viewport sizes:
// [1024, 768] > size >= [980, 690] and
// [640, 480] > size >= [0, 0]

JavaScript (heredado)

// Mapping 1
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [728, 90])
  .addSize([640, 480], "fluid")
  .addSize([0, 0], [88, 31]) // All viewports &lt; 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 &lt; 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: SingleSizeArrayEs el tamaño del viewport para esta entrada de asignación.
slotSize: GeneralSizeSon los tamaños de la ranura para esta entrada de asignación.
Muestra
SizeMappingBuilderEs una referencia a este compilador.

build

build(): SizeMappingArray
Compila una especificación de mapa de tamaños 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
SizeMappingArrayEs 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 Service a este segmento.
clearCategoryExclusions
Obsoleto. Borra todas las etiquetas de exclusión de categorías de anuncios a nivel del espacio para este espacio.
clearTargeting
Obsoleto. Borra parámetros de segmentación personalizados específicos o todos los parámetros de segmentación personalizados a nivel de la posición para esta posición.
defineSizeMapping
Establece un array de asignaciones desde un tamaño mínimo del viewport hasta el tamaño de la ranura para esta ranura.
get
Obsoleto. Devuelve el valor del atributo de AdSense asociado a la clave determinada 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 segmento.
getCategoryExclusions
Obsoleto. Devuelve las etiquetas de exclusión de categorías de anuncios para este espacio.
getConfig
Obtiene las opciones de configuración generales del espacio publicitario establecidas por setConfig.
getResponseInformation
Devuelve la información de la respuesta del anuncio.
getSlotElementId
Devuelve el ID de la ranura div proporcionado cuando se definió la ranura.
getTargeting
Obsoleto. Devuelve 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 personalizadas 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 en este espacio.
setClickUrl
Obsoleto. Establece la URL de clic a la que se redireccionará a los usuarios después de que hagan clic en el anuncio.
setCollapseEmptyDiv
Obsoleto. Establece si se debe ocultar el espacio div cuando no hay un anuncio en él.
setConfig
Establece opciones de configuración generales para este segmento.
setForceSafeFrame
Obsoleto. Configura si se debe forzar la renderización de los anuncios en este espacio publicitario con un contenedor de SafeFrame.
setSafeFrameConfig
Obsoleto. Establece las preferencias a nivel de la ranura para la configuración de SafeFrame.
setTargeting
Obsoleto. Establece un parámetro de segmentación personalizado para este espacio.
updateTargetingFromMap
Obsoleto. Establece parámetros de segmentación personalizados para este espacio, a partir de un mapa de clave:valor en un objeto JSON.

Métodos

addService

addService(service: Service): Slot
Agrega un servicio a este espacio.
Ejemplo

JavaScript

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

JavaScript (heredado)

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

TypeScript

googletag.defineSlot("/1234567/sports", [160, 600], "div")!.addService(googletag.pubads());
Consulta también
Parámetros
service: ServiceEs el servicio que se agregará.
Muestra
SlotEs el objeto de ranura en el que se llamó al método.

clearCategoryExclusions

clearCategoryExclusions(): Slot
Borra todas las etiquetas de exclusión de categorías de anuncios a nivel del espacio para este espacio.
Ejemplo

JavaScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setCategoryExclusion("AirlineAd")
  .addService(googletag.pubads());

// Make an ad request. No ad with 'AirlineAd' label will be returned
// for the slot.

// Clear category exclusions so all ads can be returned.
slot.clearCategoryExclusions();

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

JavaScript (heredado)

// Set category exclusion to exclude ads with 'AirlineAd' labels.
var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setCategoryExclusion("AirlineAd")
  .addService(googletag.pubads());

// Make an ad request. No ad with 'AirlineAd' label will be returned
// for the slot.

// Clear category exclusions so all ads can be returned.
slot.clearCategoryExclusions();

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

TypeScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setCategoryExclusion("AirlineAd")
  .addService(googletag.pubads());

// Make an ad request. No ad with 'AirlineAd' label will be returned
// for the slot.

// Clear category exclusions so all ads can be returned.
slot.clearCategoryExclusions();

// Make an ad request. Any ad can be returned for the slot.
Muestra
SlotEs el objeto de ranura 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 para este espacio.
Ejemplo

JavaScript

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

slot.clearTargeting("color");
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.clearTargeting();
// All targeting has been cleared.

JavaScript (heredado)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setTargeting("allow_expandable", "true")
  .setTargeting("interests", ["sports", "music"])
  .setTargeting("color", "red")
  .addService(googletag.pubads());

slot.clearTargeting("color");
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.clearTargeting();
// All targeting has been cleared.

TypeScript

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

slot.clearTargeting("color");
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.clearTargeting();
// All targeting has been cleared.
Consulta también
Parámetros
Optional key: stringEs la clave del parámetro de segmentación. La clave es opcional. Si no se especifica, se borrarán todos los parámetros de segmentación.
Muestra
SlotEs el objeto de ranura en el que se llamó al método.

defineSizeMapping

defineSizeMapping(sizeMapping: SizeMappingArray): Slot
Establece un array de asignaciones desde un tamaño mínimo del viewport hasta el tamaño de la ranura para esta ranura.
Ejemplo

JavaScript

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

const mapping = googletag
  .sizeMapping()
  .addSize([100, 100], [88, 31])
  .addSize(
    [320, 400],
    [
      [320, 50],
      [300, 50],
    ],
  )
  .build();

slot.defineSizeMapping(mapping);

JavaScript (heredado)

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

var mapping = googletag
  .sizeMapping()
  .addSize([100, 100], [88, 31])
  .addSize(
    [320, 400],
    [
      [320, 50],
      [300, 50],
    ],
  )
  .build();

slot.defineSizeMapping(mapping);

TypeScript

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

const mapping = googletag
  .sizeMapping()
  .addSize([100, 100], [88, 31])
  .addSize(
    [320, 400],
    [
      [320, 50],
      [300, 50],
    ],
  )
  .build();

slot.defineSizeMapping(mapping!);
Consulta también
Parámetros
sizeMapping: SizeMappingArrayEs 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
SlotEs el objeto de ranura en el que se llamó al método.

get

get(key: string): string
Devuelve el valor del atributo de AdSense asociado a la clave determinada para este espacio. Para ver los atributos a nivel del servicio que hereda este espacio publicitario, usa PubAdsService.get.
Ejemplo

JavaScript

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

slot.get("adsense_background_color");
// Returns '#FFFFFF'.

JavaScript (heredado)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .addService(googletag.pubads());

slot.get("adsense_background_color");
// Returns '#FFFFFF'.

TypeScript

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

slot.get("adsense_background_color");
// Returns '#FFFFFF'.
Consulta también
Parámetros
key: stringNombre del atributo que se buscará.
Muestra
stringValor actual de la clave del 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'.

JavaScript (heredado)

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

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

TypeScript

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

slot.getAdUnitPath();
// Returns '/1234567/sports'.
Muestra
stringEs la ruta de acceso de la unidad de anuncios.

getAttributeKeys

getAttributeKeys(): string[]
Devuelve la lista de claves de atributos establecidas en este segmento. Para ver las claves de los atributos a nivel del servicio que hereda esta ranura, usa PubAdsService.getAttributeKeys.
Ejemplo

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .set("adsense_border_color", "#AABBCC")
  .addService(googletag.pubads());

slot.getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].

JavaScript (heredado)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .set("adsense_border_color", "#AABBCC")
  .addService(googletag.pubads());

slot.getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .set("adsense_background_color", "#FFFFFF")
  .set("adsense_border_color", "#AABBCC")
  .addService(googletag.pubads());

slot.getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].
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.
Ejemplo

JavaScript

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

slot.getCategoryExclusions();
// Returns ['AirlineAd', 'TrainAd'].

JavaScript (heredado)

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

slot.getCategoryExclusions();
// Returns ['AirlineAd', 'TrainAd'].

TypeScript

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

slot.getCategoryExclusions();
// Returns ['AirlineAd', 'TrainAd'].
Muestra
string[]Son las etiquetas de exclusión de categorías de anuncios para este espacio o un array vacío si no se configuró ninguna.

getConfig

getConfig(keys: string | string[]): Pick<SlotSettingsConfig, "adsenseAttributes" | "targeting" | "categoryExclusion">
Obtiene las opciones de configuración generales del espacio publicitario establecidas por setConfig.

Este método no admite todas las propiedades de setConfig(). Las propiedades admitidas son las siguientes:
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"]);

JavaScript (heredado)

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

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

// Get the value of the `adsenseAttributes` and `categoryExclusion` settings.
var 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 obtendrán.
Muestra
Pick<SlotSettingsConfig, "adsenseAttributes" | "targeting" | "categoryExclusion">Son las opciones de configuración de la ranura.

getResponseInformation

getResponseInformation(): ResponseInformation
Devuelve la información de la respuesta del anuncio. Esto se basa en la última respuesta del anuncio para la posición. Si se llama a este método cuando la ranura no tiene un anuncio, se devolverá null.
Muestra
ResponseInformationEs la información de respuesta del anuncio más reciente o null si la ranura no tiene un anuncio.

getSlotElementId

getSlotElementId(): string
Devuelve el ID de la ranura div proporcionado cuando se definió la ranura.
Ejemplo

JavaScript

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

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

JavaScript (heredado)

var 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
stringID de la ranura 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.
Ejemplo

JavaScript

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

slot.getTargeting("allow_expandable");
// Returns ['true'].

slot.getTargeting("age");
// Returns [] (empty array).

JavaScript (heredado)

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

slot.getTargeting("allow_expandable");
// Returns ['true'].

slot.getTargeting("age");
// Returns [] (empty array).

TypeScript

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

slot.getTargeting("allow_expandable");
// Returns ['true'].

slot.getTargeting("age");
// Returns [] (empty array).
Parámetros
key: stringEs 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 tal clave.

getTargetingKeys

getTargetingKeys(): string[]
Devuelve la lista de todas las claves de segmentación personalizadas establecidas en este espacio. No se incluyen las claves de segmentación a nivel del servicio.
Ejemplo

JavaScript

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

slot.getTargetingKeys();
// Returns ['interests', 'allow_expandable'].

JavaScript (heredado)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setTargeting("allow_expandable", "true")
  .setTargeting("interests", ["sports", "music"])
  .addService(googletag.pubads());

slot.getTargetingKeys();
// Returns ['interests', 'allow_expandable'].

TypeScript

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

slot.getTargetingKeys();
// Returns ['interests', 'allow_expandable'].
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 deben establecerse antes de llamar a display o refresh.
Ejemplo

JavaScript

// Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .addService(googletag.pubads());

JavaScript (heredado)

// Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .addService(googletag.pubads());

TypeScript

// Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .set("adsense_background_color", "#FFFFFF")
  .addService(googletag.pubads());
Consulta también
Parámetros
key: stringEs el nombre del atributo.
value: stringValor del atributo.
Muestra
SlotEs el objeto de ranura en el que se llamó al método.

setCategoryExclusion

setCategoryExclusion(categoryExclusion: string): Slot
Establece una etiqueta de exclusión de categoría de anuncio a nivel del espacio en este espacio.
Ejemplo

JavaScript

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

JavaScript (heredado)

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

TypeScript

// Label = AirlineAd
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setCategoryExclusion("AirlineAd")
  .addService(googletag.pubads());
Consulta también
Parámetros
categoryExclusion: stringEs la etiqueta de exclusión de categorías de anuncios que se agregará.
Muestra
SlotEs el objeto de ranura en el que se llamó al método.

setClickUrl

setClickUrl(value: string): Slot
Establece la URL de clic a la que se redireccionará a los usuarios después de 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. Las llamadas posteriores sobrescriben el valor. Esto solo funciona para solicitudes que no son de SRA.
Ejemplo

JavaScript

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

JavaScript (heredado)

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

TypeScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setClickUrl("http://www.example.com?original_click_url=")
  .addService(googletag.pubads());
Parámetros
value: stringEs la URL de clic que se establecerá.
Muestra
SlotEs el objeto de ranura en el que se llamó al método.

setCollapseEmptyDiv

setCollapseEmptyDiv(collapse: boolean, collapseBeforeAdFetch?: boolean): Slot
Establece si se debe ocultar el espacio div cuando no hay un anuncio en él. Esto anula la configuración a nivel del servicio.
Ejemplo

JavaScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setCollapseEmptyDiv(true, true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")
  .setCollapseEmptyDiv(true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// only after GPT detects that no ads are available for the slot.

JavaScript (heredado)

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setCollapseEmptyDiv(true, true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")
  .setCollapseEmptyDiv(true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// only after GPT detects that no ads are available for the slot.

TypeScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setCollapseEmptyDiv(true, true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")!
  .setCollapseEmptyDiv(true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// only after GPT detects that no ads are available for the slot.
Consulta también
Parámetros
collapse: booleanIndica si se debe contraer el espacio si no se muestra ningún anuncio.
Optional collapseBeforeAdFetch: booleanIndica si se contraerá el espacio incluso antes de que se recupere un anuncio. Se ignora si el parámetro de contracción no es true.
Muestra
SlotEs el objeto de ranura en el que se llamó al método.

setConfig

setConfig(slotConfig: SlotSettingsConfig): void
Establece opciones de configuración generales para este segmento.
Parámetros
slotConfig: SlotSettingsConfigEs el objeto de configuración.

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): Slot
Configura si los anuncios en este espacio deben renderizarse de forma obligatoria con un contenedor de SafeFrame.

Ten en cuenta lo siguiente cuando uses esta API:
  • Este parámetro de configuración solo tendrá efecto en las solicitudes de anuncios subsiguientes que se realicen para los espacios respectivos.
  • Si se especifica, el parámetro de configuración a nivel del espacio siempre anulará el parámetro de configuración a nivel de la página.
  • Si se configura como true (a nivel del espacio o de la página), el anuncio siempre se renderizará con un contenedor de SafeFrame, independientemente de la elección que se realice en la IU de Google Ad Manager.
  • Sin embargo, si se establece en false o no se especifica, 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 usar con precaución, ya que podría afectar el comportamiento de las creatividades que intentan salir de sus elementos iframe o que dependen de que se rendericen directamente en la página de un publicador.
Ejemplo

JavaScript

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

JavaScript (heredado)

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

TypeScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setForceSafeFrame(true)
  .addService(googletag.pubads());
Consulta también
Parámetros
forceSafeFrame: booleantrue para forzar la renderización de todos los anuncios de este espacio en SafeFrames y false para inhabilitar un parámetro de configuración a nivel de la página (si está presente). Si se establece en false cuando no se especifica a nivel de la página, no se cambiará nada.
Muestra
SlotEs el objeto de ranura en el que se llamó al método.

setSafeFrameConfig

setSafeFrameConfig(config: SafeFrameConfig): Slot
Establece las preferencias a nivel de la ranura para la configuración de SafeFrame. Se ignorarán las claves no reconocidas en el objeto de configuración. Se ignorará toda la configuración si se pasa un valor no válido para una clave reconocida.

Estas preferencias a nivel del espacio, si se especifican, anularán cualquier preferencia a nivel de la página.
Ejemplo

JavaScript

googletag.pubads().setForceSafeFrame(true);

// The following slot will have a sandboxed safeframe that only
// disallows top-level navigation.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setSafeFrameConfig({ sandbox: true })
  .addService(googletag.pubads());

// The following slot will inherit page-level settings.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

JavaScript (heredado)

googletag.pubads().setForceSafeFrame(true);

// The following slot will have a sandboxed safeframe that only
// disallows top-level navigation.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setSafeFrameConfig({ sandbox: true })
  .addService(googletag.pubads());

// The following slot will inherit page-level settings.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

TypeScript

googletag.pubads().setForceSafeFrame(true);

// The following slot will have a sandboxed safeframe that only
// disallows top-level navigation.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setSafeFrameConfig({ sandbox: true })
  .addService(googletag.pubads());

// The following slot will inherit page-level settings.
googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");
Consulta también
Parámetros
config: SafeFrameConfigEs el objeto de configuración.
Muestra
SlotEs el objeto de ranura en el que se llamó al método.

setTargeting

setTargeting(key: string, value: string | string[]): Slot
Establece un parámetro de segmentación personalizado para este espacio. Si se llama a este método varias veces para la misma clave, se reemplazarán los valores anteriores. Los valores establecidos aquí anularán los parámetros de segmentación establecidos a nivel del servicio. Estas claves se definen en tu cuenta de Google Ad Manager.
Ejemplo

JavaScript

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

// Example with a single value for a key.
slot.setTargeting("allow_expandable", "true");

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

JavaScript (heredado)

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

// Example with a single value for a key.
slot.setTargeting("allow_expandable", "true");

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

TypeScript

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

// Example with a single value for a key.
slot.setTargeting("allow_expandable", "true");

// Example with multiple values for a key inside in an array.
slot.setTargeting("interests", ["sports", "music"]);
Consulta también
Parámetros
key: stringEs la clave del parámetro de segmentación.
value: string | string[]Es el valor del parámetro de segmentación o un array de valores.
Muestra
SlotEs el objeto de ranura en el que se llamó al método.

updateTargetingFromMap

updateTargetingFromMap(map: {
  [adUnitPath: string]: string | string[];
}): Slot
Establece parámetros de segmentación personalizados para este espacio, a partir de un mapa de clave:valor en un objeto JSON. Esto equivale a llamar a Slot.setTargeting para todos los valores clave del objeto. Estas claves se definen en tu cuenta de Google Ad Manager.

Notas:
  • En caso de sobrescritura, solo se conservará el último valor.
  • Si el valor es un array, se reemplazará cualquier valor anterior, no se combinará.
  • Los valores establecidos aquí anularán los parámetros de segmentación establecidos a nivel del servicio.
Ejemplo

JavaScript

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

slot.updateTargetingFromMap({
  color: "red",
  interests: ["sports", "music", "movies"],
});

JavaScript (heredado)

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

slot.updateTargetingFromMap({
  color: "red",
  interests: ["sports", "music", "movies"],
});

TypeScript

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

slot.updateTargetingFromMap({
  color: "red",
  interests: ["sports", "music", "movies"],
});
Parámetros
map: {
  [adUnitPath: string]: string | string[];
}		Mapa de pares clave-valor del parámetro de segmentación.
Muestra
SlotEs el objeto de ranura 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
Es la configuración para controlar el comportamiento de los anuncios de AdSense.
ComponentAuctionConfig
Es un objeto que representa una sola subasta de componentes en una subasta de anuncios integrada en el dispositivo.
InterstitialConfig
Es un objeto que define el comportamiento de un solo espacio publicitario intersticial.
LazyLoadConfig
Es la 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 de los publicadores.
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 de la ranura.
TaxonomyData
Es un objeto que contiene los valores de una sola Taxonomy.
VideoAdsConfig
Es la configuración para establecer la configuración relacionada con los anuncios de video.
Alias de tipo
InterstitialTrigger
Son las acciones que activan los anuncios intersticiales compatibles.
PrivacyTreatment
Son los tratamientos de privacidad del publicador admitidos.
Taxonomy

Alias de tipo

InterstitialTrigger

InterstitialTrigger: "unhideWindow" | "navBar"
Son las acciones que activan los anuncios intersticiales compatibles.

PrivacyTreatment

PrivacyTreatment: "disablePersonalization"
Son los 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

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

JavaScript (heredado)

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

TypeScript

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

Propiedades

Optional habilitado

enabled?: boolean
Indica si la expansión de anuncios está habilitada o inhabilitada.

Si se establece este valor, se anula la configuración predeterminada en Google Ad Manager.
Consulta también

googletag.config.AdSenseAttributesConfig

Es la configuración para controlar el comportamiento de los anuncios de AdSense.

Estos atributos se pueden usar para anular la configuración del servidor por 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

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 los canales de AdSense.

Los valores permitidos son los IDs de los canales separados por el signo "+".

Ejemplo: 271828183+314159265
Consulta también

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 para pruebas y no se incluirán en el recuento ni en la facturación. Este parámetro de configuración debe anularse para el tráfico de producción que no sea de prueba.

Optional document_language

document_language?: string
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

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

Es un objeto que representa una sola subasta de componentes en una subasta de anuncios integrada en el dispositivo.
Propiedades
auctionConfig
Es un objeto de configuración de la subasta para esta subasta de componente.
configKey
Es la clave de configuración asociada a esta subasta de componentes.
Consulta también

Propiedades

auctionConfig

auctionConfig: {
  auctionSignals?: unknown;
  decisionLogicURL: string;
  interestGroupBuyers?: string[];
  perBuyerExperimentGroupIds?: {
    [buyer: string]: number;
  };
  perBuyerGroupLimits?: {
    [buyer: string]: number;
  };
  perBuyerSignals?: {
    [buyer: string]: unknown;
  };
  perBuyerTimeouts?: {
    [buyer: string]: number;
  };
  seller: string;
  sellerExperimentGroupId?: number;
  sellerSignals?: unknown;
  sellerTimeout?: number;
  trustedScoringSignalsURL?: string;
}
Es un objeto de configuración de la subasta para esta subasta de componentes.

Si este valor se establece en null, se borrará cualquier configuración existente para el configKey especificado.
Ejemplo

JavaScript

const componentAuctionConfig = {
  // Seller URL should be https and the same as decisionLogicURL's origin
  seller: "https://testSeller.com",
  decisionLogicURL: "https://testSeller.com/ssp/decision-logic.js",
  interestGroupBuyers: ["https://example-buyer.com"],
  auctionSignals: { auction_signals: "auction_signals" },
  sellerSignals: { seller_signals: "seller_signals" },
  perBuyerSignals: {
    // listed on interestGroupBuyers
    "https://example-buyer.com": {
      per_buyer_signals: "per_buyer_signals",
    },
  },
};

const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]);

// To add configKey to the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: componentAuctionConfig,
    },
  ],
});

// To remove configKey from the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: null,
    },
  ],
});

JavaScript (heredado)

var componentAuctionConfig = {
  // Seller URL should be https and the same as decisionLogicURL's origin
  seller: "https://testSeller.com",
  decisionLogicURL: "https://testSeller.com/ssp/decision-logic.js",
  interestGroupBuyers: ["https://example-buyer.com"],
  auctionSignals: { auction_signals: "auction_signals" },
  sellerSignals: { seller_signals: "seller_signals" },
  perBuyerSignals: {
    // listed on interestGroupBuyers
    "https://example-buyer.com": {
      per_buyer_signals: "per_buyer_signals",
    },
  },
};

var auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]);

// To add configKey to the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: componentAuctionConfig,
    },
  ],
});

// To remove configKey from the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: null,
    },
  ],
});

TypeScript

const componentAuctionConfig = {
  // Seller URL should be https and the same as decisionLogicURL's origin
  seller: "https://testSeller.com",
  decisionLogicURL: "https://testSeller.com/ssp/decision-logic.js",
  interestGroupBuyers: ["https://example-buyer.com"],
  auctionSignals: { auction_signals: "auction_signals" },
  sellerSignals: { seller_signals: "seller_signals" },
  perBuyerSignals: {
    // listed on interestGroupBuyers
    "https://example-buyer.com": {
      per_buyer_signals: "per_buyer_signals",
    },
  },
};

const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600])!;

// To add configKey to the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: componentAuctionConfig,
    },
  ],
});

// To remove configKey from the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: null,
    },
  ],
});
Consulta también

configKey

configKey: string
Es la clave de configuración asociada a esta subasta de componentes.

Este valor no debe estar vacío y debe ser único. Si dos objetos ComponentAuctionConfig comparten el mismo valor de configKey, el último que se configure anulará las configuraciones anteriores.

googletag.config.InterstitialConfig

Es un objeto que define el comportamiento de un solo espacio publicitario intersticial.
Propiedades
requireStorageAccess?
Indica si se requiere consentimiento para el almacenamiento local para mostrar este anuncio intersticial.
triggers?
Es la configuración del activador de intersticial 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 a los anuncios intersticiales. Sin embargo, los usuarios que no proporcionaron el consentimiento de almacenamiento local aún son aptos para que se les publiquen anuncios intersticiales. Si se configura esta propiedad como true, se inhabilita el comportamiento predeterminado y se garantiza que los anuncios intersticiales solo se muestren a los usuarios que hayan otorgado 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
  },
});

JavaScript (heredado)

// Opt out of showing interstitials to users
// without local storage consent.
var 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

Optional activadores

triggers?: Partial<Record<InterstitialTrigger, boolean>>
Es la configuración del activador de intersticial para este anuncio intersticial.

Si se establece el valor de un activador de intersticial en true, se habilitará, y si se establece 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,
    },
  },
});

JavaScript (heredado)

// Define a GPT managed web interstitial ad slot.
var interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
);

// Enable optional interstitial triggers.
// Change this value to false to disable.
var enableTriggers = true;

interstitialSlot.setConfig({
  interstitial: {
    triggers: {
      navBar: enableTriggers,
      unhideWindow: enableTriggers,
    },
  },
});

TypeScript

// Define a GPT managed web interstitial ad slot.
const interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
)!;

// Enable optional interstitial triggers.
// Change this value to false to disable.
const enableTriggers = true;

interstitialSlot.setConfig({
  interstitial: {
    triggers: {
      navBar: enableTriggers,
      unhideWindow: enableTriggers,
    },
  },
});
Consulta también

googletag.config.LazyLoadConfig

Es la configuración para controlar el uso de la carga diferida en GPT.
Propiedades
fetchMarginPercent?
Es la distancia mínima desde el viewport actual a la que debe estar una ranura 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 a la que debe estar una ranura antes de que rendericemos un anuncio, expresada como un porcentaje del tamaño del viewport.
Consulta también

Propiedades

Optional fetchMarginPercent

fetchMarginPercent?: number
Es la distancia mínima desde la ventana gráfica actual que debe tener un espacio antes de que solicitemos un anuncio, expresada como un porcentaje del tamaño de la ventana gráfica.

Se usa en conjunto con renderMarginPercent. Este parámetro de configuración permite realizar una recuperación previa de un anuncio, pero espera 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 la ranura ingresa al viewport", 100 significa "cuando el anuncio está a 1 viewport de distancia", y así sucesivamente.

Optional mobileScaling

mobileScaling?: number
Es un multiplicador que se aplica a los márgenes en dispositivos móviles. Este multiplicador se aplica a fetchMarginPercent y renderMarginPercent.

Esto permite tener diferentes márgenes en dispositivos móviles y computadoras de escritorio, en los que los tamaños del 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 a la que una ranura puede estar del viewport antes de recuperar y renderizar.

Optional renderMarginPercent

renderMarginPercent?: number
Es la distancia mínima desde la ventana gráfica actual que debe tener una ranura antes de que rendericemos un anuncio, expresada como un porcentaje del tamaño de la ventana gráfica.

Se usa en conjunto con fetchMarginPercent. Este parámetro de configuración permite realizar una recuperación previa de un anuncio, pero espera 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 la ranura 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 establecer varios parámetros con una sola llamada a la API.

Todas las propiedades que se enumeran 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 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
      }
  });
  • Para borrar todos los parámetros de configuración de una función, pasa null. 
      // Configure features delta, golf, and hotel.
  googletag.setConfig({
      delta: {...},
      golf: {...},
      hotel: {...},
  });

  // Feature delta and hotel are cleared, but feature golf remains set.
  googletag.setConfig({
      delta: null,
      hotel: null,
  });
Propiedades
adExpansion?
Es la configuración para controlar la expansión de anuncios.
adsenseAttributes?
Es un parámetro de configuración para establecer atributos de AdSense.
adYield?
Obsoleto. 
categoryExclusion?
Es un parámetro de configuración para establecer exclusiones de categorías de anuncios.
centering?
Es un parámetro de configuración para controlar el centrado horizontal de los anuncios.
collapseDiv?
Es un parámetro de configuración para controlar el comportamiento de contracción de los espacios publicitarios.
disableInitialLoad?
Es un parámetro de configuración para controlar cuándo se solicitan los anuncios.
lazyLoad?
Es la 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 según ubicaciones geográficas.
pps?
Es la configuración para controlar los indicadores proporcionados por el publicador (PPS).
privacyTreatments?
Es la configuración para controlar los tratamientos de privacidad de los publicadores.
safeFrame?
Es la configuración para controlar el uso de SafeFrame en GPT.
singleRequest?
Es un parámetro de configuración para habilitar o inhabilitar la arquitectura de solicitud única (SRA).