Guia de integração

Integrar o módulo da função de permissão da pesquisa

O módulo de permissão da pesquisa permite aos clientes escolher se desejam participar do programa Google Avaliações do Consumidor e transmite as informações de transação necessárias para o Google. É necessário que este módulo esteja presente em todas as páginas de confirmação do pedido para participar do Google Avaliações do Consumidor.

Esta seção inclui os seguintes tópicos:

Se um usuário ativar a função de permissão, o Google envia uma pesquisa depois que o produto é entregue. Para mais informações, consulte pesquisa do Google Avaliações do Consumidor.

A função de permissão da pesquisa funciona em computadores e dispositivos móveis. Certifique-se de adicionar o snippet de código de permissão nos seus sites para computadores e dispositivos móveis.

Instruções de integração

Para incluir o módulo da função de permissão da pesquisa na página de confirmação do pedido, é necessário:

  1. atualizar o DOCTYPE;
  2. adicionar o código da função de permissão.

O código do módulo da função de permissão da pesquisa deve ser colocado na página de confirmação do pedido dos seus fluxos de finalização de compra. As páginas de confirmação precisam usar HTTPS (não HTTP).

Os detalhes do pedido desse módulo precisam ser precisos, pois o módulo aciona a função de permissão da pesquisa para o cliente do Google Avaliações do Consumidor.

Se o seu processo de finalização de compra usa um processador de terceiros, ele precisa redirecionar os clientes de volta para a página de confirmação no seu domínio.

Não oculte o módulo da função de permissão da pesquisa para o cliente do Google Avaliações do Consumidor com outro conteúdo da página de confirmação do pedido.

Atualizar o DOCTYPE

Verifique se a página de confirmação usa o DOCTYPE HTML5:

<!DOCTYPE html>

Esse doctype precisa ser o primeiro item de linha no código HTML da página. Usar o DOCTYPE HTML5 garante que os navegadores da Web renderizem suas páginas no modo padrão em vez de no modo quirks. O modo quirks é uma técnica usada por alguns navegadores da Web para manter a compatibilidade com páginas da Web projetadas para navegadores mais antigos, em vez de ser compatível apenas com os padrões W3C e IETF no modo padrão.

OBSERVAÇÃO: Não inclua comentários ou espaços em branco antes do DOCTYPE.

Adicionar o código da função de permissão

Para dar aos seus clientes a opção de enviar uma avaliação da experiência deles no seu site, adicione o módulo da função de permissão à página de confirmação do pedido.

Para adicionar o módulo da função de permissão da pesquisa à página de confirmação do pedido, faça o seguinte:

  1. Cole o snippet de HTML abaixo na página de confirmação do pedido:
    
    <!-- BEGIN GCR Opt-in Module Code -->
    <script src="https://apis.google.com/js/platform.js?onload=renderOptIn"
      async defer>
    </script>
    
    <script>
      window.renderOptIn = function() { 
        window.gapi.load('surveyoptin', function() {
          window.gapi.surveyoptin.render(
            {
              // REQUIRED
              "merchant_id":"MERCHANT_ID",
              "order_id": "ORDER_ID",
              "email": "CUSTOMER_EMAIL",
              "delivery_country": "COUNTRY_CODE",
              "estimated_delivery_date": "YYYY-MM-DD",
    
              // OPTIONAL
              "opt_in_style": "OPT_IN_STYLE"
            }); 
         });
      }
    </script>
    <!-- END GCR Opt-in Module Code -->
    

    Insira o código antes da tag de fechamento </BODY>. Quando você insere o código do módulo de pesquisa com o código do símbolo, a ordem é irrelevante: um código pode vir antes ou depois do outro.

  2. Substitua os valores em vermelho pelos valores dinâmicos específicos do seu site. A tabela a seguir descreve as configurações disponíveis:

     

    Variável Obrigatório? Descrição

    MERCHANT_ID

    (ID do comerciante)

    Obrigatório Seu ID no Merchant Center. É possível descobrir esse valor no Google Merchant Center.

    ORDER_ID

    (Código do pedido)

    Obrigatório Um código exclusivo para o pedido.

    CUSTOMER_EMAIL

    (E-mail do cliente)

    Obrigatório O endereço de e-mail do cliente no formato nome@domínio.com.

    COUNTRY_CODE

    (Código do país)

    Obrigatório O código do país de duas letras identifica o local em que o pedido do cliente será entregue. Esse valor precisa estar no formato ISO 3166-1 alpha-2. Não use "ZZ" para este campo. Por exemplo, "US". 

    ESTIMATED_DELIVERY_DATE

    (Data de entrega estimada)

    Obrigatório A data de entrega estimada do pedido, em que AAAA é o ano, MM é o mês e DD é o dia. Por exemplo, "2016-09-13".

    OPT_IN_STYLE

    (Estilo da permissão)

    Opcional Especifica como a caixa de diálogo do módulo da função de permissão é exibida. Os valores possíveis são:
    • "CENTER_DIALOG": exibido como uma caixa de diálogo no centro da visualização.
    • "BOTTOM_RIGHT_DIALOG": exibido como uma caixa de diálogo no canto inferior direito da visualização.
    • "BOTTOM_LEFT_DIALOG": exibido como uma caixa de diálogo no canto inferior esquerdo da visualização.
    • "TOP_RIGHT_DIALOG": exibido como uma caixa de diálogo no canto superior direito da visualização.
    • "TOP_LEFT_DIALOG": exibido como uma caixa de diálogo no canto superior esquerdo da visualização.
    • "BOTTOM_TRAY": exibido na parte inferior da visualização.

    O valor padrão é "CENTER_DIALOG".

     

  3. Especifique o idioma do módulo da função de permissão. Para isso, cole o snippet de código abaixo na sua página da Web:
    
    <!-- BEGIN GCR Language Code -->
    <script>
      window.___gcfg = {
        lang: 'LANGUAGE'
      };
    </script>
    <!-- END GCR Language Code -->
    

    Insira o código antes da tag de fechamento </BODY> na página. Quando inserido juntamente com o código da função de permissão, a ordem não importa.

    Defina o valor do parâmetro lang substituindo LANGUAGE por um dos seguintes idiomas compatíveis:

    • af
    • ar-AE
    • cs
    • da
    • de
    • en_AU
    • en_GB
    • en_US
    • es
    • es-419
    • fil
    • fr
    • ga
    • id
    • it
    • iw
    • ja
    • ko
    • ms
    • nl
    • no
    • pl
    • pt_BR
    • pt_PT
    • ru
    • sv
    • th
    • tr
    • uk
    • vi
    • zh-CN
    • zh-TW

    Se você não especificar um valor para o parâmetro lang, o módulo de pesquisa usará uma configuração de idioma com base nas configurações dos navegadores dos usuários.

