REST Resource: matters.exports

Kaynak: Dışa aktarma

Dışa aktarma işlemi.

Apps Kasası kaynaklarını kullanabilmek için hesabın gerekli Apps Kasası ayrıcalıklarına ve konuya erişimine sahip olması gerekir. Bir konuya erişebilmek için hesabın konuyu oluşturması, konuyu paylaşmış olması veya Tüm Konuları Görüntüleme ayrıcalığına sahip olması gerekir.

JSON gösterimi
{
  "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.
}
Alanlar
id

string

Yalnızca çıkış. Oluşturulan dışa aktarma kimliği.

matterId

string

Yalnızca çıkış. Konu kimliği.

parentExportId

string

Yalnızca çıkış. Bu alt dışa aktarmayı oluşturan üst dışa aktarmayı tanımlar. Bu ayar yalnızca alt dışa aktarmalarda belirlenir.

name

string

Dışa aktarma adı. Adda özel karakter (~!$'(),;@:/?) kullanmayın. Özel karakterler nedeniyle dışa aktarma dosyalarını indiremeyebilirsiniz.

requester

object (UserInfo)

Yalnızca çıkış. Dışa aktarma isteğinde bulunan kullanıcı.

query

object (Query)

Dışa aktarma işlemini oluşturmak için kullanılan sorgu parametreleri.

exportOptions

object (ExportOptions)

Ek dışa aktarma seçenekleri.

createTime

string (Timestamp format)

Yalnızca çıkış. Dışa aktarma işleminin oluşturulduğu zaman.

Oluşturulan çıktının her zaman Z normalleştirileceği ve 0, 3, 6 veya 9 kesirli basamak kullanacağı RFC 3339'u kullanır. "Z" dışındaki ofsetler de kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".

status

enum (ExportStatus)

Yalnızca çıkış. Dışa aktarma işleminin durumu.

stats

object (ExportStats)

Yalnızca çıkış. Dışa aktarma işleminin ilerleme durumu ve boyutu hakkında ayrıntılar.

Birlik alanı export_sink. Dışa aktarma havuzu türü. export_sink yalnızca aşağıdakilerden biri olabilir:
cloudStorageSink

object (CloudStorageSink)

Yalnızca çıkış. Cloud Storage'da dışa aktarılan dosyalar için akış.

UserInfo

Kullanıcının bilgileri.

JSON gösterimi
{
  "email": string,
  "displayName": string
}
Alanlar
email

string

Kullanıcının e-posta adresi.

displayName

string

Kullanıcının görünen adı.

ExportOptions

Dışa aktarma için ek seçenekler

JSON gösterimi
{
  "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.
}
Alanlar
region

enum (ExportRegion)

Dışa aktarma işlemi için istenen veri bölgesi.

Birlik alanı corpus_export_options. Dışa aktarma işlemleri için hizmete özgü seçenekler. corpus_export_options yalnızca aşağıdakilerden biri olabilir:
mailOptions

object (MailExportOptions)

Gmail dışa aktarma seçenekleri.

groupsOptions

object (GroupsExportOptions)

Gruplar dışa aktarma seçenekleri.

driveOptions

object (DriveExportOptions)

Drive dışa aktarma seçenekleri.

hangoutsChatOptions

object (HangoutsChatExportOptions)

Chat dışa aktarma seçenekleri.

voiceOptions

object (VoiceExportOptions)

Voice dışa aktarma seçenekleri.

calendarOptions

object (CalendarExportOptions)

Takvim dışa aktarma işlemi için kullanılabilen seçenek.

geminiOptions

object (GeminiExportOptions)

Gemini dışa aktarma için kullanılabilen seçenek.

MailExportOptions

Gmail dışa aktarma seçenekleri.

JSON gösterimi
{
  "exportFormat": enum (ExportFormat),
  "showConfidentialModeContent": boolean,
  "useNewExport": boolean,
  "exportLinkedDriveFiles": boolean
}
Alanlar
exportFormat

enum (ExportFormat)

Dışa aktarılan iletilerin dosya biçimi.

showConfidentialModeContent

boolean

Gizli mod içeriğini dışa aktarmak için true olarak ayarlayın.

useNewExport

boolean

Yeni dışa aktarma sistemini kullanmak için true olarak ayarlayın.

exportLinkedDriveFiles

boolean

İsteğe bağlı. Bağlı Drive dosyalarını dışa aktarmayı etkinleştirmek için true olarak ayarlayın.

ExportFormat

Mesajlar için dışa aktarma biçimi

Sıralamalar
EXPORT_FORMAT_UNSPECIFIED Dışa aktarma biçimi belirtilmedi.
MBOX MBOX olarak dışa aktarın. Yalnızca Gmail, Gruplar, Hangouts ve Voice için kullanılabilir.
PST PST olarak dışa aktarın. Yalnızca Gmail, Gruplar, Hangouts, Voice ve Takvim'de kullanılabilir.
ICS ICS olarak dışa aktarın. Yalnızca Takvim için kullanılabilir.
XML XML olarak dışa aktarın. Yalnızca Gemini için kullanılabilir.

GroupsExportOptions

Gruplar dışa aktarma seçenekleri.

JSON gösterimi
{
  "exportFormat": enum (ExportFormat)
}
Alanlar
exportFormat

enum (ExportFormat)

Dışa aktarılan iletilerin dosya biçimi.

DriveExportOptions

Drive dışa aktarma seçenekleri.

JSON gösterimi
{
  "includeAccessInfo": boolean
}
Alanlar
includeAccessInfo

boolean

Dosyalara doğrudan erişimi olmayan kullanıcılar için erişim düzeyi bilgilerini dahil etmek istiyorsanız bu değeri true olarak ayarlayın.

HangoutsChatExportOptions

Chat dışa aktarma seçenekleri.

JSON gösterimi
{
  "exportFormat": enum (ExportFormat)
}
Alanlar
exportFormat

enum (ExportFormat)

Dışa aktarılan iletilerin dosya biçimi.

VoiceExportOptions

Voice dışa aktarma seçenekleri.

JSON gösterimi
{
  "exportFormat": enum (ExportFormat)
}
Alanlar
exportFormat

enum (ExportFormat)

Dışa aktarılan kısa mesajların dosya biçimi.

CalendarExportOptions

Takvim dışa aktarma seçenekleri.

JSON gösterimi
{
  "exportFormat": enum (ExportFormat)
}
Alanlar
exportFormat

enum (ExportFormat)

Dışa aktarılan kısa mesajların dosya biçimi.

GeminiExportOptions

Gemini dışa aktarma seçenekleri.

JSON gösterimi
{
  "exportFormat": enum (ExportFormat)
}
Alanlar
exportFormat

enum (ExportFormat)

Dışa aktarılan iletilerin dosya biçimi.

ExportRegion

Dışa aktarma işleminin veri bölgesi.

Sıralamalar
EXPORT_REGION_UNSPECIFIED Bölge belirtilmemiş. Varsayılan olarak HERHANGİ bir değerdir.
ANY Herhangi bir bölge.
US Amerika Birleşik Devletleri bölgesi.
EUROPE Avrupa bölgesi.

ExportStatus

Dışa aktarma işleminin durumu.

Sıralamalar
EXPORT_STATUS_UNSPECIFIED Durum belirtilmemiş.
COMPLETED Dışa aktarma işlemi tamamlandı.
FAILED Dışa aktarma işlemi başarısız oldu.
IN_PROGRESS Dışa aktarma işlemi devam ediyor.

ExportStats

Dışa aktarma işlemiyle ilgili ilerleme bilgileri.

JSON gösterimi
{
  "exportedArtifactCount": string,
  "totalArtifactCount": string,
  "sizeInBytes": string
}
Alanlar
exportedArtifactCount

string (int64 format)

Dışa aktarma işlemi için önceden işlenmiş mesaj veya dosya sayısı.

totalArtifactCount

string (int64 format)

Dışa aktarılacak mesaj veya dosya sayısı.

sizeInBytes

string (int64 format)

Dışa aktarma işleminin bayt cinsinden boyutu.

CloudStorageSink

Cloud Storage dosyaları için dışa aktarma havuzu.

JSON gösterimi
{
  "files": [
    {
      object (CloudStorageFile)
    }
  ]
}
Alanlar
files[]

object (CloudStorageFile)

Yalnızca çıkış. Cloud Storage'daki dışa aktarılan dosyalar.

CloudStorageFile

Cloud Storage'daki dışa aktarma dosyası

JSON gösterimi
{
  "bucketName": string,
  "objectName": string,
  "size": string,
  "md5Hash": string
}
Alanlar
bucketName

string

Dışa aktarma dosyası için Cloud Storage paketinin adı. Bu değeri Cloud Storage JSON API veya XML API'de kullanabilirsiniz ancak paket içeriğini listelemek için kullanamazsınız. Bunun yerine, nesne adına göre tek tek dışa aktarma dosyaları alabilirsiniz.

objectName

string

Dışa aktarma dosyası için Cloud Storage nesnesinin adı. Bu değeri Cloud Storage JSON API veya XML API'de kullanabilirsiniz.

size

string (int64 format)

Dışa aktarma dosyası boyutu.

md5Hash

string

Dosyanın md5 karma değeri.

Yöntemler

create

Dışa aktarma işlemi oluşturur.

delete

Dışa aktarma işlemini siler.

get

Bir dışa aktarma işlemi alır.

list

Belirtilen konudaki dışa aktarmalarla ilgili ayrıntıları listeler.