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 da 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 a página de resultados anterior.

O parâmetro adPage especifica a página de resultados em que os anúncios estão sendo 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 de cinco anúncios.

pubId Obrigatório
É seu ID do cliente do Google AdSense. O pubId é a parte do seu 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 o CSA.

Exemplo:

'pubId' : 'test-property'

query Obrigatório
É a consulta de pesquisa inserida pelo usuário. O valor do parâmetro de consulta não deve ser codificado.

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 de pesquisa é o termo de pesquisa relacionada em que o usuário clicou. 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'

styleId Obrigatório
Especifica o ID do estilo de pesquisa personalizado que será aplicado aos blocos de anúncios ou 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 são renderizados com o estilo, e os parâmetros de estilo legados sã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 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 do bloco.
  • '_top' Abre na mesma janela.
  • '_blank' Abre 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 deverá ser definido como o texto do criativo do anúncio ou link.

As seguintes diretrizes 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.
  • Use essa opção somente no tráfego que você vier intencionalmente de outros sites. Ele nunca deve ser usado em tráfego orgânico.
  • Ele pode incluir a linha do título e/ou a descrição do criativo do anúncio ou link.
  • Não diferencia maiúsculas e minúsculas.
  • Ela 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.

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 nada for especificado, o padrão será "q".

Exemplo:

'resultsPageQueryParam' : 'query'

terms Opcional
Com esse parâmetro, você pode 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.

Exemplos:

'terms' : 'cars rental, flight ticket'

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.

Use esse parâmetro ao fazer testes, mas não em sistemas de produção para não receber pelos anúncios que mostrar.

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. Use o ID exclusivo do canal criado na sua conta do Google AdSense ou pelo 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 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 precisa 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  
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 deve usar para codificar o texto dos anúncios. Embora seja tecnicamente opcional, é uma prática recomendada 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  
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, você pode fornecer um booleano informando ao Google que você quer permitir anúncios que usam armazenamento local e cookies exclusivos para tráfego inválido no tráfego com e sem consentimento.
  • true Quando esse parâmetro não estiver presente ou você o definir como "true", vamos definir um cookie exclusivo para tráfego inválido e usar o armazenamento local somente no tráfego consentido.
  • false Quando você define esse parâmetro como "falso", 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 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
ID do contêiner vazio <div> em que 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 deve ter largura suficiente para que a primeira linha dos anúncios não seja quebrada. O uso do parâmetro maxTop em qualquer outra posição 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 que 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 do anúncio é concluída.

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

containerName Nome do contêiner do anúncio ou bloco de pesquisa relacionada.
adsLoaded Defina como "true" quando há pelo menos um anúncio ou termo de pesquisa relacionado para mostrar e "false" quando nenhum anúncio ou pesquisa relacionada é 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 uma posição indexada a zero desses termos na resposta. Se um termo é fornecido, mas não é retornado, ele não aparece no mapa.

Observação: teste sua função de callback para garantir que ela não gere erros, especialmente aqueles que podem 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. Se nada for especificado, o padrão será 0.

Exemplo:

'relatedSearches' : 4