Method: activity.query

Query past activity in Google Drive.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "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.
}
Fields
consolidationStrategy

object (ConsolidationStrategy)

Details on how to consolidate related actions that make up the activity. If not set, then related actions aren't consolidated.
pageSize

integer

The minimum number of activities desired in the response; the server attempts to return at least this quantity. The server may also return fewer activities if it has a partial response ready before the request times out. If not set, a default value is used.
pageToken

string

The token identifies which page of results to return. Set this to the nextPageToken value returned from a previous query to obtain the following page of results. If not set, the first page of results is returned.
filter

string

The filtering for items returned from this query request. The format of the filter string is a sequence of expressions, joined by an optional "AND", where each expression is of the form "field operator value".

Supported fields:

  • time: Uses numerical operators on date values either in terms of milliseconds since Jan 1, 1970 or in RFC 3339 format. Examples:

    • time > 1452409200000 AND time <= 1492812924310
    • time >= "2016-01-10T01:02:03-05:00"

  • detail.action_detail_case: Uses the "has" operator (:) and either a singular value or a list of allowed action types enclosed in parentheses, separated by a space. To exclude a result from the response, prepend a hyphen (-) to the beginning of the filter string. Examples:

    • detail.action_detail_case:RENAME
    • detail.action_detail_case:(CREATE RESTORE)
    • -detail.action_detail_case:MOVE
Union field key. The primary criteria in the query. The default is ancestorName = items/root, if no key is specified. key can be only one of the following:
itemName

string

Return activities for this Drive item. The format is items/ITEM_ID.
ancestorName

string

Return activities for this Drive folder, plus all children and descendants. The format is items/ITEM_ID.

Response body

Response message for querying Drive activity.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "activities": [
    {
      object (DriveActivity)
    }
  ],
  "nextPageToken": string
}
Fields
activities[]

object (DriveActivity)

List of activity requested.
nextPageToken

string

Token to retrieve the next page of results, or empty if there are no more results in the list.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authorization guide.

ConsolidationStrategy

How the individual activities are consolidated. If a set of activities is related they can be consolidated into one combined activity, such as one actor performing the same action on multiple targets, or multiple actors performing the same action on a single target. The strategy defines the rules for which activities are related.

JSON representation 
{

  // 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.
}
Fields
Union field strategy. How the individual activities are consolidated. strategy can be only one of the following:
none

object (NoConsolidation)

The individual activities are not consolidated.
legacy

object (Legacy)

The individual activities are consolidated using the legacy strategy.

NoConsolidation

This type has no fields.

A strategy that does no consolidation of individual activities.

Legacy

This type has no fields.

A strategy that consolidates activities using the grouping rules from the legacy V1 Activity API. Similar actions occurring within a window of time can be grouped across multiple targets (such as moving a set of files at once) or multiple actors (such as several users editing the same item). Grouping rules for this strategy are specific to each type of action.