Referência da GPT

Esta referência usa a notação TypeScript para descrever tipos. Veja na tabela a seguir uma breve explicação com exemplos.

Expressão de tipo
string O tipo de string primitivo.
string[] Um tipo de matriz, em que os valores podem ser apenas 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, nome de parâmetro, nome de propriedade ou assinatura de função indicam uma anotação de tipo. As anotações de tipo descrevem os tipos que o elemento à esquerda dos dois pontos pode aceitar ou retornar. A tabela a seguir mostra exemplos de anotações de tipo que podem ser encontradas nesta referência.

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

Definições de tipo

Tipos
SingleSize | MultiSize

Uma configuração de tamanho válida para um slot, que pode ter um ou vários tamanhos.
SingleSize[]

Uma lista de tamanhos válidos únicos.
"fluid" | ["fluid"]

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

  • fluid: o contêiner de anúncios redimensiona 100% da largura do div pai e redimensiona a altura para se ajustar ao conteúdo do criativo. Semelhante ao comportamento dos elementos de bloco normais em uma página. Usado para anúncios nativos (consulte o artigo relacionado). Observe que fluid e ['fluid'] são formas aceitáveis para declarar um tamanho de slot como fluido.
SingleSizeArray | NamedSize

Um único tamanho válido para um espaço.
[number, number]

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

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

Uma lista de mapeamentos de tamanho.
"unhideWindow" | "navBar"

Acionadores de anúncios intersticiais compatíveis.
"disablePersonalization"

Tratamentos de privacidade do editor compatíveis.
"IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"
BidderSignalProvider | PublisherSignalProvider

Interface para retornar um indicador seguro para um bidder ou provedor específico. É preciso fornecer uma propriedade id ou networkCode, mas não ambas.

Tipos de enumeração

Tipos enumerados
googletag.enums.OutOfPageFormat
Formatos fora da página compatíveis com a GPT.
googletag.enums.TrafficSource
Origens de tráfego compatíveis com a GPT.

googletag.enums.OutOfPageFormat

  • Formatos fora da página compatíveis com a GPT.

  • Veja também
  • Valores
    BOTTOM_ANCHOR
    Formato de âncora, em que o slot fica na parte de baixo da janela de visualização.
    INTERSTITIAL
    É o 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 de âncora, em que o slot fica na parte de cima da janela de visualização.

googletag.enums.TrafficSource

  • Origens de tráfego compatíveis com a GPT.

  • Veja também
  • Valores
    ORGANIC
    Entrada direta de URL, pesquisa no site ou download do app.
    PURCHASED
    Tráfego redirecionado de propriedades que não são próprias (atividades adquiridas ou incentivadas de outra forma).

googletag

O namespace global que a Tag do editor do Google usa na API.

Resumo da variável
apiReady
Sinalização que indica que a API da GPT está carregada e pronta para ser chamada.
cmd
Referência à fila de comando global para execução assíncrona de chamadas relacionadas à GPT.
pubadsReady
Sinalização que indica que o PubAdsService está ativado, carregado e totalmente operacional.
secureSignalProviders
Referência à matriz de provedores de indicadores seguros.
Resumo da função
companionAds
Retorna uma referência ao CompanionAdsService.
defineOutOfPageSlot
Cria um espaço de anúncio fora da página com o caminho do bloco de anúncios especificado.
defineSlot
Cria um espaço de anúncio com 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 espaços fornecidos, removendo todos os objetos relacionados e referências a esses espaços do 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 que foram definidos para os espaços de anúncio na página.
getVersion
Retorna a versão atual da 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úncio criados por PubAdsService, deste ponto em diante.
setConfig
Define as opções gerais de configuração da página.
sizeMapping
Cria um novo SizeMappingBuilder.

googletag.apiReady

  • apiReady: boolean | undefined

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

    A maneira recomendada de lidar com assíncrono é usar googletag.cmd para enfileirar callbacks para quando a GPT estiver pronta. Esses callbacks não precisam verificar googletag.apiReady, já que eles têm garantia de execução quando a API for configurada.

  • Exemplo

    JavaScript

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

    JavaScript (legado)

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

    TypeScript

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

googletag.cmd

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

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

    A variável googletag.cmd é inicializada em uma matriz JavaScript vazia pela sintaxe da tag GPT na página, e cmd.push é o método Array.push padrão que adiciona um elemento ao final da matriz. Quando o JavaScript da GPT é carregado, ele analisa a matriz e executa todas as funções em ordem. Em seguida, o script substitui cmd por um objeto CommandArray, cujo método push é definido para executar o argumento de função transmitido a ele. Esse mecanismo permite que o GPT reduza a latência percebida buscando o JavaScript de forma assíncrona, ao mesmo tempo que 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());
});

googletag.pubadsReady

  • pubadsReady: boolean | undefined

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

googletag.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 que geram indicadores e as invoca em ordem. Ela substitui uma matriz padrão usada para enfileirar funções geradores de sinal a serem 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");
  },
});
    Veja também

googletag.companionAds

googletag.defineOutOfPageSlot

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

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

    Para anúncios fora da página personalizados, div é o ID do elemento div que 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);
    Veja também
  • Parâmetros
    adUnitPath: string
    Caminho completo do bloco de anúncios com o código de rede e o código do bloco de anúncios.
    div?: string | OutOfPageFormat
    ID do div que vai conter esse bloco de anúncios ou OutOfPageFormat.
  • Retorna
    Slot | null
    O slot recém-criado, ou null, se não for possível criar um espaço.

googletag.defineSlot

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

  • Cria um espaço de anúncio com 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");
    Veja também
  • Parâmetros
    adUnitPath: string
    Caminho completo do bloco de anúncios com o código da rede e do bloco.
    size: GeneralSize
    Largura 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 que o menor tamanho fornecido no mapeamento.
    div?: string
    ID do div que conterá esse bloco de anúncios.
  • Retorna
    Slot | null
    O slot recém-criado, ou null, se não for possível criar um espaço.

googletag.destroySlots

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

  • Destrói os espaços fornecidos, removendo todos os objetos relacionados e referências a esses espaços do GPT. Esta API não é compatível com slots de passback e de complementares.

    Chamar essa API em um slot limpa o anúncio e remove o objeto de slot do estado interno mantido pela GPT. Chamar qualquer outra função no objeto de slot resultará em um comportamento indefinido. É possível que o navegador ainda não libere a memória associada a esse slot se uma referência a ele for mantida pela página do editor. Chamar essa API disponibiliza o div associado a esse espaço para reutilização.

    Especificamente, destruir um espaço remove o anúncio da visualização de página de longa duração da GPT. Assim, as solicitações futuras não serão influenciadas por bloqueios de página ou exclusões competitivas que envolvam esse anúncio. A falha em chamar essa função antes de remover o div de um espaço da página resultará em um comportamento 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
    slots?: Slot[]
    A matriz de slots a serem destruídos. A matriz é opcional. Todos os slots serão destruídos se não for especificada.
  • Retorna
    boolean
    true se os slots tiverem sido destruídos. Caso contrário, false.

