REST Resource: matters.exports

Ressource : Export

Une exportation.

Pour travailler avec les ressources Vault, le compte doit disposer des droits Vault requis et avoir accès à l'affaire. Pour accéder à un litige, le compte doit l'avoir créé, l'avoir partagé 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 problème.
parentExportId

string

Uniquement en sortie. Identifie l'exportation parente qui a généré cette exportation enfant. Cette option n'est disponible que pour les exportations enfants.
name

string

Nom de l'exportation. N'utilisez pas de caractères spéciaux (~!$'(),;@:/?) dans le nom, 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. Heure à laquelle l'exportation a été créée.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
status

enum (ExportStatus)

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

object (ExportStats)

Uniquement en sortie. Informations sur la progression et la taille de l'exportation.
Champ d'union export_sink. Type de récepteur d'exportation. export_sink ne peut être qu'un des éléments suivants :
cloudStorageSink

object (CloudStorageSink)

Uniquement en sortie. Sink pour les fichiers d'exportation 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 à afficher de l'utilisateur.

ExportOptions

Options supplémentaires pour les exportations

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

enum (ExportRegion)

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

object (MailExportOptions)

Options d'exportation Gmail.
groupsOptions

object (GroupsExportOptions)

Options d'exportation des groupes.
driveOptions

object (DriveExportOptions)

Options d'exportation Drive.
hangoutsChatOptions

object (HangoutsChatExportOptions)

Options d'exportation Chat.
voiceOptions

object (VoiceExportOptions)

Options d'exportation des données vocales.
calendarOptions

object (CalendarExportOptions)

Option disponible pour l'exportation d'agenda.
geminiOptions

object (GeminiExportOptions)

Option disponible pour l'exportation Gemini.

MailExportOptions

Options d'exportation Gmail.

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

enum (ExportFormat)

Format de fichier pour les messages exportés.
showConfidentialModeContent

boolean

Définissez la valeur sur true pour exporter le contenu en mode confidentiel.
useNewExport

boolean

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

boolean

Facultatif. Définissez la valeur sur true pour activer l'exportation des fichiers Drive associés.

ExportFormat

Format d'exportation des messages

Enums
EXPORT_FORMAT_UNSPECIFIED Aucun format d'exportation n'a été spécifié.
MBOX Exportez-les au format MBOX. Uniquement disponible 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 Calendar.
XML Exporter au format XML Disponible uniquement pour Gemini.

GroupsExportOptions

Options d'exportation des groupes.

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

enum (ExportFormat)

Format de fichier pour les messages exportés.

DriveExportOptions

Options d'exportation Drive.

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

boolean

Définissez la valeur sur true pour inclure les informations de niveau d'accès pour les utilisateurs ayant un accès indirect aux fichiers.

HangoutsChatExportOptions

Options d'exportation Chat.

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

enum (ExportFormat)

Format de fichier pour les messages exportés.

VoiceExportOptions

Options d'exportation de la voix.

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

enum (ExportFormat)

Format de fichier pour les messages texte exportés.

CalendarExportOptions

Options d'exportation d'Agenda.

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

enum (ExportFormat)

Format de fichier pour les messages texte exportés.

GeminiExportOptions

Options d'exportation Gemini.

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

enum (ExportFormat)

Format de fichier pour les messages exportés.

ExportRegion

La région de données pour l'exportation.

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

ExportStatus

État de l'exportation.

Enums
EXPORT_STATUS_UNSPECIFIED L'état n'est pas spécifié.
COMPLETED L'exportation est 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

Sink d'exportation 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. En revanche, 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

 Affiche des informations sur les exportations dans la demande spécifiée.