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
É seu ID do cliente do Google AdSense. O pubId é a parte do ID do cliente que vem depois de "partner-". Por exemplo, se o ID 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.
Essa é a consulta de pesquisa inserida pelo usuário. O valor do parâmetro de consulta não pode ser codificado.

Observação:o uso desse parâmetro na pesquisa relacionada em páginas de conteúdo gera 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 em que o usuário clicou. O resultsPageBaseUrl pode incluir seus 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 os blocos de pesquisa relacionada são solicitados. Ele controla o tipo de experiência de pesquisa relacionada que é exibido, dependendo do contexto da página:
  • 'content' Use essa 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 pesquisa relacionada nas páginas de resultados da Pesquisa.

Observação: o parâmetro da página relatedSearchSegmentação é definido automaticamente como "consulta" por padrão. No entanto, é importante observar que esse valor padrão foi projetado especificamente para ser usado apenas em 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), será necessário definir 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 desse parâmetro da página.
  • Fazer declarações falsas sobre o tipo de página ou confiar na configuração padrão de "consulta" do parâmetro relatedSearchSegmentação em páginas de resultados que não são de pesquisa são consideradas uma violação das instruções por escrito.
  • O Google pode verificar periodicamente a precisão desse valor, independentemente de ele ter sido definido manualmente ou usar o padrão.

Por exemplo:

'relatedSearchTargeting' : 'content'
'relatedSearchTargeting' : 'query'
styleId Obrigatório
Especifica o ID do estilo de pesquisa personalizado a 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, os anúncios ou pesquisas relacionadas serão renderizados com o estilo, e os parâmetros de estilo legados serão ignorados. 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 clicar 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 estiver sob seu controle, esse parâmetro precisará ser definido como o texto do criativo 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.
  • Use somente no tráfego que vem intencionalmente de outros sites, e não no tráfego orgânico.
  • Ele deve incluir o título e/ou a descrição do criativo do anúncio ou link.
  • Incluir valores que não fazem parte do criativo do anúncio ou link é 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. Caracteres unicode / diacríticos são aceitos.
  • 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 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 que serão retornados com uma solicitação de pesquisa relacionada, 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 para uma página de conteúdo com uma unidade de pesquisa relacionada para conteúdo, que pode ser ignorada com segurança sem afetar o conteúdo principal ou a experiência do usuário.

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

A pesquisa relacionada no conteúdo depende do sistema de rastreamento de conteúdo do Google para indexar páginas e gerar termos de pesquisa relevantes. Os URLs de páginas de conteúdo que contêm parâmetros de consulta, como variáveis de acompanhamento, IDs de usuários, 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 resultar em termos de pesquisa relacionados imprecisos ou irrelevantes. Este parâmetro de página instrui o rastreador do Google a ignorar esses parâmetros não essenciais, garantindo a indexação adequada do conteúdo e reduzindo o carregamento desnecessário de rastreamento. 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).

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 precisa ser uma lista de parâmetros de URL separada por vírgulas que pode aparecer quando um usuário acessa 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 impacto significativo no conteúdo, na aparência ou na experiência do usuário da página.
  • A inclusão de um parâmetro de URL que tenha um impacto significativo no conteúdo, na aparência ou na experiência do usuário das páginas é considerada uma violação das 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 em que 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'
O URL da página de conteúdo seria tratado 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. 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 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 que têm uma sobreposição de "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 vai receber pelos anúncios mostrados.

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

Exemplo:

'adtest' : 'on'

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

Vários canais precisam ser separados pelo 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 precisam 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  
grega 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 All
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 do 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  
grega 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 All
ivt Opcional
Com esse parâmetro, é possível fornecer um booleano que informa ao Google que você quer permitir anúncios que usam armazenamento local e cookies exclusivos 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", é definido um cookie exclusivo para tráfego inválido e usamos o armazenamento local apenas no tráfego consentido.
  • false Quando você define esse parâmetro como "false", um cookie exclusivo para tráfego inválido é definido e usa o armazenamento local para o tráfego com ou 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 vazio <div> onde o anúncio deve 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 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 anúncio ou do 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 forem carregados ou quando nenhum anúncio ou pesquisa relacionada for veiculado. O parâmetro precisa ser definido como uma função de callback JavaScript que você implementa, permitindo que uma ação seja realizada quando a chamada de anúncio for 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 há pelo menos um anúncio ou termo de pesquisa relacionada para exibir e como "false" quando nenhum anúncio ou pesquisa relacionada é retornado.
isExperimentVariant Defina como verdadeiro 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 aparecerá no mapa.

Observação: teste a função de callback para garantir que ela não gere erros, principalmente se ela 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