REST Resource: matters.exports

منبع: صادرات

یک صادرات

برای کار با منابع Vault، حساب باید دارای امتیازات Vault مورد نیاز و دسترسی به موضوع باشد. برای دسترسی به یک موضوع، حساب باید موضوع را ایجاد کرده باشد، موضوع را با آنها به اشتراک گذاشته باشد، یا دارای امتیاز View All Matters باشد.

نمایندگی 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 )

فقط خروجی سینک برای صادرات فایل ها در Cloud Storage.

اطلاعات کاربر

اطلاعات کاربر.

نمایندگی 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 )

گزینه هایی برای صادرات جیمیل.

groupsOptions

object ( GroupsExportOptions )

گزینه هایی برای صادرات گروه ها.

driveOptions

object ( DriveExportOptions )

گزینه‌هایی برای صادرات Drive.

hangoutsChatOptions

object ( HangoutsChatExportOptions )

گزینه هایی برای صادرات چت.

voiceOptions

object ( VoiceExportOptions )

گزینه هایی برای صادرات صدا.

calendarOptions

object ( CalendarExportOptions )

گزینه برای صادرات تقویم موجود است.

MailExportOptions

گزینه هایی برای صادرات جیمیل.

نمایندگی JSON
{
  "exportFormat": enum (ExportFormat),
  "showConfidentialModeContent": boolean,
  "useNewExport": boolean,
  "exportLinkedDriveFiles": boolean
}
زمینه های
exportFormat

enum ( ExportFormat )

فرمت فایل برای پیام های صادر شده

showConfidentialModeContent

boolean

برای صادر کردن محتوای حالت محرمانه، روی true تنظیم کنید.

useNewExport

boolean

برای استفاده از سیستم صادرات جدید، روی true تنظیم کنید.

exportLinkedDriveFiles

boolean

اختیاری. برای فعال کردن صادر کردن فایل‌های Drive مرتبط، روی true تنظیم کنید.

فرمت صادراتی

فرمت صادرات برای پیام ها

Enums
EXPORT_FORMAT_UNSPECIFIED هیچ قالب صادراتی مشخص نشده است.
MBOX صادرات به عنوان MBOX. فقط برای Gmail، Groups، Hangouts و Voice در دسترس است.
PST صادرات به عنوان PST. فقط برای Gmail، Groups، Hangouts، Voice و Calendar موجود است.
ICS صادرات به عنوان ICS. فقط برای تقویم موجود است.

GroupsExportOptions

گزینه هایی برای صادرات گروه ها.

نمایندگی JSON
{
  "exportFormat": enum (ExportFormat)
}
زمینه های
exportFormat

enum ( ExportFormat )

فرمت فایل برای پیام های صادر شده

DriveExportOptions

گزینه‌هایی برای صادرات Drive.

نمایندگی JSON
{
  "includeAccessInfo": boolean
}
زمینه های
includeAccessInfo

boolean

برای گنجاندن اطلاعات سطح دسترسی برای کاربرانی که دسترسی غیرمستقیم به فایل‌ها دارند، روی true تنظیم کنید.

HangoutsChatExportOptions

گزینه هایی برای صادرات چت.

نمایندگی JSON
{
  "exportFormat": enum (ExportFormat)
}
زمینه های
exportFormat

enum ( ExportFormat )

فرمت فایل برای پیام های صادر شده

VoiceExportOptions

گزینه های صادرات صدا.

نمایندگی JSON
{
  "exportFormat": enum (ExportFormat)
}
زمینه های
exportFormat

enum ( ExportFormat )

فرمت فایل برای پیام های متنی صادر شده.

CalendarExportOptions

گزینه های مربوط به صادرات تقویم.

نمایندگی JSON
{
  "exportFormat": enum (ExportFormat)
}
زمینه های
exportFormat

enum ( ExportFormat )

فرمت فایل برای پیام های متنی صادر شده.

منطقه صادراتی

منطقه داده برای صادرات.

Enums
EXPORT_REGION_UNSPECIFIED منطقه نامشخص است. پیش‌فرض به ANY.
ANY هر منطقه ای
US منطقه ایالات متحده
EUROPE منطقه اروپا

وضعیت صادرات

وضعیت صادرات

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

سینک را برای فایل‌های Cloud Storage صادر کنید.

نمایندگی JSON
{
  "files": [
    {
      object (CloudStorageFile)
    }
  ]
}
زمینه های
files[]

object ( CloudStorageFile )

فقط خروجی فایل های صادر شده در فضای ذخیره سازی ابری

CloudStorageFile

فایل صادراتی در فضای ذخیره سازی ابری

نمایندگی JSON
{
  "bucketName": string,
  "objectName": string,
  "size": string,
  "md5Hash": string
}
زمینه های
bucketName

string

نام سطل Cloud Storage برای فایل صادراتی. می‌توانید از این مقدار در Cloud Storage JSON API یا XML API استفاده کنید، اما نه برای فهرست کردن محتویات سطل. در عوض، می‌توانید فایل‌های صادراتی را با نام شیء دریافت کنید .

objectName

string

نام شی Cloud Storage برای فایل صادراتی. می‌توانید از این مقدار در Cloud Storage JSON API یا XML API استفاده کنید.

size

string ( int64 format)

اندازه فایل صادراتی

md5Hash

string

هش md5 ​​فایل.

مواد و روش ها

create

 صادرات ایجاد می کند.

delete

 یک صادرات را حذف می کند.

get

 صادرات می گیرد.

list

 جزئیات مربوط به صادرات را در موضوع مشخص شده فهرست می کند.