Google Drive Activity API の概要

このドキュメントでは、Google Drive Activity API の概要について説明します。

Drive Activity API を使用すると、最近のイベントをクエリできます。各イベントの詳細情報など、すべてのアクティビティの詳細な履歴を取得できます。これは、ActionDetailActorTarget の情報を含む正確なアクティビティを取得できるため、監査などのタスクに役立ちます。

Drive Activity API は、ユーザーの Google ドライブ内のオブジェクトに加えられた変更を表す DriveActivity リソースと、それらの変更に関する情報を取得できる activity.query メソッドで構成されています。

リクエスト

アプリは activity.query メソッドを使用してユーザーのアクティビティ データをリクエストします。アクティビティは、特定のドライブ アイテムまたはドライブ フォルダに含まれるすべてのアイテムに対してリクエストできます。特定のリクエストに対して、期間やアクション タイプなどのフィルタを使用してレスポンスを制限したり、レスポンスでアクティビティを統合したりできます。詳細については、Google Drive Activity API でリクエストを行うをご覧ください。

レスポンス

レスポンスには、指定されたパラメータに一致するアクティビティのリストが含まれます。各アクティビティは DriveActivity リソースで表されます。

Drive Activity API のレスポンス本文メッセージの説明。
図 1. Drive Activity API のレスポンス本文メッセージの説明。

DriveActivity リソースは Action オブジェクトのコレクションです。各オブジェクトは イベントのように自己完結型です。Action には、ActionDetailCreateEdit など)、ActorUserAdministrator など)、TargetDriveItemDrive など)、Timestamp または TimeRange のいずれかが含まれます。

DriveActivity リソースには、すべてのアクションのすべての ActorTarget、統合された Timestamp または TimeRangeAction の最も重要な ActionDetail または代表的な ActionDetail など、概要情報も含まれます。

詳しくは、Drive Activity API のデータモデルをご覧ください。

アクティビティ履歴の公開設定

Drive Activity API を使用すると、ドライブでの一部のアクティビティが報告されないことがあります。API が特定のオブジェクトに対する変更を報告するかどうかは、アプリで認証されたユーザーがその変更または変更に関する情報を確認できるかどうかによって異なります。

公開設定は、オブジェクトに設定された権限に基づきます。ドライブでファイルやフォルダが共有されるシナリオはいくつかあります。

  • 作成者がドキュメントを共有すると、ドキュメントのアクティビティ履歴は作成者と共有相手の両方に表示されます。

  • ドキュメントがユーザーと共有された後で非公開になった場合、ユーザーはアクセス権があった期間のアクティビティ履歴をすべて確認できますが、権限が制限された後のアクティビティ履歴は確認できません。

  • ドキュメントがユーザーと共有されたことがない場合、ユーザーはアクティビティ履歴を確認できません。

  • Drive Activity API を最大限に活用するには、まずアプリを Google Drive API と統合します。
  • プロジェクトの作成や認証と認可の処理など、Google Workspace API を使用した開発の詳細については、Google Workspace での開発をご覧ください。
  • アクティビティについては、API リファレンスをご覧ください。