Referência da GPT

Esta referência usa a notação TypeScript para descrever tipos. A tabela a seguir oferece 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 tipos e expressões de tipo compatíveis, consulte o Manual do TypeScript .

Anotações de tipo

Dois-pontos após uma variável, um nome de parâmetro, um nome de propriedade ou uma 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 encontrar 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 de restrição aceitam um número ilimitado de valores do tipo especificado.

googletag

O namespace global que a tag do Google Publisher usa para a API.
Namespaces
config
Interface principal de configuração para configurações no nível da página.
enums
Esse é o namespace que o GPT usa para tipos de enumeração.
events
Esse é o namespace que o 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 configurações de privacidade.
PubAdsService
Serviço de anúncios do publisher.
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 a todos os serviços.
SizeMappingBuilder
Builder para objetos de especificação de mapeamento de tamanho.
Slot
Um slot é um objeto que representa um único espaço de anúncio em uma página.
Aliases de tipo
GeneralSize
Uma configuração de tamanho válida para um slot, que pode ser um ou vários tamanhos.
MultiSize
Uma lista de tamanhos únicos válidos.
NamedSize
Tamanhos nomeados que um slot pode ter.
SingleSize
Um único tamanho válido para um slot.
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úncios.
SizeMappingArray
Uma lista de mapeamentos de tamanho.
Variáveis
apiReady
Flag que indica que a API GPT foi carregada e está pronta para ser chamada.
cmd
Referência à fila de comandos global para execução assíncrona de chamadas relacionadas ao GPT.
pubadsReady
Flag 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 especificado.
defineSlot
Cria um local do anúncio com um determinado caminho e tamanho do 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 slots especificados, removendo todos os objetos e referências relacionados desses slots da GPT.
disablePublisherConsole
Desativa o Console do Editor do Google.
display
Instrui os serviços de slot a renderizar o slot.
enableServices
Ativa todos os serviços da GPT definidos para espaços de anúncio na página.
getConfig
Recebe opções de configuração geral para o conjunto de páginas definido por setConfig.
getVersion
Retorna a versão atual do GPT.
openConsole
Abre o Console do Editor do Google.
pubads
Retorna uma referência ao PubAdsService.
setAdIframeTitle
Define o título de todos os iframes de contêiner de anúncios criados pelo PubAdsService a partir deste ponto.
setConfig
Define opções gerais de configuração para a página.
sizeMapping
Cria um novo SizeMappingBuilder.

Aliases de tipo

GeneralSize

GeneralSize: SingleSize | MultiSize
Uma configuração de tamanho válida para um slot, que pode ser um ou vários tamanhos.

MultiSize

MultiSize: SingleSize[]
Uma lista de tamanhos únicos válidos.

NamedSize

NamedSize: "fluid" | ["fluid"]
Tamanhos nomeados que um slot 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:
  • Fluido: o contêiner de anúncio ocupa 100% da largura da div principal e redimensiona a altura para ajustar o conteúdo do criativo. Semelhante ao comportamento dos elementos de bloco comuns em uma página. Usado para anúncios nativos. Consulte o artigo relacionado. As duas formas fluid e ['fluid'] são aceitáveis para declarar um tamanho de slot como flexível.

SingleSize

Um único tamanho válido para um slot.

SingleSizeArray

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

SizeMapping

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

SizeMappingArray

SizeMappingArray: SizeMapping[]
Uma lista de mapeamentos de tamanho.

Variáveis

Const apiReady

apiReady: boolean | undefined
Flag que indica que a API GPT foi carregada e está pronta para ser chamada. Essa propriedade será simplesmente undefined até que a API esteja pronta.

A maneira recomendada de processar assíncrono é usar googletag.cmd para enfileirar callbacks para quando a GPT estiver pronta. Esses callbacks não precisam verificar googletag.apiReady, já que a execução deles é garantida 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 como 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 procura na 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 da função transmitido a ele. Esse mecanismo permite que a GPT reduza a latência percebida buscando o JavaScript de forma assíncrona enquanto permite que o navegador continue 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
Flag 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 geradoras de indicadores e as invoca em ordem. Ela foi criada para substituir uma matriz padrão usada para enfileirar 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

Funções

companionAds

companionAds(): CompanionAdsService
Retorna uma referência ao CompanionAdsService.
Retorna
CompanionAdsServiceO 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.

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
Parâmetros
adUnitPath: stringCaminho completo do bloco de anúncios com o código de rede e o código do bloco de anúncios.
Optional div: string | OutOfPageFormatID da div que vai conter esse bloco de anúncios ou OutOfPageFormat.
Retorna
Slot | nullO 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 do 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
Parâmetros
adUnitPath: stringO caminho completo do bloco de anúncios com o código de rede e o código da unidade.
size: GeneralSizeLargura e altura do slot 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 do que o menor tamanho fornecido no mapeamento.
Optional div: stringID da div que vai conter este bloco de anúncios.
Retorna
Slot | nullO slot recém-criado ou null se não for possível criar um slot.

destroySlots

destroySlots(slots?: Slot[]): boolean
Destrói os slots especificados, removendo todos os objetos e referências relacionados desses slots da GPT. Essa API não é compatível com slots de retorno e complementares.

Chamar essa API em um slot limpa o anúncio e remove o objeto do slot 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 slot se uma referência a ele for mantida pela página do editor. Ao chamar essa API, a div associada a esse slot fica disponível para reutilização.

Em particular, destruir um slot 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 bloqueios ou exclusões competitivas envolvendo esse anúncio. Se essa função não for chamada antes de remover uma div de slot 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 slots a serem destruídos. A matriz é opcional. Se não for especificada, todos os slots serão destruídos.
Retorna
booleantrue se os slots tiverem sido destruídos, false caso contrário.

disablePublisherConsole

disablePublisherConsole(): void
Desativa o Console do Editor do Google.
Consulte também

display

display(divOrSlot: string | Element | Slot): void
Instrui os serviços de slot a renderizar o slot. Cada espaço de anúncio só pode ser exibido uma vez por página. Todos os slots precisam ser definidos e ter um serviço associado a eles antes de serem exibidos. A chamada de exibição não pode acontecer até que o elemento esteja presente no DOM. A maneira usual de fazer isso é colocar o código em um bloco de script dentro do elemento div nomeado na chamada do 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 é chamado serão buscados de uma só vez. Para forçar a não exibição de um slot de anúncio, toda a div precisa ser removida.
Consulte também
Parâmetros
divOrSlot: string | Element | SlotO ID do elemento div que contém o espaço do anúncio ou o elemento div, ou o objeto de slot. 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 definidos para espaços de anúncio na página.

getConfig

getConfig(keys: string | string[]): Pick<PageSettingsConfig, "adsenseAttributes" | "disableInitialLoad" | "targeting">
Recebe opções de configuração geral para o conjunto de páginas definido por setConfig.

Nem todas as propriedades setConfig() são compatíveis com esse método. As propriedades aceitas são:
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 a serem recebidas.
Retorna
Pick<PageSettingsConfig, "adsenseAttributes" | "disableInitialLoad" | "targeting">As opções de configuração do slot.

getVersion

getVersion(): string
Retorna a versão atual do GPT.
Consulte também
Retorna
stringA string da versão da GPT em execução no momento.

openConsole

openConsole(div?: string): void
Abre o Console do Editor 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
Parâmetros
Optional div: stringUm ID de div do espaço de anúncio. Este valor é opcional. Quando fornecido, o Console do Publisher tenta abrir com os detalhes do espaço de anúncio especificado em exibição.

pubads

