Referência da GPT

Esta referência usa a notação TypeScript para descrever os tipos. A tabela a seguir fornece uma breve explicação por exemplo.

Expressão de tipo
string	O tipo de string primitiva.
string[]	Um tipo de matriz em que os valores só podem ser strings.
number | string	Um tipo de união em que o valor pode ser um número ou uma string.
Array<number | string>	Um tipo de matriz, em que os valores são um tipo complexo (união).
[number, string]	Um tipo de tupla, em que o valor é uma matriz de dois elementos que precisa conter um número e uma string, nessa ordem.
Slot	Um tipo de objeto em que o valor é uma instância de googletag.Slot.
() => void	Um tipo de função sem argumentos definidos e sem valor de retorno.

Para saber mais sobre os tipos e as expressões de tipo compatíveis, consulte o Manual do TypeScript .

Anotações de tipo

Dois-pontos após uma variável, nome de parâmetro, nome de propriedade ou assinatura de função indicam uma anotação de tipo. As anotações de tipo descrevem os tipos que o elemento à esquerda dos dois pontos pode aceitar ou retornar. A tabela a seguir mostra exemplos de anotações de tipo que você pode ver nesta referência.

Anotação de tipo
param: string	Indica que param aceita ou retorna um valor de string. Essa sintaxe é usada para variáveis, parâmetros, propriedades e tipos de retorno.
param?: number | string	Indica que param é opcional, mas aceita um número ou uma string quando especificado. Essa sintaxe é usada para parâmetros e propriedades.
...params: Array<() => void>	Indica que params é um parâmetro rest que aceita funções. Os parâmetros rest aceitam um número ilimitado de valores do tipo especificado.

---

googletag

O namespace global que a Tag de Publisher do Google usa para a API.

Namespaces
config	Interface de configuração principal para definições no nível da página.
enums	Este é o namespace que a GPT usa para tipos enumerados.
events	Esse é o namespace que a GPT usa para eventos.
secureSignals	Esse é o namespace que a GPT usa para gerenciar indicadores seguros.

Interfaces
CommandArray	A matriz de comandos aceita uma sequência de funções e as invoca em ordem.
CompanionAdsService	Serviço de anúncios complementares.
PrivacySettingsConfig	Objeto de configuração para as configurações de privacidade.
PubAdsService	Serviço de publicidade do editor.
RequestHook	Função de callback invocada antes de cada solicitação de anúncio quando registrada por PubAdsService.registerRequestHook.
ResponseInformation	Um objeto que representa uma única resposta de anúncio.
RewardedPayload	Um objeto que representa a recompensa associada a um anúncio premiado.
Service	Classe de serviço base que contém métodos comuns para todos os serviços.
SizeMappingBuilder	Builder para objetos de especificação de mapeamento de tamanho.
Slot	Slot é um objeto que representa um único espaço do anúncio em uma página.

Aliases de tipo
FluidSize	A string de tamanho em que o contêiner de anúncio ocupa 100% da largura da div pai e, em seguida, redimensiona a altura para se ajustar ao conteúdo do criativo.
GeneralSize	Uma configuração de tamanho válida para um espaço, que pode ser de um ou vários tamanhos.
MultiSize	Uma lista de tamanhos válidos.
NamedSize	Tamanhos nomeados que um espaço pode ter.
SingleSize	Um único tamanho válido para um espaço.
SingleSizeArray	Matriz de dois números que representam [largura, altura].
SizeMapping	Um mapeamento do tamanho da janela de visualização para os tamanhos de anúncio.
SizeMappingArray	Uma lista de mapeamentos de tamanho.

Variáveis
apiReady	Sinalização que indica que a API GPT está carregada e pronta para ser chamada.
cmd	Referência à fila de comandos global para execução assíncrona de chamadas relacionadas à GPT.
pubadsReady	Sinalização que indica que o PubAdsService está ativado, carregado e totalmente operacional.
secureSignalProviders	Referência à matriz de provedores de indicadores seguros.

Funções
companionAds	Retorna uma referência ao CompanionAdsService.
defineOutOfPageSlot	Cria um espaço do anúncio fora da página com o caminho do bloco de anúncios fornecido.
defineSlot	Cria um espaço do anúncio com um determinado caminho e tamanho de bloco de anúncios e o associa ao ID de um elemento div na página que vai conter o anúncio.
destroySlots	Destrói os espaços fornecidos, removendo todos os objetos e referências relacionados desses espaços da GPT.
disablePublisherConsole	Desativa o Console do Publisher do Google.
display	Instrui os serviços de slot a renderizar o slot.
enableServices	Ativa todos os serviços da GPT que foram definidos para os espaços do anúncio na página.
getConfig	Recebe uma cópia congelada das opções de configuração geral da página definida por setConfig.
getVersion	Retorna a versão atual da GPT.
openConsole	Abre o Console do Publisher do Google.
pubads	Retorna uma referência ao PubAdsService.
setAdIframeTitle	Define o título de todos os iframes de contêiner de anúncio criados pelo PubAdsService a partir de agora.
setConfig	Define as opções de configuração geral da página.
sizeMapping	Cria um novo SizeMappingBuilder.

Aliases de tipo

---

FluidSize

FluidSize: "fluid"

A string de tamanho em que o contêiner de anúncio ocupa 100% da largura da div pai e, em seguida, redimensiona a altura para se ajustar ao conteúdo do criativo. Semelhante ao comportamento dos elementos de bloco normais em uma página. Usado para anúncios nativos e de banner (consulte o artigo relacionado).

---

GeneralSize

GeneralSize: SingleSize | MultiSize

Uma configuração de tamanho válida para um espaço, que pode ser de um ou vários tamanhos.

---

MultiSize

MultiSize: SingleSize[]

Uma lista de tamanhos válidos.

---

NamedSize

NamedSize: FluidSize | [FluidSize]

Tamanhos nomeados que um espaço pode ter. Na maioria dos casos, o tamanho é um retângulo de tamanho fixo, mas há alguns casos em que precisamos de outros tipos de especificações de tamanho. Somente os seguintes tamanhos nomeados são válidos:

• fluid: o contêiner de anúncio ocupa 100% da largura da div pai e, em seguida, redimensiona a altura para se ajustar ao conteúdo do criativo. Semelhante ao comportamento dos elementos de bloco normais em uma página. Usado para anúncios nativos e de banner (consulte o artigo relacionado). Tanto fluid quanto ['fluid'] são formas aceitáveis de declarar um tamanho de espaço como flexível.

---

SingleSize

SingleSize: SingleSizeArray | NamedSize

Um único tamanho válido para um espaço.

---

SingleSizeArray

SingleSizeArray: [number, number]

Matriz de dois números que representam [largura, altura].

---

SizeMapping

SizeMapping: [SingleSizeArray, GeneralSize]

Um mapeamento do tamanho da janela de visualização para os tamanhos de anúncio. Usado para anúncios responsivos.

---

SizeMappingArray

SizeMappingArray: SizeMapping[]

Uma lista de mapeamentos de tamanho.

Variáveis

---

Const apiReady

apiReady: boolean | undefined

Sinalização que indica que a API GPT está carregada e pronta para ser chamada. Essa propriedade será simplesmente undefined até que a API esteja pronta.

A maneira recomendada de lidar com o modo assíncrono é usar googletag.cmd para colocar callbacks em fila para quando a GPT estiver pronta. Esses callbacks não precisam verificar googletag.apiReady, porque eles são executados assim que a API é configurada.

---

Const cmd

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

Referência à fila de comandos global para execução assíncrona de chamadas relacionadas à GPT.

A variável googletag.cmd é inicializada em uma matriz JavaScript vazia pela sintaxe da tag da GPT na página, e cmd.push é o método Array.push padrão que adiciona um elemento ao final da matriz. Quando o JavaScript da GPT é carregado, ele analisa a matriz e executa todas as funções em ordem. Em seguida, o script substitui cmd por um objeto CommandArray, cujo método push é definido para executar o argumento de função transmitido a ele. Esse mecanismo permite que a GPT reduza a latência percebida ao buscar o JavaScript de forma assíncrona, enquanto o navegador continua renderizando a página.

Exemplo

JavaScript

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

JavaScript (legado)

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

TypeScript

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

---

Const pubadsReady

pubadsReady: boolean | undefined

Sinalização que indica que o PubAdsService está ativado, carregado e totalmente operacional. Essa propriedade será simplesmente undefined até que enableServices seja chamado e PubAdsService seja carregado e inicializado.

---

secureSignalProviders

secureSignalProviders: SecureSignalProvider[] | SecureSignalProvidersArray | undefined

Referência à matriz de provedores de indicadores seguros.

A matriz de provedores de indicadores seguros aceita uma sequência de funções de geração de indicadores e as invoca em ordem. Ela foi criada para substituir uma matriz padrão usada para colocar em fila as funções de geração de indicadores que serão invocadas quando a GPT for carregada.

Exemplo

JavaScript

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

JavaScript (legado)

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

Consulte também

• Compartilhar indicadores seguros com os bidders

Funções

---

companionAds

companionAds(): CompanionAdsService

Retorna uma referência ao CompanionAdsService.

Retorna
CompanionAdsService	O serviço de anúncios complementares.

---

defineOutOfPageSlot

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

Cria um espaço do anúncio fora da página com o caminho do bloco de anúncios fornecido.

Para anúncios personalizados fora da página, div é o ID do elemento div que vai conter o anúncio. Consulte o artigo sobre criativos fora da página para mais detalhes.

Para anúncios fora da página gerenciados pela GPT, div é um OutOfPageFormat compatível.

Exemplo

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

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

Consulte também

• Mostrar um anúncio premiado
• Mostrar um anúncio intersticial da Web
• Mostrar um anúncio âncora
• Mostrar um anúncio fora da página

Parâmetros
adUnitPath: string	Caminho do bloco de anúncios completo com o código de rede e o código do bloco de anúncios.
Optional div: string | OutOfPageFormat	ID da div que vai conter esse bloco de anúncios ou OutOfPageFormat.

Retorna
Slot | null	O slot recém-criado ou null se não for possível criar um slot.

---

defineSlot

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

Cria um espaço do anúncio com um determinado caminho e tamanho de bloco de anúncios e o associa ao ID de um elemento div na página que vai conter o anúncio.

Exemplo

JavaScript

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

JavaScript (legado)

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

TypeScript

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

Consulte também

• Começar a usar as Tags de Publisher do Google

Parâmetros
adUnitPath: string	Caminho completo do bloco de anúncios com o código de rede e o código do bloco.
size: GeneralSize	Largura e altura do espaço do anúncio adicionado. Esse é o tamanho usado na solicitação de anúncio se nenhum mapeamento de tamanho responsivo for fornecido ou se o tamanho da janela de visualização for menor que o menor tamanho fornecido no mapeamento.
Optional div: string	ID da div que vai conter esse bloco de anúncios.

Retorna
Slot | null	O slot recém-criado ou null se não for possível criar um slot.

---

destroySlots

destroySlots(slots?: Slot[]): boolean

Destrói os espaços fornecidos, removendo todos os objetos e referências relacionados desses espaços da GPT. Essa API não é compatível com espaços de passback e complementares.

Chamar essa API em um espaço limpa o anúncio e remove o objeto do espaço do estado interno mantido pela GPT. Chamar mais funções no objeto de slot vai resultar em um comportamento indefinido. O navegador ainda pode não liberar a memória associada a esse espaço se uma referência a ele for mantida pela página do editor. Chamar essa API disponibiliza a div associada a esse espaço para reutilização.

Em particular, destruir um espaço remove o anúncio da visualização de página de longa duração da GPT. Assim, as solicitações futuras não serão influenciadas por roadblocks ou exclusões competitivas que envolvam esse anúncio. Se essa função não for chamada antes de remover a div de um espaço da página, o comportamento será indefinido.

Exemplo

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

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

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

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

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

TypeScript

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

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

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

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

Parâmetros
Optional slots: Slot[]	A matriz de espaços a serem destruídos. A matriz é opcional. Todos os espaços serão destruídos se ela não for especificada.

Retorna
boolean	true se os espaços tiverem sido destruídos, false caso contrário.

---

disablePublisherConsole

disablePublisherConsole(): void

Desativa o Console do Publisher do Google.

Consulte também

• Console do Publisher do Google

---

display

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

Instrui os serviços de slot a renderizar o slot. Cada espaço do anúncio só deve ser exibido uma vez por página. Todos os espaços precisam ser definidos e ter um serviço associado a eles antes de serem exibidos. A chamada de exibição só pode acontecer quando o elemento estiver presente no DOM. A maneira usual de fazer isso é colocá-lo em um bloco de script dentro do elemento div nomeado na chamada de método.

Se a arquitetura de solicitação única (SRA) estiver sendo usada, todos os espaços de anúncio não buscados no momento em que esse método for chamado serão buscados de uma só vez. Para impedir que um espaço do anúncio seja exibido, é necessário remover toda a div.

Consulte também

• Começar a usar as Tags de Publisher do Google
• Mostrar um anúncio de teste
• Controlar o carregamento e a atualização de anúncios

Parâmetros
divOrSlot: string | Element | Slot	O ID do elemento div que contém o espaço do anúncio, o elemento div ou o objeto do espaço. Se um elemento div for fornecido, ele precisará ter um atributo "id" que corresponda ao ID transmitido para defineSlot.

---

enableServices

enableServices(): void

Ativa todos os serviços da GPT que foram definidos para os espaços do anúncio na página.

---

getConfig

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

Recebe uma cópia congelada das opções de configuração geral da página definida por setConfig.

Nem todas as propriedades de setConfig() são compatíveis com esse método. As propriedades compatíveis são:

• adsenseAttributes
• disableInitialLoad
• targeting

Exemplo

JavaScript

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

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

JavaScript (legado)

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

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

TypeScript

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

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

Parâmetros
keys: string | string[]	As chaves das opções de configuração que serão recebidas.

Retorna
Readonly<Pick<PageSettingsConfig, "adsenseAttributes" | "disableInitialLoad" | "targeting">>	Uma cópia congelada das opções de configuração da página.

---

getVersion

getVersion(): string

Retorna a versão atual da GPT.

Consulte também

• Histórico de versões da GPT

Retorna
string	A string da versão da GPT em execução no momento.

---

openConsole

openConsole(div?: string): void

Abre o Console do Publisher do Google.

Exemplo

JavaScript

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

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

JavaScript (legado)

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

Consulte também

• Console do Publisher do Google

Parâmetros
Optional div: string	Um ID de div do espaço do anúncio. Este valor é opcional. Quando fornecido, o Console do Publisher vai tentar abrir com os detalhes do espaço do anúncio especificado em exibição.

---

pubads

pubads(): PubAdsService

Retorna uma referência ao PubAdsService.

Retorna
PubAdsService	O serviço de publicidade do editor.

---

setAdIframeTitle

setAdIframeTitle(title: string): void

Define o título de todos os iframes de contêiner de anúncio criados pelo PubAdsService a partir deste ponto.

Exemplo

JavaScript

googletag.setAdIframeTitle("title");

JavaScript (legado)

googletag.setAdIframeTitle("title");

TypeScript

googletag.setAdIframeTitle("title");

Parâmetros
title: string	O novo título para todos os iframes de contêiner de anúncio.

---

setConfig

setConfig(config: PageSettingsConfig): void

