Análise do App Center (Unity)

Importante

O Visual Studio App Center está programado para ser desativado em 31 de março de 2025. Embora você possa continuar a usar o Visual Studio App Center até que ele seja totalmente desativado, há várias alternativas recomendadas para as quais você pode considerar migrar.

Saiba mais sobre linhas do tempo e alternativas de suporte.

• Android
• iOS
• React Native
• Windows
• Unity
• MAUI/Xamarin
• MacOS
• tvOS
• Cordova

A Análise do App Center ajuda você a entender o comportamento do usuário e o envolvimento do cliente para melhorar seu aplicativo. O SDK captura automaticamente a contagem de sessões e as propriedades do dispositivo, como modelo, versão do sistema operacional etc. Você pode definir seus próprios eventos personalizados para medir coisas importantes para você. Todas as informações capturadas estão disponíveis no portal do App Center para você analisar os dados.

Siga as instruções na seção Introdução ao Unity se você ainda não configurou o SDK em seu aplicativo.

Observação

Para usar as APIs apresentadas abaixo, você deve adicionar a seguinte using instrução ao arquivo .cs :

using Microsoft.AppCenter.Unity.Analytics;

Você também deve verificar se Usar Análise está marcado nas configurações do objeto de jogo do App Center.

Informações sobre a sessão e o dispositivo

Depois de adicionar a Análise do App Center e iniciar o SDK, ele acompanhará automaticamente as sessões e as propriedades do dispositivo, como Versão do sistema operacional, modelo etc. sem a necessidade de nenhum código adicional em seu aplicativo.

Eventos personalizados

Você pode acompanhar seus próprios eventos personalizados com até 20 propriedades para saber o que está acontecendo em seu aplicativo, entender as ações do usuário e ver as agregações no portal do App Center.

Use o TrackEvent() método para acompanhar seus eventos com propriedades. Você pode enviar até 200 nomes de eventos distintos. Há um limite máximo de 256 caracteres por nome de evento e 125 caracteres por nome e valor da propriedade do evento.

Analytics.TrackEvent("Video clicked", new Dictionary<string, string> {
	{ "Category", "Music" },
	{ "FileName", "favorite.avi" }
});

As propriedades para eventos são opcionais – se você quiser apenas acompanhar um evento, use este exemplo:

Analytics.TrackEvent("Video clicked");

Aviso

Analytics.TrackEvent() se comportará inconsistentemente entre plataformas se for chamado antes do Awake() método no script AppCenterBehavior.cs. Para ser seguro, você só deve contar com eventos a serem enviados depois que a primeira cena em seu aplicativo tiver despertado todos os MonoBehaviour scripts. Para acompanhar um evento em conjunto com a inicialização de um MonoBehavour, considere adicionar a API ao método do Start() script em vez de Awake().

Habilitar ou desabilitar a Análise do App Center em runtime

Você pode habilitar e desabilitar a Análise do App Center em runtime. Se você desabilitá-lo, o SDK interromperá a coleta de informações de análise para o aplicativo. Para desabilitar o Analytics, use a API a seguir, passando false como um parâmetro.

Analytics.SetEnabledAsync(false);

Para habilitar a Análise do App Center novamente, use a mesma API, mas passe true como um parâmetro.

Analytics.SetEnabledAsync(true);

O estado é persistido no armazenamento do dispositivo entre as inicializações do aplicativo.

Essa API é assíncrona, você pode ler mais sobre em nosso guia de APIs assíncronas do App Center .

Verificar se a Análise do App Center está habilitada

Você também pode marcar se a Análise do App Center estiver habilitada ou não.

bool isEnabled = await Analytics.IsEnabledAsync();

Prioridade e persistência do evento

Você pode acompanhar eventos comercialmente críticos que têm maior importância do que outros eventos.

Os desenvolvedores podem definir a persistência de eventos como Normal (Flags.PersistenceNormal na API) ou Crítico (Flags.PersistenceCritical na API).

Você pode usar a API a seguir para acompanhar um evento como Crítico:

Analytics.TrackEvent("eventName", Flags.PersistenceCritical);

Se você estiver usando propriedades:

Analytics.TrackEvent("eventName", new Dictionary<string, string> {
	{ "Category", "Music" },
	{ "FileName", "favorite.avi" }
}, Flags.PersistenceCritical);

Pausar e retomar o envio de logs

Pausar a transmissão de eventos pode ser útil em cenários em que o aplicativo precisa controlar a largura de banda de rede para necessidades mais críticas para os negócios. Você pode pausar o envio de logs para o back-end do App Center. Quando pausados, os eventos ainda podem ser rastreados e salvos, mas não são enviados imediatamente. Todos os eventos que seu aplicativo rastreia enquanto estiver em pausa serão enviados somente depois que você chamar Analytics.Resume.

Analytics.Pause();
Analytics.Resume();

Essa API é assíncrona, você pode ler mais sobre em nosso guia de APIs assíncronas do App Center .

Gerenciar sessão inicial

Por padrão, a ID da sessão depende do ciclo de vida do aplicativo. Se você quiser controlar o início de uma nova sessão manualmente, siga as próximas etapas:

Observação

Preste atenção que cada chamada da API Analytics.StartSession() gerará uma nova sessão. Se no modo de rastreador de sessão manual essa API não for chamada, todos os logs de envio terão um valor de sessão nulo.

Observação

Preste atenção que, depois que um novo aplicativo iniciar, a ID da sessão será regenerada.

• Desmarque a caixa de seleção Habilitar Rastreador de Sessão Manual na seção Análise no objeto de jogo com AppCenterBehavior anexado.
• Em seguida, você pode usar a StartSession API após o AppCenter.Start:

Analytics.StartSession();

Tamanho do armazenamento local

Por padrão, o SDK armazena até 10 MB de logs no armazenamento.

Sem acesso à Internet

Quando não há conectividade de rede, o SDK salva até 10 MB de logs no armazenamento local. Quando o armazenamento estiver cheio, o SDK começará a descartar logs antigos para liberar espaço para os novos logs. Depois que o dispositivo receber o acesso à Internet de volta, o SDK enviará logs no lote de 50 ou após cada 6 segundos.

Logs de eventos de envio em lote

O SDK do App Center carrega logs em um lote de 50 e, se o SDK não tiver 50 logs para enviar, ele ainda enviará logs após 6 segundos. Pode haver no máximo três lotes enviados em paralelo.

Lógica de repetição e retirada

O SDK do App Center dá suporte a novas tentativas de retirada em erros de rede recuperáveis. Abaixo está a lógica de repetição:

• 3 tentativas no máximo por solicitação.
• Cada solicitação tem seu próprio computador de estado de repetição.
• Todos os canais de transmissão são desabilitados (até o próximo processo do aplicativo) depois que uma solicitação esgota todas as suas novas tentativas.

Lógica de retirada

• 50% de randomização, primeira tentativa entre 5s e 10s, segunda repetição entre 2,5 e 5 minutos, última tentativa entre 10 e 20 minutos.
• Se a rede mudar de desativada para ativada (ou de wi-fi para móvel), os estados de repetição serão redefinidos e as solicitações serão repetidas imediatamente.