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 |
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, exceto na pesquisa relacionada nas páginas de conteúdo. Esta é 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 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.
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:
Observação:esse parâmetro é obrigatório ao usar o parâmetro 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.
Observação:ao usar esse parâmetro, Exemplos: 'terms' : 'cars rental, flight ticket' |
ignoredPageParams
|
Opcional Especifica a lista de parâmetros de URL para uma página de conteúdo com um bloco de pesquisa relacionada para conteúdo que podem ser ignorados com segurança sem afetar o conteúdo principal ou a experiência do usuário. Observação: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 das páginas de conteúdo que contêm parâmetros de consulta, como variáveis de acompanhamento, IDs do 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 a gerar termos de pesquisa relacionados imprecisos ou irrelevantes. Esse 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 a carga de rastreamento desnecessária. Isso permite que o Google reconheça melhor uma página como já tendo sido rastreada e comece a mostrar os termos sugeridos (tanto do Google quanto do parceiro, se qualificado). As seguintes diretrizes se aplicam ao uso desse parâmetro:
Exemplos:
http://example.com/content?utm_medium=social&page_id=123&click_id=456Fornecer os seguintes parâmetros de URL que podem ser ignorados: '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 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:
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 O valor padrão de
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
oe
|
Opcional O parâmetro O valor padrão de
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
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.
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:
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 |