Referência

Parâmetros

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

Esses parâmetros só precisam ser especificados uma vez por página. Eles afetam todos os blocos na página.

Obrigatório

Parâmetro Descrição e exemplos
adPage Obrigatório quando o usuário navega para a próxima página de resultados ou para a anterior.

O parâmetro adPage especifica a página de resultados em que os anúncios são exibidos. 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 anúncios retornados serão a segunda página dos cinco anúncios.

pubId Obrigatório
Esse é seu ID de cliente do Google 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 em páginas de conteúdo.
Esta é a consulta de pesquisa inserida pelo usuário. O valor do parâmetro de consulta deve ser não codificado.

Observação: usar esse parâmetro na pesquisa relacionada nas páginas de conteúdo fará com que 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 na qual a consulta de pesquisa é a termo de pesquisa relacionada em que o usuário clicou. O resultsPageBaseUrl pode incluir o próprio , 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 os blocos de pesquisa relacionada são solicitados. Ele controla que tipo A experiência de pesquisa relacionada é exibida de acordo com o contexto da página:
  • 'content' Use esta opção para a pesquisa relacionada em páginas de conteúdo (por exemplo, artigos, postagens de blog).
  • 'query' Use essa opção exclusivamente para a pesquisa relacionada no Páginas de resultados de pesquisa.

Observação: o parâmetro da página relatedSearchSegmentação é definido automaticamente como "query" por padrão. No entanto, é importante observar que esse valor padrão é especificamente projetada somente para páginas de resultados de pesquisa (pesquisa relacionada na Pesquisa). Se você for usando a pesquisa relacionada em qualquer outro tipo de página (por exemplo, artigos, postagens de blog), você precisa defina explicitamente o parâmetro 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 deste page.
  • Fazer declarações falsas sobre o tipo de página ou usar a "consulta" padrão da configuração O parâmetro relatedSearchSegmentação em páginas de resultados que não sejam de pesquisa será considerado uma violação de essas instruções por escrito.
  • O Google pode verificar periodicamente a precisão desse valor, independentemente de estar configurado ou não 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 aos blocos de anúncios ou de pesquisa relacionada na da página. Saiba mais sobre como usar estilos de pesquisa personalizados. Com o styleId definido para uma solicitação, anúncios ou pesquisas relacionadas serão renderizados com o estilo, e os parâmetros de estilo legados serão ignorada. Se 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 o clique em um anúncio abre na mesma janela ou em uma nova janela. O padrão é "_top". Esse parâmetro também pode ser usado no nível da unidade.
  • '_top' Abre na mesma janela.
  • '_blank' Abre em uma nova janela.

Exemplo: 

'linkTarget' : '_blank'
maxTermLength Opcional
Especifica o número máximo de caracteres de um termo de pesquisa relacionada, incluindo espaços. Não há um valor máximo se não for definido.

Exemplo: 

'maxTermLength' : 50
referrerAdCreative Opcional
Se um usuário acessar sua página de conteúdo que contém um bloco de pesquisa relacionada para conteúdo clicando em um anúncio ou link em outro site, e esse anúncio ou link está sob seu controle, esse parâmetro deve ser definido como o texto do anúncio desse anúncio ou link na íntegra.

As diretrizes a seguir se aplicam ao uso desse parâmetro:

  • O parâmetro só deve ser fornecido em uma solicitação de pesquisa relacionada para conteúdo e será ignorado em todas as outras solicitações.
  • Ela só deve ser usada no tráfego que você intencionalmente vem de outros sites e não devem ser usadas em tráfego orgânico.
  • Ele deve incluir a linha do título, a descrição e/ou qualquer outro texto no anúncio ou criativo de link.
  • A omissão de valores do criativo do anúncio ou link (ou inclusão de valores adicionais) é considerado uma violação dessas instruções por escrito.
  • Não diferencia maiúsculas e minúsculas.
  • Ele aceita codificação UTF-8 válida. Há suporte para caracteres Unicode / diacríticos.
  • O Google pode usar ou ignorar o parâmetro enviado. Quando usado, pode afetar a seleção e a classificação dos termos.

Observação: esse parâmetro é obrigatório ao usar o 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. Se não for especificado, o padrão será "q".

Exemplo: 

'resultsPageQueryParam' : 'query'
terms Opcional
Esse parâmetro permite fornecer uma lista delimitada por vírgulas dos seus próprios termos de pesquisa relacionada. sejam retornados com uma solicitação de pesquisa relacionada, embora o Google possa ou não usar o 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 para uma página de conteúdo com uma pesquisa relacionada de conteúdo que pode ser ignorada com segurança sem afetar o conteúdo principal nem a experiência do usuário.

