Ресурс: Подписка
Подписка на получение событий о ресурсе Google Workspace. Дополнительную информацию о подписках см. в обзоре API Google Workspace Events .
JSON-представление |
---|
{ "name": string, "uid": string, "targetResource": string, "eventTypes": [ string ], "payloadOptions": { object ( |
Поля | |
---|---|
name | Необязательный. Неизменяемый. Идентификатор. Имя ресурса подписки. Формат: |
uid | Только вывод. Назначаемый системой уникальный идентификатор подписки. |
targetResource | Необходимый. Неизменяемый. Ресурс Google Workspace, события которого отслеживаются, в формате полного имени ресурса . Чтобы узнать о целевых ресурсах и событиях, которые они поддерживают, см. раздел Поддерживаемые события Google Workspace . Пользователь может разрешить вашему приложению создать только одну подписку для данного целевого ресурса. Если ваше приложение попытается создать другую подписку с теми же учетными данными пользователя, запрос вернет ошибку |
eventTypes[] | Необходимый. Неизменяемый. Неупорядоченный список. Вход для создания подписки. В противном случае только вывод. Один или несколько типов событий, которые необходимо получить о целевом ресурсе. Отформатировано в соответствии со спецификацией CloudEvents. Поддерживаемые типы событий зависят от целевого ресурса вашей подписки. Подробную информацию см. в разделе Поддерживаемые события Google Workspace . По умолчанию вы также получаете события о жизненном цикле вашей подписки . Вам не нужно указывать события жизненного цикла для этого поля. Если вы укажете тип события, который не существует для целевого ресурса, запрос вернет код состояния HTTP |
payloadOptions | Необязательный. Параметры того, какие данные включать в полезные данные события. Поддерживается только для событий Google Chat. |
notificationEndpoint | Необходимый. Неизменяемый. Конечная точка, куда подписка доставляет события, например тему Pub/Sub. |
state | Только вывод. Состояние подписки. Определяет, может ли подписка получать события и доставлять их в конечную точку уведомлений. |
suspensionReason | Только вывод. Ошибка, приостановившая подписку. Чтобы повторно активировать подписку, устраните ошибку и вызовите метод |
authority | Только вывод. Пользователь, авторизовавший создание подписки. Формат: Для пользователей Google Workspace значением |
createTime | Только вывод. Время создания подписки. |
updateTime | Только вывод. Время последнего обновления подписки. |
reconciling | Только вывод. Если |
etag | Необязательный. Эта контрольная сумма вычисляется сервером на основе значений других полей и может отправляться в запросах на обновление, чтобы убедиться, что клиент имеет актуальное значение, прежде чем продолжить. |
Максимальный срок действия зависит от того, включает ли ваша подписка данные ресурсов в полезные данные событий (указанные в поле
По истечении срока подписки она автоматически удаляется. Вы получаете события жизненного цикла на Чтобы предотвратить истечение срока действия подписки, вы можете использовать метод | |
expireTime | Непустое значение по умолчанию. Временная метка в формате UTC, когда истекает срок действия подписки. Всегда отображается на выходе, независимо от того, что использовалось на входе. |
ttl | Только ввод. Срок жизни (TTL) или продолжительность подписки. Если не указано или установлено значение |
Параметры полезной нагрузки
Параметры того, какие данные включать в полезные данные события. Поддерживается только для событий Google Chat.
JSON-представление |
---|
{ "includeResource": boolean, "fieldMask": string } |
Поля | |
---|---|
includeResource | Необязательный. Включает ли полезная нагрузка события данные об изменившемся ресурсе. Например, для события, в котором было создано сообщение Google Chat, содержит ли полезная нагрузка данные о ресурсе |
fieldMask | Необязательный. Если Если вы укажете поле, которого не существует для ресурса, система проигнорирует это поле. |
Конечная точка уведомления
Конечная точка, куда подписка доставляет события.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
| |
pubsubTopic | Неизменяемый. Тема Cloud Pub/Sub, которая получает события для подписки. Формат: Вы должны создать тему в том же проекте Google Cloud, в котором вы создаете эту подписку. Когда тема получает события, они кодируются как сообщения Cloud Pub/Sub. Подробную информацию см. в привязке протокола Google Cloud Pub/Sub для CloudEvents . |
Состояние
Возможные состояния подписки.
Перечисления | |
---|---|
STATE_UNSPECIFIED | Значение по умолчанию. Это значение не используется. |
ACTIVE | Подписка активна и может получать и доставлять события в конечную точку уведомлений. |
SUSPENDED | Подписка не может получать события из-за ошибки. Чтобы определить ошибку, просмотрите поле . |
DELETED | Подписка удалена. |
Тип ошибки
Возможные ошибки при подписке.
Перечисления | |
---|---|
ERROR_TYPE_UNSPECIFIED | Значение по умолчанию. Это значение не используется. |
USER_SCOPE_REVOKED | Авторизующийся пользователь отозвал предоставление одной или нескольких областей OAuth. Дополнительные сведения об авторизации для Google Workspace см. в разделе Настройка экрана согласия OAuth . |
RESOURCE_DELETED | Целевой ресурс для подписки больше не существует. |
USER_AUTHORIZATION_FAILURE | Пользователь, авторизовавший создание подписки, больше не имеет доступа к целевому ресурсу подписки. |
ENDPOINT_PERMISSION_DENIED | Приложение Google Workspace не имеет доступа для доставки событий в конечную точку уведомлений вашей подписки. |
ENDPOINT_NOT_FOUND | Конечная точка уведомлений подписки не существует, или конечную точку невозможно найти в проекте Google Cloud, в котором вы создали подписку. |
ENDPOINT_RESOURCE_EXHAUSTED | Конечная точка уведомлений подписки не смогла получить события из-за недостаточной квоты или достижения ограничения скорости. |
OTHER | Произошла неопознанная ошибка. |
Методы | |
---|---|
| Создает подписку на Google Workspace. |
| Удаляет подписку на Google Workspace. |
| Получает сведения о подписке на Google Workspace. |
| Перечисляет подписки Google Workspace. |
| Обновляет или продлевает подписку на Google Workspace. |
| Повторно активирует приостановленную подписку на Google Workspace. |