Define as opções de configuração geral da página.

Parâmetros
config: PageSettingsConfig

---

sizeMapping

sizeMapping(): SizeMappingBuilder

Cria um novo SizeMappingBuilder.

Consulte também

• Tamanhos de anúncio: anúncios responsivos

Retorna
SizeMappingBuilder	Um novo builder.

---

googletag.CommandArray

A matriz de comandos aceita uma sequência de funções e as invoca em ordem. Ela foi criada para substituir uma matriz padrão usada para enfileirar funções que serão invocadas quando a GPT for carregada.

Métodos
push	Executa a sequência de funções especificadas nos argumentos em ordem.

Métodos

---

push

push(...f: ((this: typeof globalThis) => void)[]): number

Executa a sequência de funções especificadas nos argumentos em ordem.

Exemplo

JavaScript

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

JavaScript (legado)

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

TypeScript

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

Parâmetros
Rest ...f: ((this: typeof globalThis) => void)[]	Uma função JavaScript a ser executada. A vinculação do ambiente de execução sempre será globalThis. Considere transmitir uma arrow function para reter o valor this do contexto léxico delimitador.

Retorna
number	O número de comandos processados até o momento. Isso é compatível com o valor de retorno de Array.push (o tamanho atual da matriz).

---

googletag.CompanionAdsService

Estende Service

Serviço de anúncios complementares. Esse serviço é usado por anúncios em vídeo para mostrar anúncios complementares.

Métodos
addEventListener	Registra um listener que permite configurar e chamar uma função JavaScript quando um evento específico da GPT acontece na página. Herdado do método Service.addEventListener
getSlots	Recebe a lista de slots associados a este serviço. Herdado do método Service.getSlots
removeEventListener	Remove um listener registrado anteriormente. Herdado do método Service.removeEventListener
setRefreshUnfilledSlots	Define se os espaços complementares vazios serão preenchidos automaticamente.

Consulte também

• Anúncios complementares para players de vídeo e áudio

Métodos

---

setRefreshUnfilledSlots

setRefreshUnfilledSlots(value: boolean): void

Define se os espaços complementares vazios serão preenchidos automaticamente.

Esse método pode ser chamado várias vezes durante o ciclo de vida da página para ativar e desativar o preenchimento. Somente os espaços que também estão registrados no PubAdsService serão preenchidos. Devido a restrições de política, esse método não foi projetado para preencher espaços complementares vazios quando um vídeo do Ad Exchange é veiculado.

Exemplo

JavaScript

googletag.companionAds().setRefreshUnfilledSlots(true);

JavaScript (legado)

googletag.companionAds().setRefreshUnfilledSlots(true);

TypeScript

googletag.companionAds().setRefreshUnfilledSlots(true);

Parâmetros
value: boolean	true para preencher automaticamente os espaços vazios, false para deixá-los inalterados.

---

googletag.PrivacySettingsConfig

Objeto de configuração para as configurações de privacidade.

Propriedades
childDirectedTreatment?	Indica se a página deve ser tratada como direcionada a crianças.
limitedAds?	Permite que a veiculação seja executada no modo de anúncios limitados para ajudar nas necessidades de compliance regulatório do publisher.
nonPersonalizedAds?	Permite que a veiculação seja executada no modo de anúncios não personalizados para ajudar nas necessidades de compliance regulatório do editor.
restrictDataProcessing?	Permite que a veiculação seja executada no modo de processamento restrito para ajudar os publishers a atender às necessidades de compliance regulatório.
tagForAgeTreatment?	O tratamento com restrição de idade, indicando se a solicitação de anúncio deve ser tratada como criança, adolescente ou não especificada.
trafficSource?	Indica se as solicitações representam tráfego comprado ou orgânico.
underAgeOfConsent?	Indica se as solicitações de anúncio devem ser marcadas como provenientes de usuários abaixo da idade de consentimento.

Consulte também

• Definir as configurações de privacidade

Propriedades

---

Optional childDirectedTreatment

childDirectedTreatment?: boolean

Indica se a página deve ser tratada como direcionada a crianças. Defina como null para limpar a configuração.

---

Optional limitedAds

limitedAds?: boolean

Ativa a veiculação no modo de anúncios limitados para ajudar os editores a atender aos requisitos de compliance regulatório.

É possível instruir a GPT a solicitar anúncios limitados de duas maneiras:

• Automaticamente, usando um indicador de uma plataforma de gestão de consentimento da TCF v2.0 do IAB.
• Manualmente, definindo o valor desse campo como true.

Só é possível configurar anúncios limitados manualmente quando a GPT é carregada no URL de anúncios limitados. Se você tentar modificar essa configuração quando a GPT for carregada no URL padrão, um aviso do Console do Publisher será gerado.

Não é necessário ativar manualmente os anúncios limitados quando uma CMP está em uso.

Exemplo

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

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

Consulte também

• Mostrar um anúncio limitado

---

Optional nonPersonalizedAds

nonPersonalizedAds?: boolean

Permite que a veiculação seja executada no modo de anúncios não personalizados para ajudar os editores a atender às necessidades de compliance regulatório.

---

Optional restrictDataProcessing

restrictDataProcessing?: boolean

Permite que a veiculação seja executada no modo de processamento restrito para ajudar os publishers a atender às necessidades de compliance regulatório.

---

Optional tagForAgeTreatment

tagForAgeTreatment?: TagForAgeTreatment

O tratamento com restrição de idade, que indica se a solicitação de anúncio deve ser tratada como para crianças, adolescentes ou não especificada.

Consulte sua assessoria jurídica para determinar as configurações de tratamento por idade para sua base de usuários com base em requisitos legais e regulatórios. Para mais informações sobre essa configuração, consulte este artigo da Central de Ajuda.

Ao definir essa propriedade, você certifica que essa notificação é precisa e que tem autorização para agir em nome do proprietário do site. Você está ciente de que o abuso dessa configuração poderá resultar no encerramento da sua Conta do Google.

Exemplo

JavaScript

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

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

JavaScript (legado)

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

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

TypeScript

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

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

---

Optional trafficSource

trafficSource?: TrafficSource

Indica se as solicitações representam tráfego comprado ou orgânico. Esse valor preenche a dimensão Origem do tráfego nos relatórios do Ad Manager. Se não for definida, a origem de tráfego padrão será undefined nos relatórios.

Exemplo

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

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

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

TypeScript

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

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

---

Optional underAgeOfConsent

underAgeOfConsent?: boolean

Indica se as solicitações de anúncio devem ser marcadas como provenientes de usuários abaixo da idade de consentimento. Defina como null para limpar a configuração.

---

googletag.PubAdsService

Estende Service

Serviço de publicidade do editor. Esse serviço é usado para buscar e mostrar anúncios da sua conta do Google Ad Manager.

Métodos
addEventListener	Registra um listener que permite configurar e chamar uma função JavaScript quando um evento específico da GPT acontece na página. Herdado do método Service.addEventListener
clear	Remove os anúncios dos espaços indicados e os substitui por conteúdo em branco.
clearCategoryExclusions	Descontinuado. Limpa todos os rótulos de exclusão de categoria de anúncio no nível da página.
clearTargeting	Descontinuado. Limpa os parâmetros de segmentação personalizada de uma chave específica ou de todas as chaves.
collapseEmptyDivs	Descontinuado. Ativa o recolhimento de divs de espaço para que não ocupem espaço na página quando não houver conteúdo de anúncio para mostrar.
disableInitialLoad	Descontinuado. Desativa as solicitações de anúncios no carregamento da página, mas permite que os anúncios sejam solicitados com uma chamada PubAdsService.refresh.
display	Cria e exibe um espaço do anúncio com o caminho e o tamanho do bloco de anúncios fornecidos.
enableLazyLoad	Descontinuado. Ativa o carregamento lento na GPT, conforme definido pelo objeto de configuração.
enableSingleRequest	Descontinuado. Ativa o modo de solicitação única para buscar vários anúncios ao mesmo tempo.
enableVideoAds	Descontinuado. Sinaliza para a GPT que os anúncios em vídeo vão estar presentes na página.
get	Descontinuado. Retorna o valor do atributo do Google AdSense associado à chave fornecida.
getAttributeKeys	Descontinuado. Retorna as chaves de atributo que foram definidas neste serviço.
getSlots	Recebe a lista de slots associados a este serviço. Herdado do método Service.getSlots
getTargeting	Descontinuado. Retorna um parâmetro de segmentação personalizado específico no nível do serviço que foi definido.
getTargetingKeys	Descontinuado. Retorna a lista de todas as chaves de segmentação personalizadas no nível do serviço que foram definidas.
isInitialLoadDisabled	Descontinuado. Informa se as solicitações iniciais de anúncios foram desativadas por uma chamada PubAdsService.disableInitialLoad anterior.
refresh	Busca e exibe novos anúncios para espaços específicos ou todos os espaços na página.
registerRequestHook	Registra um hook a ser executado em paralelo com outros hooks registrados antes de cada solicitação de anúncio na página dentro de um tempo limite global.
removeEventListener	Remove um listener registrado anteriormente. Herdado do método Service.removeEventListener
set	Descontinuado. Define valores para os atributos do AdSense que se aplicam a todos os espaços de anúncios no serviço de anúncios do editor.
setCategoryExclusion	Descontinuado. Define uma exclusão de categoria de anúncio no nível da página para o nome do rótulo fornecido.
setCentering	Descontinuado. Ativa e desativa a centralização horizontal de anúncios.
setForceSafeFrame	Descontinuado. Configura se todos os anúncios na página precisam ser renderizados usando um contêiner do SafeFrame.
setLocation	Descontinuado. Transmite informações de localização de sites para que você possa segmentar itens de linha por área geográfica para locais específicos.
setPrivacySettings	Permite definir todas as configurações de privacidade em uma única API usando um objeto de configuração.
setPublisherProvidedId	Define o valor do ID fornecido pelo publisher.
setSafeFrameConfig	Descontinuado. Define as preferências no nível da página para a configuração do SafeFrame.
setTargeting	Descontinuado. Define parâmetros de segmentação personalizada para uma determinada chave que se aplicam a todos os espaços de anúncios do serviço de anúncios do editor.
setVideoContent	Descontinuado. Define as informações do conteúdo em vídeo que serão enviadas com as solicitações de anúncio para fins de segmentação e exclusão de conteúdo.
updateCorrelator	Muda o correlator enviado com as solicitações de anúncio, iniciando uma nova visualização de página.

Métodos

---

clear

clear(slots?: Slot[]): boolean

Remove os anúncios dos espaços indicados e os substitui por conteúdo em branco. Os espaços serão marcados como não buscados.

Especificamente, limpar um espaço remove o anúncio da visualização de página de longa duração da GPT. Assim, as solicitações futuras não serão influenciadas por roadblocks ou exclusões competitivas que envolvam esse anúncio.

Exemplo

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

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

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

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

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

TypeScript

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

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

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

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

Parâmetros
Optional slots: Slot[]	A matriz de espaços a serem limpos. A matriz é opcional. Todos os slots serão limpos se ela não for especificada.

Retorna
boolean	Retorna true se os slots tiverem sido limpos, caso contrário, retorna false.

---

clearCategoryExclusions

clearCategoryExclusions(): PubAdsService

Limpa todos os rótulos de exclusão de categoria de anúncio no nível da página. Isso é útil se você quiser atualizar o espaço.

Descontinuado:use PageSettingsConfig.categoryExclusion.

Exemplo

JavaScript

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

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

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

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

JavaScript (legado)

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

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

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

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

TypeScript

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

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

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

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

Consulte também

• Rótulos personalizados para bloquear anúncios

Retorna
PubAdsService	O objeto de serviço em que o método foi chamado.

---

clearTargeting

clearTargeting(key?: string): PubAdsService

Limpa os parâmetros de segmentação personalizada de uma chave específica ou de todas as chaves.

Descontinuado:use PageSettingsConfig.targeting.

Exemplo

JavaScript

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

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

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

JavaScript (legado)

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

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

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

TypeScript

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

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

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

Consulte também

• Segmentação por chave-valor

Parâmetros
Optional key: string	Chave do parâmetro de segmentação. A chave é opcional. Todos os parâmetros de segmentação serão limpos se ela não for especificada.

Retorna
PubAdsService	O objeto de serviço em que o método foi chamado.

---

collapseEmptyDivs

collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean

Ativa o recolhimento de divs de espaço para que não ocupem espaço na página quando não houver conteúdo de anúncio para exibir. Esse modo precisa ser definido antes de ativar o serviço.

Descontinuado:use PageSettingsConfig.collapseDiv.

Consulte também

• Recolher espaços do anúncio vazios
• Minimizar a mudança de layout

Parâmetros
Optional collapseBeforeAdFetch: boolean	Se os espaços devem ser recolhidos antes mesmo de os anúncios serem buscados. Esse parâmetro é opcional. Se não for fornecido, false será usado como o valor padrão.

Retorna
boolean	Retorna true se o modo de recolhimento de div foi ativado e false se não for possível ativar o modo de recolhimento porque o método foi chamado depois que o serviço foi ativado.

---

disableInitialLoad

disableInitialLoad(): void

Desativa as solicitações de anúncios no carregamento de página, mas permite que os anúncios sejam solicitados com uma chamada PubAdsService.refresh. Isso precisa ser definido antes de ativar o serviço. O modo assíncrono precisa ser usado. Caso contrário, não será possível solicitar anúncios usando refresh.

Descontinuado:use PageSettingsConfig.disableInitialLoad.

Consulte também

• Controlar o carregamento e a atualização de anúncios
• Controlar o loteamento de SRA

---

display

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

Cria e mostra um espaço do anúncio com o caminho e o tamanho do bloco de anúncios fornecidos.

Esse método é um atalho equivalente a chamar googletag.defineSlot seguido imediatamente por googletag.display.

O comportamento desse método depende se a arquitetura de solicitação única (SRA) está ativada:

• SRA ativada:todos os espaços de anúncio definidos até o momento dessa chamada serão agrupados e solicitados juntos.
• SRA desativada (padrão): o espaço do anúncio será solicitado individualmente.

Observação:quando esse método é chamado, um snapshot do espaço e do estado da página é criado para garantir a consistência ao enviar a solicitação de anúncio e renderizar a resposta. Todas as mudanças feitas no estado do espaço ou da página após a chamada desse método (incluindo segmentação, configurações de privacidade, SafeFrame forçado etc.) serão aplicadas apenas às solicitações display() ou refresh() subsequentes.

Exemplo

JavaScript

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

JavaScript (legado)

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

TypeScript

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

Consulte também

• Mostrar um anúncio de teste
• Controlar o carregamento e a atualização de anúncios

Parâmetros
adUnitPath: string	O caminho do bloco de anúncios do espaço a ser renderizado.
size: GeneralSize	Largura e altura do espaço.
Optional div: string | Element	O ID da div que contém o espaço ou o próprio elemento div.
Optional clickUrl: string	O URL de clique a ser usado nesse espaço.

---

enableLazyLoad

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

Ativa o carregamento lento na GPT, conforme definido pelo objeto de configuração. Para ver exemplos mais detalhados, consulte o exemplo de carregamento lento.

Observação:a busca lenta na SRA só funciona se todos os espaços estiverem fora da margem de busca.

Descontinuado:use PageSettingsConfig.lazyLoad.

Exemplo

