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

فقط خروجی. شناسه Matter.

parentExportId

string

فقط خروجی. صادر کردن والد را که این صادر کردن فرزند را ایجاد کرده است شناسایی می‌کند. این فقط برای صادر کردن‌های فرزند تنظیم شده است.

name

string

نام صادر کردن. از نویسه‌های خاص (~!$'(),;@:/؟) در نام استفاده نکنید، این نویسه‌ها می‌توانند مانع بارگیری موارد صادرشده شوند.

requester

object (UserInfo)

فقط خروجی. درخواست‌کننده صادر کردن.

query

object (Query)

پارامترهای پُرسمان استفاده‌شده برای ایجاد صادر کردن.

exportOptions

object (ExportOptions)

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

createTime

string (Timestamp format)

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

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

فقط خروجی. جزئیات مربوط به پیشرفت و اندازه برون‌برد.

نوع سینک صادر کردن. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
cloudStorageSink

object (CloudStorageSink)

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

پایان فیلدهای متقابلاً انحصاری.

UserInfo

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

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

string

نشانی ایمیل کاربر.

displayName

string

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

ExportOptions

گزینه‌های بیشتر برای صادر کردن

نمایش 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)
  },
  "geminiInWorkspaceOptions": {
    object (GeminiInWorkspaceExportOptions)
  }
}
فیلدها
region

enum (ExportRegion)

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

گزینه‌های مختص سرویس برای صادر کردن. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
mailOptions

object (MailExportOptions)

گزینه‌های صادر کردن Gmail.

groupsOptions

object (GroupsExportOptions)

گزینه‌های صادر کردن «گروه‌ها».

driveOptions

object (DriveExportOptions)

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

hangoutsChatOptions

object (HangoutsChatExportOptions)

گزینه‌های صادر کردن Chat.

voiceOptions

object (VoiceExportOptions)

گزینه‌های صادر کردن Voice.

calendarOptions

object (CalendarExportOptions)

گزینه برای برون‌برد «تقویم» دردسترس است.

geminiOptions

object (GeminiExportOptions)

گزینه دردسترس برای صادر کردن برنامه Gemini.

geminiInWorkspaceOptions

object (GeminiInWorkspaceExportOptions)

گزینه برای صادر کردن «Gemini در Workspace» دردسترس است.

پایان فیلدهای متقابلاً انحصاری.

MailExportOptions

گزینه‌های صادر کردن Gmail.

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

enum (ExportFormat)

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

showConfidentialModeContent

boolean

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

useNewExport

boolean

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

exportLinkedDriveFiles

boolean

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

ExportFormat

قالب صادر کردن پیام‌ها

شمارشی‌ها
EXPORT_FORMAT_UNSPECIFIED قالب صادر کردن مشخص نشده است.
MBOX صادر کردن به‌صورت MBOX. فقط برای Gmail، «گروه‌ها»، Hangouts، و Voice دردسترس است.
PST Glossary received. I will use these as hints for our translations. فقط برای Gmail، «گروه‌ها»، Hangouts،‏ Voice، و «تقویم» دردسترس است.
ICS صادر کردن به‌عنوان ICS. فقط برای «تقویم» دردسترس است.
XML صادر کردن به‌صورت XML. فقط برای برنامه Gemini دردسترس است.
JSON صادر کردن به‌عنوان JSON. فقط برای «Gemini در Workspace» دردسترس است.

GroupsExportOptions

گزینه‌های صادر کردن «گروه‌ها».

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

enum (ExportFormat)

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

DriveExportOptions

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

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

boolean

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

HangoutsChatExportOptions

گزینه‌های صادر کردن Chat.

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

enum (ExportFormat)

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

VoiceExportOptions

گزینه‌های صادر کردن Voice.

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

enum (ExportFormat)

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

CalendarExportOptions

گزینه‌های برون‌برد «تقویم».

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

enum (ExportFormat)

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

GeminiExportOptions

گزینه‌های صادر کردن برنامه Gemini.

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

enum (ExportFormat)

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

GeminiInWorkspaceExportOptions

گزینه‌های صادر کردن «Gemini در Workspace».

نمایش 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

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