REST Resource: matters.exports

Kaynak: Dışa aktarma

Dışa aktarma işlemi.

Hesabın, Apps Kasası kaynaklarıyla çalışabilmesi için gerekli Apps Kasası ayrıcalıklarına ve konuya erişimi olması gerekir. Bir konuya erişmek için hesabın konuyu oluşturmuş olması, konunun hesapla paylaşılmış olması veya hesabın 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)
  },

  "cloudStorageSink": {
    object (CloudStorageSink)
  }
}
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 aktarma işlemini oluşturan üst dışa aktarma işlemini tanımlar. Bu yalnızca alt dışa aktarma işlemlerinde ayarlanır.

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.

Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılır. "Z" dışındaki zaman farkları da 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 boyutuyla ilgili ayrıntılar.

Dışa aktarma havuzu türü. Aşağıda, birbirini dışlayan alanların listesi verilmiştir. Yanıtta alanlardan en fazla biri ayarlanır:
cloudStorageSink

object (CloudStorageSink)

Yalnızca çıkış. Cloud Storage'da dışa aktarma dosyaları için havuz.

Birbirini hariç tutan alanların sonu.

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şlemleriyle ilgili ek seçenekler

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

enum (ExportRegion)

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

Dışa aktarma işlemleri için hizmete özgü seçenekler. Aşağıda, birbirini dışlayan alanların listesi verilmiştir. Yanıtta alanlardan en fazla biri ayarlanır:
mailOptions

object (MailExportOptions)

Gmail dışa aktarma seçenekleri.

groupsOptions

object (GroupsExportOptions)

Gruplar'ı dışa aktarma seçenekleri.

driveOptions

object (DriveExportOptions)

Drive'dan yapılan dışa aktarma işlemleriyle ilgili seçenekler.

hangoutsChatOptions

object (HangoutsChatExportOptions)

Chat dışa aktarma seçenekleri.

voiceOptions

object (VoiceExportOptions)

Voice dışa aktarma seçenekleri.

calendarOptions

object (CalendarExportOptions)

Takvim'i dışa aktarma seçeneği kullanılabilir.

geminiOptions

object (GeminiExportOptions)

Gemini uygulamasından dışa aktarma seçeneği.

geminiInWorkspaceOptions

object (GeminiInWorkspaceExportOptions)

Workspace'te Gemini dışa aktarma işlemi için kullanılabilen seçenek.

Birbirini hariç tutan alanların sonu.

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 mesajların dosya biçimi.

showConfidentialModeContent

boolean

Gizli mod içeriğini dışa aktarmak için true değerini girin.

useNewExport

boolean

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

exportLinkedDriveFiles

boolean

İsteğe bağlıdır. Bağlı Drive dosyalarını dışa aktarmayı etkinleştirmek için true değerini girin.

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 aktarabilirsiniz. Yalnızca Gmail, Gruplar, Hangouts, Voice ve Takvim'de kullanılabilir.
ICS ICS olarak dışa aktar. Yalnızca Takvim'de kullanılabilir.
XML XML olarak dışa aktarın. Yalnızca Gemini uygulamasında kullanılabilir.
JSON JSON olarak dışa aktarın. Yalnızca Workspace için Gemini'da kullanılabilir.

GroupsExportOptions

Gruplar'ı dışa aktarma seçenekleri.

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

enum (ExportFormat)

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

DriveExportOptions

Drive'dan yapılan dışa aktarma işlemleriyle ilgili seçenekler.

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

boolean

Dosyalara dolaylı erişimi olan kullanıcıların erişim düzeyi bilgilerini dahil etmek için true değerini girin.

HangoutsChatExportOptions

Chat dışa aktarma seçenekleri.

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

enum (ExportFormat)

Dışa aktarılan mesajların 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 uygulamasından dışa aktarma seçenekleri.

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

enum (ExportFormat)

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

GeminiInWorkspaceExportOptions

Workspace'te Gemini dışa aktarma seçenekleri.

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

enum (ExportFormat)

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

ExportRegion

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

Sıralamalar
EXPORT_REGION_UNSPECIFIED Bölge belirtilmemiş. Varsayılan olarak ANY değerine ayarlanır.
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şleminin ilerleme durumu bilgileri.

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

string (int64 format)

Dışa aktarma için işlenmiş olan mesaj veya dosyaların sayısı.

totalArtifactCount

string (int64 format)

Dışa aktarılacak mesaj veya dosyaların 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çeriklerini listelemek için kullanamazsınız. Bunun yerine, nesne adına göre ayrı 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ının 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

Dışa aktarma işlemini alır.

list

Belirtilen konudaki dışa aktarma işlemleriyle ilgili ayrıntıları listeler.