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)
  },

  // 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.
}
Поля
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 дробных цифр. Также принимаются смещения, отличные от «Z». Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

status

enum ( ExportStatus )

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

stats

object ( ExportStats )

Только вывод. Подробная информация о ходе и размере экспорта.

Поле объединения export_sink . Экспортный тип раковины. export_sink может быть только одним из следующих:
cloudStorageSink

object ( CloudStorageSink )

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

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

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

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

string

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

displayName

string

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

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

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

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

enum ( ExportRegion )

Запрошенная область данных для экспорта.

Поле объединения corpus_export_options . Параметры экспорта для конкретных услуг. corpus_export_options может быть только одним из следующих:
mailOptions

object ( MailExportOptions )

Варианты экспорта Gmail.

groupsOptions

object ( GroupsExportOptions )

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

driveOptions

object ( DriveExportOptions )

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

hangoutsChatOptions

object ( HangoutsChatExportOptions )

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

voiceOptions

object ( VoiceExportOptions )

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

calendarOptions

object ( CalendarExportOptions )

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

geminiOptions

object ( GeminiExportOptions )

Опция доступна для экспорта Gemini.

MailExportOptions

Варианты экспорта Gmail.

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

enum ( ExportFormat )

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

showConfidentialModeContent

boolean

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

useNewExport

boolean

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

exportLinkedDriveFiles

boolean

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

ЭкспортФормат

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

Перечисления
EXPORT_FORMAT_UNSPECIFIED Не указан формат экспорта.
MBOX Экспортировать как MBOX. Доступно только для Gmail, групп, Hangouts и Voice.
PST Экспортировать в формате PST. Доступно только для Gmail, групп, Hangouts, Voice и календаря.
ICS Экспортировать как ICS. Доступно только для Календаря.
XML Экспортировать в формате XML. Доступно только для Близнецов.

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

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

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

enum ( ExportFormat )

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

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

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

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

boolean

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

HangoutsChatExportOptions

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

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

enum ( ExportFormat )

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

Параметры голосового экспорта

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

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

enum ( ExportFormat )

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

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

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

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

enum ( ExportFormat )

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

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

Варианты экспорта Gemini.

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

enum ( ExportFormat )

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

ЭкспортРегион

Область данных для экспорта.

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

Экспортстатус

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

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

Экспортстатс

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

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

string ( int64 format)

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

totalArtifactCount

string ( int64 format)

Количество сообщений или файлов для экспорта.

sizeInBytes

string ( int64 format)

Размер экспорта в байтах.

ОблакоХранениеРаковина

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

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

object ( CloudStorageFile )

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

ОблакоХранилищеФайл

Файл экспорта в 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

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