googletag.disablePublisherConsole

googletag.display

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

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

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

  • Exemplo

    JavaScript

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

    JavaScript (legado)

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

    TypeScript

    googletag.cmd.push(() => {
  googletag.display("div-1");
});
    Veja também
  • Parâmetros
    divOrSlot: string | Element | Slot
    O ID do elemento div que contém o espaço de anúncio, o elemento div ou o objeto do espaço. Se um elemento div for fornecido, ele precisará ter um atributo "id" que corresponda ao ID transmitido para defineSlot.

googletag.enableServices

  • enableServices(): void

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

googletag.getVersion

  • getVersion(): string

  • Retorna a versão atual da GPT.

  • Veja também
  • Retorna
    string
    A string da versão da GPT em execução no momento.

googletag.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();
    Veja também
  • Parâmetros
    div?: string
    Um código div do espaço do anúncio. Este valor é opcional. Quando fornecido, o Console do Editor tenta abrir com detalhes do espaço do anúncio especificado em visualização.

googletag.pubads

googletag.setAdIframeTitle

  • setAdIframeTitle(title: string): void

  • Define o título de todos os iframes de contêiner de anúncio criados por PubAdsService, deste ponto em diante.

  • Exemplo

    JavaScript

    googletag.setAdIframeTitle("title");

    JavaScript (legado)

    googletag.setAdIframeTitle("title");

    TypeScript

    googletag.setAdIframeTitle("title");
  • Parâmetros
    title: string
    O novo título de todos os iframes de contêiner de anúncio.

googletag.setConfig

googletag.sizeMapping

googletag.CommandArray

A matriz de comandos aceita uma sequência de funções e as invoca em ordem. Ele substitui uma matriz padrão usada para enfileirar funções a serem invocadas quando a GPT for carregada.

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

push

  • push(...f: Array<(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
    ...f: Array<(this: typeof globalThis) => void>
    Uma função JavaScript a ser executada. A vinculação do ambiente de execução sempre será globalThis. Considere transmitir uma função de seta para reter o valor this do contexto léxico de inclusão.
  • Retorna
    number
    O 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

Estende Service

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

Resumo dos 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
Consiga a lista de slots associados a este serviço.
removeEventListener
Remove um listener registrado anteriormente.
setRefreshUnfilledSlots
Define se os espaços de complementares que não foram preenchidos serão preenchidos automaticamente.
Veja também

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 a vida útil da página para ativar e desativar o preenchimento. Somente os espaços que também estiverem registrados com o PubAdsService serão preenchidos. Devido a restrições de política, este método não foi criado para preencher espaços complementares vazios quando um vídeo do Ad Exchange é veiculado.

  • Exemplo

    JavaScript

    googletag.companionAds().setRefreshUnfilledSlots(true);

    JavaScript (legado)

    googletag.companionAds().setRefreshUnfilledSlots(true);

    TypeScript

    googletag.companionAds().setRefreshUnfilledSlots(true);
  • Parâmetros
    value: boolean
    true para preencher automaticamente os espaços não preenchidos, false para deixá-los inalterados.

googletag.PrivacySettingsConfig

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

Resumo da propriedade
childDirectedTreatment
Indica se a página deve ser tratada como direcionada a crianças.
limitedAds
Ativa a veiculação no modo de anúncios limitados para atender às necessidades de conformidade regulatória do editor.
nonPersonalizedAds
Ativa a veiculação no modo de anúncios não personalizados para atender às necessidades de conformidade regulatória do editor.
restrictDataProcessing
Ativa a veiculação em modo de processamento restrito para atender às necessidades de conformidade regulatória do editor.
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 vindas de usuários abaixo da idade de consentimento.
Veja também

childDirectedTreatment

limitedAds

  • limitedAds: boolean

  • Ativa a veiculação no modo de anúncios limitados para atender às necessidades de conformidade regulatória dos editores.

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

    • Automaticamente, usando um indicador de uma plataforma de gestão de consentimento do IAB TCF v2.0.
    • Manualmente, definindo o valor deste campo como true.
    A configuração manual dos anúncios limitados só é possível quando a GPT é carregada de um URL de anúncios limitados. A tentativa de modificar essa configuração quando a GPT for carregada do URL padrão vai gerar 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,
});
    Veja também

nonPersonalizedAds

  • nonPersonalizedAds: boolean

  • Ativa a veiculação no modo de anúncios não personalizados para atender às necessidades de conformidade regulatória do editor.

restrictDataProcessing

  • restrictDataProcessing: boolean

  • Ativa a veiculação em modo de processamento restrito para atender às necessidades de conformidade regulatória do editor.

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 ela não for definida, a origem do tráfego usará undefined por padrão 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,
});

underAgeOfConsent

  • underAgeOfConsent: null | boolean

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

googletag.PubAdsService

Estende Service

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

Resumo dos 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 espaços fornecidos e os substitui por conteúdo em branco.
clearCategoryExclusions
Limpa todos os rótulos de exclusão da categoria de anúncios no nível da página.
clearTargeting
Limpa os parâmetros de segmentação personalizada para uma chave específica ou para todas as chaves.
collapseEmptyDivs
Permite o recolhimento de divs de espaço para que não ocupem espaço na página quando não houver conteúdo do anúncio a ser exibido.
disableInitialLoad
Desativa as solicitações de anúncios no carregamento de página, mas permite que eles sejam solicitados com uma chamada PubAdsService.refresh.
display
Cria e exibe um espaço de anúncio com o caminho e o tamanho do bloco de anúncios especificados.
enableLazyLoad
Ativa o carregamento lento na GPT, conforme definido pelo objeto de configuração.
enableSingleRequest
Ativa o modo de solicitação única para buscar vários anúncios ao mesmo tempo.
enableVideoAds
Sinaliza à GPT que os anúncios em vídeo vão estar presentes na página.
get
Retorna o valor do atributo do Google AdSense associado à chave especificada.
getAttributeKeys
Retorna as chaves de atributo que foram definidas neste serviço.
getSlots
Consiga a lista de slots associados a este serviço.
getTargeting
Retorna um parâmetro de segmentação personalizado específico no nível do serviço que foi definido.
getTargetingKeys
Retorna a lista de todas as chaves de segmentação em nível de serviço personalizadas que foram definidas.
isInitialLoadDisabled
Retorna se as solicitações iniciais de anúncios foram desativadas ou não desativadas por uma chamada PubAdsService.disableInitialLoad anterior.
refresh
Busca e exibe novos anúncios para espaços específicos ou para todos os espaços na página.
removeEventListener
Remove um listener registrado anteriormente.
set
Define valores para os atributos do Google AdSense que se aplicam a todos os espaços de anúncio no serviço de anúncios do editor.
setCategoryExclusion
Define uma exclusão da categoria do anúncio no nível da página para o nome do rótulo especificado.
setCentering
Ativa e desativa a centralização horizontal de anúncios.
setForceSafeFrame
Configura se todos os anúncios da página precisam ser renderizados usando um contêiner do SafeFrame.
setLocation
Transmite informações de localização de sites para que você possa segmentar itens de linha por área geográfica para locais específicos.
setPrivacySettings
Permite a definiçã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
Define as preferências no nível da página para a configuração do SafeFrame.
setTargeting
Define parâmetros de segmentação personalizada para uma determinada chave que se aplicam a todos os espaços de anúncio do serviço dos Anúncios do editor.
setVideoContent
Define as informações de conteúdo de vídeo a serem enviadas com as solicitações de anúncios para fins de segmentação e exclusão de conteúdo.
updateCorrelator
Altera o correlator enviado com as solicitações de anúncios, iniciando uma nova visualização de página.

