REST Resource: matters.exports

משאב: ייצוא

ייצוא.

כדי לעבוד עם משאבים ב-Vault, לחשבון צריכות להיות הרשאות Vault הנדרשות וגישה לעניין. כדי לגשת לתיק, החשבון צריך ליצור את התיק, לקבל שיתוף של התיק או לקבל את ההרשאה View All Matters.

ייצוג ב-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)

פלט בלבד. השעה שבה נוצר הייצוא.

הפונקציה משתמשת ב-RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 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),

  "mailOptions": {
    object (MailExportOptions)
  },
  "groupsOptions": {
    object (GroupsExportOptions)
  },
  "driveOptions": {
    object (DriveExportOptions)
  },
  "hangoutsChatOptions": {
    object (HangoutsChatExportOptions)
  },
  "voiceOptions": {
    object (VoiceExportOptions)
  },
  "calendarOptions": {
    object (CalendarExportOptions)
  },
  "geminiOptions": {
    object (GeminiExportOptions)
  }
}
שדות
region

enum (ExportRegion)

אזור הנתונים המבוקש לייצוא.
שדה איחוד corpus_export_options. אפשרויות ספציפיות לשירות לייצוא. הערך corpus_export_options יכול להיות רק אחד מהבאים:
mailOptions

object (MailExportOptions)

אפשרויות לייצוא מ-Gmail.
groupsOptions

object (GroupsExportOptions)

אפשרויות לייצוא של קבוצות.
driveOptions

object (DriveExportOptions)

אפשרויות לייצוא מ-Drive.
hangoutsChatOptions

object (HangoutsChatExportOptions)

אפשרויות לייצוא של Chat.
voiceOptions

object (VoiceExportOptions)

אפשרויות לייצוא של קולות.
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

אופציונלי. כדי להפעיל ייצוא של קבצים מקושרים ב-Drive, מגדירים את האפשרות ל-true.

ExportFormat

פורמט הייצוא של ההודעות

טיפוסים בני מנייה (enum)
EXPORT_FORMAT_UNSPECIFIED לא צוין פורמט ייצוא.
MBOX מייצאים כקובץ MBOX. האפשרות זמינה רק ב-Gmail, בקבוצות Google, ב-Hangouts וב-Voice.
PST ייצוא כקובץ PST. האפשרות זמינה רק ב-Gmail, בקבוצות Google, ב-Hangouts, ב-Voice וביומן.
ICS ייצוא כקובץ ICS. האפשרות הזו זמינה רק ביומן.
XML מייצאים כקובץ XML. האפשרות זמינה רק ב-Gemini.

GroupsExportOptions

אפשרויות לייצוא של קבוצות.

ייצוג ב-JSON 
{
  "exportFormat": enum (ExportFormat)
}
שדות
exportFormat

enum (ExportFormat)

פורמט הקובץ של ההודעות המיוצאות.

DriveExportOptions

אפשרויות לייצוא מ-Drive.

ייצוג ב-JSON 
{
  "includeAccessInfo": boolean
}
שדות
includeAccessInfo

boolean

כדי לכלול מידע על רמות גישה למשתמשים עם גישה עקיפה לקבצים, צריך להגדיר את הערך true.

HangoutsChatExportOptions

אפשרויות לייצוא של Chat.

ייצוג ב-JSON 
{
  "exportFormat": enum (ExportFormat)
}
שדות
exportFormat

enum (ExportFormat)

פורמט הקובץ של ההודעות המיוצאות.

VoiceExportOptions

האפשרויות לייצוא של קולות.

ייצוג ב-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 של קובץ הייצוא. אפשר להשתמש בערך הזה ב-API בפורמט JSON או ב-API בפורמט XML של Cloud Storage, אבל אי אפשר להשתמש בו כדי להציג את תוכן הקטגוריה. במקום זאת, אפשר לקבל קובצי ייצוא נפרדים לפי שם האובייקט.
objectName

string

השם של האובייקט ב-Cloud Storage של קובץ הייצוא. אפשר להשתמש בערך הזה ב-API בפורמט JSON או ב-API בפורמט XML של Cloud Storage.
size

string (int64 format)

גודל קובץ הייצוא.
md5Hash

string

גיבוב md5 של הקובץ.

Methods

create

 יצירת ייצוא.

delete

 מחיקת ייצוא.

get

 קבלת ייצוא.

list

 מוצגים פרטים על הייצוא בעניין שצוין.