REST Resource: matters.exports

Tài nguyên: Xuất

Một tệp xuất.

Để sử dụng các tài nguyên trên Vault, tài khoản phải có các đặc quyền bắt buộc đối với Vault và quyền truy cập vào vụ việc. Để 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ã vấn đề.
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. Tham số này chỉ được đặt trên tệp dữ liệu xuất phụ.
name

string

Tên tệp xuất. Đừng 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.
query

object (Query)

Các tham số truy vấn được dùng để tạo tệp xuất.
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 hoạt động 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 xuất.
Trường nhóm export_sink. Loại đích xuất. export_sink chỉ có thể là một trong những trạng thái sau:
cloudStorageSink

object (CloudStorageSink)

Chỉ có đầu ra. Nguồn nhận cho các tệp xuất trong Cloud Storage.

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 để 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)
  }
}
Trường
region

enum (ExportRegion)

Vùng dữ liệu được yêu cầu để xuất.
Trường nhóm corpus_export_options. Các lựa chọn dành riêng cho dịch vụ để xuất dữ liệu. corpus_export_options chỉ có thể là một trong những trạng thái sau:
mailOptions

object (MailExportOptions)

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

object (GroupsExportOptions)

Các lựa chọn để xuất dữ liệu nhóm.
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 trên Chat.
voiceOptions

object (VoiceExportOptions)

Các lựa chọn xuất dữ liệu bằng giọng nói.
calendarOptions

object (CalendarExportOptions)

Có thể xuất Lịch.
geminiOptions

object (GeminiExportOptions)

Lựa chọn xuất dữ liệu có trong Gemini.

MailExportOptions

Các lựa chọn để xuất dữ liệu trong 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 thư đã 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 dữ liệu 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ùng được cho Gmail, Groups, Hangouts và Voice.
PST Xuất dưới dạng PST. Chỉ dùng được cho Gmail, Groups, Hangouts, Voice và Lịch.
ICS Xuất dưới dạng ICS. Chỉ có trong Lịch.
XML Xuất dưới dạng XML. Chỉ có trong Gemini.

GroupsExportOptions

Các lựa chọn để xuất nhóm.

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

enum (ExportFormat)

Định dạng tệp cho thư đã 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 trên Chat.

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

enum (ExportFormat)

Định dạng tệp cho thư đã xuất.

VoiceExportOptions

Các lựa chọn để xuất giọng nói.

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 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 của Gemini.

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

enum (ExportFormat)

Định dạng tệp cho thư đã xuất.

ExportRegion

Vùng dữ liệu để xuất.

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

ExportStatus

Trạng thái của hoạt động 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 Đang xuất.

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 thư 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

Nguồn xuất 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 được 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 JSON API hoặc XML API của Cloud Storage, nhưng không thể dùng để liệt kê nội dung của 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 JSON API hoặc XML API 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ề dữ liệu xuất trong vấn đề được chỉ định.