JavaScript

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

JavaScript (legado)

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

TypeScript

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

Consulte também

• Práticas recomendadas para anúncios: priorize espaços do anúncio "importantes"
• Carregamento lento

Parâmetros

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

O objeto de configuração permite personalizar o comportamento lento. As configurações omitidas vão usar um padrão definido pelo Google que será ajustado ao longo do tempo. Para desativar uma configuração específica, como uma margem de busca, defina o valor como -1. fetchMarginPercent A distância mínima da janela de visualização atual que um espaço precisa ter antes de buscarmos o anúncio como uma porcentagem do tamanho da janela de visualização. Um valor de 0 significa "quando o espaço entra na janela de visualização", 100 significa "quando o anúncio está a uma janela de visualização de distância" e assim por diante. renderMarginPercent A distância mínima da janela de visualização atual que um espaço precisa ter antes de renderizarmos um anúncio. Isso permite pré-carregar o anúncio, mas aguardar para renderizar e baixar outros sub-recursos. O valor funciona como fetchMarginPercent como uma porcentagem da janela de visualização. mobileScaling Um multiplicador aplicado às margens em dispositivos móveis. Isso permite margens diferentes em dispositivos móveis e computadores. Por exemplo, um valor de 2,0 vai multiplicar todas as margens por 2 em dispositivos móveis, aumentando a distância mínima que um espaço pode ter antes de buscar e renderizar.

---

enableSingleRequest

enableSingleRequest(): boolean

Ativa o modo de solicitação única para buscar vários anúncios ao mesmo tempo. Isso exige que todos os espaços de anúncios do editor sejam definidos e adicionados ao PubAdsService antes da ativação do serviço. O modo de solicitação única precisa ser definido antes que o serviço seja ativado.

Descontinuado:use PageSettingsConfig.singleRequest.

Consulte também

• Práticas recomendadas para anúncios: use a arquitetura de solicitação única corretamente
• Controlar o loteamento de SRA

Retorna
boolean	Retorna true se o modo de solicitação única foi ativado e false se não for possível ativar o modo de solicitação única porque o método foi chamado depois que o serviço foi ativado.

---

enableVideoAds

enableVideoAds(): void

Sinaliza para a GPT que os anúncios em vídeo vão estar presentes na página. Isso ativa as restrições de exclusão competitiva em anúncios gráficos e em vídeo. Se o conteúdo do vídeo for conhecido, chame PubAdsService.setVideoContent para usar a exclusão de conteúdo em anúncios de display.

Descontinuado:use PageSettingsConfig.videoAds.

---

get

get(key: string): string

Retorna o valor do atributo do Google AdSense associado à chave fornecida.

Descontinuado:use googletag.getConfig.

Exemplo

JavaScript

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

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

JavaScript (legado)

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

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

TypeScript

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

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

Consulte também

• Atributos do AdSense

Parâmetros
key: string	Nome do atributo a ser procurado.

Retorna
string	Valor atual da chave de atributo ou null se a chave não estiver presente.

---

getAttributeKeys

getAttributeKeys(): string[]

Retorna as chaves de atributo que foram definidas neste serviço.

Descontinuado:use googletag.getConfig.

Exemplo

JavaScript

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

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

JavaScript (legado)

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

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

TypeScript

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

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

Retorna
string[]	Matriz de chaves de atributo definidas neste serviço. A ordem é indefinida.

---

getTargeting

getTargeting(key: string): string[]

Retorna um parâmetro de segmentação personalizado específico no nível do serviço que foi definido.

Descontinuado:use googletag.getConfig.

Exemplo

JavaScript

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

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

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

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

JavaScript (legado)

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

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

// Get targeting for a specific key.
var targeting =
  (targetingConfig === null || targetingConfig === void 0
    ? void 0
    : targetingConfig["interests"]) || [];
// Returns ['sports'].

var ageTargeting =
  (targetingConfig === null || targetingConfig === void 0 ? void 0 : targetingConfig["age"]) || [];
// Returns [] (empty array).

TypeScript

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

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

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

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

Parâmetros
key: string	A chave de segmentação que será procurada.

Retorna
string[]	Os valores associados a essa chave ou uma matriz vazia, se não houver essa chave.

---

getTargetingKeys

getTargetingKeys(): string[]

Retorna a lista de todas as chaves de segmentação personalizadas no nível do serviço que foram definidas.

Descontinuado:use googletag.getConfig.

Exemplo

JavaScript

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

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

JavaScript (legado)

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

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

TypeScript

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

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

Retorna
string[]	Matriz de chaves de segmentação. A ordem é indefinida.

---

isInitialLoadDisabled

isInitialLoadDisabled(): boolean

Informa se as solicitações iniciais de anúncios foram desativadas por uma chamada PubAdsService.disableInitialLoad anterior.

Descontinuado:use googletag.getConfig.

Retorna
boolean	Retorna true se uma chamada anterior para PubAdsService.disableInitialLoad tiver sido bem-sucedida. Caso contrário, retorna false.

---

refresh

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

Busca e exibe novos anúncios para espaços específicos ou todos os espaços na página. Funciona apenas no modo de renderização assíncrona.

Para que o comportamento seja adequado em todos os navegadores, é preciso chamar display o espaço do anúncio antes de chamar refresh. Se a chamada para display for omitida, a atualização poderá se comportar de maneira inesperada. Se quiser, use o método PubAdsService.disableInitialLoad para impedir que a display busque um anúncio.

Atualizar um espaço remove o anúncio antigo da visualização de página de longa duração da GPT. Assim, as solicitações futuras não serão influenciadas por roadblocks ou exclusões competitivas que envolvam esse anúncio.

Exemplo

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

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

Consulte também

• Controlar o carregamento e a atualização de anúncios
• Atualizar espaços do anúncio

Parâmetros
Optional slots: Slot[]	Os espaços a serem atualizados. A matriz é opcional. Todos os espaços serão atualizados se ela não for especificada.
Optional options: {   changeCorrelator: boolean; }	Opções de configuração associadas a essa chamada de atualização. changeCorrelator Especifica se um novo correlacionador será gerado para buscar anúncios. Nossos servidores de anúncios mantêm esse valor de correlação por um breve período (atualmente, por 30 segundos, mas sujeito a alterações), de modo que as solicitações com o mesmo correlator recebidas em um curto intervalo de tempo sejam consideradas uma única visualização de página. Por padrão, um novo correlator é gerado para cada atualização. Observação:essa opção não afeta a visualização de página de longa duração da GPT, que reflete automaticamente os anúncios na página e não tem prazo de validade.

---

registerRequestHook

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

Experimental Registra um hook a ser executado em paralelo com outros hooks registrados antes de cada solicitação de anúncio na página dentro de um tempo limite global.

Exemplo

JavaScript

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

// Unregister the hook.
unregister();

JavaScript (legado)

// Coming soon.

TypeScript

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

// Unregister the hook.
unregister();

Parâmetros
hook: RequestHook	Uma função que usa um objeto com a lista de espaços solicitados e retorna uma promessa que é resolvida quando todas as ações assíncronas são concluídas.
hookId: string	Um ID para rotular o hook e melhorar os diagnósticos.

Retorna
(() => void)	Uma função para cancelar o registro do hook.

---

set

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

Define valores para os atributos do Google AdSense que se aplicam a todos os espaços de anúncio no serviço de anúncios do editor.

Chamar esse método mais de uma vez para a mesma chave vai substituir os valores definidos anteriormente para ela. Todos os valores precisam ser definidos antes de chamar display ou refresh.

Descontinuado:use PageSettingsConfig.adsenseAttributes.

Exemplo

JavaScript

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

JavaScript (legado)

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

TypeScript

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

Consulte também

• Atributos do AdSense

Parâmetros
key: string	O nome do atributo.
value: string	Valor do atributo.

Retorna
PubAdsService	O objeto de serviço em que o método foi chamado.

---

setCategoryExclusion

setCategoryExclusion(categoryExclusion: string): PubAdsService

Define uma exclusão de categoria de anúncio no nível da página para o nome do rótulo informado.

Descontinuado:use PageSettingsConfig.categoryExclusion.

Exemplo

JavaScript

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

JavaScript (legado)

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

TypeScript

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

Consulte também

• Rótulos personalizados para bloquear anúncios

Parâmetros
categoryExclusion: string	O rótulo de exclusão de categoria de anúncio a ser adicionado.

Retorna
PubAdsService	O objeto de serviço em que o método foi chamado.

---

setCentering

setCentering(centerAds: boolean): void

Ativa e desativa a centralização horizontal dos anúncios. A centralização fica desativada por padrão. No gpt_mobile.js legado, a centralização é ativada por padrão.

Esse método precisa ser invocado antes de chamar display ou refresh, porque somente os anúncios solicitados após a chamada desse método serão centralizados.

Descontinuado:use PageSettingsConfig.centering.

Exemplo

JavaScript

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

JavaScript (legado)

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

TypeScript

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

Parâmetros
centerAds: boolean	true para centralizar os anúncios e false para alinhar à esquerda.

---

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): PubAdsService

Configura se todos os anúncios na página precisam ser renderizados usando um contêiner do SafeFrame.

Lembre-se do seguinte ao usar essa API:

• Essa configuração só vai entrar em vigor para as solicitações de anúncio subsequentes feitas para os respectivos espaços.
• A configuração no nível do espaço, se especificada, sempre vai substituir a configuração no nível da página.
• Se definido como true (no nível do espaço ou da página), o anúncio sempre será renderizado usando um contêiner do SafeFrame, independentemente da escolha feita na interface do Google Ad Manager.
• No entanto, se definido como false ou deixado sem especificação, o anúncio será renderizado usando um contêiner do SafeFrame, dependendo do tipo de criativo e da seleção feita na interface do Google Ad Manager.
• Essa API precisa ser usada com cuidado, porque pode afetar o comportamento de criativos que tentam sair dos iFrames ou que dependem da renderização direta em uma página do publisher.

Descontinuado:use PageSettingsConfig.safeFrame.

Exemplo

JavaScript

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

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

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

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

JavaScript (legado)

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

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

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

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

TypeScript

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

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

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

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

Consulte também

• Renderizar criativos com o SafeFrame

Parâmetros
forceSafeFrame: boolean	true para forçar a renderização de todos os anúncios da página em SafeFrames e false para mudar a configuração anterior para "false". Definir como false quando não especificado anteriormente não muda nada.

Retorna
PubAdsService	O objeto de serviço em que o método foi chamado.

---

setLocation

setLocation(address: string): PubAdsService

Transmite informações de localização de sites para que você possa segmentar itens de linha por área geográfica para locais específicos.

Descontinuado:use PageSettingsConfig.location.

Exemplo

JavaScript

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

JavaScript (legado)

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

TypeScript

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

Parâmetros
address: string	Endereço com formato livre.

Retorna
PubAdsService	O objeto de serviço em que o método foi chamado.

---

setPrivacySettings

setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService

Permite definir todas as configurações de privacidade em uma única API usando um objeto de configuração.

Exemplo

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

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

Consulte também

• Definir as configurações de privacidade
• Mostrar um anúncio limitado

Parâmetros
privacySettings: PrivacySettingsConfig	Objeto que contém as configurações de privacidade.

Retorna
PubAdsService	O objeto de serviço em que a função foi chamada.

---

setPublisherProvidedId

setPublisherProvidedId(ppid: string): PubAdsService

Define o valor do ID fornecido pelo editor.

Exemplo

JavaScript

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

JavaScript (legado)

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

TypeScript

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

Consulte também

• Sobre os identificadores fornecidos pelo editor

Parâmetros
ppid: string	Um ID alfanumérico fornecido pelo publisher. Precisa ter entre 22 e 150 caracteres.

Retorna
PubAdsService	O objeto de serviço em que o método foi chamado.

---

setSafeFrameConfig

setSafeFrameConfig(config: SafeFrameConfig): PubAdsService

Define as preferências no nível da página para a configuração do SafeFrame. As chaves não reconhecidas no objeto de configuração serão ignoradas. Toda a configuração será ignorada se um valor inválido for transmitido para uma chave reconhecida.

Essas preferências no nível da página serão substituídas pelas preferências no nível do espaço, se especificadas.

Descontinuado:use PageSettingsConfig.safeFrame.

Exemplo

JavaScript

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

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    safeFrame: {
      allowOverlayExpansion: false,
    },
  })
  .addService(googletag.pubads());

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

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

JavaScript (legado)

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

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    safeFrame: {
      allowOverlayExpansion: false,
    },
  })
  .addService(googletag.pubads());

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

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

TypeScript

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

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setConfig({
    safeFrame: {
      allowOverlayExpansion: false,
    },
  })
  .addService(googletag.pubads());

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

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

Consulte também

• Renderizar criativos com o SafeFrame

Parâmetros
config: SafeFrameConfig	O objeto de configuração.

Retorna
PubAdsService	O objeto de serviço em que o método foi chamado.

---

setTargeting

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

Define parâmetros de segmentação personalizada para uma determinada chave que se aplicam a todos os espaços de anúncios do serviço de anúncios do editor. Chamar isso várias vezes para a mesma chave vai substituir os valores antigos. Essas chaves são definidas na sua conta do Google Ad Manager.

Descontinuado:use PageSettingsConfig.targeting.

Exemplo

JavaScript

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

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

JavaScript (legado)

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

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

TypeScript

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

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

Consulte também

• Segmentação por chave-valor

Parâmetros
key: string	Chave do parâmetro de segmentação.
value: string | string[]	Valor de parâmetro ou matriz de valores.

Retorna
PubAdsService	O objeto de serviço em que o método foi chamado.

---

setVideoContent

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

Define as informações do conteúdo em vídeo que serão enviadas com as solicitações de anúncio para fins de segmentação e exclusão de conteúdo. Os anúncios em vídeo serão ativados automaticamente quando esse método for chamado. Para videoContentId e videoCmsId, use os valores fornecidos ao serviço de ingestão de conteúdo do Google Ad Manager.

Descontinuado:use PageSettingsConfig.videoAds.

Consulte também

• Parâmetros de URL da tag de anúncio VAST

Parâmetros
videoContentId: string	O Content ID do vídeo.
videoCmsId: string	O ID do CMS de vídeo.

---

updateCorrelator

updateCorrelator(): PubAdsService

Muda o correlator enviado com as solicitações de anúncio, iniciando uma nova visualização de página. O correlator é igual para todas as solicitações de anúncio que vêm de uma visualização de página e é exclusivo para cada visualização de página. Aplica-se apenas ao modo assíncrono.

Observação:isso não afeta a visualização de página de longa duração da GPT, que reflete automaticamente os anúncios que estão na página e não tem prazo de validade.

Exemplo

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

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

Retorna
PubAdsService	O objeto de serviço em que a função foi chamada.

---

googletag.RequestHook

Função de callback invocada antes de cada solicitação de anúncio quando registrada por PubAdsService.registerRequestHook.

---

googletag.ResponseInformation

Um objeto que representa uma única resposta de anúncio.

Propriedades
advertiserId	O ID do anunciante.
campaignId	O ID da campanha.
creativeId	O ID do criativo.
creativeTemplateId	O ID do modelo do anúncio.
lineItemId	O ID do item de linha.

Consulte também

• Slot.getResponseInformation

Propriedades

---

advertiserId

advertiserId: number

O ID do anunciante.

---

campaignId

