Referência

Parâmetros

Descrições dos parâmetros de nível de página

Esses parâmetros precisam ser especificados apenas uma vez por página. Eles afetam todas as unidades na página.

Obrigatório

Parâmetro Descrição e exemplos
adPage Obrigatório quando o usuário acessa a página de resultados seguintes ou anteriores.

O parâmetro adPage especifica a página de resultados em que os anúncios aparecem. Esse parâmetro é utilizado quando os usuários navegam além da primeira página de resultados de pesquisa. Por exemplo, se cinco anúncios forem solicitados e o parâmetro adPage estiver definido como 2, os cinco anúncios retornados vão aparecer na segunda página.

pubId Obrigatório
É seu ID do cliente do AdSense. O pubId é a parte do ID do cliente que vem depois de "partner-". Por exemplo, se o ID do cliente for "partner-test-property", o pubId será "test-property". Esse é o protocolo padrão para CSAs.

Exemplo: 

'pubId' : 'test-property'
query Obrigatório, exceto na pesquisa relacionada nas páginas de conteúdo.
É a consulta de pesquisa inserida pelo usuário. O valor do parâmetro de consulta não pode estar codificado.

Observação:o uso desse parâmetro na pesquisa relacionada nas páginas de conteúdo vai gerar resultados inesperados.

Exemplos: 

'query' : 'flowers'
 
'query' : 'black & decker'
 
'query' : myQuery // myQuery is a variable containing the search query
resultsPageBaseUrl Obrigatório quando há blocos de pesquisa relacionada na página.
Especifica o URL da página de resultados da pesquisa em que a consulta é o termo de pesquisa relacionada clicado pelo usuário. O resultsPageBaseUrl pode incluir os próprios parâmetros, exceto a consulta de pesquisa, que será anexada automaticamente.

Exemplo: 

'resultsPageBaseUrl' : 'http://www.example.com/search?a=v1&b=v2'
relatedSearchTargeting Obrigatório quando há blocos de pesquisa relacionada na página.
Esse parâmetro é obrigatório quando unidades de pesquisa relacionada são solicitadas. Ele controla o tipo de experiência de pesquisa relacionada que aparece, dependendo do contexto da página:
  • 'content' Use essa opção para a pesquisa relacionada em páginas de conteúdo (por exemplo, artigos e postagens de blog).
  • 'query' Use essa opção exclusivamente para a pesquisa relacionada nas páginas de resultados da pesquisa.

Observação:o parâmetro de página "relatedSearchTargeting" é definido automaticamente como "query" por padrão. No entanto, é importante observar que esse valor padrão é projetado especificamente para somente páginas de resultados da pesquisa (Pesquisa relacionada na Pesquisa). Se você estiver usando a pesquisa relacionada em qualquer outro tipo de página (por exemplo, artigos, postagens de blog), defina o parâmetro explicitamente como "content".

Observação:as diretrizes a seguir se aplicam ao uso desse parâmetro:

  • Alguns recursos de pesquisa relacionada podem ser ativados ou desativados dependendo do valor desse parâmetro de página.
  • A representação incorreta do tipo de página ou a dependência da configuração padrão "query" para o parâmetro "relatedSearchTargeting" em páginas que não são de resultados da pesquisa é considerada uma violação dessas instruções escritas.
  • O Google pode verificar periodicamente a precisão desse valor, independentemente de ele ser definido manualmente ou usando o padrão.

Exemplos:

'relatedSearchTargeting' : 'content'
 
'relatedSearchTargeting' : 'query'
styleId Obrigatório
Especifica o ID do estilo de pesquisa personalizado que será aplicado ao anúncio ou aos blocos de pesquisa relacionada na página. Saiba mais sobre como usar estilos de pesquisa personalizados. Com o styleId definido para uma solicitação, as pesquisas relacionadas ou os anúncios serão renderizados com o estilo, e os parâmetros de estilo legados serão ignorados. Se o styleId não for especificado na solicitação, um estilo padrão do sistema será renderizado.

Exemplo: 

'styleId': '1234567890'

Opcional

Parâmetro Descrição e exemplos
linkTarget Opcional
Especifica se clicar em um anúncio faz ele ser aberto na mesma janela ou em outra nova. O padrão é "_top". Esse parâmetro também pode ser usado no nível do bloco.
  • '_top' Abre na mesma janela.
  • '_blank' Abre em uma nova janela.

Exemplo: 

