Прежде чем вызывать Mail Admin Quarantine API, выполните действия, описанные на этой странице, чтобы включить API, найти идентификаторы, необходимые для каждого запроса, и предоставить необходимые права администратора в аккаунте Google Workspace.
Требования
- Аккаунт Google Workspace с функцией карантина администратора. Подробнее о том, как настроить правила карантина и управлять ими…
- Проект Google Cloud. Подробнее о том, как создать проект…
- Участие в программе предварительной версии для разработчиков Google Workspace. Чтобы вызывать Admin Quarantine API, ваш облачный проект должен быть зарегистрирован в программе.
- Доступ к консоли администратора Google с правами суперадминистратора, чтобы предоставлять права администратора и разрешать делегирование доступа к данным в домене.
Включение API
Включите mailadminquarantine.googleapis.com в облачном проекте, в котором размещена ваша интеграция.
Консоль
В консоли Google Cloud включите Mail Admin Quarantine API.
gcloud
Выполните следующую команду, заменив PROJECT_ID на идентификатор своего облачного проекта:
gcloud services enable mailadminquarantine.googleapis.com \
--project=PROJECT_ID
Как узнать свой идентификатор клиента
Каждый запрос к Admin Quarantine API идентифицирует ваш аккаунт Google Workspace с помощью названия ресурса customers/CUSTOMER_ID.
Чтобы найти идентификатор клиента, выполните следующие действия:
- Войдите в консоль администратора.
- Выберите Аккаунт > Настройки аккаунта > Профиль.
- Скопируйте идентификатор клиента.
Если идентификатор клиента начинается с C, удалите C и используйте оставшееся буквенно-цифровое значение в названии ресурса, например customers/01abc23de.
Не используйте доменное имя в качестве идентификатора клиента.
Подробнее о том, как найти идентификатор клиента…
Предоставьте необходимые права администратора
Admin Quarantine API применяет те же проверки прав администратора, что и карантин в консоли администратора. Каждый запрос выполняется от имени администратора Google Workspace, у которого должно быть одно из следующих прав Gmail:
| Рио Секрето – эксклюзивный тур | Что это дает |
|---|---|
| Доступ к административному карантину | Управление электронными письмами и доступ к ним во всех карантинах, включая основной. |
| Доступ к специальным карантинам | Управление сообщениями и доступ к ним только в карантинах, связанных с группами, участником которых является администратор. |
Суперадминистраторы имеют такие права по умолчанию. Другим администраторам назначьте роль, которая включает это право:
- Войдите в консоль администратора как суперадминистратор.
- Выберите Аккаунт > Роли администраторов.
- Выберите существующую роль или нажмите Создать роль.
- На вкладке Права выберите Сервисы > Gmail и установите флажок Доступ к административному карантину или Доступ к специальным карантинам.
- Назначьте роль аккаунту администратора, от имени которого интеграция вызывает API.
Подробные сведения о ролях уполномоченных администраторов приведены в статьях Как делегировать права администратора в Gmail и Определения прав администратора.
Если у администратора, от имени которого выполняется запрос, нет нужного права, API возвращает ошибку 403 PERMISSION_DENIED.