Query

The query definition used for search and export.

JSON representation
{
  "corpus": enum (CorpusType),
  "dataScope": enum (DataScope),
  "searchMethod": enum (SearchMethod),
  "method": enum (SearchMethod),
  "terms": string,
  "startTime": string,
  "endTime": string,
  "teamDriveInfo": {
    object (TeamDriveInfo)
  },
  "timeZone": string,

  "accountInfo": {
    object (AccountInfo)
  },
  "orgUnitInfo": {
    object (OrgUnitInfo)
  },
  "sharedDriveInfo": {
    object (SharedDriveInfo)
  },
  "hangoutsChatInfo": {
    object (HangoutsChatInfo)
  },
  "sitesUrlInfo": {
    object (SitesUrlInfo)
  },
  "driveDocumentInfo": {
    object (DriveDocumentInfo)
  }

  "mailOptions": {
    object (MailOptions)
  },
  "driveOptions": {
    object (DriveOptions)
  },
  "hangoutsChatOptions": {
    object (HangoutsChatOptions)
  },
  "voiceOptions": {
    object (VoiceOptions)
  },
  "calendarOptions": {
    object (CalendarOptions)
  },
  "geminiOptions": {
    object (GeminiOptions)
  }
}
Fields
corpus

enum (CorpusType)

The Google Workspace service to search.

dataScope

enum (DataScope)

The data source to search.

searchMethod
(deprecated)

enum (SearchMethod)

The search method to use.

method

enum (SearchMethod)

The entity to search. This field replaces searchMethod to support shared drives. When searchMethod is TEAM_DRIVE, the response of this field is SHARED_DRIVE.

terms

string

Service-specific search operators to filter search results.

startTime

string (Timestamp format)

The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

endTime

string (Timestamp format)

The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

teamDriveInfo
(deprecated)

object (TeamDriveInfo)

Required when SearchMethod is TEAM_DRIVE.

timeZone

string

The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles". For a list of time zone names, see Time Zone. For more information about how Vault uses time zones, see the Vault help center.

Union field search_method_field. When required, the details of the entities to search search_method_field can be only one of the following:
accountInfo

object (AccountInfo)

Required when SearchMethod is ACCOUNT.

orgUnitInfo

object (OrgUnitInfo)

Required when SearchMethod is ORG_UNIT.

sharedDriveInfo

object (SharedDriveInfo)

Required when SearchMethod is SHARED_DRIVE.

hangoutsChatInfo

object (HangoutsChatInfo)

Required when SearchMethod is