pubads(): PubAdsService
Retorna uma referência ao PubAdsService.
Retorna
PubAdsServiceO serviço de anúncios 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: stringO novo título para todos os iframes de contêiner de anúncio.

setConfig

setConfig(config: PageSettingsConfig): void
Define opções gerais de configuração para a página.
Parâmetros
config: PageSettingsConfig

sizeMapping

sizeMapping(): SizeMappingBuilder

googletag.CommandArray

A matriz de comandos aceita uma sequência de funções e as invoca em ordem. Ele foi criado para substituir uma matriz padrão usada para enfileirar funções a serem 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 de tempo de execução sempre será globalThis. Considere transmitir uma arrow function para reter o valor this do contexto léxico envolvente.
Retorna
numberO número de comandos processados até o momento. Isso é compatível com o valor de retorno de Array.push (o comprimento atual da matriz).

googletag.CompanionAdsService

Extends 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.
getSlots
Receba a lista de slots associados a esse serviço.
removeEventListener
Remove um listener registrado anteriormente.
setRefreshUnfilledSlots
Define se os espaços complementares que não foram preenchidos serão preenchidos automaticamente.
Consulte também

Métodos

setRefreshUnfilledSlots

setRefreshUnfilledSlots(value: boolean): void
Define se os espaços complementares que não foram preenchidos 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 também 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: booleantrue para preencher automaticamente os slots não preenchidos, false para deixá-los inalterados.

googletag.PrivacySettingsConfig

Objeto de configuração para 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 conformidade regulatória 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 publisher.
restrictDataProcessing?
Permite que a veiculação seja executada no modo de processamento restrito para ajudar nas necessidades de compliance regulatório do publisher.
trafficSource?
Indica se as solicitações representam tráfego comprado ou orgânico.
underAgeOfConsent?
Indica se as solicitações de anúncios devem ser marcadas como provenientes de usuários abaixo da idade de consentimento.
Consulte também

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
Permite que a veiculação seja executada no modo de anúncios limitados para ajudar nas necessidades de conformidade regulatória do publisher.

Você pode instruir a GPT a solicitar anúncios limitados de duas maneiras:
  • Automaticamente, usando um indicador de uma plataforma de gestão de consentimento IAB TCF v2.0.
  • Manualmente, definindo o valor desse campo como true.
A configuração manual de anúncios limitados só é possível quando a GPT é carregada no URL de anúncios limitados. Tentar modificar essa configuração quando a GPT é carregada no URL padrão gera um aviso do Console do Editor.

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

Optional nonPersonalizedAds

nonPersonalizedAds?: boolean
Permite que a veiculação seja executada no modo de anúncios não personalizados para ajudar nas necessidades de compliance regulatório do publisher.

Optional restrictDataProcessing

restrictDataProcessing?: boolean
Permite que a veiculação seja executada no modo de processamento restrito para ajudar nas necessidades de compliance regulatório do publisher.

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 vai usar 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úncios devem ser marcadas como provenientes de usuários abaixo da idade de consentimento. Defina como null para limpar a configuração.

googletag.PubAdsService

Extends Service
Serviço de anúncios do publisher. 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.
clear
Remove os anúncios dos slots especificados e os substitui por conteúdo em branco.
clearCategoryExclusions
Obsoleto. Limpa todos os rótulos de exclusão de categoria de anúncio no nível da página.
clearTargeting
Obsoleto. Limpa os parâmetros de segmentação personalizada para uma chave específica ou para todas as chaves.
collapseEmptyDivs
Obsoleto. Permite o fechamento de divs de slot para que elas não ocupem espaço na página quando não houver conteúdo do anúncio para ser exibido.
disableInitialLoad
Obsoleto. 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 mostra um local do anúncio com o caminho e o tamanho do bloco de anúncios especificados.
enableLazyLoad
Obsoleto. Ativa o carregamento lento na GPT conforme definido pelo objeto de configuração.
enableSingleRequest
Obsoleto. Ativa o modo de solicitação única para buscar vários anúncios ao mesmo tempo.
enableVideoAds
Obsoleto. Informa à GPT que anúncios em vídeo vão estar presentes na página.
get
Obsoleto. Retorna o valor do atributo do AdSense associado à chave especificada.
getAttributeKeys
Obsoleto. Retorna as chaves de atributo definidas neste serviço.
getSlots
Receba a lista de slots associados a esse serviço.
getTargeting
Obsoleto. Retorna um parâmetro de segmentação de serviço personalizado específico que foi definido.
getTargetingKeys
Obsoleto. Retorna a lista de todas as chaves de segmentação no nível do serviço personalizadas que foram definidas.
isInitialLoadDisabled
Obsoleto. Retorna se as solicitações iniciais de anúncios foram desativadas com sucesso por uma chamada anterior de PubAdsService.disableInitialLoad.
refresh
Busca e mostra novos anúncios para espaços específicos ou todos os espaços na página.
removeEventListener
Remove um listener registrado anteriormente.
set
Obsoleto. Define valores para atributos do Google AdSense que se aplicam a todas as posições de anúncio no serviço Anúncios do publisher.
setCategoryExclusion
Obsoleto. Define uma exclusão de categoria de anúncio no nível da página para o nome de rótulo especificado.
setCentering
Obsoleto. Ativa e desativa o alinhamento horizontal dos anúncios.
setForceSafeFrame
Obsoleto. Configura se todos os anúncios na página precisam ser renderizados usando um contêiner do SafeFrame.
setLocation
Obsoleto. Transmite informações de localização de sites para que você possa segmentar itens de linha por geolocalização para locais específicos.
setPrivacySettings
Permite a configuração de todas as configurações de privacidade de uma única API usando um objeto de configuração.
setPublisherProvidedId
Define o valor do ID fornecido pelo editor.
setSafeFrameConfig
Obsoleto. Define as preferências no nível da página para a configuração do SafeFrame.
setTargeting
Obsoleto. 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 Publisher Ads.
setVideoContent
Obsoleto. Define as informações de conteúdo de 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 slots especificados e os substitui por conteúdo em branco. Os slots serão marcados como não buscados.

Em particular, limpar um slot 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 bloqueios ou exclusões competitivas envolvendo 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 slots a serem limpos. A matriz é opcional. Se não for especificada, todos os slots serão limpos.
Retorna
booleanRetorna true se os slots foram 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 slot.
Exemplo

JavaScript

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

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

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

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

JavaScript (legado)

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

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

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

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

TypeScript

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

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

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

// Make ad requests. Any ad can be returned.
Consulte também
Retorna
PubAdsServiceO objeto de serviço em que o método foi chamado.

clearTargeting

clearTargeting(key?: string): PubAdsService
Limpa os parâmetros de segmentação personalizada para uma chave específica ou para todas as chaves.
Exemplo

JavaScript

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

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

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

JavaScript (legado)

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

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

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

TypeScript

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

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

googletag.pubads().clearTargeting();
// All targeting has been cleared.
Consulte também
Parâmetros
Optional key: stringChave do parâmetro de segmentação. A chave é opcional. Todos os parâmetros de segmentação serão limpos se não forem especificados.
Retorna
PubAdsServiceO objeto de serviço em que o método foi chamado.

collapseEmptyDivs

collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean
Permite o fechamento de divs de slot para que elas não ocupem espaço na página quando não houver conteúdo do anúncio para exibir. Esse modo precisa ser definido antes da ativação do serviço.
Consulte também
Parâmetros
Optional collapseBeforeAdFetch: booleanSe os slots devem ser fechados 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
booleanRetorna true se o modo de recolhimento de divs 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 da 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.
Consulte também

display

