REST Resource: matters.exports

Ressource: Export

Einen Export.

Damit das Konto mit Vault-Ressourcen arbeiten kann, muss es die erforderlichen Vault-Berechtigungen haben und Zugriff auf die Angelegenheit haben. Um auf eine Rechtsangelegenheit zugreifen zu können, muss das Konto die Rechtsangelegenheit erstellt oder die Rechtsangelegenheit für das Konto freigegeben worden sein oder der Nutzer muss die Berechtigung Alle Rechtsangelegenheiten abrufen haben.

JSON-Darstellung 
{
  "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)
  },

  // Union field export_sink can be only one of the following:
  "cloudStorageSink": {
    object (CloudStorageSink)
  }
  // End of list of possible types for union field export_sink.
}
Felder
id

string

Nur Ausgabe. Die generierte Export-ID.
matterId

string

Nur Ausgabe. Die ID der Rechtsangelegenheit.
parentExportId

string

Nur Ausgabe. Gibt den übergeordneten Export an, aus dem dieser untergeordnete Export hervorgegangen ist. Diese Einstellung gilt nur für untergeordnete Exporte.
name

string

Der Exportname. Für diesen Namen dürfen keine Sonderzeichen (~!$'(),;@:/?) verwendet werden, da sie das Herunterladen von Exporten verhindern können.
requester

object (UserInfo)

Nur Ausgabe. Der Antragsteller des Exports.
query

object (Query)

Die Abfrageparameter, die zum Erstellen des Exports verwendet wurden.
exportOptions

object (ExportOptions)

Zusätzliche Exportoptionen.
createTime

string (Timestamp format)

Nur Ausgabe. Die Uhrzeit, zu der der Export erstellt wurde.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
status

enum (ExportStatus)

Nur Ausgabe. Der Status des Exports.
stats

object (ExportStats)

Nur Ausgabe. Details zum Exportfortschritt und zur Größe.
Union-Feld export_sink. Exportsink-Typ. Für export_sink ist nur einer der folgenden Werte zulässig:
cloudStorageSink

object (CloudStorageSink)

Nur Ausgabe. Der Zielort für Exportdateien in Cloud Storage.

UserInfo

Informationen zum Nutzer

JSON-Darstellung 
{
  "email": string,
  "displayName": string
}
Felder
email

string

Die E-Mail-Adresse des Nutzers.
displayName

string

Der angezeigte Name des Nutzers.

ExportOptions

Zusätzliche Optionen für Exporte

JSON-Darstellung 
{
  "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)
  },
  "geminiOptions": {
    object (GeminiExportOptions)
  }
  // End of list of possible types for union field corpus_export_options.
}
Felder
region

enum (ExportRegion)

Der angeforderte Speicherort für die exportierten Daten.
Union-Feld corpus_export_options. Dienstspezifische Optionen für Exporte. Für corpus_export_options ist nur einer der folgenden Werte zulässig:
mailOptions

object (MailExportOptions)

Optionen für Gmail-Exporte
groupsOptions

object (GroupsExportOptions)

Optionen für den Export von Gruppen
driveOptions

object (DriveExportOptions)

Optionen für Google Drive-Exporte
hangoutsChatOptions

object (HangoutsChatExportOptions)

Optionen für Chat-Exporte
voiceOptions

object (VoiceExportOptions)

Optionen für Voice-Exporte
calendarOptions

object (CalendarExportOptions)

Option für den Kalenderexport.
geminiOptions

object (GeminiExportOptions)

Option für den Gemini-Export.

MailExportOptions

Optionen für Gmail-Exporte

JSON-Darstellung 
{
  "exportFormat": enum (ExportFormat),
  "showConfidentialModeContent": boolean,
  "useNewExport": boolean,
  "exportLinkedDriveFiles": boolean
}
Felder
exportFormat

enum (ExportFormat)

Das Dateiformat für exportierte Nachrichten.
showConfidentialModeContent

boolean

Wenn Sie Inhalte des Modus „Vertraulich“ exportieren möchten, setzen Sie diesen Wert auf true.
useNewExport

boolean

Wenn Sie das neue Exportsystem verwenden möchten, setzen Sie den Wert auf true.
exportLinkedDriveFiles

boolean

Optional. Wenn Sie verknüpfte Google Drive-Dateien exportieren möchten, setzen Sie den Wert auf true.

ExportFormat

Exportformat für Nachrichten

