Referencia de GPT

En esta referencia, se usa la notación de TypeScript para describir tipos. En la siguiente tabla, se proporciona una explicación breve a través de ejemplos.

Expresión de tipo
string Es el tipo de cadena primitivo.
string[] Es un tipo de array, en el que los valores solo pueden ser cadenas.
number | string 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 Un tipo de objeto, en el que el valor es una instancia de googletag.Slot
() => void Un tipo de función sin argumentos definidos y sin valor que se muestre.

Para obtener más información sobre los tipos y las expresiones de tipos 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 mostrar. En la siguiente tabla, se muestran ejemplos de anotaciones de tipo que puedes ver en esta referencia.

Anotación de tipos
param: string Indica que param acepta o muestra un valor de cadena. Esta sintaxis se usa para variables, parámetros, propiedades y tipos de datos que se muestran.
param?: number | string Indica que param es opcional, pero acepta un número o una 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 descanso que acepta funciones. Los parámetros de REST aceptan una cantidad ilimitada de valores del tipo especificado.

Definiciones de tipos

Tipos
SingleSize | MultiSize

Una configuración de tamaño válida para una ranura, que puede ser uno o varios tamaños.
SingleSize[]

Una lista de tamaños válidos únicos.
"fluid" | ["fluid"]

Tamaños con nombre que puede tener un espacio publicitario. En la mayoría de los casos, el tamaño es un rectángulo de tamaño fijo, pero hay algunos casos en los que necesitamos otros tipos de especificaciones de tamaño. Solo los siguientes son tamaños con nombre válidos:

  • fluid: El contenedor de anuncios toma el 100% del ancho del div superior y, luego, cambia el tamaño de su altura para adaptarse al contenido de la creatividad. Es similar a cómo se comportan los elementos de bloque normales en una página. Se usa para anuncios nativos (consulta el artículo relacionado). Ten en cuenta que fluid y ['fluid'] son formas aceptables para declarar un tamaño de ranura como flexible.
SingleSizeArray | NamedSize

Es un único tamaño válido para una ranura.
[number, number]

Array de dos números que representan [ancho, alto].
[SingleSizeArray, GeneralSize]

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

Una lista de asignaciones de tamaño.
"unhideWindow" | "navBar"

Activadores compatibles de anuncios intersticiales.
"disablePersonalization"

Tratamientos compatibles con la privacidad del publicador.
"IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"

Taxonomías admitidas para los indicadores proporcionados por el publicador (PPS).
BidderSignalProvider | PublisherSignalProvider

Interfaz para mostrar un indicador seguro para un ofertante o proveedor específico. Se debe proporcionar uno de los siguientes valores: id o networkCode, pero no ambos.

Tipos de enum

Enumeradores
googletag.enums.OutOfPageFormat
Formatos fuera de página compatibles con GPT.
googletag.enums.TrafficSource
Fuentes de tráfico compatibles con GPT

googletag.enums.OutOfPageFormat

  • Formatos fuera de página compatibles con GPT.

  • Consulta también
  • Valores
    BOTTOM_ANCHOR
    Es un formato de anuncio fijo en el que el espacio se fija en la parte inferior del viewport.
    INTERSTITIAL
    Formato de creatividad intersticial para la Web.
    LEFT_SIDE_RAIL
    Formato de riel lateral izquierdo.
    REWARDED
    Formato recompensado.
    RIGHT_SIDE_RAIL
    Formato de riel lateral derecho.
    TOP_ANCHOR
    Es un formato de anuncio fijo en el que el espacio se fija en la parte superior del viewport.

googletag.enums.TrafficSource

  • Fuentes de tráfico compatibles con GPT

  • Consulta también
  • Valores
    ORGANIC
    Entrada de URL directa, búsqueda en el sitio o descarga de la aplicación.
    PURCHASED
    Tráfico redirigido desde propiedades que no son propias (adquiridas o actividades incentivadas de algún otro modo).

googletag

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

Resumen de variables
apiReady
Marca que indica que la API de GPT está cargada y lista para ser llamada.
cmd
Referencia a la cola de comandos global para la ejecución asíncrona de llamadas relacionadas con GPT.
pubadsReady
Marca que indica que PubAdsService está habilitado, cargado y totalmente operativo.
secureSignalProviders
Referencia al array de proveedores de indicadores seguros.
Resumen de la función
companionAds
Muestra una referencia a CompanionAdsService.
defineOutOfPageSlot
Crea un espacio publicitario fuera de página con la ruta de la unidad de anuncios especificada.
defineSlot
Crea un espacio publicitario con una ruta y un tamaño de unidad de anuncios determinados y lo asocia con el ID de un elemento div en la página que contendrá el anuncio.
destroySlots
Destruye los espacios proporcionados y quita de GPT todos los objetos relacionados y las referencias de esos espacios.
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.
getVersion
Muestra la versión actual de GPT.
openConsole
Abre la Consola para publicadores de Google.
pubads
Muestra una referencia a PubAdsService.
setAdIframeTitle
Establece el título para todos los iframes del contenedor de anuncios que crea PubAdsService a partir de este momento.
setConfig
Establece opciones de configuración generales para la página.
sizeMapping
Crea un SizeMappingBuilder nuevo.

googletag.apiReady

  • apiReady: boolean | undefined

  • Marca que indica que la API de GPT está cargada y lista para ser llamada. Esta propiedad será simplemente undefined hasta que la API esté lista.

    Ten en cuenta que la forma recomendada de controlar el estado asíncrono es usar googletag.cmd para poner en cola las devoluciones de llamada cuando esté lista GPT. No es necesario que estas devoluciones de llamada verifiquen googletag.apiReady, ya que se garantiza su ejecución una vez que se configure la API.

  • Ejemplo

    JavaScript

    if (window.googletag && googletag.apiReady) {
  // GPT API can be called safely.
}

    JavaScript (heredado)

    if (window.googletag && googletag.apiReady) {
  // GPT API can be called safely.
}

    TypeScript

    if (window.googletag && googletag.apiReady) {
  // GPT API can be called safely.
}

googletag.cmd

  • cmd: Array<(this: typeof globalThis) => void> | CommandArray

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

    La sintaxis de la etiqueta GPT inicializa la variable googletag.cmd en un array de JavaScript vacío 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 archivo JavaScript de GPT, este examina el array y ejecuta todas las funciones en orden. Luego, la secuencia de comandos reemplaza cmd por un objeto CommandArray cuyo método de envío está definido para ejecutar el argumento de función que se le pasó. Este mecanismo permite que GPT reduzca la latencia percibida gracias a que recupera el código JavaScript de forma asíncrona, al mismo tiempo que permite que el navegador continúe renderizando la página.

  • Ejemplo

    JavaScript

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

    JavaScript (heredado)

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

    TypeScript

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

googletag.pubadsReady

  • pubadsReady: boolean | undefined

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

googletag.secureSignalProviders

  • secureSignalProviders: SecureSignalProvider[] | SecureSignalProvidersArray | undefined

  • Referencia al array de proveedores de indicadores seguros.

    El array de proveedores de indicadores seguros acepta una secuencia de funciones generadoras de indicadores y las invoca en orden. Su objetivo es reemplazar un array estándar que se usa para poner en cola funciones generadas por indicadores que se invocarán una vez que se cargue la etiqueta GPT.

  • Ejemplo

    JavaScript

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

    JavaScript (heredado)

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

    TypeScript

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

googletag.companionAds

googletag.defineOutOfPageSlot

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

  • Crea un espacio publicitario fuera de página con la ruta de la unidad de anuncios especificada.

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

    Para los anuncios fuera de página administrados con GPT, div es una OutOfPageFormat compatible.

  • Ejemplo

    JavaScript

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

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

    JavaScript (heredado)

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

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

    TypeScript

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

// Define a GPT managed web interstitial ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
    Consulta también
  • Parámetros
    adUnitPath: string
    Ruta de acceso de la unidad de anuncios completa con el código de red y el de la unidad de anuncios
    div?: string | OutOfPageFormat
    Es el ID del elemento div que contendrá esta unidad de anuncios o OutOfPageFormat.
  • Devuelve
    Slot | null
    El espacio nuevo o null si no se puede crear uno.

googletag.defineSlot

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

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

  • Ejemplo

    JavaScript

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

    JavaScript (heredado)

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

    TypeScript

    googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
    Consulta también
  • Parámetros
    adUnitPath: string
    Ruta de acceso de la unidad de anuncios completa con el código de red y de la unidad
    size: GeneralSize
    El ancho y la altura del espacio agregado. Este es el tamaño que se usa en la solicitud de anuncio si no se proporciona una asignación de tamaño responsivo o si el tamaño del viewport es menor que el tamaño más pequeño proporcionado en la asignación.
    div?: string
    Es el ID del elemento div que contendrá esta unidad de anuncios.
  • Devuelve
    Slot | null
    El espacio nuevo o null si no se puede crear uno.

googletag.destroySlots

  • destroySlots(slots?: Slot[]): boolean

  • Destruye los espacios proporcionados y quita de GPT todos los objetos relacionados y las referencias de esos espacios. Esta API no admite espacios de devoluciones ni complementarios.

    Si se llama a esta API en un espacio, se borra el anuncio y se quita el objeto de espacio del estado interno que mantiene GPT. Si llamas a más funciones en el objeto de espacio, se generará un comportamiento indefinido. Ten en cuenta que es posible que el navegador aún no libere la memoria asociada con ese espacio si la página del editor mantiene una referencia a él. Si se llama a esta API, el elemento div asociado a ese espacio estará disponible para reutilizarlo.

    En particular, si destruye un espacio, se quita el anuncio de la vista de página de larga duración de GPT, de modo que las publicaciones simultáneas o las exclusiones de competencia de este anuncio no influirán en las solicitudes futuras. Si no se llama a esta función antes de quitar el elemento div de un espacio publicitario 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
    slots?: Slot[]
    El array de ranuras que se destruirá. El array es opcional. Si no se especifica, se destruirán todas las ranuras.
  • Devuelve
    boolean
    true si se destruyeron las ranuras; de lo contrario, false.

