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

  // Union field export_sink can be only one of the following:
  "cloudStorageSink": {
    object (CloudStorageSink)
  }
  // End of list of possible types for union field export_sink.
}
الحقول
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)

النتائج فقط. تفاصيل حول مستوى تقدّم التصدير وحجمه

حقل الربط export_sink نوع وجهة التصدير يمكن أن يكون export_sink واحدًا مما يلي فقط:
cloudStorageSink

object (CloudStorageSink)

النتائج فقط. وجهة تصدير الملفات في 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)
  },
  "geminiOptions": {
    object (GeminiExportOptions)
  }
  // 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"

geminiOptions

object (GeminiExportOptions)

خيار متاح لتصدير Gemini

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

تنسيق تصدير الرسائل

عمليات التعداد
EXPORT_FORMAT_UNSPECIFIED لم يتم تحديد تنسيق تصدير.
MBOX تصدير بتنسيق MBOX لا تتوفّر هذه الميزة إلا لتطبيقات Gmail و"مجموعات Google" وHangouts وVoice.
PST تصدير بتنسيق PST لا تتوفّر هذه الميزة إلا لتطبيقات Gmail و"مجموعات Google" وHangouts وVoice و"تقويم Google".
ICS تصدير بتنسيق ICS لا تتوفّر إلا في "تقويم Google".
XML تصدير بتنسيق XML لا تتوفّر هذه الميزة إلا في Gemini.

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)

تنسيق الملف للرسائل النصية التي تم تصديرها

GeminiExportOptions

خيارات عمليات التصدير في Gemini

تمثيل JSON
{
  "exportFormat": enum (ExportFormat)
}
الحقول
exportFormat

enum (ExportFormat)

تنسيق الملف للرسائل التي تم تصديرها

ExportRegion

منطقة البيانات التي سيتم تصديرها

عمليات التعداد
EXPORT_REGION_UNSPECIFIED لم يتم تحديد المنطقة. الإعداد التلقائي هو ANY.
ANY أي منطقة
US منطقة الولايات المتحدة
EUROPE منطقة أوروبا

ExportStatus

حالة التصدير

عمليات التعداد
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 لملف التصدير يمكنك استخدام هذه القيمة في 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

يسرد تفاصيل حول عمليات التصدير في المسألة المحدّدة.