Enums
EXPORT_FORMAT_UNSPECIFIED Es wurde kein Exportformat angegeben.
MBOX Als MBOX-Datei exportieren. Nur für Gmail, Groups, Hangouts und Voice verfügbar.
PST Als PST-Datei exportieren. Nur für Gmail, Groups, Hangouts, Voice und Kalender verfügbar.
ICS Als ICS-Datei exportieren Nur für Google Kalender verfügbar.
XML Als XML exportieren Nur für Gemini verfügbar.

GroupsExportOptions

Optionen für den Export von Gruppen

JSON-Darstellung 
{
  "exportFormat": enum (ExportFormat)
}
Felder
exportFormat

enum (ExportFormat)

Das Dateiformat für exportierte Nachrichten.

DriveExportOptions

Optionen für Google Drive-Exporte

JSON-Darstellung 
{
  "includeAccessInfo": boolean
}
Felder
includeAccessInfo

boolean

Wenn Sie Informationen zu Zugriffsebenen für Nutzer mit indirektem Zugriff auf Dateien einschließen möchten, setzen Sie true.

HangoutsChatExportOptions

Optionen für den Export von Chats

JSON-Darstellung 
{
  "exportFormat": enum (ExportFormat)
}
Felder
exportFormat

enum (ExportFormat)

Das Dateiformat für exportierte Nachrichten.

VoiceExportOptions

Die Optionen für Voice-Exporte.

JSON-Darstellung 
{
  "exportFormat": enum (ExportFormat)
}
Felder
exportFormat

enum (ExportFormat)

Das Dateiformat für exportierte Nachrichten.

CalendarExportOptions

Die Optionen für Kalenderexporte.

JSON-Darstellung 
{
  "exportFormat": enum (ExportFormat)
}
Felder
exportFormat

enum (ExportFormat)

Das Dateiformat für exportierte Nachrichten.

GeminiExportOptions

Die Optionen für Gemini-Exporte.

JSON-Darstellung 
{
  "exportFormat": enum (ExportFormat)
}
Felder
exportFormat

enum (ExportFormat)

Das Dateiformat für exportierte Nachrichten.

ExportRegion

Die Speicherregion für den Export.

Enums
EXPORT_REGION_UNSPECIFIED Die Region ist nicht angegeben. Die Standardeinstellung ist JEDER.
ANY Beliebige Region
US USA
EUROPE Europa.

ExportStatus

Der Status des Exports.

Enums
EXPORT_STATUS_UNSPECIFIED Der Status ist nicht angegeben.
COMPLETED Der Export ist abgeschlossen.
FAILED Der Export ist fehlgeschlagen.
IN_PROGRESS Der Export wird ausgeführt.

ExportStats

Fortschrittsinformationen für einen Export.

JSON-Darstellung 
{
  "exportedArtifactCount": string,
  "totalArtifactCount": string,
  "sizeInBytes": string
}
Felder
exportedArtifactCount

string (int64 format)

Die Anzahl der Nachrichten oder Dateien, die bereits für den Export verarbeitet wurden.
totalArtifactCount

string (int64 format)

Die Anzahl der zu exportierenden Nachrichten oder Dateien.
sizeInBytes

string (int64 format)

Die Größe des Exports in Byte.

CloudStorageSink

Exportziel für Cloud Storage-Dateien.

JSON-Darstellung 
{
  "files": [
    {
      object (CloudStorageFile)
    }
  ]
}
Felder
files[]

object (CloudStorageFile)

Nur Ausgabe. Die exportierten Dateien in Cloud Storage.

CloudStorageFile

Exportdatei in Cloud Storage

JSON-Darstellung 
{
  "bucketName": string,
  "objectName": string,
  "size": string,
  "md5Hash": string
}
Felder
bucketName

string

Der Name des Cloud Storage-Buckets für die Exportdatei. Sie können diesen Wert in der JSON API oder XML API von Cloud Storage verwenden, aber nicht, um den Bucket-Inhalt aufzulisten. Stattdessen können Sie einzelne Exportdateien nach Objektnamen abrufen.
objectName

string

Der Name des Cloud Storage-Objekts für die Exportdatei. Sie können diesen Wert in der JSON API oder XML API von Cloud Storage verwenden.
size

string (int64 format)

Die Größe der Exportdatei.
md5Hash

string

Der MD5-Hash der Datei.

Methoden

create

 Erstellt einen Export.

delete

 Löscht einen Export.

get

 Ruft einen Export ab.

list

 Hier finden Sie Details zu den Exporten in der angegebenen Angelegenheit.