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)

グループのエクスポート オプション。
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

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

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 ハッシュ。

メソッド

create

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

delete

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

get

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

list

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