Visão Geral

Como desenvolvedor, você cria um aplicativo para milhões de usuários do Microsoft Teams alcançarem metas específicas de negócios ou cliente. Para essa finalidade, você a distribui usando uma ou mais das muitas opções de distribuição disponíveis para você. Depois que o aplicativo for publicado, você vai querer medir como seu aplicativo está funcionando no mundo real.

Você também estará interessado em monitorar muitos pontos de dados, como:

• Quem está interessado em seu aplicativo?
• Quais usuários e organizações estão usando seu aplicativo?
• Como os usuários estão se envolvendo com seu aplicativo?
• Quais usuários se afastaram depois de usar seu aplicativo por algum tempo?

Essas informações ajudam você a analisar os dados em relação às suas metas de negócios, tomar medidas corretivas corrigindo problemas. Ele também ajuda você a intervir na jornada do usuário ou tomar decisões informadas em torno de investimentos, melhorias e adoção de recursos para o aplicativo.

Mas o relatório de uso do aplicativo teams deve ser suficiente, não é?

Como desenvolvedor do aplicativo, você pode acompanhar o uso do aplicativo no relatório de uso do aplicativo teams no Partner Center dentro de uma semana depois de publicar seu aplicativo na Microsoft Teams Store. Os desenvolvedores de aplicativos personalizados podem encontrar análise de uso para seus aplicativos personalizados no Portal do Desenvolvedor para Teams. O relatório de uso do Partner Center fornece métricas padrão que permitem acompanhar a demanda do usuário, a rotatividade do usuário e a frequência de uso do seu aplicativo. Esses relatórios estão disponíveis em um nível agregado, como:

• Usuários ativos mensais, diários e semanais.
• Gráficos de retenção e intensidade.
• Usuários que usaram seu aplicativo há mais de cinco dias no último mês.
• Plataforma, sistema operacional e divisão geográfica de usuários para seu aplicativo e assim por diante.

Os relatórios de uso fora da caixa disponíveis no Partner Center ou no Portal do Desenvolvedor para Teams não podem fornecer análises detalhadas sobre o que acontece dentro do aplicativo e análises específicas no nível do usuário. Essas análises incluem a jornada de um usuário em seu aplicativo ou o envolvimento de um usuário com recursos específicos e a medição de conclusões de cenário.

Seu aplicativo no Teams é essencialmente um serviço baseado na Web hospedado em outros lugares, por exemplo, na nuvem do Azure. Ele é inserido e exibido dentro do shell do Microsoft Teams, onde os usuários podem usar seu aplicativo. Isso se aplica ao aplicativo, independentemente dos recursos da plataforma usados , como guias, bots, extensões de mensagem, extensões de reunião, cartões, caixas de diálogo (conhecidos como módulos de tarefa no TeamsJS v1.x) e assim por diante. Todas essas funcionalidades são um meio de criar experiências baseadas na Web no Teams.

Planeje a análise para o aplicativo Teams da mesma maneira que você faz para um produto SaaS executado no navegador da Web.

Planejar cedo para análise

Planeje análise para seu aplicativo teams no estágio de arquitetura de desenvolvimento e arquitetura de solução. Examine quais das práticas e instrumentações de dados existentes para seu aplicativo Web SaaS principal serão acumuladas para construções de tela hospedadas, como guias, caixas de diálogo, aplicativos de reunião e assim por diante no Teams que você está otimizando ou criando do zero à superfície dentro do Teams. Para recursos específicos do Teams, como construções de conversa , como bots, extensões de mensagens e assim por diante, você precisará planejar e implementar a instrumentação de análise, capturar eventos relevantes e contexto dos métodos SDK do zero.

No momento, seu aplicativo teams de produção está em tempo real na Teams Store e os clientes começam a usá-lo, sua análise e infraestrutura de dados devem estar totalmente operacionais. Ele garante que você não perca o acompanhamento:

• Marcadores de instrumentação sendo disparados.
• Eventos específicos do Teams e as informações contextuais relevantes contidas nesses eventos, alguns dos quais são disparados para você capturar em seu back-end SaaS para uso posterior.

Por exemplo, a ID do usuário Microsoft Entra para um usuário do Teams deve ser capturada quando um evento de bot específico é disparado quando um usuário instala o aplicativo bot. Essa ID de usuário pode ser mapeada para a identidade de perfil real do usuário, como endereço de email. Ele permite que você envie notificações proativas para o usuário posteriormente por meio do bot.

Instrumentando seu aplicativo para análise

