A API Reports é uma API RESTful que pode ser usada para acessar informações sobre as atividades dos usuários no Google Workspace. A API Reports faz parte da API Admin SDK.
A API Reports oferece dois tipos de relatórios:
- Relatórios de atividade, que informam eventos para 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 do cliente listam os eventos de todos os usuários no seu domínio.
- Os relatórios de uso de Usuário listam os eventos organizados por usuário.
Veja a seguir uma lista de termos comuns usados na API Reports:
- Relatórios de atividade
Os relatórios de atividades listam informações de atividades em um aplicativo ou serviço específico do Google Workspace. Os relatórios de atividade incluem data, hora, usuário e tipo de atividade. A referência da API contém uma lista completa de relatórios de atividades e as informações que eles incluem. Veja alguns exemplos de relatórios de atividade, listados por aplicativo ou serviço:
- Os relatórios de atividade do administrador mostram as atividades feitas pelos administradores usando o Admin Console. Por exemplo, você pode ver uma lista de todas as vezes que os administradores mudaram o nome de um usuário usando o Admin Console.
- Os relatórios de atividades do Google Drive listam como os usuários do seu domínio editam e visualizam os documentos deles. Por exemplo, você pode ver uma lista das atividades 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 logout. Por exemplo, é possível gerar um relatório de todos os logins do seu domínio em um período específico.
- Os relatórios de atividade em dispositivos móveis mostram atividades que usam 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 eventos quando os usuários fornecem ou revogam tokens de autorização usados por sites e aplicativos de terceiros. É possível usar a API Reports para ver uma lista de todos os acessos de terceiros aos dados do Google Workspace de um usuário.
- Relatórios de uso
Os relatórios de uso fornecem informações sobre os eventos do Google Workspace no seu domínio. Você pode usar a API para solicitar informações específicas sobre os usuários.
- Os relatórios de uso dos clientes listam as 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 do aplicativo.
- Os relatórios de uso dos usuários mostram as atividades dos usuários da sua conta. Esses relatórios podem ser personalizados e filtrados para 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.
- 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 monitorar eventos, como mudanças nos recursos. Quando você está observando um recurso e ele é alterado, 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 vê-la funcionar, use um guia de início rápido, listado por linguagem de programação na barra de navegação à esquerda. Você também pode continuar nessa 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 tokens de acesso do OAuth 2.0 para receber 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.