REST Resource: matters.exports

Ressource: Export

Ein Export.

Damit Sie mit Vault-Ressourcen arbeiten können, muss das Konto die erforderlichen Vault-Berechtigungen und Zugriff auf die Rechtsangelegenheit haben. Damit ein Nutzer auf eine Rechtsangelegenheit zugreifen kann, muss er sie erstellt haben, sie muss für ihn freigegeben worden sein oder er 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 erstellt wurde. Dies 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 Anforderer des Exports.

query

object (Query)

Die Suchparameter, die zum Erstellen des Exports verwendet wurden.

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.

Typ der Exportsenke. Im Folgenden finden Sie eine Liste der Felder, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
cloudStorageSink

object (CloudStorageSink)

Nur Ausgabe. Die Senke für Exportdateien in Cloud Storage.

Ende der sich gegenseitig ausschließenden Felder.

UserInfo

Informationen zum Nutzer.

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)
  },
  "geminiInWorkspaceOptions": {
    object (GeminiInWorkspaceExportOptions)
  }
}
Felder
region

enum (ExportRegion)

Der angeforderte Speicherort für den Export.

Dienstspezifische Optionen für Exporte. Im Folgenden finden Sie eine Liste der Felder, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
mailOptions

object (MailExportOptions)

Optionen für Gmail-Exporte.

groupsOptions

object (GroupsExportOptions)

Optionen für den Export von Google Groups.

driveOptions

object (DriveExportOptions)

Optionen für 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 verfügbar.

geminiOptions

object (GeminiExportOptions)

Option für den Export aus der Gemini App verfügbar.

geminiInWorkspaceOptions

object (GeminiInWorkspaceExportOptions)

Option für den Export von Gemini in Workspace verfügbar.

Ende der sich gegenseitig ausschließenden Felder.

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 im Modus „Vertraulich“ exportieren möchten, legen Sie true fest.

useNewExport

boolean

Wenn Sie das neue Exportsystem verwenden möchten, legen Sie den Wert auf true fest.

exportLinkedDriveFiles

boolean

Optional. Wenn Sie den Export verknüpfter Drive-Dateien aktivieren möchten, legen Sie den Wert auf true fest.

ExportFormat

Exportformat für Nachrichten

Enums
EXPORT_FORMAT_UNSPECIFIED Kein Exportformat angegeben.
MBOX Als MBOX exportieren. Nur für Gmail, Google Groups, Hangouts und Google Voice verfügbar.
PST Als PST exportieren. Nur für Gmail, Google Groups, Hangouts, Voice und Google Kalender verfügbar.
ICS Als ICS-Datei exportieren. Nur für Google Kalender verfügbar.
XML Als XML exportieren. Nur für die Gemini App verfügbar.
JSON Als JSON exportieren. Nur für Gemini in Workspace verfügbar.

GroupsExportOptions

Optionen für den Export von Google Groups.

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 einbeziehen möchten, legen Sie 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 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 App-Exporte.

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

enum (ExportFormat)

Das Dateiformat für exportierte Nachrichten.

GeminiInWorkspaceExportOptions

Die Optionen für Gemini in Workspace-Exporte.

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

enum (ExportFormat)

Das Dateiformat für exportierte Nachrichten.

ExportRegion

Der Datenspeicherort 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 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 werden Details zu den Exporten in der angegebenen Rechtsangelegenheit aufgeführt.