REST Resource: matters.exports

Ressource: Exportieren

Einen Export.

Damit Sie mit Vault-Ressourcen arbeiten können, muss das Konto die erforderlichen Vault-Berechtigungen und Zugriff auf die Rechtsangelegenheit haben. Damit Sie auf eine Rechtsangelegenheit zugreifen können, muss sie über das Konto erstellt worden sein, für die Rechtsangelegenheit freigegeben worden sein oder 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, der diesen untergeordneten Export generiert hat. Dies ist nur bei untergeordneten Exporten festgelegt.
name

string

Der Name des Exports. Der Name darf keine Sonderzeichen (~!$'(),;@:/?) enthalten, da sie das Herunterladen von Exporten verhindern können.
requester

object (UserInfo)

Nur Ausgabe Der Anforderer des Exports.
query

object (Query)

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

object (ExportOptions)

Zusätzliche Exportoptionen.
createTime

string (Timestamp format)

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

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
status

enum (ExportStatus)

Nur Ausgabe Der Status des Exports.
stats

object (ExportStats)

Nur Ausgabe Details zum Fortschritt und zur Größe des Exports.
cloudStorageSink

object (CloudStorageSink)

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

UserInfo

Nutzerdaten.

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)
  }
  // End of list of possible types for union field corpus_export_options.
}
Felder
region

enum (ExportRegion)

Der angeforderte Speicherort für Daten 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 Gruppenexporte.
driveOptions

object (DriveExportOptions)

Optionen für Drive-Exporte.
hangoutsChatOptions

object (HangoutsChatExportOptions)

Optionen für Chatexporte.
voiceOptions

object (VoiceExportOptions)

Optionen für Voice-Exporte.
calendarOptions

object (CalendarExportOptions)

Option für den Google Kalender-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

Legen Sie true fest, um Inhalte im Modus „Vertraulich“ zu exportieren.
useNewExport

boolean

Legen Sie diesen Wert auf true fest, um das neue Exportsystem zu verwenden.
exportLinkedDriveFiles

boolean

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

ExportFormat

Exportformat für Nachrichten

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

GroupsExportOptions

Optionen für Gruppenexporte.

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 für Nutzer mit indirektem Zugriff auf Dateien Informationen zu Zugriffsebenen sehen möchten, setzen Sie den Wert auf true.

HangoutsChatExportOptions

Optionen für Chatexporte.

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

CalendarExportOptions

Die Optionen für Kalenderexporte.

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

enum (ExportFormat)

Das Dateiformat für exportierte Textnachrichten.

ExportRegion

Der Speicherort für Daten für den Export.

Enums
EXPORT_REGION_UNSPECIFIED Die Region ist nicht angegeben. Die Standardeinstellung ist ANY.
ANY Beliebige Region.
US USA.
EUROPE Region 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

Informationen zum Fortschritt eines Exports.

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

Exportsenke 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 der XML API von Cloud Storage verwenden, aber nicht zum Auflisten des Bucket-Inhalts. Stattdessen können Sie einzelne Exportdateien anhand des Objektnamens abrufen.
objectName

string

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

string (int64 format)

Die Größe der Exportdatei.
md5Hash

string

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 Rechtsangelegenheit auf.