Plataformas de anúncios e lojas online

Pinterest Conversions API para Shopify: um guia de configuração

A Pinterest Conversions API envia as compras do Shopify para o Pinterest a partir do seu servidor. Conheça os eventos, o epik, os dados com hash, a eliminação de duplicados e os testes.

·8 min de leitura·Pela equipa da ROASaurus

Pontos-chave
  • A Conversions API do Pinterest envia eventos de conversão de um servidor para a sua conta de anúncios do Pinterest, a par da Pinterest Tag no navegador.
  • O Pinterest chama checkout a uma compra concluída; envie-a com o valor, a moeda, o ID da encomenda e os artigos.
  • O Pinterest associa os eventos com base nos dados do cliente com hash, no endereço IP com o user agent e no ID de clique epik.
  • O Pinterest elimina duplicados entre um evento da Tag e um evento da API com o mesmo event_id e o mesmo nome de evento e mantém o primeiro; a ROASaurus envia assim os cinco eventos de loja.
  • Teste primeiro com o modo de teste: o Pinterest mantém os eventos de teste fora dos relatórios e da otimização.

A Conversions API do Pinterest é a forma que o Pinterest tem de enviar eventos de conversão de servidor para servidor. A sua loja, ou uma ferramenta como a ROASaurus, envia eventos como compras diretamente para a sua conta de anúncios do Pinterest, em vez de depender apenas da Pinterest Tag no navegador do comprador. O Pinterest usa os dados para relatórios de conversão, otimização de campanhas e segmentação.

Este guia aborda a API v5 e os eventos que aceita, o ID de clique epik, como os dados do cliente recebem hash, como funciona a eliminação de duplicados com a Pinterest Tag, como testar e como configurar tudo no Shopify.

O que é a Conversions API do Pinterest?

A Pinterest Tag é um script no navegador do comprador. A Conversions API faz o mesmo trabalho a partir de um servidor. Na versão 5 da API, envia os eventos para o endpoint de eventos da sua conta de anúncios, autorizado com um token de acesso de conversões que cria no Pinterest Ads Manager. Cada evento indica onde aconteceu: numa loja online, a origem da ação é web.

O Pinterest pede aos anunciantes que também usam a Tag que evitem contar uma conversão duas vezes, passando um event_id com cada evento. Pede também eventos em tempo real, ou no máximo uma hora depois de acontecerem.

No Shopify, uma ligação de servidor tem uma vantagem clara: as compras vêm da própria encomenda. O Shopify comunica cada encomenda paga à ROASaurus por webhook, e a ROASaurus envia-a ao Pinterest pouco depois do pagamento, tenha a Tag disparado ou não no navegador. O guia de tracking server-side no Shopify explica a ideia com mais pormenor.

Pinterest Tag (navegador)
  • Corre no navegador do comprador
  • Pode ser bloqueada por bloqueadores de anúncios e erros de script
  • Comunica as visitas às páginas à medida que acontecem
Conversions API (servidor)
  • Corre num servidor
  • Envia compras a partir dos dados das suas encomendas
  • Precisa pelo menos de um email, ou de um endereço IP com um user agent
O Pinterest suporta ambos em simultâneo e elimina duplicados nos eventos que partilham um event_id.

Que eventos aceita a Conversions API do Pinterest?

O Pinterest tem uma lista fixa de nomes de eventos padrão, escritos em minúsculas com underscores, como page_visit, add_to_cart e checkout. Pode também definir até 15 tipos de eventos personalizados por anunciante. A ROASaurus mapeia os cinco eventos de loja do Shopify assim:

Ação do compradorNome do evento na APICom eliminação de duplicados com a Tag na ROASaurus
Vê uma páginapage_visitSim
Vê um produtoview_contentSim
Adiciona ao carrinhoadd_to_cartSim
Inicia o checkoutinitiate_checkoutSim
Conclui uma encomendacheckoutSim
O Pinterest chama checkout a uma encomenda concluída. Na ROASaurus, a Tag envia cada evento com o mesmo ID de evento e o nome correspondente da Tag (pagevisit, viewcontent, addtocart, initiatecheckout, checkout).

O nome pode confundir. O checkout do Pinterest é a compra terminada, não o início do checkout. O início do checkout é um evento separado, initiate_checkout.

