REST Resource: matters.exports

Zasób: eksport

Eksport.

Aby korzystać z zasobów Vault, konto musi mieć wymagane uprawnienia Vault i dostęp do sprawy. Aby uzyskać dostęp do sprawy, konto musi być jej twórcą, musi mieć do niej dostęp 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)
  },

  // Union field export_sink can be only one of the following:
  "cloudStorageSink": {
    object (CloudStorageSink)
  }
  // End of list of possible types for union field export_sink.
}
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 wygenerował ten eksport podrzędny. Jest ona ustawiana tylko w przypadku eksportów podrzędnych.
name

string

Nazwa eksportu. Nie używaj w nazwie znaków specjalnych (~!$'(),;@:/?), bo mogą uniemożliwić pobranie eksportu.
requester

object (UserInfo)

Tylko dane wyjściowe. Osoba, która poprosiła 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.

Używa standardu RFC 3339, w którym wygenerowany wynik jest zawsze znormalizowany według normy Z i zawiera 0, 3, 6 lub 9 cyfr ułamkowych. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".
status

enum (ExportStatus)

Tylko dane wyjściowe. Stan eksportu.
stats

object (ExportStats)

Tylko dane wyjściowe. Szczegóły dotyczące postępu i rozmiaru eksportu.
Pole unii export_sink. Typ miejsca docelowego eksportu. export_sink może być tylko jednym z tych elementów:
cloudStorageSink

object (CloudStorageSink)

Tylko dane wyjściowe. Miejsce docelowe dla plików eksportu w Cloud Storage.

UserInfo

Dane użytkownika.

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)
  },
  "geminiOptions": {
    object (GeminiExportOptions)
  }
  // End of list of possible types for union field corpus_export_options.
}
Pola
region

enum (ExportRegion)

Region danych, z którego mają być eksportowane dane.
Pole unii corpus_export_options. Opcje eksportu dotyczące konkretnych usług. corpus_export_options może być tylko jednym z tych elementów:
mailOptions

object (MailExportOptions)

Opcje eksportowania z Gmaila
groupsOptions

object (GroupsExportOptions)

Opcje eksportu grup.
driveOptions

object (DriveExportOptions)

Opcje eksportowania z Dysku.
hangoutsChatOptions

object (HangoutsChatExportOptions)

Opcje eksportowania danych z Google Chat
voiceOptions

object (VoiceExportOptions)

Opcje eksportowania danych z Voice
calendarOptions

object (CalendarExportOptions)

Opcja dostępna w przypadku eksportowania z Kalendarza.
geminiOptions

object (GeminiExportOptions)

Opcja dostępna w przypadku eksportu do Gemini.

MailExportOptions

Opcje eksportowania 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 eksportować treści w trybie poufnym, ustaw wartość na true.
useNewExport

boolean

Aby użyć nowego systemu eksportu, ustaw tę opcję na true.
exportLinkedDriveFiles

boolean

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

ExportFormat

Format eksportu wiadomości

Wartości w polu enum
EXPORT_FORMAT_UNSPECIFIED Nie wybrano formatu eksportu.
MBOX Eksportuj jako MBOX. Dostępne tylko w Gmailu, Grupach, Hangouts i Voice.
PST Eksportuj jako plik PST. Dostępne tylko w Gmailu, Grupach dyskusyjnych, Hangouts, Voice i Kalendarzu.
ICS Wyeksportuj jako plik .ics. Dostępne tylko w Kalendarzu.
XML Eksportuj jako XML. Dostępne tylko w Gemini.

GroupsExportOptions

Opcje eksportu grup.

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

enum (ExportFormat)

Format pliku wyeksportowanych wiadomości.

DriveExportOptions

Opcje eksportowania 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 tę opcję na true.

HangoutsChatExportOptions

Opcje eksportowania danych z Google Chat

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

enum (ExportFormat)

Format pliku wyeksportowanych wiadomości.

VoiceExportOptions

Opcje eksportowania danych z Voice.

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

enum (ExportFormat)

Format pliku dla eksportowanych wiadomości tekstowych.

CalendarExportOptions

Opcje eksportowania kalendarza.

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

enum (ExportFormat)

Format pliku dla eksportowanych wiadomości tekstowych.

GeminiExportOptions

Opcje eksportu Gemini.

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

enum (ExportFormat)

Format pliku wyeksportowanych wiadomości.

ExportRegion

Region danych eksportu.

Wartości w polu enum
EXPORT_REGION_UNSPECIFIED Region nie został określony. Domyślna wartość to dowolna.
ANY dowolny region.
US Region Stany Zjednoczone.
EUROPE Europe.

ExportStatus

Stan eksportu.

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

ExportStats

Informacje o postępie eksportowania.

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

string (int64 format)

Liczba wiadomości lub plików już przetworzonych na potrzeby eksportu.
totalArtifactCount

string (int64 format)

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

string (int64 format)

Rozmiar eksportu w bajtach.

CloudStorageSink

Miejsce docelowe 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 usługi Cloud Storage, ale nie możesz jej użyć do wyświetlenia 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 API usługi Cloud Storage.
size

string (int64 format)

Rozmiar pliku eksportowanego.
md5Hash

string

Skrót MD5 pliku.

Metody

create

 Tworzy eksport.

delete

 Usuwa eksport.

get

 Pobiera dane eksportu.

list

 zawiera listę szczegółów eksportów w określonej sprawie;