このガイドでは、Google Drive Activity API におけるレスポンスの主なコンポーネントについて説明し、その例と解釈方法について説明します。
オブジェクト
DriveActivity- Drive Activity API へのクエリによって返されるプライマリ リソース。これは、1 つ以上のターゲットに影響を与える 1 つ以上のアクションを実行する 1 人以上のアクターを表します。TimestampとTimeRange- それぞれ、アクティビティが発生した単一の時点、または一定期間にわたってアクティビティが発生した時点の開始と終了を表します。Actor- 通常、Actorはエンドユーザーです。ただし、管理者がユーザーまたは自身として操作している場合、または識別できないユーザーが操作している場合に、システム イベントによってActionがトリガーされることがあります。Actorメッセージは、これらの各ケースをカプセル化しています。Target-Targetは、ファイル、フォルダ、共有ドライブ、ファイルのコメントなどのアクティビティのオブジェクトです。多くのアクション タイプは複数の種類のターゲットをサポートしています。たとえば、Editは通常、ドライブのファイルに適用されますが、RenameやCreateなどの他のアクションもドライブのフォルダと共有ドライブに適用できます。ドライブのアイテムではないターゲット（ドライブのルートフォルダや、ファイルのコメントを含む親ドキュメントなど）は、引き続き参照できます。Action- 各DriveActivityリソースには 1 つ以上の関連アクションがあります。Actionは、イベントと同様に、アクションに関する詳細なタイプと情報だけでなく、Actor、Target、TimestampまたはTimeRangeも構成する自己完結型です。冗長性を確保するため、Actionは、独自のTargetフィールド、Actorフィールド、時間フィールドがDriveActivity全体と同じ場合、それらに値を設定しません。ActionDetail-Actionの特定のタイプと詳細情報です。たとえば、Moveアクションの詳細にはソースと宛先の場所が含まれ、PermissionChangeでは誰がどの権限でドキュメントにアクセスできるかを指定します。
回答例
ユーザーがドライブ内のファイルを編集しました。
単純な DriveActivity リソースには、ユーザーが 1 つのファイルを編集するなど、1 つのアクションのみを含めることができます。
"activities":[{
"primary_action_detail":{ "edit":{} },
"actors":[ { "user":{ "known_user":{ "person_name":"people/ACCOUNT_ID" } } } ],
"targets":[ { "drive_item":{ "name":"items/ITEM_ID", "title":"TITLE", "file":{} } } ],
"timestamp":{ "seconds":"1536794657", "nanos":791000000 },
"actions":[ { "detail":{ "edit":{} } } ]
}]
この出力には次の値が含まれます。
- ACCOUNT_ID: ユーザーの ID。 People API と併用することで、詳細情報を取得できます。
- ITEM_ID: ドライブのアイテムの ID。
- TITLE: ドライブのアイテムのタイトル。
このレスポンスの Action は、DriveActivity 全体と同じであるため、Actor、Target、TimeStamp は含まれません。
2 人のユーザーが同じファイルを同様の時間に編集しました。
統合を有効にすると、関連するアクションが 1 つの DriveActivity にグループ化されます。この例では、2 つの異なるユーザーによる 2 つの Edit アクション タイプという、2 つの類似したアクションがグループ化されています。
"activities":[{
"primary_action_detail":{ "edit":{} },
"actors":[
{ "user":{ "known_user":{ "person_name":"people/ACCOUNT_ID_1" } } },
{ "user":{ "known_user":{ "person_name":"people/ACCOUNT_ID_2" } } }
],
"targets":[
{ "drive_item":{ "name":"items/ITEM_ID", "title":"TITLE", "file":{} } }
],
"time_range":{
"start_time":{ "seconds":"1541089823", "nanos":712000000 },
"end_time":{ "seconds":"1541089830", "nanos":830000000 }
},
"actions":[
{
"detail":{ "edit":{} },
"actor":{ "user":{ "known_user":{ "person_name":"people/ACCOUNT_ID_1" } } },
"timestamp":{ "seconds":"1541089830", "nanos":830000000 }
},
{
"detail":{ "edit":{} },
"actor":{ "user":{ "known_user":{ "person_name":"people/ACCOUNT_ID_2" } } },
"timestamp":{ "seconds":"1541089823", "nanos":712000000 }
}
]
}]
この出力には次の値が含まれます。
- ACCOUNT_ID_1: 最初のユーザーの ID。People API と併用することで、詳細情報を取得できます。
- ACCOUNT_ID_2: 2 番目のユーザーの ID。
- ITEM_ID: ドライブのアイテムの ID。
- TITLE: ドライブのアイテムのタイトル。
このレスポンスのアクションには、DriveActivity 全体と同じであるため、Target が含まれていません。
また、この例は、アプリが個々のアクションを確認せずに DriveActivity の概要情報のみを使用する方法を示しています。レスポンスは、2 人のユーザーが一定の期間に特定のファイルを編集したことを示します。
ユーザーが 2 個のファイルを新しいディレクトリに移動しました。
この例では、ファイルが同じソースから同じ宛先に同時に移動されたため、統合戦略により関連する 2 つの Move アクションがグループ化されています。
"activities":[{
"primary_action_detail":{
"move":{
"added_parents":[ { ... } ]
"removed_parents":[ { ... } ]
}
},
"actors":[ { "user":{ "known_user":{ "person_name":"people/ACCOUNT_ID" } } } ],
"targets":[
{ "drive_item":{ "name":"items/ITEM_ID_1", "title":"TITLE_1", "file":{} } },
{ "drive_item":{ "name":"items/ITEM_ID_2", "title":"* TITLE_2", "file":{} } }
],
"timestamp":{ "seconds":"1541090960", "nanos":985000000 },
"actions":[
{
"detail":{ "move":{ "added_parents":[ { ... } ] "removed_parents":[ { ... } ] } },
"target":{ "drive_item":{ "name":"items/ITEM_ID_1", "title":"TITLE_1", "file":{} } }
},
{
"detail":{ "move":{ "added_parents":[ { ... } ] "removed_parents":[ { ... } ] } },
"target":{ "drive_item":{ "name":"items/ITEM_ID_2", "title":"* TITLE_2", "file":{} } }
}
]
}]
この出力には次の値が含まれます。
- ACCOUNT_ID: ユーザーの ID。 People API と併用することで、詳細情報を取得できます。
- ITEM_ID_1: 最初のドライブ アイテムの ID。
- ITEM_ID_2: ドライブの 2 番目のアイテムの ID。
- TITLE_1: ドライブの最初のアイテムのタイトル。
- TITLE_2: ドライブの 2 番目のアイテムのタイトル。
このレスポンスのアクションには、DriveActivity 全体と同じであるため、Actor や TimeStamp は含まれません。