REST Resource: matters.exports

Zasób: Export

eksportu;

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ą, mieć ją udostępnioną 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. Identyfikuje eksport nadrzędny, z którego pochodzi ten eksport podrzędny. Jest on ustawiany 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. Zgłaszający 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.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. 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 zbiorcze export_sink. Typ ujścia eksportu. export_sink może mieć tylko jedną z tych wartości:
cloudStorageSink

object (CloudStorageSink)

Tylko dane wyjściowe. Miejsce docelowe 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),

  "mailOptions": {
    object (MailExportOptions)
  },
  "groupsOptions": {
    object (GroupsExportOptions)
  },
  "driveOptions": {
    object (DriveExportOptions)
  },
  "hangoutsChatOptions": {
    object (HangoutsChatExportOptions)
  },
  "voiceOptions": {
    object (VoiceExportOptions)
  },
  "calendarOptions": {
    object (CalendarExportOptions)
  },
  "geminiOptions": {
    object (GeminiExportOptions)
  }
}
Pola
region

enum (ExportRegion)

Region danych, z którego mają pochodzić wyeksportowane dane.
Pole zbiorcze corpus_export_options. Opcje eksportu dotyczące konkretnych usług. corpus_export_options może mieć tylko jedną z tych wartości:
mailOptions

object (MailExportOptions)

Opcje eksportowania Gmaila.
groupsOptions

object (GroupsExportOptions)

Opcje eksportowania grup.
driveOptions

object (DriveExportOptions)

Opcje eksportowania danych z Dysku.
hangoutsChatOptions

object (HangoutsChatExportOptions)

Opcje eksportowania z Google Chat.
voiceOptions

object (VoiceExportOptions)

Opcje eksportu głosu.
calendarOptions

object (CalendarExportOptions)

Opcja dostępna w przypadku eksportowania Kalendarza.
geminiOptions

object (GeminiExportOptions)

Opcja dostępna w przypadku eksportu z Gemini.

MailExportOptions

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

boolean

Aby użyć nowego systemu eksportu, ustaw wartość true.
exportLinkedDriveFiles

boolean

Opcjonalnie. Aby włączyć eksportowanie z Dysku plików, do których prowadzą linki, ustaw wartość true.

ExportFormat

Format eksportu wiadomości

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

GroupsExportOptions

Opcje eksportowania grup.

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

enum (ExportFormat)

Format pliku wyeksportowanych wiadomości.

DriveExportOptions

Opcje eksportowania danych 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 eksportowania Voice.

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

enum (ExportFormat)

Format pliku wyeksportowanych wiadomości tekstowych.

CalendarExportOptions

Opcje eksportowania Kalendarza.

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

enum (ExportFormat)

Format pliku wyeksportowanych wiadomości tekstowych.

GeminiExportOptions

Opcje eksportu w Gemini.

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

enum (ExportFormat)

Format pliku wyeksportowanych wiadomości.

ExportRegion

Region danych, z którego pochodzą eksportowane dane.

Wartości w polu enum
EXPORT_REGION_UNSPECIFIED Region jest nieokreślony. Domyślna wartość to ANY.
ANY Dowolny region.
US Region: Stany Zjednoczone.
EUROPE region Europa.

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 Eksportowanie w toku.

ExportStats

Informacje o postępach eksportowania.

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 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 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, w którym ma się znajdować plik eksportu. Możesz użyć tej wartości w interfejsie JSON API lub XML API usługi 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 API usługi 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

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