googletag.disablePublisherConsole

googletag.display

  • 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 se deben definir y tener un servicio asociado a ellas antes de que se muestren. La llamada de visualización no debe ocurrir hasta que el elemento esté presente en el DOM. La forma habitual de lograrlo es colocarlo en un bloque de secuencia de comandos dentro del elemento div que se menciona en la llamada al método.

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

  • Ejemplo

    JavaScript

    googletag.cmd.push(() => {
  googletag.display("div-1");
});

    JavaScript (heredado)

    googletag.cmd.push(function () {
  googletag.display("div-1");
});

    TypeScript

    googletag.cmd.push(() => {
  googletag.display("div-1");
});
    Consulta también
  • Parámetros
    divOrSlot: string | Element | Slot
    Es el ID del elemento div que contiene el espacio publicitario o el elemento div, o bien el objeto del espacio. Si se proporciona un elemento div, este debe tener un atributo 'id' [id] que coincida con el ID que se pasó a defineSlot.

googletag.enableServices

  • enableServices(): void

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

googletag.getVersion

  • getVersion(): string

  • Muestra la versión actual de GPT.

  • Consulta también
  • Devuelve
    string
    Es la cadena de versión de GPT que se está ejecutando actualmente.

googletag.openConsole

  • openConsole(div?: string): void

  • Abre la Consola para publicadores de Google.

  • Ejemplo

    JavaScript

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

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

    JavaScript (heredado)

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

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

    TypeScript

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

// Calling without div ID.
googletag.openConsole();
    Consulta también
  • Parámetros
    div?: string
    Es un ID de div del espacio publicitario. Este valor es opcional. Si se proporciona, la Consola para publicadores intentará abrirse con los detalles del espacio publicitario especificado a la vista.

googletag.pubads

googletag.setAdIframeTitle

  • setAdIframeTitle(title: string): void

  • Establece el título para todos los iframes del contenedor de anuncios que crea PubAdsService a partir de este momento.

  • Ejemplo

    JavaScript

    googletag.setAdIframeTitle("title");

    JavaScript (heredado)

    googletag.setAdIframeTitle("title");

    TypeScript

    googletag.setAdIframeTitle("title");
  • Parámetros
    title: string
    El título nuevo para todos los iframes del contenedor de anuncios.

googletag.setConfig

googletag.sizeMapping

googletag.CommandArray

El array de comandos acepta una secuencia de funciones y las invoca en orden. Su objetivo es reemplazar un array estándar que se usa para poner funciones en cola que se invocarán una vez que se cargue la etiqueta GPT.

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

push

  • push(...f: Array<(this: typeof globalThis) => void>): number

  • Ejecuta la secuencia de funciones especificadas en los argumentos en orden.

  • Ejemplo

    JavaScript

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

    JavaScript (heredado)

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

    TypeScript

    googletag.cmd.push(() => {
  googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads());
});
  • Parámetros
    ...f: Array<(this: typeof globalThis) => void>
    Función de JavaScript que se ejecutará. La vinculación del entorno de ejecución siempre será globalThis. Considera pasar una función de flecha para retener el valor this del contexto léxico que la contiene.
  • Devuelve
    number
    La cantidad de comandos procesados hasta el momento. Esto es compatible con el valor que se muestra de Array.push (la longitud actual del array).

googletag.CompanionAdsService

Extiende Service

de anuncios complementarios. Los anuncios de video usan este servicio para mostrar anuncios complementarios.

Resumen de métodos
addEventListener
Registra un objeto de escucha que te permite configurar una función de JavaScript y llamarla cuando se produce un evento de GPT específico en la página.
getSlots
Obtén la lista de ranuras asociadas con este servicio.
removeEventListener
Quita un objeto de escucha registrado previamente.
setRefreshUnfilledSlots
Establece si los espacios complementarios que no se completaron se reabastecerán automáticamente.
Consulta también

setRefreshUnfilledSlots

  • setRefreshUnfilledSlots(value: boolean): void

  • Establece si los espacios complementarios que no se completaron se reabastecerán automáticamente.

    Se puede llamar a este método varias veces durante el ciclo de vida de la página para activar y desactivar el reabastecimiento. Solo se reabastecerán los espacios que también están registrados con PubAdsService. Debido a restricciones de la política, este método no está diseñado para rellenar espacios complementarios vacíos cuando se publica un video de Ad Exchange.

  • Ejemplo

    JavaScript

    googletag.companionAds().setRefreshUnfilledSlots(true);

    JavaScript (heredado)

    googletag.companionAds().setRefreshUnfilledSlots(true);

    TypeScript

    googletag.companionAds().setRefreshUnfilledSlots(true);
  • Parámetros
    value: boolean
    true para reabastecer automáticamente las ranuras sin completar, false para dejarlas sin cambios.

googletag.PrivacySettingsConfig

Objeto de configuración para la configuración de privacidad.

Resumen de la propiedad
childDirectedTreatment
Indica si la página se debe tratar como dirigida a niños.
limitedAds
Permite que la publicación se ejecute en modo de anuncios limitados para satisfacer las necesidades de cumplimiento de las reglamentaciones para los publicadores.
nonPersonalizedAds
Permite que la publicación se ejecute en modo de anuncios no personalizados para satisfacer las necesidades de cumplimiento de las normativas de los publicadores.
restrictDataProcessing
Permite que la publicación se ejecute en modo de procesamiento restringido para satisfacer las necesidades de cumplimiento de las reglamentaciones de los publicadores.
trafficSource
Indica si las solicitudes representan tráfico orgánico o comprado.
underAgeOfConsent
Indica si se deben marcar las solicitudes de anuncios para indicar que provienen de usuarios que no alcanzan la edad de consentimiento.
Consulta también

childDirectedTreatment

  • childDirectedTreatment: null | boolean

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

limitedAds

  • limitedAds: boolean

  • Permite que la publicación se publique en el modo de anuncios limitados para satisfacer las necesidades de cumplimiento de las normativas de los publicadores.

    Puede configurar GPT para que solicite anuncios limitados de dos maneras:

    • Automáticamente, con un indicador de una plataforma de administración de consentimiento del MTC v2.0 de IAB
    • De forma manual, estableciendo el valor de este campo en true.
    Solo es posible configurar anuncios limitados de forma manual cuando se carga GPT desde la URL de anuncios limitados. Si intentas modificar este parámetro de configuración cuando se carga 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 utiliza 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

nonPersonalizedAds

  • nonPersonalizedAds: boolean

  • Permite que la publicación se ejecute en modo de anuncios no personalizados para satisfacer las necesidades de cumplimiento de las normativas de los publicadores.

restrictDataProcessing

  • restrictDataProcessing: boolean

  • Permite que la publicación se ejecute en modo de procesamiento restringido para satisfacer las necesidades de cumplimiento de las reglamentaciones de los publicadores.

trafficSource

  • trafficSource: TrafficSource

  • Indica si las solicitudes representan tráfico orgánico o comprado. Este valor propaga la dimensión Fuente de tráfico en los informes de Ad Manager. Si no la estableces, la fuente de tráfico se establecerá de forma predeterminada en undefined en los informes.

  • Ejemplo

    JavaScript

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

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

    JavaScript (heredado)

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

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

    TypeScript

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

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

underAgeOfConsent

  • underAgeOfConsent: null | boolean

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

googletag.PubAdsService

Extiende Service

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

Resumen de métodos
addEventListener
Registra un objeto de escucha que te permite configurar una función de JavaScript y llamarla cuando se produce un evento de GPT específico en la página.
clear
Quita los anuncios de los espacios específicos y los reemplaza con contenido en blanco.
clearCategoryExclusions
Borra todas las etiquetas de exclusión de categorías de anuncios a nivel de la página.
clearTargeting
Borra los parámetros de segmentación personalizada de una clave específica o de todas las claves.
collapseEmptyDivs
Habilita la contracción de los elementos div del espacio publicitario de modo que no ocupen espacio en la página cuando no haya contenido del anuncio para mostrar.
disableInitialLoad
Inhabilita las solicitudes de anuncios durante la carga de la página, pero permite que se soliciten con una llamada PubAdsService.refresh.
display
Crea y muestra un espacio publicitario con la ruta de acceso y el tamaño de la unidad de anuncios especificados.
enableLazyLoad
Habilita la carga diferida en GPT según lo define el objeto de configuración.
enableSingleRequest
Habilita el modo de solicitud única para recuperar varios anuncios al mismo tiempo.
enableVideoAds
Le indica a GPT que habrá anuncios de video en la página.
get
Muestra el valor del atributo de AdSense asociado con la clave especificada.
getAttributeKeys
Devuelve las claves de atributo que se configuraron en este servicio.
getSlots
Obtén la lista de ranuras asociadas con este servicio.
getTargeting
Devuelve un parámetro personalizado de segmentación a nivel de servicio específico que se estableció.
getTargetingKeys
Muestra la lista de todas las claves de segmentación personalizadas a nivel del servicio que se configuraron.
isInitialLoadDisabled
Muestra si una llamada anterior a PubAdsService.disableInitialLoad inhabilitó correctamente las solicitudes iniciales de anuncios.
refresh
Recupera y muestra anuncios nuevos para espacios específicos de la página o para todos.
removeEventListener
Quita un objeto de escucha registrado previamente.
set
Establece valores para los atributos de AdSense que se aplican a todos los espacios publicitarios del servicio de anuncios del publicador.
setCategoryExclusion
Establece una exclusión de categoría de anuncio a nivel de la página para el nombre de la etiqueta en cuestión.
setCentering
Habilita o inhabilita el enfoque horizontal de los anuncios.
setForceSafeFrame
Configura si se deben forzar todos los anuncios de la página para que se dibujen mediante un contenedor de SafeFrame.
setLocation
Pasa información de ubicación de sitios web para que puedas segmentar líneas de pedido por ubicación geográfica para ubicaciones específicas.
setPrivacySettings
Permite configurar todos los parámetros de configuración de privacidad desde una sola API mediante un objeto de configuración.
setPublisherProvidedId
Establece el valor del ID proporcionado por el publicador.
setSafeFrameConfig
Establece las preferencias de nivel de página para la configuración de SafeFrame.
setTargeting
Establece parámetros de segmentación personalizados para una clave determinada que se aplican a todos los espacios publicitarios del servicio de Anuncios del publicador.
setVideoContent
Establece la información del contenido de video que se enviará junto con las solicitudes de anuncios para fines de segmentación y exclusión de contenido.
updateCorrelator
Cambia el correlator que se envía con las solicitudes de anuncios, lo que inicia una nueva vista de página.