display(adUnitPath: string, size: GeneralSize, div?: string | Element, clickUrl?: string): void
Cria e mostra um local do anúncio com o caminho e o tamanho do bloco de anúncios especificados. Esse método não funciona com o modo de solicitação única.

Observação:quando esse método é chamado, um snapshot do estado do slot e da página é criado para garantir a consistência ao enviar a solicitação de anúncio e renderizar a resposta. Qualquer mudança feita no slot ou no estado da página depois que esse método é chamado (incluindo segmentação, configurações de privacidade, SafeFrame forçado etc.) será aplicada apenas às solicitações subsequentes de display() ou refresh().
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
Parâmetros
adUnitPath: stringO caminho do bloco de anúncios do slot a ser renderizado.
size: GeneralSizeLargura e altura do slot.
Optional div: string | ElementO ID da div que contém o slot ou o próprio elemento div.
Optional clickUrl: stringO URL de clique a ser usado neste slot.

enableLazyLoad

enableLazyLoad(config?: {
  fetchMarginPercent?: number;
  mobileScaling?: number;
  renderMarginPercent?: number;
}): void
Ativa o carregamento lento no GPT, conforme definido pelo objeto de configuração. Para exemplos mais detalhados, consulte a amostra de carregamento lento.

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

JavaScript

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

JavaScript (legado)

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

TypeScript

googletag.pubads().enableLazyLoad({
  // Fetch slots within 5 viewports.
  fetchMarginPercent: 500,
  // Render slots within 2 viewports.
  renderMarginPercent: 200,
  // Double the above values on mobile.
  mobileScaling: 2.0,
});
Consulte também
Parâmetros
Optional config: {
  fetchMarginPercent?: number;
  mobileScaling?: number;
  renderMarginPercent?: number;
}		O objeto de configuração permite a personalização do comportamento de carregamento lento. As configurações omitidas vão usar um padrão definido pelo Google que será ajustado com o 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 slot precisa ter antes de renderizarmos um anúncio. Isso permite pré-buscar o anúncio, mas aguardar a renderização e o download de 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 variar as margens 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 slot pode ter antes de ser buscado e renderizado.

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úncio 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 da ativação do serviço.
Consulte também
Retorna
booleanRetorna true se o modo de solicitação única estiver 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 anúncios em vídeo estarão presentes na página. Isso ativa 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.

get

get(key: string): string
Retorna o valor do atributo do AdSense associado à chave especificada.
Exemplo

JavaScript

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

JavaScript (legado)

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

TypeScript

googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().get("adsense_background_color");
// Returns '#FFFFFF'.
Consulte também
Parâmetros
key: stringNome do atributo a ser procurado.
Retorna
stringValor atual da chave de atributo ou null se a chave não estiver presente.

getAttributeKeys

getAttributeKeys(): string[]
Retorna as chaves de atributo definidas neste serviço.
Exemplo

JavaScript

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

JavaScript (legado)

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

TypeScript

googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().set("adsense_border_color", "#AABBCC");
googletag.pubads().getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].
Retorna
string[]Matriz de chaves de atributo definidas neste serviço. A ordem não é definida.

getTargeting

getTargeting(key: string): string[]
Retorna um parâmetro de segmentação personalizada no nível do serviço específico que foi definido.
Exemplo

JavaScript

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

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

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

JavaScript (legado)

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

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

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

TypeScript

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

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

googletag.pubads().getTargeting("age");
// Returns [] (empty array).
Parâmetros
key: stringA chave de segmentação a 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 no nível do serviço que foram definidas.
Exemplo

JavaScript

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

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

JavaScript (legado)

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

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

TypeScript

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

googletag.pubads().getTargetingKeys();
// Returns ['interests', 'colors'].
Retorna
string[]Matriz de chaves de segmentação. A ordem não é definida.

isInitialLoadDisabled

isInitialLoadDisabled(): boolean
Retorna se as solicitações iniciais de anúncios foram desativadas com sucesso por uma chamada anterior de PubAdsService.disableInitialLoad.
Retorna
booleanRetorna true se uma chamada anterior para PubAdsService.disableInitialLoad foi bem-sucedida. Caso contrário, retorna false.

refresh

refresh(slots?: Slot[], options?: {
  changeCorrelator: boolean;
}): void
Busca e mostra 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 um comportamento adequado em todos os navegadores, a chamada de refresh precisa ser precedida por uma chamada de display no slot de anúncio. Se a chamada para display for omitida, a atualização poderá ter um comportamento inesperado. Se quiser, use o método PubAdsService.disableInitialLoad para impedir que display busque um anúncio.

A atualização de um slot 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 bloqueios ou exclusões competitivas envolvendo 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
Parâmetros
Optional slots: Slot[]Os slots a serem atualizados. A matriz é opcional. Se não for especificada, todos os slots serão atualizados.
Optional options: {
  changeCorrelator: boolean;
}		Opções de configuração associadas a essa chamada de atualização.
  • changeCorrelator

    Especifica se um novo correlator deve ser gerado para buscar anúncios. Nossos servidores de anúncios mantêm esse valor de correlação por um breve período (atualmente, 30 segundos, mas sujeito a mudanças). Assim, as solicitações com o mesmo correlator recebidas em intervalos próximos são consideradas uma única visualização de página. Por padrão, um novo correlator é gerado a 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 expiração.

set

set(key: string, value: string): PubAdsService
Define valores para atributos do Google AdSense que se aplicam a todos os espaços de anúncio no serviço Anúncios do editor.

Chamar essa função 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.
Exemplo

JavaScript

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

JavaScript (legado)

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

TypeScript

googletag.pubads().set("adsense_background_color", "#FFFFFF");
Consulte também
Parâmetros
key: stringO nome do atributo.
value: stringValor do atributo.
Retorna
PubAdsServiceO 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 de rótulo especificado.
Exemplo

JavaScript

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

JavaScript (legado)

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

TypeScript

// Label = AirlineAd.
googletag.pubads().setCategoryExclusion("AirlineAd");
Consulte também
Parâmetros
categoryExclusion: stringO rótulo de exclusão de categoria de anúncio a ser adicionado.
Retorna
PubAdsServiceO objeto de serviço em que o método foi chamado.

setCentering

setCentering(centerAds: boolean): void
Ativa e desativa o alinhamento horizontal dos anúncios. O alinhamento ao centro fica desativado por padrão. No gpt_mobile.js legado, o centralização é ativada por padrão.

Esse método precisa ser invocado antes de chamar display ou refresh, porque apenas os anúncios solicitados depois de chamar esse método serão centralizados.
Exemplo

JavaScript

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

JavaScript (legado)

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

TypeScript

// Make ads centered.
googletag.pubads().setCentering(true);
Parâmetros
centerAds: booleantrue 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.

Ao usar essa API, tenha em mente o seguinte:
  • Essa configuração só vai entrar em vigor para solicitações de anúncio subsequentes feitas para os respectivos slots.
  • A configuração no nível do slot, 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, independente 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, já que pode afetar o comportamento de criativos que tentam sair dos iframes ou dependem da renderização direta em uma página de editores.
Exemplo

JavaScript

googletag.pubads().setForceSafeFrame(true);

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

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

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

JavaScript (legado)

googletag.pubads().setForceSafeFrame(true);

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

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

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

TypeScript

googletag.pubads().setForceSafeFrame(true);

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

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

googletag.display("div-1");
googletag.display("div-2");
Consulte também
Parâmetros
forceSafeFrame: booleantrue para forçar a renderização de todos os anúncios na 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
PubAdsServiceO 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 geolocalmente itens de linha para locais específicos.
Exemplo

