保管箱 API 可讓您管理保管箱匯出作業。您可以：
建立匯出作業：將要求傳送至保管箱，以便找出特定訊息或檔案 比對查詢，並將其匯出至 Google Cloud。
注意：您最多只能同時為貴機構執行 20 項匯出作業。如要提升效能，請將大型匯出作業拆分為多個小集合。舉例來說，您可以按月劃分匯出作業，不必一次匯出所有資料。另一個例子是在每次匯出作業中納入較少實體 (例如使用者和群組、聊天室等特殊實體)。
範例：
清單匯出項目：擷取所有相關聯匯出作業的狀態 與案件有關
取得匯出作業：擷取匯出作業的相關資訊。
下載匯出內容：從 Google Cloud 下載匯出項目。
刪除匯出項目：從案件中移除匯出項目 表示錯誤。
事前準備
如要設定必要的程式庫和驗證程序，請完成快速入門導覽課程 找出適合您的程式設計語言
如要使用保管箱資源，帳戶必須擁有必要的保管箱 權限並可存取 技術。如要存取案件，帳戶必須成功建立案件，並具備 與自己共用的案件，或是擁有「查看所有案件」權限。
建立 Gmail 匯出項目
以下範例說明如何建立 Gmail 匯出項目。匯出這項要求 符合下列條件的所有 Gmail 和傳統版 Hangouts 訊息：
- 由帳戶
email1和email2擁有的郵件。 - 排除草稿郵件。
- 傳送給
ceo@solarmora.com的訊息。
提示：以下範例使用傳統版 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: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();
}
Python
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 取得)。
是在指定值期間 times。
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 API (下個 範例)。
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 和 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()
如需搜尋與匯出應用程式相關資訊 (包括搜尋限制)，請參閱開始使用保管箱搜尋和匯出功能。