REST Resource: matters.exports

Zasób: Export

Eksport.

Aby można było korzystać z zasobów Vault, konto musi mieć wymagane uprawnienia w Vault i dostęp do sprawy. Aby uzyskać dostęp do sprawy, użytkownik konta musi utworzyć tę sprawę, udostępnić ją osobie lub mieć uprawnienie do wyświetlania 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. Identyfikuje eksport nadrzędny, który spowodował utworzenie tego eksportu podrzędnego. Tę opcję ustawia się tylko w eksportach podrzędnych.
name

string

Nazwa eksportu. Nie używaj w nazwie znaków specjalnych (~!$'(),;@:/?), ponieważ 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. Czas utworzenia eksportu.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową 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. Szczegółowe informacje o postępie i rozmiarze eksportu.
cloudStorageSink

object (CloudStorageSink)

Tylko dane wyjściowe. Ujście dla 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 na potrzeby eksportu.
Pole sumy corpus_export_options. Opcje eksportu dotyczące poszczególnych usług. corpus_export_options może mieć tylko jedną z tych wartości:
mailOptions

object (MailExportOptions)

Opcje eksportu w Gmailu.
groupsOptions

object (GroupsExportOptions)

Opcje eksportu z Grup dyskusyjnych.
driveOptions

object (DriveExportOptions)

Opcje eksportów z Dysku.
hangoutsChatOptions

object (HangoutsChatExportOptions)

Opcje eksportów z Google Chat.
voiceOptions

object (VoiceExportOptions)

Opcje eksportu z Voice.
calendarOptions

object (CalendarExportOptions)

Opcja dostępna w przypadku eksportu Kalendarza.

MailExportOptions

Opcje eksportu w Gmailu.

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

boolean

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

boolean

Opcjonalnie: Aby włączyć eksportowanie plików na Dysku, do których prowadzą linki, ustaw wartość true (prawda).

ExportFormat

Format eksportu 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 Wyeksportuj jako PST. Funkcja dostępna tylko w Gmailu, Grupach dyskusyjnych, Hangouts, Voice i Kalendarzu.
ICS Eksportuj jako ICS. Dostępne tylko w przypadku Kalendarza.

GroupsExportOptions

Opcje eksportu z Grup dyskusyjnych.

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

enum (ExportFormat)

Format pliku wyeksportowanych wiadomości.

DriveExportOptions

Opcje eksportów 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 eksportów 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 eksportu w Kalendarzu.

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

enum (ExportFormat)

Format pliku wyeksportowanych SMS-ów.

ExportRegion

Region danych eksportu.

Wartości w polu enum
EXPORT_REGION_UNSPECIFIED Region jest nieokreślony. Wartość domyślna to DOWOLNA.
ANY Dowolny region.
US Region Stanów Zjednoczonych.
EUROPE Region Europy.

ExportStatus

Stan eksportu.

Wartości w polu enum
EXPORT_STATUS_UNSPECIFIED Stan nie jest okreś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 przetworzonych już na potrzeby eksportu.
totalArtifactCount

string (int64 format)

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

string (int64 format)

Rozmiar eksportu w bajtach.

CloudStorageSink

Ujście eksportu dla plików 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 dla pliku eksportu. Możesz użyć tej wartości w interfejsie JSON API lub XML API w Cloud Storage, ale nie do wyświetlania zawartości zasobnika. Zamiast tego możesz pobrać 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 w Cloud Storage.
size

string (int64 format)

Rozmiar wyeksportowanego pliku.
md5Hash

string

Skrót md5 pliku.

Metody

create

 Tworzy eksport.

delete

 Usuwa eksport.

get

 Pobiera eksport.

list

 Wyświetla szczegółowe informacje o eksportach w określonej sprawie.