JavaScript

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

JavaScript (legado)

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

TypeScript

// Postal code:
googletag.pubads().setLocation("10001,US");
Parâmetros
address: stringEndereço com formato livre.
Retorna
PubAdsServiceO objeto de serviço em que o método foi chamado.

setPrivacySettings

setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService
Permite a configuração de todas as configurações de privacidade de 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
Parâmetros
privacySettings: PrivacySettingsConfigObjeto que contém a configuração de privacidade.
Retorna
PubAdsServiceO 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
Parâmetros
ppid: stringUm ID alfanumérico fornecido pelo publisher. Precisa ter entre 32 e 150 caracteres.
Retorna
PubAdsServiceO 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 por preferências no nível do slot, se especificadas.
Exemplo

JavaScript

googletag.pubads().setForceSafeFrame(true);

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

const slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

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

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

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

JavaScript (legado)

googletag.pubads().setForceSafeFrame(true);

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

var slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

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

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

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

TypeScript

googletag.pubads().setForceSafeFrame(true);

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

const slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

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

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

googletag.display("div-1");
googletag.display("div-2");
Consulte também
Parâmetros
config: SafeFrameConfigO objeto de configuração.
Retorna
PubAdsServiceO 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 Publisher Ads. Chamar essa função várias vezes para a mesma chave vai substituir os valores antigos. Essas chaves são definidas na sua conta do Google Ad Manager.
Exemplo

JavaScript

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

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

JavaScript (legado)

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

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

TypeScript

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

// Example with multiple values for a key inside in an array.
googletag.pubads().setTargeting("interests", ["sports", "music"]);
Consulte também
Parâmetros
key: stringChave do parâmetro de segmentação.
value: string | string[]Valor ou matriz de valores do parâmetro de segmentação.
Retorna
PubAdsServiceO objeto de serviço em que o método foi chamado.

setVideoContent

setVideoContent(videoContentId: string, videoCmsId: string): void
Define as informações de conteúdo de vídeo a serem 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.
Consulte também
Parâmetros
videoContentId: stringO ID do conteúdo de vídeo.
videoCmsId: stringO 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 é o mesmo para todas as solicitações de anúncios de uma visualização de página e exclusivo em visualizações de página. Só se aplica 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 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
PubAdsServiceO objeto de serviço em que a função foi chamada.

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

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

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 a 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
Receba a lista de slots associados a esse 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 aceitos: Um objeto do tipo de evento adequado é 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
Parâmetros
eventType: KUma 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
ServiceO objeto de serviço em que o método foi chamado.

getSlots

getSlots(): Slot[]
Receba a lista de slots associados a esse 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: KUma 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 slot.
build
Cria uma especificação de mapa de tamanho com base nos mapeamentos adicionados a este builder.
Consulte também

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

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

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

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

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

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

TypeScript

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

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

// Mapping 2 will not show any ads for the following viewport sizes:
// [1024, 768] > size >= [980, 690] and
// [640, 480] > size >= [0, 0]
Parâmetros
viewportSize: SingleSizeArrayO tamanho da janela de visualização para esta entrada de mapeamento.
slotSize: GeneralSizeOs tamanhos do slot para esta entrada de mapeamento.
Retorna
SizeMappingBuilderUma 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 mapeamentos inválidos forem fornecidos, esse método vai retornar null. Caso contrário, ele vai retornar uma especificação no formato correto para transmitir a Slot.defineSizeMapping.

Observação: o comportamento do builder após chamar esse método não é definido.
Retorna
SizeMappingArrayO resultado criado por este builder. Pode ser nulo se mapeamentos de tamanho inválidos forem fornecidos.

googletag.Slot

Um slot é um objeto que representa um único espaço de anúncio em uma página.
Métodos
addService
Adiciona um Service a este slot.
clearCategoryExclusions
Obsoleto. Remove todos os rótulos de exclusão de categoria de anúncio no nível do slot para esse slot.
clearTargeting
Obsoleto. Limpa parâmetros de segmentação personalizados específicos ou todos no nível do slot.
defineSizeMapping
Define uma matriz de mapeamentos de um tamanho mínimo da janela de visualização para o tamanho do slot.
get
Obsoleto. Retorna o valor do atributo do AdSense associado à chave especificada para este slot.
getAdUnitPath
Retorna o caminho completo do bloco de anúncios, com o código de rede e o caminho do bloco.
getAttributeKeys
Obsoleto. Retorna a lista de chaves de atributo definidas neste slot.
getCategoryExclusions
Obsoleto. Retorna os rótulos de exclusão de categoria de anúncio para este slot.
getConfig
Recebe opções de configuração gerais para o slot 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
Obsoleto. Retorna um conjunto de parâmetros de segmentação personalizada específico definido neste slot.
getTargetingKeys
Obsoleto. Retorna a lista de todas as chaves de segmentação personalizada definidas neste slot.
set
Obsoleto. Define um valor para um atributo do Google AdSense neste espaço do anúncio.
setCategoryExclusion
Obsoleto. Define um rótulo de exclusão de categoria de anúncio no nível do espaço.
setClickUrl
Obsoleto. Define o URL de clique para onde os usuários serão redirecionados depois de clicar no anúncio.
setCollapseEmptyDiv
Obsoleto. Define se o slot div deve ser ocultado quando não houver um anúncio nele.
setConfig
Define opções gerais de configuração para este slot.
setForceSafeFrame
Obsoleto. Configura se os anúncios neste espaço precisam ser renderizados usando um contêiner SafeFrame.
setSafeFrameConfig
Obsoleto. Define as preferências no nível do slot para a configuração do SafeFrame.
setTargeting
Obsoleto. Define um parâmetro de segmentação personalizada para este slot.
updateTargetingFromMap
Obsoleto. Define parâmetros de segmentação personalizada para este slot, usando um mapa de chave:valor em um objeto JSON.

Métodos

addService

addService(service: Service): Slot
Adiciona um Service a este espaço.
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
Parâmetros
service: ServiceO serviço a ser adicionado.
Retorna
SlotO objeto de slot 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 para esse espaço.
Exemplo

JavaScript

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

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

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

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

JavaScript (legado)

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

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

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

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

TypeScript

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

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

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

// Make an ad request. Any ad can be returned for the slot.
Retorna
SlotO objeto de slot em que o método foi chamado.

clearTargeting

clearTargeting(key?: string): Slot
Limpa parâmetros de segmentação personalizados específicos ou todos no nível do espaço do anúncio.
Exemplo

JavaScript

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

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

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

JavaScript (legado)

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

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

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

TypeScript

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

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

slot.clearTargeting();
// All targeting has been cleared.
Consulte também
Parâmetros
Optional key: stringChave do parâmetro de segmentação. A chave é opcional. Todos os parâmetros de segmentação serão limpos se não forem especificados.
Retorna
SlotO objeto de slot 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 slot.
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
Parâmetros
sizeMapping: SizeMappingArrayMatriz de mapeamentos de tamanho. Use SizeMappingBuilder para criar um. Cada mapeamento de tamanho é uma matriz de dois elementos: SingleSizeArray e GeneralSize.
Retorna
SlotO objeto de slot em que o método foi chamado.

get

get(key: string): string
Retorna o valor do atributo do AdSense associado à chave especificada para este slot. Para conferir os atributos no nível do serviço herdados por esse slot, use PubAdsService.get.
Exemplo

JavaScript

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

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

JavaScript (legado)

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

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

TypeScript

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

