REST Resource: matters.exports

Recurso: Export

Una exportació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, debe tenerlo compartido o debe tener el privilegio Ver todos los asuntos.

Representación JSON 
{
  "id": string,
  "matterId": string,
  "parentExportId": string,
  "name": string,
  "requester": {
    object (UserInfo)
  },
  "query": {
    object (Query)
  },
  "exportOptions": {
    object (ExportOptions)
  },
  "createTime": string,
  "status": enum (ExportStatus),
  "stats": {
    object (ExportStats)
  },

  "cloudStorageSink": {
    object (CloudStorageSink)
  }
}
Campos
id

string

Solo salida. Es el ID de exportación generado.
matterId

string

Solo salida. Es el ID del asunto.
parentExportId

string

Solo salida. Identifica la exportación principal que generó esta exportación secundaria. Este parámetro solo se configura en las exportaciones secundarias.
name

string

Es el nombre de la exportación. No uses caracteres especiales (~!$'(),;@:/?) en el nombre, ya que pueden impedir que descargues las exportaciones.
requester

object (UserInfo)

Solo salida. Es el solicitante de la exportación.
query

object (Query)

Son los parámetros de consulta que se usaron para crear la exportación.
exportOptions

object (ExportOptions)

Se agregaron opciones de exportación adicionales.
createTime

string (Timestamp format)

Solo salida. Es la fecha y hora en que se creó la exportación.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
status

enum (ExportStatus)

Solo salida. Es el estado de la exportación.
stats

object (ExportStats)

Solo salida. Son los detalles sobre el progreso y el tamaño de la exportación.
Campo de unión export_sink. Es el tipo de receptor de exportación. export_sink puede ser solo uno de los parámetros siguientes:
cloudStorageSink

object (CloudStorageSink)

Solo salida. Es el destino de los archivos de exportación en Cloud Storage.

UserInfo

Es la información del usuario.

Representación JSON 
{
  "email": string,
  "displayName": string
}
Campos
email

string

Es la dirección de correo electrónico del usuario.
displayName

string

Es el nombre visible del usuario.

ExportOptions

Opciones adicionales para las exportaciones

Representación JSON 
{
  "region": enum (ExportRegion),

  "mailOptions": {
    object (MailExportOptions)
  },
  "groupsOptions": {
    object (GroupsExportOptions)
  },
  "driveOptions": {
    object (DriveExportOptions)
  },
  "hangoutsChatOptions": {
    object (HangoutsChatExportOptions)
  },
  "voiceOptions": {
    object (VoiceExportOptions)
  },
  "calendarOptions": {
    object (CalendarExportOptions)
  },
  "geminiOptions": {
    object (GeminiExportOptions)
  }
}
Campos
region

enum (ExportRegion)

Es la región de datos solicitada para la exportación.
Campo de unión corpus_export_options. Son las opciones específicas del servicio para las exportaciones. corpus_export_options puede ser solo uno de los parámetros siguientes:
mailOptions

object (MailExportOptions)

Son las opciones para las exportaciones de Gmail.
groupsOptions

object (GroupsExportOptions)

Son las opciones para las exportaciones de grupos.
driveOptions

object (DriveExportOptions)

Son las opciones para las exportaciones de Drive.
hangoutsChatOptions

object (HangoutsChatExportOptions)

Son las opciones para exportar chats.
voiceOptions

object (VoiceExportOptions)

Son las opciones para las exportaciones de voz.
calendarOptions

object (CalendarExportOptions)

Opción disponible para la exportación del calendario.
geminiOptions

object (GeminiExportOptions)

Opción disponible para la exportación de Gemini.

MailExportOptions

Son las opciones para las exportaciones de Gmail.

Representación JSON 
{
  "exportFormat": enum (ExportFormat),
  "showConfidentialModeContent": boolean,
  "useNewExport": boolean,
  "exportLinkedDriveFiles": boolean
}
Campos
exportFormat

enum (ExportFormat)

Es el formato de archivo de los mensajes exportados.
showConfidentialModeContent

boolean

Para exportar contenido en modo confidencial, configúralo como true.
useNewExport

boolean

Se debe establecer en verdadero para usar el nuevo sistema de exportación.
exportLinkedDriveFiles

boolean

Opcional. Establece el valor en true para habilitar la exportación de archivos de Drive vinculados.

ExportFormat

Formato de exportación de mensajes

Enums
EXPORT_FORMAT_UNSPECIFIED No se especificó ningún formato de exportación.
MBOX Exporta como MBOX. Solo está disponible para Gmail, Grupos, Hangouts y Voice.
PST Exporta como PST. Solo está disponible para Gmail, Grupos, Hangouts, Voice y Calendario.
ICS Exporta el calendario como ICS. Solo está disponible para Calendario.
XML Exporta como XML. Solo está disponible para Gemini.

GroupsExportOptions

Son las opciones para las exportaciones de grupos.

Representación JSON 
{
  "exportFormat": enum (ExportFormat)
}
Campos
exportFormat

enum (ExportFormat)

Es el formato de archivo de los mensajes exportados.

DriveExportOptions

Son las opciones para las exportaciones de Drive.

Representación JSON 
{
  "includeAccessInfo": boolean
}
Campos
includeAccessInfo

boolean

Se debe establecer en verdadero para incluir información sobre el nivel de acceso de los usuarios con acceso indirecto a los archivos.

HangoutsChatExportOptions

Son las opciones para exportar chats.

Representación JSON 
{
  "exportFormat": enum (ExportFormat)
}
Campos
exportFormat

enum (ExportFormat)

Es el formato de archivo de los mensajes exportados.

VoiceExportOptions

Son las opciones para las exportaciones de voz.

Representación JSON 
{
  "exportFormat": enum (ExportFormat)
}
Campos
exportFormat

enum (ExportFormat)

Es el formato de archivo de los mensajes de texto exportados.

CalendarExportOptions

Son las opciones para exportar calendarios.

Representación JSON 
{
  "exportFormat": enum (ExportFormat)
}
Campos
exportFormat

enum (ExportFormat)

Es el formato de archivo de los mensajes de texto exportados.

GeminiExportOptions

Son las opciones para las exportaciones de Gemini.

Representación JSON 
{
  "exportFormat": enum (ExportFormat)
}
Campos
exportFormat

enum (ExportFormat)

Es el formato de archivo de los mensajes exportados.

ExportRegion

Es la región de datos para la exportación.

Enums
EXPORT_REGION_UNSPECIFIED No se especificó la región. El valor predeterminado es ANY.
ANY Cualquier región
US Región de Estados Unidos.
EUROPE Región de Europa.

ExportStatus

Es el estado de la exportación.

Enums
EXPORT_STATUS_UNSPECIFIED El estado no está especificado.
COMPLETED Se completó la exportación.
FAILED No se pudo realizar la exportación.
IN_PROGRESS La exportación está en curso.

ExportStats

Es información sobre el progreso de una exportación.

Representación JSON 
{
  "exportedArtifactCount": string,
  "totalArtifactCount": string,
  "sizeInBytes": string
}
Campos
exportedArtifactCount

string (int64 format)

Es la cantidad de mensajes o archivos que ya se procesaron para la exportación.
totalArtifactCount

string (int64 format)

Cantidad de mensajes o archivos que se exportarán.
sizeInBytes

string (int64 format)

Tamaño de la exportación en bytes.

CloudStorageSink

Es el receptor de exportación para los archivos de Cloud Storage.

Representación JSON 
{
  "files": [
    {
      object (CloudStorageFile)
    }
  ]
}
Campos
files[]

object (CloudStorageFile)

Solo salida. Son los archivos exportados en Cloud Storage.

CloudStorageFile

El archivo de exportación en Cloud Storage

Representación JSON 
{
  "bucketName": string,
  "objectName": string,
  "size": string,
  "md5Hash": string
}
Campos
bucketName

string

Es el nombre del bucket de Cloud Storage para el archivo de exportación. Puedes usar este valor en la API de JSON o la API de XML de Cloud Storage, pero no para enumerar el contenido del bucket. En cambio, puedes obtener archivos de exportación individuales por nombre de objeto.
objectName

string

Nombre del objeto de Cloud Storage para el archivo de exportación. Puedes usar este valor en la API de JSON o la API de XML de Cloud Storage.
size

string (int64 format)

Tamaño del archivo de exportación.
md5Hash

string

Es el hash MD5 del archivo.

Métodos

create

 Crea una exportación.

delete

 Borra una exportación.

get

 Obtiene una exportación.

list

 Enumera los detalles sobre las exportaciones en el asunto especificado.