Query

用于搜索和导出的查询定义。

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

  // Union field search_method_field can be only one of the following:
  "accountInfo": {
    object (AccountInfo)
  },
  "orgUnitInfo": {
    object (OrgUnitInfo)
  },
  "sharedDriveInfo": {
    object (SharedDriveInfo)
  },
  "hangoutsChatInfo": {
    object (HangoutsChatInfo)
  },
  "sitesUrlInfo": {
    object (SitesUrlInfo)
  },
  "driveDocumentInfo": {
    object (DriveDocumentInfo)
  }
  // End of list of possible types for union field search_method_field.

  // Union field corpus_options_field can be only one of the following:
  "mailOptions": {
    object (MailOptions)
  },
  "driveOptions": {
    object (DriveOptions)
  },
  "hangoutsChatOptions": {
    object (HangoutsChatOptions)
  },
  "voiceOptions": {
    object (VoiceOptions)
  },
  "calendarOptions": {
    object (CalendarOptions)
  },
  "geminiOptions": {
    object (GeminiOptions)
  }
  // End of list of possible types for union field corpus_options_field.
}
字段
corpus

enum (CorpusType)

要搜索的 Google Workspace 服务。
dataScope

enum (DataScope)

要搜索的数据源。
searchMethod
(deprecated)

enum (SearchMethod)

要使用的搜索方法。
method

enum (SearchMethod)

要搜索的实体。此字段用于替换 searchMethod，以支持共享云端硬盘。当 searchMethod 为 TEAM_DRIVE 时，此字段的响应为 SHARED_DRIVE。
terms

string

服务专用搜索运算符，用于过滤搜索结果。
startTime

string (Timestamp format)

搜索查询的开始时间。采用格林尼治标准时间 (GMT) 指定。此值会舍入到指定日期的凌晨 12 点。

采用 RFC 3339 标准，生成的输出将始终在末尾带 Z，并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
endTime

string (Timestamp format)

搜索查询的结束时间。采用格林尼治标准时间 (GMT) 指定。此值会舍入到指定日期的凌晨 12 点。

采用 RFC 3339 标准，生成的输出将始终在末尾带 Z，并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
teamDriveInfo
(deprecated)

object (TeamDriveInfo)

当 SearchMethod 为 TEAM_DRIVE 时，此参数为必需参数。
timeZone

string

时区名称。它应该是 IANA TZ 名称，例如“America/Los_Angeles”。如需查看时区名称的列表，请参阅时区。如需详细了解保险柜如何使用时区，请参阅 保险柜帮助中心。
联合字段 search_method_field。如有需要，用于搜索 search_method_field 的实体的详细信息只能是以下任一项：
accountInfo

object (AccountInfo)

当 SearchMethod 为 ACCOUNT 时，此参数为必需参数。
orgUnitInfo

object (OrgUnitInfo)

当 SearchMethod 为 ORG_UNIT 时，此属性为必需属性。
sharedDriveInfo

object (SharedDriveInfo)

当 SearchMethod 为 SHARED_DRIVE 时，此参数为必需项。
hangoutsChatInfo

object (HangoutsChatInfo)

当 SearchMethod 为 ROOM 时，此参数为必填项。（只读）
sitesUrlInfo

object (SitesUrlInfo)

当 SearchMethod 为 SITES_网址 时，此属性为必需属性。
driveDocumentInfo

object (DriveDocumentInfo)

当 SearchMethod 为 DRIVE_DOCUMENT 时，此参数为必需参数。
联合字段 corpus_options_field。特定服务的其他搜索选项。corpus_options_field 只能是下列其中一项：
mailOptions

object (MailOptions)

设置 Gmail 搜索专用选项。
driveOptions

object (DriveOptions)

设置特定于云端硬盘搜索的选项。
hangoutsChatOptions

object (HangoutsChatOptions)

设置聊天搜索专用选项。（只读）
voiceOptions

object (VoiceOptions)

设置特定于语音搜索的选项。
calendarOptions

object (CalendarOptions)

设置 Google 日历搜索专用选项。
geminiOptions

object (GeminiOptions)

设置 Gemini 搜索专用选项。

DataScope

要搜索的数据源。

枚举
DATA_SCOPE_UNSPECIFIED 未指定数据源。
ALL_DATA 所有可用数据。
HELD_DATA 仅保全的数据。
UNPROCESSED_DATA 仅包含保险柜尚未处理的数据。（仅限 Gmail 和群组）

