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

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

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

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

События жизненного цикла из API Google Workspace Events структурированы в соответствии со спецификацией 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 Events отправляет события жизненного цикла за 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 Events навсегда удаляет подписки с истекшим сроком действия. Если срок действия вашей подписки истек, вы можете использовать метод 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",
      ...
    }
  }
}