REST Resource: matters.exports

Ресурс: экспорт

Экспорт.

Чтобы работать с ресурсами Сейфа, у аккаунта должны быть необходимые права Сейфа и доступ к делу. Чтобы получить доступ к делу, пользователь должен быть его создателем, иметь к нему доступ или обладать правом Просмотр всех дел.

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)
  }
}
Поля
id

string

Только для вывода. Сгенерированный идентификатор экспорта.
matterId

string

Только для вывода. Идентификатор дела.
parentExportId

string

Только для вывода. Идентификатор родительского экспорта, который породил этот дочерний экспорт. Это поле заполняется только для дочерних экспортов.
name

string

Название экспорта. Не используйте в нем специальные символы (~!$'(),;@:/?). Это может помешать скачивать файлы экспорта.
requester

object (UserInfo)

Только для вывода. Пользователь, запросивший экспорт.
query

object (Query)

Параметры запроса, использованные для создания экспорта.
exportOptions

object (ExportOptions)

Дополнительные параметры экспорта.
createTime

string (Timestamp format)

Только для вывода. Время создания экспорта.

Используется формат RFC 3339. Результат всегда будет Z-нормализованным, и в нем будут использоваться цифры дробных частей 0, 3, 6 или 9. Допустимы и другие типы нормализации. Примеры: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30".
status

enum (ExportStatus)

Только для вывода. Статус экспорта.
stats

object (ExportStats)

Только для вывода. Сведения о ходе экспорта и размере экспортируемых данных.
Тип приемника экспорта. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
cloudStorageSink

object (CloudStorageSink)

Только для вывода. Приемник для экспортированных файлов в Cloud Storage.
Конец взаимоисключающих полей.

UserInfo

Информация о пользователе.

JSON-представление 
{
  "email": string,
  "displayName": string
}
Поля
email

string

Адрес электронной почты пользователя.
displayName

string

Отображаемое имя пользователя.

ExportOptions

Дополнительные параметры экспорта

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)
  }
}
Поля
region

enum (ExportRegion)

Запрошенный регион хранения данных для экспорта.
Параметры экспорта для отдельных сервисов. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
mailOptions

object (MailExportOptions)

Параметры экспорта данных Gmail.
groupsOptions

object (GroupsExportOptions)

Параметры экспорта групп.
driveOptions

object (DriveExportOptions)

Параметры экспорта с Диска.
hangoutsChatOptions

object (HangoutsChatExportOptions)

Параметры экспорта Chat.
voiceOptions

object (VoiceExportOptions)

Параметры экспорта данных Voice.
calendarOptions

object (CalendarExportOptions)

Для экспорта Календаря доступен один вариант.
geminiOptions

object (GeminiExportOptions)

Вариант доступен для экспорта из приложения Gemini.
geminiInWorkspaceOptions

object (GeminiInWorkspaceExportOptions)

Вариант, доступный для экспорта Gemini в Workspace.
Конец взаимоисключающих полей.

MailExportOptions

Параметры экспорта данных Gmail.

JSON-представление 
{
  "exportFormat": enum (ExportFormat),
  "showConfidentialModeContent": boolean,
  "useNewExport": boolean,
  "exportLinkedDriveFiles": boolean
}
Поля
exportFormat

enum (ExportFormat)

Формат файла для экспортированных сообщений.
showConfidentialModeContent

boolean

Чтобы экспортировать контент, отправленный в конфиденциальном режиме, задайте значение true.
useNewExport

boolean

Чтобы использовать новую систему экспорта, установите значение true.
exportLinkedDriveFiles

boolean

Необязательное поле. Чтобы включить экспорт связанных файлов Диска, задайте значение true.

ExportFormat

Формат экспорта сообщений

Перечисления
EXPORT_FORMAT_UNSPECIFIED Не указан формат экспорта.
MBOX Экспортировать в формате MBOX. Доступно только для Gmail, Групп, Hangouts и Voice.
PST Экспортируйте данные в формате PST. Доступно только для Gmail, Групп, Hangouts, Voice и Календаря.
ICS Экспортировать в формате ICS. Доступно только для Календаря.
XML Экспортировать в формате XML. Доступно только в приложении Gemini.
JSON Экспортировать в формате JSON. Доступно только для Gemini в Workspace.