Para o evento de checkout, o Pinterest recomenda enviar o valor, a moeda, o ID da encomenda, os IDs de conteúdo e o número de artigos. A ROASaurus envia os cinco, mais a quantidade e o preço de cada artigo. O Pinterest pede o valor antes de impostos e de envio. No Shopify, a ROASaurus envia exatamente isso: o total da encomenda menos impostos e envio, a partir do servidor e da tag do navegador. Quando a plataforma de uma loja online não comunica os impostos e o envio em separado, a ROASaurus envia o total da encomenda.

Como é que o Pinterest associa um evento a uma pessoa?

Cada evento traz dados do utilizador. O Pinterest exige pelo menos uma de três coisas: um endereço de email com hash, um ID publicitário móvel com hash, ou o endereço IP juntamente com o user agent. Uma loja online não tem ID publicitário, por isso precisa do email ou do endereço IP e do user agent. A ROASaurus ignora um evento que não tenha nenhum dos dois, em vez de enviar um que o Pinterest não consegue usar.

CampoO que contémEnviado como
emEndereço de emailHash SHA-256 do email em minúsculas
phNúmero de telefoneHash SHA-256
fn, ln, ct, st, zp, countryNome próprio, apelido, cidade, região, código postal e paísHash SHA-256
external_idID de cliente do Shopify ou ID de visitante da ROASaurusHash SHA-256
client_ip_addressO endereço IP do compradorValor simples
client_user_agentO user agent do navegador do compradorValor simples
click_idO valor epik de um clique num anúncio do PinterestValor simples
O user_data que a ROASaurus envia. Os dados pessoais recebem primeiro hash SHA-256; o endereço IP, o user agent e o ID de clique são enviados tal como estão.

O ID de clique epik

O ID de clique do Pinterest pode vir de dois sítios: um parâmetro epik no URL da página de entrada, ou o cookie _epik no seu domínio. O guia da API do Pinterest recomenda passar o valor do cookie _epik, porque continua a funcionar quando o parâmetro do URL falta ou foi removido, o que dá melhor cobertura.

A ROASaurus lê ambos na sua loja, usando o parâmetro do URL quando um novo clique o traz e o cookie nos restantes casos. Guarda o ID de clique com o visitante e envia-o no campo click_id de cada evento do servidor, incluindo a compra. As visitas com um epik contam como visitas do Pinterest nos relatórios de atribuição da ROASaurus.

Exemplo: uma compra tal como a ROASaurus a envia para a Conversions API (hashes encurtados)
POST https://api.pinterest.com/v5/ad_accounts/549755885175/events

{
  "data": [{
    "event_name": "checkout",
    "action_source": "web",
    "event_time": 1793016000,
    "event_id": "order-5512345678901",
    "event_source_url": "https://example-store.com/checkouts/…/thank-you",
    "user_data": {
      "em": ["a3f1…9c2e"],
      "ph": ["7b40…11d8"],
      "external_id": ["e05c…4a7f"],
      "client_ip_address": "203.0.113.24",
      "client_user_agent": "Mozilla/5.0 (iPhone; …)",
      "click_id": "dj0yJnU9…"
    },
    "custom_data": {
      "currency": "USD",
      "value": "84",
      "order_id": "5512345678901",
      "content_ids": ["44123456789"],
      "contents": [{ "id": "44123456789", "quantity": 2, "item_price": "42" }],
      "num_items": 2
    }
  }]
}

Como funciona a eliminação de duplicados com a Pinterest Tag?

Se a Tag e a API comunicarem ambas uma compra, o Pinterest recebe dois eventos para uma encomenda. Para os tratar como um só, precisa do mesmo ID nos dois lados: o ID de evento na Tag tem de coincidir com o event_id no evento do servidor. O Pinterest mantém o primeiro evento que recebe e remove os duplicados que cheguem dentro de 48 horas.

A ROASaurus constrói o ID da compra a partir do ID da encomenda do Shopify. A compra da encomenda 5512345678901 tem o ID de evento order-5512345678901, na Tag que dispara no checkout e no evento do servidor.

