REST Resource: matters.exports

Recurso: exportação

Uma exportação.

Para trabalhar com recursos do Vault, a conta precisa ter os privilégios necessários do Vault e acesso ao caso. Para acessar um caso, a conta precisa ter criado o caso, ter o caso compartilhado com ela ou ter o privilégio Ver todos os casos.

Representação 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

Apenas saída. O ID de exportação gerado.
matterId

string

Apenas saída. O ID do caso.
parentExportId

string

Apenas saída. Identifica a exportação mãe que gerou essa exportação filha. Isso é definido apenas em exportações filhas.
name

string

O nome da exportação. Não use caracteres especiais (~!$'(),;@:/?) porque eles podem impedir o download das exportações.
requester

object (UserInfo)

Apenas saída. O requerente da exportação.
query

object (Query)

Os parâmetros de consulta usados para criar a exportação.
exportOptions

object (ExportOptions)

Outras opções de exportação.
createTime

string (Timestamp format)

Apenas saída. A hora em que a exportação foi criada.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
status

enum (ExportStatus)

Apenas saída. O status da exportação.
stats

object (ExportStats)

Apenas saída. Detalhes sobre o progresso e o tamanho da exportação.
Tipo de coletor de exportação. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
cloudStorageSink

object (CloudStorageSink)

Apenas saída. O coletor para arquivos de exportação no Cloud Storage.
Fim dos campos mutuamente exclusivos.

UserInfo

Informações do usuário.

Representação JSON 
{
  "email": string,
  "displayName": string
}
Campos
email

string

O endereço de e-mail do usuário.
displayName

string

O nome de exibição do usuário.

ExportOptions

Outras opções de exportação

Representação 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)
  },
  "geminiInWorkspaceOptions": {
    object (GeminiInWorkspaceExportOptions)
  }
}
Campos
region

enum (ExportRegion)

A região de dados solicitada para a exportação.
Opções de exportação específicas do serviço. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
mailOptions

object (MailExportOptions)

Opções para exportações do Gmail.
groupsOptions

object (GroupsExportOptions)

Opções para exportações de grupos.
driveOptions

object (DriveExportOptions)

Opções para exportações do Drive.
hangoutsChatOptions

object (HangoutsChatExportOptions)

Opções para exportações do Chat.
voiceOptions

object (VoiceExportOptions)

Opções para exportações do Voice.
calendarOptions

object (CalendarExportOptions)

Opção disponível para exportação do Agenda.
geminiOptions

object (GeminiExportOptions)

Opção disponível para exportação do app do Gemini.
geminiInWorkspaceOptions

object (GeminiInWorkspaceExportOptions)

Opção disponível para exportação do Gemini no Workspace.
Fim dos campos mutuamente exclusivos.

MailExportOptions

Opções para exportações do Gmail.

Representação JSON 
{
  "exportFormat": enum (ExportFormat),
  "showConfidentialModeContent": boolean,
  "useNewExport": boolean,
  "exportLinkedDriveFiles": boolean
}
Campos
exportFormat

enum (ExportFormat)

O formato do arquivo das mensagens exportadas.
showConfidentialModeContent

boolean

Para exportar conteúdo do modo confidencial, defina como true.
useNewExport

boolean

Para usar o novo sistema de exportação, defina como true.
exportLinkedDriveFiles

boolean

Opcional. Para ativar a exportação de arquivos do Drive vinculados, defina como true.

ExportFormat

Formato de exportação para mensagens

Tipos enumerados
EXPORT_FORMAT_UNSPECIFIED Nenhum formato de exportação especificado.
MBOX Exportar como MBOX. Disponível apenas para o Gmail, Grupos, Hangouts e Voice.
PST Exportar como PST. Disponível apenas para o Gmail, Grupos, Hangouts, Voice e Agenda.
ICS Exportar como ICS. Disponível apenas para o Agenda.
XML Exportar como XML. Disponível apenas para o app do Gemini.
JSON Exportar como JSON. Disponível apenas para o Gemini no Workspace.