campaignId: number

O ID da campanha.

---

creativeId

creativeId: number

O ID do criativo.

---

creativeTemplateId

creativeTemplateId: number

O ID do modelo do anúncio.

---

lineItemId

lineItemId: number

O ID do item de linha.

---

googletag.RewardedPayload

Um objeto que representa a recompensa associada a um anúncio premiado.

Propriedades
amount	O número de itens incluídos na recompensa.
type	O tipo de item incluído na recompensa (por exemplo, "moeda").

Consulte também

• Mostrar um anúncio premiado

Propriedades

---

amount

amount: number

O número de itens incluídos na recompensa.

---

type

type: string

O tipo de item incluído na recompensa (por exemplo, "moeda").

---

googletag.Service

Classe de serviço base que contém métodos comuns para todos os serviços.

Métodos
addEventListener	Registra um listener que permite configurar e chamar uma função JavaScript quando um evento específico da GPT acontece na página.
getSlots	Recebe a lista de slots associados a este serviço.
removeEventListener	Remove um listener registrado anteriormente.

Métodos

---

addEventListener

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

Registra um listener que permite configurar e chamar uma função JavaScript quando um evento específico da GPT acontece na página. Os seguintes eventos são compatíveis:

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

Um objeto do tipo de evento apropriado é transmitido ao listener quando ele é chamado.

Exemplo

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

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

Consulte também

• Listeners de eventos de anúncio

Parâmetros
eventType: K	Uma string que representa o tipo de evento gerado pela GPT. Os tipos de evento diferenciam maiúsculas de minúsculas.
listener: ((arg: EventTypeMap[K]) => void)	Função que usa um único argumento de objeto de evento.

Retorna
Service	O objeto de serviço em que o método foi chamado.

---

getSlots

getSlots(): Slot[]

Recebe a lista de slots associados a este serviço.

Retorna
Slot[]	Slots na ordem em que foram adicionados ao serviço.

---

removeEventListener

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

Remove um listener registrado anteriormente.

Exemplo

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

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	Uma string que representa o tipo de evento gerado pela GPT. Os tipos de evento diferenciam maiúsculas de minúsculas.
listener: ((event: EventTypeMap[K]) => void)	Função que usa um único argumento de objeto de evento.

---

googletag.SizeMappingBuilder

Builder para objetos de especificação de mapeamento de tamanho. Esse builder é fornecido para ajudar a criar especificações de tamanho com facilidade.

Métodos
addSize	Adiciona um mapeamento de uma matriz de tamanho único (que representa a janela de visualização) para uma matriz de tamanho único ou múltiplo que representa o espaço.
build	Cria uma especificação de mapa de tamanho com base nos mapeamentos adicionados a este builder.

Consulte também

• Tamanhos de anúncio: anúncios responsivos

Métodos

---

addSize

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

Adiciona um mapeamento de uma matriz de tamanho único (que representa a janela de visualização) para uma matriz de tamanho único ou múltiplo que representa o espaço.

Exemplo

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

// 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	O tamanho da janela de visualização para essa entrada de mapeamento.
slotSize: GeneralSize	Os tamanhos do espaço para essa entrada de mapeamento.

Retorna
SizeMappingBuilder	Uma referência a este builder.

---

build

build(): SizeMappingArray

Cria uma especificação de mapa de tamanho com base nos mapeamentos adicionados a este builder.

Se algum mapeamento inválido for fornecido, esse método vai retornar null. Caso contrário, ele retorna uma especificação no formato correto para transmitir para Slot.defineSizeMapping.

Observação: o comportamento do builder após chamar esse método é indefinido.

Retorna
SizeMappingArray	O resultado criado por este builder. Pode ser nulo se mapeamentos de tamanho inválidos forem fornecidos.

---

googletag.Slot

Slot é um objeto que representa um único espaço do anúncio em uma página.

Métodos
addService	Adiciona um serviço a este slot.
clearCategoryExclusions	Descontinuado. Limpa todos os rótulos de exclusão de categoria de anúncio no nível do espaço.
clearTargeting	Descontinuado. Limpa parâmetros de segmentação personalizados específicos ou todos os parâmetros de segmentação personalizados no nível do espaço para esse espaço.
defineSizeMapping	Define uma matriz de mapeamentos de um tamanho mínimo de janela de visualização para o tamanho do espaço.
get	Descontinuado. Retorna o valor do atributo do Google AdSense associado à chave fornecida para esse espaço.
getAdUnitPath	Retorna o caminho completo do bloco de anúncios, com o código de rede e o caminho do bloco de anúncios.
getAttributeKeys	Descontinuado. Retorna a lista de chaves de atributo definidas nesse espaço.
getCategoryExclusions	Descontinuado. Retorna os rótulos de exclusão de categoria de anúncio para esse espaço.
getConfig	Recebe uma cópia congelada das opções de configuração geral do espaço definido por setConfig.
getResponseInformation	Retorna as informações de resposta do anúncio.
getSlotElementId	Retorna o ID do slot div fornecido quando o slot foi definido.
getTargeting	Descontinuado. Retorna um parâmetro de segmentação personalizada específico definido nesse espaço.
getTargetingKeys	Descontinuado. Retorna a lista de todas as chaves de segmentação personalizada definidas nesse espaço.
set	Descontinuado. Define um valor para um atributo do Google AdSense nesse espaço do anúncio.
setCategoryExclusion	Descontinuado. Define um rótulo de exclusão de categoria de anúncio no nível do espaço.
setClickUrl	Descontinuado. Define o URL de clique para onde os usuários serão redirecionados depois de clicar no anúncio.
setCollapseEmptyDiv	Descontinuado. Define se o espaço div precisa ser ocultado quando não há anúncios nele.
setConfig	Define as opções de configuração geral para este espaço.
setForceSafeFrame	Descontinuado. Configura se os anúncios nesse espaço precisam ser renderizados usando um contêiner do SafeFrame.
setSafeFrameConfig	Descontinuado. Define as preferências no nível do espaço para a configuração do SafeFrame.
setTargeting	Descontinuado. Define um parâmetro de segmentação personalizada para esse espaço.
updateTargetingFromMap	Descontinuado. Define parâmetros de segmentação personalizada para esse espaço, de um mapa de chave-valor em um objeto JSON.

Métodos

---

addService

addService(service: Service): Slot

Adiciona um serviço a este slot.

Exemplo

JavaScript

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

JavaScript (legado)

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

TypeScript

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

Consulte também

• Começar a usar as Tags de Publisher do Google
• Mostrar um anúncio de teste

Parâmetros
service: Service	O serviço a ser adicionado.

Retorna
Slot	O objeto de espaço em que o método foi chamado.

---

clearCategoryExclusions

clearCategoryExclusions(): Slot

Limpa todos os rótulos de exclusão de categoria de anúncio no nível do espaço.

Descontinuado:use SlotSettingsConfig.categoryExclusion.

Exemplo

JavaScript

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

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

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

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

JavaScript (legado)

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

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

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

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

TypeScript

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

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

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

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

Retorna
Slot	O objeto de espaço em que o método foi chamado.

---

clearTargeting

clearTargeting(key?: string): Slot

Limpa parâmetros de segmentação personalizados específicos ou todos os parâmetros de segmentação personalizados no nível do espaço para esse espaço.

Descontinuado:use SlotSettingsConfig.targeting.

Exemplo

JavaScript

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

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

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

JavaScript (legado)

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

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

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

TypeScript

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

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

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

Consulte também

• Segmentação por chave-valor

Parâmetros
Optional key: string	Chave do parâmetro de segmentação. A chave é opcional. Todos os parâmetros de segmentação serão limpos se ela não for especificada.

Retorna
Slot	O objeto de espaço em que o método foi chamado.

---

defineSizeMapping

defineSizeMapping(sizeMapping: SizeMappingArray): Slot

Define uma matriz de mapeamentos de um tamanho mínimo de janela de visualização para o tamanho do espaço.

Exemplo

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

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

Consulte também

• Tamanhos de anúncio: anúncios responsivos

Parâmetros
sizeMapping: SizeMappingArray	Matriz de mapeamentos de tamanho. Use SizeMappingBuilder para criá-lo. Cada mapeamento de tamanho é uma matriz de dois elementos: SingleSizeArray e GeneralSize.

Retorna
Slot	O objeto de espaço em que o método foi chamado.

---

get

get(key: string): string

Retorna o valor do atributo do Google AdSense associado à chave fornecida para esse espaço. Para ver os atributos no nível do serviço herdados por esse espaço, use PubAdsService.get.

Descontinuado:use googletag.Slot.getConfig.

Exemplo

JavaScript

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

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

JavaScript (legado)

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

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

TypeScript

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

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

Consulte também

• Atributos do AdSense

Parâmetros
key: string	Nome do atributo a ser procurado.

Retorna
string	Valor atual da chave de atributo ou null se a chave não estiver presente.

---

getAdUnitPath

getAdUnitPath(): string

Retorna o caminho completo do bloco de anúncios, com o código de rede e o caminho do bloco de anúncios.

Exemplo

JavaScript

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

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

JavaScript (legado)

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

Retorna
string	Caminho do bloco de anúncios.

---

getAttributeKeys

getAttributeKeys(): string[]

Retorna a lista de chaves de atributo definidas neste slot. Para ver as chaves de atributos no nível do serviço herdados por esse espaço, use PubAdsService.getAttributeKeys.

Descontinuado:use googletag.Slot.getConfig.

Exemplo

JavaScript

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

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

JavaScript (legado)

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

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

TypeScript

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

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

Retorna
string[]	Matriz de chaves de atributo. A ordem é indefinida.

---

getCategoryExclusions

getCategoryExclusions(): string[]

Retorna os rótulos de exclusão de categoria de anúncio para esse espaço.

Descontinuado:use googletag.Slot.getConfig.

Exemplo

JavaScript

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

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

JavaScript (legado)

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

var exclusions =
  ((_a = slot.getConfig("categoryExclusion")) === null || _a === void 0
    ? void 0
    : _a.categoryExclusion) || [];
// Returns ['AirlineAd', 'TrainAd'].

TypeScript

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

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

Retorna
string[]	Os rótulos de exclusão de categoria de anúncio para esse espaço ou uma matriz vazia se nenhum tiver sido definido.

---

getConfig

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

Recebe uma cópia congelada das opções de configuração geral do espaço definido por setConfig.

Nem todas as propriedades de setConfig() são compatíveis com esse método. As propriedades compatíveis são:

• adsenseAttributes
• categoryExclusion
• targeting

Exemplo

JavaScript

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

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

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

JavaScript (legado)

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

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

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

TypeScript

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

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

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

Parâmetros
keys: string | string[]	As chaves das opções de configuração que serão recebidas.

Retorna
Readonly<Pick<SlotSettingsConfig, "adsenseAttributes" | "targeting" | "categoryExclusion">>	Uma cópia congelada das opções de configuração do slot.

---

getResponseInformation

getResponseInformation(): ResponseInformation

Retorna as informações de resposta do anúncio. Isso se baseia na última resposta do anúncio para o espaço. Se essa função for chamada quando o espaço não tiver um anúncio, null será retornado.

Retorna
ResponseInformation	As informações mais recentes da resposta do anúncio ou null se o espaço não tiver um anúncio.

---

getSlotElementId

getSlotElementId(): string

Retorna o ID do slot div fornecido quando o slot foi definido.

Exemplo

JavaScript

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

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

JavaScript (legado)

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

Retorna
string	ID do slot div.

---

getTargeting

getTargeting(key: string): string[]

Retorna um parâmetro de segmentação personalizada específico definido nesse espaço. Os parâmetros de segmentação no nível do serviço não estão incluídos.

Descontinuado:use googletag.Slot.getConfig.

Exemplo

JavaScript

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

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

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

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

JavaScript (legado)

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

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

// Get targeting for a specific key.
var targeting =
  (targetingConfig === null || targetingConfig === void 0
    ? void 0
    : targetingConfig["allow_expandable"]) || [];
// Returns ['true'].

var ageTargeting =
  (targetingConfig === null || targetingConfig === void 0 ? void 0 : targetingConfig["age"]) || [];
// Returns [] (empty array).

TypeScript

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

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

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

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

Parâmetros
key: string	A chave de segmentação que será procurada.

Retorna
string[]	Os valores associados a essa chave ou uma matriz vazia, se não houver essa chave.

---

getTargetingKeys

getTargetingKeys(): string[]

Retorna a lista de todas as chaves de segmentação personalizada definidas nesse espaço. As chaves de segmentação no nível do serviço não estão incluídas.

Descontinuado:use googletag.Slot.getConfig.

Exemplo

JavaScript

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

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

JavaScript (legado)

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

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

TypeScript

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

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

Retorna
string[]	Matriz de chaves de segmentação. A ordem é indefinida.

---

set

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

Define um valor para um atributo do Google AdSense nesse espaço do anúncio. Isso vai substituir todos os valores definidos no nível do serviço para essa chave.

Chamar esse método mais de uma vez para a mesma chave vai substituir os valores definidos anteriormente para ela. Todos os valores precisam ser definidos antes de chamar display ou refresh.

Descontinuado:use SlotSettingsConfig.adsenseAttributes.

Exemplo

JavaScript

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

JavaScript (legado)

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

TypeScript

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

Consulte também

• Atributos do AdSense

Parâmetros
key: string	O nome do atributo.
value: string	Valor do atributo.

Retorna
Slot	O objeto de espaço em que o método foi chamado.

---

setCategoryExclusion

setCategoryExclusion(categoryExclusion: string): Slot

Define um rótulo de exclusão de categoria de anúncio no nível do espaço.

Descontinuado:use SlotSettingsConfig.categoryExclusion.

Exemplo

JavaScript

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

JavaScript (legado)

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

TypeScript

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

Consulte também

• Rótulos personalizados para bloquear anúncios

Parâmetros
categoryExclusion: string	O rótulo de exclusão de categoria de anúncio a ser adicionado.

Retorna
Slot	O objeto de espaço em que o método foi chamado.

---

setClickUrl

setClickUrl(value: string): Slot

Define o URL de clique para onde os usuários serão redirecionados depois de clicar no anúncio.

Os servidores do Google Ad Manager ainda registram um clique mesmo que o URL de clique seja substituído. Qualquer URL de página de destino associado ao criativo veiculado é anexado ao valor fornecido. As chamadas subsequentes substituem o valor. Isso funciona apenas para solicitações que não são de SRA.

Descontinuado:use SlotSettingsConfig.clickUrl.

Exemplo

JavaScript

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

JavaScript (legado)

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

TypeScript

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

Parâmetros
value: string	O URL de clique a ser definido.

Retorna
Slot	O objeto de espaço em que o método foi chamado.

---

setCollapseEmptyDiv

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

Define se o espaço div precisa ser ocultado quando não há anúncios nele. Isso substitui as configurações no nível do serviço.

Descontinuado:use SlotSettingsConfig.collapseDiv.

Exemplo

JavaScript

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

const slot2 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")
  .setConfig({
    collapseDiv: "ON_NO_FILL",
  })
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// only after GPT detects that no ads are available for the slot.

JavaScript (legado)

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

var slot2 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")
  .setConfig({
    collapseDiv: "ON_NO_FILL",
  })
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// only after GPT detects that no ads are available for the slot.

TypeScript

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

