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

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

API событий Google Workspace отправляет следующие типы событий жизненного цикла:

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

События жизненного цикла из API событий Google Workspace структурированы в соответствии со спецификацией CloudEvents. Для получения дополнительной информации см. раздел «Структура событий Google Workspace» .

События приостановки

При возникновении ошибки в подписке Google Workspace API событий Google Workspace приостанавливает подписку и предотвращает получение событий. Перед повторной активацией подписки необходимо устранить все ошибки.

Для уведомления о приостановке подписки API событий Google Workspace отправляет событие жизненного цикла с типом события google.workspace.events.subscription.v1.suspended .

После получения сообщения о приостановке подписки вы можете узнать причину приостановки, устранить возникшие ошибки и повторно активировать подписку. Подробнее см. раздел «Устранение ошибок и повторная активация подписки Google Workspace» .

Ниже представлено событие CloudEvent, относящееся к событию жизненного цикла подписки Google Workspace, которая была приостановлена ​​из-за ошибки ENDPOINT_PERMISSION_DENIED :

{
  "id": "EVENT_UUID",
  "source": "//workspaceevents.googleapis.com/subscriptions/SUBSCRIPTION_ID",
  "subject": "//workspaceevents.googleapis.com/subscriptions/SUBSCRIPTION_ID",
  "type": "google.workspace.events.subscription.v1.suspended",
  "time": "2023-06-08T06:50:43.641299Z",
  "spec_version": '1.0',
  "datacontenttype": "application/json",
  "data": {
    "subscription":{
      "name": "subscriptions/SUBSCRIPTION_ID",
      "suspension_reason": "ENDPOINT_PERMISSION_DENIED",
      ...
    }
  }
}

События-напоминания об истечении срока действия

После истечения срока действия подписки API Google Workspace Events безвозвратно удаляет её, и вы не можете её продлить или повторно активировать.

Чтобы уведомить вас об истечении срока действия подписки, API событий Google Workspace отправляет события жизненного цикла за 12 часов и за один час до истечения срока действия. Тип события для событий жизненного цикла — google.workspace.events.subscription.v1.expirationReminder .

При получении напоминания об истечении срока действия используйте метод subscriptions.update() для обновления времени истечения срока действия. Подробнее см. раздел «Обновление или продление подписки Google Workspace» .

Ниже показано событие CloudEvent, относящееся к жизненному циклу подписки Google Workspace, срок действия которой истекает:

{
  "id": "EVENT_UUID",
  "source": "//workspaceevents.googleapis.com/subscriptions/SUBSCRIPTION_ID",
  "subject": "//workspaceevents.googleapis.com/subscriptions/SUBSCRIPTION_ID",
  "type": "google.workspace.events.subscription.v1.expirationReminder",
  "time": "2023-06-08T06:50:43.641299Z",
  "spec_version": '1.0',
  "datacontenttype": "application/json",
  "data": {
    "subscription":{
      "name": "subscriptions/SUBSCRIPTION_ID",
      "expire_time": "2023-06-08T18:50:43.641299Z",
      ...
    }
  }
}

События, срок действия подписки на которые истек

API событий Google Workspace отправляет вам событие жизненного цикла, когда истекает срок действия подписки. Тип события для этого события жизненного цикла — google.workspace.events.subscription.v1.expired .

API событий Google Workspace безвозвратно удаляет просроченные подписки. Если срок действия вашей подписки истек, используйте метод subscriptions.create() для создания новой подписки. Подробнее см. раздел «Создание подписки Google Workspace» .

Ниже показано событие CloudEvent, относящееся к жизненному циклу подписки Google Workspace, срок действия которой истек:

{
  "id": "EVENT_UUID",
  "source": "//workspaceevents.googleapis.com/subscriptions/SUBSCRIPTION_ID",
  "subject": "//workspaceevents.googleapis.com/subscriptions/SUBSCRIPTION_ID",
  "type": "google.workspace.events.subscription.v1.expired",
  "time": "2023-06-08T07:00:00.000000Z",
  "spec_version": '1.0',
  "datacontenttype": "application/json",
  "data": {
    "subscription":{
      "name": "subscriptions/SUBSCRIPTION_ID",
      "expire_time": "2023-06-08T07:00:00.000000Z",
      ...
    }
  }
}