Introdução à API Google Drive Activity

Este documento oferece uma visão geral da API Google Drive Activity.

A API Drive Activity permite consultar eventos recentes. É possível buscar um histórico detalhado de todas as atividades, incluindo informações granulares sobre cada evento. Isso é útil para tarefas como auditorias, já que você pode recuperar atividades precisas que incluem as informações ActionDetail, Actor e Target.

A API Drive Activity consiste no DriveActivity recurso, que representa mudanças feitas em objetos no Google Drive de um usuário, e no activity.query método, que permite recuperar informações sobre essas mudanças.

Solicitação

Seu app solicita os dados de atividade de um usuário usando o activity.query método. É possível solicitar a atividade de um item específico do Drive ou de tudo que está contido em uma pasta do Drive. Para uma determinada solicitação, você pode restringir a resposta usando um filtro, como período ou tipo de ação, e consolidar a atividade consolidada na resposta. Para mais informações, consulte Fazer solicitações na API Google Drive Activity.

Resposta

A resposta contém uma lista de atividades que correspondem aos parâmetros fornecidos, onde um DriveActivity recurso representa cada atividade:

Explicação da mensagem do corpo da resposta da API Drive Activity.
Figura 1. Explicação da mensagem do corpo da resposta da API Drive Activity.

Um recurso DriveActivity é uma coleção de Action objetos, cada um deles independente como um evento. Um Action inclui um ActionDetail (como Create ou Edit), um Actor (como User ou Administrator), um Target (como DriveItem ou Drive) e um Timestamp ou TimeRange.

Um recurso DriveActivity também contém informações de resumo, como cada Actor e Target de todas as ações, um Timestamp ou TimeRange unificado, e o ActionDetail mais importante ou representativo do Action.

Para mais informações, consulte o modelo de dados da API Drive Activity.

Visibilidade do histórico de atividades

Algumas atividades no Drive podem não ser informadas quando você usa a API Drive Activity. Se a API informa uma determinada mudança em um objeto, depende se a mudança ou as informações sobre ela estão visíveis para o usuário autenticado no seu app.

A visibilidade é baseada nas permissões definidas para o objeto. Há vários cenários em que arquivos e pastas são compartilhados no Drive:

  • Se um autor compartilhar um documento, o histórico de atividades do documento ficará visível para o criador e para os usuários com quem ele foi compartilhado.

  • Se um documento foi compartilhado com um usuário e depois foi tornado particular, o usuário poderá ver todo o histórico de atividades do período em que teve acesso, mas não depois que as permissões foram restritas.

  • Se um documento nunca foi compartilhado com um usuário, ele não poderá ver nenhum histórico de atividades.

  • Para aproveitar ao máximo a API Drive Activity, primeiro integre seu app à API Google Drive.
  • Para saber mais sobre o desenvolvimento com as APIs do Google Workspace, incluindo a criação de um projeto ou o processamento de autenticação e autorização, consulte Desenvolver no Google Workspace.
  • Para saber mais sobre atividades, consulte a referência da API.