Checkout concluídoA Tag dispara checkout com event_id order-5512345678901.
Encomenda pagaO Shopify envia a encomenda paga para a ROASaurus por webhook.
Conversions APIA ROASaurus envia checkout com o mesmo event_id e dados da encomenda com hash.
PinterestMantém a primeira cópia e remove o duplicado.
Uma compra, duas cópias, um event_id. O Pinterest conta a encomenda uma vez.

Os cinco eventos têm eliminação de duplicados

Cada evento de loja na ROASaurus tem um único ID de evento, usado pela Tag no navegador e pelo evento do servidor. A Tag usa os nomes próprios do Pinterest para os mesmos eventos: pagevisit, viewcontent, addtocart, initiatecheckout e checkout, que correspondem a page_visit, view_content, add_to_cart, initiate_checkout e checkout na API. Assim, quando ambos estão ativos, o Pinterest fica com uma única cópia de cada visita de página, visualização de produto, adição ao carrinho, início de checkout e compra.

Eventos que o Pinterest regista numa semana (loja de exemplo)
Só a TagTag e Conversions API
Compras (120 reais)
90
120
Adições ao carrinho (520 reais)
390
520
Loja de exemplo: a Tag vê 75% dos eventos, o servidor vê todos. Com IDs de evento correspondentes, o Pinterest conta cada evento uma só vez.

Pode usá-la de duas formas:

  • Tag e Conversions API em conjunto. A Tag acrescenta sinais do navegador, o servidor preenche o que a Tag não apanha e o Pinterest junta as cópias.
  • Usar a API sem a Tag. Deixe o ID da Tag vazio ou desative Also load the browser tag. Cada evento é então enviado uma só vez, apenas a partir do servidor.

O artigo de ajuda sobre a contagem em duplicado cobre as mesmas verificações para as outras plataformas de anúncios.

Como se testa a Conversions API do Pinterest?

A API tem uma flag de teste. Os pedidos enviados com test=true vão para uma sandbox: o Pinterest trata-os como dados de teste e não os usa para relatórios nem otimização.

  1. Ative o modo de teste

    Na ROASaurus, edite o pixel do Pinterest em Tracking & platforms e assinale Test mode (events show under Test events, max 20). Cada evento do servidor é então enviado com test=true. O Pinterest processa no máximo 20 eventos de teste por lote.

  2. Faça uma encomenda de teste

    Visite a sua loja, veja um produto, adicione-o ao carrinho e conclua uma encomenda.

  3. Leia o resultado

    Abra o Event log. O Pinterest pode responder HTTP 200 mesmo que um evento de um pedido tenha falhado, por isso a ROASaurus verifica o estado de cada evento e mostra aí as falhas.

  4. Desative o modo de teste

    Desmarque o modo de teste, para que os eventos contem nos relatórios e na otimização.

  5. Verifique o Events Overview

    No Pinterest Ads Manager, abra a página Events Overview. Mostra os eventos que chegam e as conversões depois da eliminação de duplicados. O Pinterest recomenda procurar um Event Quality Score de nível Good.

Como configurar a Conversions API do Pinterest no Shopify com a ROASaurus

Precisa de uma loja Shopify com a app ROASaurus e de acesso ao Pinterest Ads Manager. A página da integração com o Pinterest lista todos os campos que a ROASaurus envia.

  1. Ligue a sua loja Shopify

    Vá a Add a store › Shopify, clique em Install app e ative o app embed da ROASaurus no editor de temas. Ele capta o epik e o cookie _epik em todas as páginas. O guia de configuração do Shopify mostra cada passo.

  2. Crie um token de acesso de conversões

    No Pinterest Ads Manager, vá a Conversions e crie um token de acesso de conversões. Anote o ID da sua conta de anúncios.

  3. Adicione o pixel do Pinterest na ROASaurus

    Vá a Tracking & platforms, clique em Add pixel no cartão do Pinterest e preencha Ad account ID e Conversion access token.

  4. Adicione o ID da sua Tag

    Para a eliminação de duplicados com a Tag, preencha Pinterest Tag ID e mantenha Also load the browser tag assinalado. Sem um ID da Tag, a ROASaurus envia apenas eventos do servidor e não carrega a Tag.

  5. Adicione o pixel de checkout

    No Shopify admin › Settings › Customer events, adicione um pixel personalizado com o nome ROASaurus e cole o snippet da sua página Tracking & platforms. Dispara o evento checkout da Tag no checkout do Shopify, com o ID da encomenda como event_id.

  6. Escolha os eventos do servidor e depois teste

    Escolha os eventos do servidor que quer e teste com o modo de teste antes de ativar em produção.