'linkTarget' : '_blank'
referrerAdCreative Opcional
Se um usuário acessar sua página que contém um bloco de pesquisa relacionada de conteúdo após clicar em um anúncio ou link em outro site, e esse anúncio ou link estiver sob seu controle, esse parâmetro vai precisar usar o texto completo do criativo do anúncio ou link.

Estas diretrizes se aplicam ao uso do parâmetro em questão:

  • O parâmetro só deve ser informado em uma solicitação de pesquisa relacionada de conteúdo e será ignorado em todas as outras solicitações.
  • Só use o parâmetro no tráfego que vem intencionalmente de outros sites, nunca em tráfego orgânico.
  • Ele precisa incluir o título, a descrição e/ou qualquer outra frase no criativo do anúncio ou do link.
  • Omitir valores do criativo do anúncio ou do link (ou incluir valores adicionais) é considerado uma violação dessas instruções escritas.
  • Não diferencia maiúsculas e minúsculas.
  • Ele aceita codificação UTF-8 válida. Caracteres Unicode / diacríticos são compatíveis.
  • O Google pode utilizar ou ignorar o parâmetro enviado. Quando usado, talvez ele afete a seleção e classificação dos termos.

Observação:esse parâmetro é obrigatório ao usar o parâmetro terms.

Exemplos: 

'referrerAdCreative': 'search for ads related to dental implants'

'referrerAdCreative': 'The Early Signs of Psoriatic Arthritis'
resultsPageQueryParam Opcional
Especifica o nome do parâmetro de URL da consulta de pesquisa na página de resultados da pesquisa. O padrão será "q" se nada for especificado.

Exemplo: 

'resultsPageQueryParam' : 'query'
terms Opcional
Com esse parâmetro, você pode fornecer uma lista separada por vírgulas dos seus próprios termos de pesquisa relacionada que devem ser retornados com uma solicitação de pesquisa desse tipo, embora o Google possa ou não usar os termos fornecidos aqui.

Observação:ao usar esse parâmetro, referrerAdCreative também é obrigatório, e relatedSearchTargeting é obrigatório e precisa ser definido como "content".

Exemplos: 

'terms' : 'cars rental, flight ticket'
ignoredPageParams Opcional
Especifica a lista de parâmetros de URL de uma página de conteúdo com uma unidade de pesquisa relacionada que pode ser ignorada com segurança sem afetar o conteúdo principal ou a experiência do usuário.

Observação:para que os termos de pesquisa relacionada apareçam no seu site, o Google precisa rastrear suas páginas e garantir que os termos sejam contextualmente relevantes. Quando uma página ainda não foi rastreada ou está bloqueada para rastreamento (por exemplo, por um robots.txt) pelo Rastreador do AdSense, não mostramos os termos de pesquisa relacionados sugeridos que você fornece ao Google.

O produto "Pesquisa relacionada no conteúdo" usa o sistema de rastreamento de conteúdo do Google para indexar páginas e gerar termos de pesquisa relevantes. URLs de páginas de conteúdo com parâmetros de consulta, como variáveis de rastreamento, IDs de usuário, IDs de sessão ou outros identificadores dinâmicos, podem interferir na capacidade do rastreador de avaliar o conteúdo principal da página e podem levar a termos de pesquisa relacionados imprecisos ou irrelevantes. Esse parâmetro instrui o rastreador do Google a ignorar esses parâmetros não essenciais, garantindo a indexação adequada do conteúdo e reduzindo a carga de rastreamento desnecessária. Isso permite que o Google reconheça melhor uma página como já rastreada e comece a mostrar termos sugeridos (do Google e do parceiro, se qualificado).

Estas diretrizes se aplicam ao uso do parâmetro em questão:

  • O parâmetro só deve ser informado em uma solicitação de pesquisa relacionada de conteúdo e será ignorado em todas as outras solicitações.
  • O valor desse parâmetro precisa ser uma lista delimitada por vírgulas de parâmetros de URL que podem aparecer quando qualquer usuário navegar até a página de conteúdo.
  • Ele diferencia maiúsculas de minúsculas.
  • Quando qualquer parâmetro de URL desta lista é removido do URL da página de conteúdo, não deve haver um impacto significativo no conteúdo, na aparência ou na experiência do usuário.
  • A inclusão de um parâmetro de URL que afete significativamente o conteúdo, a aparência ou a experiência do usuário é considerada uma violação dessas instruções escritas.
  • O Google pode verificar periodicamente o efeito de ignorar os parâmetros de URL fornecidos.

Exemplos:
Um usuário visita uma página de conteúdo e o URL é: 