clear

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

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

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

  • Exemplo

    JavaScript

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

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

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

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

    JavaScript (legado)

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

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

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

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

    TypeScript

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

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

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

// This call to clear all slots.
googletag.pubads().clear();
  • Parâmetros
    slots?: Slot[]
    A matriz de slots a serem limpos. A matriz é opcional. Todos os slots serão apagados se não for especificada.
  • Retorna
    boolean
    Retorna true se os espaços tiverem sido apagados. Caso contrário, retorna false.

clearCategoryExclusions

  • clearCategoryExclusions(): PubAdsService

  • Limpa todos os rótulos de exclusão da categoria de anúncios 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.
    Veja também
  • Retorna
    PubAdsService
    O objeto de serviço em que o método foi chamado.

clearTargeting

  • clearTargeting(key?: string): PubAdsService

  • Limpa os parâmetros de segmentação personalizada 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.
    Veja também
  • Parâmetros
    key?: string
    Chave de parâmetro de segmentação. A chave é opcional. Todos os parâmetros de segmentação serão apagados se não for especificado.
  • Retorna
    PubAdsService
    O objeto de serviço em que o método foi chamado.

collapseEmptyDivs

  • collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean

  • Permite o recolhimento de divs de espaço para que não ocupem espaço na página quando não houver conteúdo do anúncio a ser exibido. Esse modo precisa ser definido antes da ativação do serviço.

  • Veja também
  • Parâmetros
    collapseBeforeAdFetch?: boolean
    Indica se os slots serão recolhidos mesmo antes que os anúncios sejam buscados. Esse parâmetro é opcional. Se não for fornecido, false será usado como o valor padrão.
  • Retorna
    boolean
    Retornará true se o modo de recolhimento div estiver ativado e false se for impossível ativar o modo de recolhimento porque o método foi chamado após a ativação do serviço.

disableInitialLoad

display

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

  • Cria e exibe um espaço de 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 o método é chamado, um snapshot do slot e do estado da página é criado para garantir a consistência ao enviar a solicitação de anúncio e renderizar a resposta. As mudanças feitas no espaço ou no estado da página após esse método ser chamado (incluindo segmentação, configurações de privacidade, forçar o SafeFrame etc.) serão aplicadas somente às solicitações display() ou refresh() subsequentes.

  • Exemplo

    JavaScript

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

    JavaScript (legado)

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

    TypeScript

    googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
    Veja também
  • Parâmetros
    adUnitPath: string
    O caminho do bloco de anúncios do espaço a ser renderizado.
    size: GeneralSize
    Largura e altura do slot.
    div?: string | Element
    O ID do div que contém o espaço ou o próprio elemento div.
    clickUrl?: string
    O URL de clique a ser usado neste espaço.

enableLazyLoad

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

  • Ativa o carregamento lento na GPT, conforme definido pelo objeto de configuração. Para exemplos mais detalhados, consulte o exemplo 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,
});
    Veja também
  • Parâmetros
    config?: { fetchMarginPercent: number, mobileScaling: number, renderMarginPercent: number }
    O objeto de configuração permite a personalização do comportamento lento. Todas as configurações omitidas usarão um padrão definido pelo Google, que será ajustado ao longo do tempo. Para desativar uma configuração específica, como uma busca de margem, defina o valor como -1.
    • fetchMarginPercent

      A distância mínima da janela de visualização atual que um espaço precisa estar para que o anúncio seja buscado como uma porcentagem do tamanho da janela de visualização. Um valor de 0 significa "quando o espaço entra na janela de visualização", 100 significa "quando o anúncio está a uma janela de visualização de distância" e assim por diante.
    • renderMarginPercent

      A distância mínima da janela de visualização atual que um espaço precisa estar antes de renderizarmos um anúncio. Isso permite a pré-busca do anúncio, mas a espera para renderizar e fazer 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 margens variadas em dispositivos móveis e computadores. Por exemplo, um valor de 2,0 multiplica todas as margens por 2 em dispositivos móveis, aumentando a distância mínima de um espaço antes da busca e da renderização.

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 dos anúncios do editor sejam definidos e adicionados ao PubAdsService antes da ativação do serviço. O modo de solicitação única precisa ser definido antes da ativação do serviço.

  • Veja também
  • Retorna
    boolean
    Retornará true se o modo de solicitação única tiver sido ativado e false se for impossível ativar o modo de solicitação única porque o método foi chamado após a ativação do serviço.

enableVideoAds

  • enableVideoAds(): void

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

get

  • get(key: string): null | string

  • Retorna o valor do atributo do Google 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'.
    Veja também
  • Parâmetros
    key: string
    Nome do atributo a ser procurado.
  • Retorna
    null | string
    Valor atual da chave de atributo ou null se a chave não estiver presente.

getAttributeKeys

  • getAttributeKeys(): string[]

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

  • 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 atributos definidas neste serviço. A ordem é indefinida.

getTargeting

  • getTargeting(key: string): string[]

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

  • 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: string
    A 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 em nível de serviço personalizadas 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 é indefinida.

isInitialLoadDisabled

  • isInitialLoadDisabled(): boolean

  • Retorna se as solicitações iniciais de anúncios foram desativadas ou não desativadas por uma chamada PubAdsService.disableInitialLoad anterior.

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

