- リソース: Export
- UserInfo
- ExportOptions
- MailExportOptions
- ExportFormat
- GroupsExportOptions
- DriveExportOptions
- HangoutsChatExportOptions
- VoiceExportOptions
- CalendarExportOptions
- ExportRegion
- ExportStatus
- ExportStats
- CloudStorageSink
- CloudStorageFile
- メソッド
リソース: Export
エクスポート。
Vault リソースを扱うには、アカウントに必要な Vault 権限と案件へのアクセス権が必要です。案件にアクセスするには、そのアカウントが案件を作成しているか、案件を共有しているか、全案件の閲覧権限を持っている必要があります。
JSON 表現 |
---|
{ "id": string, "matterId": string, "parentExportId": string, "name": string, "requester": { object ( |
フィールド | |
---|---|
id |
出力のみ。生成されたエクスポート ID。 |
matterId |
出力のみ。案件 ID。 |
parentExportId |
出力のみ。この子エクスポートを生成した親エクスポートを特定します。子エクスポートでのみ設定されます。 |
name |
エクスポート名。名前に特殊文字(~!$'()、;@:/?)は使用しないでください。特殊文字が含まれていると、エクスポートをダウンロードできなくなる可能性があります。 |
requester |
出力のみ。エクスポートのリクエスト元。 |
query |
エクスポートの作成に使用されるクエリ パラメータ。 |
exportOptions |
追加のエクスポート オプション。 |
createTime |
出力のみ。エクスポートが作成された時刻。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
status |
出力のみ。エクスポートのステータス。 |
stats |
出力のみ。エクスポートの進行状況とサイズの詳細。 |
cloudStorageSink |
出力のみ。Cloud Storage にあるエクスポート ファイル用のシンク。 |
UserInfo
ユーザーの情報。
JSON 表現 |
---|
{ "email": string, "displayName": string } |
フィールド | |
---|---|
email |
ユーザーのメールアドレス。 |
displayName |
ユーザーの表示名。 |
ExportOptions
エクスポートのその他のオプション
JSON 表現 |
---|
{ "region": enum ( |
フィールド | |
---|---|
region |
エクスポート用にリクエストされたデータ リージョン。 |
共用体フィールド corpus_export_options 。サービス固有のエクスポート オプション。corpus_export_options は次のいずれかになります。 |
|
mailOptions |
Gmail のエクスポート オプション。 |
groupsOptions |
Google グループの書き出しに関するオプション。 |
driveOptions |
ドライブの書き出しに関するオプション。 |
hangoutsChatOptions |
Chat のエクスポート オプション。 |
voiceOptions |
Voice の書き出しに関するオプション。 |
calendarOptions |
カレンダーのエクスポートで利用可能なオプションです。 |
MailExportOptions
Gmail のエクスポート オプション。
JSON 表現 |
---|
{
"exportFormat": enum ( |
フィールド | |
---|---|
exportFormat |
エクスポートされたメッセージのファイル形式。 |
showConfidentialModeContent |
情報保護モードのコンテンツをエクスポートするには、true に設定します。 |
useNewExport |
新しいエクスポート システムを使用するには、true に設定します。 |
exportLinkedDriveFiles |
(省略可)リンクされたドライブ ファイルのエクスポートを有効にするには、true に設定します。 |
ExportFormat
メッセージのエクスポート形式
列挙型 | |
---|---|
EXPORT_FORMAT_UNSPECIFIED |
エクスポート形式が指定されていません。 |
MBOX |
MBOX 形式でエクスポートします。Gmail、Google グループ、ハングアウト、Voice でのみご利用いただけます。 |
PST |
PST 形式でエクスポートします。Gmail、Google グループ、ハングアウト、Voice、カレンダーでのみご利用いただけます。 |
ICS |
ICS 形式でエクスポートカレンダーでのみ使用できます。 |
GroupsExportOptions
Google グループの書き出しに関するオプション。
JSON 表現 |
---|
{
"exportFormat": enum ( |
フィールド | |
---|---|
exportFormat |
エクスポートされたメッセージのファイル形式。 |
DriveExportOptions
ドライブの書き出しに関するオプション。
JSON 表現 |
---|
{ "includeAccessInfo": boolean } |
フィールド | |
---|---|
includeAccessInfo |
ファイルへの間接的なアクセス権を持つユーザーのアクセスレベル情報を含めるには、true に設定します。 |
HangoutsChatExportOptions
Chat のエクスポート オプション。
JSON 表現 |
---|
{
"exportFormat": enum ( |
フィールド | |
---|---|
exportFormat |
エクスポートされたメッセージのファイル形式。 |
VoiceExportOptions
Voice の書き出しに関するオプション。
JSON 表現 |
---|
{
"exportFormat": enum ( |
フィールド | |
---|---|
exportFormat |
エクスポートされたテキスト メッセージのファイル形式。 |
CalendarExportOptions
カレンダーの書き出しのオプション。
JSON 表現 |
---|
{
"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 |
すでに書き出し用に処理されたメッセージまたはファイルの数。 |
totalArtifactCount |
エクスポートされるメッセージまたはファイルの数。 |
sizeInBytes |
エクスポートのサイズ(バイト単位)。 |
CloudStorageSink
Cloud Storage ファイルのエクスポート シンク。
JSON 表現 |
---|
{
"files": [
{
object ( |
フィールド | |
---|---|
files[] |
出力のみ。Cloud Storage にエクスポートされたファイル。 |
CloudStorageFile
Cloud Storage 内のエクスポート ファイル
JSON 表現 |
---|
{ "bucketName": string, "objectName": string, "size": string, "md5Hash": string } |
フィールド | |
---|---|
bucketName |
エクスポート ファイル用の Cloud Storage バケットの名前。この値は Cloud Storage の JSON API または XML API で使用できますが、バケットの内容を一覧表示することはできません。代わりに、オブジェクト名で個々のエクスポート ファイルを取得できます。 |
objectName |
エクスポート ファイルの Cloud Storage オブジェクトの名前。この値は、Cloud Storage の JSON API または XML API で使用できます。 |
size |
エクスポート ファイルのサイズ。 |
md5Hash |
ファイルの md5 ハッシュ。 |
Methods |
|
---|---|
|
エクスポートを作成します。 |
|
エクスポートを削除します。 |
|
エクスポートを取得します。 |
|
指定した案件のエクスポートに関する詳細を一覧表示します。 |