保全可无限期地保留数据,以便履行法律义务或保留义务。通常,系统会对一个或多个用户设置保全,以确保在相关事宜不再有效之前,无法删除可能与该事宜相关的数据。
如果处于保全状态的用户删除了被保全的数据,则相应数据会从该用户的视图中移除,但会保留在保险柜中。只要保全未解除,保险柜管理员就可以搜索和导出这些数据。
预订包含以下组件:
- 服务:负责保留数据的应用。服务可以设置为 Gmail、云端硬盘或群组。
- 范围 - 保全所涵盖的实体。范围可以设置为一个或多个用户账号,也可以设置为一个组织部门 (OU)。
- 其他选项(可选):用于缩小要保留在定义范围内的数据的特定详细信息(搜索查询或配置选项)。选项包括:
- mail, Groups:用于缩小预授权范围的搜索查询
- 云端硬盘:将共享云端硬盘包含在冻结范围内
若要使用保险柜资源,该账号必须具有必要的保险柜权限,并且对相应事宜拥有访问权限。若要访问某项诉讼或调查,相应账号必须是该诉讼或调查的创建者、该诉讼或调查的共享对象,或者拥有查看所有诉讼或调查权限。
使用搜索查询为特定用户账号创建邮件预授权
以下示例展示了如何为以下内容创建名为“My First mail Accounts Hold”的预授权:
- 服务:mail
- 实体:用户账号“user1”和“user2”
- 其他选项:搜索查询“to:ceo@company.com”
从 AdminSdk 检索用户账号 ID。请注意,HeldAccount 可以接受账号 ID 或电子邮件地址。如果同时提供这两项信息,系统会使用电子邮件地址,并忽略账号 ID。
Java
HeldMailQuery mailQuery = new HeldMailQuery().setTerms("to:ceo@company.com"); Listaccounts = Lists.newArrayList(); accounts.add(new HeldAccount().setAccountId(user1accountId)); accounts.add(new HeldAccount().setEmail(user2Email)); Hold hold = new Hold() .setName("My First mail Accounts Hold") .setCorpus("MAIL"); .setQuery(new CorpusQuery().setMailQuery(mailQuery)) .setAccounts(accounts); Hold createdHold = client.matters().holds().create(matterId, hold).execute();
Python
def create_hold_mail_accounts(service, matter_id, account_id): mail_query = {'terms': 'to:ceo@company.com'} accounts = [ {'accountId': user1_account_id}, {'email': user2_email} ] wanted_hold = { 'name': 'My First mail Accounts Hold', 'corpus': 'MAIL', 'query': { 'mailQuery': mail_query }, 'accounts': accounts } return service.matters().holds().create( matterId=matter_id, body=wanted_hold).execute()
为 OU 创建云端硬盘预授权,并包含共享云端硬盘内容
以下示例展示了如何为以下内容创建名为“My First Drive OU Hold”的预授权:
- 服务:云端硬盘
- 实体:组织部门“财务”(OU ID 在 orgUnitId 中捕获)
- 其他选项:包含此组织部门中用户所属的共享云端硬盘
从 AdminSdk 检索 OU ID。
Java
HeldOrgUnit orgUnit = new HeldOrgUnit().setOrgUnitId(orgUnitId); // Include shared drives content. HeldDriveQuery driveQuery = new HeldDriveQuery().setIncludeSharedDriveFiles(true); // Create the hold. Hold hold = new Hold() .setName("My First Drive OU Hold") .setCorpus("DRIVE") .setQuery(new CorpusQuery().setDriveQuery(driveQuery)) .setOrgUnit(orgUnit); Hold createdHold = client.matters().holds().create(matterId, hold).execute(); return createdHold;
Python
def create_hold_drive_org(service, matter_id, org_unit_id): drive_query = {'includeSharedDriveFiles': True} org_unit = {'orgUnitId': org_unit_id} wanted_hold = { 'name': 'My First Drive OU Hold', 'corpus': 'DRIVE', 'orgUnit': org_unit, 'query': { 'driveQuery': drive_query } } return service.matters().holds().create( matterId=matter_id, body=wanted_hold).execute()
为特定群组账号创建日期范围内的群组保全
以下示例展示了如何为以下内容创建名为“My First Group Hold”的预授权:
- 服务:群组
- 实体:群组账号“group1”和“group2”
- 其他选项:仅保留发送日期介于“startTime”和“endTime”之间的邮件
从 AdminSdk 检索群组账号 ID。
Java
String APRIL_2_2017_GMT = "2017-04-02T00:00:00Z"; // See below for format*. Listaccounts = Lists.newArrayList(); accounts.add(new HeldAccount().setAccountId(accountId)); accounts.add(new HeldAccount().setAccountId(accountId2)); HeldGroupsQuery groupQuery = new HeldGroupsQuery(); // Restrict by sent date. groupQuery.setStartTime(APRIL_2_2017_GMT); groupQuery.setEndTime(APRIL_2_2017_GMT); // create the hold Hold hold = new Hold() .setName("My First Group Hold") .setCorpus("GROUPS") .setQuery(new CorpusQuery().setGroupsQuery(groupQuery)); hold.setAccounts(accounts); Hold createdHold = client.matters().holds().create(matterId, hold).execute();
Python
def create_hold_groups_date_range(service, matter_id, group_account_id): groups_query = { 'startTime': '2017-04-02T00:00:00Z', # See below for format* 'endTime': '2017-04-02T00:00:00Z' } accounts = [{'accountId': group_account_id}] wanted_hold = { 'name': 'My First Group Hold', 'corpus': 'GROUPS', 'query': { 'groupsQuery': groups_query }, 'accounts': accounts } return service.matters().holds().create( matterId=matter_id, body=wanted_hold).execute()
- 时间戳格式。此外,开始/结束时间会转换为格林尼治标准时间,并向下舍入到给定日期的开始时间。
查询和修改现有预授权
以下示例展示了如何列出现有预授权交易中包含的所有账号:
Java
client.matters().holds().accounts().list(matterId, holdId).execute().getAccounts();
Python
# If no accounts are on hold, ['accounts'] will raise an error. def list_held_accounts(service, matter_id, hold_id): return service.matters().holds().accounts().list( matterId=matter_id, holdId=hold_id).execute()['accounts']
以下示例展示了如何向现有预授权添加账号以及从中移除账号:
Java
// Add an account by id. client .matters() .holds() .accounts() .create(matterId, holdId, new HeldAccount().setAccountId(accountId)) .execute(); // Remove an account by id. client.matters().holds().accounts().delete(matterId, holdId, accountId).execute(); String email = "email@email.com"; // Add an account by email. client .matters() .holds() .accounts() .create(matterId, holdId, new HeldAccount().setEmail(email)) .execute();
Python
def add_held_account(service, matter_id, hold_id, account_id): held_account = {'accountId': account_id} return service.matters().holds().accounts().create( matterId=matter_id, holdId=hold_id, body=held_account).execute() def remove_held_account(service, matter_id, hold_id, account_id): return service.matters().holds().accounts().delete( matterId=matter_id, holdId=hold_id, accountId=account_id).execute() def add_held_account(service, matter_id, hold_id, email): held_account = {'email': email} return service.matters().holds().accounts().create( matterId=matter_id, holdId=hold_id, body=held_account).execute()
以下示例展示了如何修改现有 OU 预授权的 OU:
Java
Hold hold = client.matters().holds().get(matterId, holdId).execute(); hold.getOrgUnit().setOrgUnitId(newOrgUnitId); Hold modifiedHold = client.matters().holds().update(matterId, holdId, hold).execute(); return modifiedHold;
Python
def update_hold_ou(service, matter_id, hold_id, org_unit_id): current_hold = get_hold(matter_id, hold_id) current_hold['orgUnit'] = {'orgUnitId': org_unit_id} return service.matters().holds().update( matterId=matter_id, holdId=hold_id, body=current_hold).execute()
以下示例展示了如何列出某项支持请求的所有预授权:
Java
String matterId = "Matter Id";// List all holds. List
holdsList = client.matters().holds().list(matterId).execute().getHolds(); // Paginate on holds. ListHoldsResponse response = client .matters() .holds() .list(matterId) .setPageSize(10) .execute();
String nextPageToken = response.getNextPageToken(); if (nextPageToken != null) { client .matters() .holds() .list(matterId) .setPageSize(10) .setPageToken(nextPageToken) .execute(); }
Python
# This can paginate in the same manner as with matters. def list_holds(service, matter_id): return service.matters().holds().list(matterId=matter_id).execute()