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)

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

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)

出力専用。エクスポートの進行状況とサイズに関する詳細。
エクスポート シンクのタイプ。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
cloudStorageSink

object (CloudStorageSink)

出力専用。Cloud Storage のエクスポート ファイルのシンク。
相互に排他的なフィールドの終了。

UserInfo

お客様の情報。

JSON 表現 
{
  "email": string,
  "displayName": string
}
フィールド
email

string

ユーザーのメールアドレス。
displayName

string

ユーザーの表示名。

ExportOptions

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

JSON 表現 
{
  "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)
  }
}
フィールド
region

enum (ExportRegion)

エクスポート用にリクエストされたデータ リージョン。
エクスポートのサービス固有のオプション。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
mailOptions

object (MailExportOptions)

Gmail の書き出しのオプション。
groupsOptions

object (GroupsExportOptions)

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

object (DriveExportOptions)

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

object (HangoutsChatExportOptions)

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

object (VoiceExportOptions)

Voice の書き出しオプション。
calendarOptions

object (CalendarExportOptions)

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

object (GeminiExportOptions)

Gemini アプリのエクスポートで利用できるオプション。
geminiInWorkspaceOptions

object (GeminiInWorkspaceExportOptions)

Gemini in Workspace のエクスポートで利用可能なオプション。
相互に排他的なフィールドの終了。

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

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)

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

GeminiExportOptions

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

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

enum (ExportFormat)

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

GeminiInWorkspaceExportOptions

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

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

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