clear

  • clear(slots?: Slot[]): boolean

  • Quita los anuncios de los espacios específicos y los reemplaza con contenido en blanco. Los espacios se marcarán como no recuperados.

    En particular, si borras un espacio, se quitará el anuncio de la vista de página de larga duración de GPT, de modo que las publicaciones simultáneas o las exclusiones competitivas de este anuncio no influirán en las solicitudes futuras.

  • Ejemplo

    JavaScript

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

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

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

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

    JavaScript (heredado)

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

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

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

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

    TypeScript

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

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

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

// This call to clear all slots.
googletag.pubads().clear();
  • Parámetros
    slots?: Slot[]
    El array de ranuras que se borrará. El array es opcional. Si no se especifica, se borrarán todas las ranuras.
  • Devuelve
    boolean
    Muestra true si se borraron las ranuras; de lo contrario, muestra false.

clearCategoryExclusions

  • clearCategoryExclusions(): PubAdsService

  • Borra todas las etiquetas de exclusión de categorías de anuncios a nivel de la página. Esto es útil si deseas actualizar la ranura.

  • Ejemplo

    JavaScript

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

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

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

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

    JavaScript (heredado)

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

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

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

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

    TypeScript

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

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

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

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

clearTargeting

  • clearTargeting(key?: string): PubAdsService

  • Borra los parámetros de segmentación personalizada de una clave específica o de todas las claves.

  • Ejemplo

    JavaScript

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

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

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

    JavaScript (heredado)

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

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

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

    TypeScript

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

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

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

collapseEmptyDivs

  • collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean

  • Habilita la contracción de los elementos div del espacio publicitario de modo que no ocupen espacio en la página cuando no haya contenido del anuncio para mostrar. Este modo debe configurarse antes de que se habilite el servicio.

  • Consulta también
  • Parámetros
    collapseBeforeAdFetch?: boolean
    Establece 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.
  • Devuelve
    boolean
    Muestra true si se habilitó el modo de contracción de div y false si no es posible hacerlo porque se llamó al método después de que se habilitó el servicio.

disableInitialLoad

display

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

  • Crea y muestra un espacio publicitario con la ruta de acceso y el tamaño de la unidad de anuncios especificados. 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 página y el espacio publicitario para garantizar la coherencia cuando se envía la solicitud de anuncio y se renderiza la respuesta. Cualquier cambio que se realice en el espacio publicitario o en el estado de la página después de llamar a este método (incluidas la segmentación, la configuración de privacidad, la fuerza de SafeFrame, etc.) solo se aplicarán a las solicitudes display() o refresh() posteriores.

  • Ejemplo

    JavaScript

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

    JavaScript (heredado)

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

    TypeScript

    googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
    Consulta también
  • Parámetros
    adUnitPath: string
    Es la ruta de acceso de la unidad de anuncios del espacio que se renderizará.
    size: GeneralSize
    Es el ancho y la altura de la ranura.
    div?: string | Element
    Puede ser el ID del elemento div que contiene el espacio o el elemento div en sí.
    clickUrl?: string
    Es la URL de clic que se usará en este espacio.

enableLazyLoad

  • enableLazyLoad(config?: { fetchMarginPercent: number, mobileScaling: number, renderMarginPercent: number }): void

  • Habilita la carga diferida en GPT según lo define el objeto de configuración. Para ver ejemplos más detallados, consulta la muestra de carga diferida.

    Nota: La recuperación diferida en 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
    config?: { fetchMarginPercent: number, mobileScaling: number, renderMarginPercent: number }
    El objeto de configuración permite la personalización del comportamiento diferido. Cualquier configuración omitida usará un conjunto predeterminado de Google que se ajustará con el tiempo. Para inhabilitar una configuración en particular, como un margen de recuperación, establece el valor en -1.
    • fetchMarginPercent

      La distancia mínima del viewport actual a un espacio publicitario debe ser antes de que podamos recuperar el anuncio como un porcentaje del tamaño del viewport. El valor 0 significa "cuando el espacio publicitario ingresa al viewport", 100 significa "cuando el anuncio está a 1 viewport de distancia", y así sucesivamente.
    • renderMarginPercent

      La distancia mínima del viewport actual a un espacio publicitario debe ser antes de que rendericemos un anuncio. Esto permite la carga previa del anuncio, pero espera para renderizar y descargar otros subrecursos. El valor funciona igual que fetchMarginPercent como porcentaje del viewport.
    • mobileScaling

      Se aplica un multiplicador a los márgenes en dispositivos móviles. Esto permite variar los márgenes en los dispositivos móviles y en las computadoras de escritorio. Por ejemplo, un valor de 2.0 multiplicará todos los márgenes por 2 en los dispositivos móviles, lo que aumentará la distancia mínima que puede tener un espacio antes de 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 del publicador se definan y se agreguen a PubAdsService antes de habilitar el servicio. Se debe configurar el modo de solicitud única antes de habilitar el servicio.

  • Consulta también
  • Devuelve
    boolean
    Muestra true si se habilitó el modo de solicitud única y false si es imposible habilitar este modo porque se llamó al método después de que se habilitó el servicio.

enableVideoAds

  • enableVideoAds(): void

  • Le indica a GPT que habrá anuncios de video en la página. Esto habilita restricciones de exclusión competitiva en los anuncios gráficos y de video. Si el contenido de video es conocido, llama a PubAdsService.setVideoContent para poder usar la exclusión de contenido en los anuncios gráficos.

get

  • get(key: string): null | string

  • Muestra el valor del atributo de AdSense asociado con la clave especificada.

  • Ejemplo

    JavaScript

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

    JavaScript (heredado)

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

    TypeScript

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().get("adsense_background_color");
// Returns '#FFFFFF'.
    Consulta también
  • Parámetros
    key: string
    Es el nombre del atributo que se debe buscar.
  • Devuelve
    null | string
    Valor actual de la clave de 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'].
  • Devuelve
    string[]
    Array de claves de atributos establecidas en este servicio. El ordenamiento no está definido.

getTargeting

  • getTargeting(key: string): string[]

  • Devuelve un parámetro personalizado de segmentación a nivel de servicio específico que se estableció.

  • Ejemplo

    JavaScript

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

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

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

    JavaScript (heredado)

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

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

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

    TypeScript

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

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

googletag.pubads().getTargeting("age");
// Returns [] (empty array).
  • Parámetros
    key: string
    La clave de segmentación que se debe buscar.
  • Devuelve
    string[]
    Los valores asociados con esta clave o un array vacío si no existe tal clave.

getTargetingKeys

  • getTargetingKeys(): string[]

  • Muestra 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'].
  • Devuelve
    string[]
    Array de claves de segmentación. El ordenamiento no está definido.

isInitialLoadDisabled

refresh

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

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

    Para que el comportamiento sea adecuado en todos los navegadores, la llamada a refresh debe estar precedida por una llamada a display del espacio publicitario. Si se omite la llamada a display, es posible que la actualización se comporte de forma inesperada. Si lo desea, puede 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, de modo que las publicaciones simultáneas o las exclusiones competitivas que involucran ese anuncio no influirán en las solicitudes futuras.

  • Ejemplo

    JavaScript

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

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

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

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

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

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

    JavaScript (heredado)

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

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

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

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

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

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

    TypeScript

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

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

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

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

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

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

      Especifica si se generará o no un nuevo correlator para recuperar anuncios. Nuestros servidores de anuncios mantienen este valor de correlator durante un período breve (actualmente durante 30 segundos, pero están sujetos a cambios), de modo que las solicitudes con el mismo correlator recibidas muy cerca se considerarán una sola vista de página. De forma predeterminada, se genera un correlator nuevo para cada actualización.

      Nota: Esta opción no tiene efecto en la vista de página de larga duración de GPT, la cual refleja automáticamente los anuncios que se encuentran actualmente en la página y no tiene fecha de vencimiento.

set

  • set(key: string, value: string): PubAdsService

  • Establece valores para los atributos de AdSense que se aplican a todos los espacios publicitarios del servicio de anuncios del publicador.

    Si se llama más de una vez para la misma clave, se anularán los valores establecidos anteriormente para esa clave. Se deben establecer todos los valores 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: string
    Es el nombre del atributo.
    value: string
    Este es el valor del atributo.
  • Devuelve
    PubAdsService
    El objeto de servicio en el que se llamó al método.

setCategoryExclusion

  • setCategoryExclusion(categoryExclusion: string): PubAdsService

  • Establece una exclusión de categoría de anuncio a nivel de la página para el nombre de la etiqueta en cuestión.

  • Ejemplo

    JavaScript

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

    JavaScript (heredado)

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

    TypeScript

    // Label = AirlineAd.
googletag.pubads().setCategoryExclusion("AirlineAd");
    Consulta también
  • Parámetros
    categoryExclusion: string
    La etiqueta de exclusión de categoría de anuncio que se agregará.
  • Devuelve
    PubAdsService
    El objeto de servicio en el que se llamó al método.

setCentering

  • setCentering(centerAds: boolean): void

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

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

  • Ejemplo

    JavaScript

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

    JavaScript (heredado)

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

    TypeScript

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

