Administrar exportaciones

La API de Vault te permite administrar las exportaciones de Vault. Puedes hacer lo siguiente:

• Crear exportaciones: Envía una solicitud a Vault para que encuentre los mensajes o archivos que coincidan con tu búsqueda y los exporte a Google Cloud.

  Nota: No puedes tener más de 20 exportaciones en curso en tu organización. Para mejorar el rendimiento, divide las exportaciones grandes en conjuntos más pequeños. Por ejemplo, divide la exportación por mes en lugar de exportar todo de una vez. Otro ejemplo es incluir menos entidades (como usuarios y entidades especiales, como grupos, espacios de chat, etcétera) en cada exportación.

  Ejemplos:

  • Mensajes de Gmail y de la versión clásica de Hangouts
  • Elementos de Drive
  • Grabaciones de Meet
  • Cómo exportar desde una consulta guardada

• Lista de exportaciones: Recupera el estado de todas las exportaciones asociadas con un asunto.

• Obtener exportaciones: Recupera información sobre una exportación.

• Descargar exportaciones: Descarga una exportación de Google Cloud.

• Borrar exportaciones: Quita las exportaciones de un asunto cuando ya no sean necesarias.

Antes de comenzar

Para configurar las bibliotecas y la autenticación requeridas, consulta la guía de inicio rápido para tu lenguaje de programación.

Para trabajar con los recursos de Vault, la cuenta debe tener los privilegios de Vault necesarios y acceso al asunto. Para acceder a un asunto, la cuenta debe haberlo creado, compartirlo con ella o tener el privilegio Ver todos los asuntos.

Cómo crear una exportación de Gmail

En el siguiente ejemplo, se muestra cómo crear una exportación de Gmail. Esta solicitud exporta todos los mensajes de Gmail y de la versión clásica de Hangouts que cumplan con los siguientes criterios:

• mensajes de las cuentas email1 y email2.
• No incluye los borradores de mensajes.
• mensajes enviados a [email protected].

Nota: En estos ejemplos, se usa el sistema de exportación clásico de Gmail. Para exportar con el nuevo sistema de exportación, en MailExportOptions, establece useNewExport como verdadero.

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

Crea una exportación de Drive

En el siguiente ejemplo, se muestra cómo crear una exportación de Drive. Esta solicitud exporta todos los archivos, incluidos los de unidades compartidas, que cumplan con los siguientes criterios:

• Pertenece a la unidad organizativa especificada (obtenida con el SDK de Admin).

• se crearon entre los momentos especificados.

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

Crea una exportación de Meet

En el siguiente ejemplo, se muestra cómo crear una exportación de Meet. Esta solicitud exporta archivos asociados con cuentas en la unidad organizativa especificada que tienen un nombre de archivo que sigue el patrón de las grabaciones de 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()

Cómo exportar desde una consulta guardada

En el siguiente ejemplo, se muestra cómo crear una exportación a partir de una consulta guardada.

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

Cómo enumerar exportaciones

En el siguiente ejemplo, se muestra cómo recuperar una lista de exportaciones asociadas con un asunto.

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

Obtén información sobre una exportación

En el siguiente ejemplo, se muestra cómo obtener información sobre una exportación específica. Nota: Para descargar archivos y mensajes exportados, usa las APIs de Cloud (en el siguiente ejemplo).

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

Cómo descargar una exportación de Google Cloud

En el siguiente ejemplo, se muestra cómo descargar todas las exportaciones completadas en un asunto de Google Cloud. Esta solicitud usa las APIs de Vault y Cloud.

Nota: Para descargar una exportación, una cuenta necesita el privilegio Administrar exportaciones y que se le comparta el asunto.

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

Cómo borrar una exportación

En el siguiente ejemplo, se muestra cómo borrar una exportación.

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

Para obtener información específica de la app sobre la búsqueda y la exportación, incluidos los límites de búsqueda, consulta Comienza a usar la búsqueda y la exportación de Vault.