Google Vault API מאפשר לכם לנהל ייצואים של Google Vault. אפשר לבצע את המשימות הבאות:
יצירת ייצואים. שולחים בקשה ל-Vault כדי למצוא את ההודעות או הקבצים שתואמים לשאילתה ולייצא אותם ל-Google Cloud.
באפשרותכם להריץ עד 20 ייצואים בו-זמנית בארגון. כדי לייצא מהר יותר, כדאי לחלק ייצוא גדול לייצוא קטן יותר. לדוגמה, אפשר לייצא את הנתונים לפי חודש במקום לייצא את כולם בבת אחת. אפשרות נוספת היא לכלול פחות פריטים בכל ייצוא, כמו משתמשים, קבוצות או מרחבים ב-Chat. קובצי הייצוא זמינים למשך 15 יום אחרי היצירה שלהם. אחרי פרק הזמן הזה, הם נמחקים ולא ניתן לגשת אליהם יותר.
בדוגמאות הבאות אפשר לראות איך ליצור ייצוא לשירותים שונים:
הצגת רשימה של פעולות ייצוא. אחזור הסטטוס של כל הייצוא שמשויך לנושא.
איך מייצאים נתונים אחזור מידע על ייצוא.
הורדת קבצים לייצוא הורדת ייצוא מ-Google Cloud.
מחיקת אירועי ייצוא הסרה של קובצי ייצוא מתיק כשאין בהם יותר צורך.
לפני שמתחילים
כדי להגדיר את הספריות הנדרשות ואת האימות, צריך לעבור על המדריך לתחילת העבודה שמתאים לשפת התכנות שלכם.
כדי לעבוד עם משאבים ב-Vault, לחשבון צריכות להיות הרשאות Vault הנדרשות וגישה לנושא. כדי לגשת לתיק, החשבון צריך ליצור את התיק, לקבל שיתוף של התיק או לקבל את ההרשאה View All Matters.
יצירת ייצוא של Gmail
בדוגמה הבאה אפשר לראות איך ליצור ייצוא של Gmail. בבקשה הזו מיוצאות כל ההודעות ב-Gmail ובגרסה הקלאסית של Hangouts שעומדות בקריטריונים הבאים:
- הודעות בבעלות החשבונות
email1ו-email2. - לא כולל טיוטות של הודעות.
- הודעות שנשלחו אל
ceo@solarmora.com.
בדוגמאות האלה אנחנו משתמשים במערכת הייצוא הקלאסית של Gmail. כדי לייצא באמצעות מערכת הייצוא החדשה, צריך להגדיר את useNewExport כ-true ב-MailExportOptions.
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()
בייצוא מ-Gmail, העיבוד של ייצוא בפורמט MBOX מהיר יותר מהעיבוד של ייצוא בפורמט PST.
יצירת ייצוא מ-Drive
בדוגמה הבאה אפשר לראות איך יוצרים ייצוא של Drive. במסגרת הבקשה הזו, כל הקבצים מיוצאים, כולל הקבצים בתיקיות אחסון שיתופי, שעומדים בקריטריונים הבאים:
- שייכים ליחידה הארגונית שצוינה (מתקבלת באמצעות 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 ובממשקי 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.