Ame-tracker-web NPM

Ame Tracker Web

Sistema de tracking da Ame, para enviar parâmetros customizados aos providers (Pandora, GA4, AppsFlyer, etc).

💻 Pré-requisitos

Um projeto web, em javascript/typescript.

🚀 Instalando

Para instalar o Ame Tracker Web, utilize seu pacote de instalação de preferência:

NPM:

npm i ame-tracker-web

Yarn:

yarn add ame-tracker-web

☕ Usando o Ame Tracker Web

Inicialize o Ame Tracker Web com a configuração do seu projeto, no arquivo raíz (como index.js).

Exemplo:

    import AmeTracker from 'ame-tracker-web';

    new AmeTracker({
        appName: 'Nome do projeto',
        environment: 'prd',
        version: '1.0.0'
    });

Para enviar um evento de visualização de tela:

    import AmeTracker from 'ame-tracker-web';

    AmeTracker.sendEvent('at_view', 'SITE_HOME_VIEW', undefined, {
        at_custom: 0,
        at_test: 'teste'
    });

Para enviar um evento de clique:

    import AmeTracker from 'ame-tracker-web';

    AmeTracker.sendEvent('at_click', 'SITE_HOME_BUTTON_NAME', undefined, {
        at_custom: 0,
        at_test: 'teste'
    });

Primeiro parâmetro: 'at_click' ou 'at_view' (obrigatório).
Segundo parâmetro: Tag posicional (obrigatório).
Terceiro parâmetro: Tag posicional da tela anterior.
Quarto parâmetro: Parâmetros customizados adicionais.

⚠️ Alterações na implementação e manutenção do código

O código principal encontra-se na raíz do projeto, no arquivo index.ts, estando aberto a melhorias como implementações de teste, webpack, melhor reestruturação, etc.

Para utilizar o Ame Tracker Web em um novo projeto:

Certifique-se que já existe a configuração referente ao projeto nos providers (Firebase (GA4), Appsflyer, Azure EventHub (Databricks)).
Insira essas configurações dentro da pasta "config", na pasta com o nome do respectivo projeto. Por ex. a configuração do Firebase do site da Ame está no seguinte path: "config/siteAme/firebase_config.json". Manter o mesmo padrão de implementação.
Inserir o nome do novo projeto na interface da classe (variável appName), e suas respectivas importações de configuração, semelhante como já consta para o site Ame, no constructor e no método initialize.