REST Resource: matters.exports

Ressource: Export

Une exportation.

Pour utiliser les ressources Vault, le compte doit disposer des droits Vault requis et d'un accès au litige. Pour pouvoir accéder à un litige, le compte doit l'avoir créé, le partager avec lui ou disposer du droit Afficher tous les litiges.

Représentation 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)
  }
}
Champs
id

string

Uniquement en sortie. ID d'exportation généré.
matterId

string

Uniquement en sortie. ID du litige.
parentExportId

string

Uniquement en sortie. Identifie l'exportation parente ayant généré cette exportation enfant. Ce paramètre n'est défini que pour les exportations enfants.
name

string

Nom de l'exportation. N'utilisez pas de caractères spéciaux (~!$'(),;@:/?) dans le nom, car cela pourrait vous empêcher de télécharger des exportations.
requester

object (UserInfo)

Uniquement en sortie. Demandeur de l'exportation.
query

object (Query)

Paramètres de requête utilisés pour créer l'exportation.
exportOptions

object (ExportOptions)

Options d'exportation supplémentaires.
createTime

string (Timestamp format)

Uniquement en sortie. Date et heure de création de l'exportation.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
status

enum (ExportStatus)

Uniquement en sortie. État de l'exportation.
stats

object (ExportStats)

Uniquement en sortie. Détails sur la progression et la taille de l'exportation.
cloudStorageSink

object (CloudStorageSink)

Uniquement en sortie. Récepteur pour l'exportation de fichiers dans Cloud Storage.

UserInfo

Informations sur l'utilisateur.

Représentation JSON 
{
  "email": string,
  "displayName": string
}
Champs
email

string

Adresse e-mail de l'utilisateur.
displayName

string

Nom de l'utilisateur à afficher.

ExportOptions

Options supplémentaires pour les exportations

Représentation JSON 
{
  "region": enum (ExportRegion),

  // Union field corpus_export_options can be only one of the following:
  "mailOptions": {
    object (MailExportOptions)
  },
  "groupsOptions": {
    object (GroupsExportOptions)
  },
  "driveOptions": {
    object (DriveExportOptions)
  },
  "hangoutsChatOptions": {
    object (HangoutsChatExportOptions)
  },
  "voiceOptions": {
    object (VoiceExportOptions)
  },
  "calendarOptions": {
    object (CalendarExportOptions)
  }
  // End of list of possible types for union field corpus_export_options.
}
Champs
region

enum (ExportRegion)

Région de données demandée pour l'exportation.
Champ d'union corpus_export_options. Options spécifiques au service pour les exportations corpus_export_options ne peut être qu'un des éléments suivants :
mailOptions

object (MailExportOptions)

Options pour les exportations Gmail
groupsOptions

object (GroupsExportOptions)

Options pour les exportations Groupes
driveOptions

object (DriveExportOptions)

Options pour les exportations Drive.
hangoutsChatOptions

object (HangoutsChatExportOptions)

Options pour les exportations Chat
voiceOptions

object (VoiceExportOptions)

Options pour les exportations Voice.
calendarOptions

object (CalendarExportOptions)

Option disponible pour l'exportation d'agenda.

MailExportOptions

Options pour les exportations Gmail

Représentation JSON 
{
  "exportFormat": enum (ExportFormat),
  "showConfidentialModeContent": boolean,
  "useNewExport": boolean,
  "exportLinkedDriveFiles": boolean
}
Champs
exportFormat

enum (ExportFormat)

Format de fichier des messages exportés.
showConfidentialModeContent

boolean

Pour exporter du contenu en mode confidentiel, définissez la valeur sur true.
useNewExport

boolean

Pour utiliser le nouveau système d'exportation, définissez la valeur sur true.
exportLinkedDriveFiles

boolean

Facultatif. Pour activer l'exportation des fichiers Drive associés, définissez la valeur sur true.

ExportFormat

Format d'exportation des messages

Enums
EXPORT_FORMAT_UNSPECIFIED Aucun format d'exportation spécifié.
MBOX Exportez au format MBOX. Disponible uniquement pour Gmail, Groupes, Hangouts et Voice.
PST Exporter au format PST Disponible uniquement pour Gmail, Groupes, Hangouts, Voice et Agenda.
ICS Exporter au format ICS Disponible uniquement pour Agenda.

GroupsExportOptions

Options pour les exportations Groupes

Représentation JSON 
{
  "exportFormat": enum (ExportFormat)
}
Champs
exportFormat

enum (ExportFormat)

Format de fichier des messages exportés.

DriveExportOptions

Options pour les exportations Drive.

Représentation JSON 
{
  "includeAccessInfo": boolean
}
Champs
includeAccessInfo

boolean

Pour inclure des informations de niveau d'accès pour les utilisateurs disposant d'un accès indirect aux fichiers, définissez la valeur sur true.

HangoutsChatExportOptions

Options pour les exportations Chat

Représentation JSON 
{
  "exportFormat": enum (ExportFormat)
}
Champs
exportFormat

enum (ExportFormat)

Format de fichier des messages exportés.

VoiceExportOptions

Options d'exportation Voice.

Représentation JSON 
{
  "exportFormat": enum (ExportFormat)
}
Champs
exportFormat

enum (ExportFormat)

Format de fichier des SMS exportés.

CalendarExportOptions

Options pour les exportations d'agendas.

Représentation JSON 
{
  "exportFormat": enum (ExportFormat)
}
Champs
exportFormat

enum (ExportFormat)

Format de fichier des SMS exportés.

ExportRegion

Région des données pour l'exportation.

Enums
EXPORT_REGION_UNSPECIFIED La région n'est pas spécifiée. La valeur par défaut est TOUS.
ANY N'importe quelle région
US États-Unis.
EUROPE dans la région "Europe".

ExportStatus

État de l'exportation.

Enums
EXPORT_STATUS_UNSPECIFIED L'état n'est pas spécifié.
COMPLETED Exportation terminée.
FAILED Échec de l'exportation.
IN_PROGRESS L'exportation est en cours.

ExportStats

Informations sur la progression d'une exportation.

Représentation JSON 
{
  "exportedArtifactCount": string,
  "totalArtifactCount": string,
  "sizeInBytes": string
}
Champs
exportedArtifactCount

string (int64 format)

Nombre de messages ou de fichiers déjà traités pour l'exportation.
totalArtifactCount

string (int64 format)

Nombre de messages ou de fichiers à exporter.
sizeInBytes

string (int64 format)

Taille de l'exportation en octets.

CloudStorageSink

Récepteur d'exportations pour les fichiers Cloud Storage.

Représentation JSON 
{
  "files": [
    {
      object (CloudStorageFile)
    }
  ]
}
Champs
files[]

object (CloudStorageFile)

Uniquement en sortie. Fichiers exportés dans Cloud Storage.

CloudStorageFile

Fichier d'exportation dans Cloud Storage

Représentation JSON 
{
  "bucketName": string,
  "objectName": string,
  "size": string,
  "md5Hash": string
}
Champs
bucketName

string

Nom du bucket Cloud Storage pour le fichier d'exportation. Vous pouvez utiliser cette valeur dans l'API JSON ou l'API XML de Cloud Storage, mais pas pour lister le contenu du bucket. À la place, vous pouvez obtenir des fichiers d'exportation individuels par nom d'objet.
objectName

string

Nom de l'objet Cloud Storage pour le fichier d'exportation. Vous pouvez utiliser cette valeur dans l'API JSON ou l'API XML de Cloud Storage.
size

string (int64 format)

Taille du fichier d'exportation.
md5Hash

string

Hachage md5 du fichier.

Méthodes

create

 Crée une exportation.

delete

 Supprime une exportation.

get

 Récupère une exportation.

list

 Répertorie les détails des exportations dans le litige spécifié.