SearchMethod

搜索的实体类型。

枚举
SEARCH_METHOD_UNSPECIFIED 必须指定搜索方法，否则系统会拒绝。
ACCOUNT 搜索 AccountInfo 中指定的账号的数据。
ORG_UNIT 搜索 OrgUnitInfo 中指定的组织部门中的所有账号的数据。
TEAM_DRIVE

搜索 teamDriveInfo 中指定的团队云端硬盘中的数据。
ENTIRE_ORG 搜索组织中所有账号的数据。仅适用于 Gmail。指定此属性后，您无需再指定 AccountInfo 或 OrgUnitInfo。
ROOM 在 HangoutsChatInfo 中指定的 Chat 聊天室中搜索消息。
SITES_URL 按 SitesUrlInfo 中指定的已发布网站网址搜索网站。
SHARED_DRIVE 搜索 SharedDriveInfo 中指定的共享云端硬盘中的文件。
DRIVE_DOCUMENT 检索 DriveDocumentInfo 中指定的文档。

AccountInfo

要搜索的账号

JSON 表示法 
{
  "emails": [
    string
  ]
}
字段
emails[]

string

要搜索的一组账号。

OrgUnitInfo

要搜索的组织部门

JSON 表示法 
{
  "orgUnitId": string
}
字段
orgUnitId

string

要搜索的组织部门的名称（由 Admin SDK Directory API 提供）。

SharedDriveInfo

要搜索的共享云端硬盘

JSON 表示法 
{
  "sharedDriveIds": [
    string
  ]
}
字段
sharedDriveIds[]

string

共享云端硬盘 ID 的列表，由 Drive API 提供。

HangoutsChatInfo

要搜索的 Chat 聊天室

JSON 表示法 
{
  "roomId": [
    string
  ]
}
字段
roomId[]

string

由 Chat API 提供的 Chat 聊天室 ID 列表。每次请求最多只能导出 500 个 Chat 聊天室。

SitesUrlInfo

要搜索的新版 Google 协作平台网站的发布网址

JSON 表示法 
{
  "urls": [
    string
  ]
}
字段
urls[]

string

已发布的网站网址列表。

DriveDocumentInfo

要搜索的云端硬盘文档。

JSON 表示法 
{

  // Union field identifier can be only one of the following:
  "documentIds": {
    object (DriveDocumentIds)
  }
  // End of list of possible types for union field identifier.
}
字段
联合字段 identifier。检索云端硬盘文档的格式。identifier 只能是下列其中一项：
documentIds

object (DriveDocumentIds)

按文档 ID 指定云端硬盘文档。

DriveDocumentIds

按文档 ID 指定云端硬盘文档。

JSON 表示法 
{
  "ids": [
    string
  ]
}
字段
ids[]

string

必需。云端硬盘文档 ID 列表。

TeamDriveInfo

要搜索的团队云端硬盘

JSON 表示法 
{
  "teamDriveIds": [
    string
  ]
}
字段
teamDriveIds[]
(deprecated)

string

团队云端硬盘 ID 列表，由 Drive API 提供。

MailOptions

Gmail 搜索的其他选项

JSON 表示法 
{
  "excludeDrafts": boolean,
  "clientSideEncryptedOption": enum (ClientSideEncryptedOption)
}
字段
excludeDrafts

boolean

设置为 true 可排除草稿。
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

指定结果应包含加密内容、未加密内容，还是同时包含这两者。默认包含这两者。

ClientSideEncryptedOption

如果贵组织使用 Google Workspace 客户端加密功能，内容的加密状态

枚举
CLIENT_SIDE_ENCRYPTED_OPTION_UNSPECIFIED 加密状态未指定。结果既包含客户端加密内容，也包含未加密内容。
CLIENT_SIDE_ENCRYPTED_OPTION_ANY 在结果中同时包含客户端加密内容和未加密内容。
CLIENT_SIDE_ENCRYPTED_OPTION_ENCRYPTED 仅包含客户端加密内容。
CLIENT_SIDE_ENCRYPTED_OPTION_UNENCRYPTED 仅包含未加密的内容。

DriveOptions

云端硬盘搜索的其他选项。

JSON 表示法 
{
  "versionDate": string,
  "includeTeamDrives": boolean,
  "includeSharedDrives": boolean,
  "clientSideEncryptedOption": enum (ClientSideEncryptedOption),
  "sharedDrivesOption": enum (SharedDrivesOption)
}
字段
versionDate