setForceSafeFrame

  • setForceSafeFrame(forceSafeFrame: boolean): PubAdsService

  • Configura si se debe forzar la renderización de todos los anuncios de la página con un contenedor de SafeFrame.

    Cuando uses esta API, ten en cuenta lo siguiente:

    • Esta configuración solo se aplicará a las solicitudes de anuncios posteriores que se realicen para los espacios respectivos.
    • La configuración del nivel de espacio, si se especifica, siempre anulará la configuración a nivel de página.
    • Si se establece en true (a nivel del espacio publicitario o de la página), el anuncio siempre se renderizará con un contenedor de SafeFrame independiente de la opción elegida 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 salirse de sus iframes o que dependen de que se rendericen directamente en la página del publicador.

  • Ejemplo

    JavaScript

    googletag.pubads().setForceSafeFrame(true);

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

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

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

    JavaScript (heredado)

    googletag.pubads().setForceSafeFrame(true);

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

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

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

    TypeScript

    googletag.pubads().setForceSafeFrame(true);

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

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

googletag.display("div-1");
googletag.display("div-2");
    Consulta también
  • Parámetros
    forceSafeFrame: boolean
    true para forzar el dibujo de todos los anuncios de la página en SafeFrames y false para cambiar la configuración anterior a falsa. Establecer esta opción como false cuando no se haya especificado antes no cambiará nada.
  • Devuelve
    PubAdsService
    El objeto de servicio en el que se llamó a la función.

setLocation

  • setLocation(address: string): PubAdsService

  • Pasa información de ubicación de sitios web para que puedas segmentar líneas de pedido por ubicación geográfica para ubicaciones específicas.

  • Ejemplo

    JavaScript

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

    JavaScript (heredado)

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

    TypeScript

    // Postal code:
googletag.pubads().setLocation("10001,US");
  • Parámetros
    address: string
    Dirección en formato libre.
  • Devuelve
    PubAdsService
    El objeto de servicio en el que se llamó al método.

setPrivacySettings

  • setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService

  • Permite configurar todos los parámetros de configuración de privacidad desde una sola API mediante un objeto de configuración.

  • Ejemplo

    JavaScript

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

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

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

    JavaScript (heredado)

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

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

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

    TypeScript

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

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

// Clear the configuration for childDirectedTreatment.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: null,
});
    Consulta también
  • Parámetros
    privacySettings: PrivacySettingsConfig
    Objeto que contiene la configuración de la configuración de privacidad
  • Devuelve
    PubAdsService
    El objeto de servicio en el que se llamó a la función.

setPublisherProvidedId

  • setPublisherProvidedId(ppid: string): PubAdsService

  • Establece el valor del ID proporcionado por el publicador.

  • Ejemplo

    JavaScript

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

    JavaScript (heredado)

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

    TypeScript

    googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
    Consulta también
  • Parámetros
    ppid: string
    Es un ID alfanumérico proporcionado por el publicador. Debe tener entre 32 y 150 caracteres.
  • Devuelve
    PubAdsService
    El objeto de servicio en el que se llamó al método.

setSafeFrameConfig

  • setSafeFrameConfig(config: SafeFrameConfig): PubAdsService

  • Establece las preferencias de nivel de página para la configuración de SafeFrame. Se ignorará cualquier clave no reconocida en el objeto de configuración. Se ignorará toda la configuración si se pasa un valor no válido para una clave reconocida.

    Si se especifican, las preferencias a nivel de página anularán las preferencias a nivel de espacio.

  • Ejemplo

    JavaScript

    googletag.pubads().setForceSafeFrame(true);

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

const slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

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

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

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

    JavaScript (heredado)

    googletag.pubads().setForceSafeFrame(true);

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

var slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

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

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

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

    TypeScript

    googletag.pubads().setForceSafeFrame(true);

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

const slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

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

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

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

setTargeting

  • setTargeting(key: string, value: string | string[]): PubAdsService

  • Establece parámetros de segmentación personalizados para una clave determinada que se aplican a todos los espacios publicitarios del servicio de Anuncios del publicador. Si llamas a esta acción varias veces para la misma clave, se reemplazarán los valores anteriores. Estas claves se definen en tu cuenta de Google Ad Manager.

  • Ejemplo

    JavaScript

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

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

    JavaScript (heredado)

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

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

    TypeScript

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

// Example with multiple values for a key inside in an array.
googletag.pubads().setTargeting("interests", ["sports", "music"]);
    Consulta también
  • Parámetros
    key: string
    Clave del parámetro de segmentación.
    value: string | string[]
    Es el valor del parámetro de segmentación o el array de valores.
  • Devuelve
    PubAdsService
    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 fines de segmentación y exclusión de contenido. Los anuncios de video se habilitarán automáticamente cuando se invoque 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: string
    Es el ID de contenido del video.
    videoCmsId: string
    El ID de CMS de video.

updateCorrelator

  • updateCorrelator(): PubAdsService

  • Cambia el correlator 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 vista de página y es único para 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, la cual refleja automáticamente los anuncios que se muestran en la página y no tiene fecha de vencimiento.

  • Ejemplo

    JavaScript

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

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

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

    JavaScript (heredado)

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

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

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

    TypeScript

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

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

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

googletag.ResponseInformation

Es un objeto que representa una sola respuesta del anuncio.

Resumen de la propiedad
advertiserId
Es el ID del anunciante.
campaignId
El ID de la campaña.
creativeId
Es el ID de la creatividad.
creativeTemplateId
El ID de plantilla del anuncio.
lineItemId
El ID de la línea de pedido.
Consulta también

advertiserId

  • advertiserId: null | number

  • Es el ID del anunciante.

campaignId

  • campaignId: null | number

  • El ID de la campaña.

creativeId

  • creativeId: null | number

  • Es el ID de la creatividad.

creativeTemplateId

  • creativeTemplateId: null | number

  • El ID de plantilla del anuncio.

lineItemId

  • lineItemId: null | number

  • El ID de la línea de pedido.

googletag.RewardedPayload

Un objeto que representa la recompensa asociada con un anuncio recompensado

Resumen de la propiedad
amount
Indica la cantidad de artículos incluidos en la recompensa.
type
Indica el tipo de artículo incluido en la recompensa (por ejemplo, "moneda").
Consulta también

amount

  • amount: number

  • Indica la cantidad de artículos incluidos en la recompensa.

type

  • type: string

  • Indica el tipo de artículo incluido en la recompensa (por ejemplo, "moneda").

googletag.SafeFrameConfig

Objeto de configuración para contenedores de SafeFrame.

Resumen de la propiedad
allowOverlayExpansion
Si es posible que SafeFrame permita que el contenido del anuncio se expanda por medio de la superposición del contenido de la página.
allowPushExpansion
Establece si SafeFrame debe permitir que el contenido del anuncio se expanda al enviar el contenido de la página.
sandbox
Indica si SafeFrame debe usar el atributo de zona de pruebas HTML5 para evitar la navegación de nivel superior sin interacción del usuario.
useUniqueDomain
Obsoleto. Indica si SafeFrame debe usar subdominios aleatorizados para las creatividades de reservación.
Consulta también

allowOverlayExpansion

  • allowOverlayExpansion: boolean

  • Si es posible que SafeFrame permita que el contenido del anuncio se expanda por medio de la superposición del contenido de la página.

allowPushExpansion

  • allowPushExpansion: boolean

  • Establece si SafeFrame debe permitir que el contenido del anuncio se expanda al enviar el contenido de la página.

sandbox

  • sandbox: boolean

  • Indica si SafeFrame debe usar el atributo de zona de pruebas HTML5 para evitar la navegación de nivel superior sin interacción del usuario. El único valor válido es true (no se puede forzar a false). Ten en cuenta que el atributo de la zona de pruebas inhabilita los complementos (p.ej., Flash).

useUniqueDomain

  • useUniqueDomain: null | boolean

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

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

  • Consulta también

googletag.Service

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

Resumen de métodos
addEventListener
Registra un objeto de escucha que te permite configurar una función de JavaScript y llamarla cuando se produce un evento de GPT específico en la página.
getSlots
Obtén la lista de ranuras asociadas con este servicio.
removeEventListener
Quita un objeto de escucha registrado previamente.

addEventListener

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

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

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

  • Ejemplo

    JavaScript

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

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

    JavaScript (heredado)

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

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

    TypeScript

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

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

getSlots

  • getSlots(): Slot[]

  • Obtén la lista de ranuras asociadas con este servicio.

  • Devuelve
    Slot[]
    Ranuras 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: K
    Es una cadena que representa el tipo de evento que genera GPT. Los tipos de eventos distinguen mayúsculas de minúsculas.
    listener: (event: EventTypeMap[K]) => void
    Es una función que toma un solo argumento de objeto de evento.

googletag.SizeMappingBuilder

Compilador para objetos de especificación de asignación de tamaño. Se proporciona este compilador para ayudar a construir especificaciones de tamaño con facilidad.

Resumen de métodos
addSize
Agrega una asignación de un array de tamaño único (que representa el viewport) a un array de uno o varios tamaños que representa la ranura.
build
Compila una especificación de mapa de tamaño a partir de las asignaciones agregadas a este compilador.
Consulta también

addSize

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

  • Agrega una asignación de un array de tamaño único (que representa el viewport) a un array de uno o varios tamaños que representa la ranura.

  • Ejemplo

    JavaScript

    // Mapping 1
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [728, 90])
  .addSize([640, 480], "fluid")
  .addSize([0, 0], [88, 31]) // All viewports < 640x480
  .build();

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

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

    JavaScript (heredado)

    // Mapping 1
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [728, 90])
  .addSize([640, 480], "fluid")
  .addSize([0, 0], [88, 31]) // All viewports < 640x480
  .build();

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

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

    TypeScript

    // Mapping 1
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [728, 90])
  .addSize([640, 480], "fluid")
  .addSize([0, 0], [88, 31]) // All viewports < 640x480
  .build();

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

