ניהול הייצוא

Vault API מאפשר לנהל את הייצוא מ-Vault. אפשר:

• יצירת פעולות ייצוא – שליחת בקשה ל-Vault כדי למצוא את ההודעות או הקבצים שתואמים לשאילתה שלכם ולייצא אותם ל-Google Cloud.

  הערה: לא ניתן לבצע יותר מ-20 פעולות ייצוא בו-זמנית בארגון. כדי לשפר את הביצועים, כדאי לפצל נתונים גדולים לקבוצות קטנות יותר. לדוגמה, אפשר לפצל את הייצוא לפי חודש במקום לייצא את הכול בבת אחת. דוגמה נוספת היא לכלול פחות ישויות (כמו משתמשים וישויות מיוחדות כמו קבוצות, מרחבים משותפים וכו') בכל ייצוא.

  דוגמאות:

  • הודעות מ-Gmail ומהגרסה הקלאסית של Hangouts
  • פריטים ב-Drive
  • הקלטות ב-Meet
  • ייצוא משאילתה שמורה

• רשימת פעולות ייצוא – אחזור הסטטוס של כל פעולות הייצוא שמשויכות לבקשת תמיכה.

• Get exports (קבלת פעולות ייצוא) – אחזור מידע על פעולת ייצוא.

• הורדת קובצי ייצוא – הורדת קובץ ייצוא מ-Google Cloud.

• מחיקת קובצי ייצוא – הסרה של קובצי ייצוא מפנייה כשאין בהם יותר צורך.

לפני שמתחילים

כדי להגדיר את הספריות ואת האימות הנדרשים, עליכם לעיין במדריך למתחילים בשפת התכנות שלכם.

כדי לעבוד עם משאבי Vault, לחשבון צריכות להיות ההרשאות הנדרשות ל-Vault וגישה לנושא. כדי לגשת לבקשת תמיכה, החשבון צריך ליצור אותה, היא צריכה להיות משותפת איתו או שיש לו את ההרשאה הצגת כל בקשות התמיכה.

יצירת ייצוא מ-Gmail

בדוגמה הבאה מוסבר איך יוצרים ייצוא של Gmail. הבקשה הזו מייצאת את כל ההודעות ב-Gmail ובגרסה הקלאסית של Hangouts שעומדות בקריטריונים הבאים:

• הודעות בבעלות החשבונות email1 ו-email2.
• לא כולל טיוטות של הודעות.
• הודעות שנשלחות אל [email protected].

טיפ: בדוגמאות האלה נעשה שימוש במערכת הייצוא הקלאסית של Gmail. כדי לייצא באמצעות מערכת הייצוא החדשה, צריך להגדיר את useNewExport כ-true ב-MailExportOptions.

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();
}

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()

יצירת ייצוא מ-Drive

בדוגמה הבאה מוסבר איך ליצור ייצוא מ-Drive. הבקשה הזו מייצאת את כל הקבצים, כולל קבצים בתיקיות אחסון שיתופי, שעומדים בקריטריונים הבאים:

• שייכות ליחידה הארגונית שצוינה (היחידה הזו מתקבלת באמצעות 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 את כל הייצוא שהושלם באותו עניין. הבקשה הזו משתמשת ב-Vault וב-Cloud APIs.

הערה: כדי להוריד קובץ ייצוא, צריך הרשאת ניהול ייצוא בחשבון, וגם שהנושא שותף עם החשבון.

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.