slot.get("adsense_background_color");
// Returns '#FFFFFF'.
Consulte também
Parâmetros
key: stringNome do atributo a ser procurado.
Retorna
stringValor 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.
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
stringCaminho do bloco de anúncios.

getAttributeKeys

getAttributeKeys(): string[]
Retorna a lista de chaves de atributo definidas neste slot. Para conferir as chaves dos atributos no nível do serviço herdados por este slot, use PubAdsService.getAttributeKeys.
Exemplo

JavaScript

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

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

JavaScript (legado)

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

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

TypeScript

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

slot.getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].
Retorna
string[]Matriz de chaves de atributo. A ordem não é definida.

getCategoryExclusions

getCategoryExclusions(): string[]
Retorna os rótulos de exclusão de categoria de anúncio para este slot.
Exemplo

JavaScript

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

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

JavaScript (legado)

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

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

TypeScript

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

slot.getCategoryExclusions();
// Returns ['AirlineAd', 'TrainAd'].
Retorna
string[]Os rótulos de exclusão de categoria de anúncio para este slot ou uma matriz vazia se nenhum tiver sido definido.

getConfig

getConfig(keys: string | string[]): Pick<SlotSettingsConfig, "adsenseAttributes" | "targeting" | "categoryExclusion">
Recebe opções de configuração geral para o slot definido por setConfig.

Nem todas as propriedades setConfig() são compatíveis com esse método. As propriedades aceitas são:
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 a serem recebidas.
Retorna
Pick<SlotSettingsConfig, "adsenseAttributes" | "targeting" | "categoryExclusion">As 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 de anúncio para o espaço. Se isso for chamado quando o slot não tiver um anúncio, null será retornado.
Retorna
ResponseInformationAs informações mais recentes de 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 ele 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
stringID do slot div.

getTargeting

getTargeting(key: string): string[]
Retorna um conjunto de parâmetros de segmentação personalizada específico definido neste slot. Os parâmetros de segmentação no nível do serviço não estão incluídos.
Exemplo

JavaScript

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

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

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

JavaScript (legado)

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

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

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

TypeScript

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

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

slot.getTargeting("age");
// Returns [] (empty array).
Parâmetros
key: stringA chave de segmentação a 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 neste slot. As chaves de segmentação no nível do serviço não estão incluídas.
Exemplo

JavaScript

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

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

JavaScript (legado)

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

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

TypeScript

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

slot.getTargetingKeys();
// Returns ['interests', 'allow_expandable'].
Retorna
string[]Matriz de chaves de segmentação. A ordem não é definida.

set

set(key: string, value: string): Slot
Define um valor para um atributo do Google AdSense neste 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.
Exemplo

JavaScript

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

JavaScript (legado)

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

TypeScript

// Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .set("adsense_background_color", "#FFFFFF")
  .addService(googletag.pubads());
Consulte também
Parâmetros
key: stringO nome do atributo.
value: stringValor do atributo.
Retorna
SlotO objeto de slot 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.
Exemplo

JavaScript

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

JavaScript (legado)

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

TypeScript

// Label = AirlineAd
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setCategoryExclusion("AirlineAd")
  .addService(googletag.pubads());
Consulte também
Parâmetros
categoryExclusion: stringO rótulo de exclusão de categoria de anúncio a ser adicionado.
Retorna
SlotO objeto de slot em que o método foi chamado.

setClickUrl

setClickUrl(value: string): Slot
Define o URL de clique para o qual 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 da página de destino associado ao criativo veiculado é anexado ao valor fornecido. As chamadas subsequentes substituem o valor. Isso funciona apenas para solicitações não SRA.
Exemplo

JavaScript

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

JavaScript (legado)

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

TypeScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setClickUrl("http://www.example.com?original_click_url=")
  .addService(googletag.pubads());
Parâmetros
value: stringO URL de clique a ser definido.
Retorna
SlotO objeto de slot em que o método foi chamado.

setCollapseEmptyDiv

setCollapseEmptyDiv(collapse: boolean, collapseBeforeAdFetch?: boolean): Slot
Define se o slot div deve ser ocultado quando não houver um anúncio nele. Isso substitui as configurações no nível do serviço.
Exemplo

JavaScript

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

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

JavaScript (legado)

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

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

TypeScript

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

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")!
  .setCollapseEmptyDiv(true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// only after GPT detects that no ads are available for the slot.
Consulte também
Parâmetros
collapse: booleanIndica se o espaço deve ser recolhido se nenhum anúncio for retornado.
Optional collapseBeforeAdFetch: booleanSe o espaço deve ser fechado mesmo antes de um anúncio ser buscado. Ignorado se o recolhimento não for true.
Retorna
SlotO objeto de slot em que o método foi chamado.

setConfig

setConfig(slotConfig: SlotSettingsConfig): void
Define opções gerais de configuração para este slot.
Parâmetros
slotConfig: SlotSettingsConfigO objeto de configuração.

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): Slot
Configura se os anúncios neste espaço precisam ser renderizados usando um contêiner SafeFrame.

Ao usar essa API, lembre-se do seguinte:
  • Essa configuração só vai entrar em vigor para solicitações de anúncio subsequentes feitas para os respectivos slots.
  • A configuração no nível do slot, 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, independente 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, já que pode afetar o comportamento de criativos que tentam sair dos iframes ou dependem da renderização direta em uma página de editores.
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
Parâmetros
forceSafeFrame: booleantrue para forçar a renderização de todos os anúncios neste slot 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
SlotO objeto de slot em que o método foi chamado.

setSafeFrameConfig

setSafeFrameConfig(config: SafeFrameConfig): Slot
Define as preferências no nível do slot 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 do slot, se especificadas, vão substituir as preferências no nível da página.
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
Parâmetros
config: SafeFrameConfigO objeto de configuração.
Retorna
SlotO objeto de slot em que o método foi chamado.

setTargeting

setTargeting(key: string, value: string | string[]): Slot
Define um parâmetro de segmentação personalizada para este slot. 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.
Exemplo

JavaScript

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

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

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

JavaScript (legado)

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

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

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

TypeScript

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

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

// Example with multiple values for a key inside in an array.
slot.setTargeting("interests", ["sports", "music"]);
Consulte também
Parâmetros
key: stringChave do parâmetro de segmentação.
value: string | string[]Valor ou matriz de valores do parâmetro de segmentação.
Retorna
SlotO objeto de slot em que o método foi chamado.

updateTargetingFromMap

updateTargetingFromMap(map: {
  [adUnitPath: string]: string | string[];
}): Slot
Define parâmetros de segmentação personalizada para este slot, de um mapa chave:valor em um objeto JSON. Isso é o mesmo que chamar Slot.setTargeting para todos os valores-chave 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.
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
SlotO objeto de slot em que o método foi chamado.

googletag.config

Interface principal de configuração para configuraçõ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 AdSense.
ComponentAuctionConfig
Um objeto que representa um único leilão de componente em um leilão de anúncios no dispositivo.
InterstitialConfig
Um objeto que define o comportamento de um único slot de anúncio intersticial.
LazyLoadConfig
Configurações para controlar o uso do carregamento lento na GPT.
PageSettingsConfig
Interface principal de configuração para configuraçõ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 principal de configuração para definições no nível do slot.
TaxonomyData
Um objeto que contém os valores de uma única taxonomia.
VideoAdsConfig
Configurações para configurar as opçõ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
Adicionamos suporte para acionadores de anúncios intersticiais.
PrivacyTreatment
Tratamentos de privacidade do publisher compatíveis.
Taxonomy
Taxonomias compatíveis com indicadores fornecidos pelo publisher (PPS).

Aliases de tipo

CollapseDivBehavior