// Mapping 2 will not show any ads for the following viewport sizes:
// [1024, 768] > size >= [980, 690] and
// [640, 480] > size >= [0, 0]
  • Parámetros
    viewportSize: SingleSizeArray
    El tamaño del viewport para esta entrada de asignación.
    slotSize: GeneralSize
    Son los tamaños del espacio para esta entrada de asignación.
  • Devuelve
    SizeMappingBuilder
    Es una referencia a este compilador.

build

  • build(): null | SizeMappingArray

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

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

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

  • Devuelve
    null | SizeMappingArray
    El resultado que compiló este compilador. Puede ser nulo si se proporcionaron asignaciones de tamaño no válidas.

googletag.Slot

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

Resumen de métodos
addService
Agrega un Service a este espacio.
clearCategoryExclusions
Borra todas las etiquetas de exclusión de categoría de anuncio a nivel del espacio para este espacio.
clearTargeting
Borra los parámetros de segmentación específicos o personalizados a nivel del espacio para este espacio.
defineSizeMapping
Establece un array de asignaciones desde un tamaño mínimo de viewport hasta el tamaño de ranura para este espacio.
get
Muestra el valor del atributo de AdSense asociado a la clave especificada para este espacio.
getAdUnitPath
Muestra la ruta completa de la unidad de anuncios, con el código de red y la ruta de la unidad de anuncios.
getAttributeKeys
Devuelve la lista de claves de atributos establecidas en este espacio.
getCategoryExclusions
Muestra las etiquetas de exclusión de categorías de anuncios para este espacio.
getResponseInformation
Muestra la información de la respuesta del anuncio.
getSlotElementId
Devuelve el ID del espacio div proporcionado cuando se definió el espacio.
getTargeting
Devuelve un parámetro de segmentación personalizado específico configurado en este espacio publicitario.
getTargetingKeys
Muestra la lista de todas las claves de segmentación personalizadas establecidas en este espacio.
set
Establece un valor para un atributo de AdSense en este espacio publicitario.
setCategoryExclusion
Establece una etiqueta de exclusión de categoría de anuncio a nivel del espacio en este espacio.
setClickUrl
Establece la URL de clic a la que se redireccionará a los usuarios después de hacer clic en el anuncio.
setCollapseEmptyDiv
Establece si el espacio div se debe ocultar cuando no hay ningún anuncio en él.
setConfig
Establece las opciones de configuración generales para esta ranura.
setForceSafeFrame
Configura si se debe forzar la renderización de los anuncios de este espacio publicitario mediante un contenedor de SafeFrame.
setSafeFrameConfig
Establece las preferencias a nivel del espacio publicitario para la configuración de SafeFrame.
setTargeting
Establece un parámetro de segmentación personalizado para este espacio.
updateTargetingFromMap
Establece parámetros de segmentación personalizados para este espacio, a partir de un mapa de par clave-valor en un objeto JSON.

addService

  • addService(service: Service): Slot

  • Agrega un Service 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: Service
    El servicio que se agregará.
  • Devuelve
    Slot
    El objeto de ranura en el que se llamó al método.

clearCategoryExclusions

  • clearCategoryExclusions(): Slot

  • Borra todas las etiquetas de exclusión de categoría de anuncio 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.
  • Devuelve
    Slot
    El objeto de ranura en el que se llamó al método.

clearTargeting

  • clearTargeting(key?: string): Slot

  • Borra los parámetros de segmentación específicos o 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
    key?: string
    Clave del parámetro de segmentación. La clave es opcional. Si no se especifica, se borrarán todos los parámetros de segmentación.
  • Devuelve
    Slot
    El objeto de ranura en el que se llamó al método.

defineSizeMapping

  • defineSizeMapping(sizeMapping: SizeMappingArray): Slot

  • Establece un array de asignaciones desde un tamaño mínimo de viewport hasta el tamaño de ranura para este espacio.

  • Ejemplo

    JavaScript

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

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

slot.defineSizeMapping(mapping);

    JavaScript (heredado)

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

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

slot.defineSizeMapping(mapping);

    TypeScript

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

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

slot.defineSizeMapping(mapping!);
    Consulta también
  • Parámetros
    sizeMapping: SizeMappingArray
    Arreglo de asignaciones de tamaño. Puedes usar SizeMappingBuilder para crearla. Cada asignación de tamaño es un array de dos elementos: SingleSizeArray y GeneralSize.
  • Devuelve
    Slot
    El objeto de ranura en el que se llamó al método.

get

  • get(key: string): null | string

  • Muestra el valor del atributo de AdSense asociado a la clave especificada para este espacio. Para ver los atributos de nivel de 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: string
    Es el nombre del atributo que se debe buscar.
  • Devuelve
    null | string
    Valor actual de la clave de atributo o null si la clave no está presente.

getAdUnitPath

  • getAdUnitPath(): string

  • Muestra la ruta completa de la unidad de anuncios, con el código de red y la ruta de la unidad de anuncios.

  • Ejemplo

    JavaScript

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

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

    JavaScript (heredado)

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

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

    TypeScript

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

slot.getAdUnitPath();
// Returns '/1234567/sports'.
  • Devuelve
    string
    Ruta de acceso de la unidad de anuncios.

getAttributeKeys

  • getAttributeKeys(): string[]

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

  • Ejemplo

    JavaScript

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

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

    JavaScript (heredado)

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

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

    TypeScript

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

slot.getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].
  • Devuelve
    string[]
    Array de claves de atributo. El ordenamiento no está definido.

getCategoryExclusions

  • getCategoryExclusions(): string[]

  • Muestra 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'].
  • Devuelve
    string[]
    Las etiquetas de exclusión de categorías de anuncios para este espacio publicitario o un array vacío si no se estableció ninguno.

getResponseInformation

  • getResponseInformation(): null | ResponseInformation

  • Muestra la información de la respuesta del anuncio. Se basa en la última respuesta del anuncio para el espacio. Si se llama a este método cuando el espacio publicitario no tiene anuncio, se mostrará null.

  • Devuelve
    null | ResponseInformation
    La información más reciente sobre la respuesta del anuncio o null si el espacio no tiene ningún anuncio.

getSlotElementId

  • getSlotElementId(): string

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

  • Ejemplo

    JavaScript

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

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

    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'.
  • Devuelve
    string
    ID de la ranura div.

getTargeting

  • getTargeting(key: string): string[]

  • Devuelve un parámetro de segmentación personalizado específico configurado en este espacio publicitario. No se incluyen los parámetros de segmentación a nivel 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: string
    La clave de segmentación que se debe buscar.
  • Devuelve
    string[]
    Los valores asociados con esta clave o un array vacío si no existe tal clave.

getTargetingKeys

  • getTargetingKeys(): string[]

  • Muestra la lista de todas las claves de segmentación personalizadas establecidas en este espacio. Las claves de segmentación a nivel del servicio no están incluidas.

  • Ejemplo

    JavaScript

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

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

    JavaScript (heredado)

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

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

    TypeScript

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

slot.getTargetingKeys();
// Returns ['interests', 'allow_expandable'].
  • Devuelve
    string[]
    Array de claves de segmentación. El ordenamiento no está definido.

set

  • set(key: string, value: string): Slot

  • Establece un valor para un atributo de AdSense en este espacio publicitario. Esta acción anulará cualquier valor establecido en el nivel de servicio para esta clave.

    Si llamas a este método más de una vez para la misma clave, se anularán los valores ya establecidos para esa clave. Se deben establecer todos los valores 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: string
    Es el nombre del atributo.
    value: string
    Este es el valor del atributo.
  • Devuelve
    Slot
    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: string
    La etiqueta de exclusión de categoría de anuncio que se agregará.
  • Devuelve
    Slot
    El objeto de ranura en el que se llamó al método.

setClickUrl

  • setClickUrl(value: string): Slot

  • Establece la URL de clic a la que se redireccionará a los usuarios después de hacer clic en el anuncio.

    Los servidores de Google Ad Manager aún registran un clic, incluso si se reemplaza la URL de clic. Cualquier URL de página de destino asociada con la creatividad que se publica se agrega al valor proporcionado. Las llamadas posteriores reemplazan el valor. Esto funciona solo 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: string
    La URL de clic que se configurará.
  • Devuelve
    Slot
    El objeto de ranura en el que se llamó al método.

setCollapseEmptyDiv

  • setCollapseEmptyDiv(collapse: boolean, collapseBeforeAdFetch?: boolean): Slot

  • Establece si el espacio div se debe ocultar cuando no hay ningún anuncio en él. Esto anula la configuración de nivel de servicio.

  • Ejemplo

    JavaScript

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

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

    JavaScript (heredado)

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

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

    TypeScript

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

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

setConfig

  • setConfig(slotConfig: SlotSettingsConfig): void

  • Establece las opciones de configuración generales para esta ranura.

  • Parámetros
    slotConfig: SlotSettingsConfig
    El objeto de configuración.

setForceSafeFrame

  • setForceSafeFrame(forceSafeFrame: boolean): Slot

  • Configura si se deben renderizar los anuncios de este espacio publicitario de manera forzosa con un contenedor de SafeFrame.

    Cuando use esta API, tenga en cuenta lo siguiente:

    • Esta configuración solo se aplicará a las solicitudes de anuncios posteriores que se realicen para los espacios respectivos.
    • La configuración del nivel de espacio, si se especifica, siempre anulará la configuración a nivel de página.
    • Si se establece en true (a nivel del espacio publicitario o de la página), el anuncio siempre se renderizará con un contenedor de SafeFrame independiente de la opción elegida 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 salirse de sus iframes o que dependen de que se rendericen directamente en la página del publicador.

  • Ejemplo

    JavaScript

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

    JavaScript (heredado)

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

    TypeScript

    googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setForceSafeFrame(true)
  .addService(googletag.pubads());
    Consulta también
  • Parámetros
    forceSafeFrame: boolean
    true para forzar que todos los anuncios de este espacio se dibujen en SafeFrames y false para inhabilitar una configuración a nivel de la página (si existe). Si la estableces como false cuando no se especifique a nivel de la página, no se modificará nada.
  • Devuelve
    Slot
    El objeto de ranura en el que se llamó al método.

