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)

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

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

機構單位的不可變更 ID,與 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)
  }
  // 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」CorpusType必須為「groups」CorpusType

hangoutsChatQuery

object (HeldHangoutsChatQuery)

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

voiceQuery

object (HeldVoiceQuery)

Voice 訴訟保留的服務專屬選項。如果已設定此屬性,CorpusType 必須為 VOICE

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)

查詢的開始時間。請以格林威治標準時間指定。這個值會四捨五入為指定日期的凌晨 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"

HeldGroupsQuery

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

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

HeldHangoutsChatQuery

Chat 訴訟保留選項。

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

boolean

如要將使用者所屬 Chat 聊天室中的訊息納入納入範圍,請設為 true

HeldVoiceQuery

Voice 訴訟保留選項。

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

enum (VoiceCoveredData)

訴訟保留所涵蓋的資料類型清單。不能空白。順序不重要,系統會忽略重複項目。

方法

addHeldAccounts

將帳戶新增至訴訟保留。

create

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

delete

移除指定的訴訟保留,並釋出屬於訴訟保留的帳戶或機構單位。

get

取得指定訴訟保留。

list

列出案件的訴訟保留。

removeHeldAccounts

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

update

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