REST Resource: matters.exports

Resource: Export

Ekspor.

Untuk menggunakan resource Vault, akun harus memiliki hak istimewa Vault yang diperlukan dan akses ke masalah. Untuk mengakses masalah, akun harus telah membuat masalah, memiliki masalah yang dibagikan kepadanya, atau memiliki hak istimewa Lihat Semua Masalah.

Representasi 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.
}
Kolom
id

string

Hanya output. ID ekspor yang dihasilkan.
matterId

string

Hanya output. ID masalah.
parentExportId

string

Hanya output. Mengidentifikasi ekspor induk yang menghasilkan ekspor turunan ini. Hal ini hanya ditetapkan pada ekspor turunan.
name

string

Nama ekspor. Jangan gunakan karakter khusus (~!$'(),;@:/?) dalam nama file. Karakter ini dapat mencegah Anda mendownload file ekspor.
requester

object (UserInfo)

Hanya output. Pemohon ekspor.
query

object (Query)

Parameter kueri yang digunakan untuk membuat ekspor.
exportOptions

object (ExportOptions)

Opsi ekspor tambahan.
createTime

string (Timestamp format)

Hanya output. Waktu pembuatan ekspor.

Menggunakan RFC 3339, dengan output yang dihasilkan akan selalu dinormalisasi Z dan menggunakan digit pecahan 0, 3, 6, atau 9. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
status

enum (ExportStatus)

Hanya output. Status ekspor.
stats

object (ExportStats)

Hanya output. Detail tentang progres dan ukuran ekspor.
Kolom union export_sink. Jenis sink ekspor. export_sink hanya dapat berupa salah satu dari berikut:
cloudStorageSink

object (CloudStorageSink)

Hanya output. Penampung untuk file ekspor di Cloud Storage.

UserInfo

Informasi pengguna.

Representasi JSON 
{
  "email": string,
  "displayName": string
}
Kolom
email

string

Alamat email pengguna.
displayName

string

Nama pengguna yang ditampilkan.

ExportOptions

Opsi tambahan untuk ekspor

Representasi 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.
}
Kolom
region

enum (ExportRegion)

Region data yang diminta untuk ekspor.
Kolom union corpus_export_options. Opsi khusus layanan untuk ekspor. corpus_export_options hanya dapat berupa salah satu dari berikut:
mailOptions

object (MailExportOptions)

Opsi untuk ekspor Gmail.
groupsOptions

object (GroupsExportOptions)

Opsi untuk ekspor Grup.
driveOptions

object (DriveExportOptions)

Opsi untuk ekspor Drive.
hangoutsChatOptions

object (HangoutsChatExportOptions)

Opsi untuk ekspor Chat.
voiceOptions

object (VoiceExportOptions)

Opsi untuk ekspor Voice.
calendarOptions

object (CalendarExportOptions)

Opsi yang tersedia untuk ekspor Kalender.
geminiOptions

object (GeminiExportOptions)

Opsi tersedia untuk ekspor Gemini.

MailExportOptions

Opsi untuk ekspor Gmail.

Representasi JSON 
{
  "exportFormat": enum (ExportFormat),
  "showConfidentialModeContent": boolean,
  "useNewExport": boolean,
  "exportLinkedDriveFiles": boolean
}
Kolom
exportFormat

enum (ExportFormat)

Format file untuk pesan yang diekspor.
showConfidentialModeContent

boolean

Untuk mengekspor konten mode rahasia, tetapkan ke true.
useNewExport

boolean

Untuk menggunakan sistem ekspor baru, tetapkan ke true.
exportLinkedDriveFiles

boolean

Opsional. Untuk mengaktifkan ekspor file Drive yang ditautkan, tetapkan ke true.

ExportFormat

Format ekspor untuk pesan

Enum
EXPORT_FORMAT_UNSPECIFIED Tidak ada format ekspor yang ditentukan.
MBOX Ekspor sebagai MBOX. Hanya tersedia untuk Gmail, Grup, Hangouts, dan Voice.
PST Ekspor sebagai PST. Hanya tersedia untuk Gmail, Grup, Hangouts, Voice, dan Kalender.
ICS Ekspor sebagai ICS. Hanya tersedia untuk Kalender.
XML Ekspor sebagai XML. Hanya tersedia untuk Gemini.

