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

Уникальный неизменяемый идентификатор бронирования. Присваивается при создании.

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 .

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-представление 
{

  "driveQuery": {
    object (HeldDriveQuery)
  },
  "mailQuery": {
    object (HeldMailQuery)
  },
  "groupsQuery": {
    object (HeldGroupsQuery)
  },
  "hangoutsChatQuery": {
    object (HeldHangoutsChatQuery)
  },
  "voiceQuery": {
    object (HeldVoiceQuery)
  },
  "calendarQuery": {
    object (HeldCalendarQuery)
  },
  "geminiQuery": {
    object (HeldGeminiQuery)
  }
}
Поля
Поле объединения corpus_query . Если задано, оно должно соответствовать типу сервиса. corpus_query может принимать только одно из следующих значений:
driveQuery

object ( HeldDriveQuery )

Специфические для сервиса параметры для хранения данных в Диске. Если задано, CorpusType должен быть DRIVE .

mailQuery

object ( HeldMailQuery )

Специфические параметры для удержаний в Gmail. Если задано, CorpusType должен быть MAIL .

groupsQuery

object ( HeldGroupsQuery )

Параметры групп, специфичные для конкретной службы, должны быть заданы. Если задано, CorpusType должен быть GROUPS .

hangoutsChatQuery

object ( HeldHangoutsChatQuery )

Параметры, специфичные для сервиса, для удержания сообщений в чате. Если задано, CorpusType должен быть HANGOUTS_CHAT .

voiceQuery

object ( HeldVoiceQuery )

Параметры, специфичные для конкретного сервиса, для удержания голосовых вызовов. Если задано, CorpusType должен быть VOICE .

calendarQuery

object ( HeldCalendarQuery )

Параметры, специфичные для конкретного сервиса, для блокировки календаря. Если задано, CorpusType должен быть CALENDAR .

geminiQuery

object ( HeldGeminiQuery )

Параметры, специфичные для сервиса Gemini. Если задано, CorpusType должен быть GEMINI .

HoldDriveQuery

Параметры блокировки диска.

JSON-представление 
{
  "includeTeamDriveFiles": boolean,
  "includeSharedDriveFiles": boolean
}
Поля
includeTeamDriveFiles
(deprecated)

boolean

Чтобы включить файлы из Team Drive в блокировку, установите значение true .

includeSharedDriveFiles

boolean

Чтобы включить файлы с общих дисков в блокировку, установите значение true .

HoldMailQuery

Параметры запроса для удержаний в Gmail.

JSON-представление 
{
  "terms": string,
  "startTime": string,
  "endTime": string
}
Поля
terms

string

Поисковые операторы использовались для уточнения сообщений, попавших под блокировку.

startTime

string ( Timestamp format)

Время начала запроса. Укажите в формате GMT. Значение округляется до 12:00 утра указанной даты.

Используется 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. Значение округляется до 12:00 утра указанной даты.

Используется 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" .

HoldGroupsQuery

Параметры запроса для групповых блокировок.

JSON-представление 
{
  "terms": string,
  "startTime": string,
  "endTime": string
}
Поля
terms

string

Поисковые операторы использовались для уточнения сообщений, попавших под блокировку.

startTime

string ( Timestamp format)

Время начала запроса. Укажите в формате GMT. Значение округляется до 12:00 утра указанной даты.

Используется 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. Значение округляется до 12:00 утра указанной даты.

Используется 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

Варианты удержания чата.

JSON-представление 
{
  "includeRooms": boolean
}
Поля
includeRooms

boolean

Чтобы сообщения из чатов, в которых пользователь состоял, отображались в значении true .

HoldVoiceQuery

Варианты удержания голосового вызова.

JSON-представление 
{
  "coveredData": [
    enum (VoiceCoveredData)
  ]
}
Поля
coveredData[]

enum ( VoiceCoveredData )

Список типов данных, на которые распространяется блокировка. Список должен быть непустым. Порядок не имеет значения, дубликаты игнорируются.

HeldCalendarQuery

Этот тип не содержит полей.

Параметры для блокировки календаря.

HeldGeminiQuery

Этот тип не содержит полей.

Опционы для Близнецов сохранены.

Методы

addHeldAccounts

 Добавляет учетные записи в список заблокированных.

create

 Создает блокировку указанного материала.

delete

 Снимает указанную блокировку и освобождает счета или организационное подразделение, на которые распространялась блокировка.

get

 Получает указанную блокировку.

list

 Содержит перечень ограничений по делу.

removeHeldAccounts

 Снимает блокировку с указанных счетов.

update

 Обновляет область действия (организационное подразделение или счета) и параметры запроса для блокировки.