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)
  },

  "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)

פלט בלבד. פרטים על ההתקדמות והגודל של הייצוא.
סוג יעד הייצוא. זו רשימה של שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
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)
  },
  "geminiInWorkspaceOptions": {
    object (GeminiInWorkspaceExportOptions)
  }
}
שדות
region

enum (ExportRegion)

האזור הגיאוגרפי לאחסון נתונים שביקשתם לייצא.
אפשרויות ספציפיות לשירות לייצוא. זו רשימה של שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
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.
geminiInWorkspaceOptions

object (GeminiInWorkspaceExportOptions)

אפשרות זמינה לייצוא של Gemini ב-Workspace.
סוף השדות שמוציאים זה את זה.

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 Groups, ב-Hangouts וב-Voice.
PST ייצוא כקובץ PST. האפשרות זמינה רק ב-Gmail, ב-Groups, ב-Hangouts, ב-Voice וביומן Google.
ICS ייצוא כקובץ ICS. האפשרות הזו זמינה רק ביומן.
XML ייצוא כקובץ XML. זמינה רק באפליקציית Gemini.
JSON ייצוא כ-JSON. זמין רק ב-Gemini ב-Workspace.

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)

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

CalendarExportOptions

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

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

enum (ExportFormat)

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

GeminiExportOptions

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

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

enum (ExportFormat)

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

GeminiInWorkspaceExportOptions

האפשרויות לייצוא מ-Gemini ב-Workspace.

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

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