Ограничения и квоты использования

Ограничения и квоты защищают инфраструктуру Google от автоматизированного процесса, использующего API аудита электронной почты ненадлежащим образом. Чрезмерное количество запросов к API может быть результатом безобидной опечатки или неэффективной работы системы, выполняющей ненужные вызовы API. Независимо от причины, блокировка трафика из определенного источника при достижении им определенного уровня необходима для общей работоспособности системы Google Workspace. Ограничения помогают гарантировать, что действия одного разработчика не смогут негативно повлиять на все сообщество.

В маловероятном случае сбоя вашего API-запроса вы получите ответ с HTTP-кодом состояния. Код состояния 403 содержит информацию об ошибке, связанной с некорректными входными данными, а HTTP-код состояния 503 содержит информацию об ошибке, указывающую на превышение квот API. Эти ответы позволяют вашему пользовательскому приложению обнаруживать эти ошибки и предпринимать соответствующие действия.

Если ваши запросы должны быть выполнены за фиксированный период времени, отправляйте их параллельно или используйте несколько потоков в вашем Java- или C#-приложении. Примером параллельных запросов может служить запрос небольших партий электронных писем от разных пользователей, а не добавление или удаление большого количества писем от одного пользователя одновременно. В случае использования потоков попробуйте начать с 10 потоков, по одному потоку на каждое электронное письмо пользователя. Обратите внимание, что рекомендация по количеству потоков имеет свои компромиссы и не подходит для всех ситуаций с API. Если количество запросов становится слишком большим, возникают ошибки квоты. Другой пример компромисса — квота для API аудита электронной почты на максимальную общую скорость загрузки сообщений. Скорость загрузки составляет один запрос API в секунду на пользователя, независимо от того, сколько потоков выполняют запросы на загрузку.

Для всех ошибок, связанных со временем (максимум N событий в течение N секунд на поток), особенно для ошибок с кодом состояния 503 , мы рекомендуем, чтобы ваш код перехватывал исключение и, используя алгоритм экспоненциальной задержки , ждал небольшую паузу перед повторной попыткой неудачного вызова. Пример использования API аудита электронной почты: для одного потока нужно подождать 5 секунд и повторить неудачный вызов. Если запрос успешен, повторите этот шаблон для остальных потоков. Если второй запрос не удался, ваше приложение должно уменьшить частоту запросов до тех пор, пока один из них не будет успешным. Например, увеличьте начальную задержку в 5 секунд до 10 секунд и повторите неудачный вызов снова. Также определите лимит повторных попыток. Например, повторяйте запрос от 5 до 7 раз с разным временем задержки, прежде чем ваше приложение вернет пользователю ошибку.

В таблице ниже указаны ограничения для API аудита электронной почты:

Категории ограничений API Пределы
Создание зашифрованных файлов почтового ящика.

В зависимости от размера файлов, создание зашифрованных файлов почтового ящика может занять у системы до нескольких дней на подготовку.

Зашифрованные файлы почтового ящика, ошибки при удалении.

При удалении зашифрованного почтового ящика и возникновении ошибок запросу присваивается статус MARKED_DELETE . Эти сводки и файлы экспорта автоматически повторно удаляются Google в течение 24 часов (с возможным удалением оставшихся файлов). Если статус MARKED_DELETE возвращается постоянно, попробуйте стратегию экспоненциальной задержки.

В таблице ниже приведены квоты для API аудита электронной почты:

Категории квот API Квоты
Токены аутентификации ClientLogin

Действителен в течение 24 часов. Ошибка: 401 token expired .

Форматы дат

Перед использованием с API аудита электронной почты необходимо преобразовать все даты в формат всемирного координированного времени (UTC). Для получения дополнительной информации см. конвертер UTC .

Зашифрованные файлы почтового ящика, сводки EXPIRED и файлы экспорта.

Google хранит зашифрованные файлы почтовых ящиков в течение 3 недель. По истечении этого времени они удаляются. Администратор домена обязан загрузить эти файлы почтовых ящиков в течение указанного периода времени.

Зашифрованные файлы почтового ящика, формат

Зашифрованные файлы почтовых ящиков имеют формат mbox .

Зашифрованные файлы почтового ящика, максимальное количество запросов на создание.

Максимальное количество запросов на создание экспортируемых почтовых ящиков в день составляет 100 запросов от всех администраторов домена.

Статус файла зашифрованного почтового ящика, постраничная навигация

При запросе статуса всех почтовых ящиков ответы могут содержать большие объемы данных. API аудита электронной почты группирует эти данные в страницы, каждая из которых содержит максимум 100 записей, а URI в теге link rel='next' указывает на следующую страницу результатов. При разработке клиентского приложения ваш код должен обрабатывать эти дополнительные результаты.

Монитор электронной почты

Максимальное количество запросов на мониторинг электронной почты в день составляет 1500. Это ограничение действует для всего домена и включает все запросы, сделанные любым администратором в течение дня.

Открытый ключ

API аудита электронной почты поддерживает только один ключ.

Открытый ключ создан с использованием программного обеспечения GNU Privacy Guard (GPG). Он имеет формат PGP и представляет собой закодированный в ASCII ключ шифрования RSA. Перед загрузкой открытого ключа необходимо сначала преобразовать его в строку, закодированную в Base64. Файл открытого ключа должен быть в кодировке US-ASCII (предпочтительное название кодировки ASCII по версии IANA ).

Идет поиск

Параметры searchQuery и includeDeleted являются взаимоисключающими. Поисковый запрос невозможен, если includeDeleted="true" .