refresh

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

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

    Para um comportamento adequado em todos os navegadores, chamar refresh precisa ser precedido por uma chamada para display do espaço do anúncio. Se a chamada para display for omitida, a atualização poderá ter um comportamento inesperado. Se você quiser, o método PubAdsService.disableInitialLoad pode ser usado para interromper a busca de um anúncio por display.

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

  • Exemplo

    JavaScript

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

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

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

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

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

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

    JavaScript (legado)

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

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

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

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

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

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

    TypeScript

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

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

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

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

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

// This call to refresh fetches a new ad for each slot, without
// changing the correlator.
googletag.pubads().refresh(null, { changeCorrelator: false });
    Veja também
  • Parâmetros
    slots?: null | Slot[]
    Os slots a serem atualizados. A matriz é opcional. Todos os slots serão atualizados se não for especificada.
    options?: { changeCorrelator: boolean }
    Opções de configuração associadas a esta chamada de atualização.
    • changeCorrelator

      Especifica se um novo correlator será gerado ou não para a busca de anúncios. Nossos servidores de anúncios mantêm esse valor de correlação por pouco tempo (atualmente por 30 segundos, mas sujeito a alterações). Assim, as solicitações com o mesmo correlator recebidas em conjunto serão consideradas uma única visualização de página. Por padrão, um novo correlator é gerado para cada atualização.

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

set

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

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

    Chamar esse operador mais de uma vez para a mesma chave substitui os valores definidos anteriormente para essa chave. 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");
    Veja também
  • Parâmetros
    key: string
    O nome do atributo.
    value: string
    Valor do atributo.
  • Retorna
    PubAdsService
    O objeto de serviço em que o método foi chamado.

setCategoryExclusion

  • setCategoryExclusion(categoryExclusion: string): PubAdsService

  • Define uma exclusão da categoria do anúncio no nível da página para o nome do 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");
    Veja também
  • Parâmetros
    categoryExclusion: string
    O rótulo de exclusão da categoria de anúncio a ser adicionado.
  • Retorna
    PubAdsService
    O objeto de serviço em que o método foi chamado.

setCentering

  • setCentering(centerAds: boolean): void

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

    Este método deve ser invocado antes de chamar display ou refresh, porque somente 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: boolean
    true para centralizar os anúncios, false para alinhá-los à esquerda.

setForceSafeFrame

  • setForceSafeFrame(forceSafeFrame: boolean): PubAdsService

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

    Lembre-se do seguinte ao usar essa API:

    • Essa configuração só será aplicada nas próximas solicitações de anúncios feitas para os respectivos espaços.
    • A configuração no nível do espaço do anúncio, se especificada, sempre modificará 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 SafeFrame, independentemente da escolha feita na interface do Google Ad Manager.
    • No entanto, se for definido como false ou não for especificado, o anúncio será renderizado usando um contêiner 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 dos criativos que tentam sair dos iframes ou que dependem da renderização deles diretamente em uma página do editor.

  • 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");
    Veja também
  • Parâmetros
    forceSafeFrame: boolean
    true para forçar a renderização de todos os anúncios da página em SafeFrames e false para mudar a configuração anterior para "false". Definir como false quando não especificado antes não muda nada.
  • Retorna
    PubAdsService
    O objeto de serviço em que a função foi chamada.

setLocation

  • setLocation(address: string): PubAdsService

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

  • 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: string
    Endereço com formato livre.
  • Retorna
    PubAdsService
    O objeto de serviço em que o método foi chamado.

setPrivacySettings

  • setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService

  • Permite a definiçã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,
});
    Veja também
  • Parâmetros
    privacySettings: PrivacySettingsConfig
    Objeto contendo a configuração das configurações de privacidade.
  • Retorna
    PubAdsService
    O objeto de serviço em que a função foi chamada.

setPublisherProvidedId

  • setPublisherProvidedId(ppid: string): PubAdsService

  • Define o valor do ID fornecido pelo editor.

  • Exemplo

    JavaScript

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

    JavaScript (legado)

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

    TypeScript

    googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
    Veja também
  • Parâmetros
    ppid: string
    É um código alfanumérico fornecido pelo editor. Precisa ter entre 32 e 150 caracteres.
  • Retorna
    PubAdsService
    O objeto de serviço em que o método foi chamado.

setSafeFrameConfig

  • setSafeFrameConfig(config: SafeFrameConfig): PubAdsService

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

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

  • 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");
    Veja também
  • Parâmetros
    config: SafeFrameConfig
    O objeto de configuração.
  • Retorna
    PubAdsService
    O objeto de serviço em que o método foi chamado.

setTargeting

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

  • Define parâmetros de segmentação personalizada para uma determinada chave que se aplicam a todos os espaços de anúncio do serviço dos Anúncios do editor. Chamar esse operador várias vezes para a mesma chave 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"]);
    Veja também
  • Parâmetros
    key: string
    Chave de parâmetro de segmentação.
    value: string | string[]
    Valor de parâmetro de segmentação ou matriz de valores.
  • Retorna
    PubAdsService
    O objeto de serviço em que o método foi chamado.

setVideoContent

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

  • Define as informações de conteúdo de vídeo a serem enviadas com as solicitações de anúncios 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.

  • Veja também
  • Parâmetros
    videoContentId: string
    O ID do conteúdo do vídeo.
    videoCmsId: string
    É o ID do CMS do vídeo.

updateCorrelator

  • updateCorrelator(): PubAdsService

  • Altera o correlator enviado com as solicitações de anúncios, iniciando uma nova visualização de página. O correlator é o mesmo para todas as solicitações de anúncios provenientes de uma visualização de página e é único em visualizações de página. Aplica-se somente 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
    PubAdsService
    O objeto de serviço em que a função foi chamada.

googletag.ResponseInformation

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

Resumo da propriedade
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.
Veja também

advertiserId

  • advertiserId: null | number

  • O ID do anunciante.

campaignId

  • campaignId: null | number

  • O ID da campanha.

creativeId

  • creativeId: null | number

  • O ID do criativo.

creativeTemplateId

  • creativeTemplateId: null | number

  • O ID do modelo do anúncio.

lineItemId

  • lineItemId: null | number

  • O ID do item de linha.

googletag.RewardedPayload

Um objeto que representa o prêmio associado a um anúncio premiado

Resumo da propriedade
amount
Número de itens incluídos no prêmio.
type
É o tipo de item incluído no prêmio, como "moeda".
Veja também

amount

  • amount: number

  • Número de itens incluídos no prêmio.

type

  • type: string

  • É o tipo de item incluído no prêmio, como "moeda".

googletag.SafeFrameConfig

Objeto de configuração para contêineres SafeFrame.

