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

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

string

仅限输出。诉讼或调查的 ID。
parentExportId

string

仅限输出。标识生成此子级导出的父级导出。此选项仅适用于子级导出内容。
name

string

导出作业名称。请勿在名称中使用特殊字符 (~!$'(),;@:/?)，否则可能会导致您无法下载导出内容。
requester

object (UserInfo)

仅限输出。导出请求者。
query

object (Query)

用于创建导出的查询参数。
exportOptions

object (ExportOptions)

其他导出选项。
createTime

string (Timestamp format)

仅限输出。导出操作的创建时间。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
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),

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

适用于导出日历的选项。

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 和 Voice。
PST 以 PST 格式导出。仅适用于 Gmail、Google 群组、Hangouts、Google Voice 和 Google 日历。
ICS 以 ICS 格式导出。仅适用于 Google 日历。

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)

导出的文本消息的文件格式。

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

 列出指定诉讼或调查中的导出作业的详细信息。