REST Resource: matters.holds

リソース: Hold

保留。記録保持（リティゲーション ホールド）を設定すると、指定した Google Workspace サービスで特定のアカウントや組織部門のすべてのメンバーのデータが完全に削除されることを防止できます。

Vault リソースを操作するには、アカウントに必要な Vault 権限と案件へのアクセス権が必要です。案件にアクセスするには、アカウントが案件を作成したか、案件を共有しているか、または [全案件の閲覧] 権限を持っている必要があります。

JSON 表現 
{
  "holdId": string,
  "name": string,
  "updateTime": string,
  "accounts": [
    {
      object (HeldAccount)
    }
  ],
  "orgUnit": {
    object (HeldOrgUnit)
  },
  "corpus": enum (CorpusType),
  "query": {
    object (CorpusQuery)
  }
}
フィールド
holdId

string

記録保持の一意の不変 ID。作成時に割り当てられます。
name

string

記録保持の名前。
updateTime

string (Timestamp format)

この記録保持が最後に変更された時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
accounts[]

object (HeldAccount)

設定すると、指定したアカウントに記録保持が適用されます。orgUnit は空にする必要があります。
orgUnit

object (HeldOrgUnit)

記録保持を設定すると、組織部門のすべてのメンバーに記録保持が適用され、アカウントは空にする必要があります。このプロパティは変更可能です。グループの記録保持の場合は、アカウントを設定します。
corpus

enum (CorpusType)

検索するサービス。
query

object (CorpusQuery)

サービス固有のオプション。設定する場合、CorpusQuery は CorpusType と一致する必要があります。

HeldOrgUnit

記録保持（リティゲーション ホールド）の対象となっている組織部門。この構造は変更できません。

JSON 表現 
{
  "orgUnitId": string,
  "holdTime": string
}
フィールド
orgUnitId

string

Admin SDK が提供する組織部門の不変 ID。
holdTime

string (Timestamp format)

組織部門が記録保持の対象となった日時。このプロパティは変更できません。

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

CorpusQuery

サービス固有の保留オプション。

JSON 表現 
{

  // Union field corpus_query can be only one of the following:
  "driveQuery": {
    object (HeldDriveQuery)
  },
  "mailQuery": {
    object (HeldMailQuery)
  },
  "groupsQuery": {
    object (HeldGroupsQuery)
  },
  "hangoutsChatQuery": {
    object (HeldHangoutsChatQuery)
  },
  "voiceQuery": {
    object (HeldVoiceQuery)
  },
  "calendarQuery": {
    object (HeldCalendarQuery)
  }
  // End of list of possible types for union field corpus_query.
}
フィールド
共用体フィールド corpus_query。設定する場合は、サービスタイプと一致する必要があります。corpus_query は次のいずれかになります。
driveQuery

object (HeldDriveQuery)

ドライブの記録保持に関するサービス固有のオプション。設定する場合は、CorpusType を DRIVE にする必要があります。
mailQuery

object (HeldMailQuery)

Gmail の記録保持（リティゲーション ホールド）のサービス固有のオプション。設定する場合は、CorpusType を Mail にする必要があります。
groupsQuery

object (HeldGroupsQuery)

Google グループの記録保持に関するサービス固有のオプション。設定する場合、CorpusType は GROUPS にする必要があります。
hangoutsChatQuery

object (HeldHangoutsChatQuery)

チャットの記録保持（リティゲーション ホールド）に関するサービス固有のオプション。設定する場合は、CorpusType を HANGOUTS_CHAT にする必要があります。
voiceQuery

object (HeldVoiceQuery)

音声の記録保持（リティゲーション ホールド）に関するサービス固有のオプション。設定する場合は、CorpusType を VOICE にする必要があります。
calendarQuery

object (HeldCalendarQuery)

カレンダーの記録保持（リティゲーション ホールド）に関するサービス固有のオプション。設定する場合は、CorpusType を CALENDAR にする必要があります。

HeldDriveQuery

ドライブの記録保持のオプション。

JSON 表現 
{
  "includeTeamDriveFiles": boolean,
  "includeSharedDriveFiles": boolean
}
フィールド
includeTeamDriveFiles
(deprecated)

boolean

チームドライブ内のファイルを記録保持に含めるには、true に設定します。
includeSharedDriveFiles

boolean

共有ドライブ内のファイルを記録保持に含めるには、true に設定します。

HeldMailQuery

Gmail の記録保持（リティゲーション ホールド）のクエリ オプション。

JSON 表現 
{
  "terms": string,
  "startTime": string,
  "endTime": string
}
フィールド
terms

string

記録保持対象のメッセージを絞り込むための検索演算子。
startTime

string (Timestamp format)

クエリの開始時刻。GMT で指定します。値は指定された日付の午前 12 時（00:00）に丸められます。

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

string (Timestamp format)

クエリの終了時間。GMT で指定します。値は指定された日付の午前 12 時（00:00）に丸められます。

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

HeldGroupsQuery

グループの記録保持（リティゲーション ホールド）のクエリ オプション。

JSON 表現 
{
  "terms": string,
  "startTime": string,
  "endTime": string
}
フィールド
terms

string

記録保持対象のメッセージを絞り込むための検索演算子。
startTime

string (Timestamp format)

クエリの開始時刻。GMT で指定します。値は指定された日付の午前 12 時（00:00）に丸められます。

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

string (Timestamp format)

クエリの終了時間。GMT で指定します。値は指定された日付の午前 12 時（00:00）に丸められます。

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

HeldHangoutsChatQuery

Chat の記録保持（リティゲーション ホールド）のオプション。

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

boolean

ユーザーがメンバーだった Chat スペースのメッセージを含めるには、true に設定します。

HeldVoiceQuery

音声の記録保持（リティゲーション ホールド）のオプション

JSON 表現 
{
  "coveredData": [
    enum (VoiceCoveredData)
  ]
}
フィールド
coveredData[]

enum (VoiceCoveredData)

記録保持の対象となるデータ型のリスト。空にすることはできません。順序は重要ではなく、重複する内容は無視されます。

HeldCalendarQuery

この型にはフィールドがありません。

カレンダーの記録保持（リティゲーション ホールド）のオプション。

メソッド

addHeldAccounts

 アカウントを記録保持に追加する。

create

 指定した案件に記録保持を作成します。

delete

 指定した記録保持を解除し、記録保持の対象となっているアカウントまたは組織部門を解除します。

get

 指定した保留を取得します。

list

 案件の記録保持を一覧表示します。

removeHeldAccounts

 指定したアカウントを記録保持から削除します。

update

 記録保持の範囲（組織部門またはアカウント）とクエリ パラメータを更新します。