API Reports: relatório de atividade do Drive

O Relatório de atividade do Drive mostra informações sobre as atividades dos usuários quando eles gerenciam, modificam e compartilham arquivos no Drive no Google Workspace. Por exemplo, você pode usar o relatório de atividade do Drive para conferir uma lista de todos os novos documentos do Drive criados por um usuário em um período especificado. Use essas informações para entender melhor o melhor gerenciamento de conteúdo e possíveis vazamentos de dados. Para gerar um relatório, use a solicitação básica do endpoint de relatório com parâmetros específicos do relatório, como o endereço de e-mail de um usuário ou um tipo específico de alteração do Google Drive. Os relatórios podem incluir dados de até 180 dias.

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

Para mais informações sobre as strings de consulta e as propriedades de resposta da solicitação, 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 em um domínio

Você pode usar o relatório de atividade do Drive para listar informações sobre seus documentos. Por exemplo, você pode solicitar um relatório listando os 25 eventos mais recentes do Drive na sua conta, abrangendo até 180 dias. Para isso, receba 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

Veja um exemplo de resposta para esta chamada de API.

O exemplo a seguir recupera um relatório de todos os eventos do Drive nos ú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 do 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 alterações feitas pelo usuário especificado. Para ver um exemplo de resposta de API, consulte a amostra de resposta JSON.

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

Recuperar eventos do Google Drive em drives compartilhados

Você pode recuperar um relatório das atividades do Google Drive de 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 sobre quem você quer gerar o relatório no campo userKey ou especifique all para executar o relatório para todos os usuários.

O exemplo a seguir recupera um relatório com todas as alterações de um drive compartilhado específico. Para ver um exemplo de resposta de API, consulte a amostra 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 relacionados a mudanças de associação, especifique o evento shared_drive_membership_change. O exemplo a seguir recupera todas as adições de participantes 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 recuperar um relatório de todas as instâncias de um tipo de evento específico, como a criação ou edição de 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 de API, consulte a amostra 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. Junto com o 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. Saiba mais sobre o eventName na referência Nomes de eventos do Drive. Para mais informações sobre as strings de consulta e as propriedades da resposta da solicitação, 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"
      }
      ]
     }
    ]
   },
  ]
 }