Instrumentar seu código com marcadores de análise (também conhecidos como marcadores de instrumentação) é uma prática padrão de desenvolvimento de aplicativos Web. A instrumentação robusta em seu código é fundamental para o sucesso a longo prazo. Ele ajuda você a medir métricas agregadas e específicas do usuário.

Observação

Antes de começar, lembre-se sempre de lidar com os dados do usuário de acordo com suas políticas rígidas de tratamento e privacidade de dados e em conformidade com suas obrigações regulatórias.

O Teams App é outra superfície para expor sua solução ao usuário final, outra janela para sua paisagem SaaS. À medida que sua solução é dimensionada em várias plataformas (Web, plataformas móveis e Teams), é importante exibir sua instrumentação em camadas:

Há dois tipos de instrumentação de dados relevantes para sua solução:

• Instrumentação de dados para seu produto ou aplicativo SaaS principal

• Instrumentação de dados em seu aplicativo específico para o Teams

Observação

O restante deste documento recomenda apenas os dados no contexto que você pode usar, mas não substitui suas obrigações regulatórias.

Instrumentação de dados para seu produto ou aplicativo SaaS principal

Essa é a instrumentação que você fará para seu aplicativo SaaS baseado no navegador, independentemente de você estar se integrando ao Teams ou não. Se você tiver um aplicativo SaaS baseado em navegador, com toda a probabilidade, você terá essa instrumentação já feita em seu código. É assim que você pode ver a análise de clique e análise do ciclo de vida do cliente. Você também pode ver métricas de análise de conversão, como taxa de salto, exibições de página, contagem exclusiva de visitantes, contagem de sessões, tempo de engajamento, taxa de clique e muito mais para seu aplicativo Web.

Instrumentação de dados em seu aplicativo específico para o Teams

Essa instrumentação é necessária para ser feita adicionalmente em seu aplicativo SaaS porque agora está surgindo dentro do cliente do Teams. Em um nível de apresentação, seu aplicativo é acessado pelo usuário final em diferentes modalidades. Cada modalidade tem seus próprios pontos de interação de usuário exclusivos, meta dados que facilitam a captura de instrumentação exclusiva para essa modalidade. Por exemplo, a exibição de um produto pode ser rastreada por meio da exibição de página em um aplicativo Web versus rastreamento de tela no aplicativo móvel. Da mesma forma, o aplicativo teams pode ter usado um ou mais recursos da plataforma disponíveis apenas dentro do Teams, como bots, extensões de mensagem e assim por diante. ou você criou experiências para abordar casos de uso exclusivos do Teams, como extensões de reunião, cenários inteligentes com reconhecimento M365 usando o Microsoft Graph, a desenrolação de link e assim por diante. A captura de instrumentação dessas experiências exclusivas de aplicativo do Teams é abordada com mais detalhes no restante deste documento.

Análise específica do aplicativo do Teams para instrumentação

Esta seção inclui diretrizes e ponteiros sobre o que procurar, quais eventos capturar, como usar marcadores de instrumentação e onde buscar informações relevantes do Teams que ajudarão você a planejar e implementar análises para seu aplicativo. Seus aplicativos do Teams podem ser guias, bots, extensões de mensagens, cartões, Stageviews e assim por diante ou qualquer combinação desses recursos e construções de interface do usuário em escopos pessoais ou compartilhados. É melhor entender, planejar e implementar sua instrumentação em torno de cada uma dessas funcionalidades.

Você pode classificar os recursos da plataforma do Teams em dois builds:

• Builds de tela da Web hospedados
• Construções de conversa

Builds de tela da Web hospedados

Os recursos orientados à tela visual são páginas da Web com reconhecimento do Teams inseridas no Microsoft Teams, como guias, aplicativos pessoais, caixas de diálogo (exibindo um iframe inserido), Visão de palco, guias de reunião, estágio de reunião compartilhado e caixas de diálogo na reunião. Eles estão hospedados na nuvem com o restante do aplicativo SaaS que é executado no navegador da Web.

Essas páginas da Web geralmente têm a instrumentação feita para as principais necessidades do aplicativo Web SaaS. Você só precisa capturar eventos específicos do Teams e tratá-los para instrumentação específica do Teams em seu código. É útil para suas necessidades de análise que as guias são páginas da Web "com reconhecimento do Teams".

Ao criar uma guia seguindo os pré-requisitos definidos aqui, adicione o SDK do cliente JavaScript do Teams ao conteúdo ou à página de configuração da guia. Ele garante que sua página possa acessar informações ou contexto específicos do Teams. Use essas informações para insights úteis específicos do usuário, como:

