REST Resource: matters.holds

리소스: 보류

보류 보존 조치를 사용하면 지정된 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)

Drive 보류에 대한 서비스별 옵션 설정된 경우 CorpusType은 DRIVE여야 합니다.
mailQuery

object (HeldMailQuery)

Gmail 보존 조치에 대한 서비스별 옵션입니다. 설정하는 경우 CorpusType은 mail이어야 합니다.
groupsQuery

object (HeldGroupsQuery)

그룹스 보존 조치에 대한 서비스별 옵션입니다. 설정하는 경우 CorpusType은 GROUPS여야 합니다.
hangoutsChatQuery

object (HeldHangoutsChatQuery)

Chat 보존 조치에 대한 서비스별 옵션입니다. 설정된 경우 CorpusType은 HANGOUTS_CHAT이어야 합니다.
voiceQuery

object (HeldVoiceQuery)

Voice 대기 관련 서비스별 옵션입니다. 설정된 경우 CorpusType은 VOICE여야 합니다.
calendarQuery

object (HeldCalendarQuery)

Calendar 보존 조치에 대한 서비스별 옵션입니다. 설정된 경우 CorpusType은 CALENDAR여야 합니다.

HeldDriveQuery

Drive 보존 조치 옵션

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시로 반올림됩니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z" 및 "2014-10-02T15:01:23.045123456Z"입니다.
endTime

string (Timestamp format)

쿼리의 종료 시간입니다. GMT로 지정합니다. 값은 지정된 날짜의 오전 12시로 반올림됩니다.

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시로 반올림됩니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z" 및 "2014-10-02T15:01:23.045123456Z"입니다.
endTime

string (Timestamp format)

쿼리의 종료 시간입니다. GMT로 지정합니다. 값은 지정된 날짜의 오전 12시로 반올림됩니다.

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

Voice 보류 옵션

JSON 표현 
{
  "coveredData": [
    enum (VoiceCoveredData)
  ]
}
필드
coveredData[]

enum (VoiceCoveredData)

보존 조치가 적용되는 데이터 유형의 목록입니다. 비어 있지 않아야 합니다. 순서는 중요하지 않으며 중복은 무시됩니다.

HeldCalendarQuery

이 유형에는 필드가 없습니다.

Calendar 보존 조치 옵션

메서드

addHeldAccounts

 계정을 보존 조치에 추가합니다.

create

 지정된 법적 사안에서 보류 조치를 만듭니다.

delete

 지정된 보존 조치를 삭제하고 보존 조치가 적용된 계정 또는 조직 단위를 해제합니다.

get

 지정된 보존 조치를 가져옵니다.

list

 법적 사안의 보류를 표시합니다.

removeHeldAccounts

 보류 중인 지정된 계정을 삭제합니다.

update

 보존 조치의 범위 (조직 단위 또는 계정) 및 쿼리 매개변수를 업데이트합니다.