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)

فقط خروجی. زمانی که export ایجاد شده است.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "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 )

فقط خروجی. سینک برای فایل‌های خروجی در فضای ذخیره‌سازی ابری.

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

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

نمایش JSON 
{
  "email": string,
  "displayName": string
}
فیلدها
email

string

آدرس ایمیل کاربر.

displayName

string

نام نمایش داده شده کاربر.

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

گزینه‌های اضافی برای صادرات

نمایش JSON 
{
  "region": enum (ExportRegion),

  "mailOptions": {
    object (MailExportOptions)
  },
  "groupsOptions": {
    object (GroupsExportOptions)
  },
  "driveOptions": {
    object (DriveExportOptions)
  },
  "hangoutsChatOptions": {
    object (HangoutsChatExportOptions)
  },
  "voiceOptions": {
    object (VoiceExportOptions)
  },
  "calendarOptions": {
    object (CalendarExportOptions)
  },
  "geminiOptions": {
    object (GeminiExportOptions)
  }
}
فیلدها
region

enum ( ExportRegion )

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

فیلد یونیون corpus_export_options . گزینه‌های خاص سرویس برای صادرات. corpus_export_options فقط می‌تواند یکی از موارد زیر باشد:
mailOptions

object ( MailExportOptions )

گزینه‌هایی برای خروجی گرفتن از جیمیل

groupsOptions

object ( GroupsExportOptions )

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

driveOptions

object ( DriveExportOptions )

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

hangoutsChatOptions

object ( HangoutsChatExportOptions )

گزینه‌هایی برای خروجی گرفتن از چت.

voiceOptions

object ( VoiceExportOptions )

گزینه‌هایی برای خروجی گرفتن از صدا.

calendarOptions

object ( CalendarExportOptions )

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

geminiOptions

object ( GeminiExportOptions )

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

گزینه‌های صادرات ایمیل

گزینه‌هایی برای خروجی گرفتن از جیمیل

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

enum ( ExportFormat )

قالب فایل برای پیام‌های صادر شده.

showConfidentialModeContent

boolean

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

useNewExport

boolean

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

exportLinkedDriveFiles

boolean

اختیاری. برای فعال کردن خروجی گرفتن از فایل‌های لینک شده‌ی درایو، روی true تنظیم کنید.

فرمت خروجی

فرمت خروجی برای پیام‌ها

انوم‌ها
EXPORT_FORMAT_UNSPECIFIED قالب خروجی مشخص نشده است.
MBOX خروجی به صورت MBOX. فقط برای Gmail، Groups، Hangouts و Voice در دسترس است.
PST خروجی به صورت PST. فقط برای Gmail، گروه‌ها، Hangouts، Voice و تقویم در دسترس است.
ICS خروجی به صورت ICS. فقط برای تقویم در دسترس است.
XML خروجی به صورت XML. فقط برای Gemini در دسترس است.

گزینه‌های صادرات گروه‌ها

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

نمایش JSON 
{
  "exportFormat": enum (ExportFormat)
}
فیلدها
exportFormat

enum ( ExportFormat )

قالب فایل برای پیام‌های صادر شده.

گزینه‌های DriveExport

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

نمایش JSON 
{
  "includeAccessInfo": boolean
}
فیلدها
includeAccessInfo

boolean

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

گزینه‌های خروجی HangoutsChat

گزینه‌هایی برای خروجی گرفتن از چت.

نمایش JSON 
{
  "exportFormat": enum (ExportFormat)
}
فیلدها
exportFormat

enum ( ExportFormat )

قالب فایل برای پیام‌های صادر شده.

گزینه‌های خروجی صدا

گزینه‌های مربوط به خروجی گرفتن از صدا.

نمایش JSON 
{
  "exportFormat": enum (ExportFormat)
}
فیلدها
exportFormat

enum ( ExportFormat )

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

گزینه‌های صادرات تقویم

گزینه‌های مربوط به خروجی گرفتن از تقویم.

نمایش JSON 
{
  "exportFormat": enum (ExportFormat)
}
فیلدها
exportFormat

enum ( ExportFormat )

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

گزینه‌های صادرات جمینی

گزینه‌های صادرات جمینی

نمایش JSON 
{
  "exportFormat": enum (ExportFormat)
}
فیلدها
exportFormat

enum ( ExportFormat )

قالب فایل برای پیام‌های صادر شده.

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

ناحیه داده برای صادرات.

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

وضعیت صادرات

وضعیت صادرات.

انوم‌ها
EXPORT_STATUS_UNSPECIFIED وضعیت نامشخص است.
COMPLETED صادرات تکمیل شد.
FAILED صادرات شکست خورد.
IN_PROGRESS صادرات در حال انجام است.

آمار صادرات

اطلاعات پیشرفت برای صادرات.

نمایش JSON 
{
  "exportedArtifactCount": string,
  "totalArtifactCount": string,
  "sizeInBytes": string
}
فیلدها
exportedArtifactCount

string ( int64 format)

تعداد پیام‌ها یا فایل‌هایی که قبلاً برای صادرات پردازش شده‌اند.

totalArtifactCount

string ( int64 format)

تعداد پیام‌ها یا فایل‌هایی که باید صادر شوند.

sizeInBytes

string ( int64 format)

اندازه خروجی بر حسب بایت.

کلود استوریج سینک

سینک خروجی برای فایل‌های ذخیره‌سازی ابری.

نمایش JSON 
{
  "files": [
    {
      object (CloudStorageFile)
    }
  ]
}
فیلدها
files[]

object ( CloudStorageFile )

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

فایل ذخیره‌سازی ابری

فایل خروجی در فضای ذخیره‌سازی ابری

نمایش JSON 
{
  "bucketName": string,
  "objectName": string,
  "size": string,
  "md5Hash": string
}
فیلدها
bucketName

string

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

objectName

string

نام شیء ذخیره‌سازی ابری برای فایل خروجی. می‌توانید از این مقدار در API JSON یا API XML ذخیره‌سازی ابری استفاده کنید.

size

string ( int64 format)

اندازه فایل خروجی.

md5Hash

string

هش md5 ​​فایل.

روش‌ها

create

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

delete

 یک خروجی را حذف می‌کند.

get

 صادراتی دریافت می‌کند.

list

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