• ID do locatário do Microsoft 365 (Microsoft Entra locatário) para o usuário atual (tid). No Microsoft 365 ou Microsoft Entra ID, um locatário é representante de uma organização, ou seja, da empresa do usuário. A ID do locatário do Microsoft 365 é útil para descobrir e registrar a qual locatário do Microsoft 365 o usuário pertence. Depois de conhecer a ID do locatário, você pode descobrir o domínio de locatário da organização, que geralmente revela o nome da organização, usando esse API do Graph. Certifique-se de invocar essa API no locatário do Desenvolvedor do Microsoft 365, pois você poderá consentir com a permissão de administrador de locatário necessária.
• Tipo de licença atribuído ao usuário e à SKU para o locatário do usuário atual. Os valores possíveis são planos empresariais F1, E1, E3 e E5 para (licenseType) e empresarial, gratuitos, edu e desconhecidos para (tenantSKU).
• O contexto em que a URL da guia é carregada. Alguns valores possíveis podem ser a página de conteúdo, a caixa de diálogo, as configurações da guia, a caixa de diálogo remover guias, o lado da reuniãoPanel e assim por diante. (frameContext).
• Tipo de cliente host em que a guia é carregada. Os valores possíveis são Android, IoS, Web, desktop, surfaceHub e assim por diante. (hostClientType). Você pode fatiar seus dados de análise.
• Reconhecimento de localidade para que o usuário indique idioma, por exemplo, en-us, fr-fr, ja-jp e assim por diante. (locale).
• Nome da entidade de usuário ou dica de logon (loginHint) do usuário atual no locatário atual (geralmente endereço de email do usuário).
• Nome da equipe e nome do canal em que a guia do canal é adicionada (teamName, channelName).
• ID exclusiva para a sessão de aplicativo atual dentro de uma guia usada para correlacionar dados de instrumentação (appSessionId).
• A ID da reunião é usada por uma guia em execução no contexto da reunião e é adicionada para a carga de resposta (meetingId).
• Microsoft Entra ID do usuário atual.

Depois de extrair as informações específicas do Teams do contexto de guia, algumas maneiras possíveis de usá-la são mostradas nos seguintes exemplos:

Acompanhar informações específicas do Teams	Resultado
Organização do usuário.	Acompanhe a demanda por seu aplicativo, especialmente se você oferecer um período de avaliação para novas inscrição ou oferta de freemium para seu produto SaaS para divulgação de vendas, organização a bordo, marcar para obter assistência.
O tipo de organização do usuário e a função do usuário.	Use o tipo de licença e o SKU de locatário para construir um perfil de cliente para o usuário do Teams. Corte seus dados de análise, como uso, sessões, retenção e assim por diante. nesse caso, e adapte seus recursos, experiências e assim por diante. Conformemente.
Inferências de contexto de cliente de host, localidade e uso de nomes de equipe ou canal.	Enriqueça o perfil do cliente em sua análise de usuário.
Contexto de quadro.	Obtenha informações sobre o contexto em que o usuário está usando seu aplicativo, a jornada do usuário e o padrão de uso de várias áreas de superfície, recursos e escopos. Crie as experiências do usuário de acordo e invista mais em recursos populares entre seus usuários.
Endereço de email do usuário.	Associe uma identidade significativa e real ao usuário do Teams e forneça o endereço de domínio da organização de locatários do Microsoft 365, ou seja, contoso.onmicrosoft.com. Identifique a organização à qual o usuário pertence. O endereço de email do usuário pode ser usado para concluir o perfil do usuário e comunicar-se com o usuário para ativação, remarketingmento e re-engajamento. No entanto, tenha cuidado para não usar mal esse canal ou enviar spam ao usuário.
Microsoft Entra ID de usuário ou objeto.	Obtenha e armazene a ID exclusiva Microsoft Entra usuário ou objeto no momento da instalação do aplicativo (bot). Envie qualquer notificação proativa para o usuário por meio do bot.

Construções de conversa

Os recursos orientados para conversa ou chat incluem bots, extensões de mensagens, cartões e caixas de diálogo (exibindo um Cartão Adaptável) criados para usuários do Teams. Conceitualmente, essas experiências são criadas para e disponíveis apenas para usuários especificamente dentro do Teams. Você precisará capturar eventos específicos do Teams e manuseá-los para instrumentação específica do Teams em seu código para esses builds do zero. Um bot pode acessar dados de contexto adicionais sobre uma equipe, chat, reunião, chamada 1:1 ou chamada em grupo onde ele está instalado.

Use essas informações para enriquecer a funcionalidade do bot e a experiência do usuário:

• Consulte o bot para a lista de membros e seus perfis de usuário básicos, incluindo IDs de usuário do Teams e informações de Microsoft Entra, como nome e Microsoft Entra ID de usuário ou objeto.