CollapseDivBehavior: "DISABLED" | "BEFORE_FETCH" | "ON_NO_FILL"
Valores aceitos para controlar o comportamento de recolhimento dos espaços de anúncio.
Consulte também

InterstitialTrigger

InterstitialTrigger: "unhideWindow" | "navBar"
Adicionamos suporte para acionadores de anúncios intersticiais.

PrivacyTreatment

PrivacyTreatment: "disablePersonalization"
Tratamentos de privacidade do publisher compatíveis.

Taxonomia

Taxonomy: "IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"
Taxonomias compatíveis com indicadores fornecidos pelo publisher (PPS).
Consulte também

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

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 por solicitação.
Propriedades
adsense_ad_format?
Formato de anúncio do AdSense.
adsense_channel_ids?
IDs de canais do Google AdSense.
adsense_test_mode?
Indica se o modo de teste está ativado.
document_language?
Idioma da página em que os anúncios são exibidos.
page_url?
URL da página em que os anúncios são exibidos.
Consulte também

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 canais do AdSense.

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

Exemplo: 271828183+314159265
Consulte também

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 desmarcada para tráfego de produção e 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

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

Um objeto que representa um único leilão de componente em um leilão de anúncios no dispositivo.
Propriedades
auctionConfig
Um objeto de configuração de leilão para este leilão de componente.
configKey
A chave de configuração associada a este leilão de componente.
Consulte também

Propriedades

auctionConfig

auctionConfig: {
  auctionSignals?: unknown;
  decisionLogicURL: string;
  interestGroupBuyers?: string[];
  perBuyerExperimentGroupIds?: {
    [buyer: string]: number;
  };
  perBuyerGroupLimits?: {
    [buyer: string]: number;
  };
  perBuyerSignals?: {
    [buyer: string]: unknown;
  };
  perBuyerTimeouts?: {
    [buyer: string]: number;
  };
  seller: string;
  sellerExperimentGroupId?: number;
  sellerSignals?: unknown;
  sellerTimeout?: number;
  trustedScoringSignalsURL?: string;
}
Um objeto de configuração de leilão para este leilão de componente.

Se esse valor for definido como null, qualquer configuração atual para o configKey especificado será excluída.
Exemplo

JavaScript

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

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

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

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

JavaScript (legado)

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

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

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

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

TypeScript

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

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

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

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

configKey

configKey: string
A chave de configuração associada a este leilão de componente.

Esse valor não pode estar vazio e precisa ser exclusivo. Se dois objetos ComponentAuctionConfig compartilharem o mesmo valor de configKey, o último a ser definido vai substituir as configurações anteriores.

googletag.config.InterstitialConfig

Um objeto que define o comportamento de um único slot de anúncio intersticial.
Propriedades
requireStorageAccess?
Indica se o consentimento para armazenamento local é necessário para mostrar esse anúncio intersticial.
triggers?
A configuração de acionador intersticial para esse 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 para 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

Optional gatilhos

triggers?: Partial<Record<InterstitialTrigger, boolean>>
A configuração de acionamento do anúncio intersticial.

Definir o valor de um acionador intersticial como true o ativa, e false o desativa. 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

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

Propriedades

Optional fetchMarginPercent

fetchMarginPercent?: number
A distância mínima da janela de visualização atual que um slot 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 buscar um anúncio com antecedência, mas aguardar a renderização e o download de outros subrecursos. Portanto, esse valor precisa ser sempre maior ou igual a renderMarginPercent.

Um valor de 0 significa "quando o slot 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 slot pode ter da janela de visualização antes da busca e da renderização.

Optional renderMarginPercent

renderMarginPercent?: number
A distância mínima da janela de visualização atual que um slot precisa ter antes de renderizarmos um anúncio, expressa como uma porcentagem do tamanho da janela de visualização.

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

Um valor de 0 significa "quando o slot 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 configuraçõ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 recursos reais que usam setConfig. Para 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 limpas 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 atributos do Google AdSense.
adYield?
Descontinuado. 
categoryExclusion?
Configuração para configurar exclusões de categoria de anúncio.
centering?
Configuração para controlar a centralização horizontal dos anúncios.
collapseDiv?
Configuração para controlar o comportamento de recolhimento dos espaços de anúncios.
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 localizações geográficas.
pps?
Configurações para controlar os indicadores fornecidos pelo publisher (PPS).
privacyTreatments?
Configurações para controlar os tratamentos de privacidade do editor.
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 chaves-valor.
threadYield?
Configuração para controlar se o 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 atributos do AdSense.

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

As mudanças de atributos do 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"

Optional categoryExclusion

categoryExclusion?: string[]
Configuração para configurar exclusões de categoria de anúncio.
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

Optional centralização

centering?: boolean
Configuração para controlar a centralização horizontal dos anúncios. O alinhamento centralizado é desativado por padrão.

As mudanças de alinhamento horizontal só se aplicam a 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

// 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 de anúncio.

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

Valores aceitos:
  • null (padrão): o slot não será recolhido.
  • DISABLED: o espaço não será recolhido, com ou sem um anúncio retornado.
  • BEFORE_FETCH: o espaço começa recolhido e é aberto quando um anúncio é retornado.
  • ON_NO_FILL: o espaço começa expandido e é recolhido se nenhum anúncio for 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

Optional disableInitialLoad

disableInitialLoad?: boolean
Configuração para controlar quando os anúncios são solicitados.

Por padrão, o método googletag.display registra espaços de anúncios e solicita anúncios para eles. No entanto, às vezes é preferível 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 slots 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

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 a amostra de carregamento lento.

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

Todas 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 com o 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

Optional local

location?: string
Configuração para segmentar itens de linha por área geográfica em locais geográficos.
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

Optional pps

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 safeFrame

safeFrame?: SafeFrameConfig
Configurações para controlar o uso do SafeFrame na GPT.

Os valores configurados com essa definição serão aplicados a todos os espaços de anúncios na página. Os locais de 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

Optional segmentação

targeting?: Record<string, string | string[]>
Configuração para controlar a segmentação por chaves-valor.

A segmentação configurada com essa configuração será aplicada a todos os espaços de anúncios 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

Optional threadYield

threadYield?: "DISABLED" | "ENABLED_ALL_SLOTS"
Configuração para controlar se a GPT deve gerar a linha de execução JS ao solicitar e renderizar criativos.

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

Valores aceitos:
  • null (padrão): a GPT vai gerar a linha de execução JS para slots fora da janela de visualização.
  • ENABLED_ALL_SLOTS: a GPT vai gerar a linha de execução JS para todos os slots, independente de estarem ou não na janela de visualização.
  • DISABLED: a GPT não vai gerar a linha de execução 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

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

googletag.config.PrivacyTreatmentsConfig

Configurações para controlar os tratamentos de privacidade do editor.
Propriedades
treatments
Uma matriz de tratamentos de privacidade do publisher a serem 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

Propriedades

taxonomies

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 sobrepondo 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 devem 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?
Obsoleto. Se o SafeFrame deve usar subdomínios aleatórios para criativos de reserva.
Consulte também

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 devem 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, o Flash).

Optional useUniqueDomain

useUniqueDomain?: boolean
Indica se o SafeFrame deve usar subdomínios aleatórios para criativos de reserva. Transmita null para limpar o valor armazenado.

Observação: esse recurso está ativado por padrão.
Consulte também

googletag.config.SlotSettingsConfig

Interface de configuração principal para configurações no nível do slot.

Permite definir vários recursos com uma única chamada de API para um único slot.

