REST Resource: matters.exports

Tài nguyên: Xuất

Một tệp xuất.

Để làm việc với các tài nguyên của Vault, tài khoản phải có các đặc quyền cần thiết trong Vault và có quyền truy cập vào tài liệu lưu trữ. Để truy cập vào một vấn đề, tài khoản phải là tài khoản đã tạo vấn đề đó, được chia sẻ vấn đề đó hoặc có đặc quyền Xem tất cả vấn đề.

Biểu diễn dưới dạng 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)
  }
}
Trường
id

string

Chỉ có đầu ra. Mã xuất được tạo.
matterId

string

Chỉ có đầu ra. Mã yêu cầu.
parentExportId

string

Chỉ có đầu ra. Xác định tệp dữ liệu xuất chính đã tạo ra tệp dữ liệu xuất phụ này. Trạng thái này chỉ được đặt trên các tệp dữ liệu xuất phụ.
name

string

Tên của tệp xuất. Đừng sử dụng các ký tự đặc biệt (~!$'(),;@:/?) trong tên vì các ký tự này có thể khiến bạn không tải được tệp xuất xuống.
requester

object (UserInfo)

Chỉ có đầu ra. Người yêu cầu xuất dữ liệu.
query

object (Query)

Các tham số truy vấn dùng để tạo tệp xuất dữ liệu.
exportOptions

object (ExportOptions)

Các lựa chọn xuất khác.
createTime

string (Timestamp format)

Chỉ có đầu ra. Thời điểm tạo tệp xuất.

Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".
status

enum (ExportStatus)

Chỉ có đầu ra. Trạng thái của quá trình xuất.
stats

object (ExportStats)

Chỉ có đầu ra. Thông tin chi tiết về tiến trình và kích thước của tệp xuất.
Loại bồn lưu trữ dữ liệu xuất. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
cloudStorageSink

object (CloudStorageSink)

Chỉ có đầu ra. Bộ chứa cho các tệp xuất trong Cloud Storage.
Kết thúc các trường loại trừ lẫn nhau.

UserInfo

Thông tin của người dùng.

Biểu diễn dưới dạng JSON 
{
  "email": string,
  "displayName": string
}
Trường
email

string

Địa chỉ email của người dùng.
displayName

string

Tên hiển thị của người dùng.

ExportOptions

Các lựa chọn khác cho tệp xuất

Biểu diễn dưới dạng 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)
  }
}
Trường
region

enum (ExportRegion)

Khu vực lưu trữ dữ liệu được yêu cầu cho tệp xuất.
Các lựa chọn xuất dành riêng cho dịch vụ. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
mailOptions

object (MailExportOptions)

Các lựa chọn để xuất dữ liệu Gmail.
groupsOptions

object (GroupsExportOptions)

Các lựa chọn xuất dữ liệu của Groups.
driveOptions

object (DriveExportOptions)

Các lựa chọn xuất dữ liệu trên Drive.
hangoutsChatOptions

object (HangoutsChatExportOptions)

Các lựa chọn xuất dữ liệu trong Chat.
voiceOptions

object (VoiceExportOptions)

Các lựa chọn xuất dữ liệu Voice.
calendarOptions

object (CalendarExportOptions)

Lựa chọn có sẵn để xuất Lịch.
geminiOptions

object (GeminiExportOptions)

Lựa chọn có sẵn để xuất dữ liệu từ ứng dụng Gemini.
geminiInWorkspaceOptions

object (GeminiInWorkspaceExportOptions)

Lựa chọn có thể dùng để xuất dữ liệu Gemini trong Workspace.
Kết thúc các trường loại trừ lẫn nhau.

MailExportOptions

Các lựa chọn để xuất dữ liệu Gmail.

Biểu diễn dưới dạng JSON 
{
  "exportFormat": enum (ExportFormat),
  "showConfidentialModeContent": boolean,
  "useNewExport": boolean,
  "exportLinkedDriveFiles": boolean
}
Trường
exportFormat

enum (ExportFormat)

Định dạng tệp cho tin nhắn được xuất.
showConfidentialModeContent

boolean

Để xuất nội dung ở chế độ bảo mật, hãy đặt thành true.
useNewExport

boolean

Để sử dụng hệ thống xuất mới, hãy đặt thành true.
exportLinkedDriveFiles

boolean

Không bắt buộc. Để bật tính năng xuất các tệp được liên kết trên Drive, hãy đặt thành true.

ExportFormat

Định dạng xuất cho tin nhắn

Enum
EXPORT_FORMAT_UNSPECIFIED Chưa chỉ định định dạng xuất.
MBOX Xuất dưới dạng MBOX. Chỉ dành cho Gmail, Groups, Hangouts và Voice.
PST Xuất dưới dạng tệp PST. Chỉ dành cho Gmail, Groups, Hangouts, Voice và Lịch.
ICS Xuất dưới dạng tệp ICS. Chỉ dành cho Lịch.
XML Xuất dưới dạng XML. Chỉ dùng được cho ứng dụng Gemini.
JSON Xuất dưới dạng JSON. Chỉ dành cho Gemini trong Workspace.

