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)

僅供輸出。建立匯出作業的時間。

RFC3339 世界標準時間「Zulu」的時間戳記格式，解析度為奈秒，且最多 9 個小數位數。範例："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)

提供 Google 日曆匯出的選項。

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 和 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

 列出指定案件中匯出項目的詳細資料。