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

  // 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、網路論壇、Hangouts 和 Google 語音。
PST 匯出為 PST。僅適用於 Gmail、Google 網路論壇、Hangouts、Google 語音和日曆。
ICS 匯出為 ICS 格式。僅適用於 Google 日曆。
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

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