setSafeFrameConfig

  • setSafeFrameConfig(config: null | SafeFrameConfig): Slot

  • Establece las preferencias a nivel del espacio publicitario para la configuración de SafeFrame. Se ignorará cualquier clave no reconocida en el objeto de configuración. Se ignorará toda la configuración si se pasa un valor no válido para una clave reconocida.

    Si se especifican, estas preferencias a nivel de ranura anularán cualquier preferencia a nivel de página.

  • Ejemplo

    JavaScript

    googletag.pubads().setForceSafeFrame(true);

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

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

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

    JavaScript (heredado)

    googletag.pubads().setForceSafeFrame(true);

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

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

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

    TypeScript

    googletag.pubads().setForceSafeFrame(true);

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

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

googletag.display("div-1");
googletag.display("div-2");
    Consulta también
  • Parámetros
    config: null | SafeFrameConfig
    El objeto de configuración.
  • Devuelve
    Slot
    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 llamas a este método varias veces para la misma clave, se reemplazarán los valores anteriores. Los valores que se establezcan aquí reemplazarán los parámetros de segmentación establecidos a nivel del servicio. Estas claves se definen en tu cuenta de Google Ad Manager.

  • Ejemplo

    JavaScript

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

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

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

    JavaScript (heredado)

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

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

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

    TypeScript

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

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

// Example with multiple values for a key inside in an array.
slot.setTargeting("interests", ["sports", "music"]);
    Consulta también
  • Parámetros
    key: string
    Clave del parámetro de segmentación.
    value: string | string[]
    Es el valor del parámetro de segmentación o el array de valores.
  • Devuelve
    Slot
    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 par clave-valor en un objeto JSON. Esto es lo mismo que llamar a Slot.setTargeting para todos los pares clave-valor del objeto. Estas claves se definen en tu cuenta de Google Ad Manager.

    Notas:

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

  • Ejemplo

    JavaScript

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

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

    JavaScript (heredado)

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

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

    TypeScript

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

slot.updateTargetingFromMap({
  color: "red",
  interests: ["sports", "music", "movies"],
});
  • Parámetros
    map: {  [adUnitPath: string]: string | string[] }
    Mapa de par clave-valor del parámetro de segmentación.
  • Devuelve
    Slot
    El objeto de ranura en el que se llamó al método.

googletag.config.AdExpansionConfig

Configuración para controlar la expansión de anuncios.

Resumen de la propiedad
enabled
Si la expansión de anuncios está habilitada o inhabilitada.
Ejemplo

JavaScript

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

JavaScript (heredado)

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

TypeScript

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

enabled

googletag.config.ComponentAuctionConfig

Es un objeto que representa una subasta de un solo componente en una subasta de anuncios integrada en el dispositivo.

Resumen de la propiedad
auctionConfig
Es un objeto de configuración de subasta para la subasta de este componente.
configKey
Es la clave de configuración asociada con la subasta de este componente.
Consulta también

auctionConfig

  • auctionConfig: null | { auctionSignals: unknown, decisionLogicUrl: string, interestGroupBuyers: string[], perBuyerExperimentGroupIds: {  [buyer: string]: number }, perBuyerGroupLimits: {  [buyer: string]: number }, perBuyerSignals: {  [buyer: string]: unknown }, perBuyerTimeouts: {  [buyer: string]: number }, seller: string, sellerExperimentGroupId: number, sellerSignals: unknown, sellerTimeout: number, trustedScoringSignalsUrl: string }

  • Un objeto de configuración de subasta para la subasta de este componente.

    Si este valor se establece 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 con la subasta de este componente.

    Este valor no puede estar vacío y debe ser único. Si dos objetos ComponentAuctionConfig comparten el mismo valor de configKey, el último que se configure reemplazará los parámetros de configuración anteriores.

googletag.config.InterstitialConfig

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

Resumen de la propiedad
triggers
Es la configuración del activador de anuncios intersticiales.

triggers

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

  • La configuración del activador de anuncios intersticiales para este anuncio intersticial.

    Si estableces el valor de un activador de anuncios intersticiales en true, se habilitará, y false lo inhabilitará. Esto anulará los valores predeterminados configurados en Google Ad Manager.

  • Ejemplo

    JavaScript

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

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

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

    JavaScript (heredado)

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

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

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

    TypeScript

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

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

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

googletag.config.PageSettingsConfig

Interfaz de configuración principal para parámetros a nivel de página.

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

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

Ejemplos:

  • Solo se modifican los componentes especificados en la llamada a setConfig. 
      // Configure feature alpha.
  googletag.setConfig({
      alpha: {...}
  });

  // Configure feature bravo. Feature alpha is unchanged.
  googletag.setConfig({
     bravo: {...}
  });
  • Toda la configuración de una función determinada se actualiza con cada llamada a setConfig. 
      // Configure feature charlie to echo = 1, foxtrot = true.
  googletag.setConfig({
      charlie: {
          echo: 1,
          foxtrot: true,
      }
  });

  // Update feature charlie to echo = 2. Since foxtrot was not specified,
  // the value is cleared.
  googletag.setConfig({
      charlie: {
          echo: 2
      }
  });
  • Para borrar toda la 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,
  });

Resumen de la propiedad
adExpansion
Configuración para controlar la expansión de anuncios.
pps
Configuración para controlar los indicadores proporcionados por el publicador (PPS).
privacyTreatments
Configuración para controlar los tratamientos de privacidad del publicador.

adExpansion

  • adExpansion: null | AdExpansionConfig

  • Configuración para controlar la expansión de anuncios.

pps

privacyTreatments

  • privacyTreatments: null | PrivacyTreatmentsConfig

  • Configuración para controlar los tratamientos de privacidad del publicador.

googletag.config.PrivacyTreatmentsConfig

Configuración para controlar los tratamientos de privacidad del publicador.

Resumen de la propiedad
treatments
Una variedad de tratamientos con la privacidad de los publicadores que se pueden habilitar.

treatments

  • treatments: "disablePersonalization"[]

  • Una variedad de tratamientos con la privacidad de los publicadores que se pueden habilitar.

  • Ejemplo

    JavaScript

    // Disable personalization across the entire page.
googletag.setConfig({
  privacyTreatments: { treatments: ["disablePersonalization"] },
});

    JavaScript (heredado)

    // Disable personalization across the entire page.
googletag.setConfig({
  privacyTreatments: { treatments: ["disablePersonalization"] },
});

    TypeScript

    // Disable personalization across the entire page.
googletag.setConfig({
  privacyTreatments: { treatments: ["disablePersonalization"] },
});

googletag.config.PublisherProvidedSignalsConfig

Objeto de configuración de indicadores proporcionados por el publicador (PPS).

Resumen de la propiedad
taxonomies
Un objeto que contiene asignaciones de Taxonomía.
Ejemplo

JavaScript

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

JavaScript (heredado)

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

TypeScript

googletag.setConfig({
  pps: {
    taxonomies: {
      IAB_AUDIENCE_1_1: { values: ["6", "626"] },
      // '6' = 'Demographic | Age Range | 18-20'
      // '626' = 'Interest | Sports | Darts'
      IAB_CONTENT_2_2: { values: ["48", "127"] },
      // '48' = 'Books and Literature | Fiction'
      // '127' = 'Careers | Job Search'
    },
  },
});
Consulta también

taxonomies

googletag.config.SlotSettingsConfig

Interfaz de configuración principal para la configuración a nivel de espacio.

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

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

Ejemplos:

  • Solo se modifican los componentes especificados en la llamada a Slot.setConfig. 
      const slot = googletag.defineSlot("/1234567/example", [160, 600]);

  // Configure feature alpha.
  slot.setConfig({
      alpha: {...}
  });

  // Configure feature bravo. Feature alpha is unchanged.
  slot.setConfig({
     bravo: {...}
  });
  • Toda la configuración de una función determinada se actualiza con cada llamada a Slot.setConfig. 
      // Configure feature charlie to echo = 1, foxtrot = true.
  slot.setConfig({
      charlie: {
          echo: 1,
          foxtrot: true,
      }
  });

  // Update feature charlie to echo = 2. Since foxtrot was not specified,
  // the value is cleared.
  slot.setConfig({
      charlie: {
          echo: 2
      }
  });
  • Para borrar toda la configuración de una función, pasa null. 
      // Configure features delta, golf, and hotel.
  slot.setConfig({
      delta: {...},
      golf: {...},
      hotel: {...},
  });

  // Feature delta and hotel are cleared, but feature golf remains set.
  slot.setConfig({
      delta: null,
      hotel: null,
  });

Resumen de la propiedad
adExpansion
Configuración para controlar la expansión de anuncios.
componentAuction
Es un conjunto de subastas de componentes que se incluirán en una subasta de anuncios integrada en el dispositivo.
interstitial
Son parámetros de configuración que controlan el comportamiento de los espacios publicitarios intersticiales.

adExpansion

  • adExpansion: AdExpansionConfig

  • Configuración para controlar la expansión de anuncios.

componentAuction

  • componentAuction: ComponentAuctionConfig[]

  • Es un conjunto de subastas de componentes que se incluirán en una subasta de anuncios integrada en el dispositivo.

interstitial

  • interstitial: InterstitialConfig

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

googletag.config.TaxonomyData

Un objeto que contiene los valores de una sola Taxonomía.

Resumen de la propiedad
values
Una lista de valores de Taxonomía.

values

  • values: string[]

  • Una lista de valores de Taxonomía.

googletag.events.Event

Interfaz base para todos los eventos de GPT. Todos los eventos de GPT que aparecen a continuación tendrán los campos que se indican a continuación.

Resumen de la propiedad
serviceName
Es el nombre del servicio que activó el evento.
slot
Es el espacio que activó el evento.
Consulta también

serviceName

  • serviceName: string

  • Es el nombre del servicio que activó el evento.

slot

  • slot: Slot

  • Es el espacio que activó el evento.

googletag.events.EventTypeMap