Todas as propriedades listadas abaixo são exemplos e não refletem recursos reais que usam setConfig. Para 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 de 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 limpas 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 configurar a expansão de anúncios.
adsenseAttributes?
Configuração para definir atributos do Google AdSense.
categoryExclusion?
Configuração para configurar exclusões de categoria de anúncio.
clickUrl?
Configuração para definir o URL ao qual os usuários serão redirecionados após clicar no anúncio.
collapseDiv?
Configuração para definir o comportamento de recolhimento do slot de anúncio.
componentAuction?
Uma matriz de leilões de componentes a serem incluídos em um leilão de anúncios no dispositivo.
interstitial?
Configurações que configuram o comportamento do slot de anúncio intersticial.
safeFrame?
Configurações para configurar 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

Optional adsenseAttributes

adsenseAttributes?: AdSenseAttributesConfig
Configuração para definir atributos do AdSense.

Os atributos do AdSense definidos com essa configuração só se aplicam ao slot de anúncio. Essa configuração pode ser chamada várias vezes para definir vários valores de atributos ou substituir valores atuais.

As mudanças de atributos do 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 configurar exclusões de categoria de anúncio.
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

Optional clickUrl

clickUrl?: string
Configuração para definir o URL ao qual 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 da 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 recolhido não ocupa espaço na página.

Valores aceitos:
  • null (padrão): o slot não será recolhido.
  • DISABLED: o espaço não será recolhido, com ou sem um anúncio retornado.
  • BEFORE_FETCH: o espaço começa recolhido e é aberto quando um anúncio é retornado.
  • ON_NO_FILL: o espaço começa expandido e é recolhido se nenhum anúncio for 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

Optional componentAuction

componentAuction?: ComponentAuctionConfig[]
Uma matriz de leilões de componentes a serem incluídos em um leilão de anúncios no dispositivo.

Optional interstitial

interstitial?: InterstitialConfig
Configurações que definem o comportamento do slot de anúncio intersticial.
Consulte também

Optional safeFrame

safeFrame?: SafeFrameConfig
Configurações para configurar o uso do SafeFrame na GPT.

Os valores configurados com essa configuração só se aplicam ao slot de anúncio e substituem os valores definidos com 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 com essa definição só será aplicada ao local 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

googletag.config.TaxonomyData

Um objeto que contém os valores de uma única taxonomia.
Propriedades
values
Uma lista de valores de Taxonomia.

Propriedades

values

values: readonly string[]
Uma lista de valores de Taxonomia.

googletag.config.VideoAdsConfig

Configurações para configurar as opçõ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 ID do conteúdo de vídeo.
Consulte também

Propriedades

enableVideoAds

enableVideoAds: boolean
Indica se os anúncios em vídeo vão aparecer na página.

Quando definido como true, isso ativa restrições de exclusão de conteúdo em anúncios de display e em vídeo.

Se o conteúdo do 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 de vídeo.

É 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 de vídeo especificado por videoContentId.
Consulte também

Optional videoContentId

videoContentId?: string
O ID do conteúdo de vídeo.

É um valor exclusivo que identifica um vídeo específico da origem de conteúdo especificada por videoCmsId. Esse valor é atribuído pelo CMS que hospeda seu conteúdo em vídeo.
Consulte também

googletag.enums

Esse é o namespace que o GPT usa para tipos de enumeração.
Enumerações
OutOfPageFormat
Formatos fora da página 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
Membros da enumeração
AD_INTENTS
Formato de intenções de anúncio.
BOTTOM_ANCHOR
Formato de âncora em que o slot fica na parte de baixo da janela de visualização.
GAME_MANUAL_INTERSTITIAL
Formato de anúncio intersticial manual de jogo.

Observação:o anúncio intersticial manual de jogo é um formato de acesso limitado.
INTERSTITIAL
Formato do criativo intersticial da Web.
LEFT_SIDE_RAIL
Formato da coluna lateral esquerda.
REWARDED
Formato premiado.
RIGHT_SIDE_RAIL
Formato da coluna lateral direita.
TOP_ANCHOR
Formato fixo em que o slot fica na parte de cima da janela de visualização.

TrafficSource

TrafficSource
Origens de tráfego compatíveis com a GPT.
Consulte também
Membros da enumeração
ORGANIC
Entrada de URL direto, pesquisa no site ou download do app.
PURCHASED
O tráfego foi redirecionado de propriedades de terceiros (atividades adquiridas ou incentivadas de outra forma).

googletag.events

Esse é o namespace que o GPT usa para eventos. Seu código pode reagir a esses eventos usando Service.addEventListener.
Interfaces
Event
Interface base para todos os eventos do GPT.
EventTypeMap
É um pseudotipo que mapeia um nome de evento para o tipo de objeto de evento correspondente em Service.addEventListener e Service.removeEventListener.
GameManualInterstitialSlotClosedEvent
Esse evento é disparado quando um usuário fecha um slot intersticial manual do jogo.
GameManualInterstitialSlotReadyEvent
Esse evento é acionado quando um espaço de anúncio intersticial manual de jogo está pronto para ser mostrado ao usuário.
ImpressionViewableEvent
Esse evento é disparado quando uma impressão se torna visível, de acordo com os critérios do Active View.
RewardedSlotClosedEvent
Esse evento é disparado quando um usuário fecha um slot de anúncio premiado.
RewardedSlotGrantedEvent
Esse evento é disparado quando um prêmio é concedido por assistir um anúncio premiado.
RewardedSlotReadyEvent
Esse evento é disparado quando um anúncio premiado está pronto para ser exibido.
RewardedSlotVideoCompletedEvent
Esse evento é disparado quando um anúncio em vídeo premiado termina de ser reproduzido.
SlotOnloadEvent
Esse evento é disparado quando o iframe do criativo dispara o evento de carregamento.
SlotRenderEndedEvent
Esse evento é disparado quando o código do criativo é injetado em um slot.
SlotRequestedEvent
Esse evento é disparado quando um anúncio é solicitado para um determinado slot.
SlotResponseReceived
Esse evento é disparado quando uma resposta de anúncio é recebida para um determinado slot.
SlotVisibilityChangedEvent
Esse evento é disparado sempre que a porcentagem na tela da área de um slot de anúncio muda.

googletag.events.Event

Interface base para todos os eventos do GPT. Todos os eventos da GPT abaixo têm os seguintes campos.
Propriedades
serviceName
Nome do serviço que acionou o evento.
slot
O slot que acionou o evento.
Consulte também

Propriedades

serviceName

serviceName: string
Nome do serviço que acionou o evento.

slot

slot: Slot
O slot que acionou o evento.

googletag.events.EventTypeMap

É um pseudotipo que mapeia um nome de evento para o tipo de objeto de evento correspondente em Service.addEventListener e Service.removeEventListener. Ele é documentado apenas para fins de referência e segurança de tipo.
Propriedades
gameManualInterstitialSlotClosed
gameManualInterstitialSlotReady
impressionViewable
rewardedSlotClosed
rewardedSlotGranted
rewardedSlotReady
rewardedSlotVideoCompleted
slotOnload
slotRenderEnded
slotRequested
slotResponseReceived
slotVisibilityChanged

Propriedades

gameManualInterstitialSlotClosed

gameManualInterstitialSlotReady

impressionViewable

rewardedSlotClosed

rewardedSlotGranted

rewardedSlotReady

rewardedSlotVideoCompleted

slotOnload

slotRenderEnded

slotRequested

slotResponseReceived

slotResponseReceived: SlotResponseReceived
Alias para events.SlotResponseReceived.

slotVisibilityChanged

googletag.events.GameManualInterstitialSlotClosedEvent

