REST Resource: matters.exports

משאב: ייצוא

ייצוא.

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

ייצוג ב-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 וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד '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)

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

object (DriveExportOptions)

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

object (HangoutsChatExportOptions)

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

object (VoiceExportOptions)

אפשרויות לייצוא של Voice.
calendarOptions

object (CalendarExportOptions)

אפשרות זמינה לייצוא מיומן Google.
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 וביומן Google.
ICS מייצאים כקובץ ICS. האפשרות הזו זמינה רק ביומן Google.
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

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

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

enum (ExportFormat)

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

CalendarExportOptions

האפשרויות לייצוא מיומן Google.

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

ייצוא של Sink לקובצי 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

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