REST Resource: matters.exports

Kaynak: Dışa Aktarma

Dışa aktarma.

Apps Kasası kaynaklarıyla çalışabilmesi için hesabın gerekli Apps Kasası ayrıcalıklarına ve konuya erişim iznine sahip olması gerekir. Bir konuya erişmek için hesabın konuyu oluşturmuş olması, konuyu kendisiyle 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)
  },
  "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 aktarmayı oluşturan üst dışa aktarmayı tanımlar. Bu ayar yalnızca alt dışa aktarma işlemlerinde ayarlanır.

name

string

Dışa aktarma adı. Adda özel karakterler (~!$'(),;@:/?) kullanmayın, bunlar dışa aktarılan dosyaları indirmenizi engelleyebilir.

requester

object (UserInfo)

Yalnızca çıkış. Dışa aktarma işlemini yapan kişi.

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.

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

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.

cloudStorageSink

object (CloudStorageSink)

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

UserInfo

Kullanıcı 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şlemleri 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)
  }
  // End of list of possible types for union field corpus_export_options.
}
Alanlar
region

enum (ExportRegion)

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

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

object (MailExportOptions)

Gmail dışa aktarma seçenekleri.

groupsOptions

object (GroupsExportOptions)

Gruplar dışa aktarma işlemleri için seçenekler.

driveOptions

object (DriveExportOptions)

Drive'dan 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)

Bu seçenek Takvim dışa aktarma için kullanılabilir.

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 ayarlayın.

useNewExport

boolean

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

exportLinkedDriveFiles

boolean

İsteğe bağlı. Bağlı Drive dosyalarını dışa aktarmayı etkinleştirmek için değeri 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'ta kullanılabilir.
PST PST olarak dışa aktar. Yalnızca Gmail, Gruplar, Hangouts, Voice ve Takvim'de kullanılabilir.
ICS ICS olarak dışa aktar. Yalnızca Takvim'de kullanılabilir.

GroupsExportOptions

Gruplar dışa aktarma işlemleri için seçenekler.

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

enum (ExportFormat)

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

DriveExportOptions

Drive'dan dışa aktarma seçenekleri.

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

boolean

Dosyalara dolaylı erişimi olan kullanıcıların erişim düzeyi bilgilerini eklemek için 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 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.

ExportRegion

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

Sıralamalar
EXPORT_REGION_UNSPECIFIED Bölge belirtilmedi. Varsayılan değer HERHANGİ BİRİ'dir.
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şlemi için ilerleme bilgileri.

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

string (int64 format)

Dışa aktarma işlemi için halihazırda işlenmiş olan iletilerin veya dosyaların 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'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 dışa aktarma dosyalarını tek tek alabilirsiniz.

objectName

string

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

size

string (int64 format)

Dışa aktarma dosyasının boyutu.

md5Hash

string

Dosyanın md5 hash değeri.

Yöntemler

create

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

delete

Dışa aktarma işlemini siler.

get

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

list

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