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)

此保全的上次修改时间。

时间戳，采用 RFC3339 世界协调时间 (UTC)（即“祖鲁时”）格式，具有纳秒级分辨率，最多包含九个小数位。示例："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 世界协调时间 (UTC)（即“祖鲁时”）格式，具有纳秒级分辨率，最多包含九个小数位。示例："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 必须为 GROUPS。
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)

查询的开始时间。使用格林尼治标准时间指定。该值会四舍五入到指定日期的零点。

时间戳，采用 RFC3339 世界协调时间 (UTC)（即“祖鲁时”）格式，具有纳秒级分辨率，最多包含九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
endTime

string (Timestamp format)

查询的结束时间。使用格林尼治标准时间指定。该值会四舍五入到指定日期的零点。

时间戳，采用 RFC3339 世界协调时间 (UTC)（即“祖鲁时”）格式，具有纳秒级分辨率，最多包含九个小数位。示例："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)

查询的开始时间。使用格林尼治标准时间指定。该值会四舍五入到指定日期的零点。

时间戳，采用 RFC3339 世界协调时间 (UTC)（即“祖鲁时”）格式，具有纳秒级分辨率，最多包含九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
endTime

string (Timestamp format)

查询的结束时间。使用格林尼治标准时间指定。该值会四舍五入到指定日期的零点。

时间戳，采用 RFC3339 世界协调时间 (UTC)（即“祖鲁时”）格式，具有纳秒级分辨率，最多包含九个小数位。示例："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

 更新保全的范围（组织部门或帐号）和查询参数。