- JSON 表示法
- DataScope
- SearchMethod
- AccountInfo
- OrgUnitInfo
- SharedDriveInfo
- HangoutsChatInfo
- SitesUrlInfo
- TeamDriveInfo
- MailOptions
- ClientSideEncryptedOption
- DriveOptions
- HangoutsChatOptions
- VoiceOptions
- CalendarOptions
- AttendeeResponse
用于搜索和导出的查询定义。
JSON 表示法 |
---|
{ "corpus": enum ( |
字段 | |
---|---|
corpus |
要搜索的 Google Workspace 服务。 |
dataScope |
要搜索的数据源。 |
searchMethod |
要使用的搜索方法。 |
method |
要搜索的实体。此字段取代了 searchMethod,以支持共享云端硬盘。当 searchMethod 为 TEAM_DRIVE 时,此字段的响应为 SHARED_DRIVE。 |
terms |
服务专用的搜索运算符,用于过滤搜索结果。 |
startTime |
搜索查询的开始时间。使用格林尼治标准时间指定。该值会四舍五入到指定日期的零点。 时间戳,采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,具有纳秒级分辨率,最多包含九个小数位。示例: |
endTime |
搜索查询的结束时间。使用格林尼治标准时间指定。该值会四舍五入到指定日期的零点。 时间戳,采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,具有纳秒级分辨率,最多包含九个小数位。示例: |
teamDriveInfo |
当 SearchMethod 为 TEAM_DRIVE 时,此字段是必需的。 |
timeZone |
时区名称。它应该是 IANA TZ 名称,例如“America/Los_Angeles”。如需查看时区名称列表,请参阅时区。如要详细了解保险柜如何使用时区,请参阅保险柜帮助中心。 |
联合字段 search_method_field 。必要时,要搜索的实体 search_method_field 的详细信息只能是下列其中一项: |
|
accountInfo |
当 SearchMethod 为 ACCOUNT 时,是必需的。 |
orgUnitInfo |
当 SearchMethod 为 ORG_UNIT 时,是必需的。 |
sharedDriveInfo |
当 SearchMethod 为 SHARED_DRIVE 时是必需的。 |
hangoutsChatInfo |
当 SearchMethod 为 ROOM 时,是必需的。(只读) |
sitesUrlInfo |
当 SearchMethod 为 SITES_网址 时,是必需的。 |
联合字段 corpus_options_field 。适用于特定服务的其他搜索选项。corpus_options_field 只能是下列其中一项: |
|
mailOptions |
设置 Gmail 搜索专用选项。 |
driveOptions |
设置云端硬盘搜索专用选项。 |
hangoutsChatOptions |
设置 Chat 搜索专用选项。(只读) |
voiceOptions |
设置语音搜索专用选项。 |
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[] |
要搜索的一组帐号。 |
OrgUnitInfo
要搜索的组织部门
JSON 表示法 |
---|
{ "orgUnitId": string } |
字段 | |
---|---|
orgUnitId |
要搜索的组织部门的名称,由 Admin SDK Directory API 提供。 |
HangoutsChatInfo
要搜索的 Chat 聊天室
JSON 表示法 |
---|
{ "roomId": [ string ] } |
字段 | |
---|---|
roomId[] |
Chat 聊天室 ID 列表,由 Chat API 提供。每个请求只能导出 500 个 Chat 聊天室中的消息。 |
SitesUrlInfo
可供搜索的新版 Google 协作平台的已发布网站网址
JSON 表示法 |
---|
{ "urls": [ string ] } |
字段 | |
---|---|
urls[] |
已发布网站网址的列表。 |
TeamDriveInfo
要搜索的共享云端硬盘
JSON 表示法 |
---|
{ "teamDriveIds": [ string ] } |
字段 | |
---|---|
teamDriveIds[] |
由 Drive API 提供的团队云端硬盘 ID 列表。 |
MailOptions
适用于 Gmail 搜索的其他选项
JSON 表示法 |
---|
{
"excludeDrafts": boolean,
"clientSideEncryptedOption": enum ( |
字段 | |
---|---|
excludeDrafts |
设置为 true 可排除草稿。 |
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 ( |
字段 | |
---|---|
versionDate |
搜索当前版本的云端硬盘文件,但导出在指定日期零点(世界协调时间 [UTC])之前保存的上一个版本的内容。输入世界协调时间 (UTC) 的日期。 时间戳,采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,具有纳秒级分辨率,最多包含九个小数位。示例: |
includeTeamDrives |
若设为 true,则包含共享云端硬盘。 |
includeSharedDrives |
设为 true 即可包含共享云端硬盘。 |
clientSideEncryptedOption |
设置结果是仅包含通过 Google Workspace 客户端加密功能加密的内容,还是仅包含未加密内容,或者两者兼而有之。默认设置为两者。目前支持云端硬盘。 |
HangoutsChatOptions
适用于 Google Chat 搜索的其他选项
JSON 表示法 |
---|
{ "includeRooms": boolean } |
字段 | |
---|---|
includeRooms |
如要按帐号或组织部门进行搜索,则设为 true 即可包含聊天室。 |
VoiceOptions
语音搜索的其他选项
JSON 表示法 |
---|
{
"coveredData": [
enum ( |
字段 | |
---|---|
coveredData[] |
要搜索的数据类型 |
CalendarOptions
日历搜索的其他选项
JSON 表示法 |
---|
{
"locationQuery": [
string
],
"peopleQuery": [
string
],
"minusWords": [
string
],
"responseStatuses": [
enum ( |
字段 | |
---|---|
locationQuery[] |
仅匹配位置包含指定集合中所有字词的事件。如果字符串包含带引号的短语,则此方法仅匹配位置包含完全匹配短语的事件。系统会以“and”表示该组中的条目。 字词拆分示例:["New Zealand"] vs ["New","Zealand"] "New Zealand":同时与“New andbetter Zealand”匹配:仅与较晚的地区匹配 |
peopleQuery[] |
仅匹配参加者包含指定集合中所有字词的活动。系统会以“and”表示该组中的条目。 |
minusWords[] |
仅匹配在标题、说明、地点或参加者中不包含指定集中任何字词的活动。系统会用“或”处理该组中的条目。 |
responseStatuses[] |
仅匹配保管人给出其中一个回复的活动。如果该集为空或包含 ATTENDEE_专为 Response_UNSPECIFIED,则不会对响应进行过滤。 |
versionDate |
搜索 Google 日历活动的当前版本,但导出指定日期零点(世界协调时间 [UTC])之前保存的上个版本的内容。输入世界协调时间 (UTC) 的日期。 时间戳,采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,具有纳秒级分辨率,最多包含九个小数位。示例: |
AttendeeResponse
用户对邀请的回复。
枚举 | |
---|---|
ATTENDEE_RESPONSE_UNSPECIFIED |
未指定参加者响应。如果设置此选项,则不会过滤回复,系统会忽略查询选项中的所有其他参加者回复。 |
ATTENDEE_RESPONSE_NEEDS_ACTION |
该参与者已受邀但尚未回复。 |
ATTENDEE_RESPONSE_ACCEPTED |
参与者打算参加。 |
ATTENDEE_RESPONSE_DECLINED |
参与者不打算参加。 |
ATTENDEE_RESPONSE_TENTATIVE |
参与者希望有时间参加。 |