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,

  "accountInfo": {
    object (AccountInfo)
  },
  "orgUnitInfo": {
    object (OrgUnitInfo)
  },
  "sharedDriveInfo": {
    object (SharedDriveInfo)
  },
  "hangoutsChatInfo": {
    object (HangoutsChatInfo)
  },
  "sitesUrlInfo": {
    object (SitesUrlInfo)
  },
  "driveDocumentInfo": {
    object (DriveDocumentInfo)
  }

  "mailOptions": {
    object (MailOptions)
  },
  "driveOptions": {
    object (DriveOptions)
  },
  "hangoutsChatOptions": {
    object (HangoutsChatOptions)
  },
  "voiceOptions": {
    object (VoiceOptions)
  },
  "calendarOptions": {
    object (CalendarOptions)
  },
  "geminiOptions": {
    object (GeminiOptions)
  },
  "geminiInWorkspaceOptions": {
    object (GeminiInWorkspaceOptions)
  }
}
欄位
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」。如需時區名稱清單，請參閱「時區」。如要進一步瞭解保管箱如何使用時區，請造訪保管箱說明中心。
指定要搜尋的實體詳細資料 (如有需要)。以下是互斥欄位清單。回應中最多會設定下列其中一個欄位：
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，則必須提供這項資訊。
互斥欄位結束。
特定服務的其他搜尋選項。以下是互斥欄位清單。回應中最多會設定下列其中一個欄位：
mailOptions

object (MailOptions)

設定 Gmail 搜尋專用選項。
driveOptions

object (DriveOptions)

設定雲端硬碟搜尋專用選項。
hangoutsChatOptions

object (HangoutsChatOptions)

設定 Chat 搜尋專屬選項。(唯讀)
voiceOptions

object (VoiceOptions)

設定語音搜尋專屬選項。
calendarOptions

object (CalendarOptions)

設定日曆搜尋專用選項。
geminiOptions

object (GeminiOptions)

設定 Gemini 應用程式搜尋專用選項。
geminiInWorkspaceOptions

object (GeminiInWorkspaceOptions)

設定 Gemini in Workspace 搜尋專用選項。
互斥欄位結束。

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

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

HangoutsChatInfo

要搜尋的 Chat 聊天室

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

string

Chat 聊天室 ID 清單，由 Chat API 提供。每次要求最多可從 500 個 Chat 聊天室匯出資料。

SitesUrlInfo

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

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

string

已發布網站的網址清單。

DriveDocumentInfo

要搜尋的雲端硬碟文件。

JSON 表示法 
{

  "documentIds": {
    object (DriveDocumentIds)
  }
}
欄位
擷取雲端硬碟文件的格式。以下是互斥欄位清單。回應中最多會設定下列其中一個欄位：
documentIds

object (DriveDocumentIds)

依文件 ID 指定雲端硬碟文件。
互斥欄位結束。

DriveDocumentIds

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

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

string

必填。雲端硬碟文件 ID 清單。

TeamDriveInfo

要搜尋的團隊雲端硬碟

JSON 表示法 
{
  "teamDriveIds": [
    string
  ]
}
欄位
teamDriveIds[]
(deprecated)

string

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

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)

搜尋雲端硬碟檔案目前的版本，但匯出該特定日期凌晨 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

設為 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 只有在帳戶是資源的協作者，但不是共用雲端硬碟的成員時，才會包含共用雲端硬碟資源。這會對應到 Vault 使用者介面中的「僅在文件直接共用 (而非因為是共用雲端硬碟成員) 時才包含」選項。(先前「includeSharedDrives」為關閉狀態)
INCLUDED 搜尋結果會顯示共用雲端硬碟中的資源。(先前為「includeSharedDrives」開啟)

HangoutsChatOptions

Google Chat 搜尋的其他選項

JSON 表示法 
{
  "includeRooms": boolean
}
欄位
includeRooms

boolean

如要依帳戶或組織單位搜尋，請將此參數設為 true，即可納入聊天室。

VoiceOptions

語音搜尋的其他選項

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

enum (VoiceCoveredData)

要搜尋的資料類型

CalendarOptions

其他 Google 日曆搜尋選項

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

活動的與會者必須含有指定組合中的所有字詞，系統才會將其視為相符結果。集合中的項目會以「和」的方式考量。
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 應用程式搜尋的其他選項

GeminiInWorkspaceOptions

這個類型沒有任何欄位。

Gemini in Workspace 搜尋的其他選項