Ricevi e rispondi a eventi del ciclo di vita per gli abbonamenti a Google Workspace

Questa pagina spiega gli eventi del ciclo di vita che ricevi per gli abbonamenti a Google Workspace e come utilizzarli per mantenere attivo un abbonamento.

L'API Google Workspace Events invia i seguenti tipi di eventi del ciclo di vita:

La tua app deve gestire esplicitamente questi tipi di eventi del ciclo di vita e ignorare i nuovi tipi di eventi che potrebbero essere visualizzati in futuro.

Gli eventi del ciclo di vita dell'API Google Workspace Events sono strutturati in base alla specifica CloudEvents. Per saperne di più, vedi Struttura degli eventi di Google Workspace.

Eventi di sospensione

Quando si verifica un errore per un abbonamento a Google Workspace, l'API Google Workspace Events sospende l'abbonamento e impedisce la ricezione di eventi. Risolvi eventuali errori relativi all'abbonamento prima di riattivarlo.

Per comunicarti una sospensione, l'API Google Workspace Events invia un evento del ciclo di vita con il tipo di evento google.workspace.events.subscription.v1.suspended.

Dopo aver ricevuto una notifica di sospensione, puoi scoprire il motivo della sospensione, risolvere eventuali errori e riattivare l'iscrizione. Per maggiori dettagli, vedi Risolvere gli errori e riattivare un abbonamento a Google Workspace.

Di seguito è riportato un CloudEvent per un evento del ciclo di vita relativo a un abbonamento a Google Workspace sospeso a causa dell'errore 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",
      ...
    }
  }
}

Eventi di promemoria relativi alla scadenza

Una volta scaduto un abbonamento, l'API Google Workspace Events lo elimina definitivamente e non puoi rinnovarlo o riattivarlo.

Per avvisarti della scadenza di un abbonamento, l'API Google Workspace Events invia eventi del ciclo di vita 12 ore e 1 ora prima dell'ora di scadenza. Il tipo di evento per gli eventi del ciclo di vita è google.workspace.events.subscription.v1.expirationReminder.

Quando ricevi un evento di promemoria di scadenza, utilizza il metodo subscriptions.update() per aggiornare l'ora di scadenza. Per maggiori dettagli, vedi Aggiornare o rinnovare un abbonamento a Google Workspace.

Di seguito è riportato un CloudEvent per un evento del ciclo di vita relativo a un abbonamento a Google Workspace in scadenza:

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

Eventi di abbonamento scaduto

L'API Google Workspace Events ti invia un evento del ciclo di vita quando la sottoscrizione scade. Il tipo di evento per questo evento del ciclo di vita è google.workspace.events.subscription.v1.expired.

L'API Google Workspace Events elimina definitivamente gli abbonamenti scaduti. Se l'abbonamento scade, utilizza il metodo subscriptions.create() per crearne un altro. Per maggiori dettagli, vedi Creare un abbonamento a Google Workspace.

Di seguito è riportato un CloudEvent per un evento del ciclo di vita relativo a un abbonamento a Google Workspace scaduto:

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