Este es un seudotipo que asigna un nombre de evento a su tipo de objeto de evento correspondiente para Service.addEventListener y Service.removeEventListener. Está documentado solo como referencia y con fines de seguridad de tipos.

Resumen de la propiedad
impressionViewable
rewardedSlotClosed
rewardedSlotGranted
rewardedSlotReady
slotOnload
slotRenderEnded
slotRequested
slotResponseReceived
slotVisibilityChanged

impressionViewable

rewardedSlotClosed

rewardedSlotGranted

rewardedSlotReady

slotOnload

slotRenderEnded

slotRequested

slotResponseReceived

slotVisibilityChanged

googletag.events.ImpressionViewableEvent

Extiende Event

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

Resumen de la propiedad
serviceName
Es el nombre del servicio que activó el evento.
slot
Es el espacio que activó el evento.
Ejemplo

JavaScript

// This listener is called when an impression becomes viewable.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("impressionViewable", (event) => {
  const slot = event.slot;
  console.log("Impression for slot", slot.getSlotElementId(), "became viewable.");

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

JavaScript (heredado)

// This listener is called when an impression becomes viewable.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("impressionViewable", function (event) {
  var slot = event.slot;
  console.log("Impression for slot", slot.getSlotElementId(), "became viewable.");

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

TypeScript

// This listener is called when an impression becomes viewable.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("impressionViewable", (event) => {
  const slot = event.slot;
  console.log("Impression for slot", slot.getSlotElementId(), "became viewable.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
Consulta también

googletag.events.RewardedSlotClosedEvent

Extiende Event

Este evento se activa cuando el usuario cierra un espacio publicitario recompensado. Es posible que se active antes o después de que se haya otorgado la recompensa. Para determinar si se otorgó una recompensa, usa events.RewardedSlotGrantedEvent en su lugar.

Resumen de la propiedad
serviceName
Es el nombre del servicio que activó el evento.
slot
Es el espacio que activó el evento.
Ejemplo

JavaScript

// This listener is called when the user closes a rewarded ad slot.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotClosed", (event) => {
  const slot = event.slot;
  console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed.");

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

JavaScript (heredado)

// This listener is called when the user closes a rewarded ad slot.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotClosed", function (event) {
  var slot = event.slot;
  console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed.");

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

TypeScript

// This listener is called when the user closes a rewarded ad slot.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotClosed", (event) => {
  const slot = event.slot;
  console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
Consulta también

googletag.events.RewardedSlotGrantedEvent

Extiende Event

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

Resumen de la propiedad
payload
Un objeto que contiene información sobre la recompensa que se otorgó.
serviceName
Es el nombre del servicio que activó el evento.
slot
Es el espacio que activó el evento.
Ejemplo

JavaScript

// This listener is called whenever a reward is granted for a
// rewarded ad.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotGranted", (event) => {
  const slot = event.slot;
  console.group("Reward granted for slot", slot.getSlotElementId(), ".");

  // Log details of the reward.
  console.log("Reward type:", event.payload?.type);
  console.log("Reward amount:", event.payload?.amount);
  console.groupEnd();

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

JavaScript (heredado)

// This listener is called whenever a reward is granted for a
// rewarded ad.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotGranted", function (event) {
  var _a, _b;
  var slot = event.slot;
  console.group("Reward granted for slot", slot.getSlotElementId(), ".");

  // Log details of the reward.
  console.log("Reward type:", (_a = event.payload) === null || _a === void 0 ? void 0 : _a.type);
  console.log(
    "Reward amount:",
    (_b = event.payload) === null || _b === void 0 ? void 0 : _b.amount
  );
  console.groupEnd();

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

TypeScript

// This listener is called whenever a reward is granted for a
// rewarded ad.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotGranted", (event) => {
  const slot = event.slot;
  console.group("Reward granted for slot", slot.getSlotElementId(), ".");

  // Log details of the reward.
  console.log("Reward type:", event.payload?.type);
  console.log("Reward amount:", event.payload?.amount);
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
Consulta también

payload

  • payload: null | RewardedPayload

  • Un objeto que contiene información sobre la recompensa que se otorgó.

googletag.events.RewardedSlotReadyEvent

Extiende Event

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

Resumen de la propiedad
serviceName
Es el nombre del servicio que activó el evento.
slot
Es el espacio que activó el evento.
Resumen de métodos
makeRewardedVisible
Muestra el anuncio recompensado.
Ejemplo

JavaScript

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotReady", (event) => {
  const slot = event.slot;
  console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

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

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

JavaScript (heredado)

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotReady", function (event) {
  var slot = event.slot;
  console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

  // Replace with custom logic.
  var userHasConsented = true;
  if (userHasConsented) {
    event.makeRewardedVisible();
  }

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

TypeScript

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotReady", (event) => {
  const slot = event.slot;
  console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

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

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
Consulta también

makeRewardedVisible

  • makeRewardedVisible(): void

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

googletag.events.SlotOnloadEvent

Extiende Event

Este evento se activa cuando el iframe de la creatividad activa su evento de carga. Cuando se renderizan anuncios rich media en el modo de renderización síncrona, no se usa ningún iframe, por lo que no se activará ningún SlotOnloadEvent.

Resumen de la propiedad
serviceName
Es el nombre del servicio que activó el evento.
slot
Es el espacio que activó el evento.
Ejemplo

JavaScript

// This listener is called when a creative iframe load event fires.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", (event) => {
  const slot = event.slot;
  console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded.");

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

JavaScript (heredado)

// This listener is called when a creative iframe load event fires.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", function (event) {
  var slot = event.slot;
  console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded.");

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

TypeScript

// This listener is called when a creative iframe load event fires.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", (event) => {
  const slot = event.slot;
  console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
Consulta también

googletag.events.SlotRenderEndedEvent

Extiende Event

Este evento se activa cuando se inserta el código de la creatividad en un espacio. Este evento ocurrirá antes de que se recuperen los recursos de la creatividad, por lo que es posible que la creatividad aún no esté visible. Si necesitas saber cuándo terminaron de cargarse todos los recursos de creatividades de un espacio, considera usar events.SlotOnloadEvent.

Resumen de la propiedad
advertiserId
Es el ID del anunciante del anuncio renderizado.
campaignId
Es el ID de campaña del anuncio renderizado.
companyIds
Son los ID de las empresas que ofertan en el anuncio de reabastecimiento renderizado.
creativeId
Es el ID de la creatividad del anuncio de reservación renderizado.
creativeTemplateId
Es el ID de la plantilla de creatividad del anuncio de reservación renderizado.
isBackfill
Indica si un anuncio era de reabastecimiento.
isEmpty
Indica si se mostró un anuncio para el espacio.
labelIds
Son los ID de etiqueta del anuncio renderizado.
lineItemId
Es el ID de línea de pedido del anuncio de reservación renderizado.
serviceName
Es el nombre del servicio que activó el evento.
size
Indica el tamaño en píxeles de la creatividad renderizada.
slot
Es el espacio que activó el evento.
slotContentChanged
Indica si el contenido del espacio se cambió con el anuncio renderizado.
sourceAgnosticCreativeId
Es el ID de la creatividad de la reserva renderizada o del anuncio de reabastecimiento.
sourceAgnosticLineItemId
Es el ID de la línea de pedido del anuncio de reabastecimiento o de reserva renderizado.
yieldGroupIds
Son los ID de los grupos de rendimiento del anuncio de reabastecimiento renderizado.
Ejemplo

JavaScript

// This listener is called when a slot has finished rendering.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRenderEnded", (event) => {
  const slot = event.slot;
  console.group("Slot", slot.getSlotElementId(), "finished rendering.");

  // Log details of the rendered ad.
  console.log("Advertiser ID:", event.advertiserId);
  console.log("Campaign ID:", event.campaignId);
  console.log("Company IDs:", event.companyIds);
  console.log("Creative ID:", event.creativeId);
  console.log("Creative Template ID:", event.creativeTemplateId);
  console.log("Is backfill?:", event.isBackfill);
  console.log("Is empty?:", event.isEmpty);
  console.log("Label IDs:", event.labelIds);
  console.log("Line Item ID:", event.lineItemId);
  console.log("Size:", event.size);
  console.log("Slot content changed?", event.slotContentChanged);
  console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId);
  console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId);
  console.log("Yield Group IDs:", event.yieldGroupIds);
  console.groupEnd();

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

JavaScript (heredado)

// This listener is called when a slot has finished rendering.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRenderEnded", function (event) {
  var slot = event.slot;
  console.group("Slot", slot.getSlotElementId(), "finished rendering.");

  // Log details of the rendered ad.
  console.log("Advertiser ID:", event.advertiserId);
  console.log("Campaign ID:", event.campaignId);
  console.log("Company IDs:", event.companyIds);
  console.log("Creative ID:", event.creativeId);
  console.log("Creative Template ID:", event.creativeTemplateId);
  console.log("Is backfill?:", event.isBackfill);
  console.log("Is empty?:", event.isEmpty);
  console.log("Label IDs:", event.labelIds);
  console.log("Line Item ID:", event.lineItemId);
  console.log("Size:", event.size);
  console.log("Slot content changed?", event.slotContentChanged);
  console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId);
  console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId);
  console.log("Yield Group IDs:", event.yieldGroupIds);
  console.groupEnd();

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

TypeScript

// This listener is called when a slot has finished rendering.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRenderEnded", (event) => {
  const slot = event.slot;
  console.group("Slot", slot.getSlotElementId(), "finished rendering.");

  // Log details of the rendered ad.
  console.log("Advertiser ID:", event.advertiserId);
  console.log("Campaign ID:", event.campaignId);
  console.log("Company IDs:", event.companyIds);
  console.log("Creative ID:", event.creativeId);
  console.log("Creative Template ID:", event.creativeTemplateId);
  console.log("Is backfill?:", event.isBackfill);
  console.log("Is empty?:", event.isEmpty);
  console.log("Label IDs:", event.labelIds);
  console.log("Line Item ID:", event.lineItemId);
  console.log("Size:", event.size);
  console.log("Slot content changed?", event.slotContentChanged);
  console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId);
  console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId);
  console.log("Yield Group IDs:", event.yieldGroupIds);
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
Consulta también

