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

仅限输出。生成的导出 ID。
matterId

string

仅限输出。相关事项 ID。
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 中导出文件的接收器。

UserInfo

用户的信息。

JSON 表示法 
{
  "email": string,
  "displayName": string
}
字段
email

string

用户的电子邮件地址。
displayName

string

用户的显示名称。

ExportOptions

导出的其他选项

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)

Chat 导出选项。
voiceOptions

object (VoiceExportOptions)

Voice 导出选项。
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。

ExportFormat

消息的导出格式

枚举
EXPORT_FORMAT_UNSPECIFIED 未指定导出格式。
MBOX 导出为 MBOX。仅适用于 Gmail、Google 群组、Hangouts 和 Google Voice。
PST 导出为 PST 文件。仅适用于 Gmail、群组、Hangouts、Voice 和 Google 日历。
ICS 导出为 ICS。仅适用于日历。
XML 导出为 XML。仅适用于 Gemini。

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)

导出消息的文件格式。

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 存储分区的名称。您可以在 Cloud Storage JSON API 或 XML API 中使用此值，但不能用于列出存储分区内容。不过，您可以按对象名称获取单个导出文件。
objectName

string

导出文件的 Cloud Storage 对象的名称。您可以在 Cloud Storage JSON API 或 XML API 中使用此值。
size

string (int64 format)

导出文件的大小。
md5Hash

string

文件的 md5 哈希。

方法

create

 创建导出内容。

delete

 删除导出内容。

get

 获取导出内容。

list

 列出指定事项中的导出内容的详细信息。