Resumo da propriedade
allowOverlayExpansion
Indica se o SafeFrame deve permitir a expansão do conteúdo do anúncio sobrepondo o conteúdo da página.
allowPushExpansion
Indica se o SafeFrame deve permitir que o conteúdo do anúncio seja expandido enviando o conteúdo da página.
sandbox
Indica se o SafeFrame deve usar o atributo de sandbox HTML5 para impedir a navegação de nível superior sem interação do usuário.
useUniqueDomain
Obsoleto. Indica se o SafeFrame deve usar subdomínios aleatórios para os criativos de reserva.
Veja também

allowOverlayExpansion

  • allowOverlayExpansion: boolean

  • Indica se o SafeFrame deve permitir a expansão do conteúdo do anúncio sobrepondo o conteúdo da página.

allowPushExpansion

  • allowPushExpansion: boolean

  • Indica se o SafeFrame deve permitir que o conteúdo do anúncio seja expandido enviando o conteúdo da página.

sandbox

  • sandbox: boolean

  • Indica se o SafeFrame deve usar o atributo de sandbox HTML5 para impedir a navegação de nível superior sem interação do usuário. O único valor válido é true (não pode ser forçado para false). O atributo sandbox desativa plug-ins (por exemplo, Flash).

useUniqueDomain

  • useUniqueDomain: null | boolean

  • Indica se o SafeFrame deve usar subdomínios aleatórios para os criativos de reserva. Transmita null para limpar o valor armazenado.

    Observação: esse recurso é ativado por padrão.

  • Veja também

googletag.Service

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

Resumo dos 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
Consiga a lista de slots associados a este serviço.
removeEventListener
Remove um listener registrado anteriormente.

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. Há suporte para os seguintes eventos:

    Um objeto do tipo de evento apropriado é transmitido ao listener quando é 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.
  }
});
    Veja também
  • Parâmetros
    eventType: K
    É uma string que representa o tipo de evento gerado pela GPT. Os tipos de evento diferenciam maiúsculas de minúsculas.
    listener: (arg: EventTypeMap[K]) => void
    Função que usa um único argumento de objeto de evento.
  • Retorna
    Service
    O objeto de serviço em que o método foi chamado.

getSlots

  • getSlots(): Slot[]

  • Consiga a lista de slots associados a este serviço.

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

removeEventListener

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

  • Remove um listener registrado anteriormente.

  • Exemplo

    JavaScript

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

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

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

    JavaScript (legado)

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

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

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

    TypeScript

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

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

  // Add onViewableListener as a listener for impressionViewable events.
  googletag.pubads().addEventListener("impressionViewable", onViewableListener);
  googletag.enableServices();
});
  • Parâmetros
    eventType: K
    É uma string que representa o tipo de evento gerado pela GPT. Os tipos de evento diferenciam maiúsculas de minúsculas.
    listener: (event: EventTypeMap[K]) => void
    Função que usa um único argumento de objeto de evento.

googletag.SizeMappingBuilder

Builder de objetos de especificação de mapeamento de tamanho. Esse criador é fornecido para ajudar a criar especificações de tamanho facilmente.

Resumo dos 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 de vários tamanhos representando o espaço.
build
Cria uma especificação de mapa de tamanho com base nos mapeamentos adicionados a esse builder.
Veja também

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 de vários tamanhos representando o espaço.

  • Exemplo

    JavaScript

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

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

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

    JavaScript (legado)

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

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

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

    TypeScript

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

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

// Mapping 2 will not show any ads for the following viewport sizes:
// [1024, 768] > size >= [980, 690] and
// [640, 480] > size >= [0, 0]
  • Parâmetros
    viewportSize: SingleSizeArray
    O tamanho da janela de visualização para esta entrada de mapeamento.
    slotSize: GeneralSize
    Os tamanhos do slot para esta entrada de mapeamento.
  • Retorna
    SizeMappingBuilder
    Uma referência a este criador.

build

  • build(): null | SizeMappingArray

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

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

    Observação: o comportamento do builder depois de chamar esse método é indefinido.

  • Retorna
    null | SizeMappingArray
    O resultado criado por este builder. Pode ser nulo se mapeamentos de tamanho inválidos tiverem sido fornecidos.

googletag.Slot

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

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

addService

  • addService(service: Service): Slot

  • Adiciona um Service ao slot.

  • Exemplo

    JavaScript

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

    JavaScript (legado)

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

    TypeScript

    googletag.defineSlot("/1234567/sports", [160, 600], "div")!.addService(googletag.pubads());
    Veja também
  • Parâmetros
    service: Service
    O serviço a ser adicionado.
  • Retorna
    Slot
    O 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 deste 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
    Slot
    O objeto de slot em que o método foi chamado.

clearTargeting

  • clearTargeting(key?: string): Slot

  • Limpa todos os parâmetros de segmentação personalizados ou específicos do espaço para este espaço.

  • 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.
    Veja também
  • Parâmetros
    key?: string
    Chave de parâmetro de segmentação. A chave é opcional. Todos os parâmetros de segmentação serão apagados se não for especificado.
  • Retorna
    Slot
    O 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 da janela de visualização para o tamanho do espaço desse espaço.

  • Exemplo

    JavaScript

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

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

slot.defineSizeMapping(mapping);

    JavaScript (legado)

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

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

slot.defineSizeMapping(mapping);

    TypeScript

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

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

slot.defineSizeMapping(mapping!);
    Veja também
  • Parâmetros
    sizeMapping: SizeMappingArray
    Matriz de mapeamentos de tamanho. Você pode usar o SizeMappingBuilder para criá-lo. Cada mapeamento de tamanho é uma matriz de dois elementos: SingleSizeArray e GeneralSize.
  • Retorna
    Slot
    O objeto de slot em que o método foi chamado.

get

  • get(key: string): null | string

  • Retorna o valor do atributo do AdSense associado à chave especificada para esse espaço. Para ver os atributos de nível de 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'.
    Veja também
  • Parâmetros
    key: string
    Nome do atributo a ser procurado.
  • Retorna
    null | string
    Valor atual da chave de atributo ou null se a chave não estiver presente.

getAdUnitPath

  • getAdUnitPath(): string

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

  • Exemplo

    JavaScript

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

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

    JavaScript (legado)

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

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

    TypeScript

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

slot.getAdUnitPath();
// Returns '/1234567/sports'.
  • Retorna
    string
    Caminho do bloco de anúncios.

getAttributeKeys

  • getAttributeKeys(): string[]

  • Retorna a lista de chaves de atributo definidas neste slot. Para ver as chaves de atributos de nível de serviço herdados por esse 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 atributos. A ordem é indefinida.

getCategoryExclusions

  • getCategoryExclusions(): string[]

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

  • 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 esse espaço ou uma matriz vazia se nenhum tiver sido definido.

