Method: activity.query

Google ドライブでの過去のアクティビティに対してクエリを実行します。

HTTP リクエスト

POST https://driveactivity.googleapis.com/v2/activity:query

この URL は gRPC Transcoding 構文を使用します。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現
{
  "consolidationStrategy": {
    object (ConsolidationStrategy)
  },
  "pageSize": integer,
  "pageToken": string,
  "filter": string,

  // Union field key can be only one of the following:
  "itemName": string,
  "ancestorName": string
  // End of list of possible types for union field key.
}
フィールド
consolidationStrategy

object (ConsolidationStrategy)

アクティビティを構成する関連アクションを統合する方法の詳細。設定しない場合、関連するアクションは統合されません。

pageSize

integer

レスポンスに必要なアクティビティの最小数。サーバーは少なくともこの数量を返そうとします。また、リクエストがタイムアウトする前に部分的なレスポンスの準備ができている場合、サーバーは返すアクティビティの数が少なくなることもあります。設定されていない場合は、デフォルト値が使用されます。

pageToken

string

このトークンは、返される結果ページを識別します。次のページの結果を取得するには、前のクエリから返された nextPageToken 値に設定します。設定しない場合、結果の最初のページが返されます。

filter

string

このクエリ リクエストから返されたアイテムのフィルタリング。フィルタ文字列の形式は、オプションの「AND」で結合された一連の式です。各式は「フィールド演算子値」の形式になります。

サポートされているフィールド:

  • time: 1970 年 1 月 1 日からのミリ秒数または RFC 3339 形式のいずれかで、日付値に数値演算子を使用します。例:

    • time > 1452409200000 AND time <= 1492812924310
    • time >= "2016-01-10T01:02:03-05:00"
  • detail.action_detail_case: 「has」を使用します。演算子(:)と、単一の値、または許可されるアクション タイプのリストをかっこで囲み、スペースで区切って指定します。レスポンスから結果を除外するには、フィルタ文字列の先頭にハイフン(-)を追加します。例:

    • detail.action_detail_case:RENAME
    • detail.action_detail_case:(CREATE RESTORE)
    • -detail.action_detail_case:MOVE
共用体フィールド key。クエリの主要条件。キーが指定されていない場合のデフォルトは ancestorName = items/root です。key は次のいずれかになります。
itemName

string

このドライブ アイテムのアクティビティを返却します。形式は items/ITEM_ID です。

ancestorName

string

このドライブ フォルダと、すべての子と子孫のアクティビティを返します。形式は items/ITEM_ID です。

レスポンスの本文

ドライブのアクティビティをクエリした場合のレスポンス メッセージ。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現
{
  "activities": [
    {
      object (DriveActivity)
    }
  ],
  "nextPageToken": string
}
フィールド
activities[]

object (DriveActivity)

リクエストされたアクティビティのリストです。

nextPageToken

string

結果の次のページを取得するためのトークン。リストにそれ以上の結果がない場合は空です。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/drive.activity
  • https://www.googleapis.com/auth/drive.activity.readonly

詳細については、承認ガイドをご覧ください。

ConsolidationStrategy

個々のアクティビティを統合する方法。一組の活動が関連している場合、1 つの活動を結合した活動に統合することができます。例えば、1 人のアクターが複数の標的に対して同じアクションを実行する、複数のアクターが単一のターゲットで同じ活動を行うなど。戦略では、アクティビティを関連付けるルールを定義します。

JSON 表現
{

  // Union field strategy can be only one of the following:
  "none": {
    object (NoConsolidation)
  },
  "legacy": {
    object (Legacy)
  }
  // End of list of possible types for union field strategy.
}
フィールド
共用体フィールド strategy。個々のアクティビティを統合する方法。strategy は次のいずれかになります。
none

object (NoConsolidation)

個々のアクティビティは統合されません。

legacy

object (Legacy)

個々のアクティビティは、従来の戦略を使用して統合されます。

NoConsolidation

この型にはフィールドがありません。

個々のアクティビティを統合しない戦略。

レガシー

この型にはフィールドがありません。

従来の V1 Activity API のグループ化ルールを使用してアクティビティを統合する戦略。ある時間枠内で発生した同様のアクションは、複数のターゲット(一連のファイルを一度に移動するなど)または複数のアクター(複数のユーザーが同じアイテムを編集するなど)にグループ化できます。この戦略のグループ化ルールは、アクションのタイプごとに固有です。