const slot2 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")!
  .setConfig({
    collapseDiv: "ON_NO_FILL",
  })
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// only after GPT detects that no ads are available for the slot.

Consulte também

• Recolher espaços do anúncio vazios
• Minimizar a mudança de layout

Parâmetros
collapse: boolean	Indica se o espaço será recolhido se nenhum anúncio for retornado.
Optional collapseBeforeAdFetch: boolean	Se o espaço deve ser recolhido antes mesmo de um anúncio ser buscado. Ignorado se o recolhimento não for true.

Retorna
Slot	O objeto de espaço em que o método foi chamado.

---

setConfig

setConfig(slotConfig: SlotSettingsConfig): Slot

Define as opções de configuração geral para este slot.

Parâmetros
slotConfig: SlotSettingsConfig	O objeto de configuração.

Retorna
Slot	O objeto de espaço em que o método foi chamado.

---

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): Slot

Configura se os anúncios nesse espaço precisam ser renderizados usando um contêiner do SafeFrame.

Lembre-se do seguinte ao usar essa API:

• Essa configuração só vai entrar em vigor para as solicitações de anúncio subsequentes feitas para os respectivos espaços.
• A configuração no nível do espaço, se especificada, sempre vai substituir a configuração no nível da página.
• Se definido como true (no nível do espaço ou da página), o anúncio sempre será renderizado usando um contêiner do SafeFrame, independentemente da escolha feita na interface do Google Ad Manager.
• No entanto, se definido como false ou deixado sem especificação, o anúncio será renderizado usando um contêiner do SafeFrame, dependendo do tipo de criativo e da seleção feita na interface do Google Ad Manager.
• Essa API precisa ser usada com cuidado, porque pode afetar o comportamento de criativos que tentam sair dos iFrames ou que dependem da renderização direta em uma página do publisher.

Descontinuado:use SlotSettingsConfig.safeFrame.

Exemplo

JavaScript

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

JavaScript (legado)

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

Consulte também

• Renderizar criativos com o SafeFrame

Parâmetros
forceSafeFrame: boolean	true para forçar a renderização de todos os anúncios desse espaço em SafeFrames e false para desativar uma configuração no nível da página (se houver). Definir como false quando não especificado no nível da página não muda nada.

Retorna
Slot	O objeto de espaço em que o método foi chamado.

---

setSafeFrameConfig

setSafeFrameConfig(config: SafeFrameConfig): Slot

Define as preferências no nível do espaço para a configuração do SafeFrame. As chaves não reconhecidas no objeto de configuração serão ignoradas. Toda a configuração será ignorada se um valor inválido for transmitido para uma chave reconhecida.

Se especificadas, essas preferências no nível do espaço vão substituir as preferências no nível da página.

Descontinuado:use SlotSettingsConfig.safeFrame.

Exemplo

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

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

Consulte também

• Renderizar criativos com o SafeFrame

Parâmetros
config: SafeFrameConfig	O objeto de configuração.

Retorna
Slot	O objeto de espaço em que o método foi chamado.

---

setTargeting

setTargeting(key: string, value: string | string[]): Slot

Define um parâmetro de segmentação personalizada para esse espaço. Chamar esse método várias vezes para a mesma chave vai substituir os valores antigos. Os valores definidos aqui vão substituir os parâmetros de segmentação definidos no nível do serviço. Essas chaves são definidas na sua conta do Google Ad Manager.

Descontinuado:use SlotSettingsConfig.targeting.

Exemplo

JavaScript

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

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

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

JavaScript (legado)

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

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

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

TypeScript

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

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

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

Consulte também

• Segmentação por chave-valor

Parâmetros
key: string	Chave do parâmetro de segmentação.
value: string | string[]	Valor de parâmetro ou matriz de valores.

Retorna
Slot	O objeto de espaço em que o método foi chamado.

---

updateTargetingFromMap

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

Define parâmetros de segmentação personalizada para esse espaço, de um mapa de chave-valor em um objeto JSON. Isso é o mesmo que chamar Slot.setTargeting para todas as chaves-valor do objeto. Essas chaves são definidas na sua conta do Google Ad Manager.

Observações:

• Em caso de substituição, apenas o último valor será mantido.
• Se o valor for uma matriz, qualquer valor anterior será substituído, não mesclado.
• Os valores definidos aqui vão substituir os parâmetros de segmentação definidos no nível do serviço.

Descontinuado:use SlotSettingsConfig.targeting.

Exemplo

JavaScript

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

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

JavaScript (legado)

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 chave-valor do parâmetro de segmentação.

Retorna
Slot	O objeto de espaço em que o método foi chamado.

---

googletag.config

Interface de configuração principal para definições no nível da página.

Interfaces
AdExpansionConfig	Configurações para controlar a expansão de anúncios.
AdSenseAttributesConfig	Configurações para controlar o comportamento dos anúncios do Google AdSense.
AutoRefreshConfig	Configurações de atualização automática.
ContinueButtonConfig	Configurações para definir o comportamento do botão "Continuar".
InterstitialConfig	Um objeto que define o comportamento de um único espaço do anúncio intersticial.
LazyLoadConfig	Configurações para controlar o uso do carregamento lento na GPT.
PageSettingsConfig	Interface de configuração principal para definições no nível da página.
PrivacyTreatmentsConfig	Configurações para controlar os tratamentos de privacidade do editor.
PublisherProvidedSignalsConfig	Objeto de configuração de indicadores fornecidos pelo publisher (PPS).
SafeFrameConfig	Configurações para controlar o SafeFrame na GPT.
SlotSettingsConfig	Interface de configuração principal para as definições no nível do espaço.
TaxonomyData	Um objeto que contém os valores de uma única Taxonomia.
VideoAdsConfig	Configurações para definir as configurações relacionadas a anúncios em vídeo.

Aliases de tipo
CollapseDivBehavior	Valores aceitos para controlar o comportamento de recolhimento dos espaços de anúncio.
InterstitialTrigger	Acionadores de anúncios intersticiais compatíveis.
PrivacyTreatment	Tratamentos de privacidade do publisher compatíveis.
Taxonomy	Taxonomias compatíveis com os indicadores fornecidos pelo publisher (PPS).

Aliases de tipo

---

CollapseDivBehavior

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

Valores compatíveis para controlar o comportamento de recolhimento dos espaços do anúncio.

Consulte também

• PageSettingsConfig.collapseDiv
• SlotSettingsConfig.collapseDiv

---

InterstitialTrigger

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

Acionadores de anúncios intersticiais compatíveis.

Observação: a partir de 15 de junho de 2026, o acionador backward não será mais compatível, e a ativação dele não terá efeito. Consulte as notas da versão da GPT para mais informações.

---

PrivacyTreatment

PrivacyTreatment: "disablePersonalization"

Tratamentos de privacidade do publisher compatíveis.

---

Taxonomia

Taxonomy: "IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"

Taxonomias compatíveis com os indicadores fornecidos pelo publisher (PPS).

Consulte também

• Taxonomia de público-alvo do IAB 1.1
• Taxonomia de conteúdo 2.2 do IAB

---

googletag.config.AdExpansionConfig

Configurações para controlar a expansão de anúncios.

Propriedades
enabled?	Se a expansão de anúncios está ativada ou desativada.

Exemplo

JavaScript

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

JavaScript (legado)

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

Propriedades

---

Optional ativado

enabled?: boolean

Se a expansão de anúncios está ativada ou desativada.

Definir esse valor substitui o padrão configurado no Google Ad Manager.

Consulte também

• Expandir anúncios em computadores e tablets
• Expandir anúncios na Web para dispositivos móveis (tela parcial)

---

googletag.config.AdSenseAttributesConfig

Configurações para controlar o comportamento dos anúncios do Google AdSense.

Esses atributos podem ser usados para substituir as configurações do lado do servidor em cada solicitação.

Propriedades
adsense_ad_format?	Formato de anúncio do AdSense.
adsense_channel_ids?	IDs de canais do Google AdSense.
adsense_test_mode?	Se o modo de teste está ativado ou não.
document_language?	Idioma da página em que os anúncios são veiculados.
page_url?	URL da página em que os anúncios são veiculados.

Consulte também

• PageSettingsConfig.adsenseAttributes
• SlotSettingsConfig.adsenseAttributes

Propriedades

---

Optional adsense_ad_format

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

Formato de anúncio do AdSense.

---

Optional adsense_channel_ids

adsense_channel_ids?: string

IDs de canal do Google AdSense.

Os valores permitidos são IDs de canal separados por "+".

Exemplo: 271828183+314159265

Consulte também

• Acompanhar a performance dos blocos de anúncios com canais personalizados

---

Optional adsense_test_mode

adsense_test_mode?: "on"

Se o modo de teste está ativado ou não.

Quando definido como on, os anúncios são marcados como somente para teste e não são incluídos na contagem ou no faturamento. Essa configuração precisa ser desativada para o tráfego de produção que não é de teste.

---

Optional document_language

document_language?: string

Idioma da página em que os anúncios são exibidos.

Os valores permitidos são códigos de idioma ISO 639-1 válidos.

Exemplo: en

Consulte também

• Lista de códigos de idioma ISO 639

---

Optional page_url

page_url?: string

URL da página em que os anúncios são exibidos.

Os valores permitidos são URLs válidos.

Exemplo: http://www.example.com

---

googletag.config.AutoRefreshConfig

Configurações de atualização automática.

Propriedades
backForwardCache?	Se a GPT vai atualizar automaticamente um espaço de anúncio visualizado ativamente quando a página for restaurada do cache de avanço e retorno.
heavyAds?	Se a GPT vai atualizar automaticamente um espaço do anúncio se a intervenção de anúncios pesados do Chrome for acionada no iframe do anúncio do espaço.

Propriedades

---

Optional backForwardCache

backForwardCache?: boolean

Se a GPT vai atualizar automaticamente um espaço de anúncio visualizado ativamente quando a página for restaurada do cache de avanço e retorno. O padrão é true.

Exemplo

JavaScript

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

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

JavaScript (legado)

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

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

TypeScript

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

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

Consulte também

• Cache de avanço e retorno

---

Optional heavyAds

heavyAds?: boolean

Se a GPT vai atualizar automaticamente um espaço do anúncio se a intervenção de anúncios pesados do Chrome for acionada no iframe do anúncio do espaço. O padrão é true.

Exemplo

JavaScript

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

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

JavaScript (legado)

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

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

TypeScript

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

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

Consulte também

• Entender as intervenções em anúncios pesados do Chrome

---

googletag.config.ContinueButtonConfig

Configurações para definir o comportamento do botão "Continuar".

Propriedades
backgroundColor?	A cor de fundo do botão.
font?	A família de fontes do texto do botão.
fontColor?	A cor do texto do botão.
freqCapIntervalMinutes?	O intervalo do limite de frequência em minutos.
targetId?	O ID do elemento HTML em que o botão "Continuar" será renderizado/acionado.

Consulte também

• SlotSettingsConfig.continueButton

Propriedades

---

Optional backgroundColor

backgroundColor?: string

A cor de fundo do botão.

Exemplo: 'blue', '#94B1FF'

---

Optional fonte

font?: string

A família de fontes do texto do botão.

Exemplo: 'Arial'

---

Optional fontColor

fontColor?: string

A cor do texto do botão.

Exemplo: 'white', '#B73B87'

---

Optional freqCapIntervalMinutes

freqCapIntervalMinutes?: number

O intervalo do limite de frequência em minutos.

Precisa ser um número inteiro maior ou igual a 1.

---

Optional targetId

targetId?: string

O ID do elemento HTML em que o botão "Continuar" será renderizado/acionado.

---

googletag.config.InterstitialConfig

Um objeto que define o comportamento de um único espaço do anúncio intersticial.

Propriedades
requireStorageAccess?	Se o consentimento para armazenamento local é necessário para mostrar esse anúncio intersticial.
triggers?	A configuração do acionador intersticial para este anúncio intersticial.

Propriedades

---

Optional requireStorageAccess

requireStorageAccess?: boolean

Se o consentimento para armazenamento local é necessário para mostrar esse anúncio intersticial.

A GPT usa o armazenamento local para aplicar um limite de frequência aos anúncios intersticiais. No entanto, os usuários que não deram consentimento para armazenamento local ainda podem receber anúncios intersticiais. Definir essa propriedade como true desativa o comportamento padrão e garante que os anúncios intersticiais sejam mostrados apenas aos usuários que deram consentimento para o armazenamento local.

Exemplo

JavaScript

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

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

JavaScript (legado)

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

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

TypeScript

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

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

Consulte também

• Tráfego de intersticiais da Web

---

Optional gatilhos

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

A configuração do acionador intersticial para esse anúncio intersticial.

Definir o valor de um acionador intersticial como true vai ativá-lo, e false vai desativá-lo. Isso vai substituir os valores padrão configurados no Google Ad Manager.

Exemplo

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

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

Consulte também

• Mostrar um anúncio intersticial da Web

---

googletag.config.LazyLoadConfig

Configurações para controlar o uso do carregamento lento na GPT.

Propriedades
fetchMarginPercent?	A distância mínima da janela de visualização atual que um espaço precisa ter antes de solicitarmos um anúncio, expressa como uma porcentagem do tamanho da janela de visualização.
mobileScaling?	Um multiplicador aplicado às margens em dispositivos móveis.
renderMarginPercent?	A distância mínima da janela de visualização atual que um espaço precisa ter antes de renderizarmos um anúncio, expressa como uma porcentagem do tamanho da janela de visualização.

Consulte também

• PageSettingsConfig.lazyLoad

Propriedades

---

Optional fetchMarginPercent

fetchMarginPercent?: number

A distância mínima da janela de visualização atual que um espaço precisa ter antes de solicitarmos um anúncio, expressa como uma porcentagem do tamanho da janela de visualização.

Usada em conjunto com renderMarginPercent, essa configuração permite pré-buscar um anúncio, mas aguardar para renderizar e fazer o download de outros sub-recursos. Portanto, esse valor precisa ser sempre maior ou igual a renderMarginPercent.

Um valor de 0 significa "quando o espaço entra na janela de visualização", 100 significa "quando o anúncio está a uma janela de visualização de distância" e assim por diante.

---

Optional mobileScaling

mobileScaling?: number

Um multiplicador aplicado às margens em dispositivos móveis. Esse multiplicador é aplicado a fetchMarginPercent e renderMarginPercent.

Isso permite margens diferentes em dispositivos móveis e computadores, em que os tamanhos da janela de visualização e as velocidades de rolagem podem ser diferentes. Por exemplo, um valor de 2,0 vai multiplicar todas as margens por 2 em dispositivos móveis, aumentando a distância mínima que um espaço pode ter da janela de visualização antes de buscar e renderizar.

---

Optional renderMarginPercent

renderMarginPercent?: number

A distância mínima do viewport atual que um espaço precisa ter antes de renderizarmos um anúncio, expressa como uma porcentagem do tamanho do viewport.

Usada em conjunto com fetchMarginPercent, essa configuração permite a pré-busca de um anúncio, mas aguarda a renderização e o download de outros sub-recursos. Portanto, esse valor precisa ser sempre menor ou igual a fetchMarginPercent.

Um valor de 0 significa "quando o espaço entra na janela de visualização", 100 significa "quando o anúncio está a uma janela de visualização de distância" e assim por diante.

---

googletag.config.PageSettingsConfig

