Vault API ช่วยให้คุณจัดการการส่งออกของห้องนิรภัยได้ ดังนี้
สร้างการส่งออก - ส่งคำขอไปยังห้องนิรภัยซึ่งค้นหาข้อความหรือไฟล์ที่ จับคู่คำค้นหาและส่งออกไปยัง Google Cloud
หมายเหตุ: คุณสามารถส่งออกได้ไม่เกิน 20 รายการอยู่ระหว่างดำเนินการทั่วทั้งองค์กร แบ่งการส่งออกขนาดใหญ่ออกเป็นชุดย่อยเพื่อปรับปรุงประสิทธิภาพ เช่น แยกการส่งออกตามเดือนแทนการส่งออกทั้งหมดในครั้งเดียว อีกตัวอย่างหนึ่งคือการรวมเอนทิตีให้น้อยลง (เช่น ผู้ใช้และเอนทิตีพิเศษ เช่น กลุ่ม พื้นที่ใน Chat ฯลฯ) ในการส่งออกแต่ละครั้ง
ตัวอย่าง
การส่งออกรายการ - ดึงข้อมูลสถานะของการส่งออกทั้งหมดที่เกี่ยวข้อง ในเรื่อง
รับการส่งออก - ดึงข้อมูลเกี่ยวกับการส่งออก
ดาวน์โหลดการส่งออก - ดาวน์โหลดการส่งออกจาก Google Cloud
ลบการส่งออก - นำการส่งออกออกจากกรณี ที่ไม่จำเป็นอีกต่อไป
ก่อนเริ่มต้น
หากต้องการตั้งค่าไลบรารีและการตรวจสอบสิทธิ์ที่จำเป็น โปรดดูการเริ่มต้นอย่างรวดเร็ว สำหรับภาษาโปรแกรมของคุณด้วย
ในการใช้งานทรัพยากรของห้องนิรภัย บัญชีจะต้องมีห้องนิรภัยที่จำเป็น สิทธิ์และสิทธิ์เข้าถึง เป็นสิ่งสำคัญ ในการเข้าถึงกรณี บัญชีจะต้องสร้างกรณีไว้แล้ว มี แชร์กับบุคคลเหล่านี้ หรือมีสิทธิ์ดูกรณีทั้งหมด
สร้างการส่งออก Gmail
ตัวอย่างต่อไปนี้แสดงวิธีสร้างการส่งออก Gmail การส่งออกคำขอนี้ ข้อความทั้งหมดใน Gmail และ Hangouts แบบคลาสสิกที่ตรงกับเกณฑ์ต่อไปนี้
- ข้อความที่เป็นของบัญชี
email1
และemail2
- ไม่รวมข้อความร่าง
- ส่งข้อความถึง
[email protected]
แล้ว
เคล็ดลับ: ตัวอย่างเหล่านี้ใช้ระบบการส่งออกของ Gmail แบบคลาสสิก หากต้องการส่งออกโดยใช้
ระบบส่งออกใหม่
ใน MailExportOptions
ตั้งค่า useNewExport
เป็น "จริง"
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)
สร้างขึ้นระหว่าง 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 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 และ Cloud APIs
หมายเหตุ: บัญชีต้องมีสิ่งต่อไปนี้จึงจะดาวน์โหลดการส่งออกได้ จัดการสิทธิ์การส่งออก และ แชร์กับพวกเขา
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()
โปรดดูข้อมูลเฉพาะแอปเกี่ยวกับการค้นหาและการส่งออก รวมถึงขีดจำกัดการค้นหาที่หัวข้อเริ่มต้นใช้งานการค้นหาและการส่งออกของห้องนิรภัย