保留を管理

記録保持では、法的義務や保全義務を果たすためにデータが無期限に保持されます。通常、保留は 1 人以上のユーザーに対して設定され、その問題がアクティブでなくなるまで、その問題に関連する可能性があるデータが削除されないようにします。

記録保持の対象となるユーザーが記録保持対象のデータを削除した場合、そのデータはユーザーのビューからは削除されますが、Vault 内には保持されます。記録保持が設定されている限り、Vault 管理者はそのデータの検索と書き出しを行えます。

保留には次のコンポーネントがあります。

  • サービス - 保持されるデータの処理を担当するアプリケーション。サービスは、メール、ドライブ、Google グループに設定できます。
  • スコープ - 保留の対象となるエンティティ。スコープは、1 つ以上のユーザー アカウントまたは組織部門（OU）に設定できます。
  • その他のオプション（省略可）- 定義されたスコープ内に保持するデータを絞り込むために使用される特定の詳細（検索クエリまたは構成オプション）。次のようなオプションがあります。
    • mail、Groups: 検索クエリを使用して保留を絞り込む
    • ドライブ: 共有ドライブを保留に含める

Vault リソースを操作するには、アカウントに必要な Vault 権限とケースへのアクセス権が必要です。案件にアクセスするには、そのアカウントが案件を作成したか、案件を共有されているか、全案件の閲覧権限を持っている必要があります。

検索クエリを使用して特定のユーザー アカウントのメールを保留にする

次の例は、次のような場合に「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");
List accounts = 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」という名前の保留を作成します。

  • サービス: ドライブ
  • エンティティ: 組織部門「Finance」（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*.
 
List accounts = 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()
  • タイムスタンプの形式。また、開始時間と終了時間は GMT に変換され、指定された日付の開始時間に切り捨てられます。

既存の保留をクエリして変更する

次の例は、既存の保留に含まれるすべてのアカウントを一覧表示する方法を示しています。

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()