L'API Vault vous permet de gérer les exportations Vault. Vous pouvez :
Créer des exportations : envoyez une requête à Vault pour rechercher les messages ou fichiers correspondant à votre requête et les exporter vers Google Cloud.
Remarque:Vous ne pouvez pas autoriser plus de 20 exportations en cours dans votre organisation. Pour améliorer les performances, divisez les exportations volumineuses en ensembles plus petits. Par exemple, divisez votre exportation par mois au lieu de tout exporter en même temps. Vous pouvez également inclure moins d'entités (utilisateurs et entités spéciales telles que des groupes, des espaces de discussion, etc.) dans chaque exportation.
Exemples :
List exports (Liste des exportations) : permet de récupérer l'état de toutes les exportations associées à un litige.
Get exports (Obtenir des exportations) : permet de récupérer des informations sur une exportation.
Télécharger des exports : téléchargez une export depuis Google Cloud.
Supprimer les exportations : supprimez les exportations d'un litige lorsqu'elles ne sont plus nécessaires.
Avant de commencer
Pour configurer les bibliothèques et l'authentification requises, suivez la procédure de démarrage rapide pour votre langage de programmation.
Pour utiliser les ressources Vault, le compte doit disposer des droits Vault requis et avoir accès à l'objet. Pour accéder à un litige, le compte doit l'avoir créé, l'avoir partagé avec lui ou disposer du droit Afficher tous les litiges.
Créer une exportation Gmail
L'exemple suivant montre comment créer une exportation Gmail. Cette requête exporte tous les messages Gmail et de la version classique de Hangouts qui répondent aux critères suivants:
- messages appartenant aux comptes
email1etemail2; - exclut les brouillons.
- messages envoyés à
ceo@solarmora.com.
Remarque:Ces exemples utilisent le système d'exportation classique de Gmail. Pour exporter à l'aide du nouveau système d'exportation, dans MailExportOptions, définissez useNewExport sur "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()
Créer une exportation Drive
L'exemple suivant montre comment créer une exportation Drive. Cette requête exporte tous les fichiers, y compris ceux des Drive partagés, qui répondent aux critères suivants:
- appartiennent à l'unité organisationnelle spécifiée (obtenue avec le SDK Admin).
ont été créées entre les heures spécifiées.
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()
Créer une exportation Meet
L'exemple suivant montre comment créer une export de Meet. Cette requête exporte les fichiers associés aux comptes de l'unité organisationnelle spécifiée dont le nom de fichier suit le format des enregistrements 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()
Exporter à partir d'une requête enregistrée
L'exemple suivant montre comment créer une exportation à partir d'une requête enregistrée.
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()
Lister les exportations
L'exemple suivant montre comment récupérer la liste des exportations associées à un litige.
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()
Obtenir des informations sur une exportation
L'exemple suivant montre comment obtenir des informations sur une exportation spécifique. Remarque: Pour télécharger les fichiers et les messages exportés, vous devez utiliser les API Cloud (dans l'exemple suivant).
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()
Télécharger une exportation depuis Google Cloud
L'exemple suivant montre comment télécharger toutes les exportations terminées en une seule fois depuis Google Cloud. Cette requête utilise les API Vault et Cloud.
Remarque:Pour télécharger une exportation, un compte doit disposer du droit "Gérer les exportations" et du litige partagé avec lui.
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+'))
Supprimer une exportation
L'exemple suivant montre comment supprimer une exportation.
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()
Pour en savoir plus sur la recherche et l'exportation, y compris les limites de recherche, consultez Premiers pas avec la recherche et l'exportation Vault.