Google Drive Activity API は、ユーザーの Google ドライブ内のオブジェクトに加えられた変更を表す DriveActivity
リソースと、それらの変更に関する情報を取得できる activity.query
メソッドで構成されています。
リクエスト
アプリが activity.query
メソッドを使用してユーザーのアクティビティ データをリクエストします。アクティビティは、特定のドライブ アイテムまたはドライブ フォルダ内のすべてのアイテムに対してリクエストできます。特定のリクエストに対して、期間やアクション タイプなどの制約でレスポンスを制限したり、レスポンスでアクティビティを統合したりできます。詳細については、Drive Activity API でリクエストを行うをご覧ください。
レスポンス
リクエストへのレスポンスは、指定されたパラメータに一致するアクティビティのリストです。ここで、DriveActivity
リソースは各アクティビティを表します。
DriveActivity
リソースは Action
オブジェクトのコレクションで、各オブジェクトはイベントのように自己完結型です。Action
には、ActionDetail
(Create
や Edit
など)、Actor
(User
や Administrator
など)、Target
(DriveItem
や Drive
など)、Timestamp
または TimeRange
のいずれかが含まれます。
DriveActivity
リソースには、すべてのアクションのすべての Actor
と Target
、統合された Timestamp
または TimeRange
、Action
の最も重要または代表的な ActionDetail
などの概要情報も含まれます。
詳細については、Drive Activity API データモデルをご覧ください。
アクティビティ履歴の公開設定
この API を使用すると、ドライブの一部のアクティビティが報告されない場合があります。Drive Activity API がオブジェクトに対する特定の変更をレポートするかどうかは、その変更または変更に関する情報が、アプリ内で認証済みのユーザーに表示されるかどうかによって異なります。
公開設定は、オブジェクトに設定された権限に基づいています。ドライブでファイルとフォルダが共有されるシナリオはいくつかあります。
- 作成者がドキュメントを共有すると、ドキュメントのアクティビティ履歴は作成者だけでなく、共有された認証済みユーザーにも表示されます。
- ドキュメントがユーザーと共有されてから非公開にされた場合、認証されたユーザーは、アクセス権が付与されていたことと、権限が制限された間にすべてのアクティビティ履歴を表示できます。
- ドキュメントがユーザーと共有されていない場合、ユーザーはアクティビティ履歴を表示できません。
使ってみる
Drive Activity API を最大限に活用するには、まずアプリを Google Drive API と統合します。Drive Activity API の使用を開始するには、プロジェクトを作成する方法とリクエストを承認する方法を学びます。または、API リファレンスでアクティビティについて詳しく確認してください。