REST Resource: matters.holds

資源：Hol

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

如要使用保管箱資源，帳戶必須具備必要的保管箱權限和案件存取權。如要存取案件，帳戶必須建立該案件、已與他們共用案件，或是具備「查看所有案件」權限。

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

string

訴訟保留的專屬不可變動 ID。建立時指派 ID。
name

string

訴訟保留的名稱。
updateTime

string (Timestamp format)

上次修改這項訴訟保留的時間。

RFC3339 世界標準時間「Zulu」格式的時間戳記，解析度以奈秒為單位，小數點後最多 9 位。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
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)

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

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

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)

Voice 訴訟保留的服務專屬選項，如要設定，則 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 點。

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

string (Timestamp format)

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

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

HeldGroupsQuery

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

JSON 表示法 
{
  "terms": string,
  "startTime": string,
  "endTime": string
}
欄位
terms

string

您可使用搜尋運算子修正訴訟保留涵蓋的訊息。
startTime

string (Timestamp format)

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

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

string (Timestamp format)

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

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

HeldHangoutsChatQuery

Chat 訴訟保留的選項。

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

boolean

如要納入使用者所屬的 Chat 聊天室訊息，請設為 true。

HeldVoiceQuery

Voice 保留選項。

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

enum (VoiceCoveredData)

訴訟保留所涵蓋資料類型的清單。不得空白。順序無關緊要，且系統會忽略重複項目。

HeldCalendarQuery

這個類型沒有任何欄位。

日曆訴訟保留選項。

方法

addHeldAccounts

 將帳戶加入訴訟保留。

create

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

delete

 移除指定的訴訟保留，並釋出適用訴訟保留的帳戶或機構單位。

get

 取得指定的訴訟保留。

list

 列出案件中的訴訟保留。

removeHeldAccounts

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

update

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