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)

搜尋查詢的開始時間。請以格林威治標準時間指定。這個值會四捨五入為指定日期的凌晨 12 點。

RFC3339 世界標準時間「Zulu」格式的時間戳記，採用奈秒解析度，且最多 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
endTime

string (Timestamp format)

搜尋查詢的結束時間。請以格林威治標準時間指定。這個值會四捨五入為指定日期的凌晨 12 點。

RFC3339 世界標準時間「Zulu」格式的時間戳記，採用奈秒解析度，且最多 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
teamDriveInfo
(deprecated)

object (TeamDriveInfo)

如果 SearchMethod 為 TEAM_友，則為必要欄位。
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_URL 時為必要。
聯集欄位 corpus_options_field。特定服務的其他搜尋選項。corpus_options_field 只能是下列其中一項：
mailOptions

object (MailOptions)

設定 Gmail 搜尋專屬選項。
driveOptions

object (DriveOptions)

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

object (HangoutsChatOptions)

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

object (VoiceOptions)

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

object (CalendarOptions)

設定 Google 日曆搜尋專屬選項。

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

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

HangoutsChatInfo

要搜尋的 Chat 聊天室

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

string

Chat 聊天室 ID 清單，由 Chat API 提供。每次要求只能匯出 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)

搜尋目前的雲端硬碟檔案版本，但匯出指定日期凌晨 12:00 (世界標準時間) 前儲存的最後一個版本內容。輸入日期 (以世界標準時間為準)。

RFC3339 世界標準時間「Zulu」格式的時間戳記，採用奈秒解析度，且最多 9 個小數位數。範例："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"] "紐西蘭"：同時符合「紐西蘭和更紐西蘭」：僅比對之後
peopleQuery[]

string

僅比對與會者包含指定集合中所有字詞的活動。組合中的項目會視為「and」。
minusWords[]

string

只會比對標題、說明、地點或參與者中不含任何指定字詞的活動。組合中的項目會視為「or」。
responseStatuses[]

enum (AttendeeResponse)

只比對監管人提供了其中一項回應的事件。如果資料集空白或包含 ATTENDEE_response_UNSPECIFIED，則系統不會篩選回應。
versionDate

string (Timestamp format)

搜尋目前的日曆活動版本，並匯出指定日期凌晨 12:00 (世界標準時間) 前儲存的最後一個版本內容。輸入日期 (以世界標準時間為準)。

RFC3339 世界標準時間「Zulu」格式的時間戳記，採用奈秒解析度，且最多 9 個小數位數。範例："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 參與者預期可能會參加。