REST Resource: matters.exports

资源:Export

导出。

如需使用保险柜资源,该账号必须拥有所需的保险柜权限,并且有权访问相应诉讼。如要访问诉讼或调查,账号必须是诉讼或调查的创建者、诉讼或调查的共享对象,或者拥有查看所有诉讼或调查权限。

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)

仅限输出。导出任务的创建时间。

采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 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)

仅限输出。有关导出进度和大小的详细信息。

导出接收器类型。以下是互斥字段的列表。在响应中,最多只能设置其中一个字段:
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)

可用于导出 Google 日历。

geminiOptions

object (GeminiExportOptions)

Gemini 应用导出功能提供的选项。

geminiInWorkspaceOptions

object (GeminiInWorkspaceExportOptions)

Workspace 中的 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、群组、Hangouts 和 Voice。
PST 导出为 PST。仅适用于 Gmail、群组、Hangouts、Voice 和日历。
ICS 导出为 ICS。仅适用于 Google 日历。
XML 导出为 XML。仅适用于 Gemini 应用。
JSON 导出为 JSON。仅适用于 Gemini in 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

Workspace 中的 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

列出指定诉讼中的导出操作的详细信息。