advertiserId

  • advertiserId: null | number

  • Es el ID del anunciante del anuncio renderizado. El valor es null para espacios vacíos, anuncios de reabastecimiento y creatividades que renderizan servicios distintos de PubAdsService.

campaignId

  • campaignId: null | number

  • Es el ID de campaña del anuncio renderizado. El valor es null para espacios vacíos, anuncios de reabastecimiento y creatividades que renderizan servicios distintos de PubAdsService.

companyIds

  • companyIds: null | number[]

  • Son los ID de las empresas que ofertan en el anuncio de reabastecimiento renderizado. El valor es null para espacios vacíos, anuncios de reservación y creatividades que renderizan servicios distintos de PubAdsService.

creativeId

  • creativeId: null | number

  • Es el ID de la creatividad del anuncio de reservación renderizado. El valor es null para espacios vacíos, anuncios de reabastecimiento y creatividades que renderizan servicios distintos de PubAdsService.

creativeTemplateId

  • creativeTemplateId: null | number

  • Es el ID de la plantilla de creatividad del anuncio de reservación renderizado. El valor es null para espacios vacíos, anuncios de reabastecimiento y creatividades que renderizan servicios distintos de PubAdsService.

isBackfill

  • isBackfill: boolean

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

isEmpty

  • isEmpty: boolean

  • Indica si se mostró un anuncio para el espacio. El valor es true si no se muestra ningún anuncio. De lo contrario, es false.

labelIds

  • labelIds: null | number[]

  • Son los ID de etiqueta del anuncio renderizado. El valor es null para espacios vacíos, anuncios de reabastecimiento y creatividades que renderizan servicios distintos de PubAdsService.

lineItemId

  • lineItemId: null | number

  • Es el ID de línea de pedido del anuncio de reservación renderizado. El valor es null para espacios vacíos, anuncios de reabastecimiento y creatividades que renderizan servicios distintos de PubAdsService.

size

  • size: null | string | number[]

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

slotContentChanged

  • slotContentChanged: boolean

  • Indica si el contenido del espacio se cambió con el anuncio renderizado. El valor es true si se cambió el contenido. De lo contrario, es false.

sourceAgnosticCreativeId

  • sourceAgnosticCreativeId: null | number

  • Es el ID de la creatividad de la reserva renderizada o del anuncio de reabastecimiento. El valor es null si el anuncio no es una reservación o un reabastecimiento de líneas de pedido, o si se renderizan la creatividad mediante servicios que no sean PubAdsService.

sourceAgnosticLineItemId

  • sourceAgnosticLineItemId: null | number

  • Es el ID de la línea de pedido del anuncio de reabastecimiento o de reserva renderizado. El valor es null si el anuncio no es una reservación o un reabastecimiento de líneas de pedido, o si se renderizan la creatividad mediante servicios que no sean PubAdsService.

yieldGroupIds

  • yieldGroupIds: null | number[]

  • Son los ID de los grupos de rendimiento del anuncio de reabastecimiento renderizado. El valor es null para espacios vacíos, anuncios de reservación y creatividades que renderizan servicios distintos de PubAdsService.

googletag.events.SlotRequestedEvent

Extiende Event

Este evento se activa cuando se solicita un anuncio para un espacio específico.

Resumen de la propiedad
serviceName
Es el nombre del servicio que activó el evento.
slot
Es el espacio que activó el evento.
Ejemplo

JavaScript

// This listener is called when the specified service issues an ad
// request for a slot. Each slot will fire this event, even though they
// may be batched together in a single request if single request
// architecture (SRA) is enabled.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRequested", (event) => {
  const slot = event.slot;
  console.log("Slot", slot.getSlotElementId(), "has been requested.");

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

JavaScript (heredado)

// This listener is called when the specified service issues an ad
// request for a slot. Each slot will fire this event, even though they
// may be batched together in a single request if single request
// architecture (SRA) is enabled.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRequested", function (event) {
  var slot = event.slot;
  console.log("Slot", slot.getSlotElementId(), "has been requested.");

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

TypeScript

// This listener is called when the specified service issues an ad
// request for a slot. Each slot will fire this event, even though they
// may be batched together in a single request if single request
// architecture (SRA) is enabled.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRequested", (event) => {
  const slot = event.slot;
  console.log("Slot", slot.getSlotElementId(), "has been requested.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
Consulta también

googletag.events.SlotResponseReceived

Extiende Event

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

Resumen de la propiedad
serviceName
Es el nombre del servicio que activó el evento.
slot
Es el espacio que activó el evento.
Ejemplo

JavaScript

// This listener is called when an ad response has been received
// for a slot.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotResponseReceived", (event) => {
  const slot = event.slot;
  console.log("Ad response for slot", slot.getSlotElementId(), "received.");

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

JavaScript (heredado)

// This listener is called when an ad response has been received
// for a slot.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotResponseReceived", function (event) {
  var slot = event.slot;
  console.log("Ad response for slot", slot.getSlotElementId(), "received.");

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

TypeScript

// This listener is called when an ad response has been received
// for a slot.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotResponseReceived", (event) => {
  const slot = event.slot;
  console.log("Ad response for slot", slot.getSlotElementId(), "received.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
Consulta también

googletag.events.SlotVisibilityChangedEvent

Extiende Event

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

Resumen de la propiedad
inViewPercentage
Es el porcentaje del área del anuncio que es visible.
serviceName
Es el nombre del servicio que activó el evento.
slot
Es el espacio que activó el evento.
Ejemplo

JavaScript

// This listener is called whenever the on-screen percentage of an
// ad slot's area changes.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotVisibilityChanged", (event) => {
  const slot = event.slot;
  console.group("Visibility of slot", slot.getSlotElementId(), "changed.");

  // Log details of the event.
  console.log("Visible area:", `${event.inViewPercentage}%`);
  console.groupEnd();

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

JavaScript (heredado)

// This listener is called whenever the on-screen percentage of an
// ad slot's area changes.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotVisibilityChanged", function (event) {
  var slot = event.slot;
  console.group("Visibility of slot", slot.getSlotElementId(), "changed.");

  // Log details of the event.
  console.log("Visible area:", "".concat(event.inViewPercentage, "%"));
  console.groupEnd();

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

TypeScript

// This listener is called whenever the on-screen percentage of an
// ad slot's area changes.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotVisibilityChanged", (event) => {
  const slot = event.slot;
  console.group("Visibility of slot", slot.getSlotElementId(), "changed.");

  // Log details of the event.
  console.log("Visible area:", `${event.inViewPercentage}%`);
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
Consulta también

inViewPercentage

  • inViewPercentage: number

  • Es el porcentaje del área del anuncio que es visible. El valor es un número entre 0 y 100.

googletag.secureSignals.BidderSignalProvider

Muestra un indicador seguro para un ofertante específico.

Un proveedor de indicadores seguros de ofertantes consta de 2 partes:

  1. Una función de colector, que muestra un Promise que se resuelve en un indicador seguro
  2. Una id que identifica al ofertante asociado con el indicador
Si quieres mostrar un indicador seguro para un publicador, usa secureSignals.PublisherSignalProvider en su lugar.

Resumen de la propiedad
collectorFunction
.
id
Es un identificador único para el recopilador asociado con este indicador seguro, como se registra en Google Ad Manager.
Ejemplo

JavaScript

// id is provided
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

JavaScript (heredado)

// id is provided
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: function () {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

TypeScript

// id is provided
googletag.secureSignalProviders!.push({
  id: "collector123",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});
Consulta también

collectorFunction

  • collectorFunction: () => Promise<string>

id

  • id: string

  • Es un identificador único para el recopilador asociado con este indicador seguro, como se registra en Google Ad Manager.

googletag.secureSignals.PublisherSignalProvider

Muestra un indicador seguro de un publicador específico.

Un proveedor de indicadores del publicador consta de 2 partes:

  1. Una función de colector, que muestra un Promise que se resuelve en un indicador seguro
  2. Un networkCode que identifica al publicador asociado con el indicador.
Si quieres mostrar un indicador seguro para un ofertante, usa secureSignals.BidderSignalProvider.

Resumen de la propiedad
collectorFunction
.
networkCode
Es el código de red (como se ve en la ruta de la unidad de anuncios) del publicador asociado con este indicador seguro.
Ejemplo

JavaScript

// networkCode is provided
googletag.secureSignalProviders.push({
  networkCode: "123456",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

JavaScript (heredado)

// networkCode is provided
googletag.secureSignalProviders.push({
  networkCode: "123456",
  collectorFunction: function () {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

TypeScript

// networkCode is provided
googletag.secureSignalProviders!.push({
  networkCode: "123456",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});
Consulta también

collectorFunction

  • collectorFunction: () => Promise<string>

networkCode

  • networkCode: string

  • Es el código de red (como se ve en la ruta de la unidad de anuncios) del publicador asociado con este indicador seguro.

googletag.secureSignals.SecureSignalProvidersArray

Es una interfaz para administrar indicadores seguros.

Resumen de métodos
clearAllCache
Borra todos los indicadores de todos los recopiladores de la caché y, por lo tanto, puede reducir la probabilidad de que se incluyan indicadores en las solicitudes de anuncios para esta vista de página y, posiblemente, posteriores.
push
Agrega un secureSignals.SecureSignalProvider nuevo al array del proveedor de indicadores y comienza el proceso de generación de indicadores.

clearAllCache

  • clearAllCache(): void

  • Borra todos los indicadores de todos los recopiladores de la caché y, por lo tanto, puede reducir la probabilidad de que se incluyan indicadores en las solicitudes de anuncios para esta vista de página y, posiblemente, posteriores. Solo debe usarse en cambios de estado significativos, como eventos que indican un usuario nuevo (p.ej., acceder, salir, registrarse).

push