Eventos de Visualização de Vitrine
Cada vitrine recomendada pela API contém um campo chamado impressionUrl
O impressionUrl
fornece uma url que pode ser usada para registrar o evento de visualização da vitrine. Esse evento deve ser disparado sempre que uma vitrine entra na área visível pelo usuário.
Com este evento implementado, temos um feedback sobre quais vitrines fornecidas pela API foram realmente visualizadas pelos usuários. Isso torna nosso motor de otimização de vitrines mais assertivo e também ajuda nosso sistema a melhorar a qualidade das recomendações feitas ao longo do tempo.
Como o layout mais comum das vitrines é um carrossel, onde nem todos os produtos são exibidos de uma única vez, é possível fornecer um intervalo indicando os índices do primeiro e do último produto vistos pelo usuário. Esse intervalo pode ser informado através da adição de dois parâmetros à url fornecida na resposta da api, firstOffset
e lastOffset
descritos abaixo:
Parâmetros | Descrição |
---|---|
apiKey | ID interno de identificação da sua loja. |
secretKey | Chave de acesso para autenticar a requisição. Pode ser substituída pelo parâmetro origin quando a requisição é feita via frontend para não expor a chave. |
deviceId | Identificador único do dispositivo. Todas as requisições feitas a partir do mesmo dispositivo devem possuir o mesmo deviceId. |
firstOffset | Contém a posição do primeiro produto mostrado na área visível da vitrine, com índice a partir de 0. |
lastOffset | Contém a posição do último produto mostrado na área visível da vitrine |
firstOffset
e lastOffset
não sejam enviados, o registro será feito para todos os produtos da vitrine, mesmo que não tenham sido visualizados.- Caso a coleta de eventos seja realizada pelos nossos scripts (através do
window.linxMeta
), é necessário que seja utilizado o mesmo valor correspondente dedeviceId
. Este campo é disponibilizado pelos scripts de coleta no domínio do lojista, no cookiechaordic_browserId
. - Se a coleta de eventos for chamada via API, o gerenciamento do
deviceId
deve ser feito pelo lojista.
curl -v -G "https://recs.chaordicsystems.com/v0/impression" \
-d trackingImpression="CghxZGItdnRleBIEaG9tZRoKYW5vbi10ZXN0ZSILbW9zdHBvcHVsYXIqEzIwMTctMTAtMDUgMTE6MzI6MDYywQEKA3RvcBIkNzNiNWNlZDAtYjRhMC0xMWU1LTliYjgtYWRmMmM5NzRiNTk1GiQ2Yjc5MDA4OS04N2Y1LTU2MWItODZkNy04MTYwZGZjOTQwZjIiEnJrLXdtYS1taV9wdXJjaGFzZSokZjYzMTFhNjAtYTlkOS0xMWU3LWIwYzYtN2ZkODVkZDdiNjJhMiRmNTg3MWVjMC1hOWQ5LTExZTctYjBjNi03ZmQ4NWRkN2I2MmE6B2Rlc2t0b3BCBXRlc3RlOgIQEEoDNjY3SgM3MDhKAzIxMkoDMjUwSgMxOTRKAzY3NUoDMjU5SgM2NzNKAzMzMEoCNTFKAzE4MUoDMjcwSgM2NzJKAzcwM0oDMTU5SgMxMTA=" \
-d apiKey="<my-apikey>" \
-d secretKey="<my-secret-key>" \
-d source="<my-source>" \
-d deviceId="<my-device-id>" \
-d userId="<my-user-id>" \
-d firstOffset=2 \
-d lastOffset=4 \
-H "Origin: www.meusite.com"