getResponseInformation

  • getResponseInformation(): null | ResponseInformation

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

  • Retorna
    null | ResponseInformation
    As informações mais recentes de resposta do anúncio, ou null se o espaço não tiver anúncio.

getSlotElementId

  • getSlotElementId(): string

  • Retorna o ID do espaço div fornecido quando o espaço foi definido.

  • Exemplo

    JavaScript

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

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

    JavaScript (legado)

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

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

    TypeScript

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

slot.getSlotElementId();
// Returns 'div'.
  • Retorna
    string
    ID do slot div.

getTargeting

  • getTargeting(key: string): string[]

  • Retorna um parâmetro de segmentação personalizada específico definido neste espaço. 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: string
    A 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 personalizadas definidas neste espaço. 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 é indefinida.

set

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

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

    Chamar esse método mais de uma vez para a mesma chave vai modificar os valores definidos anteriormente para essa chave. 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());
    Veja também
  • Parâmetros
    key: string
    O nome do atributo.
    value: string
    Valor do atributo.
  • Retorna
    Slot
    O objeto de slot em que o método foi chamado.

setCategoryExclusion

  • setCategoryExclusion(categoryExclusion: string): Slot

  • Define um rótulo de exclusão da categoria de anúncio no nível do espaço neste 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());
    Veja também
  • Parâmetros
    categoryExclusion: string
    O rótulo de exclusão da categoria de anúncio a ser adicionado.
  • Retorna
    Slot
    O objeto de slot em que o método foi chamado.

setClickUrl

  • setClickUrl(value: string): Slot

  • Define o URL de clique para onde os usuários serão redirecionados após 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 será anexado ao valor fornecido. As chamadas seguintes 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: string
    O URL de clique a ser definido.
  • Retorna
    Slot
    O objeto de slot em que o método foi chamado.

setCollapseEmptyDiv

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

  • Define se o espaço div deve ficar oculto quando não houver anúncios no espaço. Isso substitui as configurações de nível de 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.
    Veja também
  • Parâmetros
    collapse: boolean
    Indica se o espaço deve ser recolhido se nenhum anúncio for retornado.
    collapseBeforeAdFetch?: boolean
    Indica se o espaço deve ser recolhido mesmo antes de um anúncio ser buscado. Será ignorado se o recolhimento não for true.
  • Retorna
    Slot
    O objeto de slot em que o método foi chamado.

setConfig

  • setConfig(slotConfig: SlotSettingsConfig): void

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

  • Parâmetros
    slotConfig: SlotSettingsConfig
    O 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.

    Lembre-se das seguintes informações ao usar essa API:

    • Essa configuração só será aplicada nas próximas solicitações de anúncios feitas para os respectivos espaços.
    • A configuração no nível do espaço do anúncio, se especificada, sempre modificará 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 SafeFrame, independentemente da escolha feita na interface do Google Ad Manager.
    • No entanto, se for definido como false ou não for especificado, o anúncio será renderizado usando um contêiner 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 dos criativos que tentam sair dos iframes ou que dependem da renderização deles diretamente em uma página do editor.

  • 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());
    Veja também
  • Parâmetros
    forceSafeFrame: boolean
    true para forçar a renderização de todos os anúncios nesse espaço em SafeFrames e false para desativar uma configuração de nível de página (se houver). Definir como false quando não especificado no nível da página não vai mudar nada.
  • Retorna
    Slot
    O objeto de slot em que o método foi chamado.

setSafeFrameConfig

  • setSafeFrameConfig(config: null | SafeFrameConfig): Slot

  • Define as preferências no nível do slot para a configuração do SafeFrame. Todas 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 espaço, se especificadas, vão substituir todas 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");
    Veja também
  • Parâmetros
    config: null | SafeFrameConfig
    O objeto de configuração.
  • Retorna
    Slot
    O 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 espaço. Chamar esse método várias vezes para a mesma chave substituirá os valores antigos. Os valores definidos aqui substituirão 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"]);
    Veja também
  • Parâmetros
    key: string
    Chave de parâmetro de segmentação.
    value: string | string[]
    Valor de parâmetro de segmentação ou matriz de valores.
  • Retorna
    Slot
    O objeto de slot em que o método foi chamado.

updateTargetingFromMap

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

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

    Observações:

    • Em caso de substituição, apenas o último valor será mantido.
    • Se o valor for uma matriz, qualquer valor anterior será substituído, não mesclado.
    • Os valores definidos aqui substituirão 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
    Slot
    O objeto de slot em que o método foi chamado.

googletag.config.AdExpansionConfig

Configurações para controlar a expansão do anúncio.

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

enabled

googletag.config.ComponentAuctionConfig

Um objeto que representa um leilão de componente único em um leilão de anúncios no dispositivo.

Resumo da propriedade
auctionConfig
Um objeto de configuração de leilão para o leilão desse componente.
configKey
A chave de configuração associada ao leilão desse componente.
Veja também

auctionConfig

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

  • Um objeto de configuração de leilão para este leilão de componentes.

    Se esse valor for definido como null, todas as configurações atuais do configKey especificado serão excluídas.

  • 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,
    },
  ],
});
    Veja também

configKey

  • configKey: string

  • A chave de configuração associada a esse leilão de componente.

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

googletag.config.InterstitialConfig

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

Resumo da propriedade
triggers
A configuração do acionador intersticial para este anúncio intersticial.

triggers

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

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

    Definir o valor de um acionador intersticial como true vai ativá-lo e false o desativará. Essa ação 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,
    },
  },
});
    Veja também

googletag.config.PageSettingsConfig

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

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

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

Exemplos:

  • Somente os recursos especificados na chamada 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 setConfig. 
      // Configure feature charlie to echo = 1, foxtrot = true.
  googletag.setConfig({
      charlie: {
          echo: 1,
          foxtrot: true,
      }
  });

  // Update feature charlie to echo = 2. Since foxtrot was not specified,
  // the value is cleared.
  googletag.setConfig({
      charlie: {
          echo: 2
      }
  });
  • Todas as configurações de um recurso podem ser apagadas ao transmitir 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,
  });

Resumo da propriedade
adExpansion
Configurações para controlar a expansão do anúncio.
pps
Configurações para controlar os indicadores fornecidos pelo editor (PPS).
privacyTreatments
Configurações para controlar os tratamentos de privacidade do editor.

adExpansion

  • adExpansion: null | AdExpansionConfig

  • Configurações para controlar a expansão do anúncio.

pps

privacyTreatments

  • privacyTreatments: null | PrivacyTreatmentsConfig

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

googletag.config.PrivacyTreatmentsConfig

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

Resumo da propriedade
treatments
Uma série de tratamentos de privacidade do editor que podem ser ativados.