Interface de configuração principal para definições no nível da página.

Permite definir vários recursos com uma única chamada de API.

Todas as propriedades listadas abaixo são exemplos e não refletem os recursos reais que usam setConfig. Para ver o conjunto de recursos, consulte os campos no tipo PageSettingsConfig abaixo.

Exemplos:

• Somente os recursos especificados na chamada googletag.setConfig são modificados.

    // Configure feature alpha.
    googletag.setConfig({
        alpha: {...}
    });
  
    // Configure feature bravo. Feature alpha is unchanged.
    googletag.setConfig({
       bravo: {...}
    });

• Todas as configurações de um determinado recurso são atualizadas a cada chamada para googletag.setConfig.

    // Configure feature charlie to echo = 1, foxtrot = true.
    googletag.setConfig({
        charlie: {
            echo: 1,
            foxtrot: true,
        }
    });
  
    // Update feature charlie to echo = 2. Since foxtrot was not specified,
    // the value is cleared.
    googletag.setConfig({
        charlie: {
            echo: 2
        }
    });

• Todas as configurações de um recurso podem ser apagadas transmitindo 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,
    });

Propriedades
adExpansion?	Configurações para controlar a expansão de anúncios.
adsenseAttributes?	Configuração para definir os atributos do Google AdSense.
adYield?	Descontinuado.
autoRefresh?	Configuração para definir o comportamento de atualização automática de anúncios.
categoryExclusion?	Configuração para definir exclusões de categorias de anúncios.
centering?	Configuração para controlar a centralização horizontal dos anúncios.
collapseDiv?	Configuração para controlar o comportamento de recolhimento dos espaços do anúncio.
disableInitialLoad?	Configuração para controlar quando os anúncios são solicitados.
lazyLoad?	Configurações para controlar o uso do carregamento lento na GPT.
location?	Configuração para segmentar itens de linha por área geográfica.
pps?	Configurações para controlar os indicadores fornecidos pelo publisher (PPS).
privacyTreatments?	Configurações para controlar os tratamentos de privacidade do editor.
requestHookTimeoutMs?	Configuração para controlar o tempo máximo que a GPT vai esperar para que todos os ganchos de solicitação registrados sejam concluídos antes de prosseguir com uma solicitação de anúncio.
safeFrame?	Configurações para controlar o uso do SafeFrame na GPT.
singleRequest?	Configuração para ativar ou desativar a arquitetura de solicitação única (SRA).
targeting?	Configuração para controlar a segmentação por chave-valor.
threadYield?	Configuração para controlar se a GPT deve gerar a linha de execução JS ao solicitar e renderizar criativos.
videoAds?	Configurações para controlar anúncios em vídeo.

Propriedades

---

Optional adExpansion

adExpansion?: AdExpansionConfig

Configurações para controlar a expansão de anúncios.

---

Optional adsenseAttributes

adsenseAttributes?: AdSenseAttributesConfig

Configuração para definir os atributos do Google AdSense.

Os atributos do Google AdSense definidos por essa configuração serão aplicados a todos os espaços de anúncio na página. Essa configuração pode ser chamada várias vezes para definir vários valores de atributo ou substituir os valores atuais.

As mudanças nos atributos do Google AdSense só se aplicam aos anúncios solicitados depois que esse método é chamado. Por isso, recomendamos chamar esse método antes de qualquer chamada para googletag.display ou PubAdsService.refresh.

Exemplo

JavaScript

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

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

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

JavaScript (legado)

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

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

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

TypeScript

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

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

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

---

Optional adYield

adYield?: "DISABLED" | "ENABLED_ALL_SLOTS"

Descontinuado:use threadYield. Ele será removido em breve.

---

Optional autoRefresh

autoRefresh?: AutoRefreshConfig

Configuração para definir o comportamento da atualização automática de anúncios.

Exemplo

JavaScript

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

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

JavaScript (legado)

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

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

TypeScript

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

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

---

Optional categoryExclusion

categoryExclusion?: string[]

Configuração para definir exclusões de categorias de anúncios.

Exemplo

JavaScript

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

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

JavaScript (legado)

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

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

TypeScript

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

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

Consulte também

• Rótulos personalizados para bloquear anúncios

---

Optional centralização

centering?: boolean

Configuração para controlar a centralização horizontal dos anúncios. A centralização fica desativada por padrão.

As mudanças na centralização horizontal só se aplicam às solicitações de anúncio feitas após a chamada desse método. Por isso, recomendamos chamar esse método antes de qualquer chamada para googletag.display ou PubAdsService.refresh.

Exemplo

JavaScript

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

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

JavaScript (legado)

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

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

TypeScript

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

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

---

Optional collapseDiv

collapseDiv?: CollapseDivBehavior

Configuração para controlar o comportamento de recolhimento dos espaços do anúncio.

Um espaço do anúncio recolhido não ocupa espaço na página.

Valores compatíveis:

• null (padrão): o espaço não será recolhido.
• DISABLED: o espaço não será recolhido, mesmo que nenhum anúncio seja retornado.
• BEFORE_FETCH: o espaço começa recolhido e se expande quando um anúncio é retornado.
• ON_NO_FILL: o espaço começa expandido e é recolhido se nenhum anúncio é retornado.

Exemplo

JavaScript

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

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

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

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

JavaScript (legado)

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

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

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

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

TypeScript

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

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

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

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

Consulte também

• Recolher espaços do anúncio vazios
• Minimizar a mudança de layout

---

Optional disableInitialLoad

disableInitialLoad?: boolean

Configuração para controlar quando os anúncios são solicitados.

Por padrão, o método googletag.display registra os espaços de anúncio e solicita anúncios para eles. No entanto, às vezes é melhor separar essas ações para controlar com mais precisão quando o conteúdo do anúncio é carregado.

Ao ativar essa configuração, os anúncios não serão solicitados para espaços registrados quando o método display() for chamado. Em vez disso, uma chamada separada para PubAdsService.refresh precisa ser feita para iniciar uma solicitação de anúncio.

Esse método precisa ser chamado antes de googletag.enableServices.

Exemplo

JavaScript

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

JavaScript (legado)

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

TypeScript

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

Consulte também

• Controlar o carregamento e a atualização de anúncios
• Controlar o loteamento de SRA

---

Optional lazyLoad

lazyLoad?: LazyLoadConfig

Configurações para controlar o uso do carregamento lento na GPT.

O carregamento lento é uma técnica para atrasar a solicitação e a renderização de anúncios até que eles se aproximem da janela de visualização do usuário. Para um exemplo mais detalhado, consulte o exemplo de carregamento lento.

Observação:se singleRequest estiver ativado, a busca lenta só vai funcionar quando todos os espaços estiverem fora da margem de busca.

As configurações de carregamento lento que não forem especificadas ao chamar setConfig() vão usar um valor padrão definido pelo Google. Esses padrões podem ser ajustados ao longo do tempo. Para desativar uma configuração específica, defina o valor como null.

Exemplo

JavaScript

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

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

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

JavaScript (legado)

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

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

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

TypeScript

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

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

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

Consulte também

• Práticas recomendadas para anúncios: priorize espaços do anúncio "importantes"
• Carregamento lento

---

Optional local

location?: string

Configuração para segmentar itens de linha por área geográfica.

Exemplo

JavaScript

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

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

JavaScript (legado)

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

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

TypeScript

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

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

Consulte também

• Segmentar localizações geográficas para exibição

---

Optional pps

pps?: PublisherProvidedSignalsConfig

Configurações para controlar os indicadores fornecidos pelo publisher (PPS).

---

Optional privacyTreatments

privacyTreatments?: PrivacyTreatmentsConfig

Configurações para controlar os tratamentos de privacidade do editor.

---

Optional Experimental requestHookTimeoutMs

requestHookTimeoutMs?: number | "auto"

Configuração para controlar o tempo máximo que a GPT vai esperar para que todos os hooks de solicitação registrados sejam concluídos antes de prosseguir com uma solicitação de anúncio.

Todos os hooks de solicitação registrados são executados em paralelo. Esse tempo limite define o limite máximo de tempo que o processo de solicitação de anúncio vai pausar enquanto aguarda a conclusão dessas execuções paralelas.

Valores compatíveis:

• Número positivo em milissegundos: o período de espera personalizado.
• 'auto': a GPT usa um tempo limite otimizado pelo Google.
• null: desativa os tempos limite (a GPT aguarda indefinidamente a conclusão dos hooks).

Exemplo

JavaScript

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

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

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

JavaScript (legado)

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

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

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

TypeScript

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

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

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

---

Optional safeFrame

safeFrame?: SafeFrameConfig

Configurações para controlar o uso do SafeFrame na GPT.

Os valores configurados por essa definição serão aplicados a todos os espaços de anúncio na página. Os espaços do anúncio individuais podem substituir esses valores usando SlotSettingsConfig.safeFrame.

Exemplo

JavaScript

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

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

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

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

JavaScript (legado)

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

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

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

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

TypeScript

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

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

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

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

---

Optional singleRequest

singleRequest?: boolean

Configuração para ativar ou desativar a arquitetura de solicitação única (SRA).

Quando a SRA está ativada, todos os espaços de anúncio definidos antes de uma chamada googletag.display ou PubAdsService.refresh são agrupados em uma única solicitação de anúncio. Isso oferece benefícios de desempenho, mas também é necessário para garantir que os roadblocks e as exclusões competitivas sejam respeitados.

Quando a SRA está desativada, cada espaço do anúncio é solicitado individualmente. Esse é o comportamento padrão da GPT.

Esse método precisa ser chamado antes de googletag.enableServices.

Exemplo

JavaScript

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

JavaScript (legado)

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

TypeScript

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

Consulte também

• Sobre roadblocks
• Práticas recomendadas para anúncios: use a arquitetura de solicitação única corretamente
• Controlar o loteamento de SRA

---

Optional segmentação

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

Configuração para controlar a segmentação por chave-valor.

A segmentação configurada por essa configuração será aplicada a todos os espaços do anúncio na página. Essa configuração pode ser chamada várias vezes para definir várias chaves-valor de segmentação ou substituir valores atuais. As chaves de segmentação são definidas na sua conta do Google Ad Manager.

Exemplo

JavaScript

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

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

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

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

JavaScript (legado)

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

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

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

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

TypeScript

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

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

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

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

Consulte também

• Segmentação por chave-valor

---

Optional threadYield

threadYield?: "DISABLED" | "ENABLED_ALL_SLOTS"

Configuração para controlar se a GPT deve ceder a linha de execução do JS ao solicitar e renderizar criativos.

A GPT só vai ceder para navegadores que oferecem suporte à API Scheduler.postTask ou Scheduler.yield.

Valores compatíveis:

• null (padrão): a GPT vai gerar a linha de execução JS para espaços fora da janela de visualização.
• ENABLED_ALL_SLOTS: a GPT vai gerar a linha de execução JS para todos os espaços, independentemente de estarem na janela de visualização.
• DISABLED: a GPT não vai gerar a linha de execução do JS.

Exemplo

JavaScript

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

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

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

JavaScript (legado)

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

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

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

TypeScript

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

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

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

Consulte também

• Programador

---

Optional videoAds

videoAds?: VideoAdsConfig

Configurações para controlar anúncios em vídeo.

Exemplo

JavaScript

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

JavaScript (legado)

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

TypeScript

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

Consulte também

• Ingestão de conteúdo em vídeo

---

googletag.config.PrivacyTreatmentsConfig

Configurações para controlar os tratamentos de privacidade do editor.

Propriedades
treatments	Uma matriz de tratamentos de privacidade do publisher que serão ativados.

Propriedades

---

tratamentos

treatments: "disablePersonalization"[]

Uma matriz de tratamentos de privacidade do publisher a serem ativados.

Exemplo

JavaScript

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

JavaScript (legado)

// 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 configuração de indicadores fornecidos pelo publisher (PPS).

Propriedades
taxonomies	Um objeto que contém mapeamentos de Taxonomy ou nulo para limpar a configuração.

Exemplo

JavaScript

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

JavaScript (legado)

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

TypeScript

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

Consulte também

• Sobre os indicadores fornecidos pelo publisher (Beta)
• Taxonomia de público-alvo do IAB 1.1
• Taxonomia de conteúdo 2.2 do IAB

Propriedades

---

taxonomias

taxonomies: Partial<Record<Taxonomy, TaxonomyData>>

Um objeto que contém mapeamentos de Taxonomy ou nulo para limpar a configuração.

---

googletag.config.SafeFrameConfig

Configurações para controlar o SafeFrame na GPT.

Propriedades
allowOverlayExpansion?	Se o SafeFrame deve permitir que o conteúdo do anúncio seja expandido ao sobrepor o conteúdo da página.
allowPushExpansion?	Se o SafeFrame deve permitir que o conteúdo do anúncio seja expandido ao empurrar o conteúdo da página.
forceSafeFrame?	Se os anúncios precisam ser renderizados usando um contêiner SafeFrame.
sandbox?	Se o SafeFrame deve usar o atributo sandbox do HTML5 para impedir a navegação de nível superior sem interação do usuário.
useUniqueDomain?	Descontinuado. Se o SafeFrame deve usar subdomínios aleatórios para criativos de reserva.

Consulte também

• PageSettingsConfig.safeFrame
• SlotSettingsConfig.safeFrame

Propriedades

---

Optional allowOverlayExpansion

allowOverlayExpansion?: boolean

Se o SafeFrame deve permitir que o conteúdo do anúncio seja expandido sobrepondo o conteúdo da página.

---

Optional allowPushExpansion

allowPushExpansion?: boolean

Se o SafeFrame deve permitir que o conteúdo do anúncio seja expandido ao empurrar o conteúdo da página.

---

Optional forceSafeFrame

forceSafeFrame?: boolean

Se os anúncios precisam ser renderizados usando um contêiner SafeFrame.

---

Optional sandbox

sandbox?: boolean

Se o SafeFrame deve usar o atributo sandbox do HTML5 para impedir a navegação de nível superior sem interação do usuário. O único valor válido é true (não pode ser forçado para false). O atributo sandbox desativa plug-ins (por exemplo, Flash).

---

Optional useUniqueDomain

useUniqueDomain?: boolean

Se o SafeFrame deve usar subdomínios aleatórios para criativos de reserva. Transmita null para limpar o valor armazenado.

Observação: esse recurso é ativado por padrão.

Descontinuado:não é mais possível desativar esse recurso. Definir useUniqueDomain não tem efeito.

Consulte também

• Renderizar criativos com o SafeFrame

---

googletag.config.SlotSettingsConfig

Interface de configuração principal para as definições no nível do espaço.

Permite definir vários recursos com uma única chamada de API para um único espaço.

Todas as propriedades listadas abaixo são exemplos e não refletem os recursos reais que usam setConfig. Para ver o conjunto de recursos, consulte os campos no tipo SlotSettingsConfig abaixo.

Exemplos:

• Somente os recursos especificados na chamada Slot.setConfig são modificados.

    const slot = googletag.defineSlot("/1234567/example", [160, 600]);
  
    // Configure feature alpha.
    slot.setConfig({
        alpha: {...}
    });
  
    // Configure feature bravo. Feature alpha is unchanged.
    slot.setConfig({
       bravo: {...}
    });

• Todas as configurações de um determinado recurso são atualizadas a cada chamada para 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
        }
    });

• Todas as configurações de um recurso podem ser apagadas transmitindo 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,
    });