GroupsExportOptions

Opções para exportações de grupos.

Representação JSON 
{
  "exportFormat": enum (ExportFormat)
}
Campos
exportFormat

enum (ExportFormat)

O formato do arquivo das mensagens exportadas.

DriveExportOptions

Opções para exportações do Drive.

Representação JSON 
{
  "includeAccessInfo": boolean
}
Campos
includeAccessInfo

boolean

Para incluir informações de nível de acesso para usuários com acesso indireto a arquivos, defina como true.

HangoutsChatExportOptions

Opções para exportações do Chat.

Representação JSON 
{
  "exportFormat": enum (ExportFormat)
}
Campos
exportFormat

enum (ExportFormat)

O formato do arquivo das mensagens exportadas.

VoiceExportOptions

As opções para exportações do Voice.

Representação JSON 
{
  "exportFormat": enum (ExportFormat)
}
Campos
exportFormat

enum (ExportFormat)

O formato do arquivo das mensagens de texto exportadas.

CalendarExportOptions

As opções para exportações do Agenda.

Representação JSON 
{
  "exportFormat": enum (ExportFormat)
}
Campos
exportFormat

enum (ExportFormat)

O formato do arquivo das mensagens de texto exportadas.

GeminiExportOptions

As opções de exportação do app do Gemini.

Representação JSON 
{
  "exportFormat": enum (ExportFormat)
}
Campos
exportFormat

enum (ExportFormat)

O formato do arquivo das mensagens exportadas.

GeminiInWorkspaceExportOptions

As opções para exportações do Gemini no Workspace.

Representação JSON 
{
  "exportFormat": enum (ExportFormat)
}
Campos
exportFormat

enum (ExportFormat)

O formato do arquivo das mensagens exportadas.

ExportRegion

A região de dados da exportação.

Tipos enumerados
EXPORT_REGION_UNSPECIFIED A região não foi especificada. O padrão é ANY.
ANY Qualquer região.
US Região dos Estados Unidos.
EUROPE Região da Europa.

ExportStatus

O status da exportação.

Tipos enumerados
EXPORT_STATUS_UNSPECIFIED O status não foi especificado.
COMPLETED A exportação foi concluída.
FAILED Falha na exportação.
IN_PROGRESS A exportação está em andamento.

ExportStats

Informações de progresso de uma exportação.

Representação JSON 
{
  "exportedArtifactCount": string,
  "totalArtifactCount": string,
  "sizeInBytes": string
}
Campos
exportedArtifactCount

string (int64 format)

O número de mensagens ou arquivos já processados para exportação.
totalArtifactCount

string (int64 format)

O número de mensagens ou arquivos a serem exportados.
sizeInBytes

string (int64 format)

O tamanho da exportação em bytes.

CloudStorageSink

Coletor de exportação para arquivos do Cloud Storage.

Representação JSON 
{
  "files": [
    {
      object (CloudStorageFile)
    }
  ]
}
Campos
files[]

object (CloudStorageFile)

Apenas saída. Os arquivos exportados no Cloud Storage.

CloudStorageFile

O arquivo de exportação no Cloud Storage

Representação JSON 
{
  "bucketName": string,
  "objectName": string,
  "size": string,
  "md5Hash": string
}
Campos
bucketName

string

O nome do bucket do Cloud Storage para o arquivo de exportação. É possível usar esse valor na API JSON ou na API XML do Cloud Storage, mas não para listar o conteúdo do bucket. Em vez disso, é possível receber arquivos de exportação individuais pelo nome do objeto.
objectName

string

O nome do objeto do Cloud Storage para o arquivo de exportação. Use esse valor na API JSON ou na API XML do Cloud Storage.
size

string (int64 format)

O tamanho do arquivo de exportação.
md5Hash

string

O hash md5 do arquivo.

Métodos

create

 Cria uma exportação.

delete

 Exclui uma exportação.

get

 Recebe uma exportação.

list

 Lista detalhes sobre as exportações no caso especificado.