Esta referência usa a notação do TypeScript para descrever tipos. A tabela a seguir fornece 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 só podem ser strings. |
number | string |
Um tipo union, 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 (de 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 nem valor de retorno. |
Para saber mais sobre os tipos e expressões de tipo aceitos, 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 denotam uma anotação de tipo. As anotações de tipo descrevem os tipos que o elemento à esquerda do dois-ponto pode aceitar ou retornar. A tabela a seguir mostra exemplos de anotações de tipo que podem aparecer 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 de descanso
que aceita funções. Os parâmetros Rest aceitam um número ilimitado de valores do tipo especificado.
|
googletag
Namespaces | |
---|---|
config | Interface de configuração principal para configurações no nível da página. |
enums | Esse é o namespace que o GPT usa para tipos de enumeração. |
events | Esse é o namespace que o GPT usa para eventos. |
secure | Esse é o namespace que a GPT usa para gerenciar indicadores seguros. |
Interfaces | |
---|---|
Command | A matriz de comando aceita uma sequência de funções e as invoca em ordem. |
Companion | Serviço de anúncios complementares. |
Privacy | Objeto de configuração para configurações de privacidade. |
Pub | Serviço de anúncios do editor. |
Response | Um objeto que representa uma única resposta de anúncio. |
Rewarded | Um objeto que representa a recompensa associada a um anúncio premiado. |
Safe | Objeto de configuração para contêineres do SafeFrame. |
Service | Classe de serviço base que contém métodos comuns para todos os serviços. |
Size | Builder para objetos de especificação de mapeamento de tamanho. |
Slot | O slot é um objeto que representa um único espaço de anúncio em uma página. |
Aliases de tipo | |
---|---|
General | Uma configuração de tamanho válida para um slot, que pode ser um ou vários tamanhos. |
Multi | Uma lista de tamanhos únicos válidos. |
Named | Tamanhos nomeados que um slot pode ter. |
Single | Um único tamanho válido para um slot. |
Single | Matriz de dois números que representam [largura, altura]. |
Size | Um mapeamento do tamanho da janela de visualização para os tamanhos do anúncio. |
Size | Uma lista de mapeamentos de tamanho. |
Variáveis | |
---|---|
api | Flag que indica que a API GPT está carregada e pronta para ser chamada. |
cmd | Referência à fila de comandos global para execução assíncrona de chamadas relacionadas ao GPT. |
pubads | Flag que indica que o PubAdsService está ativado, carregado e totalmente operacional. |
secure | Referência à matriz de provedores de indicadores seguros. |
Funções | |
---|---|
companion | Retorna uma referência ao CompanionAdsService. |
define | Cria um espaço de anúncio fora da página com o caminho do bloco de anúncios fornecido. |
define | Cria um local do anúncio com um determinado caminho e tamanho do bloco de anúncios e o associa ao ID de um elemento div na página que vai conter o anúncio. |
destroy | Destrói os slots fornecidos, removendo todos os objetos e referências relacionados a esses slots do GPT. |
disable | Desativa o Console do Editor do Google. |
display | Instrui os serviços de slot a renderizar o slot. |
enable | Ativa todos os serviços da GPT que foram definidos para os espaços de anúncio na página. |
get | Retorna a versão atual do GPT. |
open | Abre o Console do Editor do Google. |
pubads | Retorna uma referência ao PubAdsService. |
set | Define o título de todos os iframes do contêiner de anúncios criados pela PubAdsService a partir desse ponto. |
set | Define opções de configuração gerais para a página. |
size | Cria um novo SizeMappingBuilder. |
Aliases de tipo
GeneralSize
GeneralSize: SingleSize | MultiSize
Uma configuração de tamanho válida para um slot, que pode ser um ou vários tamanhos.
MultiSize
MultiSize: SingleSize[]
Uma lista de tamanhos únicos válidos.
NamedSize
- fluido: o contêiner de anúncios ocupa 100% da largura do div pai e redimensiona a altura para ajustar o conteúdo do criativo. Assim como os elementos de bloco normais em uma página. Usado para anúncios nativos (consulte o artigo relacionado). Tanto
fluid
quanto['fluid']
são formas aceitáveis para declarar o tamanho de um slot como fluido.
NamedSize: "fluid" | ["fluid"]
Tamanhos nomeados que um slot pode ter. Na maioria dos casos, o tamanho é um retângulo de tamanho fixo, mas há alguns casos em que precisamos de outros tipos de especificações de tamanho. Somente os seguintes tamanhos nomeados são válidos:
SingleSize
SingleSize: SingleSizeArray | NamedSize
Um único tamanho válido para um slot.
SingleSizeArray
SingleSizeArray: [number, number]
Matriz de dois números que representam [largura, altura].
SizeMapping
SizeMapping: [SingleSizeArray, GeneralSize]
Um mapeamento do tamanho da janela de visualização para os tamanhos de anúncios. Usado para anúncios responsivos.
SizeMappingArray
SizeMappingArray: SizeMapping[]
Uma lista de mapeamentos de tamanho.
Variáveis
Const
apiReady
apiReady: boolean | undefined
Flag que indica que a API GPT está carregada e pronta para ser chamada. Essa propriedade será simplesmente undefined
até que a API esteja pronta.
A maneira recomendada de processar o modo assíncrono é usar googletag.cmd para enfileirar callbacks para quando o GPT estiver pronto. Esses callbacks não precisam verificar googletag.apiReady, porque são executados assim que a API é configurada.
Const
cmd
- 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()); });
cmd: ((this: typeof globalThis) => void)[] | CommandArray
Referência à fila de comandos global para execução assíncrona de chamadas relacionadas à GPT.
A variável googletag.cmd
é inicializada como uma matriz JavaScript vazia pela sintaxe da tag GPT na página, e cmd.push
é o método Array.push
padrão que adiciona um elemento ao final da matriz. Quando o JavaScript da GPT é carregado, ele procura na matriz e executa todas as funções em ordem. Em seguida, o script substitui cmd
por um objeto CommandArray cujo método de envio é definido para executar o argumento de função transmitido a ele. Esse mecanismo permite que a GPT reduza a latência percebida ao buscar o JavaScript de forma assíncrona, permitindo que o navegador continue renderizando a página.
Const
pubadsReady
pubadsReady: boolean | undefined
Flag que indica que o PubAdsService está ativado, carregado e totalmente operacional. Essa propriedade será simplesmente undefined
até que enableServices seja chamado e PubAdsService seja carregado e inicializado.
secureSignalProviders
- Exemplo
JavaScript
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { return Promise.resolve("signal"); }, });
JavaScript (legado)
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: function () { return Promise.resolve("signal"); }, });
TypeScript
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { return Promise.resolve("signal"); }, });
- Consulte também
secureSignalProviders: SecureSignalProvider[] | SecureSignalProvidersArray | undefined
Referência à matriz de provedores de indicadores seguros.
A matriz de provedores de indicadores seguros aceita uma sequência de funções geradoras de indicadores e as invoca em ordem. Ele substitui uma matriz padrão usada para enfileirar funções de geração de indicadores que serão invocadas quando o GPT for carregado.
Funções
companionAds
companionAds(): CompanionAdsService
Retorna uma referência ao CompanionAdsService.
Retorna | |
---|---|
CompanionAdsService | O serviço de anúncios complementares. |
defineOutOfPageSlot
- Exemplo
JavaScript
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
JavaScript (legado)
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
TypeScript
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
- Consulte também
defineOutOfPageSlot(adUnitPath: string, div?: string | OutOfPageFormat): Slot | null
Cria um espaço do anúncio fora da página com o caminho do bloco de anúncios.
Para anúncios personalizados fora da página, div
é o ID do elemento div que vai conter o anúncio. Consulte o artigo sobre criativos fora da página para mais detalhes.
Para anúncios fora da página gerenciados pela GPT, div
é um OutOfPageFormat compatível.
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. |
| ID do div que vai conter o bloco de anúncios ou o OutOfPageFormat. |
Retorna | |
---|---|
Slot | null | O slot recém-criado ou null se não for possível criar um slot. |
defineSlot
- Exemplo
JavaScript
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
JavaScript (legado)
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
TypeScript
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
- Consulte também
defineSlot(adUnitPath: string, size: GeneralSize, div?: string): Slot | null
Cria um local do anúncio com um determinado caminho e tamanho do bloco de anúncios e o associa ao ID de um elemento div na página que vai conter o anúncio.
Parâmetros | |
---|---|
adUnitPath: string | Caminho completo do bloco de anúncios com o código de rede e o código do bloco. |
size: GeneralSize | Largura e altura do espaço adicionado. Esse é o tamanho usado na solicitação de anúncio se nenhum mapeamento de tamanho responsivo for fornecido ou se o tamanho da viewport for menor do que o menor tamanho fornecido no mapeamento. |
| ID do div que vai conter o bloco de anúncios. |
Retorna | |
---|---|
Slot | null | O slot recém-criado ou null se não for possível criar um slot. |
destroySlots
- 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();
destroySlots(slots?: Slot[]): boolean
Destrói os slots fornecidos, removendo todos os objetos e referências relacionados a esses slots do GPT. Essa API não oferece suporte a slots de retorno e de complemento.
Chamar essa API em um slot limpa o anúncio e remove o objeto do slot do estado interno mantido pela GPT. Chamar mais funções no objeto de slot resultará em um comportamento indefinido. O navegador ainda pode não liberar a memória associada a esse slot se uma referência a ele for mantida pela página do editor. A chamada dessa API disponibiliza o div associado ao slot para reutilização.
Especificamente, a destruição de um slot remove o anúncio da visualização de página de longa duração do GPT. Assim, as solicitações futuras não serão influenciadas por obstáculos ou exclusões competitivas envolvendo esse anúncio. Se essa função não for chamada antes de remover o div de um slot da página, o comportamento será indefinido.
Parâmetros | |
---|---|
| A matriz de slots a ser destruída. A matriz é opcional. Todos os slots serão destruídos se não forem especificados. |
Retorna | |
---|---|
boolean | true se os slots foram destruídos, false caso contrário. |
disablePublisherConsole
tela
- Consulte também
display(divOrSlot: string | Element | Slot): void
Instrui os serviços de slot a renderizar o slot. Cada espaço de anúncio precisa ser mostrado apenas uma vez por página. Todos os slots precisam ser definidos e ter um serviço associado antes de serem exibidos. A chamada de exibição não pode acontecer até que o elemento esteja presente no DOM. A maneira usual de fazer isso é colocá-lo em um bloco de script no elemento div nomeado na chamada de método.
Se a arquitetura de solicitação única (SRA) estiver sendo usada, todos os espaços de anúncio não buscados no momento em que esse método for chamado serão buscados de uma só vez. Para forçar um espaço de anúncio a não aparecer, o div inteiro precisa ser removido.
Parâmetros | |
---|---|
divOrSlot: string | Element | Slot | O ID do elemento div que contém o slot de anúncio ou o elemento div ou o objeto de slot. Se um elemento div for fornecido, ele precisará ter um atributo "id" que corresponda ao ID transmitido para defineSlot. |
enableServices
getVersion
openConsole
- Exemplo
JavaScript
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
JavaScript (legado)
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
TypeScript
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
- Consulte também
openConsole(div?: string): void
Abre o Console do Editor do Google.
Parâmetros | |
---|---|
| Um ID de div do espaço do anúncio. Este valor é opcional. Quando fornecido, o Console do Editor tenta abrir com os detalhes do espaço de anúncio especificado em exibição. |
pubads
pubads(): PubAdsService
Retorna uma referência ao PubAdsService.
Retorna | |
---|---|
PubAdsService | O serviço de anúncios do editor. |
setAdIframeTitle
- Exemplo
JavaScript
googletag.setAdIframeTitle("title");
JavaScript (legado)
googletag.setAdIframeTitle("title");
TypeScript
googletag.setAdIframeTitle("title");
setAdIframeTitle(title: string): void
Define o título de todos os iframes do contêiner de anúncios criados pela PubAdsService a partir desse ponto.
Parâmetros | |
---|---|
title: string | O novo título para todos os iframes do contêiner de anúncios. |
setConfig
setConfig(config: PageSettingsConfig): void
Define opções de configuração gerais para a página.
Parâmetros | |
---|---|
config: PageSettingsConfig |
sizeMapping
- Consulte também
sizeMapping(): SizeMappingBuilder
Cria um novo SizeMappingBuilder.
Retorna | |
---|---|
SizeMappingBuilder | Um novo builder. |
googletag.CommandArray
Métodos | |
---|---|
push | Executa a sequência de funções especificadas nos argumentos em ordem. |
Métodos
push
- 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()); });
push(...f: ((this: typeof globalThis) => void)[]): number
Executa a sequência de funções especificadas nos argumentos em ordem.
Parâmetros | |
---|---|
| Uma função JavaScript a ser executada. A vinculação de tempo de execução será sempre globalThis . Considere transmitir uma função de seta para manter o valor this do contexto lexical envolvente. |
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
EstendidoMétodos | |
---|---|
add | Registra um listener que permite configurar e chamar uma função JavaScript quando um evento específico da GPT ocorre na página. Herdado de |
get | Receba a lista de horários associados a esse serviço. Herdado de |
remove | Remove um listener registrado anteriormente. Herdado de |
set | Define se os slots complementares que não foram preenchidos serão preenchidos automaticamente. |
- Consulte também
Métodos
setRefreshUnfilledSlots
- Exemplo
JavaScript
googletag.companionAds().setRefreshUnfilledSlots(true);
JavaScript (legado)
googletag.companionAds().setRefreshUnfilledSlots(true);
TypeScript
googletag.companionAds().setRefreshUnfilledSlots(true);
setRefreshUnfilledSlots(value: boolean): void
Define se os slots 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 automático. Somente os slots que também estiverem registrados no PubAdsService serão preenchidos. Devido a restrições de política, esse método não foi projetado para preencher slots complementares vazios quando um vídeo do Ad Exchange é veiculado.
Parâmetros | |
---|---|
value: boolean | true para preencher automaticamente as vagas vazias e false para deixar inalteradas. |
googletag.PrivacySettingsConfig
Propriedades | |
---|---|
child | Indica se a página precisa ser tratada como direcionada a crianças. |
limited | Permite que a veiculação seja executada no modo anúncios limitados para ajudar nas necessidades de conformidade regulamentar do editor. |
non | Permite que a veiculação seja executada no modo anúncios não personalizados para ajudar nas necessidades de compliance regulatória do editor. |
restrict | Permite que a veiculação seja executada no modo de processamento restrito para ajudar nas necessidades de compliance regulatória do editor. |
traffic | Indica se as solicitações representam tráfego orgânico ou comprado. |
under | Indica se as solicitações de anúncios devem ser marcadas como vindas de usuários abaixo da idade de consentimento. |
- Consulte também
Propriedades
Optional
childDirectedTreatment
childDirectedTreatment?: null | boolean
Indica se a página precisa ser tratada como direcionada a crianças. Defina como null
para limpar a configuração.
Optional
limitedAds
- Automaticamente, usando um indicador de uma plataforma de gestão de consentimento do IAB TCF v2.0.
- Manualmente, definindo o valor desse campo como
true
. - Exemplo
JavaScript
// Manually enable limited ads serving. // GPT must be loaded from the limited ads URL to configure this setting. googletag.pubads().setPrivacySettings({ limitedAds: true, });
JavaScript (legado)
// Manually enable limited ads serving. // GPT must be loaded from the limited ads URL to configure this setting. googletag.pubads().setPrivacySettings({ limitedAds: true, });
TypeScript
// Manually enable limited ads serving. // GPT must be loaded from the limited ads URL to configure this setting. googletag.pubads().setPrivacySettings({ limitedAds: true, });
- Consulte também
limitedAds?: boolean
Permite que a veiculação seja executada no modo anúncios limitados para ajudar nas necessidades de conformidade regulatória do editor.
É possível instruir a GPT a solicitar anúncios limitados de duas maneiras:
Não é necessário ativar manualmente os anúncios limitados quando uma CMP está em uso.
Optional
nonPersonalizedAds
nonPersonalizedAds?: boolean
Permite que a veiculação seja executada no modo anúncios não personalizados para ajudar nas necessidades de compliance regulatória do editor.
Optional
restrictDataProcessing
restrictDataProcessing?: boolean
Permite que a veiculação seja executada no modo de processamento restrito para ajudar nas necessidades de compliance regulatória do editor.
Optional
trafficSource
- 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, });
trafficSource?: TrafficSource
Indica se as solicitações representam tráfego orgânico ou comprado. Esse valor preenche a dimensão Origem do tráfego nos relatórios do Ad Manager. Se não for definido, a origem do tráfego vai ser undefined
nos relatórios.
Optional
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
EstendidoMétodos | |
---|---|
add | Registra um listener que permite configurar e chamar uma função JavaScript quando um evento específico da GPT ocorre na página. Herdado de |
clear | Remove os anúncios dos slots especificados e os substitui por conteúdo em branco. |
clear | Limpa todos os rótulos de exclusão de categoria de anúncio no nível da página. |
clear | Limpa os parâmetros de segmentação personalizada de uma chave específica ou de todas as chaves. |
collapse | Permite o fechamento de divs de slot para que elas não ocupem espaço na página quando não há conteúdo de anúncio para exibir. |
disable | Desativa as solicitações de anúncios no carregamento da página, mas permite que os anúncios sejam solicitados com uma chamada PubAdsService.refresh. |
display | Cria e exibe um local do anúncio com o caminho e o tamanho do bloco de anúncios. |
enable | Ativa o carregamento lento no GPT, conforme definido pelo objeto de configuração. |
enable | Ativa o modo de solicitação única para buscar vários anúncios ao mesmo tempo. |
enable | Indica à GPT que os anúncios em vídeo vão aparecer na página. |
get | Retorna o valor do atributo do Google AdSense associado à chave fornecida. |
get | Retorna as chaves de atributo definidas neste serviço. |
get | Receba a lista de horários associados a esse serviço. Herdado de |
get | Retorna um parâmetro de segmentação personalizada no nível do serviço que foi definido. |
get | Retorna a lista de todas as chaves de segmentação personalizadas no nível do serviço que foram definidas. |
is | Retorna se as solicitações iniciais de anúncios foram desativadas por uma chamada PubAdsService.disableInitialLoad anterior. |
refresh | Busca e exibe novos anúncios para espaços específicos ou todos os espaços na página. |
remove | Remove um listener registrado anteriormente. Herdado de |
set | Define valores para atributos do Google AdSense que se aplicam a todos os espaços de anúncio no serviço de anúncios do editor. |
set | Define uma exclusão da categoria do anúncio no nível da página para o nome do rótulo fornecido. |
set | Ativa e desativa o alinhamento horizontal dos anúncios. |
set | Configura se todos os anúncios na página precisam ser renderizados usando um contêiner do SafeFrame. |
set | Transmite informações de local de sites para que você possa segmentar itens de linha por geolocalização em locais específicos. |
set | Permite a configuração de todas as configurações de privacidade de uma única API usando um objeto de configuração. |
set | Define o valor do ID fornecido pelo editor. |
set | Define as preferências no nível da página para a configuração do SafeFrame. |
set | Define parâmetros de segmentação personalizada para uma determinada chave que se aplica a todos os espaços de anúncios do serviço de anúncios do editor. |
set | Define as informações do conteúdo em vídeo a serem enviadas com as solicitações de anúncio para fins de segmentação e exclusão de conteúdo. |
update | Muda o correlator enviado com as solicitações de anúncio, iniciando uma nova visualização de página. |
Métodos
clear
- 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();
clear(slots?: Slot[]): boolean
Remove os anúncios dos slots especificados e os substitui por conteúdo em branco. Os slots serão marcados como não buscados.
Especificamente, a limpeza de um slot remove o anúncio da visualização de página de longa duração da GPT. Assim, as solicitações futuras não serão influenciadas por obstáculos ou exclusões competitivas envolvendo esse anúncio.
Parâmetros | |
---|---|
| A matriz de slots a ser limpa. A matriz é opcional. Todos os slots serão limpos se não forem especificados. |
Retorna | |
---|---|
boolean | Retorna true se os slots foram limpos ou false . |
clearCategoryExclusions
- Exemplo
JavaScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
JavaScript (legado)
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
TypeScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
- Consulte também
clearCategoryExclusions(): PubAdsService
Limpa todos os rótulos de exclusão de categoria de anúncio no nível da página. Isso é útil se você quiser atualizar o slot.
Retorna | |
---|---|
PubAdsService | O objeto de serviço em que o método foi chamado. |
clearTargeting
- Exemplo
JavaScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
JavaScript (legado)
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
TypeScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
- Consulte também
clearTargeting(key?: string): PubAdsService
Limpa os parâmetros de segmentação personalizada de uma chave específica ou de todas as chaves.
Parâmetros | |
---|---|
| Chave do parâmetro de segmentação. A chave é opcional. Todos os parâmetros de segmentação serão limpos se ela não for especificada. |
Retorna | |
---|---|
PubAdsService | O objeto de serviço em que o método foi chamado. |
collapseEmptyDivs
- Consulte também
collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean
Permite o fechamento de divs de slot para que elas não ocupem espaço na página quando não há conteúdo do anúncio para exibir. Esse modo precisa ser definido antes da ativação do serviço.
Parâmetros | |
---|---|
| Indica se os slots vão ser fechados antes mesmo da busca dos anúncios. Esse parâmetro é opcional. Se não for fornecido, false será usado como o valor padrão. |
Retorna | |
---|---|
boolean | Retorna true se o modo de colapso de div foi ativado e false se for impossível ativar o modo de colapso porque o método foi chamado depois que o serviço foi ativado. |
disableInitialLoad
disableInitialLoad(): void
Desativa as solicitações de anúncios no carregamento da página, mas permite que os anúncios sejam solicitados com uma chamada PubAdsService.refresh. Isso precisa ser definido antes de ativar o serviço. O modo assíncrono precisa ser usado. Caso contrário, será impossível solicitar anúncios usando refresh
.
tela
- 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");
display(adUnitPath: string, size: GeneralSize, div?: string | Element, clickUrl?: string): void
Cria e exibe um local do anúncio com o caminho e o tamanho do bloco de anúncios. Esse método não funciona com o modo de solicitação única.
Observação:quando esse 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. Todas as mudanças feitas no slot ou no estado da página após a chamada desse método (incluindo segmentação, configurações de privacidade, ativação do SafeFrame etc.) só serão aplicadas a solicitações display()
ou refresh()
subsequentes.
Parâmetros | |
---|---|
adUnitPath: string | O caminho do bloco de anúncios do slot a ser renderizado. |
size: GeneralSize | Largura e altura do slot. |
| O ID do div que contém o slot ou o próprio elemento div. |
| O URL de clique a ser usado neste slot. |
enableLazyLoad
- Exemplo
JavaScript
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
JavaScript (legado)
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
TypeScript
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
- Consulte também
fetchMarginPercent
A distância mínima da janela de visualização atual que um slot precisa ter antes de buscar o anúncio como uma porcentagem do tamanho da janela de visualização. Um valor de 0 significa "quando o slot entra na viewport", 100 significa "quando o anúncio está a uma viewport de distância" e assim por diante.renderMarginPercent
A distância mínima da janela de visualização atual que um slot precisa ter antes de renderizar um anúncio. Isso permite o pré-carregamento do anúncio, mas aguardando a renderização e o download de outros subrecursos. O valor funciona comofetchMarginPercent
como uma porcentagem da viewport.mobileScaling
Um multiplicador aplicado às margens em dispositivos móveis. Isso permite margens variáveis em dispositivos móveis e computadores. Por exemplo, um valor de 2,0 vai multiplicar todas as margens por 2 em dispositivos móveis, aumentando a distância mínima que um slot pode ter antes de buscar e renderizar.
enableLazyLoad(config?: {
fetchMarginPercent?: number;
mobileScaling?: number;
renderMarginPercent?: number;
}): void
Ativa o carregamento lento no GPT, conforme definido pelo objeto de configuração. Para conferir exemplos mais detalhados, consulte o exemplo de Carregamento lento.
Observação:a busca lenta no SRA só funciona se todos os slots estiverem fora da margem de busca.
Parâmetros | |
---|---|
| O objeto de configuração permite a personalização do comportamento preguiçoso. As configurações omitidas vão usar um padrão definido pelo Google que será ajustado ao longo do tempo. Para desativar uma configuração específica, como uma margem de busca, defina o valor como -1 . |
enableSingleRequest
- Consulte também
enableSingleRequest(): boolean
Ativa o modo de solicitação única para buscar vários anúncios ao mesmo tempo. Para isso, todos os espaços de anúncios do editor precisam ser definidos e adicionados ao PubAdsService antes de ativar o serviço. O modo de solicitação única precisa ser definido antes da ativação do serviço.
Retorna | |
---|---|
boolean | Retorna true se o modo de solicitação única foi ativado e false se for impossível ativar o modo de solicitação única porque o método foi chamado depois que o serviço foi ativado. |
enableVideoAds
enableVideoAds(): void
Indica à GPT que os anúncios em vídeo vão aparecer na página. Isso ativa as restrições de exclusão competitiva em anúncios gráficos e em vídeo. Se o conteúdo do vídeo for conhecido, chame PubAdsService.setVideoContent para poder usar a exclusão de conteúdo em anúncios de display.
get
- Exemplo
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
JavaScript (legado)
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
TypeScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
- Consulte também
get(key: string): null | string
Retorna o valor do atributo do Google AdSense associado à chave fornecida.
Parâmetros | |
---|---|
key: string | Nome do atributo a ser procurado. |
Retorna | |
---|---|
null | string | O valor atual da chave do atributo ou null se a chave não estiver presente. |
getAttributeKeys
- 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'].
getAttributeKeys(): string[]
Retorna as chaves de atributo definidas neste serviço.
Retorna | |
---|---|
string[] | Matriz de chaves de atributo definidas neste serviço. A ordem é indefinida. |
getTargeting
- 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).
getTargeting(key: string): string[]
Retorna um parâmetro de segmentação personalizada no nível do serviço que foi definido.
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
- 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'].
getTargetingKeys(): string[]
Retorna a lista de todas as chaves de segmentação personalizadas no nível do serviço que foram definidas.
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 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 . |
atualizar
- Exemplo
JavaScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
JavaScript (legado)
var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
TypeScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!; googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!; googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
- Consulte também
changeCorrelator
Especifica se um novo correlator precisa ser gerado para buscar anúncios. Nossos servidores de anúncios mantêm esse valor de correlação por um breve período (atualmente 30 segundos, mas sujeito a mudanças). Assim, as solicitações com o mesmo correlator recebidas em intervalos próximos são consideradas uma única visualização de página. Por padrão, um novo correlator é gerado para cada atualização.
Observação:essa opção não afeta a visualização de página de longa duração do GPT, que reflete automaticamente os anúncios que estão na página e não tem tempo de expiração.
refresh(slots?: null | Slot[], options?: {
changeCorrelator: boolean;
}): void
Busca e exibe novos anúncios para espaços específicos ou todos os espaços na página. Funciona apenas no modo de renderização assíncrona.
Para um comportamento adequado em todos os navegadores, a chamada de refresh
precisa ser precedida por uma chamada para display
o slot de anúncio. Se a chamada para display
for omitida, a atualização poderá apresentar um comportamento inesperado. Se desejar, o método PubAdsService.disableInitialLoad pode ser usado para impedir que display
busque um anúncio.
A atualização de um slot remove o anúncio antigo da visualização de página de longa duração do GPT. Assim, as solicitações futuras não serão influenciadas por obstáculos ou exclusões competitivas que envolvam esse anúncio.
Parâmetros | |
---|---|
| Os slots a serem atualizados. A matriz é opcional. Todos os slots serão atualizados se não forem especificados. |
| Opções de configuração associadas a esta chamada de atualização. |
set
- Exemplo
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF");
JavaScript (legado)
googletag.pubads().set("adsense_background_color", "#FFFFFF");
TypeScript
googletag.pubads().set("adsense_background_color", "#FFFFFF");
- Consulte também
set(key: string, value: string): PubAdsService
Define valores para atributos do Google AdSense que se aplicam a todos os espaços de anúncio no serviço de anúncios do editor.
Chamar esse método mais de uma vez para a mesma chave vai substituir os valores definidos anteriormente para essa chave. Todos os valores precisam ser definidos antes de chamar display
ou refresh
.
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
- Exemplo
JavaScript
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
JavaScript (legado)
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
TypeScript
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
- Consulte também
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 fornecido.
Parâmetros | |
---|---|
categoryExclusion: string | O rótulo de exclusão da categoria de anúncios a ser adicionado. |
Retorna | |
---|---|
PubAdsService | O objeto de serviço em que o método foi chamado. |
setCentering
- 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);
setCentering(centerAds: boolean): void
Ativa e desativa o alinhamento horizontal dos anúncios. A centralização fica desativada por padrão. No gpt_mobile.js legado, o alinhamento central está ativado por padrão.
Esse método precisa ser invocado antes de chamar display
ou refresh
, porque apenas os anúncios solicitados após a chamada desse método serão centralizados.
Parâmetros | |
---|---|
centerAds: boolean | true para centralizar os anúncios e false para alinhar à esquerda. |
setForceSafeFrame
- Essa configuração só vai entrar em vigor para solicitações de anúncios posteriores feitas nos respectivos slots.
- A configuração do slot, se especificada, sempre vai substituir a configuração da página.
- Se definido como
true
(no nível do slot ou da página), o anúncio será renderizado sempre usando um contêiner do SafeFrame, independente da escolha feita na interface do Google Ad Manager. - No entanto, se for definido como
false
ou não especificado, o anúncio será renderizado usando um contêiner do SafeFrame, dependendo do tipo de criativo e da seleção feita na interface do Google Ad Manager. - Essa API precisa ser usada com cuidado, porque pode afetar o comportamento de criativos que tentam sair dos iFrames ou dependem deles para serem renderizados diretamente na 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");
- Consulte também
setForceSafeFrame(forceSafeFrame: boolean): PubAdsService
Configura se todos os anúncios na página precisam ser renderizados usando um contêiner do SafeFrame.
Considere o seguinte ao usar essa API:
Parâmetros | |
---|---|
forceSafeFrame: boolean | true para forçar a renderização de todos os anúncios na página em SafeFrames e false para mudar a configuração anterior para "false". Definir esse valor como false quando não for especificado antes não vai mudar nada. |
Retorna | |
---|---|
PubAdsService | O objeto de serviço em que a função foi chamada. |
setLocation
- 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");
setLocation(address: string): PubAdsService
Transmite informações de local de sites para que você possa segmentar itens de linha por geolocalização em locais específicos.
Parâmetros | |
---|---|
address: string | Endereço com formato livre. |
Retorna | |
---|---|
PubAdsService | O objeto de serviço em que o método foi chamado. |
setPrivacySettings
- 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, });
setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService
Permite a configuração de todas as configurações de privacidade de uma única API usando um objeto de configuração.
Parâmetros | |
---|---|
privacySettings: PrivacySettingsConfig | Objeto que contém a configuração de configurações de privacidade. |
Retorna | |
---|---|
PubAdsService | O objeto de serviço em que a função foi chamada. |
setPublisherProvidedId
- Exemplo
JavaScript
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
JavaScript (legado)
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
TypeScript
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
- Consulte também
setPublisherProvidedId(ppid: string): PubAdsService
Define o valor do ID fornecido pelo editor.
Parâmetros | |
---|---|
ppid: string | Um ID 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
- Exemplo
JavaScript
googletag.pubads().setForceSafeFrame(true); const pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; const slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript (legado)
googletag.pubads().setForceSafeFrame(true); var pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; var slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
TypeScript
googletag.pubads().setForceSafeFrame(true); const pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; const slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
- Consulte também
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. A configuração inteira 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 slot, se especificadas.
Parâmetros | |
---|---|
config: SafeFrameConfig | O objeto de configuração. |
Retorna | |
---|---|
PubAdsService | O objeto de serviço em que o método foi chamado. |
setTargeting
- Exemplo
JavaScript
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
JavaScript (legado)
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
TypeScript
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
- Consulte também
setTargeting(key: string, value: string | string[]): PubAdsService
Define parâmetros de segmentação personalizada para uma determinada chave que se aplicam a todos os espaços de anúncios do serviço de anúncios do editor. Chamar esse método várias vezes para a mesma chave vai substituir os valores antigos. Essas chaves são definidas na sua conta do Google Ad Manager.
Parâmetros | |
---|---|
key: string | Chave do parâmetro de segmentação. |
value: string | string[] | Valor do parâmetro de segmentação ou matriz de valores. |
Retorna | |
---|---|
PubAdsService | O objeto de serviço em que o método foi chamado. |
setVideoContent
- Consulte também
setVideoContent(videoContentId: string, videoCmsId: string): void
Define as informações do conteúdo em vídeo a serem enviadas com as solicitações de anúncio para fins de segmentação e exclusão de conteúdo. Os anúncios em vídeo serão ativados automaticamente quando esse método for chamado. Para videoContentId
e videoCmsId
, use os valores fornecidos ao serviço de transferência de conteúdo do Google Ad Manager.
Parâmetros | |
---|---|
videoContentId: string | O ID do conteúdo do vídeo. |
videoCmsId: string | O ID do CMS do vídeo. |
updateCorrelator
- 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.
updateCorrelator(): PubAdsService
Muda o correlator enviado com as solicitações de anúncio, iniciando uma nova visualização de página. O correlator é o mesmo para todas as solicitações de anúncios provenientes de uma visualização de página e exclusivo em visualizações de página. Isso se aplica apenas ao modo assíncrono.
Observação:isso não afeta a visualização de página de longa duração da GPT, que reflete automaticamente os anúncios que estão na página e não tem tempo de expiração.
Retorna | |
---|---|
PubAdsService | O objeto de serviço em que a função foi chamada. |
googletag.ResponseInformation
Propriedades | |
---|---|
advertiser | O ID do anunciante. |
campaign | O ID da campanha. |
creative | O ID do criativo. |
creative | O ID do modelo do anúncio. |
line | O ID do item de linha. |
- Consulte também
Propriedades
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
Propriedades | |
---|---|
amount | O número de itens incluídos na recompensa. |
type | O tipo de item incluído na recompensa (por exemplo, "moeda"). |
- Consulte também
Propriedades
amount
amount: number
O número de itens incluídos na recompensa.
type
type: string
O tipo de item incluído na recompensa (por exemplo, "moeda").
googletag.SafeFrameConfig
Propriedades | |
---|---|
allow | Define se o SafeFrame pode permitir que o conteúdo do anúncio seja expandido sobrepondo o conteúdo da página. |
allow | Define se o SafeFrame precisa permitir que o conteúdo do anúncio seja expandido empurrando o conteúdo da página. |
sandbox | Define se o SafeFrame precisa usar o atributo sandbox do HTML5 para impedir a navegação de nível superior sem a interação do usuário. |
use | Obsoleto. Se o SafeFrame precisa usar subdomínios aleatórios para criativos de reserva. |
- Consulte também
Propriedades
Optional
allowOverlayExpansion
allowOverlayExpansion?: boolean
Define se o SafeFrame pode permitir que o conteúdo do anúncio seja expandido sobrepondo o conteúdo da página.
Optional
allowPushExpansion
allowPushExpansion?: boolean
Define se o SafeFrame precisa permitir que o conteúdo do anúncio seja expandido empurrando o conteúdo da página.
Optional
sandbox
sandbox?: boolean
Define se o SafeFrame precisa usar o atributo sandbox do HTML5 para impedir a navegação de nível superior sem a interação do usuário. O único valor válido é true
(não pode ser forçado para false
). O atributo sandbox desativa plug-ins (por exemplo, Flash).
Optional
useUniqueDomain
- Consulte também
useUniqueDomain?: null | boolean
Se o SafeFrame precisa usar subdomínios aleatórios para criativos de reserva. Transmita null
para limpar o valor armazenado.
Observação: esse recurso está ativado por padrão.
googletag.Service
Métodos | |
---|---|
add | Registra um listener que permite configurar e chamar uma função JavaScript quando um evento específico da GPT ocorre na página. |
get | Receba a lista de horários associados a esse serviço. |
remove | Remove um listener registrado anteriormente. |
Métodos
addEventListener
- events.GameManualInterstitialSlotClosedEvent
- events.GameManualInterstitialSlotReadyEvent
- events.ImpressionViewableEvent
- events.RewardedSlotClosedEvent
- events.RewardedSlotGrantedEvent
- events.RewardedSlotReadyEvent
- events.SlotOnloadEvent
- events.SlotRenderEndedEvent
- events.SlotRequestedEvent
- events.SlotResponseReceived
- events.SlotVisibilityChangedEvent
- Exemplo
JavaScript
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", (event) => { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { if (event.slot === targetSlot) { // Slot specific logic. } });
JavaScript (legado)
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", function (event) { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", function (event) { if (event.slot === targetSlot) { // Slot specific logic. } });
TypeScript
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", (event) => { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { if (event.slot === targetSlot) { // Slot specific logic. } });
- Consulte também
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 ocorre na página. Os seguintes eventos são compatíveis:
Parâmetros | |
---|---|
eventType: K | Uma string que representa o tipo de evento gerado pelo 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
removeEventListener
- 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(); });
removeEventListener<K extends keyof EventTypeMap>(eventType: K, listener: ((event: EventTypeMap[K]) => void)): void
Remove um listener registrado anteriormente.
Parâmetros | |
---|---|
eventType: K | Uma string que representa o tipo de evento gerado pelo 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
Métodos | |
---|---|
add | Adiciona um mapeamento de uma matriz de tamanho único (que representa a viewport) para uma matriz de tamanho único ou múltiplo que representa o slot. |
build | Cria uma especificação de mapa de tamanho com base nos mapeamentos adicionados a esse builder. |
- Consulte também
Métodos
addSize
- 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]
addSize(viewportSize: SingleSizeArray, slotSize: GeneralSize): SizeMappingBuilder
Adiciona um mapeamento de uma matriz de tamanho único (que representa a viewport) para uma matriz de tamanho único ou múltiplo que representa o slot.
Parâmetros | |
---|---|
viewportSize: SingleSizeArray | O tamanho da janela de visualização para essa entrada de mapeamento. |
slotSize: GeneralSize | Os tamanhos do slot para esta entrada de mapeamento. |
Retorna | |
---|---|
SizeMappingBuilder | Uma referência a esse builder. |
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, ele retorna uma especificação no formato correto para transmitir a Slot.defineSizeMapping.
Observação: o comportamento do builder após a chamada desse método é indefinido.
Retorna | |
---|---|
null | SizeMappingArray | O resultado criado por este builder. Pode ser nulo se mapeamentos de tamanho inválidos forem fornecidos. |
googletag.Slot
Métodos | |
---|---|
add | Adiciona um serviço a este slot. |
clear | Limpa todos os rótulos de exclusão de categoria de anúncio no nível do slot para esse slot. |
clear | Limpa parâmetros de segmentação específicos ou todos os personalizados no nível do slot para esse slot. |
define | Define uma matriz de mapeamentos de um tamanho mínimo de janela de visualização para o tamanho do slot. |
get | Retorna o valor do atributo do Google AdSense associado à chave fornecida para esse slot. |
get | Retorna o caminho completo do bloco de anúncios, com o código de rede e o caminho do bloco de anúncios. |
get | Retorna a lista de chaves de atributo definidas neste slot. |
get | Retorna os rótulos de exclusão de categoria de anúncios para esse slot. |
get | Retorna as informações de resposta do anúncio. |
get | Retorna o ID do slot div fornecido quando o slot foi definido. |
get | Retorna um parâmetro de segmentação personalizada específico definido neste slot. |
get | Retorna a lista de todas as chaves de segmentação personalizadas definidas neste slot. |
set | Define um valor para um atributo do Google AdSense nesse espaço. |
set | Define um rótulo de exclusão de categoria do anúncio no nível do espaço. |
set | Define o URL de clique para onde os usuários serão redirecionados após clicar no anúncio. |
set | Define se o slot div precisa ser ocultado quando não há um anúncio nele. |
set | Define opções de configuração gerais para este slot. |
set | Configura se os anúncios nesse slot precisam ser renderizados usando um contêiner do SafeFrame. |
set | Define as preferências no nível do slot para a configuração do SafeFrame. |
set | Define um parâmetro de segmentação personalizada para esse slot. |
update | Define parâmetros de segmentação personalizada para esse slot, a partir de um mapa de chave-valor em um objeto JSON. |
Métodos
addService
- Exemplo
JavaScript
googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());
JavaScript (legado)
googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());
TypeScript
googletag.defineSlot("/1234567/sports", [160, 600], "div")!.addService(googletag.pubads());
- Consulte também
addService(service: Service): Slot
Adiciona um serviço a este slot.
Parâmetros | |
---|---|
service: Service | O serviço a ser adicionado. |
Retorna | |
---|---|
Slot | O objeto de slot em que o método foi chamado. |
clearCategoryExclusions
- 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.
clearCategoryExclusions(): Slot
Limpa todos os rótulos de exclusão de categoria de anúncio no nível do slot para esse slot.
Retorna | |
---|---|
Slot | O objeto de slot em que o método foi chamado. |
clearTargeting
- Exemplo
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
JavaScript (legado)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
- Consulte também
clearTargeting(key?: string): Slot
Limpa parâmetros de segmentação específicos ou todos os personalizados no nível do slot para esse slot.
Parâmetros | |
---|---|
| Chave do parâmetro de segmentação. A chave é opcional. Todos os parâmetros de segmentação serão limpos se ela não for especificada. |
Retorna | |
---|---|
Slot | O objeto de slot em que o método foi chamado. |
defineSizeMapping
- Exemplo
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); const mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ], ) .build(); slot.defineSizeMapping(mapping);
JavaScript (legado)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); var mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ], ) .build(); slot.defineSizeMapping(mapping);
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); const mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ], ) .build(); slot.defineSizeMapping(mapping!);
- Consulte também
defineSizeMapping(sizeMapping: SizeMappingArray): Slot
Define uma matriz de mapeamentos de um tamanho mínimo de janela de visualização para o tamanho do slot.
Parâmetros | |
---|---|
sizeMapping: SizeMappingArray | Matriz de mapeamentos de tamanho. Use SizeMappingBuilder para criar o mapa. 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
- Exemplo
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
JavaScript (legado)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
- Consulte também
get(key: string): null | string
Retorna o valor do atributo do Google AdSense associado à chave fornecida para esse slot. Para conferir os atributos de nível de serviço herdados por esse slot, use PubAdsService.get.
Parâmetros | |
---|---|
key: string | Nome do atributo a ser procurado. |
Retorna | |
---|---|
null | string | O valor atual da chave do atributo ou null se a chave não estiver presente. |
getAdUnitPath
- 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'.
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.
Retorna | |
---|---|
string | Caminho do bloco de anúncios. |
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'].
getAttributeKeys(): string[]
Retorna a lista de chaves de atributo definidas neste slot. Para conferir as chaves dos atributos de nível de serviço herdados por esse slot, use PubAdsService.getAttributeKeys.
Retorna | |
---|---|
string[] | Matriz de chaves de atributo. A ordem é indefinida. |
getCategoryExclusions
- 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'].
getCategoryExclusions(): string[]
Retorna os rótulos de exclusão de categoria de anúncios para esse slot.
Retorna | |
---|---|
string[] | Os rótulos de exclusão de categoria de anúncios para esse slot ou uma matriz vazia se nenhum foi definido. |
getResponseInformation
getResponseInformation(): null | ResponseInformation
Retorna as informações de resposta do anúncio. Isso é baseado na última resposta do anúncio para o espaço. Se isso for chamado quando o slot não tiver um anúncio, null
será retornado.
Retorna | |
---|---|
null | ResponseInformation | As informações mais recentes sobre a resposta do anúncio ou null se o espaço não tiver nenhum anúncio. |
getSlotElementId
- 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'.
getSlotElementId(): string
Retorna o ID do slot div
fornecido quando o slot foi definido.
Retorna | |
---|---|
string | ID do slot div . |
getTargeting
- 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).
getTargeting(key: string): string[]
Retorna um parâmetro de segmentação personalizada específico definido neste slot. Os parâmetros de segmentação no nível do serviço não estão incluídos.
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
- 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'].
getTargetingKeys(): string[]
Retorna a lista de todas as chaves de segmentação personalizadas definidas neste slot. As chaves de segmentação no nível do serviço não estão incluídas.
Retorna | |
---|---|
string[] | Matriz de chaves de segmentação. A ordem é indefinida. |
set
- Exemplo
JavaScript
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
JavaScript (legado)
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
TypeScript
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
- Consulte também
set(key: string, value: string): Slot
Define um valor para um atributo do Google AdSense nesse espaço. Isso vai substituir todos os valores definidos no nível do serviço para essa chave.
Chamar esse método mais de uma vez para a mesma chave vai substituir os valores definidos anteriormente para essa chave. Todos os valores precisam ser definidos antes de chamar display
ou refresh
.
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
- Exemplo
JavaScript
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
JavaScript (legado)
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
TypeScript
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
- Consulte também
setCategoryExclusion(categoryExclusion: string): Slot
Define um rótulo de exclusão de categoria do anúncio no nível do espaço.
Parâmetros | |
---|---|
categoryExclusion: string | O rótulo de exclusão da categoria de anúncios a ser adicionado. |
Retorna | |
---|---|
Slot | O objeto de slot em que o método foi chamado. |
setClickUrl
- 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());
setClickUrl(value: string): Slot
Define o URL de clique para onde os usuários serão redirecionados depois de clicar no anúncio.
Os servidores do Google Ad Manager ainda registram um clique, mesmo que o URL de clique seja substituído. Qualquer URL da página de destino associado ao criativo veiculado é anexado ao valor fornecido. As chamadas subsequentes substituem o valor. Isso funciona apenas para solicitações que não são de SRA.
Parâmetros | |
---|---|
value: string | O URL do clique a ser definido. |
Retorna | |
---|---|
Slot | O objeto de slot em que o método foi chamado. |
setCollapseEmptyDiv
- Exemplo
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2") .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
JavaScript (legado)
googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2") .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
TypeScript
googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2")! .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
- Consulte também
setCollapseEmptyDiv(collapse: boolean, collapseBeforeAdFetch?: boolean): Slot
Define se o slot div
precisa ser ocultado quando não há um anúncio nele. Isso substitui as configurações no nível do serviço.
Parâmetros | |
---|---|
collapse: boolean | Se o slot será recolhido se nenhum anúncio for retornado. |
| Se o slot será fechado antes mesmo de um anúncio ser buscado. Será ignorado se o colapso não for true . |
Retorna | |
---|---|
Slot | O objeto de slot em que o método foi chamado. |
setConfig
setConfig(slotConfig: SlotSettingsConfig): void
Define opções de configuração gerais para este slot.
Parâmetros | |
---|---|
slotConfig: SlotSettingsConfig | O objeto de configuração. |
setForceSafeFrame
- Essa configuração só vai entrar em vigor para solicitações de anúncios posteriores feitas nos respectivos slots.
- A configuração do slot, se especificada, sempre vai substituir a configuração da página.
- Se definido como
true
(no nível do slot ou da página), o anúncio será renderizado sempre usando um contêiner do SafeFrame, independente da escolha feita na interface do Google Ad Manager. - No entanto, se for definido como
false
ou não especificado, o anúncio será renderizado usando um contêiner do SafeFrame, dependendo do tipo de criativo e da seleção feita na interface do Google Ad Manager. - Essa API precisa ser usada com cuidado, porque pode afetar o comportamento de criativos que tentam sair dos iFrames ou dependem deles para serem renderizados diretamente na 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());
- Consulte também
setForceSafeFrame(forceSafeFrame: boolean): Slot
Define se os anúncios nesse slot precisam ser renderizados usando um contêiner do SafeFrame.
Considere o seguinte ao usar essa API:
Parâmetros | |
---|---|
forceSafeFrame: boolean | true para forçar a renderização de todos os anúncios nesse slot em SafeFrames e false para desativar uma configuração no nível da página (se houver). Definir esse valor como false quando não for 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
- Exemplo
JavaScript
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript (legado)
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
TypeScript
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
- Consulte também
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. A configuração inteira será ignorada se um valor inválido for transmitido para uma chave reconhecida.
Essas preferências no nível do slot, se especificadas, vão substituir todas as preferências no nível da página.
Parâmetros | |
---|---|
config: null | SafeFrameConfig | O objeto de configuração. |
Retorna | |
---|---|
Slot | O objeto de slot em que o método foi chamado. |
setTargeting
- Exemplo
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
JavaScript (legado)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
- Consulte também
setTargeting(key: string, value: string | string[]): Slot
Define um parâmetro de segmentação personalizada para esse slot. Chamar esse método várias vezes para a mesma chave vai substituir os valores antigos. Os valores definidos aqui vão substituir os parâmetros de segmentação definidos no nível do serviço. Essas chaves são definidas na sua conta do Google Ad Manager.
Parâmetros | |
---|---|
key: string | Chave do parâmetro de segmentação. |
value: string | string[] | Valor do parâmetro de segmentação ou matriz de valores. |
Retorna | |
---|---|
Slot | O objeto de slot em que o método foi chamado. |
updateTargetingFromMap
- 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 combinado.
- Os valores definidos aqui vão substituir os parâmetros de segmentação definidos no nível do serviço.
- Exemplo
JavaScript
const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div"); slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
JavaScript (legado)
var slot = googletag.defineSlot("/1234567/sports", [160, 600], "div"); slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
TypeScript
const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!; slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
updateTargetingFromMap(map: {
[adUnitPath: string]: string | string[];
}): Slot
Define parâmetros de segmentação personalizada para esse slot, a partir de um mapa de chave-valor em um objeto JSON. Isso é o mesmo que chamar Slot.setTargeting para todos os valores de chave do objeto. Essas chaves são definidas na sua conta do Google Ad Manager.
Observações:
Parâmetros | |
---|---|
map: { | 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
Interfaces | |
---|---|
Ad | Configurações para controlar a expansão do anúncio. |
Component | Um objeto que representa um leilão de único componente em um leilão de anúncios no dispositivo. |
Interstitial | Um objeto que define o comportamento de um único slot de anúncio intersticial. |
Page | Interface de configuração principal para configurações no nível da página. |
Privacy | Configurações para controlar os tratamentos de privacidade do editor. |
Publisher | Objeto de configuração dos indicadores fornecidos pelo editor (PPS, na sigla em inglês). |
Slot | Interface de configuração principal para configurações no nível do slot. |
Taxonomy | Um objeto que contém os valores de uma única taxonomia. |
Aliases de tipo | |
---|---|
Interstitial | Acionadores de anúncios intersticiais aceitos. |
Privacy | Tratamentos de privacidade do editor com suporte. |
Taxonomy | Taxonomias compatíveis com indicadores fornecidos pelo editor (PPS). |
Aliases de tipo
InterstitialTrigger
InterstitialTrigger: "unhideWindow" | "navBar"
Acionadores de anúncios intersticiais aceitos.
PrivacyTreatment
PrivacyTreatment: "disablePersonalization"
Tratamentos de privacidade do editor com suporte.
Taxonomia
- Consulte também
Taxonomy: "IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"
Taxonomias compatíveis com indicadores fornecidos pelo editor (PPS).
googletag.config.AdExpansionConfig
Propriedades | |
---|---|
enabled | Indica se a expansão de anúncios está ativada ou desativada. |
- Exemplo
JavaScript
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
JavaScript (legado)
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
TypeScript
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
Propriedades
Optional
ativado
enabled?: null | boolean
Indica se a expansão de anúncios está ativada ou desativada.
A configuração desse valor substitui o padrão definido no Google Ad Manager.
googletag.config.ComponentAuctionConfig
Propriedades | |
---|---|
auction | Um objeto de configuração de leilão para este leilão de componentes. |
config | A chave de configuração associada a esse leilão de componentes. |
Propriedades
auctionConfig
- 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, }, ], });
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 esse leilão de componentes.
Se esse valor for definido como null
, qualquer configuração atual do configKey
especificado será excluída.
configKey
configKey: string
A chave de configuração associada a esse leilão de componentes.
Esse valor precisa ser preenchido e ser exclusivo. Se dois objetos ComponentAuctionConfig
compartilharem o mesmo valor de configKey, o último a ser definido vai substituir as configurações anteriores.
googletag.config.InterstitialConfig
Propriedades | |
---|---|
require | Indica se o consentimento de armazenamento local é necessário para mostrar este anúncio intersticial. |
triggers | A configuração do acionador intersticial para este anúncio. |
Propriedades
Optional
requireStorageAccess
- Exemplo
JavaScript
// Opt out of showing interstitials to users // without local storage consent. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, ); interstitialSlot.setConfig({ interstitial: { requireStorageAccess: true, // defaults to false }, });
JavaScript (legado)
// Opt out of showing interstitials to users // without local storage consent. var interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, ); interstitialSlot.setConfig({ interstitial: { requireStorageAccess: true, // defaults to false }, });
TypeScript
// Opt out of showing interstitials to users // without local storage consent. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, )!; interstitialSlot.setConfig({ interstitial: { requireStorageAccess: true, // defaults to false }, });
- Consulte também
requireStorageAccess?: null | boolean
Se o consentimento para armazenamento local é necessário para exibir esse anúncio intersticial.
A GPT usa o armazenamento local para aplicar um limite de frequência aos anúncios intersticiais. No entanto, os usuários que não deram consentimento para armazenamento local ainda estão qualificados para receber anúncios intersticiais. A configuração dessa propriedade como true
desativa o comportamento padrão e garante que os anúncios intersticiais sejam mostrados apenas para usuários que deram consentimento para armazenamento local.
Optional
gatilhos
- Exemplo
JavaScript
// Define a GPT managed web interstitial ad slot. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, ); // Enable optional interstitial triggers. // Change this value to false to disable. const enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
JavaScript (legado)
// Define a GPT managed web interstitial ad slot. var interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, ); // Enable optional interstitial triggers. // Change this value to false to disable. var enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
TypeScript
// Define a GPT managed web interstitial ad slot. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL, )!; // Enable optional interstitial triggers. // Change this value to false to disable. const enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
- Consulte também
triggers?: null | Partial<Record<InterstitialTrigger, boolean>>
A configuração do gatilho intersticial para esse anúncio intersticial.
Definir o valor de um gatilho intersticial como true
vai ativá-lo, e false
vai desativá-lo. Isso vai substituir os valores padrão configurados no Google Ad Manager.
googletag.config.PageSettingsConfig
Permite definir vários recursos com uma única chamada de API.
Todas as propriedades listadas abaixo são exemplos e não refletem os recursos reais que usam setConfig. Para o conjunto de recursos, consulte os campos no tipo PageSettingsConfig abaixo.
Exemplos:
- Somente os recursos especificados na chamada googletag.setConfig são modificados.
// Configure feature alpha. googletag.setConfig({ alpha: {...} }); // Configure feature bravo. Feature alpha is unchanged. googletag.setConfig({ bravo: {...} });
- Todas as configurações de um determinado recurso são atualizadas a cada chamada para googletag.setConfig.
// Configure feature charlie to echo = 1, foxtrot = true. googletag.setConfig({ charlie: { echo: 1, foxtrot: true, } }); // Update feature charlie to echo = 2. Since foxtrot was not specified, // the value is cleared. googletag.setConfig({ charlie: { echo: 2 } });
- Todas as configurações de um recurso podem ser apagadas transmitindo
null
.// Configure features delta, golf, and hotel. googletag.setConfig({ delta: {...}, golf: {...}, hotel: {...}, }); // Feature delta and hotel are cleared, but feature golf remains set. googletag.setConfig({ delta: null, hotel: null, });
Propriedades | |
---|---|
ad | Configurações para controlar a expansão do anúncio. |
ad | Descontinuado. |
pps | Configurações para controlar os indicadores fornecidos pelo editor (PPS). |
privacy | Configurações para controlar os tratamentos de privacidade do editor. |
thread | Configuração para controlar se a GPT precisa gerar a linha de execução do JS ao renderizar criativos. |
Propriedades
Optional
adExpansion
adExpansion?: null | AdExpansionConfig
Configurações para controlar a expansão do anúncio.
Optional
adYield
adYield?: null | "DISABLED" | "ENABLED_ALL_SLOTS"
Optional
pps
pps?: null | PublisherProvidedSignalsConfig
Configurações para controlar os indicadores fornecidos pelo editor (PPS).
Optional
privacyTreatments
privacyTreatments?: null | PrivacyTreatmentsConfig
Configurações para controlar os tratamentos de privacidade do editor.
Optional
threadYield
null
(padrão): o GPT vai gerar a linha de execução do JS para slots fora da janela de visualização.ENABLED_ALL_SLOTS
: a GPT vai gerar a linha de execução do JS para todos os slots, independentemente de o slot estar dentro da viewport.DISABLED
: a GPT não vai gerar a linha de execução do JS.- Exemplo
JavaScript
// Disable yielding. googletag.setConfig({ threadYield: "DISABLED" }); // Enable yielding for all slots. googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" }); // Enable yielding only for slots outside of the viewport (default). googletag.setConfig({ threadYield: null });
JavaScript (legado)
// Disable yielding. googletag.setConfig({ threadYield: "DISABLED" }); // Enable yielding for all slots. googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" }); // Enable yielding only for slots outside of the viewport (default). googletag.setConfig({ threadYield: null });
TypeScript
// Disable yielding. googletag.setConfig({ threadYield: "DISABLED" }); // Enable yielding for all slots. googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" }); // Enable yielding only for slots outside of the viewport (default). googletag.setConfig({ threadYield: null });
- Consulte também
threadYield?: null | "DISABLED" | "ENABLED_ALL_SLOTS"
Configura a possibilidade de a GPT gerar a linha de execução do JS ao renderizar criativos.
A GPT vai gerar apenas para navegadores compatíveis com a API Scheduler.postTask ou Scheduler.yield.
Valores aceitos:
googletag.config.PrivacyTreatmentsConfig
Propriedades | |
---|---|
treatments | Uma matriz de tratamentos de privacidade do editor a serem ativados. |
Propriedades
tratamentos
- 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"] }, });
treatments: null | "disablePersonalization"[]
Uma matriz de tratamentos de privacidade do editor a serem ativados.
googletag.config.PublisherProvidedSignalsConfig
Propriedades | |
---|---|
taxonomies | Um objeto que contém mapeamentos de taxonomia. |
- Exemplo
JavaScript
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 30-34' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
JavaScript (legado)
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 30-34' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
TypeScript
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 30-34' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
Propriedades
taxonomias
taxonomies: Partial<Record<Taxonomy, TaxonomyData>>
Um objeto que contém mapeamentos de taxonomia.
googletag.config.SlotSettingsConfig
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 o conjunto de recursos, consulte os campos no tipo SlotSettingsConfig abaixo.
Exemplos:
- Somente os recursos especificados na chamada Slot.setConfig são modificados.
const slot = googletag.defineSlot("/1234567/example", [160, 600]); // Configure feature alpha. slot.setConfig({ alpha: {...} }); // Configure feature bravo. Feature alpha is unchanged. slot.setConfig({ bravo: {...} });
- Todas as configurações de um determinado recurso são atualizadas a cada chamada para Slot.setConfig.
// Configure feature charlie to echo = 1, foxtrot = true. slot.setConfig({ charlie: { echo: 1, foxtrot: true, } }); // Update feature charlie to echo = 2. Since foxtrot was not specified, // the value is cleared. slot.setConfig({ charlie: { echo: 2 } });
- Todas as configurações de um recurso podem ser apagadas transmitindo
null
.// Configure features delta, golf, and hotel. slot.setConfig({ delta: {...}, golf: {...}, hotel: {...}, }); // Feature delta and hotel are cleared, but feature golf remains set. slot.setConfig({ delta: null, hotel: null, });
Propriedades | |
---|---|
ad | Configurações para controlar a expansão do anúncio. |
component | 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. |
Propriedades
Optional
adExpansion
adExpansion?: null | AdExpansionConfig
Configurações para controlar a expansão do anúncio.
Optional
componentAuction
componentAuction?: null | ComponentAuctionConfig[]
Uma matriz de leilões de componentes a serem incluídos em um leilão de anúncios no dispositivo.
Optional
intersticial
interstitial?: null | InterstitialConfig
Configurações que controlam o comportamento do espaço de anúncio intersticial.
googletag.config.TaxonomyData
Propriedades | |
---|---|
values | Uma lista de valores de taxonomia. |
Propriedades
values
values: string[]
Uma lista de valores de taxonomia.
googletag.enums
Enumerações | |
---|---|
Out | Formatos fora da página compatíveis com a GPT. |
Traffic | Origens de tráfego compatíveis com o GPT. |
Enumerações
OutOfPageFormat
- Consulte também
OutOfPageFormat
Formatos fora da página compatíveis com a GPT.
Membros da enumeração | |
---|---|
BOTTOM_ | Formato de âncora em que o slot fica preso à parte de baixo da janela de visualização. |
GAME_ | Formato intersticial manual de jogo. Observação:o intersticial manual de jogo é um formato de acesso limitado. |
INTERSTITIAL | Formato do criativo intersticial da Web. |
LEFT_ | Formato da coluna lateral esquerda. |
REWARDED | Formato premiado. |
RIGHT_ | Formato da coluna lateral à direita. |
TOP_ | Formato de âncora em que o slot fica preso à parte de cima da janela de visualização. |
TrafficSource
- Consulte também
TrafficSource
Origens de tráfego compatíveis com o GPT.
googletag.events
Interfaces | |
---|---|
Event | Interface base para todos os eventos do GPT. |
Event | É um pseudotipo que mapeia um nome de evento para o tipo de objeto de evento correspondente para Service.addEventListener e Service.removeEventListener. |
Game | Esse evento é acionado quando um slot de intersticial manual de jogo é fechado pelo usuário. |
Game | Esse evento é acionado quando um espaço intersticial manual de jogo está pronto para ser mostrado ao usuário. |
Impression | Esse evento é acionado quando uma impressão se torna visível, de acordo com os critérios do Active View. |
Rewarded | Esse evento é disparado quando um slot de anúncio premiado é fechado pelo usuário. |
Rewarded | Esse evento é acionado quando um prêmio é concedido por visualizar um anúncio premiado. |
Rewarded | Esse evento é acionado quando um anúncio premiado está pronto para ser exibido. |
Slot | Esse evento é acionado quando o iframe do criativo aciona o evento de carregamento. |
Slot | Esse evento é acionado quando o código do criativo é injetado em um slot. |
Slot | Esse evento é acionado quando um anúncio é solicitado para um slot específico. |
Slot | Esse evento é acionado quando uma resposta de anúncio é recebida para um slot específico. |
Slot | Esse evento é acionado sempre que a porcentagem na tela da área de um slot de anúncio muda. |
googletag.events.Event
Propriedades | |
---|---|
service | Nome do serviço que acionou o evento. |
slot | O slot que acionou o evento. |
- Consulte também
Propriedades
serviceName
serviceName: string
Nome do serviço que acionou o evento.
slot
slot: Slot
O slot que acionou o evento.
googletag.events.EventTypeMap
Propriedades
gameManualInterstitialSlotClosed
gameManualInterstitialSlotClosed: GameManualInterstitialSlotClosedEvent
É o alias de events.GameManualInterstitialSlotClosedEvent.
gameManualInterstitialSlotReady
gameManualInterstitialSlotReady: GameManualInterstitialSlotReadyEvent
impressionViewable
impressionViewable: ImpressionViewableEvent
Alias de events.ImpressionViewableEvent.
rewardedSlotClosed
rewardedSlotClosed: RewardedSlotClosedEvent
É o alias de events.RewardedSlotClosedEvent.
rewardedSlotGranted
rewardedSlotGranted: RewardedSlotGrantedEvent
Alias de events.RewardedSlotGrantedEvent.
rewardedSlotReady
rewardedSlotReady: RewardedSlotReadyEvent
Alias de events.RewardedSlotReadyEvent.
slotOnload
slotOnload: SlotOnloadEvent
É o alias de events.SlotOnloadEvent.
slotRenderEnded
slotRenderEnded: SlotRenderEndedEvent
Alias de events.SlotRenderEndedEvent.
slotRequested
slotRequested: SlotRequestedEvent
Alias para events.SlotRequestedEvent.
slotResponseReceived
slotResponseReceived: SlotResponseReceived
Alias de events.SlotResponseReceived.
slotVisibilityChanged
slotVisibilityChanged: SlotVisibilityChangedEvent
Alias de events.SlotVisibilityChangedEvent.
googletag.events.GameManualInterstitialSlotClosedEvent
EstendidoObservação:o anúncio intersticial manual de jogo é um formato de acesso limitado.
Propriedades | |
---|---|
service | Nome do serviço que acionou o evento. Herdado de |
slot | O slot que acionou o evento. Herdado de |
- Exemplo
JavaScript
// This listener is called when a game manual interstial slot is closed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => { const slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (legado)
// This listener is called when a game manual interstial slot is closed. var targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", function (event) { var slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a game manual interstial slot is closed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => { const slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed."); if (slot === targetSlot) { // Slot specific logic. } });
googletag.events.GameManualInterstitialSlotReadyEvent
EstendidoObservação:o intersticial manual de jogo é um formato de acesso limitado.
Propriedades | |
---|---|
service | Nome do serviço que acionou o evento. Herdado de |
slot | O slot que acionou o evento. Herdado de |
Métodos | |
---|---|
make | Mostra o anúncio intersticial manual de jogo ao usuário. |
- Exemplo
JavaScript
// This listener is called when a game manual interstitial slot is ready to // be displayed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => { const slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is ready to be displayed."); //Replace with custom logic. const displayGmiAd = true; if (displayGmiAd) { event.makeGameManualInterstitialVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (legado)
// This listener is called when a game manual interstitial slot is ready to // be displayed. var targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); googletag.pubads().addEventListener("gameManualInterstitialSlotReady", function (event) { var slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is ready to be displayed."); //Replace with custom logic. var displayGmiAd = true; if (displayGmiAd) { event.makeGameManualInterstitialVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a game manual interstitial slot is ready to // be displayed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => { const slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is ready to be displayed."); //Replace with custom logic. const displayGmiAd = true; if (displayGmiAd) { event.makeGameManualInterstitialVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
Métodos
makeGameManualInterstitialVisible
googletag.events.ImpressionViewableEvent
EstendidoPropriedades | |
---|---|
service | Nome do serviço que acionou o evento. Herdado de |
slot | O slot que acionou o evento. Herdado de |
- Exemplo
JavaScript
// This listener is called when an impression becomes viewable. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("impressionViewable", (event) => { const slot = event.slot; console.log("Impression for slot", slot.getSlotElementId(), "became viewable."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (legado)
// This listener is called when an impression becomes viewable. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("impressionViewable", function (event) { var slot = event.slot; console.log("Impression for slot", slot.getSlotElementId(), "became viewable."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when an impression becomes viewable. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("impressionViewable", (event) => { const slot = event.slot; console.log("Impression for slot", slot.getSlotElementId(), "became viewable."); if (slot === targetSlot) { // Slot specific logic. } });
- Consulte também
googletag.events.RewardedSlotClosedEvent
EstendidoPropriedades | |
---|---|
service | Nome do serviço que acionou o evento. Herdado de |
slot | O slot que acionou o evento. Herdado de |
- 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. } });
- Consulte também
googletag.events.RewardedSlotGrantedEvent
EstendidoPropriedades | |
---|---|
payload | Um objeto que contém informações sobre a recompensa concedida. |
service | Nome do serviço que acionou o evento. Herdado de |
slot | O slot que acionou o evento. Herdado de |
- 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. } });
- Consulte também
Propriedades
payload
payload: null | RewardedPayload
Um objeto que contém informações sobre a recompensa concedida.
googletag.events.RewardedSlotReadyEvent
EstendidoPropriedades | |
---|---|
service | Nome do serviço que acionou o evento. Herdado de |
slot | O slot que acionou o evento. Herdado de |
Métodos | |
---|---|
make | Mostra 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. } });
- Consulte também
Métodos
makeRewardedVisible
googletag.events.SlotOnloadEvent
EstendidoSlotOnloadEvent
é acionado.Propriedades | |
---|---|
service | Nome do serviço que acionou o evento. Herdado de |
slot | O slot que acionou o evento. Herdado de |
- Exemplo
JavaScript
// This listener is called when a creative iframe load event fires. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { const slot = event.slot; console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (legado)
// This listener is called when a creative iframe load event fires. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", function (event) { var slot = event.slot; console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a creative iframe load event fires. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { const slot = event.slot; console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded."); if (slot === targetSlot) { // Slot specific logic. } });
- Consulte também
googletag.events.SlotRenderEndedEvent
EstendidoPropriedades | |
---|---|
advertiser | ID do anunciante do anúncio renderizado. |
campaign | ID da campanha do anúncio renderizado. |
company | IDs das empresas que deram lances no anúncio de preenchimento renderizado. |
creative | ID do criativo do anúncio de reserva renderizado. |
creative | ID do modelo de criativo do anúncio de reserva renderizado. |
is | Indica se um anúncio foi de preenchimento. |
is | Indica se um anúncio foi retornado para o slot. |
label | Descontinuado. |
line | ID do item de linha do anúncio de reserva renderizado. |
service | Nome do serviço que acionou o evento. Herdado de |
size | Indica o tamanho em pixels do criativo renderizado. |
slot | O slot que acionou o evento. Herdado de |
slot | Se o conteúdo do slot foi alterado com o anúncio renderizado. |
source | ID do criativo da reserva renderizada ou do anúncio de preenchimento. |
source | ID do item de linha da reserva renderizada ou do anúncio de preenchimento. |
yield | IDs dos grupos de rendimento do anúncio de preenchimento renderizado. |
- Exemplo
JavaScript
// This listener is called when a slot has finished rendering. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", (event) => { const slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (legado)
// This listener is called when a slot has finished rendering. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", function (event) { var slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a slot has finished rendering. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", (event) => { const slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
- Consulte também
Propriedades
advertiserId
advertiserId: null | number
ID do anunciante do anúncio renderizado. O valor é null
para slots vazios, anúncios de preenchimento e criativos renderizados por serviços diferentes do PubAdsService.
campaignId
campaignId: null | number
ID da campanha do anúncio renderizado. O valor é null
para slots vazios, anúncios de preenchimento e criativos renderizados por serviços diferentes do PubAdsService.
companyIds
companyIds: null | number[]
IDs das empresas que deram lances no anúncio de preenchimento renderizado. O valor é null
para slots vazios, anúncios de reserva e criativos renderizados por serviços diferentes de PubAdsService.
creativeId
creativeId: null | number
ID do criativo do anúncio de reserva renderizado. O valor é null
para slots vazios, anúncios de preenchimento e criativos renderizados por serviços diferentes do PubAdsService.
creativeTemplateId
creativeTemplateId: null | number
ID do modelo de criativo do anúncio de reserva renderizado. O valor é null
para slots vazios, anúncios de preenchimento e criativos renderizados por serviços diferentes do PubAdsService.
isBackfill
isBackfill: boolean
Indica se um anúncio foi de preenchimento. O valor é true
se o anúncio foi de preenchimento. Caso contrário, é false
.
isEmpty
isEmpty: boolean
Indica se um anúncio foi retornado para o slot. O valor é true
se nenhum anúncio foi retornado. Caso contrário, é false
.
labelIds
labelIds: null | number[]
lineItemId
lineItemId: null | number
ID do item de linha do anúncio de reserva renderizado. O valor é null
para slots vazios, anúncios de preenchimento e criativos renderizados por serviços diferentes do PubAdsService.
size
size: null | string | number[]
Indica o tamanho em pixels do criativo renderizado. Exemplo: [728, 90]
. O valor é null
para espaços de anúncio vazios.
slotContentChanged
slotContentChanged: boolean
Se o conteúdo do slot foi alterado com o anúncio renderizado. O valor será true
se o conteúdo tiver sido alterado ou false
caso contrário.
sourceAgnosticCreativeId
sourceAgnosticCreativeId: null | number
ID do criativo da reserva renderizada ou do anúncio de preenchimento. O valor é null
se o anúncio não for uma reserva ou um preenchimento de item de linha ou se o criativo for renderizado por serviços diferentes de PubAdsService.
sourceAgnosticLineItemId
sourceAgnosticLineItemId: null | number
ID do item de linha da reserva renderizada ou do anúncio de preenchimento. O valor é null
se o anúncio não for uma reserva ou um preenchimento de item de linha ou se o criativo for renderizado por serviços diferentes de PubAdsService.
yieldGroupIds
yieldGroupIds: null | number[]
IDs dos grupos de rendimento do anúncio de preenchimento renderizado. O valor é null
para slots vazios, anúncios de reserva e criativos renderizados por serviços diferentes de PubAdsService.
googletag.events.SlotRequestedEvent
EstendidoPropriedades | |
---|---|
service | Nome do serviço que acionou o evento. Herdado de |
slot | O slot que acionou o evento. Herdado de |
- Exemplo
JavaScript
// This listener is called when the specified service issues an ad // request for a slot. Each slot will fire this event, even though they // may be batched together in a single request if single request // architecture (SRA) is enabled. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRequested", (event) => { const slot = event.slot; console.log("Slot", slot.getSlotElementId(), "has been requested."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (legado)
// This listener is called when the specified service issues an ad // request for a slot. Each slot will fire this event, even though they // may be batched together in a single request if single request // architecture (SRA) is enabled. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRequested", function (event) { var slot = event.slot; console.log("Slot", slot.getSlotElementId(), "has been requested."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when the specified service issues an ad // request for a slot. Each slot will fire this event, even though they // may be batched together in a single request if single request // architecture (SRA) is enabled. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRequested", (event) => { const slot = event.slot; console.log("Slot", slot.getSlotElementId(), "has been requested."); if (slot === targetSlot) { // Slot specific logic. } });
- Consulte também
googletag.events.SlotResponseReceived
EstendidoPropriedades | |
---|---|
service | Nome do serviço que acionou o evento. Herdado de |
slot | O slot que acionou o evento. Herdado de |
- Exemplo
JavaScript
// This listener is called when an ad response has been received // for a slot. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", (event) => { const slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (legado)
// This listener is called when an ad response has been received // for a slot. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", function (event) { var slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when an ad response has been received // for a slot. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", (event) => { const slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
- Consulte também
googletag.events.SlotVisibilityChangedEvent
EstendidoPropriedades | |
---|---|
in | A porcentagem da área do anúncio que está visível. |
service | Nome do serviço que acionou o evento. Herdado de |
slot | O slot que acionou o evento. Herdado de |
- Exemplo
JavaScript
// This listener is called whenever the on-screen percentage of an // ad slot's area changes. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotVisibilityChanged", (event) => { const slot = event.slot; console.group("Visibility of slot", slot.getSlotElementId(), "changed."); // Log details of the event. console.log("Visible area:", `${event.inViewPercentage}%`); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (legado)
// This listener is called whenever the on-screen percentage of an // ad slot's area changes. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotVisibilityChanged", function (event) { var slot = event.slot; console.group("Visibility of slot", slot.getSlotElementId(), "changed."); // Log details of the event. console.log("Visible area:", "".concat(event.inViewPercentage, "%")); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called whenever the on-screen percentage of an // ad slot's area changes. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotVisibilityChanged", (event) => { const slot = event.slot; console.group("Visibility of slot", slot.getSlotElementId(), "changed."); // Log details of the event. console.log("Visible area:", `${event.inViewPercentage}%`); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
- Consulte também
Propriedades
inViewPercentage
inViewPercentage: number
A porcentagem da área do anúncio que está visível. O valor é um número entre 0 e 100.
googletag.secureSignals
Interfaces | |
---|---|
Bidder | Retorna um indicador seguro para um bidder específico. |
Publisher | Retorna um indicador seguro para um editor específico. |
Secure | Uma interface para gerenciar indicadores seguros. |
Aliases de tipo | |
---|---|
Secure | Interface para retornar um indicador seguro para um bidder ou provedor específico. |
Aliases de tipo
SecureSignalProvider
SecureSignalProvider: BidderSignalProvider | PublisherSignalProvider
Interface para retornar um indicador seguro para um bidder ou provedor específico. É necessário fornecer id
ou networkCode
, mas não ambos.
googletag.secureSignals.BidderSignalProvider
Um provedor de indicador seguro do bidder consiste em duas partes:
- Uma função de coletor, que retorna um
Promise
que é resolvido em um indicador seguro. - Um
id
que identifica o bidder associado ao indicador.
Propriedades | |
---|---|
collector | Uma função que retorna um Promise que é resolvido em um sinal seguro. |
id | Um identificador exclusivo do coletor associado a esse indicador seguro, conforme registrado no Google Ad Manager. |
- Exemplo
JavaScript
// id is provided googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
JavaScript (legado)
// id is provided googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: function () { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
TypeScript
// id is provided googletag.secureSignalProviders!.push({ id: "collector123", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
- Consulte também
Propriedades
collectorFunction
collectorFunction: (() => Promise<string>)
Uma função que retorna um Promise
que é resolvido em um sinal seguro.
id
id: string
Um identificador exclusivo do coletor associado a esse indicador seguro, conforme registrado no Google Ad Manager.
googletag.secureSignals.PublisherSignalProvider
Um provedor de indicador do editor consiste em duas partes:
- Uma função de coletor, que retorna um
Promise
que é resolvido em um indicador seguro. - Um
networkCode
que identifica o editor associado ao indicador.
Propriedades | |
---|---|
collector | Uma função que retorna um Promise que é resolvido em um sinal seguro. |
network | O código de rede (como mostrado no caminho do bloco de anúncios) do editor associado a esse indicador seguro. |
- Exemplo
JavaScript
// networkCode is provided googletag.secureSignalProviders.push({ networkCode: "123456", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
JavaScript (legado)
// networkCode is provided googletag.secureSignalProviders.push({ networkCode: "123456", collectorFunction: function () { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
TypeScript
// networkCode is provided googletag.secureSignalProviders!.push({ networkCode: "123456", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
- Consulte também
Propriedades
collectorFunction
collectorFunction: (() => Promise<string>)
Uma função que retorna um Promise
que é resolvido em um sinal seguro.
networkCode
networkCode: string
O código de rede (como mostrado no caminho do bloco de anúncios) do editor associado a esse indicador seguro.
googletag.secureSignals.SecureSignalProvidersArray
Métodos | |
---|---|
clear | Limpa todos os indicadores de todos os coletores do cache. |
push | Adiciona um novo secureSignals.SecureSignalProvider à matriz do provedor de indicadores e inicia o processo de geração de indicadores. |
Métodos
clearAllCache
clearAllCache(): void
Limpa todos os indicadores de todos os coletores do cache.
Chamar esse método pode reduzir a probabilidade de os indicadores serem incluídos em solicitações de anúncios para as visualizações de página atuais e possivelmente futuras. Por isso, ele só deve ser chamado quando mudanças de estado significativas ocorrerem, como eventos que indicam um novo usuário (login, logout, inscrição etc.).
push
push(provider: SecureSignalProvider): void
Adiciona um novo secureSignals.SecureSignalProvider à matriz do provedor de indicadores e inicia o processo de geração de indicadores.
Parâmetros | |
---|---|
provider: SecureSignalProvider | O objeto secureSignals.SecureSignalProvider a ser adicionado à matriz. |