API Vault позволяет управлять экспортом Vault. Ты можешь:
Создайте экспорт — отправьте запрос в Vault, который найдет сообщения или файлы, соответствующие вашему запросу, и экспортирует их в Google Cloud.
Примечание. В вашей организации может выполняться не более 20 экспортов. Чтобы повысить производительность, разбейте крупные экспортированные данные на более мелкие наборы. Например, разделите экспорт по месяцам вместо того, чтобы экспортировать все сразу. Другой пример — включать в каждый экспорт меньше объектов (например, пользователей и специальных объектов, таких как группы, пространство чата и т. д.).
Примеры:
Список экспортов — получение статуса всех экспортов, связанных с делом.
Получить экспорт — получить информацию об экспорте.
Загрузить экспорт — загрузить экспорт из Google Cloud.
Удалить экспорт — удалить экспорт из дела, когда он больше не нужен.
Прежде чем вы начнете
Чтобы настроить необходимые библиотеки и аутентификацию, ознакомьтесь с кратким руководством для вашего языка программирования.
Для работы с ресурсами Сейфа у учетной записи должны быть необходимые права Сейфа и доступ к делу. Чтобы получить доступ к делу, учетная запись должна создать дело, предоставить доступ к делу или иметь право просмотра всех дел .
Создайте экспорт Gmail
В следующем примере показано, как создать экспорт Gmail. Этот запрос экспортирует все сообщения Gmail и классической версии Hangouts, соответствующие следующим критериям:
- сообщения, принадлежащие учетным записям
email1иemail2. - исключает черновики сообщений.
- сообщения отправляются на адрес
ceo@solarmora.com.
Совет. В этих примерах используется классическая система экспорта Gmail. Чтобы экспортировать с использованием новой системы экспорта , в MailExportOptions установите для useNewExport значение true.
Джава
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:ceo@solarmora.com";
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();
}
Питон
def create_mail_account_held_data_export(service, matter_id):
emails_to_search = ['email1', 'email2']
mail_query_options = {'excludeDrafts': True}
query_terms = 'to:ceo@solarmora.com'
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).
были созданы между указанными моментами .
Джава
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();
}
Питон
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.
Питон
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()
Экспорт из сохраненного запроса
В следующем примере показано, как создать экспорт из сохраненного запроса.
Питон
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()
Список экспорта
В следующем примере показано, как получить список экспорта, связанного с делом.
Джава
public class exports {
public ListExportsResponse listExports(Vault client, String matterId) {
return client.matters().exports().list(matterId).execute();
}
Питон
def list_exports(service, matter_id):
return service.matters().exports().list(matterId=matter_id).execute()
Получить информацию об экспорте
В следующем примере показано, как получить информацию о конкретном экспорте. Примечание. Чтобы загрузить экспортированные файлы и сообщения, вы используете Cloud API (в следующем примере).
Джава
public Export getExportById(Vault client, String matterId, String exportId) {
return client.matters().exports().get(matterId, exportId).execute();
}
Питон
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. В этом запросе используются API-интерфейсы Vault и Cloud.
Примечание. Чтобы загрузить экспорт, учетной записи необходимы полномочия на управление экспортом и доступ к делу.
Питон
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+'))
Удаление экспорта
В следующем примере показано, как удалить экспорт.
Джава
public void deleteExportById(Vault client, String matterId, String exportId) {
client.matters().exports().delete(matterId, exportId).execute();
Питон
def delete_export_by_id(service, matter_id, export_id):
return service.matters().exports().delete(
matterId=matter_id, exportId=export_id).execute()
Информацию о поиске и экспорте для конкретного приложения, включая ограничения поиска, см. в разделе Начало работы с поиском и экспортом в Vault .