REST Resource: matters.exports

Ressource: Export

Ein Export.

Damit ein Konto mit Vault-Ressourcen arbeiten kann, muss es die erforderlichen Vault-Berechtigungen und Zugriff auf die Rechtsangelegenheit haben. Damit auf eine Rechtsangelegenheit zugegriffen werden kann, muss das Konto die Rechtsangelegenheit erstellt haben, die Rechtsangelegenheit muss für das Konto freigegeben worden sein oder das Konto 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)
  },

  "cloudStorageSink": {
    object (CloudStorageSink)
  }
}
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. Dieser Wert wird nur für untergeordnete Exporte festgelegt.
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 Anfragesteller des Exports.
query

object (Query)

Die zum Erstellen des Exports verwendeten Abfrageparameter.
exportOptions

object (ExportOptions)

Zusätzliche Exportoptionen
createTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem der Export erstellt wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. 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. Typ der Exportsenke. Für export_sink ist nur einer der folgenden Werte zulässig:
cloudStorageSink

object (CloudStorageSink)

Nur Ausgabe. Das Ziel für Exportdateien in Cloud Storage.

UserInfo

Informationen des Nutzers.

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

string

Die E-Mail-Adresse des Nutzers.
displayName

string

Der Anzeigename des Nutzers.

ExportOptions

Zusätzliche Optionen für Exporte

JSON-Darstellung 
{
  "region": enum (ExportRegion),

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

enum (ExportRegion)

Die angeforderte Datenregion für den Export.
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 Gruppenexport.
driveOptions

object (DriveExportOptions)

Optionen für Drive-Exporte.
hangoutsChatOptions

object (HangoutsChatExportOptions)

Optionen für Chat-Exporte.
voiceOptions

object (VoiceExportOptions)

Optionen für den Sprachexport.
calendarOptions

object (CalendarExportOptions)

Option für den Kalenderexport verfügbar.
geminiOptions

object (GeminiExportOptions)

Option für den Gemini-Export verfügbar.

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

Setzen Sie diesen Wert auf true, um Inhalte des Modus „Vertraulich“ zu exportieren.
useNewExport

boolean

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

boolean

Optional. Setzen Sie den Wert auf true, um das Exportieren verknüpfter Drive-Dateien zu aktivieren.

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 Gruppenexport.

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

enum (ExportFormat)

Das Dateiformat für exportierte Nachrichten.

DriveExportOptions

Optionen für 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, legen Sie den Wert auf true fest.

HangoutsChatExportOptions

Optionen für Chat-Exporte.

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

enum (ExportFormat)

Das Dateiformat für exportierte Nachrichten.

VoiceExportOptions

Die Optionen für den Sprachexport.

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

enum (ExportFormat)

Das Dateiformat für exportierte SMS.

CalendarExportOptions

Optionen für Kalenderexporte.

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

enum (ExportFormat)

Das Dateiformat für exportierte SMS.

GeminiExportOptions

Die Optionen für Gemini-Exporte.

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

enum (ExportFormat)

Das Dateiformat für exportierte Nachrichten.

ExportRegion

Die Datenregion für den Export.

Enums
EXPORT_REGION_UNSPECIFIED Die Region ist nicht angegeben. Die Standardeinstellung ist ANY.
ANY Beliebige Region.
US Region Vereinigte Staaten.
EUROPE Region Europa.

ExportStatus

Der Status des Exports.

Enums
EXPORT_STATUS_UNSPECIFIED Der Status ist nicht angegeben.
COMPLETED Der Export wurde 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

Die 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 Inhalt des Buckets 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

 Listet Details zu den Exporten in der angegebenen Angelegenheit auf.