REST Resource: matters.exports

Tài nguyên: Xuất

Một tệp xuất.

Để xử lý các tài nguyên trong 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ấn đề. Để truy cập vào một vấn đề, tài khoản phải là người 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)
  },

  // 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.
}
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 xuất dữ liệu gốc đã tạo ra tệp xuất dữ liệu con này. Bạn chỉ có thể đặt thuộc tính này trên tệp xuất phụ.
name

string

Tên tệp xuất. Đừng sử dụng các ký tự đặc biệt (~!$'(),;@:/?) trong tên, vì chúng 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.
exportOptions

object (ExportOptions)

Các tuỳ chọn xuất khác.
createTime

string (Timestamp format)

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

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo Z và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ dời 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 xuất.
Trường hợp hợp nhất export_sink. Loại bồn lưu trữ xuất. export_sink chỉ có thể là một trong những loại sau:
cloudStorageSink

object (CloudStorageSink)

Chỉ có đầu ra. Vùng chứa 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 tuỳ chọn khác để xuất

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

enum (ExportRegion)

Khu vực dữ liệu được yêu cầu để xuất.
Trường hợp hợp nhất corpus_export_options. Các tuỳ 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 loại sau:
mailOptions

object (MailExportOptions)

Các tuỳ chọn để xuất dữ liệu sang Gmail.
groupsOptions

object (GroupsExportOptions)

Các tuỳ chọn để xuất Nhóm.
driveOptions

object (DriveExportOptions)

Các tuỳ chọn xuất dữ liệu trên Drive.
hangoutsChatOptions

object (HangoutsChatExportOptions)

Các tuỳ chọn để xuất dữ liệu từ Chat.
voiceOptions

object (VoiceExportOptions)

Các tuỳ chọn xuất nội dung bằng giọng nói.
calendarOptions

object (CalendarExportOptions)

Có tuỳ chọn xuất Lịch.
geminiOptions

object (GeminiExportOptions)

Có lựa chọn xuất sang Gemini.

MailExportOptions

Các tuỳ chọn để xuất dữ liệu sang 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ư đượ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 thư

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ỉ dành cho Lịch.
XML Xuất dưới dạng XML. Chỉ dành cho Gemini.

GroupsExportOptions

Các tuỳ 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ư được xuất.

DriveExportOptions

Các tuỳ 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

Để đưa 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 tuỳ chọn để xuất dữ liệu từ 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ư được xuất.

VoiceExportOptions

Các tuỳ chọn xuất nội dung bằng 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 tuỳ 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 tuỳ chọn xuất 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ư được xuất.

ExportRegion

Khu vực dữ liệu để xuất.

Enum
EXPORT_REGION_UNSPECIFIED Khu vực chưa được chỉ định. Giá trị mặc định là BẤT KỲ.
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 quá trình xuất.

Enum
EXPORT_STATUS_UNSPECIFIED Trạng thái không xác định.
COMPLETED Quá trình xuất đã hoàn tất.
FAILED Không xuất được dữ liệu.
IN_PROGRESS Quá trình xuất đang diễn ra.

ExportStats

Thông tin 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 thư 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

Vùng xuất cho tệp 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 của bộ chứa. Thay vào đó, bạn có thể tải 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

 Nhận dữ liệu xuất.

list

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