Exemplo de código da função de permissão da pesquisa

Os valores das variáveis normalmente são substituídos na página de confirmação do pedido pelo código do servidor. O exemplo abaixo mostra como você pode implementar o código do módulo da função de permissão com PHP:


<!-- BEGIN GCR Opt-in Module Code -->
<script src="https://apis.google.com/js/platform.js?onload=renderOptIn"
  async defer>
</script>

<script>
  window.renderOptIn = function() { 
    window.gapi.load('surveyoptin', function() {
      window.gapi.surveyoptin.render(
        {
          "merchant_id": 42,
          "order_id": "<?php echo $order_id ?>",
          "email": "<?php echo $email_address ?>",
          "delivery_country": "<?php echo $user_country ?>",
          "estimated_delivery_date": "<?php echo $delivery_date ?>",
          "opt_in_style": "BOTTOM_LEFT_DIALOG"
        }); 
     });
  }
</script>
<!-- END GCR Opt-in Module Code -->

<!-- BEGIN GCR Language Code -->
<script>
  window.___gcfg = {
    lang: 'en_US'
  };
</script>
<!-- END GCR Language Code -->

Se o módulo da função de permissão não aparecer na sua página ou você receber mensagens de erros ao carregar a página, consulte a seção Solução de problemas.

Solução de problemas

Esta seção descreve alguns erros comuns que podem ocorrer ao implementar o código do módulo da função de permissão do Google Avaliações do Consumidor.

O módulo da função de permissão não está visível

Se o módulo da função de permissão não estiver visível na página, procure pelas seguintes fontes de problemas:

Problema Diagnóstico
O código fonte HTML não contém o código do módulo da função de permissão Veja o código fonte HTML no seu navegador e verifique se exatamente uma instância do bloco do código do módulo da função de permissão aparece na página.
O módulo da função de permissão aparece fora da tela ou é ocultado por outros elementos O módulo pode estar renderizado além dos limites da área visível. Tente rolar vertical e horizontalmente por toda a página para ver o módulo.

A página encontra erros de JavaScript

A tabela abaixo lista fontes comuns de problemas com o JavaScript do módulo da função de permissão:

Problema Diagnóstico
Parâmetro obrigatório ausente Ao implementar o código do módulo da função de permissão, os seguintes parâmetros são obrigatórios:

 

  • merchant_id
  • order_id
  • email
  • delivery_country
  • estimated_delivery_date
O DOCTYPE precisa ser HTML 5 Certifique-se de que a página de confirmação do pedido usa o DOCTYPE HTML5:
<!DOCTYPE html>
Parâmetro estimated_delivery_date inválido A data precisa estar no formato AAAA-MM-DD, em que AAAA é o ano com quatro dígitos, MM é o mês com dois dígitos e DD é o dia com dois dígitos. O valor é uma string, que precisa ser colocada entre aspas. Por exemplo, "2016-09-13".
Parâmetro opt_in_style inválido O valor do parâmetro opcional opt_in_style pode ser uma das seguintes strings:
  • "CENTER_DIALOG"
  • "BOTTOM_RIGHT_DIALOG"
  • "BOTTOM_LEFT_DIALOG"
  • "TOP_RIGHT_DIALOG"
  • "TOP_LEFT_DIALOG"
  • "BOTTOM_TRAY"
Não há compatibilidade com o seu navegador Seu navegador precisa ser compatível com HTML 5. Atualize-o para a versão mais recente.

 

O recurso de preenchimento automático do Chrome pode facilitar ainda mais a experiência de pagamento dos seus clientes. Saiba como adicionar ele à sua página de pagamento.
Este artigo foi útil para você?
Como podemos melhorá-lo?