string (Timestamp format)

搜索云端硬盘文件的当前版本，但导出指定日期当天零点（世界协调时间 [UTC]）之前最后保存的版本的内容。输入日期（世界协调时间）。

采用 RFC 3339 标准，生成的输出将始终在末尾带 Z，并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
includeTeamDrives
(deprecated)

boolean

设置为 true 可包含团队云端硬盘。
includeSharedDrives
(deprecated)

boolean

设置为 true 以包含共享云端硬盘。
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

设置结果是仅包含使用 Google Workspace 客户端加密功能加密的内容、仅包含未加密的内容，还是同时包含这两者。默认值为“两者都允许”。目前支持云端硬盘。
sharedDrivesOption

enum (SharedDrivesOption)

可选。用于包含或排除共享云端硬盘中文档的选项。我们建议您使用此字段，而不是 includeSharedDrives。设置此字段后，它会替换 includeSharedDrives 和 includeTeamDrives。

SharedDrivesOption

用于选择要包含的共享云端硬盘文档类型的选项。

枚举
SHARED_DRIVES_OPTION_UNSPECIFIED 未指定共享云端硬盘选项。
NOT_INCLUDED 如果资源位于共享云端硬盘中，则不会包含在搜索结果中。
INCLUDED_IF_ACCOUNT_IS_NOT_A_MEMBER 只有在账号是资源协作者但不是共享云端硬盘成员的情况下，共享云端硬盘资源才会包含在内。这与保险柜界面中的“仅当文档直接共享（而非因为是共享云端硬盘成员）时才包含”选项相对应。（以前“includeSharedDrives”处于关闭状态）
INCLUDED 搜索结果中会包含共享云端硬盘中的资源。（以前为“includeSharedDrives”处于开启状态）

HangoutsChatOptions

Google Chat 搜索的其他选项

JSON 表示法 
{
  "includeRooms": boolean
}
字段
includeRooms

boolean

对于按账号或组织部门进行的搜索，将此值设为 true 即可包含聊天室。

VoiceOptions

语音搜索的其他选项

JSON 表示法 
{
  "coveredData": [
    enum (VoiceCoveredData)
  ]
}
字段
coveredData[]

enum (VoiceCoveredData)

要搜索的数据类型

CalendarOptions

日历搜索的其他选项

JSON 表示法 
{
  "locationQuery": [
    string
  ],
  "peopleQuery": [
    string
  ],
  "minusWords": [
    string
  ],
  "responseStatuses": [
    enum (AttendeeResponse)
  ],
  "versionDate": string
}
字段
locationQuery[]

string

仅匹配位置包含给定集合中的所有字词的事件。如果字符串包含带引号的字词，此方法仅匹配位置信息包含该字词的事件。集合中的条目会被视为“和”运算。

词语拆分示例：[“New Zealand”] 与 [“New”，“Zealand”]“New Zealand”：这两个词组都匹配“New and better Zealand”：只有后者匹配
peopleQuery[]

string

仅匹配参与者包含给定集合中的所有字词的事件。集合中的条目会被视为“和”运算。
minusWords[]

string

仅匹配标题、说明、地点或参加者中不含给定集合中的任何字词的活动。系统会将组中的条目视为“或”关系。
responseStatuses[]

enum (AttendeeResponse)

仅匹配保管人做出以下某种回应的活动。如果集合为空或包含 ATTENDEE_RESPONSE_UNSPECIFIED，系统将不会对回复进行过滤。
versionDate

string (Timestamp format)

搜索日历活动的当前版本，但导出指定日期当天零点（世界协调时间 [UTC]）之前最后保存的版本的内容。输入日期（世界协调时间）。

采用 RFC 3339 标准，生成的输出将始终在末尾带 Z，并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

AttendeeResponse

用户对邀请的回复。

枚举
ATTENDEE_RESPONSE_UNSPECIFIED 未指定参加者回复。如果设置此属性，系统将不会对回答进行过滤，并且会忽略查询选项中的所有其他参加者回答。
ATTENDEE_RESPONSE_NEEDS_ACTION 参与者已收到邀请，但尚未回复。
ATTENDEE_RESPONSE_ACCEPTED 参与者计划参加。
ATTENDEE_RESPONSE_DECLINED 参与者不打算参加。
ATTENDEE_RESPONSE_TENTATIVE 参与者预计可能会参加。

GeminiOptions

此类型没有字段。

Gemini 搜索的其他选项