REST Resource: matters.exports

Zasób: eksportowanie

eksport,

Aby pracować z zasobami 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, który wygenerował ten eksport podrzędny. To ustawienie jest konfigurowane 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.
Typ ujścia eksportu. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
cloudStorageSink

object (CloudStorageSink)

Tylko dane wyjściowe. Ujście plików eksportu w Cloud Storage.
Koniec pól wykluczających się wzajemnie.

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)
  },
  "geminiInWorkspaceOptions": {
    object (GeminiInWorkspaceExportOptions)
  }
}
Pola
region

enum (ExportRegion)

Region danych, do którego mają zostać wyeksportowane dane.
Opcje eksportu obejmujące konkretne usługi. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
mailOptions

object (MailExportOptions)

Opcje eksportu Gmaila.
groupsOptions

object (GroupsExportOptions)

Opcje eksportu Grup dyskusyjnych.
driveOptions

object (DriveExportOptions)

Opcje eksportu danych z Dysku.
hangoutsChatOptions

object (HangoutsChatExportOptions)

Opcje eksportu czatów.
voiceOptions

object (VoiceExportOptions)

Opcje eksportu danych Voice.
calendarOptions

object (CalendarExportOptions)

Opcja dostępna w przypadku eksportu Kalendarza.
geminiOptions

object (GeminiExportOptions)

Opcja dostępna w przypadku eksportowania z aplikacji Gemini.
geminiInWorkspaceOptions

object (GeminiInWorkspaceExportOptions)

Opcja dostępna w przypadku eksportu z Gemini w Workspace.
Koniec pól wykluczających się wzajemnie.

MailExportOptions

Opcje eksportu 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 z trybu poufnego, ustaw wartość true.
useNewExport

boolean

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

boolean

Opcjonalnie: Aby włączyć eksportowanie połączonych plików na Dysku, 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 dyskusyjnych, Hangouts i Voice.
PST Eksportuj jako plik PST. Dostępne tylko w Gmailu, Grupach dyskusyjnych, Hangouts, Voice i Kalendarzu.
ICS Eksportuj jako plik ICS. Dostępne tylko w Kalendarzu.
XML Eksportuj jako plik XML. Dostępne tylko w aplikacji Gemini.
JSON Eksportuj jako plik JSON. Dostępne tylko w przypadku Gemini w Workspace.

GroupsExportOptions

Opcje eksportu Grup dyskusyjnych.

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

enum (ExportFormat)

Format pliku wyeksportowanych wiadomości.

DriveExportOptions

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

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

enum (ExportFormat)

Format pliku wyeksportowanych wiadomości.

VoiceExportOptions

Opcje eksportu danych z Voice.

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

enum (ExportFormat)

Format pliku wyeksportowanych SMS-ów.

CalendarExportOptions

Opcje eksportu Kalendarza.

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

enum (ExportFormat)

Format pliku wyeksportowanych SMS-ów.

GeminiExportOptions

Opcje eksportowania danych z aplikacji Gemini.

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

enum (ExportFormat)

Format pliku wyeksportowanych wiadomości.

GeminiInWorkspaceExportOptions

Opcje eksportu Gemini w Workspace.

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 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 Eksport został zakończony.
FAILED Eksport się nie udał.
IN_PROGRESS Trwa eksportowanie.

ExportStats

Informacje o postępach 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 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 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 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 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 listę szczegółów dotyczących eksportów w określonej sprawie.