Wprowadzenie do interfejsu Google Drive Activity API

Ten dokument zawiera omówienie interfejsu Google Drive Activity API.

Interfejs Drive Activity API umożliwia wysyłanie zapytań o ostatnie zdarzenia. Możesz pobrać szczegółową historię wszystkich działań, w tym szczegółowe informacje o każdym zdarzeniu. Jest to przydatne w przypadku zadań takich jak audyty, ponieważ możesz pobierać dokładne działania, które zawierają informacje ActionDetail, ActorTarget.

Interfejs Drive Activity API składa się z zasobu DriveActivity, który reprezentuje zmiany wprowadzone w obiektach na Dysku Google użytkownika, oraz metody activity.query, która umożliwia pobieranie informacji o tych zmianach.

Żądanie

Aplikacja żąda danych o aktywności użytkownika za pomocą metody activity.query. Możesz poprosić o aktywność dotyczącą konkretnego elementu na Dysku lub wszystkich elementów znajdujących się w folderze na Dysku. W przypadku danego żądania możesz ograniczyć odpowiedź za pomocą filtra, np. zakresu czasu lub typu działania, a także możesz zdecydować, czy aktywność ma być skonsolidowana w odpowiedzi. Więcej informacji znajdziesz w artykule Wysyłanie żądań w interfejsie Google Drive Activity API.

Odpowiedź

Odpowiedź zawiera listę aktywności pasujących do podanych parametrów, gdzie każdy zasób DriveActivity reprezentuje aktywność:

Wyjaśnienie treści odpowiedzi interfejsu Drive Activity API.
Rysunek 1. Wyjaśnienie treści komunikatu w odpowiedzi interfejsu Drive Activity API.

DriveActivity Zasób to zbiór Action obiektów, z których każdy jest samodzielny, jak zdarzenie. Element Action zawiera ActionDetail (np. Create lub Edit), Actor (np. User lub Administrator), Target (np. DriveItem lub Drive) oraz Timestamp lub TimeRange.

DriveActivity zawiera też informacje podsumowujące, takie jak wszystkie ActorTarget ze wszystkich działań, ujednolicone Timestamp lub TimeRange oraz najważniejsze lub reprezentatywne ActionDetailAction.

Więcej informacji znajdziesz w artykule Model danych interfejsu Drive Activity API.

Widoczność historii aktywności

Niektóre działania na Dysku mogą nie być raportowane, gdy używasz interfejsu Drive Activity API. To, czy interfejs API zgłosi daną zmianę w obiekcie, zależy od tego, czy zmiana lub informacje o niej są widoczne dla uwierzytelnionego użytkownika w Twojej aplikacji.

Widoczność zależy od uprawnień ustawionych dla obiektu. Istnieje kilka scenariuszy, w których pliki i foldery są udostępniane na Dysku:

  • Jeśli autor udostępni dokument, historia aktywności związana z tym dokumentem będzie widoczna zarówno dla twórcy, jak i użytkowników, którym go udostępniono.

  • Jeśli dokument został udostępniony użytkownikowi, a następnie ustawiono go jako prywatny, użytkownik może zobaczyć całą historię aktywności z okresu, w którym miał dostęp do dokumentu, ale nie z okresu po ograniczeniu uprawnień.

  • Jeśli dokument nigdy nie został udostępniony użytkownikowi, nie może on zobaczyć żadnej historii aktywności.

  • Aby w pełni wykorzystać możliwości interfejsu Drive Activity API, najpierw zintegruj aplikację z Google Drive API.
  • Więcej informacji o tworzeniu aplikacji z wykorzystaniem interfejsów API Google Workspace, w tym o tworzeniu projektu oraz obsłudze uwierzytelniania i autoryzacji, znajdziesz w artykule Tworzenie aplikacji w Google Workspace.
  • Więcej informacji o aktywnościach znajdziesz w dokumentacji interfejsu API.