REST Resource: matters.exports

แหล่งข้อมูล: ส่งออก

การส่งออก

หากต้องการทำงานกับทรัพยากรของห้องนิรภัย บัญชีต้องมีสิทธิ์ของห้องนิรภัยที่จําเป็นและการเข้าถึงเคส หากต้องการเข้าถึงเคส บัญชีต้องเป็นผู้สร้างเคส มีเคสที่แชร์กับตน หรือมีสิทธิ์ดูเคสทั้งหมด

การแสดง 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

เอาต์พุตเท่านั้น รหัสการส่งออกที่สร้างขึ้น
matterId

string

เอาต์พุตเท่านั้น รหัสเคส
parentExportId

string

เอาต์พุตเท่านั้น ระบุการส่งออกหลักที่สร้างการส่งออกย่อยนี้ ซึ่งตั้งค่าได้เฉพาะในการส่งออกย่อยเท่านั้น
name

string

ชื่อการส่งออก อย่าใช้สัญลักษณ์พิเศษ (~!$'(),;@:/?) ในชื่อ เพราะอาจทำให้คุณไม่สามารถดาวน์โหลดการส่งออกได้
requester

object (UserInfo)

เอาต์พุตเท่านั้น ผู้ขอส่งออก
query

object (Query)

พารามิเตอร์การค้นหาที่ใช้สร้างการส่งออก
exportOptions

object (ExportOptions)

ตัวเลือกการส่งออกเพิ่มเติม
createTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่สร้างการส่งออก

ใช้ RFC 3339 ซึ่งเอาต์พุตที่สร้างขึ้นจะเป็นรูปแบบ Z-normalized เสมอ และใช้ตัวเลขทศนิยม 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)

ตัวเลือกการส่งออก Groups
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

รูปแบบการส่งออกสำหรับข้อความ

Enum
EXPORT_FORMAT_UNSPECIFIED ไม่ได้ระบุรูปแบบการส่งออก
MBOX ส่งออกเป็น MBOX ใช้ได้กับ Gmail, Groups, Hangouts และ Voice เท่านั้น
PST ส่งออกเป็น PST ใช้ได้กับ Gmail, Groups, Hangouts, Voice และปฏิทินเท่านั้น
ICS ส่งออกเป็น ICS ใช้ได้กับปฏิทินเท่านั้น
XML ส่งออกเป็น XML ใช้ได้กับ Gemini เท่านั้น

GroupsExportOptions

ตัวเลือกการส่งออก Groups

การแสดง 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

เขตข้อมูลสําหรับการส่งออก

Enum
EXPORT_REGION_UNSPECIFIED ไม่ได้ระบุภูมิภาค ค่าเริ่มต้นคือ ANY
ANY ทุกภูมิภาค
US ภูมิภาคสหรัฐอเมริกา
EUROPE ภูมิภาคยุโรป

ExportStatus

สถานะการส่งออก

Enum
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 สำหรับไฟล์ส่งออก คุณสามารถใช้ค่านี้ใน JSON API หรือ XML API ของ Cloud Storage แต่ใช้เพื่อแสดงรายการเนื้อหาของที่เก็บข้อมูลไม่ได้ แต่คุณสามารถรับไฟล์ส่งออกแต่ละไฟล์ตามชื่อออบเจ็กต์แทนได้
objectName

string

ชื่อออบเจ็กต์ Cloud Storage สำหรับไฟล์ส่งออก คุณสามารถใช้ค่านี้ใน JSON API หรือ XML API ของ Cloud Storage
size

string (int64 format)

ขนาดไฟล์ที่ส่งออก
md5Hash

string

แฮช MD5 ของไฟล์

เมธอด

create

 สร้างการส่งออก

delete

 ลบการส่งออก

get

 รับการส่งออก

list

 แสดงรายละเอียดเกี่ยวกับการส่งออกในเคสที่ระบุ