Esta referência usa a notação TypeScript para descrever tipos. Confira na tabela a seguir uma breve explicação por exemplo.
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 de união, em que o valor pode ser um número ou uma string. |
Array<number | string> |
Um tipo de matriz em que os valores são um tipo complexo (união). |
[number, string] |
Um tipo de tupla, em que o valor é uma matriz de dois elementos que precisa conter um número e uma string, nessa ordem. |
Slot |
Um tipo de objeto, em que o valor é uma instância de googletag.Slot . |
() => void |
Um tipo de função sem argumentos definidos e sem valor de retorno. |
Para saber mais sobre tipos e expressões de tipo compatíveis, consulte o Manual do TypeScript .
Anotações de tipo
Dois pontos após uma variável, nome do parâmetro, nome da propriedade ou assinatura da função indicam uma anotação de tipo. As anotações de tipo descrevem os tipos que o elemento à esquerda dos dois pontos pode aceitar ou retornar. A tabela a seguir mostra exemplos de anotações de tipo que podem ser encontradas nesta referência.
Anotação de tipo | |
---|---|
param: string |
Indica que param aceita ou retorna um valor de string. Essa sintaxe é usada para variáveis, parâmetros, propriedades e tipos de retorno.
|
param?: number | string |
Indica que param é opcional, mas aceita um número ou uma string quando especificado. Essa sintaxe é usada para parâmetros e propriedades.
|
...params: Array<() => void> |
Indica que params é um
parâmetro REST
que aceita funções. Os parâmetros REST aceitam um número ilimitado de valores do tipo especificado.
|
Definições de tipo
Tipos | |
---|---|
|
SingleSize | MultiSize
|
Uma configuração de tamanho válida para um slot, que pode ter um ou vários tamanhos. |
|
|
SingleSize[]
|
Uma lista de tamanhos únicos válidos. |
|
|
"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 tamanhos nomeados a seguir são válidos:
|
|
|
SingleSizeArray | NamedSize
|
Um único tamanho válido para um espaço. |
|
|
[number, number]
|
Matriz de dois números que representa [largura, altura]. |
|
|
[SingleSizeArray, GeneralSize]
|
Mapeamento do tamanho da janela de visualização para os tamanhos dos anúncios. Usado para anúncios responsivos. |
|
|
SizeMapping[]
|
Uma lista de mapeamentos de tamanho. |
|
|
"unhideWindow" | "navBar"
|
Acionadores de anúncios intersticiais compatíveis. |
|
|
"disablePersonalization"
|
Tratamentos de privacidade do editor compatíveis. |
|
|
"IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"
|
Taxonomias compatíveis com os indicadores fornecidos pelo editor (PPS, na sigla em inglês). |
|
|
BidderSignalProvider | PublisherSignalProvider
|
Interface para retornar um indicador seguro para um bidder ou um provedor específico. É preciso fornecer uma destas opções: |
Tipos de enumeração
Tipos enumerados | |
---|---|
googletag.enums.OutOfPageFormat
|
Formatos fora da página compatíveis com a GPT.
|
googletag.enums.TrafficSource
|
Origens de tráfego compatíveis com a GPT.
|
googletag.enums.OutOfPageFormat
-
Formatos fora da página compatíveis com a GPT.
-
- Veja também
googletag.enums.TrafficSource
-
Origens de tráfego compatíveis com a GPT.
-
- Veja também
googletag
O namespace global que a Tag do editor do Google usa na sua API.
Resumo das variáveis | |
---|---|
apiReady
|
Sinalização que indica que a API GPT está carregada e pronta para ser chamada.
|
cmd
|
Referência à fila de comando global para execução assíncrona de chamadas relacionadas à GPT.
|
pubadsReady
|
Sinalização que indica que o
PubAdsService está ativado, carregado e totalmente operacional.
|
secureSignalProviders
|
Referência à matriz de provedores de indicadores seguros.
|
Resumo da função | |
---|---|
companionAds
|
Retorna uma referência ao
CompanionAdsService .
|
defineOutOfPageSlot
|
Cria um espaço de anúncio fora da página com o caminho do bloco de anúncios especificado.
|
defineSlot
|
Cria um espaço de anúncio com determinado caminho e tamanho de bloco de anúncios e o associa ao ID de um elemento div na página que conterá o anúncio.
|
destroySlots
|
Destrói os espaços fornecidos, removendo todos os objetos relacionados e as referências a esses espaços da GPT.
|
disablePublisherConsole
|
Desativa o Console do Editor do Google.
|
display
|
Instrui os serviços de slot a renderizar o slot.
|
enableServices
|
Ativa todos os serviços da GPT que foram definidos para os espaços do anúncio na página.
|
getVersion
|
Retorna a versão atual da GPT.
|
openConsole
|
Abre o Console do Editor do Google.
|
pubads
|
Retorna uma referência ao
PubAdsService .
|
setAdIframeTitle
|
Define o título de todos os iframes de contêiner do anúncio criados por
PubAdsService a partir desse momento.
|
setConfig
|
Define as opções gerais de configuração para a página.
|
sizeMapping
|
Cria um novo
SizeMappingBuilder .
|
googletag.apiReady
-
apiReady: boolean | undefined
-
Sinalização que indica que a API GPT está carregada e pronta para ser chamada. Essa propriedade será simplesmente
undefined
até que a API esteja pronta.
A maneira recomendada de lidar com a sintaxe é usar googletag.cmd para enfileirar callbacks para quando a GPT estiver pronta. Esses callbacks não precisam verificar googletag.apiReady porque há garantia de que serão executados assim que a API for configurada. -
- Exemplo
-
JavaScript
if (window.googletag && googletag.apiReady) { // GPT API can be called safely. }
JavaScript (legado)
if (window.googletag && googletag.apiReady) { // GPT API can be called safely. }
TypeScript
if (window.googletag && googletag.apiReady) { // GPT API can be called safely. }
googletag.cmd
-
cmd: Array<(this: typeof globalThis) => void> | CommandArray
-
Referência à fila de comando global para execução assíncrona de chamadas relacionadas à GPT.
A variávelgoogletag.cmd
é inicializada em uma matriz JavaScript vazia pela sintaxe da tag GPT na página, ecmd.push
é o métodoArray.push
padrão que adiciona um elemento ao final da matriz. Quando o JavaScript da GPT é carregado, ele analisa a matriz e executa todas as funções em ordem. Em seguida, o script substituicmd
por um objetoCommandArray
cujo método push é definido para executar o argumento de função transmitido a ele. Esse mecanismo permite que o GPT reduza a latência percebida buscando o JavaScript de forma assíncrona, ao mesmo tempo permitindo que o navegador continue renderizando a página. -
- Exemplo
-
JavaScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
JavaScript (legado)
googletag.cmd.push(function () { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
TypeScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads()); });
googletag.pubadsReady
-
pubadsReady: boolean | undefined
-
Sinalização que indica que o
PubAdsService
está ativado, carregado e totalmente operacional. Essa propriedade será simplesmenteundefined
até queenableServices
seja chamado ePubAdsService
seja carregado e inicializado. -
googletag.secureSignalProviders
-
secureSignalProviders: SecureSignalProvider[] | SecureSignalProvidersArray | undefined
-
Referência à matriz de provedores de indicadores seguros.
Essa matriz aceita uma sequência de funções geradoras de indicadores e as invoca em ordem. Ela tem como objetivo substituir uma matriz padrão usada para enfileirar funções geradoras de indicadores a serem invocadas quando a GPT for carregada. -
- Exemplo
-
JavaScript
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { return Promise.resolve("signal"); }, });
JavaScript (legado)
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: function () { return Promise.resolve("signal"); }, });
TypeScript
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { return Promise.resolve("signal"); }, });
- Veja também
googletag.companionAds
-
companionAds(): CompanionAdsService
-
Retorna uma referência ao
CompanionAdsService
. -
-
Retorna CompanionAdsService
O serviço de anúncios complementares.
googletag.defineOutOfPageSlot
-
defineOutOfPageSlot(adUnitPath: string, div?: string | OutOfPageFormat): Slot | null
-
Cria um espaço de anúncio fora da página com o caminho do bloco de anúncios especificado.
Para anúncios fora da página personalizados,div
é o ID do elemento div que conterá o anúncio. Consulte o artigo sobre criativos fora da página para mais detalhes.
Para anúncios fora da página gerenciados pela GPT,div
é um OutOfPageFormat compatível. -
- Exemplo
-
JavaScript
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
JavaScript (legado)
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
TypeScript
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
- Veja também
-
Parâmetros adUnitPath: string
Caminho completo do bloco de anúncios com o código de rede e o código do bloco de anúncios.div?: string | OutOfPageFormat
ID do div que conterá esse bloco de anúncios ou OutOfPageFormat. -
Retorna Slot | null
O slot recém-criado, ounull
, se um espaço não puder ser criado.
googletag.defineSlot
-
defineSlot(adUnitPath: string, size: GeneralSize, div?: string): Slot | null
-
Cria um espaço de anúncio com determinado caminho e tamanho de bloco de anúncios e o associa ao ID de um elemento div na página que conterá o anúncio.
-
- Exemplo
-
JavaScript
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
JavaScript (legado)
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
TypeScript
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
- Veja também
-
Parâmetros adUnitPath: string
Caminho completo do bloco de anúncios com o código de rede e o código do bloco.size: GeneralSize
Largura e altura do slot adicionado. Esse é o tamanho usado na solicitação de anúncio se nenhum mapeamento de tamanho responsivo for fornecido ou se o tamanho da janela de visualização for menor que o menor tamanho fornecido no mapeamento.div?: string
ID do div que conterá esse bloco de anúncios. -
Retorna Slot | null
O slot recém-criado, ounull
, se um espaço não puder ser criado.
googletag.destroySlots
-
destroySlots(slots?: Slot[]): boolean
-
Destrói os espaços fornecidos, removendo todos os objetos relacionados e as referências a esses espaços da GPT. Esta API não é compatível com espaços de passback e complementares.
Chamar essa API em um espaço limpa o anúncio e remove o objeto de espaço do estado interno mantido pela GPT. Chamar mais funções no objeto de slot resulta em um comportamento indefinido. Observe que 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. Chamar essa API disponibiliza o div associado a esse espaço para reutilização.
Especificamente, destruir um espaço remove o anúncio da visualização de página de longa duração da GPT. Assim, as solicitações futuras não serão influenciadas por bloqueios ou exclusões competitivas envolvendo esse anúncio. Se essa função não for chamada antes de remover o div de um espaço da página, o comportamento será indefinido. -
- Exemplo
-
JavaScript
// The calls to construct an ad and display contents. const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to destroy only slot1. googletag.destroySlots([slot1]); // This call to destroy both slot1 and slot2. googletag.destroySlots([slot1, slot2]); // This call to destroy all slots. googletag.destroySlots();
JavaScript (legado)
// The calls to construct an ad and display contents. var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to destroy only slot1. googletag.destroySlots([slot1]); // This call to destroy both slot1 and slot2. googletag.destroySlots([slot1, slot2]); // This call to destroy all slots. googletag.destroySlots();
TypeScript
// The calls to construct an ad and display contents. const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!; googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!; googletag.display("div-2"); // This call to destroy only slot1. googletag.destroySlots([slot1]); // This call to destroy both slot1 and slot2. googletag.destroySlots([slot1, slot2]); // This call to destroy all slots. googletag.destroySlots();
-
Parâmetros slots?: Slot[]
A matriz de slots a serem destruídos. A matriz é opcional. Todos os slots serão destruídos se não for especificado. -
Retorna boolean
true
se os slots tiverem sido destruídos. Caso contrário,false
.
googletag.disablePublisherConsole
-
disablePublisherConsole(): void
-
Desativa o Console do Editor do Google.
-
- Veja também
googletag.display
-
display(divOrSlot: string | Element | Slot): void
-
Instrui os serviços de slot a renderizar o slot. Cada espaço de anúncio deve ser exibido somente uma vez por página. Todos os espaços precisam ser definidos e ter um serviço associado a eles antes de serem exibidos. A chamada de exibição não pode acontecer até que o elemento esteja presente no DOM. A maneira comum de fazer isso é colocá-lo em um bloco de script dentro do elemento div nomeado na chamada do método.
Se a arquitetura de solicitação única (SRA) estiver sendo usada, todos os espaços de anúncio não buscados no momento em que esse método é chamado serão buscados de uma só vez. Para forçar a não exibição de um espaço de anúncio, é necessário remover todo o div. -
- Exemplo
-
JavaScript
googletag.cmd.push(() => { googletag.display("div-1"); });
JavaScript (legado)
googletag.cmd.push(function () { googletag.display("div-1"); });
TypeScript
googletag.cmd.push(() => { googletag.display("div-1"); });
- Veja também
-
Parâmetros divOrSlot: string | Element | Slot
O ID do elemento div que contém o espaço de anúncio, o elemento div ou o objeto do espaço. Se um elemento div for fornecido, ele precisará ter um atributo "id" que corresponda ao ID transmitido paradefineSlot
.
googletag.enableServices
-
enableServices(): void
-
Ativa todos os serviços da GPT que foram definidos para os espaços do anúncio na página.
-
googletag.getVersion
-
getVersion(): string
-
Retorna a versão atual da GPT.
-
- Veja também
-
Retorna string
A string da versão da GPT em execução no momento.
googletag.openConsole
-
openConsole(div?: string): void
-
Abre o Console do Editor do Google.
-
- Exemplo
-
JavaScript
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
JavaScript (legado)
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
TypeScript
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
- Veja também
-
Parâmetros div?: string
Um código div do espaço de anúncio. Este valor é opcional. Quando fornecido, o Console do Editor tentará abrir com detalhes do espaço de anúncio especificado em visualização.
googletag.pubads
-
pubads(): PubAdsService
-
Retorna uma referência ao
PubAdsService
. -
-
Retorna PubAdsService
O serviço de anúncios do editor.
googletag.setAdIframeTitle
-
setAdIframeTitle(title: string): void
-
Define o título de todos os iframes de contêiner do anúncio criados por
PubAdsService
a partir desse momento. -
- Exemplo
-
JavaScript
googletag.setAdIframeTitle("title");
JavaScript (legado)
googletag.setAdIframeTitle("title");
TypeScript
googletag.setAdIframeTitle("title");
-
Parâmetros title: string
O novo título para todos os iframes de contêiner de anúncios.
googletag.setConfig
-
setConfig(config: PageSettingsConfig): void
-
Define as opções gerais de configuração para a página.
-
-
Parâmetros config: PageSettingsConfig
googletag.sizeMapping
-
sizeMapping(): SizeMappingBuilder
-
Cria um novo
SizeMappingBuilder
. -
- Veja também
-
Retorna SizeMappingBuilder
Um novo builder.
googletag.CommandArray
A matriz de comandos aceita uma sequência de funções e as invoca em ordem. Ela tem como objetivo substituir uma matriz padrão usada para enfileirar funções que serão invocadas quando a GPT for carregada.
Resumo dos métodos | |
---|---|
push
|
Executa a sequência de funções especificadas nos argumentos em ordem.
|
push
-
push(...f: Array<(this: typeof globalThis) => void>): number
-
Executa a sequência de funções especificadas nos argumentos em ordem.
-
- Exemplo
-
JavaScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
JavaScript (legado)
googletag.cmd.push(function () { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
TypeScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads()); });
-
Parâmetros ...f: Array<(this: typeof globalThis) => void>
Uma função JavaScript a ser executada. A vinculação do ambiente de execução sempre seráglobalThis
. Considere transmitir uma arrow function para reter o valorthis
do contexto lexical delimitado. -
Retorna number
O número de comandos processados até o momento. Isso é compatível com o valor de retorno deArray.push
(o comprimento atual da matriz).
googletag.CompanionAdsService
Estende
o serviço de anúncios complementares. Esse serviço é usado por anúncios em vídeo para mostrar anúncios complementares.
Resumo dos métodos | |
---|---|
addEventListener
|
Registra um listener que permite configurar e chamar uma função JavaScript quando ocorre um evento específico da GPT na página.
Herdado de
|
getSlots
|
Confira a lista de slots associados a este serviço.
Herdado de
|
removeEventListener
|
Remove um listener registrado anteriormente.
Herdado de
|
setRefreshUnfilledSlots
|
Define se os espaços complementares que não foram preenchidos serão preenchidos automaticamente.
|
- Veja também
setRefreshUnfilledSlots
-
setRefreshUnfilledSlots(value: boolean): void
-
Define se os espaços complementares que não foram preenchidos serão preenchidos automaticamente.
Esse método pode ser chamado várias vezes durante a vida útil da página para ativar e desativar o preenchimento. Somente os espaços que também estiverem registrados noPubAdsService
serão preenchidos. Devido a restrições de política, esse método não foi criado para preencher espaços complementares vazios quando um vídeo do Ad Exchange for veiculado. -
- Exemplo
-
JavaScript
googletag.companionAds().setRefreshUnfilledSlots(true);
JavaScript (legado)
googletag.companionAds().setRefreshUnfilledSlots(true);
TypeScript
googletag.companionAds().setRefreshUnfilledSlots(true);
-
Parâmetros value: boolean
true
para preencher automaticamente os espaços não preenchidos,false
para deixá-los inalterados.
googletag.PrivacySettingsConfig
Objeto de configuração para definições de privacidade.
Resumo da propriedade | |
---|---|
childDirectedTreatment
|
Indica se a página deve ser tratada como direcionada a crianças.
|
limitedAds
|
Permite que a veiculação seja executada no modo de anúncios limitados para ajudar nas necessidades de conformidade regulatória do editor.
|
nonPersonalizedAds
|
Permite que a veiculação seja executada no modo de anúncios não personalizados para ajudar nas necessidades de conformidade regulatória do editor.
|
restrictDataProcessing
|
Permite que a veiculação seja executada no modo de processamento restrito para atender às necessidades de conformidade regulatória do editor.
|
trafficSource
|
Indica se as solicitações representam tráfego comprado ou orgânico.
|
underAgeOfConsent
|
Indica se as solicitações de anúncios precisam ser marcadas como provenientes de usuários abaixo da idade de consentimento.
|
- Veja também
childDirectedTreatment
-
childDirectedTreatment: null | boolean
-
Indica se a página deve ser tratada como direcionada a crianças. Defina como
null
para limpar a configuração. -
limitedAds
-
limitedAds: boolean
-
Permite que a veiculação seja executada no modo de anúncios limitados para ajudar nas necessidades de conformidade regulatória do editor.
É possível instruir a GPT a solicitar anúncios limitados de duas maneiras:- De forma automática, usando um indicador de uma plataforma de gestão de consentimento do IAB TCF v2.0.
- Manualmente, definindo o valor desse campo como
true
.
Não é necessário ativar manualmente os anúncios limitados quando uma CMP está em uso. -
- Exemplo
-
JavaScript
// Manually enable limited ads serving. // GPT must be loaded from the limited ads URL to configure this setting. googletag.pubads().setPrivacySettings({ limitedAds: true, });
JavaScript (legado)
// Manually enable limited ads serving. // GPT must be loaded from the limited ads URL to configure this setting. googletag.pubads().setPrivacySettings({ limitedAds: true, });
TypeScript
// Manually enable limited ads serving. // GPT must be loaded from the limited ads URL to configure this setting. googletag.pubads().setPrivacySettings({ limitedAds: true, });
- Veja também
nonPersonalizedAds
-
nonPersonalizedAds: boolean
-
Permite que a veiculação seja executada no modo de anúncios não personalizados para ajudar nas necessidades de conformidade regulatória do editor.
-
restrictDataProcessing
-
restrictDataProcessing: boolean
-
Permite que a veiculação seja executada no modo de processamento restrito para atender às necessidades de conformidade regulatória do editor.
-
trafficSource
-
trafficSource: TrafficSource
-
Indica se as solicitações representam tráfego comprado ou orgânico. Esse valor preenche a dimensão Origem do tráfego nos relatórios do Ad Manager. Se ela não for definida, o padrão da origem do tráfego será
undefined
nos relatórios. -
- Exemplo
-
JavaScript
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
JavaScript (legado)
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
TypeScript
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
underAgeOfConsent
-
underAgeOfConsent: null | boolean
-
Indica se as solicitações de anúncios precisam ser marcadas como provenientes de usuários abaixo da idade de consentimento. Defina como
null
para limpar a configuração. -
googletag.PubAdsService
Estende
serviço de anúncios do editor. Esse serviço é usado para buscar e exibir anúncios na sua conta do Google Ad Manager.
Resumo dos métodos | |
---|---|
addEventListener
|
Registra um listener que permite configurar e chamar uma função JavaScript quando ocorre um evento específico da GPT na página.
Herdado de
|
clear
|
Remove os anúncios dos espaços fornecidos e os substitui por conteúdo em branco.
|
clearCategoryExclusions
|
Limpa todos os rótulos de exclusão de categorias de anúncios no nível da página.
|
clearTargeting
|
Limpa os parâmetros de segmentação personalizada para uma chave específica ou para todas as chaves.
|
collapseEmptyDivs
|
Ativa o recolhimento de divs de espaço para que não ocupem espaço na página quando não houver conteúdo de anúncio para exibir.
|
disableInitialLoad
|
Desativa as solicitações de anúncios no carregamento de página, mas permite que eles sejam solicitados com uma chamada
PubAdsService.refresh .
|
display
|
Cria e exibe um espaço de anúncio com o caminho e o tamanho do bloco de anúncios especificado.
|
enableLazyLoad
|
Ativa o carregamento lento na GPT, conforme definido pelo objeto de configuração.
|
enableSingleRequest
|
Ativa o modo de solicitação única para buscar vários anúncios ao mesmo tempo.
|
enableVideoAds
|
Sinaliza à GPT que os anúncios em vídeo estarão presentes na página.
|
get
|
Retorna o valor do atributo do AdSense associado à chave fornecida.
|
getAttributeKeys
|
Retorna as chaves de atributo que foram definidas neste serviço.
|
getSlots
|
Confira a lista de slots associados a este serviço.
Herdado de
|
getTargeting
|
Retorna um parâmetro de segmentação personalizado específico no nível de serviço que foi definido.
|
getTargetingKeys
|
Retorna a lista de todas as chaves de segmentação personalizadas no nível de serviço que foram definidas.
|
isInitialLoadDisabled
|
Retorna se as solicitações iniciais de anúncios foram ou não 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.
|
removeEventListener
|
Remove um listener registrado anteriormente.
Herdado de
|
set
|
Define valores para os atributos do Google AdSense que se aplicam a todos os espaços de anúncio no serviço Anúncios do editor.
|
setCategoryExclusion
|
Define uma exclusão de categoria de anúncio em nível de página para o nome do rótulo fornecido.
|
setCentering
|
Ativa e desativa a centralização horizontal de anúncios.
|
setForceSafeFrame
|
Configura se todos os anúncios na página devem ser renderizados por meio de um contêiner SafeFrame.
|
setLocation
|
Transmite informações sobre a localização de sites para que você possa segmentar itens de linha por área geográfica para locais específicos.
|
setPrivacySettings
|
Permite definir todas as configurações de privacidade de uma única API usando um objeto de configuração.
|
setPublisherProvidedId
|
Define o valor do ID fornecido pelo editor.
|
setSafeFrameConfig
|
Define as preferências no nível da página para a configuração do SafeFrame.
|
setTargeting
|
Define parâmetros de segmentação personalizada para determinada chave que se aplicam a todos os espaços de anúncio de serviço dos anúncios do editor.
|
setVideoContent
|
Define as informações de conteúdo de vídeo a serem enviadas com as solicitações de anúncios para fins de segmentação e exclusão de conteúdo.
|
updateCorrelator
|
Muda o correlator enviado com as solicitações de anúncios, iniciando efetivamente uma nova visualização de página.
|
clear
-
clear(slots?: Slot[]): boolean
-
Remove os anúncios dos espaços fornecidos e os substitui por conteúdo em branco. Os espaços serão marcados como não buscados.
Especificamente, limpar um local remove o anúncio da visualização de página de longa duração da GPT. Assim, as solicitações futuras não serão influenciadas por bloqueios ou exclusões competitivas envolvendo esse anúncio. -
- Exemplo
-
JavaScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to clear only slot1. googletag.pubads().clear([slot1]); // This call to clear both slot1 and slot2. googletag.pubads().clear([slot1, slot2]); // This call to clear all slots. googletag.pubads().clear();
JavaScript (legado)
var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to clear only slot1. googletag.pubads().clear([slot1]); // This call to clear both slot1 and slot2. googletag.pubads().clear([slot1, slot2]); // This call to clear all slots. googletag.pubads().clear();
TypeScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!; googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!; googletag.display("div-2"); // This call to clear only slot1. googletag.pubads().clear([slot1]); // This call to clear both slot1 and slot2. googletag.pubads().clear([slot1, slot2]); // This call to clear all slots. googletag.pubads().clear();
-
Parâmetros slots?: Slot[]
A matriz de slots a serem limpos. A matriz é opcional. Se não for especificada, todos os slots serão apagados. -
Retorna boolean
Retornatrue
se os espaços tiverem sido apagados. Caso contrário, retornafalse
.
clearCategoryExclusions
-
clearCategoryExclusions(): PubAdsService
-
Limpa todos os rótulos de exclusão de categorias de anúncios no nível da página. Isso é útil se você deseja atualizar o slot.
-
- Exemplo
-
JavaScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
JavaScript (legado)
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
TypeScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
- Veja também
-
Retorna PubAdsService
O objeto de serviço em que o método foi chamado.
clearTargeting
-
clearTargeting(key?: string): PubAdsService
-
Limpa os parâmetros de segmentação personalizada para uma chave específica ou para todas as chaves.
-
- Exemplo
-
JavaScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
JavaScript (legado)
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
TypeScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
- Veja também
-
Parâmetros key?: string
Chave do parâmetro de segmentação. A chave é opcional. Se não for especificada, todos os parâmetros de segmentação serão apagados. -
Retorna PubAdsService
O objeto de serviço em que o método foi chamado.
collapseEmptyDivs
-
collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean
-
Ativa o recolhimento de divs de espaço para que não ocupem espaço na página quando não houver conteúdo de anúncio para exibir. Esse modo precisa ser definido antes da ativação do serviço.
-
Parâmetros collapseBeforeAdFetch?: boolean
Indica se os espaços serão recolhidos mesmo antes da busca dos anúncios. Esse parâmetro é opcional. Se não for fornecido,false
será usado como valor padrão. -
Retorna boolean
Retornatrue
se o modo de recolhimento div estiver ativado efalse
se não for possível ativar o modo de recolhimento porque o método foi chamado após a ativação do serviço.
disableInitialLoad
-
disableInitialLoad(): void
-
Desativa as solicitações de anúncios no carregamento de página, mas permite que eles sejam solicitados com uma chamada
PubAdsService.refresh
. Isso precisa ser definido antes da ativação do serviço. O modo assíncrono precisa ser usado. Caso contrário, será impossível solicitar anúncios usandorefresh
.
display
-
display(adUnitPath: string, size: GeneralSize, div?: string | Element, clickUrl?: string): void
-
Cria e exibe um espaço de anúncio com o caminho e o tamanho do bloco de anúncios especificado. Esse método não funciona com o modo de solicitação única.
Observação:quando ele é chamado, um resumo do estado da página e do espaço é criado para garantir consistência ao enviar a solicitação de anúncio e renderizar a resposta. Qualquer mudança feita no estado do espaço ou da página após a chamada desse método (incluindo segmentação, configurações de privacidade, forçar SafeFrame etc.) será aplicada somente às solicitaçõesdisplay()
ourefresh()
subsequentes. -
- Exemplo
-
JavaScript
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
JavaScript (legado)
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
TypeScript
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
- Veja também
-
Parâmetros adUnitPath: string
O caminho do bloco de anúncios do espaço a ser renderizado.size: GeneralSize
Largura e altura do slot.div?: string | Element
O ID da div que contém o espaço ou o próprio elemento div.clickUrl?: string
O URL de clique a ser usado nesse espaço.
enableLazyLoad
-
enableLazyLoad(config?: { fetchMarginPercent: number, mobileScaling: number, renderMarginPercent: number }): void
-
Ativa o carregamento lento na GPT, conforme definido pelo objeto de configuração. Para exemplos mais detalhados, consulte o exemplo Carregamento lento.
Observação:a busca lenta na SRA só funciona se todos os slots estiverem fora da margem de busca. -
- Exemplo
-
JavaScript
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
JavaScript (legado)
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
TypeScript
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
- Veja também
-
Parâmetros config?: { fetchMarginPercent: number, mobileScaling: number, renderMarginPercent: number }
O objeto de configuração permite a personalização do comportamento lento. Todas as configurações omitidas usarão um padrão definido pelo Google que será ajustado ao longo do tempo. Para desativar uma configuração específica, como uma margem de busca, defina o valor como-1
.fetchMarginPercent
A distância mínima de um espaço da janela de visualização atual antes de buscarmos o anúncio como uma porcentagem do tamanho da janela de visualização. Um valor de 0 significa "quando o espaço entra na janela de visualização", "100" significa "quando o anúncio está a uma janela de visualização de distância" e assim por diante.renderMarginPercent
A distância mínima de um espaço da janela de visualização atual para que um anúncio seja renderizado. Isso permite a pré-busca do anúncio, mas a espera para renderizar e fazer o download de outros sub-recursos. O valor funciona exatamente comofetchMarginPercent
em uma porcentagem da janela de visualização.mobileScaling
Um multiplicador aplicado às margens em dispositivos móveis. Isso permite margens variadas em dispositivos móveis em comparação com computadores. Por exemplo, um valor de 2,0 multiplica todas as margens por 2 em dispositivos móveis, aumentando a distância mínima de um espaço antes da busca e da renderização.
enableSingleRequest
-
enableSingleRequest(): boolean
-
Ativa o modo de solicitação única para buscar vários anúncios ao mesmo tempo. Isso exige que todos os espaços de anúncios do editor sejam definidos e adicionados ao PubAdsService antes da ativação do serviço. O modo de solicitação única precisa ser definido antes da ativação do serviço.
-
Retorna boolean
Retornatrue
se o modo de solicitação única estiver ativado efalse
se for impossível ativar o modo de solicitação única porque o método foi chamado após a ativação do serviço.
enableVideoAds
-
enableVideoAds(): void
-
Sinaliza à GPT que os anúncios em vídeo estarão presentes na página. Isso ativa as restrições de exclusão competitiva em anúncios de display e em vídeo. Se o conteúdo em vídeo for conhecido, chame
PubAdsService.setVideoContent
para poder usar a exclusão de conteúdo para anúncios de display. -
get
-
get(key: string): null | string
-
Retorna o valor do atributo do AdSense associado à chave fornecida.
-
- Exemplo
-
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
JavaScript (legado)
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
TypeScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
- Veja também
-
Parâmetros key: string
Nome do atributo a ser procurado. -
Retorna null | string
Valor atual da chave de atributo, ounull
se a chave não estiver presente.
getAttributeKeys
-
getAttributeKeys(): string[]
-
Retorna as chaves de atributo que foram definidas neste serviço.
-
- Exemplo
-
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
JavaScript (legado)
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
TypeScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
-
Retorna string[]
Matriz de chaves de atributo definidas neste serviço. A ordenação é indefinida.
getTargeting
-
getTargeting(key: string): string[]
-
Retorna um parâmetro de segmentação personalizado específico no nível de serviço que foi definido.
-
- Exemplo
-
JavaScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
JavaScript (legado)
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
TypeScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
-
Parâmetros key: string
A chave de segmentação a ser procurada. -
Retorna string[]
Os valores associados a esta chave ou uma matriz vazia se essa chave não existir.
getTargetingKeys
-
getTargetingKeys(): string[]
-
Retorna a lista de todas as chaves de segmentação personalizadas no nível de serviço que foram definidas.
-
- Exemplo
-
JavaScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().getTargetingKeys(); // Returns ['interests', 'colors'].
JavaScript (legado)
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().getTargetingKeys(); // Returns ['interests', 'colors'].
TypeScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().getTargetingKeys(); // Returns ['interests', 'colors'].
-
Retorna string[]
Matriz de chaves de segmentação. A ordenação é indefinida.
isInitialLoadDisabled
-
isInitialLoadDisabled(): boolean
-
Retorna se as solicitações iniciais de anúncios foram ou não desativadas por uma chamada
PubAdsService.disableInitialLoad
anterior. -
-
Retorna boolean
Retornatrue
se uma chamada anterior paraPubAdsService.disableInitialLoad
for bem-sucedida. Caso contrário, retornafalse
.
refresh
-
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 derefresh
precisa ser precedida por uma chamada paradisplay
do espaço do anúncio. Se a chamada paradisplay
for omitida, a atualização poderá se comportar de maneira inesperada. É possível usar o métodoPubAdsService.disableInitialLoad
para impedir quedisplay
busque um anúncio.
A atualização de um espaço remove o anúncio antigo da visualização de página de longa duração da GPT. Assim, as solicitações futuras não serão influenciadas por bloqueios ou exclusões competitivas envolvendo esse anúncio. -
- Exemplo
-
JavaScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
JavaScript (legado)
var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
TypeScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!; googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!; googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
- Veja também
-
Parâmetros slots?: null | Slot[]
Os slots a serem atualizados. A matriz é opcional. Todos os slots serão atualizados se não for especificada.options?: { changeCorrelator: boolean }
Opções de configuração associadas a esta chamada de atualização.changeCorrelator
Especifica se um novo correlator deve ou não ser gerado para buscar anúncios. Nossos servidores de anúncios mantêm esse valor de correlação por pouco tempo (no momento, por 30 segundos, mas sujeito a mudanças). Assim, as solicitações com a mesma correlação recebidas em um período próximo 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 exibição de página de longa duração da GPT, que reflete automaticamente os anúncios que estão atualmente na página e não tem prazo de validade.
set
-
set(key: string, value: string): PubAdsService
-
Define valores para os atributos do Google AdSense que se aplicam a todos os espaços de anúncio no serviço de anúncios do editor.
Chamar isso mais de uma vez para a mesma chave substitui os valores definidos anteriormente para essa chave. Todos os valores precisam ser definidos antes de chamardisplay
ourefresh
. -
- Exemplo
-
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF");
JavaScript (legado)
googletag.pubads().set("adsense_background_color", "#FFFFFF");
TypeScript
googletag.pubads().set("adsense_background_color", "#FFFFFF");
- Veja também
-
Parâmetros key: string
O nome do atributo.value: string
Valor do atributo. -
Retorna PubAdsService
O objeto de serviço em que o método foi chamado.
setCategoryExclusion
-
setCategoryExclusion(categoryExclusion: string): PubAdsService
-
Define uma exclusão de categoria de anúncio em nível de página para o nome do rótulo fornecido.
-
- Exemplo
-
JavaScript
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
JavaScript (legado)
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
TypeScript
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
- Veja também
-
Parâmetros categoryExclusion: string
O rótulo de exclusão da categoria de anúncio a ser adicionado. -
Retorna PubAdsService
O objeto de serviço em que o método foi chamado.
setCentering
-
setCentering(centerAds: boolean): void
-
Ativa e desativa a centralização horizontal de anúncios. A centralização fica desativada por padrão. No gpt_mobile.js legado, a centralização é ativada por padrão.
Esse método precisa ser invocado antes dedisplay
ourefresh
, já que apenas os anúncios solicitados depois de chamar esse método serão centralizados. -
- Exemplo
-
JavaScript
// Make ads centered. googletag.pubads().setCentering(true);
JavaScript (legado)
// Make ads centered. googletag.pubads().setCentering(true);
TypeScript
// Make ads centered. googletag.pubads().setCentering(true);
-
Parâmetros centerAds: boolean
true
para centralizar os anúncios,false
para alinhá-los à esquerda.
setForceSafeFrame
-
setForceSafeFrame(forceSafeFrame: boolean): PubAdsService
-
Configura se todos os anúncios na página devem ser renderizados usando um contêiner SafeFrame.
Lembre-se do seguinte ao usar essa API:- Essa configuração só terá efeito em solicitações de anúncios subsequentes feitas para os respectivos espaços.
- A configuração no nível do espaço, se especificada, sempre substitui a configuração no nível da página.
- Se for definido como
true
(no nível do espaço ou da página), o anúncio sempre será renderizado usando um contêiner do SafeFrame, independente da escolha feita na interface do Google Ad Manager. - No entanto, se for definido como
false
ou não for 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, já que pode afetar o comportamento de criativos que tentam sair dos iframes ou depender da renderização direta deles em uma página do editor.
-
- Exemplo
-
JavaScript
googletag.pubads().setForceSafeFrame(true); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setForceSafeFrame(false) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript (legado)
googletag.pubads().setForceSafeFrame(true); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setForceSafeFrame(false) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
TypeScript
googletag.pubads().setForceSafeFrame(true); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setForceSafeFrame(false) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
- Veja também
-
Parâmetros forceSafeFrame: boolean
true
para forçar a renderização de todos os anúncios na página em SafeFrames efalse
para alterar a configuração anterior para "false". Se ele for definido comofalse
quando não for especificado, nada vai mudar. -
Retorna PubAdsService
O objeto de serviço em que a função foi chamada.
setLocation
-
setLocation(address: string): PubAdsService
-
Transmite informações sobre a localização de sites para que você possa segmentar itens de linha por área geográfica para locais específicos.
-
- Exemplo
-
JavaScript
// Postal code: googletag.pubads().setLocation("10001,US");
JavaScript (legado)
// Postal code: googletag.pubads().setLocation("10001,US");
TypeScript
// Postal code: googletag.pubads().setLocation("10001,US");
-
Parâmetros address: string
Endereço com forma livre. -
Retorna PubAdsService
O objeto de serviço em que o método foi chamado.
setPrivacySettings
-
setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService
-
Permite definir todas as configurações de privacidade de uma única API usando um objeto de configuração.
-
- Exemplo
-
JavaScript
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
JavaScript (legado)
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
TypeScript
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
- Veja também
-
Parâmetros privacySettings: PrivacySettingsConfig
Objeto contendo a configuração de privacidade. -
Retorna PubAdsService
O objeto de serviço em que a função foi chamada.
setPublisherProvidedId
-
setPublisherProvidedId(ppid: string): PubAdsService
-
Define o valor do ID fornecido pelo editor.
-
- Exemplo
-
JavaScript
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
JavaScript (legado)
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
TypeScript
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
- Veja também
-
Parâmetros ppid: string
É um código alfanumérico fornecido pelo editor. Precisa ter entre 32 e 150 caracteres. -
Retorna PubAdsService
O objeto de serviço em que o método foi chamado.
setSafeFrameConfig
-
setSafeFrameConfig(config: SafeFrameConfig): PubAdsService
-
Define as preferências no nível da página para a configuração do SafeFrame. Todas as chaves não reconhecidas no objeto de configuração serão ignoradas. Toda a configuração será ignorada se um valor inválido for transmitido para uma chave reconhecida.
Essas preferências no nível da página vão ser substituídas pelas preferências no nível do slot, se especificadas. -
- Exemplo
-
JavaScript
googletag.pubads().setForceSafeFrame(true); const pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; const slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript (legado)
googletag.pubads().setForceSafeFrame(true); var pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; var slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
TypeScript
googletag.pubads().setForceSafeFrame(true); const pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; const slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
- Veja também
-
Parâmetros config: SafeFrameConfig
O objeto de configuração. -
Retorna PubAdsService
O objeto de serviço em que o método foi chamado.
setTargeting
-
setTargeting(key: string, value: string | string[]): PubAdsService
-
Define parâmetros de segmentação personalizada para determinada chave que se aplicam a todos os espaços de anúncio de serviço dos anúncios do editor. Chamar essa opção várias vezes para a mesma chave substituirá os valores antigos. Essas chaves são definidas na sua conta do Google Ad Manager.
-
- Exemplo
-
JavaScript
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
JavaScript (legado)
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
TypeScript
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
- Veja também
-
Parâmetros key: string
Chave 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
-
setVideoContent(videoContentId: string, videoCmsId: string): void
-
Define as informações de conteúdo de vídeo a serem enviadas com as solicitações de anúncios para fins de segmentação e exclusão de conteúdo. Os anúncios em vídeo serão ativados automaticamente quando esse método for chamado. Para
videoContentId
evideoCmsId
, use os valores fornecidos ao serviço de processamento de conteúdo do Google Ad Manager. -
- Veja também
-
Parâmetros videoContentId: string
É o ID do conteúdo em vídeo.videoCmsId: string
O ID do CMS do vídeo.
updateCorrelator
-
updateCorrelator(): PubAdsService
-
Muda o correlator enviado com as solicitações de anúncios, iniciando efetivamente 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 todas as visualizações de página. Isso se aplica somente ao modo assíncrono.
Observação:isso não afeta a visualização de página de longa duração da GPT, que reflete automaticamente os anúncios que estão realmente na página e não tem prazo de validade. -
- Exemplo
-
JavaScript
// Assume that the correlator is currently 12345. All ad requests made // by this page will currently use that value. // Replace the current correlator with a new correlator. googletag.pubads().updateCorrelator(); // The correlator will now be a new randomly selected value, different // from 12345. All subsequent ad requests made by this page will use // the new value.
JavaScript (legado)
// Assume that the correlator is currently 12345. All ad requests made // by this page will currently use that value. // Replace the current correlator with a new correlator. googletag.pubads().updateCorrelator(); // The correlator will now be a new randomly selected value, different // from 12345. All subsequent ad requests made by this page will use // the new value.
TypeScript
// Assume that the correlator is currently 12345. All ad requests made // by this page will currently use that value. // Replace the current correlator with a new correlator. googletag.pubads().updateCorrelator(); // The correlator will now be a new randomly selected value, different // from 12345. All subsequent ad requests made by this page will use // the new value.
-
Retorna PubAdsService
O objeto de serviço em que a função foi chamada.
googletag.ResponseInformation
Um objeto que representa uma única resposta de anúncio.
Resumo da propriedade | |
---|---|
advertiserId
|
O ID do anunciante.
|
campaignId
|
O ID da campanha.
|
creativeId
|
O ID do criativo.
|
creativeTemplateId
|
O ID do modelo do anúncio.
|
lineItemId
|
ID do item de linha.
|
- Veja também
advertiserId
-
advertiserId: null | number
-
O ID do anunciante.
-
campaignId
-
campaignId: null | number
-
O ID da campanha.
-
creativeId
-
creativeId: null | number
-
O ID do criativo.
-
creativeTemplateId
-
creativeTemplateId: null | number
-
O ID do modelo do anúncio.
-
lineItemId
-
lineItemId: null | number
-
ID do item de linha.
-
googletag.RewardedPayload
Objeto que representa a recompensa associada a um anúncio premiado.
Resumo da propriedade | |
---|---|
amount
|
Número de itens incluídos no prêmio.
|
type
|
O tipo de item incluído no prêmio (por exemplo, "moeda").
|
- Veja também
amount
-
amount: number
-
Número de itens incluídos no prêmio.
-
type
-
type: string
-
O tipo de item incluído no prêmio (por exemplo, "moeda").
-
googletag.SafeFrameConfig
Objeto de configuração para contêineres SafeFrame.
Resumo da propriedade | |
---|---|
allowOverlayExpansion
|
Indica se o SafeFrame deve permitir a expansão do conteúdo do anúncio sobrepondo o conteúdo da página.
|
allowPushExpansion
|
Indica se o SafeFrame deve permitir que o conteúdo do anúncio se expanda ao enviar o conteúdo da página.
|
sandbox
|
Indica se o SafeFrame deve usar o atributo sandbox HTML5 para impedir a navegação de nível superior sem interação do usuário.
|
useUniqueDomain
|
Obsoleto.
Indica se o SafeFrame deve usar subdomínios aleatórios para os criativos de reserva.
|
- Veja também
allowOverlayExpansion
-
allowOverlayExpansion: boolean
-
Indica se o SafeFrame deve permitir a expansão do conteúdo do anúncio sobrepondo o conteúdo da página.
-
allowPushExpansion
-
allowPushExpansion: boolean
-
Indica se o SafeFrame deve permitir que o conteúdo do anúncio se expanda ao enviar o conteúdo da página.
-
sandbox
-
sandbox: boolean
-
Indica se o SafeFrame deve usar o atributo sandbox HTML5 para impedir a navegação de nível superior sem interação do usuário. O único valor válido é
true
(não pode ser forçado parafalse
). Observe que o atributo sandbox desativa plug-ins (por exemplo, Flash). -
useUniqueDomain
-
useUniqueDomain: null | boolean
-
Indica se o SafeFrame deve usar subdomínios aleatórios para os criativos de reserva. Transmita
null
para limpar o valor armazenado.
Observação: esse recurso é ativado por padrão. -
- Veja também
googletag.Service
Classe de serviço base que contém métodos comuns a todos os serviços.
Resumo dos métodos | |
---|---|
addEventListener
|
Registra um listener que permite configurar e chamar uma função JavaScript quando ocorre um evento específico da GPT na página.
|
getSlots
|
Confira a lista de slots associados a este serviço.
|
removeEventListener
|
Remove um listener registrado anteriormente.
|
addEventListener
-
addEventListener<K extends keyof EventTypeMap>(eventType: K, listener: (arg: EventTypeMap[K]) => void): Service
-
Registra um listener que permite configurar e chamar uma função JavaScript quando ocorre um evento específico da GPT na página. Há suporte para os seguintes eventos:
Um objeto do tipo de evento adequado é passado ao listener quando ele é chamado. -
- Exemplo
-
JavaScript
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", (event) => { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { if (event.slot === targetSlot) { // Slot specific logic. } });
JavaScript (legado)
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", function (event) { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", function (event) { if (event.slot === targetSlot) { // Slot specific logic. } });
TypeScript
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", (event) => { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { if (event.slot === targetSlot) { // Slot specific logic. } });
- Veja também
-
Parâmetros eventType: K
Uma string que representa o tipo de evento gerado pela GPT. Os tipos de evento diferenciam maiúsculas de minúsculas.listener: (arg: EventTypeMap[K]) => void
Função que usa um único argumento de objeto de evento. -
Retorna Service
O objeto de serviço em que o método foi chamado.
getSlots
removeEventListener
-
removeEventListener<K extends keyof EventTypeMap>(eventType: K, listener: (event: EventTypeMap[K]) => void): void
-
Remove um listener registrado anteriormente.
-
- Exemplo
-
JavaScript
googletag.cmd.push(() => { // Define a new ad slot. googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. const onViewableListener = (event) => { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(() => { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
JavaScript (legado)
googletag.cmd.push(function () { // Define a new ad slot. googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. var onViewableListener = function (event) { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(function () { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
TypeScript
googletag.cmd.push(() => { // Define a new ad slot. googletag .defineSlot("/6355419/Travel", [728, 90], "div-for-slot")! .addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. const onViewableListener = (event: googletag.events.ImpressionViewableEvent) => { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(() => { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
-
Parâmetros eventType: K
Uma string que representa o tipo de evento gerado pela GPT. Os tipos de evento diferenciam maiúsculas de minúsculas.listener: (event: EventTypeMap[K]) => void
Função que usa um único argumento de objeto de evento.
googletag.SizeMappingBuilder
Builder de objetos de especificação de mapeamento de tamanho. Esse builder é fornecido para ajudar a criar especificações de tamanho com facilidade.
Resumo dos métodos | |
---|---|
addSize
|
Adiciona um mapeamento de uma matriz de tamanho único (que representa a janela de visualização) para uma matriz de tamanho único ou de vários tamanhos que representa o espaço.
|
build
|
Cria uma especificação de tamanho do mapa a partir dos mapeamentos adicionados a esse builder.
|
- Veja também
addSize
-
addSize(viewportSize: SingleSizeArray, slotSize: GeneralSize): SizeMappingBuilder
-
Adiciona um mapeamento de uma matriz de tamanho único (que representa a janela de visualização) para uma matriz de tamanho único ou de vários tamanhos que representa o espaço.
-
- Exemplo
-
JavaScript
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 640x480 .build(); // Mapping 2 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], []) .addSize([640, 480], [120, 60]) .addSize([0, 0], []) .build(); // Mapping 2 will not show any ads for the following viewport sizes: // [1024, 768] > size >= [980, 690] and // [640, 480] > size >= [0, 0]
JavaScript (legado)
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 640x480 .build(); // Mapping 2 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], []) .addSize([640, 480], [120, 60]) .addSize([0, 0], []) .build(); // Mapping 2 will not show any ads for the following viewport sizes: // [1024, 768] > size >= [980, 690] and // [640, 480] > size >= [0, 0]
TypeScript
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 640x480 .build(); // Mapping 2 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], []) .addSize([640, 480], [120, 60]) .addSize([0, 0], []) .build(); // Mapping 2 will not show any ads for the following viewport sizes: // [1024, 768] > size >= [980, 690] and // [640, 480] > size >= [0, 0]
-
Parâmetros viewportSize: SingleSizeArray
O tamanho da janela de visualização dessa entrada de mapeamento.slotSize: GeneralSize
Os tamanhos do slot dessa 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 retornaránull
. Caso contrário, ele retorna uma especificação no formato correto para transmitir aoSlot.defineSizeMapping
.
Observação: o comportamento do builder depois de chamar esse método é indefinido. -
-
Retorna null | SizeMappingArray
O resultado criado por este builder. Poderá ser nulo se mapeamentos de tamanho inválidos tiverem sido fornecidos.
googletag.Slot
O espaço é um objeto que representa um único espaço de anúncio em uma página.
Resumo dos métodos | |
---|---|
addService
|
Adiciona um
Service ao slot.
|
clearCategoryExclusions
|
Limpa todos os rótulos de exclusão de categoria de anúncio em nível de espaço para esse espaço.
|
clearTargeting
|
Limpa alguns ou todos os parâmetros personalizados de segmentação para esse espaço no nível do espaço.
|
defineSizeMapping
|
Define uma matriz de mapeamentos do tamanho mínimo da janela de visualização para o tamanho do espaço desse espaço.
|
get
|
Retorna o valor do atributo do AdSense associado à chave fornecida para esse espaço.
|
getAdUnitPath
|
Retorna o caminho completo do bloco de anúncios, com o código de rede e o caminho do bloco de anúncios.
|
getAttributeKeys
|
Retorna a lista de chaves de atributo definidas nesse espaço.
|
getCategoryExclusions
|
Retorna os rótulos de exclusão de categoria de anúncio deste espaço.
|
getResponseInformation
|
Retorna as informações de resposta do anúncio.
|
getSlotElementId
|
Retorna o ID do slot
div fornecido quando ele foi definido.
|
getTargeting
|
Retorna um parâmetro de segmentação personalizada específico definido nesse espaço.
|
getTargetingKeys
|
Retorna a lista de todas as chaves de segmentação personalizadas definidas nesse espaço.
|
set
|
Define um valor para um atributo do AdSense nesse espaço de anúncio.
|
setCategoryExclusion
|
Define um rótulo de exclusão da categoria de anúncio em nível de espaço neste espaço.
|
setClickUrl
|
Define o URL de clique para o qual os usuários serão redirecionados após clicar no anúncio.
|
setCollapseEmptyDiv
|
Define se o espaço
div será oculto quando não houver anúncios nele.
|
setConfig
|
Define as opções gerais de configuração para o slot.
|
setForceSafeFrame
|
Configura se os anúncios neste espaço precisam ser renderizados com frequência usando um contêiner SafeFrame.
|
setSafeFrameConfig
|
Define as preferências no nível do espaço para a configuração do SafeFrame.
|
setTargeting
|
Define um parâmetro de segmentação personalizada para esse espaço.
|
updateTargetingFromMap
|
Define parâmetros de segmentação personalizada para este espaço, a partir de um mapa chave-valor em um objeto JSON.
|
addService
-
Adiciona um
Service
ao slot. -
- Exemplo
-
JavaScript
googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());
JavaScript (legado)
googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());
TypeScript
googletag.defineSlot("/1234567/sports", [160, 600], "div")!.addService(googletag.pubads());
- Veja também
-
Parâmetros service: Service
O serviço a ser adicionado. -
Retorna Slot
O objeto de slot em que o método foi chamado.
clearCategoryExclusions
-
clearCategoryExclusions(): Slot
-
Limpa todos os rótulos de exclusão de categoria de anúncio em nível de espaço para esse espaço.
-
- Exemplo
-
JavaScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.clearCategoryExclusions(); // Make an ad request. Any ad can be returned for the slot.
JavaScript (legado)
// Set category exclusion to exclude ads with 'AirlineAd' labels. var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.clearCategoryExclusions(); // Make an ad request. Any ad can be returned for the slot.
TypeScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.clearCategoryExclusions(); // Make an ad request. Any ad can be returned for the slot.
-
Retorna Slot
O objeto de slot em que o método foi chamado.
clearTargeting
-
clearTargeting(key?: string): Slot
-
Limpa alguns ou todos os parâmetros personalizados de segmentação para esse espaço no nível do espaço.
-
- Exemplo
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
JavaScript (legado)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
- Veja também
-
Parâmetros key?: string
Chave do parâmetro de segmentação. A chave é opcional. Se não for especificada, todos os parâmetros de segmentação serão apagados. -
Retorna Slot
O objeto de slot em que o método foi chamado.
defineSizeMapping
-
defineSizeMapping(sizeMapping: SizeMappingArray): Slot
-
Define uma matriz de mapeamentos do tamanho mínimo da janela de visualização para o tamanho do espaço desse espaço.
-
- Exemplo
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); const mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ] ) .build(); slot.defineSizeMapping(mapping);
JavaScript (legado)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); var mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ] ) .build(); slot.defineSizeMapping(mapping);
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); const mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ] ) .build(); slot.defineSizeMapping(mapping!);
- Veja também
-
Parâmetros sizeMapping: SizeMappingArray
Matriz de mapeamentos de tamanho. UseSizeMappingBuilder
para criá-lo. Cada mapeamento de tamanho é uma matriz de dois elementos:SingleSizeArray
eGeneralSize
. -
Retorna Slot
O objeto de slot em que o método foi chamado.
get
-
get(key: string): null | string
-
Retorna o valor do atributo do AdSense associado à chave fornecida para esse espaço. Para ver os atributos de nível de serviço herdados por esse espaço, use
PubAdsService.get
. -
- Exemplo
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
JavaScript (legado)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
- Veja também
-
Parâmetros key: string
Nome do atributo a ser procurado. -
Retorna null | string
Valor atual da chave de atributo, ounull
se a chave não estiver presente.
getAdUnitPath
-
getAdUnitPath(): string
-
Retorna o caminho completo do bloco de anúncios, com o código de rede e o caminho do bloco de anúncios.
-
- Exemplo
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
JavaScript (legado)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
-
Retorna string
Caminho do bloco de anúncios.
getAttributeKeys
-
getAttributeKeys(): string[]
-
Retorna a lista de chaves de atributo definidas nesse espaço. Para consultar as chaves dos atributos de nível de serviço herdadas por esse espaço, use
PubAdsService.getAttributeKeys
. -
- Exemplo
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .set("adsense_border_color", "#AABBCC") .addService(googletag.pubads()); slot.getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
JavaScript (legado)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .set("adsense_border_color", "#AABBCC") .addService(googletag.pubads()); slot.getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .set("adsense_border_color", "#AABBCC") .addService(googletag.pubads()); slot.getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
-
Retorna string[]
Matriz de chaves de atributo. A ordenação é indefinida.
getCategoryExclusions
-
getCategoryExclusions(): string[]
-
Retorna os rótulos de exclusão de categoria de anúncio deste espaço.
-
- Exemplo
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
JavaScript (legado)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
-
Retorna string[]
Os rótulos de exclusão da categoria de anúncio deste espaço ou uma matriz vazia se nenhuma tiver sido definida.
getResponseInformation
-
getResponseInformation(): null | ResponseInformation
-
Retorna as informações de resposta do anúncio. Isso se baseia na última resposta do anúncio para o espaço. Se for chamado quando o espaço não tiver anúncio,
null
será retornado. -
-
Retorna null | ResponseInformation
As informações mais recentes de resposta do anúncio, ounull
se o espaço não tiver anúncio.
getSlotElementId
-
getSlotElementId(): string
-
Retorna o ID do slot
div
fornecido quando ele foi definido. -
- Exemplo
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div'.
JavaScript (legado)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div'.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div'.
-
Retorna string
ID do slotdiv
.
getTargeting
-
getTargeting(key: string): string[]
-
Retorna um parâmetro de segmentação personalizada específico definido nesse espaço. Os parâmetros de segmentação no nível de serviço não estão incluídos.
-
- Exemplo
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
JavaScript (legado)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
-
Parâmetros key: string
A chave de segmentação a ser procurada. -
Retorna string[]
Os valores associados a esta chave ou uma matriz vazia se essa chave não existir.
getTargetingKeys
-
getTargetingKeys(): string[]
-
Retorna a lista de todas as chaves de segmentação personalizadas definidas nesse espaço. As chaves de segmentação de nível de serviço não estão incluídas.
-
- Exemplo
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .addService(googletag.pubads()); slot.getTargetingKeys(); // Returns ['interests', 'allow_expandable'].
JavaScript (legado)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .addService(googletag.pubads()); slot.getTargetingKeys(); // Returns ['interests', 'allow_expandable'].
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .addService(googletag.pubads()); slot.getTargetingKeys(); // Returns ['interests', 'allow_expandable'].
-
Retorna string[]
Matriz de chaves de segmentação. A ordenação é indefinida.
set
-
set(key: string, value: string): Slot
-
Define um valor para um atributo do AdSense nesse espaço de anúncio. Isso substitui todos os valores definidos no nível de serviço para essa chave.
Chamar esse método mais de uma vez para a mesma chave substitui os valores definidos anteriormente. Todos os valores precisam ser definidos antes de chamardisplay
ourefresh
. -
- Exemplo
-
JavaScript
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
JavaScript (legado)
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
TypeScript
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
- Veja também
-
Parâmetros key: string
O nome do atributo.value: string
Valor do atributo. -
Retorna Slot
O objeto de slot em que o método foi chamado.
setCategoryExclusion
-
setCategoryExclusion(categoryExclusion: string): Slot
-
Define um rótulo de exclusão da categoria de anúncio em nível de espaço neste espaço.
-
- Exemplo
-
JavaScript
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
JavaScript (legado)
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
TypeScript
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
- Veja também
-
Parâmetros categoryExclusion: string
O rótulo de exclusão da categoria de anúncio a ser adicionado. -
Retorna Slot
O objeto de slot em que o método foi chamado.
setClickUrl
-
setClickUrl(value: string): Slot
-
Define o URL de clique para o qual os usuários serão redirecionados depois de clicar no anúncio.
Os servidores do Google Ad Manager ainda registram um clique, mesmo que o URL de clique seja substituído. Qualquer URL da página de destino associado ao criativo veiculado é anexado ao valor fornecido. As chamadas seguintes substituem o valor. Isso funciona apenas para solicitações que não são de SRA. -
- Exemplo
-
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
JavaScript (legado)
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
TypeScript
googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
-
Parâmetros value: string
O URL de clique a ser definido. -
Retorna Slot
O objeto de slot em que o método foi chamado.
setCollapseEmptyDiv
-
setCollapseEmptyDiv(collapse: boolean, collapseBeforeAdFetch?: boolean): Slot
-
Define se o espaço
div
será oculto quando não houver anúncios nele. Isso substitui as configurações de nível de serviço. -
- Exemplo
-
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2") .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
JavaScript (legado)
googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2") .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
TypeScript
googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2")! .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
- Veja também
-
Parâmetros collapse: boolean
Indica se o espaço será recolhido caso nenhum anúncio seja retornado.collapseBeforeAdFetch?: boolean
Indica se o espaço será recolhido mesmo antes de um anúncio ser buscado. Será ignorado se o recolhimento não fortrue
. -
Retorna Slot
O objeto de slot em que o método foi chamado.
setConfig
-
setConfig(slotConfig: SlotSettingsConfig): void
-
Define as opções gerais de configuração para o slot.
-
-
Parâmetros slotConfig: SlotSettingsConfig
O objeto de configuração.
setForceSafeFrame
-
setForceSafeFrame(forceSafeFrame: boolean): Slot
-
Configura se os anúncios neste espaço devem ou não ser renderizados usando um contêiner do SafeFrame.
Lembre-se do seguinte ao usar essa API:- Essa configuração só terá efeito em solicitações de anúncios subsequentes feitas para os respectivos espaços.
- A configuração no nível do espaço, se especificada, sempre substitui a configuração no nível da página.
- Se for definido como
true
(no nível do espaço ou da página), o anúncio sempre será renderizado usando um contêiner do SafeFrame, independente da escolha feita na interface do Google Ad Manager. - No entanto, se for definido como
false
ou não for 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, já que pode afetar o comportamento de criativos que tentam sair dos iframes ou depender da renderização direta deles em uma página do editor.
-
- Exemplo
-
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setForceSafeFrame(true) .addService(googletag.pubads());
JavaScript (legado)
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setForceSafeFrame(true) .addService(googletag.pubads());
TypeScript
googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setForceSafeFrame(true) .addService(googletag.pubads());
- Veja também
-
Parâmetros forceSafeFrame: boolean
true
para forçar a renderização de todos os anúncios neste espaço em SafeFrames efalse
para desativar uma configuração no nível da página (se presente). Definir comofalse
quando não for especificado no nível da página não mudará nada. -
Retorna Slot
O objeto de slot em que o método foi chamado.
setSafeFrameConfig
-
setSafeFrameConfig(config: null | SafeFrameConfig): Slot
-
Define as preferências no nível do espaço para a configuração do SafeFrame. Todas as chaves não reconhecidas no objeto de configuração serão ignoradas. Toda a configuração será ignorada se um valor inválido for transmitido para uma chave reconhecida.
Essas preferências no nível do slot, se especificadas, vão substituir as da página. -
- Exemplo
-
JavaScript
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript (legado)
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
TypeScript
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
- Veja também
-
Parâmetros config: null | SafeFrameConfig
O objeto de configuração. -
Retorna Slot
O objeto de slot em que o método foi chamado.
setTargeting
-
setTargeting(key: string, value: string | string[]): Slot
-
Define um parâmetro de segmentação personalizada para esse espaço. Chamar esse método várias vezes para a mesma chave substituirá os valores antigos. Os valores definidos aqui substituirão os parâmetros de segmentação definidos no nível de serviço. Essas chaves são definidas na sua conta do Google Ad Manager.
-
- Exemplo
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
JavaScript (legado)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
- Veja também
-
Parâmetros key: string
Chave 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
-
updateTargetingFromMap(map: { [adUnitPath: string]: string | string[] }): Slot
-
Define parâmetros de segmentação personalizada para este espaço, a partir de um mapa chave-valor em um objeto JSON. Isso é o mesmo que chamar
Slot.setTargeting
para todas as chaves-valor do objeto. Essas chaves são definidas na sua conta do Google Ad Manager.
Observações:- Em caso de substituição, apenas o último valor será mantido.
- Se o valor for uma matriz, qualquer valor anterior será substituído, e não mesclado.
- Os valores definidos aqui substituirão os parâmetros de segmentação definidos no nível de serviço.
-
- Exemplo
-
JavaScript
const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div"); slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
JavaScript (legado)
var slot = googletag.defineSlot("/1234567/sports", [160, 600], "div"); slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
TypeScript
const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!; slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
-
Parâmetros map: { [adUnitPath: string]: string | string[] }
Mapa de chave-valor do parâmetro de segmentação. -
Retorna Slot
O objeto de slot em que o método foi chamado.
googletag.config.AdExpansionConfig
Configurações para controlar a expansão de anúncios.
Resumo da propriedade | |
---|---|
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 }, });
enabled
-
enabled: boolean
-
Indica se a expansão de anúncios está ativada ou desativada.
A definição desse valor substitui o padrão configurado no Google Ad Manager.
googletag.config.ComponentAuctionConfig
É um objeto que representa um leilão de um único componente em um leilão de anúncios no dispositivo.
Resumo da propriedade | |
---|---|
auctionConfig
|
É um objeto de configuração para este leilão de componentes.
|
configKey
|
A chave de configuração associada a este leilão de componentes.
|
auctionConfig
-
auctionConfig: null | { auctionSignals: unknown, decisionLogicUrl: string, interestGroupBuyers: string[], perBuyerExperimentGroupIds: { [buyer: string]: number }, perBuyerGroupLimits: { [buyer: string]: number }, perBuyerSignals: { [buyer: string]: unknown }, perBuyerTimeouts: { [buyer: string]: number }, seller: string, sellerExperimentGroupId: number, sellerSignals: unknown, sellerTimeout: number, trustedScoringSignalsUrl: string }
-
Um objeto de configuração para este leilão de componentes.
Se o valor for definido comonull
, qualquer configuração atual para oconfigKey
especificado será excluída. -
- Exemplo
-
JavaScript
const componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicUrl's origin seller: "https://testSeller.com", decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]); // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
JavaScript (legado)
var componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicUrl's origin seller: "https://testSeller.com", decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; var auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]); // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
TypeScript
const componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicUrl's origin seller: "https://testSeller.com", decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600])!; // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
- Veja também
configKey
-
configKey: string
-
A chave de configuração associada a este leilão de componente.
Esse valor não pode estar vazio e precisa ser exclusivo. Se dois objetosComponentAuctionConfig
compartilharem o mesmo valor de configKey, o último a ser definido substituirá as configurações anteriores. -
googletag.config.InterstitialConfig
Um objeto que define o comportamento de um único espaço de anúncio intersticial.
Resumo da propriedade | |
---|---|
triggers
|
A configuração do acionador do intersticial para este anúncio intersticial.
|
triggers
-
triggers: Partial<Record<InterstitialTrigger, boolean>>
-
A configuração do acionador intersticial para este anúncio intersticial.
Definir o valor de um acionador intersticial comotrue
o ativa efalse
o desativa. Isso substitui os valores padrão configurados no Google Ad Manager. -
- Exemplo
-
JavaScript
// Define a GPT managed web interstitial ad slot. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL ); // Enable optional interstitial triggers. // Change this value to false to disable. const enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
JavaScript (legado)
// Define a GPT managed web interstitial ad slot. var interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL ); // Enable optional interstitial triggers. // Change this value to false to disable. var enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
TypeScript
// Define a GPT managed web interstitial ad slot. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL )!; // Enable optional interstitial triggers. // Change this value to false to disable. const enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
- Veja também
googletag.config.PageSettingsConfig
Interface de configuração principal para configurações no nível da página.
Permite definir vários recursos com uma única chamada de API.
Todas as propriedades listadas abaixo são exemplos e não refletem os recursos reais que utilizam setConfig. Para saber quais são os recursos, consulte os campos do tipo PageSettingsConfig abaixo.
Exemplos:
- Somente os recursos especificados na chamada
setConfig
são modificados.// Configure feature alpha. googletag.setConfig({ alpha: {...} }); // Configure feature bravo. Feature alpha is unchanged. googletag.setConfig({ bravo: {...} });
- Todas as configurações de um determinado recurso são atualizadas a cada chamada para
setConfig
.// Configure feature charlie to echo = 1, foxtrot = true. googletag.setConfig({ charlie: { echo: 1, foxtrot: true, } }); // Update feature charlie to echo = 2. Since foxtrot was not specified, // the value is cleared. googletag.setConfig({ charlie: { echo: 2 } });
- Todas as configurações de um recurso podem ser apagadas 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, });
Resumo da propriedade | |
---|---|
adExpansion
|
Configurações para controlar a expansão de anúncios.
|
pps
|
Configurações para controlar os identificadores fornecidos pelo editor (PPS, na sigla em inglês).
|
privacyTreatments
|
Configurações para controlar os tratamentos de privacidade do editor.
|
adExpansion
-
adExpansion: null | AdExpansionConfig
-
Configurações para controlar a expansão de anúncios.
-
pps
-
pps: null | PublisherProvidedSignalsConfig
-
Configurações para controlar os identificadores fornecidos pelo editor (PPS, na sigla em inglês).
-
privacyTreatments
-
privacyTreatments: null | PrivacyTreatmentsConfig
-
Configurações para controlar os tratamentos de privacidade do editor.
-
googletag.config.PrivacyTreatmentsConfig
Configurações para controlar os tratamentos de privacidade do editor.
Resumo da propriedade | |
---|---|
treatments
|
Uma série de tratamentos de privacidade do editor a serem ativados.
|
treatments
-
treatments: "disablePersonalization"[]
-
Uma série de tratamentos de privacidade do editor a serem ativados.
-
- Exemplo
-
JavaScript
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
JavaScript (legado)
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
TypeScript
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
googletag.config.PublisherProvidedSignalsConfig
Objeto de configuração dos indicadores fornecidos pelo editor (PPS, na sigla em inglês).
Resumo da propriedade | |
---|---|
taxonomies
|
Um objeto que contém mapeamentos de Taxonomy.
|
- Exemplo
-
JavaScript
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 18-20' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
JavaScript (legado)
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 18-20' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
TypeScript
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 18-20' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
- Veja também
taxonomies
-
taxonomies: Partial<Record<Taxonomy, TaxonomyData>>
-
Um objeto que contém mapeamentos de Taxonomy.
-
googletag.config.SlotSettingsConfig
Interface de configuração principal para configurações no nível do slot.
Permite definir vários recursos com uma única chamada de API para um único slot.
Todas as propriedades listadas abaixo são exemplos e não refletem recursos reais que usam setConfig. Para saber mais sobre o conjunto de recursos, consulte os campos do 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, });
Resumo da propriedade | |
---|---|
adExpansion
|
Configurações para controlar a expansão de anúncios.
|
componentAuction
|
É um conjunto de leilões de componentes que serão incluídos em um leilão de anúncios no dispositivo.
|
interstitial
|
Configurações que controlam o comportamento do espaço de anúncio intersticial.
|
adExpansion
-
adExpansion: AdExpansionConfig
-
Configurações para controlar a expansão de anúncios.
-
componentAuction
-
componentAuction: ComponentAuctionConfig[]
-
É um conjunto de leilões de componentes que serão incluídos em um leilão de anúncios no dispositivo.
-
interstitial
-
interstitial: InterstitialConfig
-
Configurações que controlam o comportamento do espaço de anúncio intersticial.
-
googletag.config.TaxonomyData
Um objeto que contém os valores de uma única Taxonomy.
Resumo da propriedade | |
---|---|
values
|
Uma lista de valores de Taxonomy.
|
values
-
values: string[]
-
Uma lista de valores de Taxonomy.
-
googletag.events.Event
Interface de base para todos os eventos da GPT. Todos os eventos da GPT abaixo terão os campos a seguir.
Resumo da propriedade | |
---|---|
serviceName
|
Nome do serviço que acionou o evento.
|
slot
|
O espaço que acionou o evento.
|
- Veja também
serviceName
-
serviceName: string
-
Nome do serviço que acionou o evento.
-
slot
-
slot: Slot
-
O espaço que acionou o evento.
-
googletag.events.EventTypeMap
Este é um pseudotipo que mapeia um nome de evento para o tipo de objeto de evento correspondente em Service.addEventListener
e Service.removeEventListener
. Ela é documentada apenas para fins de referência e segurança de tipos.
Resumo da propriedade | |
---|---|
impressionViewable
|
Alias para
events.ImpressionViewableEvent .
|
rewardedSlotClosed
|
Alias para
events.RewardedSlotClosedEvent .
|
rewardedSlotGranted
|
Alias para
events.RewardedSlotGrantedEvent .
|
rewardedSlotReady
|
Alias para
events.RewardedSlotReadyEvent .
|
slotOnload
|
Alias para
events.SlotOnloadEvent .
|
slotRenderEnded
|
Alias para
events.SlotRenderEndedEvent .
|
slotRequested
|
Alias para
events.SlotRequestedEvent .
|
slotResponseReceived
|
Alias para
events.SlotResponseReceived .
|
slotVisibilityChanged
|
Alias para
events.SlotVisibilityChangedEvent .
|
impressionViewable
-
impressionViewable: ImpressionViewableEvent
-
Alias para
events.ImpressionViewableEvent
. -
rewardedSlotClosed
-
rewardedSlotClosed: RewardedSlotClosedEvent
-
Alias para
events.RewardedSlotClosedEvent
. -
rewardedSlotGranted
-
rewardedSlotGranted: RewardedSlotGrantedEvent
-
Alias para
events.RewardedSlotGrantedEvent
. -
rewardedSlotReady
-
rewardedSlotReady: RewardedSlotReadyEvent
-
Alias para
events.RewardedSlotReadyEvent
. -
slotOnload
-
slotOnload: SlotOnloadEvent
-
Alias para
events.SlotOnloadEvent
. -
slotRenderEnded
-
slotRenderEnded: SlotRenderEndedEvent
-
Alias para
events.SlotRenderEndedEvent
. -
slotRequested
-
slotRequested: SlotRequestedEvent
-
Alias para
events.SlotRequestedEvent
. -
slotResponseReceived
-
slotResponseReceived: SlotResponseReceived
-
Alias para
events.SlotResponseReceived
. -
slotVisibilityChanged
-
slotVisibilityChanged: SlotVisibilityChangedEvent
-
Alias para
events.SlotVisibilityChangedEvent
. -
googletag.events.ImpressionViewableEvent
Estende
Este evento é disparado quando uma impressão se torna visível, de acordo com os critérios do Active View.
Resumo da propriedade | |
---|---|
serviceName
|
Nome do serviço que acionou o evento.
Herdado de
|
slot
|
O espaço 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. } });
- Veja também
googletag.events.RewardedSlotClosedEvent
Estende
Este evento é disparado quando um espaço de anúncio premiado é fechado pelo usuário. Ela pode ser disparada antes ou depois da concessão de uma recompensa. Para determinar se um prêmio foi concedido, use events.RewardedSlotGrantedEvent
.
Resumo da propriedade | |
---|---|
serviceName
|
Nome do serviço que acionou o evento.
Herdado de
|
slot
|
O espaço 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. } });
- Veja também
googletag.events.RewardedSlotGrantedEvent
Estende
Este evento é disparado quando uma recompensa é concedida por visualizar um anúncio premiado. Se o anúncio for fechado antes que os critérios para concessão de um prêmio sejam atendidos, esse evento não será disparado.
Resumo da propriedade | |
---|---|
payload
|
Um objeto contendo informações sobre a recompensa que foi concedida.
|
serviceName
|
Nome do serviço que acionou o evento.
Herdado de
|
slot
|
O espaço 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. } });
- Veja também
payload
-
payload: null | RewardedPayload
-
Um objeto contendo informações sobre a recompensa que foi concedida.
-
googletag.events.RewardedSlotReadyEvent
Estende
Este evento é disparado quando um anúncio premiado está pronto para ser exibido. O editor é responsável por apresentar ao usuário a opção de visualizar o anúncio antes de exibi-lo.
Resumo da propriedade | |
---|---|
serviceName
|
Nome do serviço que acionou o evento.
Herdado de
|
slot
|
O espaço que acionou o evento.
Herdado de
|
Resumo dos métodos | |
---|---|
makeRewardedVisible
|
Exibe o anúncio premiado.
|
- Exemplo
-
JavaScript
// This listener is called when a rewarded ad slot becomes ready to be // displayed. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotReady", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed."); // Replace with custom logic. const userHasConsented = true; if (userHasConsented) { event.makeRewardedVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (legado)
// This listener is called when a rewarded ad slot becomes ready to be // displayed. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotReady", function (event) { var slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed."); // Replace with custom logic. var userHasConsented = true; if (userHasConsented) { event.makeRewardedVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a rewarded ad slot becomes ready to be // displayed. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotReady", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed."); // Replace with custom logic. const userHasConsented = true; if (userHasConsented) { event.makeRewardedVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
- Veja também
makeRewardedVisible
-
makeRewardedVisible(): void
-
Exibe o anúncio premiado. Esse método não deve ser chamado até que o usuário autorize a visualização do anúncio.
-
googletag.events.SlotOnloadEvent
Estende
Este evento é disparado quando o iframe do criativo dispara o evento de carregamento. Ao renderizar anúncios rich media no modo de renderização síncrona, nenhum iframe é usado, portanto nenhum SlotOnloadEvent
será disparado.
Resumo da propriedade | |
---|---|
serviceName
|
Nome do serviço que acionou o evento.
Herdado de
|
slot
|
O espaço 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. } });
- Veja também
googletag.events.SlotRenderEndedEvent
Estende
Este evento é disparado quando o código do criativo é injetado em um espaço. Esse evento ocorrerá antes que os recursos do criativo sejam buscados. Por isso, talvez o criativo ainda não esteja visível. Se você precisar saber quando todos os recursos do criativo para um espaço foram carregados, use events.SlotOnloadEvent
.
Resumo da propriedade | |
---|---|
advertiserId
|
ID do anunciante do anúncio renderizado.
|
campaignId
|
ID da campanha do anúncio renderizado.
|
companyIds
|
IDs das empresas que oferecem lances para o anúncio de preenchimento renderizado.
|
creativeId
|
ID do criativo do anúncio de reserva renderizado.
|
creativeTemplateId
|
ID do modelo de criativo do anúncio de reserva renderizado.
|
isBackfill
|
Indica se o anúncio foi de preenchimento.
|
isEmpty
|
Indica se um anúncio foi retornado para o espaço.
|
labelIds
|
IDs de rótulos do anúncio renderizado.
|
lineItemId
|
ID do item de linha do anúncio de reserva renderizado.
|
serviceName
|
Nome do serviço que acionou o evento.
Herdado de
|
size
|
Indica o tamanho do pixel do criativo renderizado.
|
slot
|
O espaço que acionou o evento.
Herdado de
|
slotContentChanged
|
Se o conteúdo do espaço foi alterado com o anúncio renderizado.
|
sourceAgnosticCreativeId
|
ID do criativo do anúncio de reserva ou preenchimento renderizado.
|
sourceAgnosticLineItemId
|
ID do item de linha do anúncio de reserva ou preenchimento renderizado.
|
yieldGroupIds
|
IDs dos grupos de rendimento do anúncio de preenchimento renderizado.
|
- Exemplo
-
JavaScript
// This listener is called when a slot has finished rendering. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", (event) => { const slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Label IDs:", event.labelIds); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (legado)
// This listener is called when a slot has finished rendering. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", function (event) { var slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Label IDs:", event.labelIds); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a slot has finished rendering. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", (event) => { const slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Label IDs:", event.labelIds); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
- Veja também
advertiserId
-
advertiserId: null | number
-
ID do anunciante do anúncio renderizado. O valor é
null
para espaços vazios, anúncios de preenchimento e criativos renderizados por serviços diferentes dePubAdsService
. -
campaignId
-
campaignId: null | number
-
ID da campanha do anúncio renderizado. O valor é
null
para espaços vazios, anúncios de preenchimento e criativos renderizados por serviços diferentes dePubAdsService
. -
companyIds
-
companyIds: null | number[]
-
IDs das empresas que oferecem lances para o anúncio de preenchimento renderizado. O valor é
null
para espaços vazios, anúncios de reserva e criativos renderizados por serviços diferentes dePubAdsService
. -
creativeId
-
creativeId: null | number
-
ID do criativo do anúncio de reserva renderizado. O valor é
null
para espaços vazios, anúncios de preenchimento e criativos renderizados por serviços diferentes dePubAdsService
. -
creativeTemplateId
-
creativeTemplateId: null | number
-
ID do modelo de criativo do anúncio de reserva renderizado. O valor é
null
para espaços vazios, anúncios de preenchimento e criativos renderizados por serviços diferentes dePubAdsService
. -
isBackfill
-
isBackfill: boolean
-
Indica se o anúncio foi de preenchimento. O valor será
true
se o anúncio for de preenchimento. Caso contrário, o valor seráfalse
. -
isEmpty
-
isEmpty: boolean
-
Indica se um anúncio foi retornado para o espaço. O valor será
true
se nenhum anúncio for retornado. Caso contrário, o valor seráfalse
. -
labelIds
-
labelIds: null | number[]
-
IDs de rótulos do anúncio renderizado. O valor é
null
para espaços vazios, anúncios de preenchimento e criativos renderizados por serviços diferentes dePubAdsService
. -
lineItemId
-
lineItemId: null | number
-
ID do item de linha do anúncio de reserva renderizado. O valor é
null
para espaços vazios, anúncios de preenchimento e criativos renderizados por serviços diferentes dePubAdsService
. -
size
-
size: null | string | number[]
-
Indica o tamanho do pixel do criativo renderizado. Exemplo:
[728, 90]
. O valor énull
para espaços de anúncio vazios. -
slotContentChanged
-
slotContentChanged: boolean
-
Se o conteúdo do espaço foi alterado com o anúncio renderizado. O valor será
true
se o conteúdo tiver sido alterado. Caso contrário, o valor seráfalse
. -
sourceAgnosticCreativeId
-
sourceAgnosticCreativeId: null | number
-
ID do criativo do anúncio de reserva ou preenchimento renderizado. O valor será
null
se o anúncio não for um preenchimento de reserva ou item de linha ou se o criativo for renderizado por serviços diferentes dePubAdsService
. -
sourceAgnosticLineItemId
-
sourceAgnosticLineItemId: null | number
-
ID do item de linha do anúncio de reserva ou preenchimento renderizado. O valor será
null
se o anúncio não for um preenchimento de reserva ou item de linha ou se o criativo for renderizado por serviços diferentes dePubAdsService
. -
yieldGroupIds
-
yieldGroupIds: null | number[]
-
IDs dos grupos de rendimento do anúncio de preenchimento renderizado. O valor é
null
para espaços vazios, anúncios de reserva e criativos renderizados por serviços diferentes dePubAdsService
. -
googletag.events.SlotRequestedEvent
Estende
Este evento é disparado quando um anúncio é solicitado para um espaço específico.
Resumo da propriedade | |
---|---|
serviceName
|
Nome do serviço que acionou o evento.
Herdado de
|
slot
|
O espaço 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. } });
- Veja também
googletag.events.SlotResponseReceived
Estende
Este evento é disparado quando uma resposta de anúncio é recebida para um espaço em particular.
Resumo da propriedade | |
---|---|
serviceName
|
Nome do serviço que acionou o evento.
Herdado de
|
slot
|
O espaço 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. } });
- Veja também
googletag.events.SlotVisibilityChangedEvent
Estende
Este evento é disparado sempre que a porcentagem na tela da área de um espaço de anúncio é alterada. O evento é limitado e não será acionado mais de uma vez a cada 200 ms.
Resumo da propriedade | |
---|---|
inViewPercentage
|
A porcentagem da área do anúncio que é visível.
|
serviceName
|
Nome do serviço que acionou o evento.
Herdado de
|
slot
|
O espaço 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. } });
- Veja também
inViewPercentage
-
inViewPercentage: number
-
A porcentagem da área do anúncio que é visível. O valor é um número entre 0 e 100.
-
googletag.secureSignals.BidderSignalProvider
Retorna um indicador seguro para um bidder específico.
Um provedor de indicador seguro do bidder consiste em duas partes:
- Uma função de coletor, que retorna um
Promise
que se refere a um indicador seguro. - Um
id
que identifica o bidder associado ao indicador.
secureSignals.PublisherSignalProvider
.
Resumo da propriedade | |
---|---|
collectorFunction
|
.
|
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"); }, });
- Veja também
collectorFunction
-
collectorFunction: () => Promise<string>
-
id
-
id: string
-
É um identificador exclusivo do coletor associado a esse indicador seguro, conforme registrado no Google Ad Manager.
-
googletag.secureSignals.PublisherSignalProvider
Retorna um indicador seguro para um editor específico.
Um provedor de indicador do editor é composto por duas partes:
- Uma função de coletor, que retorna um
Promise
que se refere a um indicador seguro. - Uma
networkCode
que identifica o editor associado ao indicador.
secureSignals.BidderSignalProvider
.
Resumo da propriedade | |
---|---|
collectorFunction
|
.
|
networkCode
|
O código de rede (conforme visto no caminho do bloco de anúncios) do editor associado a esse indicador seguro.
|
- Exemplo
-
JavaScript
// networkCode is provided googletag.secureSignalProviders.push({ networkCode: "123456", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
JavaScript (legado)
// networkCode is provided googletag.secureSignalProviders.push({ networkCode: "123456", collectorFunction: function () { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
TypeScript
// networkCode is provided googletag.secureSignalProviders!.push({ networkCode: "123456", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
- Veja também
collectorFunction
-
collectorFunction: () => Promise<string>
-
networkCode
-
networkCode: string
-
O código de rede (conforme visto no caminho do bloco de anúncios) do editor associado a esse indicador seguro.
-
googletag.secureSignals.SecureSignalProvidersArray
Uma interface para gerenciar indicadores seguros.
Resumo dos métodos | |
---|---|
clearAllCache
|
Limpa todos os sinais em cache do armazenamento local.
|
push
|
Adiciona um novo
secureSignals.SecureSignalProvider à matriz do provedor de indicadores e inicia o processo de geração de indicadores.
|
clearAllCache
-
clearAllCache(): void
-
Limpa todos os sinais em cache do armazenamento local.
-
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 objetosecureSignals.SecureSignalProvider
que será adicionado à matriz.