Kelola ekspor

Vault API memungkinkan Anda mengelola ekspor Vault. Anda dapat:

  • Buat ekspor—kirim permintaan ke Vault yang menemukan pesan atau file yang mencocokkan kueri Anda dan mengekspornya ke Google Cloud.

    Catatan: Anda tidak boleh memiliki lebih dari 20 ekspor yang sedang berlangsung di seluruh organisasi. Untuk meningkatkan performa, bagi ekspor besar menjadi kumpulan yang lebih kecil. Misalnya, pisahkan ekspor Anda berdasarkan bulan, bukan mengekspor semuanya sekaligus. Contoh lainnya adalah menyertakan lebih sedikit entitas (seperti pengguna dan entitas khusus seperti grup, ruang chat, dll.) dalam setiap ekspor.

    Contoh:

  • Daftar ekspor—ambil status semua ekspor yang terkait dengan suatu masalah.

  • Mendapatkan ekspor—ambil informasi tentang ekspor.

  • Mendownload ekspor—mendownload ekspor dari Google Cloud.

  • Menghapus ekspor—menghapus ekspor dari masalah saat ekspor tidak lagi diperlukan.

Sebelum memulai

Untuk menyiapkan library dan autentikasi yang diperlukan, pelajari panduan memulai untuk bahasa pemrograman Anda.

Untuk menggunakan resource Vault, akun harus memiliki Vault yang diperlukan hak istimewa dan akses ke itu penting. Untuk mengakses masalah, akun yang membuat masalah tersebut, memiliki kasus Anda dibagikan kepada mereka, atau memiliki hak istimewa Melihat Semua Masalah.

Membuat ekspor Gmail

Contoh berikut menunjukkan cara membuat ekspor Gmail. Permintaan ini mengekspor semua pesan Gmail dan Hangouts klasik yang memenuhi kriteria berikut:

  • pesan yang dimiliki oleh akun email1 dan email2.
  • tidak termasuk pesan draf.
  • pesan dikirim ke ceo@solarmora.com.

Tips: Contoh ini menggunakan sistem ekspor Gmail klasik. Untuk mengekspor menggunakan sistem ekspor baru, di MailExportOptions, setel useNewExport ke 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()

Membuat ekspor Drive

Contoh berikut menunjukkan cara membuat ekspor Drive. Permintaan ini mengekspor semua file, termasuk yang ada di drive bersama, yang memenuhi kriteria berikut:

  • milik unit organisasi yang ditentukan (diperoleh dengan Admin SDK).

  • dibuat di antara kolom yang ditentukan 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()

Membuat ekspor Meet

Contoh berikut menunjukkan cara membuat ekspor Meet. Permintaan ini mengekspor file yang terkait dengan akun di unit organisasi tertentu yang memiliki nama file yang mengikuti pola rekaman 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()

Mengekspor dari kueri tersimpan

Contoh berikut menunjukkan cara membuat ekspor dari kueri tersimpan.

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

Mencantumkan ekspor

Contoh berikut menunjukkan cara mengambil daftar ekspor yang terkait dengan suatu masalah.

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

Mendapatkan informasi tentang ekspor

Contoh berikut menunjukkan cara mendapatkan informasi tentang ekspor tertentu. Catatan: Untuk mendownload file dan pesan yang diekspor, gunakan Cloud API (pada langkah contoh).

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

Mendownload ekspor dari Google Cloud

Contoh berikut menunjukkan cara mendownload semua ekspor yang telah selesai dalam suatu masalah dari Google Cloud. Permintaan ini menggunakan Vault dan Cloud API.

Catatan: Untuk mendownload ekspor, akun memerlukan Mengelola hak istimewa Ekspor dan masalah yang dibagikan kepada mereka.

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+'))

Menghapus ekspor

Contoh berikut menunjukkan cara menghapus ekspor.

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

Untuk mengetahui informasi khusus aplikasi terkait penelusuran dan ekspor termasuk batas penelusuran, lihat Memulai penelusuran dan ekspor Vault.