GroupsExportOptions

Các lựa chọn xuất dữ liệu của Groups.

Biểu diễn dưới dạng JSON 
{
  "exportFormat": enum (ExportFormat)
}
Trường
exportFormat

enum (ExportFormat)

Định dạng tệp cho tin nhắn được xuất.

DriveExportOptions

Các lựa chọn xuất dữ liệu trên Drive.

Biểu diễn dưới dạng JSON 
{
  "includeAccessInfo": boolean
}
Trường
includeAccessInfo

boolean

Để thêm thông tin về cấp truy cập cho những người dùng có quyền truy cập gián tiếp vào tệp, hãy đặt thành true.

HangoutsChatExportOptions

Các lựa chọn xuất dữ liệu trong Chat.

Biểu diễn dưới dạng JSON 
{
  "exportFormat": enum (ExportFormat)
}
Trường
exportFormat

enum (ExportFormat)

Định dạng tệp cho tin nhắn được xuất.

VoiceExportOptions

Các lựa chọn xuất dữ liệu Voice.

Biểu diễn dưới dạng JSON 
{
  "exportFormat": enum (ExportFormat)
}
Trường
exportFormat

enum (ExportFormat)

Định dạng tệp cho tin nhắn văn bản đã xuất.

CalendarExportOptions

Các lựa chọn xuất dữ liệu Lịch.

Biểu diễn dưới dạng JSON 
{
  "exportFormat": enum (ExportFormat)
}
Trường
exportFormat

enum (ExportFormat)

Định dạng tệp cho tin nhắn văn bản đã xuất.

GeminiExportOptions

Các lựa chọn xuất dữ liệu từ ứng dụng Gemini.

Biểu diễn dưới dạng JSON 
{
  "exportFormat": enum (ExportFormat)
}
Trường
exportFormat

enum (ExportFormat)

Định dạng tệp cho tin nhắn được xuất.

GeminiInWorkspaceExportOptions

Các lựa chọn xuất dữ liệu của Gemini trong Workspace.

Biểu diễn dưới dạng JSON 
{
  "exportFormat": enum (ExportFormat)
}
Trường
exportFormat

enum (ExportFormat)

Định dạng tệp cho tin nhắn được xuất.

ExportRegion

Khu vực lưu trữ dữ liệu cho tệp xuất.

Enum
EXPORT_REGION_UNSPECIFIED Khu vực chưa được chỉ định. Giá trị mặc định là ANY.
ANY Mọi khu vực.
US Khu vực Hoa Kỳ.
EUROPE Khu vực Châu Âu.

ExportStatus

Trạng thái của tệp xuất.

Enum
EXPORT_STATUS_UNSPECIFIED Trạng thái không xác định.
COMPLETED Đã xuất xong.
FAILED Không xuất được.
IN_PROGRESS Quá trình xuất đang diễn ra.

ExportStats

Thông tin về tiến trình xuất.

Biểu diễn dưới dạng JSON 
{
  "exportedArtifactCount": string,
  "totalArtifactCount": string,
  "sizeInBytes": string
}
Trường
exportedArtifactCount

string (int64 format)

Số lượng tin nhắn hoặc tệp đã được xử lý để xuất.
totalArtifactCount

string (int64 format)

Số lượng tin nhắn hoặc tệp cần xuất.
sizeInBytes

string (int64 format)

Kích thước của tệp xuất tính bằng byte.

CloudStorageSink

Xuất bồn lưu trữ cho các tệp trên Cloud Storage.

Biểu diễn dưới dạng JSON 
{
  "files": [
    {
      object (CloudStorageFile)
    }
  ]
}
Trường
files[]

object (CloudStorageFile)

Chỉ có đầu ra. Các tệp đã xuất trong Cloud Storage.

CloudStorageFile

Tệp xuất trong Cloud Storage

Biểu diễn dưới dạng JSON 
{
  "bucketName": string,
  "objectName": string,
  "size": string,
  "md5Hash": string
}
Trường
bucketName

string

Tên của bộ chứa Cloud Storage cho tệp xuất. Bạn có thể sử dụng giá trị này trong API JSON hoặc API XML của Cloud Storage, nhưng không thể dùng để liệt kê nội dung trong bộ chứa. Thay vào đó, bạn có thể lấy từng tệp xuất theo tên đối tượng.
objectName

string

Tên của đối tượng Cloud Storage cho tệp xuất. Bạn có thể sử dụng giá trị này trong API JSON hoặc API XML của Cloud Storage.
size

string (int64 format)

Kích thước tệp xuất.
md5Hash

string

Hàm băm md5 của tệp.

Phương thức

create

 Tạo một tệp xuất.

delete

 Xoá một tệp xuất.

get

 Lấy một tệp xuất.

list

 Liệt kê thông tin chi tiết về các tệp xuất trong vụ việc được chỉ định.