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)

上次修改此搁置状态的时间。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 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)

如果设置了此属性，则保全适用于相应组织部门的所有成员，并且账号必须为空。此属性可变。对于 Google 群组保全，请设置账号。
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 规范化（即转换为 UTC 零时区格式并在末尾附加 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)

语音保留功能的特定于服务的选项。如果设置了此字段，CorpusType 必须为 VOICE。
calendarQuery

object (HeldCalendarQuery)

与 Google 日历中止服务相关的特定选项。如果设置了此字段，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 规范化（即转换为 UTC 零时区格式并在末尾附加 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 规范化（即转换为 UTC 零时区格式并在末尾附加 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 规范化（即转换为 UTC 零时区格式并在末尾附加 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 规范化（即转换为 UTC 零时区格式并在末尾附加 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

聊天内容保全选项。

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

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