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)
  }
  // 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)
  }
  // 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)

搜索查询的开始时间。请以格林尼治标准时间指定。该值会四舍五入到指定日期的零点。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
endTime

string (Timestamp format)

搜索查询的结束时间。请以格林尼治标准时间指定。该值会四舍五入到指定日期的零点。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
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_网址 时，此参数是必需的。
联合字段 corpus_options_field。针对特定服务的其他搜索选项。corpus_options_field 只能是下列其中一项：
mailOptions

object (MailOptions)

设置 Gmail 搜索专用选项。
driveOptions

object (DriveOptions)

设置云端硬盘专用选项。
hangoutsChatOptions

object (HangoutsChatOptions)

设置特定于 Chat 搜索的选项。（只读）
voiceOptions

object (VoiceOptions)

设置语音搜索专用选项。
calendarOptions

object (CalendarOptions)

设置日历搜索专用选项。

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 中指定的共享云端硬盘中的文件。

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

已发布的网站网址列表。

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)
}
字段
versionDate

string (Timestamp format)

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

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
includeTeamDrives
(deprecated)

boolean

设为 true 即可包含团队云端硬盘。
includeSharedDrives

boolean

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

enum (ClientSideEncryptedOption)

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

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

仅匹配位置包含指定集合中所有字词的事件。如果字符串中包含带引号的短语，则此方法仅匹配位置中包含完全匹配短语的事件。组中的条目以“and”处理。

字词拆分示例：["New Zealand"] 与 ["New","Zealand"] "New Zealand"：同时与“New and best Zealand”匹配：仅与以后的匹配
peopleQuery[]

string

仅匹配参加者包含指定集合中所有字词的活动。组中的条目以“and”处理。
minusWords[]

string

仅匹配符合以下条件的活动：标题、说明、地点或参与者中不包含指定字词集中的任何字词。组中的条目将被视为“或”。
responseStatuses[]

enum (AttendeeResponse)

仅匹配监护人给出上述任一响应的活动。如果集合为空或包含 ATTENDEE_RESPONSE_UNSPECIFIED，则系统不会对回复进行过滤。
versionDate

string (Timestamp format)

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

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

AttendeeResponse

用户对邀请的回复。

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