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, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "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)

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

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

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

טיפוסים בני מנייה (enums)
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

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

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

enum (ExportFormat)

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

ExportRegion

האזור לשמירת הנתונים לייצוא.

טיפוסים בני מנייה (enums)
EXPORT_REGION_UNSPECIFIED האזור לא צוין. ברירת המחדל היא Any.
ANY כל אזור.
US אזור ארצות הברית.
EUROPE אזור אירופה.

ExportStatus

סטטוס הייצוא.

טיפוסים בני מנייה (enums)
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. אפשר להשתמש בערך הזה ב-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

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