REST Resource: matters.holds

資源：保留

暫緩撥付。訴訟保留可防止指定 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

機構單位的不變 ID，由 Admin SDK 提供。
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 表示法 
{

  "driveQuery": {
    object (HeldDriveQuery)
  },
  "mailQuery": {
    object (HeldMailQuery)
  },
  "groupsQuery": {
    object (HeldGroupsQuery)
  },
  "hangoutsChatQuery": {
    object (HeldHangoutsChatQuery)
  },
  "voiceQuery": {
    object (HeldVoiceQuery)
  },
  "calendarQuery": {
    object (HeldCalendarQuery)
  },
  "geminiQuery": {
    object (HeldGeminiQuery)
  }
}
欄位
聯集欄位 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)

Voice 暫停通話的服務專屬選項。如果設定，CorpusType 必須為 VOICE。
calendarQuery

object (HeldCalendarQuery)

日曆預留時間的服務專屬選項。如果已設定，CorpusType 必須為 CALENDAR。
geminiQuery

object (HeldGeminiQuery)

Gemini 暫緩發布的服務專屬選項。如果已設定，CorpusType 必須為 GEMINI。

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

這個類型沒有任何欄位。

日曆保留選項。

HeldGeminiQuery

這個類型沒有任何欄位。

Gemini 暫緩發布選項。

方法

addHeldAccounts

 將帳戶新增至訴訟保留。

create

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

delete

 移除指定的訴訟保留，並解除受訴訟保留影響的帳戶或組織單位。

get

 取得指定的訴訟保留。

list

 列出案件中的訴訟保留。

removeHeldAccounts

 從訴訟保留中移除指定帳戶。

update

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