http://example.com/content?utm_medium=social&page_id=123&click_id=456
 Forneça os seguintes parâmetros de URL ignoráveis: 
'ignoredPageParams' : 'utm_medium,click_id,session_ref'
 Trataria o URL da página de conteúdo como: 
http://example.com/content?page_id=123

Definições de configuração

Parâmetro Descrição e exemplos
adsafe Opcional
Especifica as regras de filtragem que o Google deve aplicar aos anúncios relacionados à consulta de pesquisa. Confira a seguir as configurações válidas para adsafe e o efeito de cada valor nos anúncios retornados:
  • 'high' Retorna anúncios indicados para menores. Não retorna anúncios impróprios ou de conteúdo sexual.
  • 'medium' Retorna anúncios indicados e não indicados para menores. Não retorna anúncios de conteúdo sexual adulto.
  • 'low' Retorna todos os tipos de anúncios.

Por padrão, o adsafe é definido como "high".

Exemplo: 

'adsafe': 'medium'
adtest Opcional
O parâmetro adtest é usado para indicar que uma solicitação de anúncios é um teste. Quando o parâmetro adtest tem o valor on, o Google trata a solicitação como um teste e não conta as impressões de anúncios nem acompanha a taxa de cliques.

Quando o parâmetro adtest tem o valor on, você não gera receita.

As solicitações de anúncios com o parâmetro adtest definido como on e provenientes de um domínio que não foi aprovado na guia "Sites" retornam anúncios com uma sobreposição de "anúncio de teste" e não são clicáveis.

Use esse parâmetro ao realizar testes, mas não em sistemas de produção. Se fizer isso, você não receberá pelos anúncios veiculados.

O valor padrão do parâmetro "adtest" é "off".

Exemplo: 

'adtest' : 'on'
channel Opcional
Inclua um canal do AdSense para pesquisas se quiser acompanhar a performance de páginas diferentes. Use o ID do canal exclusivo criado na sua conta do Google AdSense ou pelo seu gerente técnico de contas. Saiba mais sobre os canais neste link.

No caso de vários canais, separe usando o símbolo "+".

Exemplos: 

'channel' :  'testA'  
'channel' :  'testA+testB'
hl Opcional
Esse parâmetro identifica o idioma que os anúncios solicitados ou as pesquisas relacionadas devem segmentar. O valor padrão é en.

O Google aceita todos os códigos de idioma da API Google Ads.

Observação: os anunciantes devem especificar os idiomas em que seus anúncios estão segmentados. Se você incluir esse parâmetro na sua solicitação, o Google retornará somente anúncios segmentados no idioma escolhido ou em todos os idiomas. No entanto, isso não garante que o texto do anúncio estará no idioma especificado.

Normalmente, você deve definir o parâmetro "hl" como o idioma principal da página a partir da qual o parâmetro é enviado.

Exemplos: 

'hl' : 'es'
ie Opcional

O parâmetro ie define o esquema de codificação de caracteres que deve ser usado para interpretar a string de consulta.

O valor padrão de ie é utf-8.

Valor Nome padrão Idiomas associados suportados
latin1 ISO-8859-1 Europa ocidental (alemão, catalão, dinamarquês, espanhol, francês, finlandês, holandês, indonésio, inglês, italiano, norueguês, português e sueco)
latin2 ISO-8859-2 Europa oriental (croata, eslovaco, esloveno, húngaro, polonês, romeno, sérvio e tcheco)
latin3 ISO-8859-3  
latin4 ISO-8859-4 Mar Báltico (estoniano, letão e lituano)
cirílico ISO-8859-5 Búlgaro e russo
arabic ISO-8859-6  
grego ISO-8859-7 Grego
hebrew ISO-8859-8 Hebraico
latin5 ISO-8859-9  
latin6 ISO-8859-10 Islandês
euc-jp EUC-JP Japonês
euc-kr EUC-KR Coreano
sjis Shift_JIS Japonês
big5 Big5 Chinês tradicional
gb GB2312 Chinês simplificado
utf-8 UTF-8 Todos
oe Opcional

O parâmetro oe define o esquema de codificação de caracteres que o Google deve usar para codificar o texto dos anúncios. Embora opcional, é recomendável transmitir um valor para esse parâmetro.

O valor padrão de oe é utf-8.

