Registrar eventos

Selecionar plataforma: iOS+ Android Web Flutter Unity C++

O Analytics registra automaticamente alguns eventos para você. Não é necessário adicionar códigos para recebê-los. Caso o app precise coletar outros dados, é possível registrar até 500 tipos diferentes de eventos do Analytics no app. Não há limite para o volume total de eventos registrados pelo app. Como os nomes de eventos diferenciam letras maiúsculas e minúsculas, registrar dois eventos com nomes que diferem apenas no uso de caixa baixa/alta vai resultar na criação de dois eventos distintos.

Antes de começar

Verifique se você configurou seu projeto e pode acessar o Analytics, como descrito em Primeiras etapas com o Analytics.

Se você quiser coletar dados de atribuição de campanha para apps da plataforma Apple, adicione o framework AdSupport ao seu projeto.

Registrar eventos

Depois de criar uma instância FirebaseAnalytics, use-a para registrar eventos com os métodos log- da biblioteca.

Eventos predefinidos

Para ajudar você a começar, o SDK do Analytics define vários eventos recomendados, comuns entre diferentes tipos de apps, como os de varejo, e-commerce, viagem e jogos. Para saber mais sobre esses eventos e quando usar cada um, consulte Eventos recomendados.

Encontre os métodos de registro para os tipos de eventos recomendados na Referência da API.

Confira no exemplo a seguir como registrar um evento select_content:

await FirebaseAnalytics.instance.logSelectContent(
    contentType: "image",
    itemId: itemId,
);

Como alternativa, você pode registrar o mesmo evento usando logEvent():

await FirebaseAnalytics.instance.logEvent(
    name: "select_content",
    parameters: {
        "content_type": "image",
        "item_id": itemId,
    },
);

Isso pode ser útil se você quiser especificar outros parâmetros, além dos prescritos (obrigatórios). Você pode adicionar os seguintes parâmetros a qualquer evento:

  • Parâmetros personalizados: podem ser usados como dimensões ou métricas em relatórios do Analytics. Use dimensões personalizadas para dados de parâmetros de eventos não numéricos e métricas personalizadas para quaisquer dados de parâmetros melhor representados numericamente. Depois de registrar um parâmetro personalizado usando o SDK, registre a dimensão ou métrica para garantir que esses parâmetros apareçam nos relatórios do Analytics. Para isso, acesse Analytics > Eventos > Gerenciar definições personalizadas > Criar dimensões personalizadas.

    Os parâmetros personalizados podem ser usados em definições de segmentos que podem ser aplicadas a todos os relatórios. Eles também estão incluídos nos dados exportados ao BigQuery caso seu app seja vinculado a um projeto do BigQuery. Encontre exemplos de consultas e muito mais no Google Analytics 4 BigQuery Export.

  • value é um parâmetro de uso geral útil para coletar uma métrica principal pertencente a um evento. Exemplos incluem receita, distância, horário e pontos.

  • Os nomes dos parâmetros podem ter até 40 caracteres e precisam começar com um caractere alfabético e conter apenas caracteres alfanuméricos e sublinhados. Os tipos compatíveis são "String" e "num". Os valores de parâmetro da string podem ter até 100 caracteres. Os prefixos "firebase", "google" e "ga_" são reservados e não devem ser usados para nomes de parâmetros.

Eventos personalizados

Caso seu aplicativo tenha necessidades específicas não atendidas por um tipo de evento recomendado, registre seus próprios eventos personalizados, conforme mostrado neste exemplo:

await FirebaseAnalytics.instance.logEvent(
    name: "share_image",
    parameters: {
        "image_name": name,
        "full_text": text,
    },
);

Definir parâmetros padrão de eventos

É possível registrar parâmetros em eventos usando setDefaultEventParameters(). Os parâmetros padrão são associados a todos os eventos futuros registrados.

Assim como nos parâmetros personalizados, registre os parâmetros de eventos padrão para garantir que eles apareçam nos relatórios do Analytics.

Os valores de parâmetro válidos são "String" e "num". Definir o valor de uma chave como null limpa esse parâmetro. Passar um valor nulo limpa todos os parâmetros.

// Not supported on web
await FirebaseAnalytics.instance
  .setDefaultEventParameters({
    version: '1.2.3'
  });

Se um parâmetro for especificado nos métodos logEvent() ou log, esse valor será usado no lugar do padrão.

Para limpar um parâmetro padrão, chame o método setDefaultEventParameters() com o parâmetro definido como null.