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)

この保留が最後に変更された日時。

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"。
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)

組織部門が保留された日時。このプロパティは変更できません。

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"。

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)

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

object (HeldHangoutsChatQuery)

Chat の記録保持に関するサービス固有のオプション。設定する場合は、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 で指定します。値は指定した日の午前 0 時に丸められます。

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"。
endTime

string (Timestamp format)

クエリの終了時間。GMT で指定します。値は指定した日の午前 0 時に丸められます。

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"。

HeldGroupsQuery

グループの記録保持のクエリ オプション。

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

string

ホールドの対象となるメールを絞り込むために使用される検索演算子。
startTime

string (Timestamp format)

クエリの開始時間。GMT で指定します。値は指定した日の午前 0 時に丸められます。

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"。
endTime

string (Timestamp format)

クエリの終了時間。GMT で指定します。値は指定した日の午前 0 時に丸められます。

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"。

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

 保留のスコープ（組織部門またはアカウント）とクエリ パラメータを更新します。