Com Respect visitor consent ativado, que é a predefinição, a ROASaurus segue a escolha do comprador no banner de cookies do Shopify. Quando um comprador recusa os cookies de marketing, a ROASaurus não carrega a Pinterest Tag para ele, não define nenhum ID de visitante, pelo que os seus cliques não ficam associados a ele, e não envia os seus eventos de navegação ao Pinterest. A sua encomenda paga continua a ser enviada para a Conversions API a partir do servidor, com os dados da encomenda com hash e o endereço IP e o user agent da encomenda, mas sem ID de clique. O guia de consentimento e privacidade explica o que é guardado e enviado.

Ligue a sua conta de anúncios do Pinterest em Setup › Ad spend e a ROASaurus obtém o investimento das campanhas todas as horas, para que veja o ROAS do Pinterest e o lucro depois dos anúncios na análise de lucro. O guia da Events API do TikTok cobre a mesma configuração para o TikTok, onde todos os eventos que seguem pelos dois caminhos têm eliminação de duplicados.

Fontes

  1. Pinterest Developers: Track conversion events in the API
  2. Pinterest Business help: The Pinterest Conversions API
  3. Pinterest Developers: Track conversions with Pinterest Tag

Na ROASaurus

Continue a ler

Plataformas de anúncios e lojas onlineTracking de conversões em pagamento contra reembolso e checkouts externosTracking de conversões em pagamento contra reembolso: porque é que os pixels falham as encomendas COD e de checkout externo, quando enviar a compra e como tratar as encomendas recusadas.Plataformas de anúncios e lojas onlineTracking de conversões no CCV Shop: um guia de configuraçãoTracking de conversões no CCV Shop: envie as encomendas pagas para a Meta e o TikTok com um webhook assinado, associe-as aos cliques em anúncios, configure, teste e trate os pagamentos tardios.Plataformas de anúncios e lojas onlineConversões avançadas do Google Ads no ShopifyAs conversões avançadas acrescentam dados de clientes com hash às compras do Google Ads no Shopify. Veja como funcionam, em que diferem das importações offline e como configurar.
FAQ

Perguntas e respostas

O que é a Conversions API do Pinterest?

É o endpoint de servidor para servidor do Pinterest para eventos de conversão. A sua loja ou uma ferramenta como a ROASaurus envia eventos como compras diretamente para a sua conta de anúncios do Pinterest, sem depender da Pinterest Tag no navegador.

Qual é o evento do Pinterest que corresponde a uma compra?

O Pinterest chama checkout a uma encomenda concluída. O início do checkout é um evento separado, initiate_checkout.

O que é o epik?

O epik é um ID de clique do Pinterest. Pode chegar como parâmetro de URL na página de entrada, e o Pinterest recomenda enviar o valor do cookie _epik no campo click_id, porque o cookie dá melhor cobertura.

A ROASaurus elimina duplicados em todos os eventos do Pinterest?

Sim. As visitas de página, as visualizações de produto, as adições ao carrinho, os inícios de checkout e as compras trazem cada um o mesmo ID de evento na Tag e na Conversions API, com nomes de evento correspondentes, pelo que o Pinterest fica com uma única cópia.

Porque é que a ROASaurus precisa de um ID da conta de anúncios e de um ID da Tag?

A Conversions API envia eventos do servidor para a conta de anúncios. O ID da Tag serve apenas para a Tag do navegador. Com ambos definidos, os eventos do navegador e do servidor partilham IDs e o Pinterest mantém uma cópia de cada.

Como testo sem afetar os meus relatórios?

Ative o modo de teste no pixel do Pinterest na ROASaurus. Os eventos são então enviados com test=true, e o Pinterest não os usa para relatórios nem otimização.

Cada venda, associada ao anúncio que a gerou

Tracking server-side, lucro e valor vitalício do cliente numa só app. Teste gratuito de 14 dias, sem cartão de crédito.

Comece o seu teste gratuito →