GroupsExportOptions

Opsi untuk ekspor Grup.

Representasi JSON 
{
  "exportFormat": enum (ExportFormat)
}
Kolom
exportFormat

enum (ExportFormat)

Format file untuk pesan yang diekspor.

DriveExportOptions

Opsi untuk ekspor Drive.

Representasi JSON 
{
  "includeAccessInfo": boolean
}
Kolom
includeAccessInfo

boolean

Untuk menyertakan informasi tingkat akses bagi pengguna yang memiliki akses tidak langsung ke file, tetapkan ke true.

HangoutsChatExportOptions

Opsi untuk ekspor Chat.

Representasi JSON 
{
  "exportFormat": enum (ExportFormat)
}
Kolom
exportFormat

enum (ExportFormat)

Format file untuk pesan yang diekspor.

VoiceExportOptions

Opsi untuk ekspor Voice.

Representasi JSON 
{
  "exportFormat": enum (ExportFormat)
}
Kolom
exportFormat

enum (ExportFormat)

Format file untuk pesan teks yang diekspor.

CalendarExportOptions

Opsi untuk ekspor Kalender.

Representasi JSON 
{
  "exportFormat": enum (ExportFormat)
}
Kolom
exportFormat

enum (ExportFormat)

Format file untuk pesan teks yang diekspor.

GeminiExportOptions

Opsi untuk ekspor Gemini.

Representasi JSON 
{
  "exportFormat": enum (ExportFormat)
}
Kolom
exportFormat

enum (ExportFormat)

Format file untuk pesan yang diekspor.

ExportRegion

Region data untuk ekspor.

Enum
EXPORT_REGION_UNSPECIFIED Region tidak ditentukan. Defaultnya adalah ANY.
ANY Region mana pun.
US Region Amerika Serikat.
EUROPE Region Eropa.

ExportStatus

Status ekspor.

Enum
EXPORT_STATUS_UNSPECIFIED Status tidak ditentukan.
COMPLETED Ekspor selesai.
FAILED Ekspor gagal.
IN_PROGRESS Ekspor sedang berlangsung.

ExportStats

Informasi progres untuk ekspor.

Representasi JSON 
{
  "exportedArtifactCount": string,
  "totalArtifactCount": string,
  "sizeInBytes": string
}
Kolom
exportedArtifactCount

string (int64 format)

Jumlah pesan atau file yang telah diproses untuk diekspor.
totalArtifactCount

string (int64 format)

Jumlah pesan atau file yang akan diekspor.
sizeInBytes

string (int64 format)

Ukuran ekspor dalam byte.

CloudStorageSink

Ekspor sink untuk file Cloud Storage.

Representasi JSON 
{
  "files": [
    {
      object (CloudStorageFile)
    }
  ]
}
Kolom
files[]

object (CloudStorageFile)

Hanya output. File yang diekspor di Cloud Storage.

CloudStorageFile

File ekspor di Cloud Storage

Representasi JSON 
{
  "bucketName": string,
  "objectName": string,
  "size": string,
  "md5Hash": string
}
Kolom
bucketName

string

Nama bucket Cloud Storage untuk file ekspor. Anda dapat menggunakan nilai ini di JSON API atau XML API Cloud Storage, tetapi tidak untuk mencantumkan konten bucket. Sebagai gantinya, Anda dapat mendapatkan setiap file ekspor berdasarkan nama objek.
objectName

string

Nama objek Cloud Storage untuk file ekspor. Anda dapat menggunakan nilai ini di JSON API atau XML API Cloud Storage.
size

string (int64 format)

Ukuran file ekspor.
md5Hash

string

Hash md5 file.

Metode

create

 Membuat ekspor.

delete

 Menghapus ekspor.

get

 Mendapatkan ekspor.

list

 Mencantumkan detail tentang ekspor dalam masalah yang ditentukan.