Valor Nome padrão Idiomas associados suportados
latin1 ISO-8859-1 Europa ocidental (alemão, catalão, dinamarquês, espanhol, francês, finlandês, holandês, indonésio, inglês, italiano, norueguês, português e sueco)
latin2 ISO-8859-2 Europa oriental (croata, eslovaco, esloveno, húngaro, polonês, romeno, sérvio e tcheco)
latin3 ISO-8859-3  
latin4 ISO-8859-4 Mar Báltico (estoniano, letão e lituano)
cirílico ISO-8859-5 Búlgaro e russo
arabic ISO-8859-6  
grego ISO-8859-7 Grego
hebrew ISO-8859-8 Hebraico
latin5 ISO-8859-9  
latin6 ISO-8859-10 Islandês
euc-jp EUC-JP Japonês
euc-kr EUC-KR Coreano
sjis Shift_JIS Japonês
gb GB2312 Chinês simplificado
utf-8 UTF-8 Todos
ivt Opcional
Esse parâmetro permite fornecer um booleano que informa ao Google que você quer permitir anúncios que usam armazenamento local e de cookies exclusivo para tráfego inválido no tráfego com ou sem consentimento.
  • true Quando esse parâmetro não está presente ou é definido como "true", definimos um cookie exclusivo para tráfego inválido e usamos o armazenamento local apenas no tráfego com consentimento.
  • false Quando você define esse parâmetro como "false", definimos um cookie exclusivo para tráfego inválido e usamos o armazenamento local no tráfego com e sem consentimento.

Por padrão, o IVT é definido como "true".

Exemplo: 

'ivt': false

Descrições dos parâmetros de nível de unidade

Esses parâmetros afetam a forma como os blocos de anúncios individuais em uma página são apresentados ao usuário. Cada parâmetro pode ser definido individualmente para cada bloco de anúncios.

Obrigatório

Parâmetro Descrição e exemplos
container Obrigatório
O ID do contêiner de anúncio vazio <div> em que o anúncio deve aparecer.

Exemplo: 

'container' : 'afscontainer1'
maxTop Obrigatório quando o bloco de anúncios está acima dos resultados da pesquisa.

Use esse parâmetro para especificar o número de anúncios que vão aparecer no bloco de anúncios de cima.

Observação: esse parâmetro é usado no lugar do parâmetro "number". Esse bloco de anúncios precisa ter largura suficiente para que a primeira linha dos anúncios não seja quebrada. O uso do parâmetro maxTop em qualquer outro canal na página é uma violação da política.

Exemplo:

'maxTop' : 4
width Obrigatório
Especifica a largura do bloco de anúncios ou de pesquisa relacionada em pixels.

Exemplo: 

'width' : '700px'
 
'width' : 700

Definições de configuração

Parâmetro Descrição e exemplos
adLoadedCallback Opcional
Especifica uma função JavaScript que será chamada quando os anúncios ou pesquisas relacionadas carregarem ou quando nenhuma pesquisa relacionada ou anúncio for veiculado. O parâmetro precisa ser definido como uma função de callback JavaScript que pode ser implementada. Assim, é possível realizar uma ação quando a chamada de anúncio é concluída.

A função de callback usa os seguintes parâmetros:

containerName Nome do contêiner do bloco de anúncios ou de pesquisa relacionada.
adsLoaded Defina como "true" quando houver pelo menos um anúncio ou termo de pesquisa relacionada para exibir e "false" quando nenhuma pesquisa relacionada ou anúncio for retornado.
isExperimentVariant Defina como "true" se um experimento de estilo personalizado estiver em execução e a variante do experimento for escolhida para renderizar os anúncios.
callbackOptions Um objeto JSON que contém os seguintes campos:
termPositions: para um bloco de pesquisa relacionada, contém um map<string,int> de termos fornecidos pelo editor para a posição indexada a zero desses termos na resposta. Se um termo for fornecido, mas não retornado, ele não vai aparecer no mapa.

Observação: teste a função de callback para garantir que ela não gere erros, principalmente aqueles que podem interferir no carregamento da sua página.

Exemplo de callback JavaScript: 

var adblock1 = {
  'container' : 'adblock1_div_id',
  'adLoadedCallback' : function(containerName, adsLoaded,
    isExperimentVariant, callbackOptions) {
    if (adsLoaded) {
       try {
         // most likely do nothing
       } catch (e) {
         alert ("Error in callback function");
         // Do something to handle error gracefully
       }
    } else {
       // as you always do when there is no ad coverage from Google
    }
  }
};
number Opcional
O número de anúncios que devem aparecer nesse bloco. O valor padrão é 2.

Exemplo: 

'number' : 4
relatedSearches Opcional
O número de pesquisas relacionadas que devem aparecer nessa unidade. O padrão é 0 se nada for especificado.

Exemplo: 

'relatedSearches' : 4