Propriedades
adExpansion?	Configurações para definir a expansão de anúncios.
adsenseAttributes?	Configuração para definir os atributos do Google AdSense.
categoryExclusion?	Configuração para definir exclusões de categorias de anúncios.
clickUrl?	Configuração para definir o URL para onde os usuários serão redirecionados depois de clicar no anúncio.
collapseDiv?	Configuração para definir o comportamento de recolhimento do espaço do anúncio.
continueButton?	Configurações para definir o comportamento do botão "Continuar" em anúncios de pausa de conteúdo.
interstitial?	Configurações que definem o comportamento do espaço do anúncio intersticial.
safeFrame?	Configurações para definir o uso do SafeFrame na GPT.
targeting?	Configuração para definir a segmentação por chave-valor.

Propriedades

---

Optional adExpansion

adExpansion?: AdExpansionConfig

Configurações para definir a expansão de anúncios.

Consulte também

• Expansão de anúncios

---

Optional adsenseAttributes

adsenseAttributes?: AdSenseAttributesConfig

Configuração para definir os atributos do Google AdSense.

Os atributos do Google AdSense configurados por essa configuração só serão aplicados ao espaço do anúncio. Essa configuração pode ser chamada várias vezes para definir vários valores de atributo ou substituir os valores atuais.

As mudanças nos atributos do Google AdSense só se aplicam aos anúncios solicitados depois que esse método é chamado. Por isso, recomendamos chamar esse método antes de qualquer chamada para googletag.display ou PubAdsService.refresh.

Exemplo

JavaScript

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

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

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

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

JavaScript (legado)

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

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

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

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

TypeScript

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

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

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

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

---

Optional categoryExclusion

categoryExclusion?: string[]

Configuração para definir exclusões de categorias de anúncios.

Exemplo

JavaScript

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

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

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

JavaScript (legado)

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

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

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

TypeScript

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

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

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

Consulte também

• Rótulos personalizados para bloquear anúncios

---

Optional clickUrl

clickUrl?: string

Configuração para definir o URL para onde os usuários serão redirecionados depois de clicar no anúncio.

Os servidores do Google Ad Manager ainda registram um clique mesmo que o URL de clique seja substituído. Qualquer URL de página de destino associado ao criativo veiculado é anexado ao valor fornecido. Definir esse valor mais de uma vez vai substituir qualquer valor configurado anteriormente. Transmitir null vai limpar o valor.

Observação:essa configuração se aplica apenas a solicitações que não são de SRA.

Exemplo

JavaScript

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

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

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

JavaScript (legado)

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

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

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

TypeScript

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

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

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

---

Optional collapseDiv

collapseDiv?: CollapseDivBehavior

Configuração para definir o comportamento de recolhimento do espaço do anúncio.

Um espaço de anúncio recolhido não ocupa espaço na página.

Valores compatíveis:

• null (padrão): o espaço não será recolhido.
• DISABLED: o espaço não será recolhido, mesmo que nenhum anúncio seja retornado.
• BEFORE_FETCH: o espaço começa recolhido e se expande quando um anúncio é retornado.
• ON_NO_FILL: o espaço começa expandido e é recolhido se nenhum anúncio é retornado.

Exemplo

JavaScript

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

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

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

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

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

JavaScript (legado)

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

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

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

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

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

TypeScript

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

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

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

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

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

Consulte também

• Recolher espaços do anúncio vazios
• Minimizar a mudança de layout

---

Optional continueButton

continueButton?: ContinueButtonConfig

Configurações para definir o comportamento do botão "Continuar" em anúncios de pausa de conteúdo.

Essas configurações permitem personalizar a aparência e o comportamento das interações de saída e de continuar lendo associadas aos formatos de pausa de conteúdo.

Todas as configurações do botão "Continuar" que não forem especificadas ao chamar setConfig() vão usar um valor padrão definido pelo Google.

Para desativar ou limpar todas as configurações do botão "Continuar", transmita null.

Exemplo

JavaScript

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

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

JavaScript (legado)

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

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

TypeScript

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

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

---

Optional intersticial

interstitial?: InterstitialConfig

Configurações que definem o comportamento do espaço do anúncio intersticial.

Consulte também

• Tráfego de intersticiais da Web

---

Optional safeFrame

safeFrame?: SafeFrameConfig

Configurações para definir o uso do SafeFrame na GPT.

Os valores configurados por essa configuração só serão aplicados ao espaço do anúncio e vão substituir os valores definidos por PageSettingsConfig.safeFrame.

Exemplo

JavaScript

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

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

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

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

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

JavaScript (legado)

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

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

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

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

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

TypeScript

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

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

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

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

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

---

Optional segmentação

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

Configuração para definir a segmentação por chave-valor.

A segmentação configurada por essa definição só será aplicada ao espaço do anúncio. Essa configuração pode ser chamada várias vezes para definir várias chaves-valor de segmentação ou substituir valores atuais. As chaves de segmentação são definidas na sua conta do Google Ad Manager.

Exemplo

JavaScript

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

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

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

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

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

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

JavaScript (legado)

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

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

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

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

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

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

TypeScript

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

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

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

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

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

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

Consulte também

• Segmentação por chave-valor

---

googletag.config.TaxonomyData

Um objeto que contém os valores de uma única Taxonomia.

Propriedades
values	Uma lista de valores de Taxonomia.

Propriedades

---

valores

values: readonly string[]

Uma lista de valores de Taxonomia.

---

googletag.config.VideoAdsConfig

Configurações para definir as configurações relacionadas a anúncios em vídeo.

Propriedades
enableVideoAds	Se os anúncios em vídeo vão aparecer na página.
videoCmsId?	O ID da origem do conteúdo de vídeo.
videoContentId?	O Content ID do vídeo.

Consulte também

• PageSettingsConfig.videoAds

Propriedades

---

enableVideoAds

enableVideoAds: boolean

Se os anúncios em vídeo vão estar presentes na página.

Quando definido como true, isso ativa as restrições de exclusão de conteúdo em anúncios de display e em vídeo.

Se o conteúdo em vídeo for conhecido, defina videoContentId e videoCmsId com os valores fornecidos ao serviço de ingestão de conteúdo do Google Ad Manager para usar a exclusão de conteúdo em anúncios de display.

---

Optional videoCmsId

videoCmsId?: string

O ID da origem do conteúdo em vídeo.

Esse é um valor exclusivo atribuído pelo serviço de ingestão de conteúdo do Google Ad Manager para identificar a origem do conteúdo em vídeo especificado por videoContentId.

Consulte também

• cmsid (ID da origem do conteúdo)

---

Optional videoContentId

videoContentId?: string

O Content ID do vídeo.

Esse é um valor exclusivo que identifica um vídeo específico da origem do conteúdo definida por videoCmsId. Esse valor é atribuído pelo CMS que hospeda seu conteúdo em vídeo.

Consulte também

• vid (ID do vídeo)

---

googletag.enums

Este é o namespace que a GPT usa para tipos enumerados.

Enumerações
OutOfPageFormat	Formatos fora da página compatíveis com a GPT.
TagForAgeTreatment	Configurações de tratamento por idade compatíveis com a GPT.
TrafficSource	Origens de tráfego compatíveis com a GPT.

Enumerações

---

OutOfPageFormat

OutOfPageFormat

Formatos fora da página compatíveis com a GPT.

Consulte também

• defineOutOfPageSlot

Membros de enumeração
AD_INTENTS	Formato de intenções de anúncio.
BOTTOM_ANCHOR	Formato âncora em que o espaço fica na parte de baixo da janela de visualização.
GAME_MANUAL_INTERSTITIAL	Formato intersticial manual de jogo. Observação:o intersticial manual de jogo é um formato com acesso limitado.
INTERSTITIAL	Formato de criativo intersticial da Web.
LEFT_SIDE_RAIL	Formato da coluna lateral esquerda.
REWARDED	Formato premiado.
RIGHT_SIDE_RAIL	Formato de coluna lateral direita.
TOP_ANCHOR	Formato âncora em que o espaço fica fixo na parte de cima da janela de visualização.

---

TagForAgeTreatment

TagForAgeTreatment

Configurações de tratamento por idade compatíveis com a GPT.

Consulte também

• PrivacySettingsConfig.tagForAgeTreatment

Membros de enumeração
CHILD	Indica que as solicitações de anúncio devem receber tratamento para crianças.
TEEN	Indica que as solicitações de anúncio devem receber tratamento para adolescentes.
UNSPECIFIED	Valor padrão. Indica que nenhum indicador específico de tratamento com restrição de idade se aplica à solicitação de anúncio.

---

TrafficSource

TrafficSource

Origens de tráfego compatíveis com a GPT.

Consulte também

• PrivacySettingsConfig.trafficSource

Membros de enumeração
ORGANIC	Entrada de URL direto, pesquisa no site ou download do app.
PURCHASED	Tráfego redirecionado de propriedades de terceiros (atividades adquiridas ou incentivadas de outra forma).

---

googletag.events

Esse é o namespace que a GPT usa para eventos. Seu código pode reagir a esses eventos usando Service.addEventListener.

Interfaces
Event	Interface de base para todos os eventos da GPT.
EventTypeMap	Esse é um pseudotipo que mapeia um nome de evento para o tipo de objeto de evento correspondente para Service.addEventListener e Service.removeEventListener.
GameManualInterstitialSlotClosedEvent	Esse evento é acionado quando um espaço intersticial manual de jogo é fechado pelo usuário.
GameManualInterstitialSlotReadyEvent	Esse evento é acionado quando um espaço intersticial manual de jogo está pronto para ser mostrado ao usuário.
ImpressionViewableEvent	Esse evento é acionado quando uma impressão se torna visível, de acordo com os critérios do Active View.
RewardedSlotClosedEvent	Esse evento é acionado quando um espaço do anúncio premiado é fechado pelo usuário.
RewardedSlotGrantedEvent	Esse evento é acionado quando um prêmio é concedido por visualizar um anúncio premiado.
RewardedSlotReadyEvent	Esse evento é disparado quando um anúncio premiado está pronto para ser veiculado.
RewardedSlotVideoCompletedEvent	Esse evento é disparado quando um anúncio em vídeo premiado termina de ser reproduzido.
SlotOnloadEvent	Esse evento é acionado quando o iframe do criativo aciona o evento de carregamento.
SlotRenderEndedEvent	Esse evento é acionado quando o código do criativo é injetado em um espaço.
SlotRequestedEvent	Esse evento é acionado quando um anúncio é solicitado para um determinado espaço.
SlotResponseReceived	Esse evento é acionado quando uma resposta de anúncio é recebida para um determinado espaço.
SlotVisibilityChangedEvent	Esse evento é acionado sempre que a porcentagem na tela da área de um espaço do anúncio muda.

---

googletag.events.Event

Interface de base para todos os eventos da GPT. Todos os eventos da GPT abaixo terão os campos a seguir.

Propriedades
serviceName	Nome do serviço que acionou o evento.
slot	O slot que acionou o evento.

Consulte também

• Listeners de eventos de anúncio

Propriedades

---

serviceName

serviceName: string

Nome do serviço que acionou o evento.

---

slot

slot: Slot

O slot que acionou o evento.

---

googletag.events.EventTypeMap

Este é um pseudotipo que mapeia um nome de evento para o tipo de objeto de evento correspondente para Service.addEventListener e Service.removeEventListener. Ele é documentado apenas para fins de referência e segurança de tipos.

Propriedades
gameManualInterstitialSlotClosed	Alias para events.GameManualInterstitialSlotClosedEvent.
gameManualInterstitialSlotReady	Alias para events.GameManualInterstitialSlotReadyEvent.
impressionViewable	Alias para events.ImpressionViewableEvent.
rewardedSlotClosed	Alias para events.RewardedSlotClosedEvent.
rewardedSlotGranted	Alias para events.RewardedSlotGrantedEvent.
rewardedSlotReady	Alias para events.RewardedSlotReadyEvent.
rewardedSlotVideoCompleted	Alias para events.RewardedSlotVideoCompletedEvent.
slotOnload	Alias para events.SlotOnloadEvent.
slotRenderEnded	Alias para events.SlotRenderEndedEvent.
slotRequested	Alias para events.SlotRequestedEvent.
slotResponseReceived	Alias para events.SlotResponseReceived.
slotVisibilityChanged	Alias para events.SlotVisibilityChangedEvent.

Propriedades

---

gameManualInterstitialSlotClosed

gameManualInterstitialSlotClosed: GameManualInterstitialSlotClosedEvent

Alias para events.GameManualInterstitialSlotClosedEvent.

---

gameManualInterstitialSlotReady

gameManualInterstitialSlotReady: GameManualInterstitialSlotReadyEvent

Alias para events.GameManualInterstitialSlotReadyEvent.

---

impressionViewable

impressionViewable: ImpressionViewableEvent

Alias para events.ImpressionViewableEvent.

---

rewardedSlotClosed

rewardedSlotClosed: RewardedSlotClosedEvent

Alias para events.RewardedSlotClosedEvent.

---

rewardedSlotGranted

rewardedSlotGranted: RewardedSlotGrantedEvent

Alias para events.RewardedSlotGrantedEvent.

---

rewardedSlotReady

rewardedSlotReady: RewardedSlotReadyEvent

Alias para events.RewardedSlotReadyEvent.

---

rewardedSlotVideoCompleted

rewardedSlotVideoCompleted: RewardedSlotVideoCompletedEvent

Alias para events.RewardedSlotVideoCompletedEvent.

---

slotOnload

slotOnload: SlotOnloadEvent

Alias para events.SlotOnloadEvent.

---

slotRenderEnded

slotRenderEnded: SlotRenderEndedEvent

Alias para events.SlotRenderEndedEvent.

---

slotRequested

slotRequested: SlotRequestedEvent

Alias para events.SlotRequestedEvent.

---

slotResponseReceived

slotResponseReceived: SlotResponseReceived

Alias para events.SlotResponseReceived.

---

slotVisibilityChanged

slotVisibilityChanged: SlotVisibilityChangedEvent

Alias para events.SlotVisibilityChangedEvent.

---

googletag.events.GameManualInterstitialSlotClosedEvent

Estende Event

Esse evento é disparado quando um espaço intersticial manual de jogo é fechado pelo usuário.

Observação:o intersticial manual de jogo é um formato de acesso limitado.

Propriedades
serviceName	Nome do serviço que acionou o evento. Herdado da propriedade Event.serviceName
slot	O slot que acionou o evento. Herdado da propriedade Event.slot

Exemplo

JavaScript

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

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

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

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

JavaScript (legado)

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

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

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

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

TypeScript

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

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

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

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

Consulte também

• Listeners de eventos de anúncio
• Mostrar um anúncio intersticial manual de jogos

---

googletag.events.GameManualInterstitialSlotReadyEvent

Estende Event

Esse evento é disparado quando um espaço intersticial manual de jogo está pronto para ser mostrado ao usuário.

Observação:o intersticial manual de jogo é um formato de acesso limitado.

Propriedades
serviceName	Nome do serviço que acionou o evento. Herdado da propriedade Event.serviceName
slot	O slot que acionou o evento. Herdado da propriedade Event.slot

Métodos
makeGameManualInterstitialVisible	Mostra o anúncio intersticial manual de jogo ao usuário.

Exemplo

JavaScript

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

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

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

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

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

