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

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)

适用于 Google 日历预订的服务专用选项。如果设置，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

Voice 通话保持选项。

JSON 表示法 
{
  "coveredData": [
    enum (VoiceCoveredData)
  ]
}
字段
coveredData[]

enum (VoiceCoveredData)

冻结范围内的数据类型列表。应不为空。顺序无关紧要，系统会忽略重复项。

HeldCalendarQuery

此类型没有字段。

日历预订选项。

方法

addHeldAccounts

 为保全添加账号。

create

 在指定的诉讼或调查中创建保全。

delete

 移除指定的保全，并释放保全所涵盖的账号或组织部门。

get

 获取指定的预授权。

list

 列出某一诉讼或调查中的保全。

removeHeldAccounts

 从保全名单中移除指定的账号。

update

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