Extends Event
Esse evento é disparado quando um slot de anúncio intersticial manual de jogo é fechado pelo usuário.

Observação:o anúncio intersticial manual de jogo é um formato de acesso limitado.
Propriedades
serviceName
Nome do serviço que acionou o evento.
slot
O slot que acionou o evento.
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

googletag.events.GameManualInterstitialSlotReadyEvent

Extends Event
Esse evento é disparado quando um espaço de anúncio 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.
slot
O slot que acionou o evento.
Métodos
makeGameManualInterstitialVisible
Mostra o anúncio intersticial manual de jogo para o 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

Métodos

makeGameManualInterstitialVisible

makeGameManualInterstitialVisible(): void
Mostra o anúncio intersticial manual de jogo para o usuário.

googletag.events.ImpressionViewableEvent

Extends Event
Esse evento é disparado 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.
slot
O slot que acionou o evento.
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

googletag.events.RewardedSlotClosedEvent

Extends Event
Esse evento é disparado quando um usuário fecha um slot de anúncio premiado. Ele pode ser disparado antes ou depois de uma recompensa ser concedida. Para determinar se uma recompensa foi concedida, use events.RewardedSlotGrantedEvent.
Propriedades
serviceName
Nome do serviço que acionou o evento.
slot
O slot que acionou o evento.
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

googletag.events.RewardedSlotGrantedEvent

Extends Event
Esse evento é disparado quando um prêmio é concedido por assistir 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.
slot
O slot que acionou o evento.
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

Propriedades

payload

Um objeto que contém informações sobre a recompensa concedida.

googletag.events.RewardedSlotReadyEvent

Extends Event
Esse evento é disparado quando um anúncio premiado está pronto para ser exibido. O publisher é responsável por apresentar ao usuário uma opção de ver o anúncio antes de mostrá-lo.
Propriedades
serviceName
Nome do serviço que acionou o evento.
slot
O slot que acionou o evento.
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

Métodos

makeRewardedVisible

makeRewardedVisible(): void
Mostra o anúncio premiado. Esse método não deve ser chamado até que o usuário concorde em ver o anúncio.

googletag.events.RewardedSlotVideoCompletedEvent

Extends 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.
slot
O slot que acionou o evento.
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

googletag.events.SlotOnloadEvent

Extends Event
Esse evento é disparado quando o iframe do criativo dispara o evento de carregamento. Ao renderizar anúncios rich media no modo de renderização síncrona, nenhum iframe é usado, portanto, nenhum SlotOnloadEvent é disparado.
Propriedades
serviceName
Nome do serviço que acionou o evento.
slot
O slot que acionou o evento.
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

googletag.events.SlotRenderEndedEvent

Extends Event
Esse evento é disparado quando o código do criativo é injetado em um slot. Esse evento vai ocorrer antes da busca dos recursos do criativo, então ele ainda não vai estar visível. Se você precisar saber quando todos os recursos de criativo de um slot terminaram de carregar, considere o 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 é um identificador exclusivo para a resposta do anúncio.
serviceName
Nome do serviço que acionou o evento.
size
Indica o tamanho em pixels do criativo renderizado.
slot
O slot que acionou o evento.
slotContentChanged
Se o conteúdo do slot 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

Propriedades

advertiserId

advertiserId: number
ID do anunciante do anúncio renderizado. O valor é null para slots vazios, anúncios de preenchimento e criativos renderizados por serviços diferentes de PubAdsService.

campaignId

campaignId: number
ID da campanha do anúncio renderizado. O valor é null para slots vazios, anúncios de preenchimento e criativos renderizados por serviços diferentes de PubAdsService.

companyIds

companyIds: number[]
IDs das empresas que deram lances no anúncio de preenchimento renderizado. O valor é null para slots vazios, anúncios de reserva e criativos renderizados por serviços diferentes de PubAdsService.

creativeId

creativeId: number
ID do criativo do anúncio de reserva renderizado. O valor é null para slots vazios, anúncios de preenchimento e criativos renderizados por serviços diferentes de PubAdsService.

creativeTemplateId

creativeTemplateId: number
ID do modelo de criativo do anúncio de reserva renderizado. O valor é null para slots vazios, anúncios de preenchimento e criativos renderizados por serviços diferentes de PubAdsService.

isBackfill

isBackfill: boolean
Indica se um anúncio era de preenchimento. O valor será true se o anúncio for de preenchimento e false caso contrário.

isEmpty

isEmpty: boolean
Indica se um anúncio foi retornado para o espaço. O valor é true se nenhum anúncio for retornado e false caso contrário.

labelIds

labelIds: number[]

lineItemId

lineItemId: number
ID do item de linha do anúncio de reserva renderizado. O valor é null para slots vazios, anúncios de preenchimento e criativos renderizados por serviços diferentes de PubAdsService.

responseIdentifier

responseIdentifier: string
O identificador de resposta é um identificador 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).

size

size: string | number[]
Indica o tamanho em pixels do criativo renderizado. Exemplo: [728, 90]. O valor é null para espaços de anúncio vazios.

slotContentChanged

slotContentChanged: boolean
Se o conteúdo do slot foi alterado com o anúncio renderizado. O valor será true se o conteúdo tiver sido alterado. Caso contrário, será false.

sourceAgnosticCreativeId

sourceAgnosticCreativeId: number
ID do criativo da reserva renderizada ou do anúncio de preenchimento. O valor é 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 diferentes de PubAdsService.

sourceAgnosticLineItemId

sourceAgnosticLineItemId: number
ID do item de linha do anúncio de reserva ou preenchimento renderizado. O valor é 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 diferentes de PubAdsService.

yieldGroupIds

yieldGroupIds: number[]
IDs dos grupos de rendimento do anúncio de preenchimento renderizado. O valor é null para slots vazios, anúncios de reserva e criativos renderizados por serviços diferentes de PubAdsService.

googletag.events.SlotRequestedEvent

Extends Event
Esse evento é disparado quando um anúncio é solicitado para um determinado slot.
Propriedades
serviceName
Nome do serviço que acionou o evento.
slot
O slot que acionou o evento.
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

googletag.events.SlotResponseReceived

Extends Event
Esse evento é disparado quando uma resposta de anúncio é recebida para um determinado slot.
Propriedades
serviceName
Nome do serviço que acionou o evento.
slot
O slot que acionou o evento.
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

googletag.events.SlotVisibilityChangedEvent

Extends Event
Esse evento é disparado sempre que a porcentagem na tela da área de um slot de 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.
slot
O slot que acionou o evento.
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

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

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 do bidder consiste em duas partes:

  1. Uma função de coleta que retorna um Promise que é resolvido em um indicador seguro.
  2. Um id que identifica o bidder associado ao indicador.
Para retornar um indicador seguro de um editor, use secureSignals.PublisherSignalProvider.
Propriedades
collectorFunction
Uma função que retorna uma Promise que é resolvida 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

Propriedades

collectorFunction

collectorFunction: (() => Promise<string>)
Uma função que retorna uma Promise que é resolvida 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 coleta que retorna um Promise que é resolvido 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 uma Promise que é resolvida em um indicador seguro.
networkCode
O código da rede (como visto no caminho do bloco de anúncios) do editor 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

Propriedades

collectorFunction

collectorFunction: (() => Promise<string>)
Uma função que retorna uma Promise que é resolvida em um indicador seguro.

networkCode

networkCode: string
O código da rede (como visto no caminho do bloco de anúncios) do editor 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 dos 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: SecureSignalProviderO objeto secureSignals.SecureSignalProvider a ser adicionado à matriz.