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)
  },
  "cloudStorageSink": {
    object (CloudStorageSink)
  }
}
ช่อง
id

string

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

string

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

string

เอาต์พุตเท่านั้น ระบุการส่งออกระดับบนสุดที่สร้างการส่งออกย่อยนี้ การตั้งค่านี้จะตั้งค่าในการส่งออกย่อยเท่านั้น
name

string

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

object (UserInfo)

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

object (Query)

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

object (ExportOptions)

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

string (Timestamp format)

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

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขเศษส่วนได้สูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
status

enum (ExportStatus)

เอาต์พุตเท่านั้น สถานะของการส่งออก
stats

object (ExportStats)

เอาต์พุตเท่านั้น รายละเอียดเกี่ยวกับความคืบหน้าและขนาดในการส่งออก
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)
  }
  // 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)

ตัวเลือกสำหรับการส่งออกปฏิทิน

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 ใช้ได้กับปฏิทินเท่านั้น

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)

รูปแบบไฟล์สำหรับข้อความที่ส่งออก

ExportRegion

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

Enum
EXPORT_REGION_UNSPECIFIED ไม่ได้ระบุภูมิภาค ค่าเริ่มต้นคือ "ใดๆ"
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

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