GroupsExportOptions

Параметры экспорта групп.

JSON-представление 
{
  "exportFormat": enum (ExportFormat)
}
Поля
exportFormat

enum (ExportFormat)

Формат файла для экспортированных сообщений.

DriveExportOptions

Параметры экспорта с Диска.

JSON-представление 
{
  "includeAccessInfo": boolean
}
Поля
includeAccessInfo

boolean

Чтобы включить сведения об уровне доступа для пользователей, имеющих косвенный доступ к файлам, установите значение true.

HangoutsChatExportOptions

Параметры экспорта Chat.

JSON-представление 
{
  "exportFormat": enum (ExportFormat)
}
Поля
exportFormat

enum (ExportFormat)

Формат файла для экспортированных сообщений.

VoiceExportOptions

Параметры экспорта данных Voice.

JSON-представление 
{
  "exportFormat": enum (ExportFormat)
}
Поля
exportFormat

enum (ExportFormat)

Формат файла для экспортированных текстовых сообщений.

CalendarExportOptions

Параметры экспорта Календаря.

JSON-представление 
{
  "exportFormat": enum (ExportFormat)
}
Поля
exportFormat

enum (ExportFormat)

Формат файла для экспортированных текстовых сообщений.

GeminiExportOptions

Варианты экспорта данных приложения Gemini.

JSON-представление 
{
  "exportFormat": enum (ExportFormat)
}
Поля
exportFormat

enum (ExportFormat)

Формат файла для экспортированных сообщений.

GeminiInWorkspaceExportOptions

Варианты экспорта для Gemini в Workspace.

JSON-представление 
{
  "exportFormat": enum (ExportFormat)
}
Поля
exportFormat

enum (ExportFormat)

Формат файла для экспортированных сообщений.

ExportRegion

Регион хранения данных для экспорта.

Перечисления
EXPORT_REGION_UNSPECIFIED Регион не указан. Значение по умолчанию – ANY.
ANY Любой регион.
US Регион США.
EUROPE Европа.

ExportStatus

Статус экспорта.

Перечисления
EXPORT_STATUS_UNSPECIFIED Статус не указан.
COMPLETED Экспорт завершен.
FAILED Не удалось выполнить экспорт.
IN_PROGRESS Выполняется экспорт.

ExportStats

Информация о ходе экспорта.

JSON-представление 
{
  "exportedArtifactCount": string,
  "totalArtifactCount": string,
  "sizeInBytes": string
}
Поля
exportedArtifactCount

string (int64 format)

Количество сообщений или файлов, уже обработанных для экспорта.
totalArtifactCount

string (int64 format)

Количество сообщений или файлов, которые нужно экспортировать.
sizeInBytes

string (int64 format)

Размер экспортируемых данных в байтах.

CloudStorageSink

Приемник экспорта для файлов Cloud Storage.

JSON-представление 
{
  "files": [
    {
      object (CloudStorageFile)
    }
  ]
}
Поля
files[]

object (CloudStorageFile)

Только для вывода. Экспортированные файлы в Cloud Storage.

CloudStorageFile

Экспортированный файл в Cloud Storage

JSON-представление 
{
  "bucketName": string,
  "objectName": string,
  "size": string,
  "md5Hash": string
}
Поля
bucketName

string

Название сегмента Cloud Storage для экспортируемого файла. Это значение можно использовать в JSON API или XML API Cloud Storage, но не для просмотра содержимого сегмента. Вместо этого вы можете получить отдельные файлы экспорта по названию объекта.
objectName

string

Название объекта Cloud Storage для экспортируемого файла. Это значение можно использовать в JSON API или XML API Cloud Storage.
size

string (int64 format)

Размер экспортируемого файла.
md5Hash

string

Хеш MD5 файла.

Методы

create

 Создает экспорт.

delete

 Удаляет экспорт.

get

 Получает экспорт.

list

 Показывает сведения об экспорте в указанном деле.