本頁面由 Cloud Translation API 翻譯而成。

Query

JSON 表示法
DataScope
SearchMethod
AccountInfo
- JSON 表示法
OrgUnitInfo
- JSON 表示法
SharedDriveInfo
- JSON 表示法
HangoutsChatInfo
- JSON 表示法
SitesUrlInfo
- JSON 表示法
DriveDocumentInfo
- JSON 表示法
DriveDocumentIds
- JSON 表示法
TeamDriveInfo
- JSON 表示法
MailOptions
- JSON 表示法
ClientSideEncryptedOption
DriveOptions
- JSON 表示法
SharedDrivesOption
HangoutsChatOptions
- JSON 表示法
VoiceOptions
- JSON 表示法
CalendarOptions
- JSON 表示法
AttendeeResponse
GeminiOptions

用於搜尋和匯出的查詢定義。

JSON 表示法

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),
  "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)` 這個欄位已於 2019 年 6 月 10 日淘汰。請改用 method。我們將於 2020 年 6 月 1 日停止支援這個欄位。要使用的搜尋方法。
`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)` 這個欄位已於 2019 年 6 月 10 日淘汰。請改用 SharedDriveInfo。我們將於 2020 年 6 月 1 日停止支援這個欄位。如果 SearchMethod 為 TEAM_DRIVE，則為必填。
`timeZone`	`string` 時區名稱，應為 IANA 時區名稱，例如「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_URL 時為必填。
`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)` 設定日曆搜尋專屬選項。
`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 中指定的小組雲端硬碟資料。這個欄位已於 2019 年 6 月 10 日淘汰。請改用 SHARED_DRIVE。我們將於 2020 年 6 月 1 日停止支援這個欄位。
`ENTIRE_ORG`	搜尋機構內所有帳戶的資料。僅支援 Gmail。指定後，您不需要指定 AccountInfo 或 OrgUnitInfo。
`ROOM`	在 HangoutsChatInfo 中指定的 Chat 聊天室中搜尋訊息。
`SITES_URL`	根據 SitesUrlInfo 中指定的已發布網站網址搜尋網站。
`SHARED_DRIVE`	搜尋 SharedDriveInfo 中指定的共用雲端硬碟中的檔案。
`DRIVE_DOCUMENT`	擷取 DriveDocumentInfo 中指定的文件。

AccountInfo

要搜尋的帳戶

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

欄位

欄位
`emails[]`	`string` 要搜尋的一組帳戶。

emails[]

string

要搜尋的一組帳戶。

OrgUnitInfo

要搜尋的機構單位

JSON 表示法
{ "orgUnitId": string }

欄位

欄位
`orgUnitId`	`string` 要搜尋的機構單位名稱，由 Admin SDK Directory API 提供。

orgUnitId

string

要搜尋的機構單位名稱，由 Admin SDK Directory API 提供。

SharedDriveInfo

要搜尋的共用雲端硬碟

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

欄位

欄位
`sharedDriveIds[]`	`string` Drive API 提供的共用雲端硬碟 ID 清單。

sharedDriveIds[]

string

Drive API 提供的共用雲端硬碟 ID 清單。

HangoutsChatInfo

要搜尋的 Chat 聊天室

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

欄位

欄位
`roomId[]`	`string` Chat API 提供的 Chat 聊天室 ID 清單。每個要求最多可匯出 500 個 Chat 聊天室。

roomId[]

string

Chat API 提供的 Chat 聊天室 ID 清單。每個要求最多可匯出 500 個 Chat 聊天室。

SitesUrlInfo

要搜尋的新版 Google 協作平台網站的發布網址

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

欄位

欄位
`urls[]`	`string` 已發布的網站網址清單。

urls[]

string

已發布的網站網址清單。

DriveDocumentInfo

要搜尋的 Google 雲端硬碟文件。

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 指定雲端硬碟文件。

聯集欄位 identifier。擷取雲端硬碟文件的格式。identifier 只能是下列其中一項：

documentIds

object (DriveDocumentIds)

依據文件 ID 指定雲端硬碟文件。

DriveDocumentIds

依據文件 ID 指定雲端硬碟文件。

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

欄位

欄位
`ids[]`	`string` 必要欄位。雲端硬碟文件 ID 清單。

ids[]

string

必要欄位。雲端硬碟文件 ID 清單。

TeamDriveInfo

要搜尋的團隊雲端硬碟

JSON 表示法
{ "teamDriveIds": [ string ] }

欄位

欄位
`teamDriveIds[] (deprecated)`	`string` 這個欄位已於 2019 年 6 月 10 日淘汰。請改用 sharedDriveIds。我們將於 2020 年 6 月 1 日停止支援這個欄位。由 Drive API 提供的團隊雲端硬碟 ID 清單。

teamDriveIds[]
(deprecated)

string

由 Drive API 提供的團隊雲端硬碟 ID 清單。

MailOptions

Gmail 搜尋的其他選項

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

欄位

欄位
`excludeDrafts`	`boolean` 設為 true 即可排除草稿。
`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 表示法

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

{
  "versionDate": string,
  "includeTeamDrives": boolean,
  "includeSharedDrives": boolean,
  "clientSideEncryptedOption": enum (ClientSideEncryptedOption),
  "sharedDrivesOption": enum (SharedDrivesOption)
}

欄位
`versionDate`	`string (Timestamp format)` 搜尋雲端硬碟檔案的目前版本，但匯出該日期凌晨 12:00 (世界標準時間) 前儲存的最後一個版本內容。請以世界標準時間輸入日期。使用 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` 這個欄位已於 2019 年 6 月 10 日淘汰。請改用 includeSharedDrives。我們將於 2020 年 6 月 1 日停止支援這個欄位。設為 true 可納入小組雲端硬碟。
`includeSharedDrives (deprecated)`	`boolean` 這個欄位已於 2025 年 5 月 27 日淘汰。請改用 sharedDrivesOption。我們將於 2026 年 5 月 27 日停止支援這個欄位。設為 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，這樣系統就會納入聊天室。

includeRooms

boolean

如果是依帳戶或機構單位搜尋，請將值設為 true，這樣系統就會納入聊天室。

VoiceOptions

語音搜尋的其他選項

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

欄位

欄位
`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 better Zealand」相符，但只會比對後者
`peopleQuery[]`	`string` 只會比對出席者包含指定集合中所有字詞的活動。集合中的項目會視為「and」。
`minusWords[]`	`string` 只比對標題、說明、地點或參與者中不含指定組合中任何字詞的活動。集合中的項目會視為「或」。
`responseStatuses[]`	`enum (AttendeeResponse)` 只比對管理員提供上述回覆的事件。如果集合為空白或包含 ATTENDEE_RESPONSE_UNSPECIFIED，系統就不會篩選回覆。
`versionDate`	`string (Timestamp format)` 搜尋日曆活動的目前版本，但匯出該日期凌晨 12:00 (世界標準時間) 前儲存的最後一個版本內容。請以世界標準時間輸入日期。使用 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 搜尋的其他選項

Query 透過集合功能整理內容 你可以依據偏好儲存及分類內容。

DataScope

SearchMethod

AccountInfo

OrgUnitInfo

SharedDriveInfo

HangoutsChatInfo

SitesUrlInfo

DriveDocumentInfo

DriveDocumentIds

TeamDriveInfo

MailOptions

ClientSideEncryptedOption

DriveOptions

SharedDrivesOption

HangoutsChatOptions

VoiceOptions

CalendarOptions

AttendeeResponse

GeminiOptions

Query