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)

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

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
status

enum (ExportStatus)

פלט בלבד. סטטוס הייצוא.
stats

object (ExportStats)

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

object (CloudStorageSink)

פלט בלבד. ה-sink לקובצי ייצוא ב-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)

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

object (DriveExportOptions)

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

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

ExportFormat

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

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

GroupsExportOptions

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

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

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

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

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

שיטות

create

 יצירת ייצוא.

delete

 מחיקת ייצוא.

get

 מקבל ייצוא.

list

 בתיבת הדו-שיח הזו מפורטים פרטים על פעולות הייצוא בעניין שצוין.