Eventos de Conversão
Após realizar o clique no produto, o usuário será direcionado para a página de produto ou para o carrinho. Caso o usuário finalize o pedido, torna-se necessário coletar o evento de conversão gerado na página de conclusão do pedido. Através do endpoint /c.gif
, será registrada a compra e consequentemente, as métricas de performance de conversão.
O evento é composto por 2 parâmetros e 1 header:
cUID
: É o identificar único do usuário enviado nas chamadas da API de Vitrines e Evento de Click do Produto Patrocinado.conv
: Contém as informações do pedido no padrãoencodeURIComponent(JSON.stringify(conv))
X-Api-Key
: Header responsável por autenticar a loja no envio da conversão. É o mesmo apresentado na chamada da API.
curl -v -G "https://api-ads.percycle.com/c.gif" \
-d conv="%7B%22tId%22%3A%22pedidoIdFinalClick%22%2C%22currency%22%3A%22BRL%22%2C%22products%22%3A%5B%7B%22sku%22%3A%22Z410024151VRD_PRD%22%2C%22price%22%3A59%2C%22qty%22%3A1%7D%5D%2C%22total%22%3A59%7D" \
-d cUID="<user-id>" \
-H "X-Api-Key: <my-api-key>"
200
. Observe que o response da request será um GIF
. Não se preocupe, a conversão foi enviada corretamente.Implementação
O processo de implementação será dividido em duas partes. Primeiro, será necessário inserir as informações do pedido. Por fim, realizar o encode para ser utilizado como parâmetro conv
.
Informações do pedido:
tID
: Número do pedido. Utilize o mesmo número exibido para o cliente na conclusão da compra.currency
: Moeda do país. Exemplo: BRL, USD, EUR.products
: Informações dos produtos que foram comprados.sku
: ID do produto.price
: Valor do produto.qty
: Quantidade do produto.sellerId
: Seller do produto. (É obrigatório caso o produto seja vendido por outro Seller3P)
total
: Total do pedido.
Query Params
conv
string
required
conv
string
required
encodeURIComponent(JSON.stringify(conv))
cUID
string
required
cUID
string
required
Headers
X-Origin
string
required
X-Origin
string
required
URL da página que será exibido os anúncios.Exemplo:Utilize-o quando a chamada for via Backend.
https://dominio.com.br
X-Referer
string
required
X-Referer
string
required
URL da página que está requisitando esse recurso.Exemplo:Utilize-o quando a chamada for via Backend.
https://dominio.com.br
X-Api-Key
string
X-Api-Key
string
Caso não saiba qual é a suaUtilize-o quando a chamada for via Backend.
api-key
, solicite ao responsável técnico de integração enviando um e-mail para atendimento@linximpulse.com.br.X-User-Id
string
X-User-Id
string
Trata-se de uma maneira de identificar a sessão do usuário e consequentemente, apresentar as vitrines com base na navegação daquele usuário.Utilize-o quando a chamada for via Backend.
import axios from 'axios'
const conv = {
tId: '12345',
currency: 'BRL',
products: [
{
sku: 'Z410025421',
price: 100,
qty: 1,
sellerId: 'Linx'
}
],
total: 100
}
await axios.get('https://api-ads.percycle.com/c.gif', {
params: {
conv: encodeURIComponent(JSON.stringify(conv)),
cUID: '<unique-user-id>'
},
headers: {
'X-Api-Key': '<my-api-key>'
}
})