رابط برنامهنویسی کاربردی Vault به شما امکان میدهد خروجیهای Vault را مدیریت کنید. شما میتوانید:
ایجاد خروجی - درخواستی به Vault ارسال کنید که پیامها یا فایلهایی را که با درخواست شما مطابقت دارند پیدا کرده و آنها را به Google Cloud خروجی دهد.
توجه:
- شما میتوانید تا 20 خروجی را همزمان در سراسر سازمان خود اجرا کنید. برای سریعتر کردن خروجیها، خروجیهای بزرگ را به خروجیهای کوچکتر تقسیم کنید. به عنوان مثال، دادهها را به جای همه به صورت یکجا، بر اساس ماه خروجی بگیرید. گزینه دیگر این است که موارد کمتری مانند کاربران، گروهها یا فضاهای چت را در هر خروجی بگنجانید.
- خروجیها به مدت ۱۵ روز پس از ایجاد در دسترس هستند و پس از آن حذف شده و دیگر قابل دسترسی نخواهند بود.
مثالها:
فهرست کردن خروجیها - وضعیت تمام خروجیهای مرتبط با یک موضوع را بازیابی میکند.
دریافت خروجیها - بازیابی اطلاعات مربوط به یک خروجی.
دانلود خروجیها — یک خروجی از Google Cloud دانلود کنید.
حذف اکسپورتها — اکسپورتها را از یک موضوع زمانی که دیگر نیازی به آنها نیست، حذف کنید.
قبل از اینکه شروع کنی
برای تنظیم کتابخانههای مورد نیاز و احراز هویت، از طریق راهنمای سریع زبان برنامهنویسی خود اقدام کنید.
برای کار با منابع Vault، حساب کاربری باید امتیازات لازم Vault و دسترسی به موضوع را داشته باشد. برای دسترسی به یک موضوع، حساب کاربری باید آن موضوع را ایجاد کرده باشد، موضوع را با آنها به اشتراک گذاشته باشد یا امتیاز مشاهده همه موضوعات را داشته باشد.
ایجاد خروجی جیمیل
مثال زیر نحوه ایجاد خروجی Gmail را نشان میدهد. این درخواست تمام پیامهای Gmail و Hangouts کلاسیک را که معیارهای زیر را دارند، خروجی میدهد:
- پیامهای متعلق به حسابهای
email1وemail2. - پیامهای پیشنویس را حذف میکند.
- پیامهای ارسال شده به
ceo@solarmora.com.
نکته: این مثالها از سیستم کلاسیک خروجی گرفتن جیمیل استفاده میکنند. برای خروجی گرفتن با استفاده از سیستم جدید ، در قسمت 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()
فهرست صادرات
مثال زیر نحوه بازیابی لیستی از export های مرتبط با یک موضوع را نشان میدهد.
جاوا
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()
دریافت اطلاعات در مورد صادرات
مثال زیر نحوه دریافت اطلاعات مربوط به یک خروجی خاص را نشان میدهد. توجه: برای دانلود فایلها و پیامهای خروجی گرفته شده، از 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 را نشان میدهد. این درخواست از 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+'))
حذف یک خروجی
مثال زیر نحوه حذف یک export را نشان میدهد.
جاوا
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 مراجعه کنید.