REST Resource: matters.holds

資源：Hold

保留。訴訟保留可防止指定 Google Workspace 服務清除特定帳戶或機構單位所有成員的資料。

如要使用保管箱資源，帳戶必須具備必要的保管箱權限，並能存取案件。如要存取案件，帳戶必須是該案件的建立者、共用對象，或具備「查看所有案件」權限。

JSON 表示法 
{
  "holdId": string,
  "name": string,
  "updateTime": string,
  "accounts": [
    {
      object (HeldAccount)
    }
  ],
  "orgUnit": {
    object (HeldOrgUnit)
  },
  "corpus": enum (CorpusType),
  "query": {
    object (CorpusQuery)
  }
}
欄位
holdId

string

保留項目的專屬 ID (不可變更)。在建立時指派。
name

string

保留項目的名稱。
updateTime

string (Timestamp format)

上次修改這項保留資料的時間。

使用 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"。
accounts[]

object (HeldAccount)

如果已設定，系統會將保留狀態套用至指定帳戶，且 orgUnit 必須留空。
orgUnit

object (HeldOrgUnit)

如果已設定，訴訟保留狀態會套用至機構單位的所有成員，且「帳戶」必須為空白。這個屬性可變動。如要設定群組訴訟保留，請設定「帳戶」。
corpus

enum (CorpusType)

要搜尋的服務。
query

object (CorpusQuery)

服務專屬選項。如果已設定，CorpusQuery 必須與 CorpusType 相符。

HeldOrgUnit

訴訟保留所涵蓋的機構單位。這個結構體無法變更。

JSON 表示法 
{
  "orgUnitId": string,
  "holdTime": string
}
欄位
orgUnitId

string

Admin SDK 提供的機構單位不可變更 ID。
holdTime

string (Timestamp format)

機構單位處於訴訟保留狀態的時間。這個屬性無法變更。

使用 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"。

CorpusQuery

保留專屬服務選項。

JSON 表示法 
{

  // Union field corpus_query can be only one of the following:
  "driveQuery": {
    object (HeldDriveQuery)
  },
  "mailQuery": {
    object (HeldMailQuery)
  },
  "groupsQuery": {
    object (HeldGroupsQuery)
  },
  "hangoutsChatQuery": {
    object (HeldHangoutsChatQuery)
  },
  "voiceQuery": {
    object (HeldVoiceQuery)
  },
  "calendarQuery": {
    object (HeldCalendarQuery)
  }
  // End of list of possible types for union field corpus_query.
}
欄位
聯集欄位 corpus_query。如果已設定，則必須與服務類型相符。corpus_query 只能是下列其中一項：
driveQuery

object (HeldDriveQuery)

雲端硬碟保留功能的服務專屬選項。如果已設定，CorpusType 必須為 DRIVE。
mailQuery

object (HeldMailQuery)

適用於 Gmail 訴訟保留的服務專屬選項。如果已設定，CorpusType 必須為 MAIL。
groupsQuery

object (HeldGroupsQuery)

群組保留功能的特定服務選項。如果已設定，CorpusType 必須為 GROUPS。
hangoutsChatQuery

object (HeldHangoutsChatQuery)

Chat 訴訟保留的服務專屬選項。如果已設定，CorpusType 必須為 HANGOUTS_CHAT。
voiceQuery

object (HeldVoiceQuery)

語音服務保留功能的服務專屬選項。如果已設定，CorpusType 必須為 VOICE。
calendarQuery

object (HeldCalendarQuery)

日曆暫緩功能的服務專屬選項。如果已設值，CorpusType 必須為 CALENDAR。

HeldDriveQuery

雲端硬碟訴訟保留的選項。

JSON 表示法 
{
  "includeTeamDriveFiles": boolean,
  "includeSharedDriveFiles": boolean
}
欄位
includeTeamDriveFiles
(deprecated)

boolean

如要將小組雲端硬碟中的檔案納入保留項目，請將值設為 true。
includeSharedDriveFiles

boolean

如要將共用雲端硬碟中的檔案納入保留項目，請將此值設為 true。

HeldMailQuery

查詢 Gmail 訴訟保留資料的選項。

JSON 表示法 
{
  "terms": string,
  "startTime": string,
  "endTime": string
}
欄位
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"。

HeldGroupsQuery

群組訴訟保留的查詢選項。

JSON 表示法 
{
  "terms": string,
  "startTime": string,
  "endTime": string
}
欄位
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"。

HeldHangoutsChatQuery

Chat 訴訟保留選項。

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

boolean

如要將使用者所屬 Chat 聊天室中的訊息納入搜尋範圍，請將此值設為 true。

HeldVoiceQuery

語音留言的選項。

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

enum (VoiceCoveredData)

這項資料保留措施涵蓋的資料類型清單。不得空白。順序不重要，重複項目會遭到忽略。

HeldCalendarQuery

這個類型沒有任何欄位。

日曆保留功能的選項。

方法

addHeldAccounts

 新增要套用訴訟保留的帳戶。

create

 在指定案件中建立訴訟保留。

delete

 移除指定的訴訟保留狀態，並釋出遭到保留的帳戶或機構單位。

get

 取得指定的保留。

list

 列出案件中的訴訟保留。

removeHeldAccounts

 從保留狀態中移除指定的帳戶。

update

 更新訴訟保留的範圍 (機構單位或帳戶) 和查詢參數。