Vault API を使用すると、Vault のエクスポートを管理できます。次のことが可能です。
エクスポートを作成する - クエリに一致するメールまたはファイルを検索して Google Cloud にエクスポートするリクエストを Vault に送信します。
注: 組織全体で 20 件を超える書き出しを同時に処理することはできません。パフォーマンスを向上させるには、大規模なエクスポートを小さなセットに分割します。たとえば、すべてを一度にエクスポートするのではなく、エクスポートを月ごとに分割します。別の例として、各エクスポートに含めるエンティティ（ユーザーや、グループ、チャット スペースなどの特別なエンティティなど）を減らすこともできます。
例:
エクスポートを一覧表示 - 問題に関連付けられているすべてのエクスポートのステータスを取得します。
エクスポートを取得する - エクスポートに関する情報を取得します。
エクスポートをダウンロードする - Google Cloud からエクスポートをダウンロードします。
エクスポートを削除する - 不要になったエクスポートをケースから削除します。
始める前に
必要なライブラリと認証を設定するには、使用しているプログラミング言語のクイックスタートをご覧ください。
Vault リソースを操作するには、アカウントに必要な Vault 権限とケースへのアクセス権が必要です。案件にアクセスするには、そのアカウントが案件を作成したか、案件を共有されているか、全案件の閲覧権限を持っている必要があります。
Gmail のエクスポートを作成する
次の例は、Gmail のエクスポートを作成する方法を示しています。このリクエストは、次の条件を満たすすべての Gmail と従来のハングアウトのメッセージをエクスポートします。
- アカウント
email1とemail2が所有するメッセージ。 - 下書きメールは除外されます。
[email protected]に送信されたメッセージです。
ヒント: これらの例では、従来の Gmail エクスポート システムを使用しています。新しいエクスポート システムを使用してエクスポートするには、MailExportOptions で useNewExport を true に設定します。
Java
public Export createMailAccountHeldDataExports(Vault client, String matterId) {
AccountInfo emailsToSearch = new AccountInfo().setEmails(ImmutableList.of("email1", "email2"));
MailOptions mailQueryOptions = new MailOptions().setExportFormat("PST");
String queryTerms = "to:[email protected]";
Query mailQuery =
new Query()
.setCorpus("MAIL")
.setDataScope("HELD_DATA")
.setSearchMethod("ACCOUNT")
.setAccountInfo(emailsToSearch)
.setTerms(queryTerms)
.setMailOptions(mailQueryOptions);
MailExportOptions mailExportOptions =
new MailExportOptions()
.setExportFormat("MBOX")
.showConfidentialModeContent(true);
Export wantedExport =
new Export()
.setMatterId(matterId)
.setName("My first mail accounts export")
.setQuery(mailQuery)
.setExportOptions(new ExportOptions().setMailOptions(mailExportOptions));
return client.matters().exports().create(matter, wantedExport).execute();
}
Python
def create_mail_account_held_data_export(service, matter_id):
emails_to_search = ['email1', 'email2']
mail_query_options = {'excludeDrafts': True}
query_terms = 'to:[email protected]'
mail_query = {
'corpus': 'MAIL',
'dataScope': 'HELD_DATA',
'searchMethod': 'ACCOUNT',
'accountInfo': {
'emails': emails_to_search
},
'terms': query_terms,
'mailOptions': mail_query_options,
}
mail_export_options = {
'exportFormat': 'MBOX',
'showConfidentialModeContent': True
}
wanted_export = {
'name': 'My first mail accounts export',
'query': mail_query,
'exportOptions': {
'mailOptions': mail_export_options
}
}
return service.matters().exports().create(
matterId=matter_id, body=wanted_export).execute()
ドライブのエクスポートを作成する
次の例は、ドライブのエクスポートを作成する方法を示しています。このリクエストは、次の条件を満たすすべてのファイル（共有ドライブ内のファイルを含む）をエクスポートします。
- 指定した組織部門（Admin SDK で取得）に属している。
が指定された時刻の間に作成された
Java
public Export createDriveOuAllDataExport(Vault client, String matterId) {
OrgUnitInfo ouToSearch = new OrgUnitInfo().setOrgUnitId("ou id retrieved from admin sdk");
DriveOptions driveQueryOptions = new DriveOptions().setIncludeSharedDrives(true);
Query driveQuery =
new Query()
.setCorpus("DRIVE")
.setDataScope("ALL_DATA")
.setSearchMethod("ORG_UNIT")
.setOrgUnitInfo(ouToSearch)
.setDriveOptions(driveQueryOptions)
.setStartTime("2017-03-16T00:00:00Z")
.setEndTime("2017-03-16T00:00:00Z")
.setTimeZone("Etc/GMT+2");
DriveExportOptions driveExportOptions = new DriveExportOptions().setIncludeAccessInfo(false);
Export wantedExport =
new Export()
.setName("My first drive ou export")
.setQuery(driveQuery)
.setExportOptions(new ExportOptions().setDriveOptions(driveExportOptions));
return client.matters().exports().create(matter, wantedExport).execute();
}
Python
def create_drive_ou_all_data_export(service, matter_id):
ou_to_search = 'ou id retrieved from admin sdk'
drive_query_options = {'includeSharedDrives': True}
drive_query = {
'corpus': 'DRIVE',
'dataScope': 'ALL_DATA',
'searchMethod': 'ORG_UNIT',
'orgUnitInfo': {
'org_unit_id': ou_to_search
},
'driveOptions': drive_query_options,
'startTime': '2017-03-16T00:00:00Z',
'endTime': '2017-09-23T00:00:00Z',
'timeZone': 'Etc/GMT+2'
}
drive_export_options = {'includeAccessInfo': False}
wanted_export = {
'name': 'My first drive ou export',
'query': drive_query,
'exportOptions': {
'driveOptions': drive_export_options
}
}
return service.matters().exports().create(
matterId=matter_id, body=wanted_export).execute()
Meet のエクスポートを作成する
次の例は、Meet のエクスポートを作成する方法を示しています。このリクエストは、指定した組織部門内のアカウントに関連付けられ、Meet の録画のパターンに従うファイル名を持つファイルをエクスポートします。
Python
def create_meet_export(service, matter_id, ou_to_search, export_name):
export = {
'name': export_name,
'query': {
'corpus': 'DRIVE',
'dataScope': 'ALL_DATA',
'searchMethod': 'ORG_UNIT',
'terms': 'title:"...-...-... \\(....-..-.. at ..:.. *\\)"',
'orgUnitInfo': {
'orgUnitId': 'id:'+ou_to_search
},
'driveOptions': {
'includeTeamDrives': True,
'includeSharedDrives': True
},
'timeZone': 'Etc/GMT',
'method': 'ORG_UNIT'
},
'exportOptions': {
'driveOptions': {},
'region': 'ANY'
},
}
return service.matters().exports().create(
matterId=matter_id, body=export).execute()
保存したクエリからエクスポートする
次の例は、保存したクエリからエクスポートを作成する方法を示しています。
Python
def create_mail_export_from_saved_query(service, matter_id, saved_query_id, export_name):
export = {
'name': export_name,
'exportOptions': {
'mailOptions': {
'exportFormat': 'PST',
'showConfidentialModeContent': True
},
'region': 'ANY'
}
}
export['query'] = service.matters().savedQueries().get(
savedQueryId=saved_query_id, matterId=matter_id).execute()['query']
return service.matters().exports().create(
matterId=matter_id, body=export).execute()
エクスポートを一覧表示する
次の例は、問題に関連付けられているエクスポートのリストを取得する方法を示しています。
Java
public class exports {
public ListExportsResponse listExports(Vault client, String matterId) {
return client.matters().exports().list(matterId).execute();
}
Python
def list_exports(service, matter_id):
return service.matters().exports().list(matterId=matter_id).execute()
エクスポートに関する情報を取得する
次の例は、特定のエクスポートに関する情報を取得する方法を示しています。注: エクスポートされたファイルとメッセージをダウンロードするには、Cloud APIs を使用します（次の例を参照）。
Java
public Export getExportById(Vault client, String matterId, String exportId) {
return client.matters().exports().get(matterId, exportId).execute();
}
Python
def get_export_by_id(service, matter_id, export_id):
return service.matters().exports().get(
matterId=matter_id, exportId=export_id).execute()
Google Cloud からエクスポートをダウンロードする
次の例は、完了したすべてのエクスポートを Google Cloud からダウンロードする方法を示しています。このリクエストでは、Vault API と Cloud API を使用します。
注: エクスポートをダウンロードするには、アカウントにエクスポートの管理権限と、共有された案件が必要です。
Python
def download_exports(service, matter_id):
"""Google Cloud storage service is authenticated by running
`gcloud auth application-default login` and expects a billing enabled project
in ENV variable `GOOGLE_CLOUD_PROJECT` """
gcpClient = storage.Client()
matter_id = os.environ['MATTERID']
for export in vaultService.matters().exports().list(
matterId=matter_id).execute()['exports']:
if 'cloudStorageSink' in export:
directory = export['name']
if not os.path.exists(directory):
os.makedirs(directory)
print(export['id'])
for sinkFile in export['cloudStorageSink']['files']:
filename = '%s/%s' % (directory, sinkFile['objectName'].split('/')[-1])
objectURI = 'gs://%s/%s' % (sinkFile['bucketName'],
sinkFile['objectName'])
print('get %s to %s' % (objectURI, filename))
gcpClient.download_blob_to_file(objectURI, open(filename, 'wb+'))
エクスポートを削除する
次の例は、エクスポートを削除する方法を示しています。
Java
public void deleteExportById(Vault client, String matterId, String exportId) {
client.matters().exports().delete(matterId, exportId).execute();
Python
def delete_export_by_id(service, matter_id, export_id):
return service.matters().exports().delete(
matterId=matter_id, exportId=export_id).execute()
検索の上限など、検索と書き出しに関するアプリ固有の情報については、Vault での検索と書き出しのスタートガイドをご覧ください。