• Use a Microsoft Entra ID do usuário ou objeto do usuário para localizar o nome, sobrenome, endereço de email, ID do locatário e a função do usuário na equipe. Aproveite esses detalhes conforme descrito para builds de tela da Web hospedados.

• Se o bot estiver instalado em uma equipe, consulte-o para obter metadados sobre essa equipe, incluindo a ID do grupo Microsoft Entra e o nome da equipe. Ele também pode consultar a lista de canais da equipe, que retorna IDs e nomes do canal. Aproveite essas informações para configuração, configuração e personalização.

• Usando a API de Detalhes da Reunião, obtenha metadados estáticos de uma reunião ou chamada, como tipo de reunião (por exemplo, GroupCall, , OneToOneCall, Adhoc, Broadcast, MeetNow, Recurring, Scheduledou Unknown), tipo de conversa, ID do locatário organizador e assim por diante.

Cada atividade enviada pelo Teams ao bot conterá o turnContext objeto do qual todos esses campos relevantes podem ser recuperados. Você pode aproveitá-los de maneira semelhante à descrita para construções de tela da Web hospedada.

Como as extensões de mensagem são baseadas no canal do bot, a maioria das anteriores também se aplica a extensões de mensagem.

Insights agregados e específicos do usuário

Além das métricas óbvias no mundo SaaS, como usuários ativos diários, semanais e mensais, e o tempo gasto em seu aplicativo implementando análise cuidadosamente para seu aplicativo Teams de acordo com as diretrizes acima, você obterá insights como:

• Métricas de agregação

  • Quais recursos de plataforma, áreas de superfície (por exemplo, guias, bots, extensões de mensagem) e builds de interface do usuário (cartões, caixas de diálogo, Stageviews) aproveitadas em seu aplicativo do Teams encontraram o maior uso por seus usuários?
  • Qual escopo ou ponto de entrada da interface do usuário (como aplicativo pessoal, canal, chat em grupo) é o mais usado pelos usuários para invocar seu aplicativo e iniciar uma nova sessão de aplicativo no Teams?
  • Quantos dias, em média, os usuários usam seu aplicativo na primeira semana após a instalação do aplicativo?
  • Qual é a análise de coorte de retenção de usuário semana a semana ou mês a mês para seu aplicativo ou recursos específicos (como aplicativo pessoal ou bot) em seu aplicativo?
  • Quantos usuários usam seu aplicativo somente em clientes móveis do Teams?
  • Quantos usuários usaram a funcionalidade do dispositivo de câmera em seu aplicativo?
  • O que a análise de funil revela para seu aplicativo entre fases, desde a instalação do aplicativo até a ativação até o envolvimento com a retenção e, por fim, a monetização? Onde estão acontecendo as entregas?
  • Quantos usuários instalaram seu aplicativo na última semana?
  • Quantos usuários se recuperaram do seu aplicativo nos últimos três meses? Qual é a taxa de rotatividade trimestral resultante?
  • Qual organização viu o número máximo de instalações para seu aplicativo nos últimos 30 dias?
  • A quais organizações os usuários que instalam seu aplicativo nos últimos 14 dias pertencem?
  • Qual organização viu o número máximo de inscrições de avaliação para seu aplicativo nos últimos sete dias?
  • Em que tipos de reuniões (GroupCall, , AdhocOneToOneCall, Broadcast, MeetNowou ScheduledRecurring ) seu aplicativo é usado?

• Métricas específicas do usuário

  • Quais usuários ainda não experimentaram o recurso de guias de canal que você implementou em seu aplicativo na última atualização do aplicativo?
  • Quais usuários não concluíram a integração dentro do aplicativo pessoal?
  • Entre os usuários que instalaram o aplicativo na última semana, quais usuários não retornaram ao aplicativo nem uma vez para envolvimento após a instalação?
  • Quais usuários instalaram o aplicativo, mas ainda não entraram no aplicativo?
  • Quantas vezes um usuário específico usou seu aplicativo teams nos últimos 30 dias?
  • Quantos dias um usuário específico usou ativamente seu aplicativo nos últimos sete dias?
  • Quando foi a última vez que um usuário específico usou seu aplicativo no Teams?
  • Qual foi a jornada de um usuário de aplicativo específico dentro do Teams?
  • Quais usuários se recuperaram do seu aplicativo nos últimos três meses?
  • Um usuário específico usou seu aplicativo em uma reunião do Teams?

Em seguida, confira como você deve criar metodicamente sua estratégia de instrumentação de dados e decidir o que medir com base em quais insights específicos você deseja derivar do uso do aplicativo teams.

Próxima etapa

Strategize e decida o que medir