treatments

  • treatments: "disablePersonalization"[]

  • Uma série de tratamentos de privacidade do editor que podem ser 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 editor (PPS).

Resumo da propriedade
taxonomies
Um objeto que contém mapeamentos de Taxonomy.
Exemplo

JavaScript

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

JavaScript (legado)

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

TypeScript

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

taxonomies

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 os recursos reais que usam setConfig. Para ver o conjunto de recursos, veja os campos no tipo SlotSettingsConfig abaixo.

Exemplos:

  • Somente os recursos especificados na chamada Slot.setConfig são modificados. 
      const slot = googletag.defineSlot("/1234567/example", [160, 600]);

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

  // Configure feature bravo. Feature alpha is unchanged.
  slot.setConfig({
     bravo: {...}
  });
  • Todas as configurações de um determinado recurso são atualizadas a cada chamada para Slot.setConfig. 
      // Configure feature charlie to echo = 1, foxtrot = true.
  slot.setConfig({
      charlie: {
          echo: 1,
          foxtrot: true,
      }
  });

  // Update feature charlie to echo = 2. Since foxtrot was not specified,
  // the value is cleared.
  slot.setConfig({
      charlie: {
          echo: 2
      }
  });
  • Todas as configurações de um recurso podem ser apagadas ao transmitir 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,
  });

Resumo da propriedade
adExpansion
Configurações para controlar a expansão do 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 controlam o comportamento do espaço de anúncio intersticial.

adExpansion

  • adExpansion: AdExpansionConfig

  • Configurações para controlar a expansão do anúncio.

componentAuction

  • componentAuction: ComponentAuctionConfig[]

  • Uma matriz de leilões de componentes a serem incluídos em um leilão de anúncios no dispositivo.

interstitial

  • interstitial: InterstitialConfig

  • Configurações que controlam o comportamento do espaço de anúncio intersticial.

googletag.config.TaxonomyData

Um objeto que contém os valores de uma única Taxonomia.

Resumo da propriedade
values
Uma lista de valores de Taxonomy.

values

  • values: string[]

  • Uma lista de valores de Taxonomy.

googletag.events.Event

é a interface básica para todos os eventos da GPT. Todos os eventos da GPT abaixo terão os campos a seguir.

Resumo da propriedade
serviceName
Nome do serviço que acionou o evento.
slot
O slot que acionou o evento.
Veja também

serviceName

  • serviceName: string

  • Nome do serviço que acionou o evento.

slot

  • slot: Slot

  • O slot que acionou o evento.

googletag.events.EventTypeMap

Esse é um pseudotipo que mapeia um nome de evento para o tipo de objeto de evento correspondente para Service.addEventListener e Service.removeEventListener. Ela é documentada apenas para fins de referência e segurança de tipo.

Resumo da propriedade
impressionViewable
rewardedSlotClosed
rewardedSlotGranted
rewardedSlotReady
slotOnload
slotRenderEnded
slotRequested
slotResponseReceived
slotVisibilityChanged

impressionViewable

rewardedSlotClosed

rewardedSlotGranted

rewardedSlotReady

slotOnload

slotRenderEnded

slotRequested

slotResponseReceived

slotVisibilityChanged

googletag.events.ImpressionViewableEvent

Estende Event

Este evento é disparado quando uma impressão se torna visível, de acordo com os critérios do Active View.

Resumo da propriedade
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.
  }
});
Veja também

googletag.events.RewardedSlotClosedEvent

Estende Event

Este evento é disparado quando um espaço de anúncio premiado é fechado pelo usuário. Ele pode ser disparado antes ou depois que uma recompensa é concedida. Para saber se uma recompensa foi concedida, use events.RewardedSlotGrantedEvent.

Resumo da propriedade
serviceName
Nome do serviço que acionou o evento.
slot
O slot que acionou o evento.
Exemplo

JavaScript

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

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

JavaScript (legado)

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

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

TypeScript

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

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
Veja também

googletag.events.RewardedSlotGrantedEvent

Estende Event

Este evento é disparado quando uma recompensa é concedida pela visualização de um anúncio premiado. Se o anúncio for fechado antes que os critérios de concessão de prêmio sejam atendidos, esse evento não será disparado.

Resumo da propriedade
payload
Um objeto contendo informações sobre a recompensa que foi concedida.
serviceName
Nome do serviço que acionou o evento.
slot
O slot que acionou o evento.
Exemplo

JavaScript

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

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

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

JavaScript (legado)

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

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

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

TypeScript

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

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

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
Veja também

payload

  • payload: null | RewardedPayload

  • Um objeto contendo informações sobre a recompensa que foi concedida.

googletag.events.RewardedSlotReadyEvent

Estende Event

Este evento é disparado quando um anúncio premiado está pronto para ser exibido. O editor é responsável por apresentar ao usuário a opção de visualizar o anúncio antes de exibi-lo.

Resumo da propriedade
serviceName
Nome do serviço que acionou o evento.
slot
O slot que acionou o evento.
Resumo dos métodos
makeRewardedVisible
Exibe o anúncio premiado.
Exemplo

JavaScript

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

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

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

JavaScript (legado)

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

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

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

TypeScript

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

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

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
Veja também

makeRewardedVisible

  • makeRewardedVisible(): void

  • Exibe o anúncio premiado. Esse método não deve ser chamado até que o usuário tenha consentido a visualização do anúncio.

googletag.events.SlotOnloadEvent

Estende Event

Este 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 será acionado.

Resumo da propriedade
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.
  }
});
Veja também

googletag.events.SlotRenderEndedEvent

Estende Event

Este evento é disparado quando o código do criativo é injetado em um espaço. Esse evento ocorrerá antes da busca dos recursos do criativo. Por isso, talvez ele ainda não esteja visível. Caso você precise saber quando todos os recursos criativos de um slot terminaram de carregar, considere usar events.SlotOnloadEvent.

Resumo da propriedade
advertiserId
ID do anunciante do anúncio renderizado.
campaignId
ID da campanha do anúncio renderizado.
companyIds
IDs das empresas que dão 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
Se um anúncio era de preenchimento.
isEmpty
Se um anúncio foi retornado para o espaço.
labelIds
IDs de rótulo do anúncio renderizado.
lineItemId
ID do item de linha do anúncio de reserva renderizado.
serviceName
Nome do serviço que acionou o evento.
size
Indica o tamanho do pixel do criativo renderizado.
slot
O slot que acionou o evento.
slotContentChanged
Indica se o conteúdo do espaço foi alterado com o anúncio renderizado.
sourceAgnosticCreativeId
ID do criativo do anúncio de reserva ou de preenchimento renderizado.
sourceAgnosticLineItemId
ID do item de linha do anúncio de reserva ou de preenchimento renderizado.
yieldGroupIds
IDs dos grupos de rendimento para o 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("Label IDs:", event.labelIds);
  console.log("Line Item ID:", event.lineItemId);
  console.log("Size:", event.size);
  console.log("Slot content changed?", event.slotContentChanged);
  console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId);
  console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId);
  console.log("Yield Group IDs:", event.yieldGroupIds);
  console.groupEnd();

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

