Recibe y responde eventos del ciclo de vida de las suscripciones a Google Workspace

En esta página, se explican los eventos de ciclo de vida que recibes para las suscripciones de Google Workspace y cómo puedes usarlos para mantener una suscripción activa.

La API de Google Workspace Events envía los siguientes tipos de eventos de ciclo de vida:

Tu app debe controlar explícitamente estos tipos de eventos de ciclo de vida e ignorar los nuevos tipos de eventos que podrían aparecer en el futuro.

Los eventos de ciclo de vida de la API de Google Workspace Events se estructuran de acuerdo con la especificación de CloudEvents. Para obtener más información, consulta Estructura de los eventos de Google Workspace.

Eventos de suspensión

Cuando se produce un error en una suscripción a Google Workspace, la API de Google Workspace Events suspende la suscripción y evita que reciba eventos. Debes resolver cualquier error de la suscripción antes de reactivarla.

Para notificarte sobre una suspensión, la API de Google Workspace Events envía un evento de ciclo de vida con el tipo de evento google.workspace.events.subscription.v1.suspended.

Después de recibir un evento de suspensión, puedes obtener información sobre el motivo de la suspensión, resolver cualquier error y reactivar la suscripción. Para obtener más información, consulta Cómo resolver errores y reactivar una suscripción a Google Workspace.

A continuación, se muestra un CloudEvent para un evento de ciclo de vida sobre una suscripción a Google Workspace que se suspendió debido al error 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",
      ...
    }
  }
}

Eventos de recordatorio de vencimiento

Una vez que vence una suscripción, la API de Google Workspace Events la borra de forma permanente y no puedes renovarla ni reactivarla.

Para notificarte sobre una suscripción que vencerá pronto, la API de Google Workspace Events envía eventos de ciclo de vida 12 horas y una hora antes de la fecha de vencimiento. El tipo de evento para los eventos de ciclo de vida es google.workspace.events.subscription.v1.expirationReminder.

Cuando recibes un evento de recordatorio de vencimiento, puedes usar el método subscriptions.update() para actualizar la fecha y hora de vencimiento. Para obtener más información, consulta Cómo actualizar o renovar una suscripción a Google Workspace.

A continuación, se muestra un CloudEvent para un evento de ciclo de vida sobre una suscripción a Google Workspace que está por vencer:

{
  "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",
      ...
    }
  }
}

Eventos vencidos de suscripciones

La API de Google Workspace Events te envía un evento de ciclo de vida cuando vence la suscripción. El tipo de evento para este evento de ciclo de vida es google.workspace.events.subscription.v1.expired.

La API de Google Workspace Events borra de forma permanente las suscripciones vencidas. Si tu suscripción vence, puedes usar el método subscriptions.create() para crear otra. Para obtener más información, consulta Crea una suscripción a Google Workspace.

A continuación, se muestra un CloudEvent para un evento de ciclo de vida de una suscripción vencida a 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",
      ...
    }
  }
}