REST Resource: matters.exports

リソース: Export

エクスポート。

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

出力のみ。生成されたエクスポート ID。
matterId

string

出力のみ。案件 ID。
parentExportId

string

出力のみ。この子エクスポートを生成した親エクスポートを特定します。子エクスポートでのみ設定されます。
name

string

エクスポート名。名前に特殊文字（~!$'()、;@:/?）は使用しないでください。特殊文字が含まれていると、エクスポートをダウンロードできなくなる可能性があります。
requester

object (UserInfo)

出力のみ。エクスポートのリクエスト元。
query

object (Query)

エクスポートの作成に使用されるクエリ パラメータ。
exportOptions

object (ExportOptions)

追加のエクスポート オプション。
createTime

string (Timestamp format)

出力のみ。エクスポートが作成された時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
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),

  // 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.
}
フィールド
region

enum (ExportRegion)

エクスポート用にリクエストされたデータ リージョン。
共用体フィールド corpus_export_options。サービス固有のエクスポート オプション。corpus_export_options は次のいずれかになります。
mailOptions

object (MailExportOptions)

Gmail のエクスポート オプション。
groupsOptions

object (GroupsExportOptions)

Google グループの書き出しに関するオプション。
driveOptions

object (DriveExportOptions)

ドライブの書き出しに関するオプション。
hangoutsChatOptions

object (HangoutsChatExportOptions)

Chat のエクスポート オプション。
voiceOptions

object (VoiceExportOptions)

Voice の書き出しに関するオプション。
calendarOptions

object (CalendarExportOptions)

カレンダーのエクスポートで利用可能なオプションです。

MailExportOptions

Gmail のエクスポート オプション。

JSON 表現 
{
  "exportFormat": enum (ExportFormat),
  "showConfidentialModeContent": boolean,
  "useNewExport": boolean,
  "exportLinkedDriveFiles": boolean
}
フィールド
exportFormat

enum (ExportFormat)

エクスポートされたメッセージのファイル形式。
showConfidentialModeContent

boolean

情報保護モードのコンテンツをエクスポートするには、true に設定します。
useNewExport

boolean

新しいエクスポート システムを使用するには、true に設定します。
exportLinkedDriveFiles

boolean

（省略可）リンクされたドライブ ファイルのエクスポートを有効にするには、true に設定します。

ExportFormat

メッセージのエクスポート形式

列挙型
EXPORT_FORMAT_UNSPECIFIED エクスポート形式が指定されていません。
MBOX MBOX 形式でエクスポートします。Gmail、Google グループ、ハングアウト、Voice でのみご利用いただけます。
PST PST 形式でエクスポートします。Gmail、Google グループ、ハングアウト、Voice、カレンダーでのみご利用いただけます。
ICS ICS 形式でエクスポートカレンダーでのみ使用できます。

GroupsExportOptions

Google グループの書き出しに関するオプション。

JSON 表現 
{
  "exportFormat": enum (ExportFormat)
}
フィールド
exportFormat

enum (ExportFormat)

エクスポートされたメッセージのファイル形式。

DriveExportOptions

ドライブの書き出しに関するオプション。

JSON 表現 
{
  "includeAccessInfo": boolean
}
フィールド
includeAccessInfo

boolean

ファイルへの間接的なアクセス権を持つユーザーのアクセスレベル情報を含めるには、true に設定します。

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)

エクスポートされたテキスト メッセージのファイル形式。

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 バケットの名前。この値は Cloud Storage の JSON API または XML API で使用できますが、バケットの内容を一覧表示することはできません。代わりに、オブジェクト名で個々のエクスポート ファイルを取得できます。
objectName

string

エクスポート ファイルの Cloud Storage オブジェクトの名前。この値は、Cloud Storage の JSON API または XML API で使用できます。
size

string (int64 format)

エクスポート ファイルのサイズ。
md5Hash

string

ファイルの md5 ハッシュ。

Methods

create

 エクスポートを作成します。

delete

 エクスポートを削除します。

get

 エクスポートを取得します。

list

 指定した案件のエクスポートに関する詳細を一覧表示します。