REST Resource: matters.holds

Ресурс: Держите

Удержание. Удержание не позволяет указанной службе Google Workspace удалять данные для определенных аккаунтов или всех участников организационного подразделения.

Для работы с ресурсами Сейфа у учетной записи должны быть необходимые права Сейфа и доступ к делу. Чтобы получить доступ к делу, учетная запись должна создать дело, предоставить доступ к делу или иметь право просмотра всех дел .

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)

Последний раз это удержание было изменено.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "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 .

ХелдОргЮнит

Организационная единица, на которую распространяется запрет. Эта структура неизменна.

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

string

Неизменяемый идентификатор организационного подразделения, предоставленный Admin SDK .

holdTime

string ( Timestamp format)

Когда организационное подразделение было приостановлено. Это свойство неизменяемо.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

Корпусзапрос

Параметры удержания для конкретных услуг.

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)
  }
  // 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 )

Параметры удержания чата для конкретных служб. Если установлено, CorpusType должен быть HANGOUTS_CHAT .

voiceQuery

object ( HeldVoiceQuery )

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

Хелддрайвекуери

Варианты запретов на удаление на Диске.

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

boolean

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

includeSharedDriveFiles

boolean

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

Хелдмейлкуери

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

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

string

Операторы поиска уточняли сообщения, на которые распространяется запрет.

startTime

string ( Timestamp format)

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

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

endTime

string ( Timestamp format)

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

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "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)

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

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

endTime

string ( Timestamp format)

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

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

HeldHangoutsChatQuery

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

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

boolean

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

Хелдвоицекуери

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

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

enum ( VoiceCoveredData )

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

Методы

addHeldAccounts

 Добавляет аккаунты в удержание.

create

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

delete

 Удаляет указанное удержание и освобождает аккаунты или организационное подразделение, на которые распространяется удержание.

get

 Получает указанное удержание.

list

 Перечисляет запреты на дело.

removeHeldAccounts

 Удаляет указанные учетные записи из режима удержания.

update

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