API Reports: relatório de atividade do Drive

O relatório de atividade do Drive fornece informações sobre as atividades dos usuários ao gerenciar, modificar e compartilhar arquivos no Google Drive no Google Workspace. Por exemplo, você pode usar o relatório de atividade do Drive para receber uma lista de todos os novos documentos do Drive criados por um usuário específico em um período determinado. Use essas informações para ter insights sobre um melhor gerenciamento de conteúdo e possíveis vazamentos de dados. Para receber um relatório, use a solicitação de endpoint de relatório básico com parâmetros específicos do relatório, como um endereço de e-mail do usuário ou um tipo específico de mudança no Google Drive. Os relatórios podem incluir dados de até os últimos 180 dias.

O relatório de atividades do Google Drive só pode ser usado para fins legais em contas com uma licença atribuída.

Para informações sobre as strings de consulta da solicitação e as propriedades da resposta, consulte a referência da API. Para informações sobre eventos específicos relacionados ao Google Drive, consulte Nomes de eventos do Drive.

Recuperar eventos do Google Drive para um domínio

Você pode usar o relatório de atividade do Drive para listar informações sobre seus documentos do Drive. Por exemplo, você pode pedir um relatório com os 25 eventos mais recentes do Drive da sua conta, que podem abranger até 180 dias. Para receber esse relatório, obtenha um token de autorização conforme descrito no guia de autorização e use a seguinte solicitação HTTP GET:

GET https://admin.googleapis.com/admin/reports/v1/activity/users/all
/applications/drive?maxResults=25

Confira um exemplo de resposta a essa chamada de API.

O exemplo a seguir recupera um relatório de todos os eventos do Drive dos últimos 180 dias, o período máximo.

GET https://admin.googleapis.com/admin/reports/v1/activity/users/all
/applications/drive

Recuperar eventos do Google Drive por usuário

Para recuperar um relatório das atividades do Google Drive de um usuário específico, use uma solicitação HTTP GET com o token de autorização descrito no guia de autorização. O campo userKey é o endereço de e-mail principal do usuário no relatório ou all para todos os usuários.

O exemplo a seguir recupera um relatório que lista todas as mudanças feitas pelo usuário especificado. Para ver um exemplo de resposta da API, consulte o exemplo de resposta JSON.

GET https://admin.googleapis.com/admin/reports/v1/activity/users/kim@example.com
/applications/drive

Recuperar eventos do Google Drive para drives compartilhados

É possível recuperar um relatório de atividades do Google Drive para um drive compartilhado específico usando uma solicitação HTTP GET com o token de autorização descrito no guia de autorização. Especifique o endereço de e-mail do usuário para quem você quer gerar o relatório no campo userKey ou especifique all para gerar o relatório para todos os usuários.

O exemplo a seguir recupera um relatório de todas as mudanças em uma unidade compartilhada específica. Para ver um exemplo de resposta da API, consulte o exemplo de resposta JSON.

GET https://admin.googleapis.com/admin/reports/v1/activity/users/all
/applications/drive?filters=shared_drive_id==<id of shared drive>

Para recuperar eventos de um drive compartilhado, filtre usando o doc_type. O exemplo a seguir recupera eventos que afetam todos os drives compartilhados:

GET https://admin.googleapis.com/admin/reports/v1/activity/users/all
/applications/drive?filters=doc_type=shared_drive

Para recuperar eventos de mudanças de associação, especifique o evento shared_drive_membership_change. O exemplo a seguir recupera todas as adições de membros aos drives compartilhados:

GET https://admin.googleapis.com/admin/reports/v1/activity/users/all
/applications/drive?evetName=shared_drive_membership_change&
filters=membership_change_type==add_to_shared_drive

Recuperar eventos do Google Drive por tipo de evento

Para extrair um relatório de todas as instâncias de um tipo de evento específico, como criar ou editar um documento, use uma solicitação HTTP GET com o token de autorização descrito no guia de autorização. O campo userKey é o endereço de e-mail principal do usuário no relatório ou all para todos os usuários.

O exemplo a seguir recupera um relatório de todas as atividades de criação de documentação da conta. Para ver um exemplo de resposta da API, consulte o exemplo de resposta JSON:

GET https://admin.googleapis.com/admin/reports/v1/activity/users/all
/applications/drive?eventName=create

Exemplo de resposta JSON

Quando você faz uma solicitação HTTP GET para a API, uma resposta bem-sucedida retorna um código de status HTTP 200. Além do código de status, a resposta retorna um relatório do Drive. Esses relatórios também estão disponíveis no Admin Console. Para mais informações, consulte a Central de Ajuda para admins do Google Workspace. Para informações sobre eventName, consulte a referência de nomes de eventos do Drive. Para mais informações sobre as strings de consulta da solicitação e as propriedades de resposta, consulte a referência da API.

{
 "kind": "reports#auditActivities",
 "nextPageToken": "next page's token",
 "items": [
  {
   "kind": "audit#activity",
   "id": {
    "time": "2014-03-17T15:39:18.460Z",
    "uniqQualifier": "report's unique ID",
    "applicationName": "drive",
    "customerId": "ABC123xyz"
   },
   "actor": {
   "callerType": "USER",
   "email": "kim@example.com",
   "profileId": "user's unique Google Workspace profile ID",
   "key": "consumer key of requestor in an OAuth 2LO request"
   },
   "ownerDomain": "domain of the source owner",
   "ipAddress": "user's IP address",
   "events": [
    {
     "type": "access",
     "name": "edit",
     "parameters": [
      {
        "name": "primary_event",
        "boolValue": true
      },
      {
        "name": "owner_is_shared_drive",
        "boolValue": false
      },      {
        "name": "doc_id",
        "value": "1DWuYM3ot_sAyEQqOz0xWJ9bVMSYzOmRNeBqbgtSwuK8"
      },
      {
        "name": "doc_title",
        "value": "Meeting notes"
      },
      {
        "name": "doc_type",
        "value": "document"
      },
      {
        "name": "owner",
        "value": "mary@example.com"
      }
      ]
     }
    ]
   },
  ]
 }