- JSON representation
- DataScope
- SearchMethod
- AccountInfo
- OrgUnitInfo
- SharedDriveInfo
- HangoutsChatInfo
- SitesUrlInfo
- TeamDriveInfo
- MailOptions
- DriveOptions
- ClientSideEncryptedOption
- HangoutsChatOptions
- VoiceOptions
The query definition used for search and export.
JSON representation |
---|
{ "corpus": enum ( |
Fields | |
---|---|
corpus |
The Google Workspace service to search. |
dataScope |
The data source to search. |
searchMethod |
The search method to use. |
method |
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 |
Service-specific search operators to filter search results. |
startTime |
The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
endTime |
The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
teamDriveInfo |
Required when SearchMethod is TEAM_DRIVE. |
timeZone |
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 |
Required when SearchMethod is ACCOUNT. |
orgUnitInfo |
Required when SearchMethod is ORG_UNIT. |
sharedDriveInfo |
Required when SearchMethod is SHARED_DRIVE. |
hangoutsChatInfo |
Required when SearchMethod is ROOM. (read-only) |
sitesUrlInfo |
Required when SearchMethod is SITES_URL. |
Union field corpus_options_field . Additional search options for specific services. corpus_options_field can be only one of the following: |
|
mailOptions |
Set Gmail search-specific options. |
driveOptions |
Set Drive search-specific options. |
hangoutsChatOptions |
Set Chat search-specific options. (read-only) |
voiceOptions |
Set Voice search-specific options. |
DataScope
The source of data to search.
Enums | |
---|---|
DATA_SCOPE_UNSPECIFIED |
No data source specified. |
ALL_DATA |
All available data. |
HELD_DATA |
Only data on hold. |
UNPROCESSED_DATA |
Only data not yet processed by Vault. (Gmail and Groups only) |
SearchMethod
The entity type for the search.
Enums | |
---|---|
SEARCH_METHOD_UNSPECIFIED |
A search method must be specified or else it is rejected. |
ACCOUNT |
Search the data of the accounts specified in AccountInfo. |
ORG_UNIT |
Search the data of all accounts in the organizational unit specified in OrgUnitInfo. |
TEAM_DRIVE |
Search the data in the Team Drive specified in teamDriveInfo. |
ENTIRE_ORG |
Search the data of all accounts in the organization. Supported only for Gmail. When specified, you don't need to specify AccountInfo or OrgUnitInfo. |
ROOM |
Search messages in the Chat spaces specified in HangoutsChatInfo. |
SITES_URL |
Search for sites by the published site URLs specified in SitesUrlInfo. |
SHARED_DRIVE |
Search the files in the shared drives specified in SharedDriveInfo. |
AccountInfo
The accounts to search
JSON representation |
---|
{ "emails": [ string ] } |
Fields | |
---|---|
emails[] |
A set of accounts to search. |
OrgUnitInfo
The organizational unit to search
JSON representation |
---|
{ "orgUnitId": string } |
Fields | |
---|---|
orgUnitId |
The name of the organizational unit to search, as provided by the Admin SDK Directory API. |
HangoutsChatInfo
The Chat spaces to search
JSON representation |
---|
{ "roomId": [ string ] } |
Fields | |
---|---|
roomId[] |
A list of Chat spaces IDs, as provided by the Chat API. There is a limit of exporting from 500 Chat spaces per request. |
SitesUrlInfo
The published site URLs of new Google Sites to search
JSON representation |
---|
{ "urls": [ string ] } |
Fields | |
---|---|
urls[] |
A list of published site URLs. |
TeamDriveInfo
Team Drives to search
JSON representation |
---|
{ "teamDriveIds": [ string ] } |
Fields | |
---|---|
teamDriveIds[] |
List of Team Drive IDs, as provided by the Drive API. |
MailOptions
Additional options for Gmail search
JSON representation |
---|
{ "excludeDrafts": boolean } |
Fields | |
---|---|
excludeDrafts |
Set to true to exclude drafts. |
DriveOptions
Additional options for Drive search
JSON representation |
---|
{
"versionDate": string,
"includeTeamDrives": boolean,
"includeSharedDrives": boolean,
"clientSideEncryptedOption": enum ( |
Fields | |
---|---|
versionDate |
Search the current version of the Drive file, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
includeTeamDrives |
Set to true to include Team Drive. |
includeSharedDrives |
Set to true to include shared drives. |
clientSideEncryptedOption |
Set whether the results include only content encrypted with Google Workspace Client-side encryption content, only unencrypted content, or both. Defaults to both. Currently supported for Drive. |
ClientSideEncryptedOption
If your organization uses Google Workspace Client-side encryption, the encryption status of content
Enums | |
---|---|
CLIENT_SIDE_ENCRYPTED_OPTION_UNSPECIFIED |
Encryption status unspecified. Results include both client-side encrypted and non-encrypted content. |
CLIENT_SIDE_ENCRYPTED_OPTION_ANY |
Include both client-side encrypted and unencrypted content in results. |
CLIENT_SIDE_ENCRYPTED_OPTION_ENCRYPTED |
Include client-side encrypted content only. |
CLIENT_SIDE_ENCRYPTED_OPTION_UNENCRYPTED |
Include unencrypted content only. |
HangoutsChatOptions
Additional options for Google Chat search
JSON representation |
---|
{ "includeRooms": boolean } |
Fields | |
---|---|
includeRooms |
For searches by account or organizational unit, set to true to include rooms. |
VoiceOptions
Additional options for Voice search
JSON representation |
---|
{
"coveredData": [
enum ( |
Fields | |
---|---|
coveredData[] |
Datatypes to search |