JavaScript (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("Label IDs:", event.labelIds);
  console.log("Line Item ID:", event.lineItemId);
  console.log("Size:", event.size);
  console.log("Slot content changed?", event.slotContentChanged);
  console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId);
  console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId);
  console.log("Yield Group IDs:", event.yieldGroupIds);
  console.groupEnd();

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

TypeScript

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

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

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
Veja também

advertiserId

  • advertiserId: null | number

  • ID do anunciante do anúncio renderizado. O valor é null para espaços vazios, anúncios de preenchimento e criativos renderizados por outros serviços que não são PubAdsService.

campaignId

  • campaignId: null | number

  • ID da campanha do anúncio renderizado. O valor é null para espaços vazios, anúncios de preenchimento e criativos renderizados por outros serviços que não são PubAdsService.

companyIds

  • companyIds: null | number[]

  • IDs das empresas que dão lances no anúncio de preenchimento renderizado. O valor é null para slots vazios, anúncios de reserva e criativos renderizados por outros serviços que não são PubAdsService.

creativeId

  • creativeId: null | number

  • ID do criativo do anúncio de reserva renderizado. O valor é null para espaços vazios, anúncios de preenchimento e criativos renderizados por outros serviços que não são PubAdsService.

creativeTemplateId

  • creativeTemplateId: null | number

  • ID do modelo de criativo do anúncio de reserva renderizado. O valor é null para espaços vazios, anúncios de preenchimento e criativos renderizados por outros serviços que não são PubAdsService.

isBackfill

  • isBackfill: boolean

  • Se um anúncio era de preenchimento. O valor será true se o anúncio for de preenchimento. Caso contrário, será false.

isEmpty

  • isEmpty: boolean

  • Se um anúncio foi retornado para o espaço. O valor será true se nenhum anúncio for retornado. Caso contrário, será false.

labelIds

  • labelIds: null | number[]

  • IDs de rótulo do anúncio renderizado. O valor é null para espaços vazios, anúncios de preenchimento e criativos renderizados por outros serviços que não são PubAdsService.

lineItemId

  • lineItemId: null | number

  • ID do item de linha do anúncio de reserva renderizado. O valor é null para espaços vazios, anúncios de preenchimento e criativos renderizados por outros serviços que não são PubAdsService.

size

  • size: null | string | number[]

  • Indica o tamanho do pixel do criativo renderizado. Exemplo: [728, 90]. O valor é null para espaços de anúncio vazios.

slotContentChanged

  • slotContentChanged: boolean

  • Indica se o conteúdo do espaço foi alterado com o anúncio renderizado. O valor será true se o conteúdo tiver sido alterado. Caso contrário, será false.

sourceAgnosticCreativeId

  • sourceAgnosticCreativeId: null | number

  • ID do criativo do anúncio de reserva ou de preenchimento renderizado. O valor será null se o anúncio não for um preenchimento de reserva ou item de linha, ou se o criativo for renderizado por outros serviços que não sejam PubAdsService.

sourceAgnosticLineItemId

  • sourceAgnosticLineItemId: null | number

  • ID do item de linha do anúncio de reserva ou de preenchimento renderizado. O valor será null se o anúncio não for um preenchimento de reserva ou item de linha, ou se o criativo for renderizado por outros serviços que não sejam PubAdsService.

yieldGroupIds

  • yieldGroupIds: null | number[]

  • IDs dos grupos de rendimento para o anúncio de preenchimento renderizado. O valor é null para slots vazios, anúncios de reserva e criativos renderizados por outros serviços que não são PubAdsService.

googletag.events.SlotRequestedEvent

Estende Event

Este evento é disparado quando um anúncio é solicitado para um espaço específico.

Resumo da propriedade
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.
  }
});
Veja também

googletag.events.SlotResponseReceived

Estende Event

Este evento é disparado quando uma resposta de anúncio é recebida para um espaço específico.

Resumo da propriedade
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.
  }
});
Veja também

googletag.events.SlotVisibilityChangedEvent

Estende Event

Este evento é disparado sempre que a porcentagem na tela da área de um espaço de anúncio é alterada. O evento é limitado e não será disparado mais do que uma vez a cada 200 ms.

Resumo da propriedade
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.
  }
});
Veja também

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.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 coletor, que retorna um Promise que se refere a um indicador seguro.
  2. Um id que identifica o bidder associado ao indicador.
Para retornar um indicador seguro para um editor, use secureSignals.PublisherSignalProvider.

Resumo da propriedade
collectorFunction
.
id
É um identificador exclusivo do coletor associado a este 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");
  },
});
Veja também

collectorFunction

  • collectorFunction: () => Promise<string>

id

  • id: string

  • É um identificador exclusivo do coletor associado a este indicador seguro, conforme registrado no Google Ad Manager.

googletag.secureSignals.PublisherSignalProvider

Retorna um indicador seguro para um editor específico.

Um provedor de indicador do editor é composto por duas partes:

  1. Uma função de coletor, que retorna um Promise que se refere a um indicador seguro.
  2. Um networkCode que identifica o editor associado ao indicador.
Para retornar um indicador seguro para um bidder, use secureSignals.BidderSignalProvider.

Resumo da propriedade
collectorFunction
.
networkCode
O código de rede (conforme 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");
  },
});
Veja também

collectorFunction

  • collectorFunction: () => Promise<string>

networkCode

  • networkCode: string

  • O código de rede (conforme visto no caminho do bloco de anúncios) do editor associado a esse indicador seguro.

googletag.secureSignals.SecureSignalProvidersArray

Uma interface para gerenciar indicadores seguros.

Resumo dos métodos
clearAllCache
Limpa todos os indicadores do cache para todos os coletores e pode reduzir a probabilidade de inclusão de indicadores em solicitações de anúncios para essa visualização e, possivelmente, para as próximas.
push
Adiciona um novo secureSignals.SecureSignalProvider à matriz do provedor de indicadores e inicia o processo de geração de indicadores.

clearAllCache

  • clearAllCache(): void

  • Limpa todos os indicadores do cache para todos os coletores e pode reduzir a probabilidade de inclusão de indicadores em solicitações de anúncios para essa visualização e, possivelmente, para as próximas. só deve ser usada em mudanças de estado significativas, como eventos que indicam um novo usuário (por exemplo, login, logout, inscrição).

push