JavaScript (legado)

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

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

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

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

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

TypeScript

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

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

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

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

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

Consulte também

• Listeners de eventos de anúncio
• Mostrar um anúncio intersticial manual de jogo

Métodos

---

makeGameManualInterstitialVisible

makeGameManualInterstitialVisible(): boolean

Mostra o anúncio intersticial manual de jogo ao usuário. Retorna se o anúncio foi exibido.

Retorna
boolean

---

googletag.events.ImpressionViewableEvent

Estende Event

Esse evento é acionado quando uma impressão se torna visível, de acordo com os critérios do Active View.

Propriedades
serviceName	Nome do serviço que acionou o evento. Herdado da propriedade Event.serviceName
slot	O slot que acionou o evento. Herdado da propriedade Event.slot

Exemplo

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

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

Consulte também

• Listeners de eventos de anúncio

---

googletag.events.RewardedSlotClosedEvent

Estende Event

Esse evento é acionado quando um espaço do anúncio premiado é fechado pelo usuário. Ele pode ser acionado antes ou depois que uma recompensa é concedida. Para determinar se uma recompensa foi concedida, use events.RewardedSlotGrantedEvent.

Propriedades
serviceName	Nome do serviço que acionou o evento. Herdado da propriedade Event.serviceName
slot	O slot que acionou o evento. Herdado da propriedade Event.slot

Exemplo

JavaScript

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

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

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

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

JavaScript (legado)

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

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

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

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

TypeScript

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

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

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

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

Consulte também

• Listeners de eventos de anúncio
• Mostrar um anúncio premiado

---

googletag.events.RewardedSlotGrantedEvent

Estende Event

Esse evento é acionado quando um prêmio é concedido por visualizar um anúncio premiado. Se o anúncio for fechado antes que os critérios para conceder uma recompensa sejam atendidos, esse evento não será disparado.

Propriedades
payload	Um objeto que contém informações sobre a recompensa concedida.
serviceName	Nome do serviço que acionou o evento. Herdado da propriedade Event.serviceName
slot	O slot que acionou o evento. Herdado da propriedade Event.slot

Exemplo

JavaScript

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

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

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

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

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

JavaScript (legado)

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

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

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  googletag.pubads().addEventListener("rewardedSlotGranted", 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

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

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

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

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

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

Consulte também

• Listeners de eventos de anúncio
• Mostrar um anúncio premiado

Propriedades

---

payload

payload: RewardedPayload

Um objeto que contém informações sobre a recompensa concedida.

---

googletag.events.RewardedSlotReadyEvent

Estende Event

Esse evento é disparado quando um anúncio premiado está pronto para ser veiculado. O publisher é responsável por apresentar ao usuário uma opção para visualizar o anúncio antes de mostrá-lo.

Propriedades
serviceName	Nome do serviço que acionou o evento. Herdado da propriedade Event.serviceName
slot	O slot que acionou o evento. Herdado da propriedade Event.slot

Métodos
makeRewardedVisible	Mostra o anúncio premiado.

Exemplo

JavaScript

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

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

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  googletag.pubads().addEventListener("rewardedSlotReady", (event) => {
    const slot = event.slot;
    console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

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

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

JavaScript (legado)

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

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

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  googletag.pubads().addEventListener("rewardedSlotReady", 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.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

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

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  googletag.pubads().addEventListener("rewardedSlotReady", (event) => {
    const slot = event.slot;
    console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

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

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

Consulte também

• Listeners de eventos de anúncio
• Mostrar um anúncio premiado

Métodos

---

makeRewardedVisible

makeRewardedVisible(): boolean

Mostra o anúncio premiado. Esse método só deve ser chamado depois que o usuário consentir em ver o anúncio.

Retorna
boolean	Indica se o anúncio premiado foi exibido.

---

googletag.events.RewardedSlotVideoCompletedEvent

Estende Event

Esse evento é disparado quando um anúncio em vídeo premiado termina de ser reproduzido.

Propriedades
serviceName	Nome do serviço que acionou o evento. Herdado da propriedade Event.serviceName
slot	O slot que acionou o evento. Herdado da propriedade Event.slot

Exemplo

JavaScript

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

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

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

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

JavaScript (legado)

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

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

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

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

TypeScript

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

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

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

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

Consulte também

• Listeners de eventos de anúncio
• Mostrar um anúncio premiado

---

googletag.events.SlotOnloadEvent

Estende Event

Esse evento é acionado quando o iframe do criativo aciona o evento de carregamento. Ao renderizar anúncios rich media no modo de renderização síncrona, nenhum iframe é usado, então nenhum SlotOnloadEvent será disparado.

Propriedades
serviceName	Nome do serviço que acionou o evento. Herdado da propriedade Event.serviceName
slot	O slot que acionou o evento. Herdado da propriedade Event.slot

Exemplo

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

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

Consulte também

• Listeners de eventos de anúncio

---

googletag.events.SlotRenderEndedEvent

Estende Event

Esse evento é acionado quando o código do criativo é injetado em um espaço. Esse evento ocorre antes que os recursos do criativo sejam buscados, então ele pode ainda não estar visível. Se você precisar saber quando todos os recursos do criativo de um espaço terminaram de carregar, use events.SlotOnloadEvent.

Propriedades
advertiserId	ID do anunciante do anúncio renderizado.
campaignId	ID da campanha do anúncio renderizado.
companyIds	IDs das empresas que deram lances no anúncio de preenchimento renderizado.
creativeId	ID do criativo do anúncio de reserva renderizado.
creativeTemplateId	ID do modelo de criativo do anúncio de reserva renderizado.
isBackfill	Indica se um anúncio era de preenchimento.
isEmpty	Indica se um anúncio foi retornado para o espaço.
labelIds	Descontinuado.
lineItemId	ID do item de linha do anúncio de reserva renderizado.
responseIdentifier	O identificador de resposta é exclusivo para a resposta do anúncio.
serviceName	Nome do serviço que acionou o evento. Herdado da propriedade Event.serviceName
size	Indica o tamanho em pixels do criativo renderizado.
slot	O slot que acionou o evento. Herdado da propriedade Event.slot
slotContentChanged	Se o conteúdo do espaço foi alterado com o anúncio renderizado.
sourceAgnosticCreativeId	ID do criativo da reserva renderizada ou do anúncio de preenchimento.
sourceAgnosticLineItemId	ID do item de linha do anúncio de reserva ou preenchimento renderizado.
yieldGroupIds	IDs dos grupos de rendimento do anúncio de preenchimento renderizado.

Exemplo

JavaScript

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

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

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

JavaScript (legado)

// 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("Line Item ID:", event.lineItemId);
  console.log("Size:", event.size);
  console.log("Slot content changed?", event.slotContentChanged);
  console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId);
  console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId);
  console.log("Yield Group IDs:", event.yieldGroupIds);
  console.groupEnd();

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

TypeScript

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

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

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

Consulte também

• Listeners de eventos de anúncio

Propriedades

---

advertiserId

advertiserId: number

ID do anunciante do anúncio renderizado. O valor é null para espaços vazios, anúncios de preenchimento e criativos renderizados por serviços que não sejam o PubAdsService.

---

campaignId

campaignId: number

ID da campanha do anúncio renderizado. O valor é null para espaços vazios, anúncios de preenchimento e criativos renderizados por serviços que não sejam o PubAdsService.

---

companyIds

companyIds: number[]

IDs das empresas que deram lances no anúncio de preenchimento renderizado. O valor é null para espaços vazios, anúncios de reserva e criativos renderizados por serviços que não sejam o PubAdsService.

---

creativeId

creativeId: number

ID do criativo do anúncio de reserva renderizado. O valor é null para espaços vazios, anúncios de preenchimento e criativos renderizados por serviços que não sejam o PubAdsService.

---

creativeTemplateId

creativeTemplateId: number

ID do modelo de criativo do anúncio de reserva renderizado. O valor é null para espaços vazios, anúncios de preenchimento e criativos renderizados por serviços que não sejam o PubAdsService.

---

isBackfill

isBackfill: boolean

Indica se um anúncio era de preenchimento. O valor será true se o anúncio for de preenchimento, ou false caso contrário.

---

isEmpty

isEmpty: boolean

Indica se um anúncio foi retornado para o espaço. O valor será true se nenhum anúncio for retornado. Caso contrário, será false.

---

labelIds

labelIds: number[]

Descontinuado:este campo não é mais preenchido.

---

lineItemId

lineItemId: number

ID do item de linha do anúncio de reserva renderizado. O valor é null para espaços vazios, anúncios de preenchimento e criativos renderizados por serviços que não sejam o PubAdsService.

---

responseIdentifier

responseIdentifier: string

O identificador de resposta é exclusivo para a resposta do anúncio. Esse valor pode ser usado para identificar e bloquear o anúncio na Central de revisão de anúncios (ARC, na sigla em inglês).

---

tamanho

size: string | number[]

Indica o tamanho em pixels do criativo renderizado. Exemplo: [728, 90]. O valor é null para espaços do anúncio vazios.

---

slotContentChanged

slotContentChanged: boolean

Se o conteúdo do espaço foi alterado com o anúncio renderizado. O valor será true se o conteúdo tiver sido alterado, ou false caso contrário.

---

sourceAgnosticCreativeId

sourceAgnosticCreativeId: number

ID do criativo da reserva renderizada ou do anúncio de preenchimento. O valor será null se o anúncio não for uma reserva ou um preenchimento de item de linha, ou se o criativo for renderizado por serviços que não sejam o PubAdsService.

---

sourceAgnosticLineItemId

sourceAgnosticLineItemId: number

ID do item de linha do anúncio de reserva ou preenchimento renderizado. O valor será null se o anúncio não for uma reserva ou um preenchimento de item de linha, ou se o criativo for renderizado por serviços que não sejam o PubAdsService.

---

yieldGroupIds

yieldGroupIds: number[]

IDs dos grupos de rendimento do anúncio de preenchimento renderizado. O valor é null para espaços vazios, anúncios de reserva e criativos renderizados por serviços que não sejam o PubAdsService.

---

googletag.events.SlotRequestedEvent

Estende Event

Esse evento é acionado quando um anúncio é solicitado para um determinado espaço.

Propriedades
serviceName	Nome do serviço que acionou o evento. Herdado da propriedade Event.serviceName
slot	O slot que acionou o evento. Herdado da propriedade Event.slot

Exemplo

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

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

Consulte também

• Listeners de eventos de anúncio

---

googletag.events.SlotResponseReceived

Estende Event

Esse evento é acionado quando uma resposta de anúncio é recebida para um determinado espaço.

Propriedades
serviceName	Nome do serviço que acionou o evento. Herdado da propriedade Event.serviceName
slot	O slot que acionou o evento. Herdado da propriedade Event.slot

Exemplo

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

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

Consulte também

• Listeners de eventos de anúncio

---

googletag.events.SlotVisibilityChangedEvent

Estende Event

Esse evento é acionado sempre que a porcentagem na tela da área de um espaço do anúncio muda. O evento é limitado e não será disparado mais de uma vez a cada 200 ms.

Propriedades
inViewPercentage	A porcentagem da área do anúncio que está visível.
serviceName	Nome do serviço que acionou o evento. Herdado da propriedade Event.serviceName
slot	O slot que acionou o evento. Herdado da propriedade Event.slot

Exemplo

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

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

Consulte também

• Listeners de eventos de anúncio

Propriedades

---

inViewPercentage

inViewPercentage: number

A porcentagem da área do anúncio que está visível. O valor é um número entre 0 e 100.

---

googletag.secureSignals

Esse é o namespace que a GPT usa para gerenciar indicadores seguros.

Interfaces
BidderSignalProvider	Retorna um indicador seguro para um bidder específico.
PublisherSignalProvider	Retorna um indicador seguro para um editor específico.
SecureSignalProvidersArray	Uma interface para gerenciar indicadores seguros.

Aliases de tipo
SecureSignalProvider	Interface para retornar um indicador seguro para um bidder ou provedor específico.

Aliases de tipo

---

SecureSignalProvider

SecureSignalProvider: BidderSignalProvider | PublisherSignalProvider

Interface para retornar um indicador seguro para um bidder ou provedor específico. É necessário fornecer id ou networkCode, mas não ambos.

---

googletag.secureSignals.BidderSignalProvider

Retorna um indicador seguro para um bidder específico.

Um provedor de indicadores seguros de bidder consiste em duas partes:

1. Uma função de coletor, que retorna um Promise que se resolve em um indicador seguro.
2. Um id que identifica o bidder associado ao indicador.

Para retornar um indicador seguro para um publisher, use secureSignals.PublisherSignalProvider.

Propriedades
collectorFunction	Uma função que retorna um Promise que se resolve em um indicador seguro.
id	Um identificador exclusivo do coletor associado a esse indicador seguro, conforme registrado no Google Ad Manager.

Exemplo

JavaScript

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

JavaScript (legado)

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

Consulte também

• Compartilhar indicadores seguros com os bidders

Propriedades

---

collectorFunction

collectorFunction: (() => Promise<string>)

Uma função que retorna um Promise que se resolve em um indicador seguro.

---

id

id: string

Um identificador exclusivo do coletor associado a esse indicador seguro, conforme registrado no Google Ad Manager.

---

googletag.secureSignals.PublisherSignalProvider

Retorna um indicador seguro para um publisher específico.

Um provedor de indicadores do publisher consiste em duas partes:

1. Uma função de coletor, que retorna um Promise que se resolve em um indicador seguro.
2. Um networkCode que identifica o publisher associado ao indicador.

Para retornar um indicador seguro para um bidder, use secureSignals.BidderSignalProvider.

Propriedades
collectorFunction	Uma função que retorna um Promise que se resolve em um indicador seguro.
networkCode	O código de rede (conforme mostrado no caminho do bloco de anúncios) do publisher associado a esse indicador seguro.

Exemplo

JavaScript

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

JavaScript (legado)

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

Consulte também

• Compartilhar indicadores seguros com os bidders

Propriedades

---

collectorFunction

collectorFunction: (() => Promise<string>)

Uma função que retorna um Promise que se resolve em um indicador seguro.

---

networkCode

networkCode: string

O código de rede (conforme mostrado no caminho do bloco de anúncios) do publisher associado a esse indicador seguro.

---

googletag.secureSignals.SecureSignalProvidersArray

Uma interface para gerenciar indicadores seguros.

Métodos
clearAllCache	Limpa todos os indicadores de todos os coletores do cache.
push	Adiciona um novo secureSignals.SecureSignalProvider à matriz de provedores de indicadores e inicia o processo de geração de indicadores.

Métodos

---

clearAllCache

clearAllCache(): void

Limpa todos os indicadores de todos os coletores do cache.

A chamada desse método pode reduzir a probabilidade de os indicadores serem incluídos em solicitações de anúncios para as visualizações de página atuais e possivelmente futuras. Por isso, ele só deve ser chamado quando ocorrerem mudanças significativas no estado, como eventos que indicam um novo usuário (fazer login, sair da conta, se inscrever etc.).

---

push

push(provider: SecureSignalProvider): void

Adiciona um novo secureSignals.SecureSignalProvider à matriz de provedores de indicadores e inicia o processo de geração de indicadores.

Parâmetros
provider: SecureSignalProvider	O objeto secureSignals.SecureSignalProvider a ser adicionado à matriz.