Documentação / Z4C


Widget JavaScript para conteúdo

O plugin JavaScript permite recuperar itens a serem recomendados, além de permitir o rastreamento do usuário.

A vantagem do uso do plugin está na economia em horas de codificação.

Método zunnit.contentTrackAndRec ( {} )


Método para rastrear as ações do usuário e recuperar itens a serem recomendados em uma única chamada.

Deve-se inserir no corpo do HTML a inclusão da biblioteca para posteriormente se realizar chamadas. O Script a ser incluído encontra-se no seguinte endereço:

 

http://d1d6shnftky8yc.cloudfront.net/js/zunnit.min.js

ou

https://d1d6shnftky8yc.cloudfront.net/js/zunnit.min.js


Exemplo de codificação

O Exemplo abaixo conta com duas partes, o primeiro bloco JavaScript é responsável por fazer a carga do Plugin para o navegador do usuário e tratasse de uma chamada sincrona. Já o segundo bloco JavaScript é responsável pela execução do rastreamento e recuperação da recomendação. Para a recomendação seja exibida no navegador, deve existir um blobo “div” vazio e com o id pré-determinado. Esse bloco “div” será preenchido com o HTML pela função “contentTrackAndRec”.
 

<script type="text/javascript">
    var zProtocol = (("https:" == document.location.protocol) ? "https" : "http");
    document.write(unescape("%3Cscript src='" + zProtocol + "://d1d6shnftky8yc.cloudfront.net/js/zunnit.min.js' type='text/javascript'%3E%3C/script%3E"));
</script>

<script type="text/javascript"> zunnit.contentTrackAndRec({ 'user_key': 'USER_KEY', 'service_key': 'SERVICE_KEY', 'guest_id': 'GUEST_ID', 'page_type': 'PAGE_TYPE', 'item_ids': 'ITEM_ID' }); </script>

 

Parâmetros


A função recebe um dicionário, o qual pode conter as seguintes chaves e valores:

 

user_key

obrigatório

Chave do usuário da API (definida no painel de controle).

service_key

obrigatório

Chave do serviço da API (definida no painel de controle).

page_type

obrigatório

Tipo da página onde as recomendações serão exibidas. Pode assumir um dos seguintes valores:

  • home

  • navigating

  • item

  • search

item_ids

opcional

Lista de identificadores (IDs), separados por virgula, de os tópicos ou artigos na qual a recomendação deve ser baseada.

groups

opcional

Permite a filtragem das recomendações por categorias.

query

opcional

Esse parâmetro torna possível a filtragem de produtos ou itens por uma consulta realizada pelo usuário no website. Por exemplo, um usuário realiza uma busca por “Futebol” no site de notícias, seria interessante para o sistema de recomendação saber o que o usuário está procurando para melhorar seus resultados.

count

opcional

Número máximo de itens a serem retornados. Se fornecido, substitui o valor definido nas vitrines.

guest_id

opcional

Identificador atribuído a um usuário que está navegando pelo serviço. Usualmente recuparado por um mecanismo de Cookie

customer_id

opcional

Identificador do usuário cadastrado.

sync

opcional

Variável booleana que indica se as chamadas devem ser feitas de forma síncrona (true) ou assíncrona (false). O padrão é se fazer chamadas assíncronas.