Observação:para que os termos de pesquisa relacionada possam ser exibidos no seu site, o Google precisa rastrear suas páginas para garantir que os termos sejam contextualmente relevantes. Quando uma página ainda não foi rastreado ou bloqueado para rastreamento (por exemplo, por um robots.txt) pelo Rastreador do AdSense, não mostraremos sugestões de termos de pesquisa relacionada que você fornecer ao Google.

A pesquisa relacionada no conteúdo depende do sistema de rastreamento de conteúdo do Google para indexar de pesquisa e gerar termos de pesquisa relevantes. URLs da página de conteúdo que contêm parâmetros de consulta, como já que as variáveis de acompanhamento, os IDs de usuário, os 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 pode levar a resultados imprecisos ou termos de pesquisa relacionados irrelevantes. Este parâmetro de página instrui o rastreador do Google a ignorar parâmetros não essenciais, garantindo a indexação adequada do conteúdo e reduzindo o rastreamento desnecessário carregar. Isso permite que o Google reconheça melhor uma página como já rastreada e comece a mostrando termos sugeridos (do Google e do parceiro, se houver qualificação).

As diretrizes a seguir se aplicam ao uso desse parâmetro:

  • O parâmetro só deve ser fornecido em uma solicitação de pesquisa relacionada para conteúdo e será ignorado em todas as outras solicitações.
  • O valor desse parâmetro deve ser uma lista delimitada por vírgulas de parâmetros de URL que podem aparecem quando um usuário navega até a página de conteúdo.
  • Ele diferencia maiúsculas de minúsculas.
  • Quando qualquer parâmetro de URL desta lista for removido do URL da página de conteúdo, deverá haver não podem afetar de maneira significativa o conteúdo, a aparência ou a experiência do usuário da página.
  • Incluir um parâmetro de URL que impacte significativamente o conteúdo, a aparência ou o experiência do usuário é considerada uma violação dessas instruções por escrito.
  • 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 onde o URL é: 

http://example.com/content?utm_medium=social&page_id=123&click_id=456
 Fornecer os seguintes parâmetros de URL ignoráveis: 
'ignoredPageParams' : 'utm_medium,click_id,session_ref'
 Trate 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 que correspondem à consulta de pesquisa. Veja 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 alto.

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 contabiliza as impressões de anúncios nem acompanha os resultados da 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 provenientes de um domínio que não foi aprovado na guia "Sites" retornarão anúncios com um "anúncio de teste" e não são clicáveis.

Use esse parâmetro ao fazer testes, mas não em sistemas de produção. Caso contrário, você não receberá pelos anúncios exibidos.

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

Exemplo: 

'adtest' : 'on'
channel Opcional
Você pode incluir um canal do AdSense para pesquisas para acompanhar o desempenho de páginas diferentes. Usar o ID exclusivo do canal criado na sua conta do AdSense ou pelo seu Gerente técnico de contas. Saiba mais sobre canais aqui.

Vários canais devem ser separados pelo símbolo 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 AdWords.

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 será usado para interpretar a string de consulta.

O valor padrão do 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 precisa usar para codificar o texto dos anúncios. Embora opcional, é uma prática recomendada transmitir um valor para esse parâmetro.

O valor padrão da 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 um cookie somente para tráfego inválido e armazenamento local para o tráfego com e sem consentimento.
  • true Quando esse parâmetro não está presente ou você o define como "true", Vamos definir um cookie exclusivo para tráfego inválido e usar o armazenamento local apenas em tráfego com consentimento.
  • false Quando você define esse parâmetro como "false" Vamos definir um cookie exclusivo para tráfego inválido e usar o armazenamento local no tráfego com e sem consentimento.

Por padrão, o IVT é definido como verdadeiro.

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úncios vazio <div> em que o anúncio será exibido.

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 a serem exibidos no bloco de anúncios superior.

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

Exemplo:

'maxTop' : 4
width Obrigatório
Especifica a largura do anúncio ou bloco 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 a ser chamada quando os anúncios ou pesquisas relacionadas tiverem carregados ou quando nenhum anúncio ou pesquisa relacionada é veiculado. O parâmetro deve ser definido como Função de callback JavaScript que você implementa e permite que uma ação seja realizada quando o é 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 nenhum anúncio ou pesquisa relacionada é retornado.
isExperimentVariant Defina como verdadeiro se um experimento de estilo personalizado estiver em andamento e a variante do experimental é escolhido 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 parâmetro map<string,int> de editores fornecidos termos para a posição com índice zero desses termos na resposta. Se um termo for fornecido mas não retornada, ele não aparecerá no mapa.

Observação: teste a função de callback para garantir que ela não gere erros. especialmente aquelas que possam interferir no carregamento da página.

Exemplo de um 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 ser exibidos nesse bloco. O valor padrão é 2.

Exemplo: 

'number' : 4
relatedSearches Opcional
O número de pesquisas relacionadas que devem aparecer nesse bloco. O padrão será 0 se nada for especificado.

Exemplo: 

'relatedSearches' : 4