REST Resource: matters.exports

Zasób: Export

Eksport.

Aby móc korzystać z zasobów Vault, konto musi mieć wymagane uprawnienia w Vault i dostęp do sprawy. Aby uzyskać dostęp do sprawy, konto musi utworzyć sprawę, udostępnić ją lub mieć uprawnienie Wyświetlanie wszystkich spraw.

Zapis 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)
  }
}
Pola
id

string

Tylko dane wyjściowe. Wygenerowany identyfikator eksportu.
matterId

string

Tylko dane wyjściowe. Identyfikator sprawy.
parentExportId

string

Tylko dane wyjściowe. Określa eksport nadrzędny, który wywołał ten eksport podrzędny. Ta opcja jest ustawiana tylko w eksportach podrzędnych.
name

string

Nazwa eksportu. W nazwie nie używaj znaków specjalnych (~!$'(),;@:/?) – mogą one uniemożliwiać pobieranie eksportów.
requester

object (UserInfo)

Tylko dane wyjściowe. Zgłaszający prośbę o eksport.
query

object (Query)

Parametry zapytania użyte do utworzenia eksportu.
exportOptions

object (ExportOptions)

Dodatkowe opcje eksportu.
createTime

string (Timestamp format)

Tylko dane wyjściowe. Godzina utworzenia eksportu.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
status

enum (ExportStatus)

Tylko dane wyjściowe. Stan eksportu.
stats

object (ExportStats)

Tylko dane wyjściowe. Informacje o postępie i rozmiarze eksportu.
cloudStorageSink

object (CloudStorageSink)

Tylko dane wyjściowe. Ujście plików eksportu w Cloud Storage.

UserInfo

Informacje o użytkowniku.

Zapis JSON 
{
  "email": string,
  "displayName": string
}
Pola
email

string

Adres e-mail użytkownika.
displayName

string

Wyświetlana nazwa użytkownika.

ExportOptions

Dodatkowe opcje eksportu

Zapis JSON 
{
  "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.
}
Pola
region

enum (ExportRegion)

Żądany region danych do wyeksportowania.
Pole sumy corpus_export_options. Opcje eksportu związane z konkretną usługą. corpus_export_options może mieć tylko jedną z tych wartości:
mailOptions

object (MailExportOptions)

Opcje eksportowania danych z Gmaila.
groupsOptions

object (GroupsExportOptions)

Opcje eksportu z Grup dyskusyjnych.
driveOptions

object (DriveExportOptions)

Opcje eksportu z Dysku.
hangoutsChatOptions

object (HangoutsChatExportOptions)

Opcje eksportowania z Google Chat.
voiceOptions

object (VoiceExportOptions)

Opcje eksportów z Voice.
calendarOptions

object (CalendarExportOptions)

Dostępna jest opcja eksportu Kalendarza.

MailExportOptions

Opcje eksportowania danych z Gmaila.

Zapis JSON 
{
  "exportFormat": enum (ExportFormat),
  "showConfidentialModeContent": boolean,
  "useNewExport": boolean,
  "exportLinkedDriveFiles": boolean
}
Pola
exportFormat

enum (ExportFormat)

Format pliku wyeksportowanych wiadomości.
showConfidentialModeContent

boolean

Aby wyeksportować treści w trybie poufnym, ustaw wartość true (prawda).
useNewExport

boolean

Aby używać nowego systemu eksportu, ustaw wartość true (prawda).
exportLinkedDriveFiles

boolean

Opcjonalnie. Aby umożliwić eksportowanie połączonych plików z Dysku, ustaw wartość true.

ExportFormat

Eksportowanie formatu wiadomości

Wartości w polu enum
EXPORT_FORMAT_UNSPECIFIED Nie określono formatu eksportu.
MBOX Eksportuj jako MBOX. Funkcja dostępna tylko w Gmailu, Grupach dyskusyjnych, Hangouts i Voice.
PST Eksportuj jako PST. Funkcja dostępna tylko w Gmailu, Grupach dyskusyjnych, Hangouts, Voice i Kalendarzu.
ICS Eksportuj jako ICS. (tylko w Kalendarzu).

GroupsExportOptions

Opcje eksportu z Grup dyskusyjnych.

Zapis JSON 
{
  "exportFormat": enum (ExportFormat)
}
Pola
exportFormat

enum (ExportFormat)

Format pliku wyeksportowanych wiadomości.

DriveExportOptions

Opcje eksportu z Dysku.

Zapis JSON 
{
  "includeAccessInfo": boolean
}
Pola
includeAccessInfo

boolean

Aby uwzględnić informacje o poziomie dostępu użytkowników, którzy mają pośredni dostęp do plików, ustaw wartość true.

HangoutsChatExportOptions

Opcje eksportowania z Google Chat.

Zapis JSON 
{
  "exportFormat": enum (ExportFormat)
}
Pola
exportFormat

enum (ExportFormat)

Format pliku wyeksportowanych wiadomości.

VoiceExportOptions

Opcje eksportów z Voice.

Zapis JSON 
{
  "exportFormat": enum (ExportFormat)
}
Pola
exportFormat

enum (ExportFormat)

Format pliku wyeksportowanych SMS-ów.

CalendarExportOptions

Opcje eksportowania Kalendarza.

Zapis JSON 
{
  "exportFormat": enum (ExportFormat)
}
Pola
exportFormat

enum (ExportFormat)

Format pliku wyeksportowanych SMS-ów.

ExportRegion

Region danych eksportowanych danych.

Wartości w polu enum
EXPORT_REGION_UNSPECIFIED Region jest nieokreślony. Wartość domyślna to DOWOLNY.
ANY Dowolny region.
US Stany Zjednoczone.
EUROPE Region Europy.

ExportStatus

Stan eksportu.

Wartości w polu enum
EXPORT_STATUS_UNSPECIFIED Stan jest nieokreślony.
COMPLETED Eksportowanie zostało zakończone.
FAILED Eksport się nie udał.
IN_PROGRESS Trwa eksportowanie.

ExportStats

Informacje o postępie eksportu.

Zapis JSON 
{
  "exportedArtifactCount": string,
  "totalArtifactCount": string,
  "sizeInBytes": string
}
Pola
exportedArtifactCount

string (int64 format)

Liczba wiadomości lub plików, które zostały już przetworzone do wyeksportowania.
totalArtifactCount

string (int64 format)

Liczba wiadomości lub plików do wyeksportowania.
sizeInBytes

string (int64 format)

Rozmiar eksportu w bajtach.

CloudStorageSink

Eksportuj ujście dla plików z Cloud Storage.

Zapis JSON 
{
  "files": [
    {
      object (CloudStorageFile)
    }
  ]
}
Pola
files[]

object (CloudStorageFile)

Tylko dane wyjściowe. Wyeksportowane pliki w Cloud Storage.

CloudStorageFile

Plik eksportu w Cloud Storage

Zapis JSON 
{
  "bucketName": string,
  "objectName": string,
  "size": string,
  "md5Hash": string
}
Pola
bucketName

string

Nazwa zasobnika Cloud Storage, w którym znajduje się plik eksportu. Możesz użyć tej wartości w interfejsie JSON API Cloud Storage lub XML API, ale nie do wyświetlania zawartości zasobnika. Zamiast tego możesz pobierać poszczególne pliki eksportu według nazwy obiektu.
objectName

string

Nazwa obiektu Cloud Storage dla pliku eksportu. Możesz użyć tej wartości w interfejsie JSON API lub XML API w Cloud Storage.
size

string (int64 format)

Rozmiar pliku eksportu.
md5Hash

string

Skrót MD5 pliku.

Metody

create

 Tworzy eksport.

delete

 Usuwa eksport.

get

 pobiera eksport.

list

 Wyświetla szczegółowe informacje na temat eksportów w określonej sprawie.