- משאב: ייצוא
- UserInfo
- ExportOptions
- MailExportOptions
- ExportFormat
- GroupsExportOptions
- DriveExportOptions
- HangoutsChatExportOptions
- VoiceExportOptions
- CalendarExportOptions
- ExportRegion
- ExportStatus
- ExportStats
- CloudStorageSink
- CloudStorageFile
- שיטות
משאב: ייצוא
ייצוא.
כדי לעבוד עם המשאבים של Vault, לחשבון צריכות להיות ההרשאות הנדרשות ב-Vault וגישה לעניין. כדי לגשת לעניין, צריך שהחשבון יצר את העניין, לשתף איתו את העניין או לקבל הרשאה להצגת כל העניינים.
ייצוג JSON |
---|
{ "id": string, "matterId": string, "parentExportId": string, "name": string, "requester": { object ( |
שדות | |
---|---|
id |
פלט בלבד. מזהה הייצוא שנוצר. |
matterId |
פלט בלבד. מזהה העניין. |
parentExportId |
פלט בלבד. מזהה את הייצוא ברמת ההורה שהוביל לייצוא הצאצא הזה. ההגדרה הזו מוגדרת רק לייצוא של חשבונות צאצא. |
name |
שם הייצוא אל תשתמשו בתווים מיוחדים (~!$'(),;@:/?) בשם, הם עלולים למנוע מכם להוריד את הקבצים שיוצאו. |
requester |
פלט בלבד. שם המבקש לייצוא. |
query |
הפרמטרים של השאילתה ששימשו ליצירת הייצוא. |
exportOptions |
אפשרויות ייצוא נוספות. |
createTime |
פלט בלבד. השעה שבה נוצר הייצוא. חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
status |
פלט בלבד. סטטוס הייצוא. |
stats |
פלט בלבד. פרטים על ההתקדמות בייצוא ועל הגודל שלו. |
cloudStorageSink |
פלט בלבד. ה-sink לקובצי ייצוא ב-Cloud Storage. |
UserInfo
פרטי המשתמש.
ייצוג JSON |
---|
{ "email": string, "displayName": string } |
שדות | |
---|---|
email |
כתובת האימייל של המשתמש. |
displayName |
השם המוצג של המשתמש. |
ExportOptions
אפשרויות נוספות לייצוא
ייצוג JSON |
---|
{ "region": enum ( |
שדות | |
---|---|
region |
אזור הנתונים המבוקש לייצוא. |
שדה איחוד corpus_export_options . אפשרויות ייצוא ספציפיות לשירות. corpus_export_options יכול להיות רק אחת מהאפשרויות הבאות: |
|
mailOptions |
אפשרויות לייצוא של Gmail. |
groupsOptions |
אפשרויות לייצוא של קבוצות Google. |
driveOptions |
אפשרויות לייצוא מ-Drive. |
hangoutsChatOptions |
האפשרויות לייצוא של Chat. |
voiceOptions |
אפשרויות לייצוא של Voice. |
calendarOptions |
האפשרות זמינה לייצוא היומן. |
MailExportOptions
אפשרויות לייצוא של Gmail.
ייצוג JSON |
---|
{
"exportFormat": enum ( |
שדות | |
---|---|
exportFormat |
פורמט הקובץ להודעות שיוצאו. |
showConfidentialModeContent |
כדי לייצא תוכן ממצב סודי, מגדירים את הערך true. |
useNewExport |
כדי להשתמש במערכת הייצוא החדשה, מגדירים את הערך true. |
exportLinkedDriveFiles |
זה שינוי אופציונלי. כדי להפעיל את הייצוא של קובצי 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 |
פורמט הקובץ להודעות שיוצאו. |
DriveExportOptions
אפשרויות לייצוא מ-Drive.
ייצוג JSON |
---|
{ "includeAccessInfo": boolean } |
שדות | |
---|---|
includeAccessInfo |
כדי לכלול פרטי רמת גישה של משתמשים עם גישה עקיפה לקבצים, צריך להגדיר את הערך true. |
HangoutsChatExportOptions
אפשרויות לייצוא של Chat.
ייצוג JSON |
---|
{
"exportFormat": enum ( |
שדות | |
---|---|
exportFormat |
פורמט הקובץ להודעות שיוצאו. |
VoiceExportOptions
האפשרויות לייצוא מ-Voice.
ייצוג JSON |
---|
{
"exportFormat": enum ( |
שדות | |
---|---|
exportFormat |
פורמט הקובץ של הודעות טקסט שיוצאו. |
CalendarExportOptions
האפשרויות לייצוא יומן.
ייצוג JSON |
---|
{
"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 |
מספר ההודעות או הקבצים שכבר עובדו לייצוא. |
totalArtifactCount |
מספר ההודעות או הקבצים לייצוא. |
sizeInBytes |
גודל הייצוא בבייטים. |
CloudStorageSink
ייצוא sink לקובצי Cloud Storage.
ייצוג JSON |
---|
{
"files": [
{
object ( |
שדות | |
---|---|
files[] |
פלט בלבד. הקבצים שאתם מייצאים ב-Cloud Storage. |
CloudStorageFile
קובץ הייצוא ב-Cloud Storage
ייצוג JSON |
---|
{ "bucketName": string, "objectName": string, "size": string, "md5Hash": string } |
שדות | |
---|---|
bucketName |
שם הקטגוריה של Cloud Storage לקובץ הייצוא. אפשר להשתמש בערך הזה ב-API בפורמט JSON או ב-API בפורמט XML של Cloud Storage, אבל לא כדי להציג את תוכן הקטגוריה. במקום זאת, אפשר לקבל קובצי ייצוא נפרדים לפי שם האובייקט. |
objectName |
שם האובייקט של Cloud Storage של קובץ הייצוא. אפשר להשתמש בערך הזה ב-API בפורמט JSON או ב-API בפורמט XML ב-Cloud Storage. |
size |
גודל הקובץ לייצוא. |
md5Hash |
גיבוב md5 של הקובץ. |
שיטות |
|
---|---|
|
יצירת ייצוא. |
|
מחיקת ייצוא. |
|
מקבל ייצוא. |
|
בתיבת הדו-שיח הזו מפורטים פרטים על פעולות הייצוא בעניין שצוין. |