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)
  },

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

string

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

string

出力専用。案件 ID。
parentExportId

string

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

string

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

object (UserInfo)

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

object (Query)

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

object (ExportOptions)

その他のエクスポート オプション。
createTime

string (Timestamp format)

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

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
status

enum (ExportStatus)

出力専用。エクスポートのステータス。
stats

object (ExportStats)

出力専用。エクスポートの進行状況とサイズに関する詳細。
共用体フィールド export_sink。エクスポート シンクのタイプ。export_sink は次のいずれかになります。
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)
  },
  "geminiOptions": {
    object (GeminiExportOptions)
  }
  // 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)

チャットのエクスポート オプション。
voiceOptions

object (VoiceExportOptions)

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

object (CalendarExportOptions)

カレンダーのエクスポートに使用できるオプション。
geminiOptions

object (GeminiExportOptions)

Gemini エクスポートで使用できるオプション。

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、グループ、ハングアウト、Voice でのみ使用できます。
PST PST としてエクスポートします。Gmail、グループ、ハングアウト、Voice、カレンダーでのみ使用できます。
ICS ICS としてエクスポートします。カレンダーでのみ使用できます。
XML XML としてエクスポートします。Gemini でのみ利用できます。

GroupsExportOptions

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

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

enum (ExportFormat)

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

DriveExportOptions

ドライブのエクスポート オプション。

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

boolean

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

HangoutsChatExportOptions

チャットのエクスポート オプション。

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

enum (ExportFormat)

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

VoiceExportOptions

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

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

enum (ExportFormat)

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

CalendarExportOptions

カレンダーのエクスポート オプション。

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

enum (ExportFormat)

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

GeminiExportOptions

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

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

 指定した件のエクスポートの詳細をリストします。