A API Reports é uma API RESTful que pode ser usada para acessar informações sobre as atividades do Google Workspace dos seus usuários. A API Reports faz parte da API Admin SDK.
A API Reports fornece dois tipos de relatório:
- Relatórios de atividade, que informam eventos de um aplicativo ou serviço específico, como o Google Drive ou o Admin Console.
- Relatórios de Uso, que listam os eventos do espaço de trabalho causados pelos usuários
- Os relatórios de uso de Cliente listam eventos de todos os usuários no seu domínio.
- Os relatórios de uso do usuário listam os eventos organizados por usuário.
Veja a seguir uma lista de termos comuns usados na API Reports:
- Relatórios de atividades
Os relatórios de atividades listam informações das atividades em um aplicativo ou serviço específico do Google Workspace. Os relatórios de atividade incluem a data, a hora, o usuário e o tipo de atividade. A Referência da API contém uma lista completa de relatórios de atividades e as informações incluídas neles. Veja alguns exemplos de relatórios de atividades, listados por app ou serviço:
- Os relatórios de atividade do administrador mostram as atividades realizadas pelos administradores no Admin Console. Por exemplo, é possível ver uma lista de todas as vezes que os administradores alteraram o nome de um usuário no Admin Console.
- Os relatórios de atividade do Google Drive listam como os usuários do seu domínio editam e visualizam os documentos do Google Drive. Por exemplo, você pode acessar uma lista com a atividade de um usuário específico no Drive.
- Os relatórios de atividade de login fornecem informações sobre quando os usuários da sua conta fazem login e saem das contas. Você pode, por exemplo, obter um relatório de todos os logins no seu domínio em um determinado período.
- Os Relatórios de atividade em dispositivos móveis mostram atividades usando dispositivos móveis gerenciados pelo Gerenciamento Google de dispositivos móveis. Por exemplo, você pode receber uma notificação quando os usuários registrarem um novo dispositivo.
- Os relatórios de atividade do token OAuth listam os eventos em que os usuários concederam ou revogaram tokens de autorização usados por sites e aplicativos de terceiros. Use a API Reports para ver uma lista de todo o acesso de terceiros aos dados de um usuário do Google Workspace.
- Relatórios de uso
Os relatórios de uso mostram informações sobre os eventos do Google Workspace no seu domínio. É possível usar a API para solicitar informações específicas sobre os usuários.
- Os relatórios de uso dos clientes listam atividades detalhadas de aplicativos e serviços na sua conta. Essas informações de uso são organizadas por tipo de aplicativo e contêm informações específicas dele.
- Os relatórios de uso de usuários mostram as atividades dos usuários da sua conta. Esses relatórios podem ser personalizados e filtrados para mostrar informações de uso específicas. Essas informações de uso são organizadas por tipo de aplicativo e contêm informações específicas dele.
- Os relatórios de uso de entidades listam as atividades relacionadas às entidades usadas pelos usuários da sua conta no aplicativo Currents.
- Notificações
- A API Reports fornece notificações que permitem acompanhar eventos, como mudanças em recursos. Quando você está monitorando um recurso e ele muda, a API Reports envia uma notificação. Para mais informações sobre como configurar e receber notificações da API Reports, consulte o guia sobre Como receber notificações push.
Próximas etapas
Para saber mais sobre a API Reports e ver como ela funciona, use um guia de início rápido, que está listado por linguagem de programação na barra de navegação à esquerda. Continue nesta seção para ler informações gerais sobre como configurar sua conta.
Para usar a API Reports, siga as etapas de pré-requisito para configurar sua conta e se tornar um administrador. Você também vai criar um projeto e registrá-lo usando o Console de APIs do Google e ativar o serviço da API Reports.
A seção de autorização mostra como usar os tokens de acesso do OAuth 2.0 para coletar dados do usuário de aplicativos e serviços do Google Workspace.
Para encontrar os detalhes de um tipo de recurso ou método específico, consulte a Referência da API.
Para mais informações, consulte o Issue Tracker da API Admin SDK, o Blog de desenvolvedores do Google Workspace e a Central de Ajuda do administrador do Google Workspace.