Lebenszyklusereignisse für Google Workspace-Abos empfangen und darauf reagieren

Auf dieser Seite werden die Lebenszyklusereignisse beschrieben, die Sie für Google Workspace-Abos erhalten, und wie Sie die Ereignisse nutzen können, um ein aktives Abo zu behalten.

Die Google Workspace Events API sendet die folgenden Arten von Lebenszyklusereignissen:

Ihre App sollte diese Lebenszyklus-Ereignistypen explizit verarbeiten und neue Ereignistypen ignorieren, die in Zukunft auftreten könnten.

Lebenszyklusereignisse aus der Google Workspace Events API sind gemäß der CloudEvents-Spezifikation strukturiert. Weitere Informationen finden Sie unter Struktur von Google Workspace-Ereignissen.

Sperrungsereignisse

Wenn bei einem Google Workspace-Abo ein Fehler auftritt, sperrt die Google Workspace Events API das Abo und verhindert, dass Ereignisse empfangen werden. Sie müssen alle Fehler im Zusammenhang mit dem Abo beheben, bevor Sie es reaktivieren können.

Wenn Sie über eine Sperrung informiert werden sollen, sendet die Google Workspace Events API ein Lebenszyklusereignis mit dem Ereignistyp google.workspace.events.subscription.v1.suspended.

Wenn Sie eine Sperrung erhalten, können Sie den Grund dafür ermitteln, Fehler beheben und das Abo reaktivieren. Weitere Informationen finden Sie im Hilfeartikel Fehler beheben und ein Google Workspace-Abo reaktivieren.

Im Folgenden sehen Sie ein CloudEvent für ein Lebenszyklusereignis zu einem Google Workspace-Abo, das aufgrund des Fehlers ENDPOINT_PERMISSION_DENIED ausgesetzt wurde:

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

Ereignisse für Ablaufzeit-Erinnerungen

Nach Ablauf eines Abos wird es von der Google Workspace Events API endgültig gelöscht und kann nicht verlängert oder reaktiviert werden.

Damit Sie über ein ablaufendes Abo informiert werden, sendet die Google Workspace Events API 12 Stunden und eine Stunde vor Ablauf Lebenszyklusereignisse. Der Ereignistyp für Lebenszyklusereignisse ist google.workspace.events.subscription.v1.expirationReminder.

Wenn Sie ein Ablauferinnerungsereignis erhalten, können Sie mit der Methode subscriptions.update() das Ablaufdatum aktualisieren. Weitere Informationen finden Sie unter Google Workspace-Abo aktualisieren oder verlängern.

Im Folgenden sehen Sie ein CloudEvent für ein Lebenszyklusereignis zu einem ablaufenden Google Workspace-Abo:

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

Ereignisse zum Ablauf des Abos

Die Google Workspace Events API sendet Ihnen ein Lebenszyklusereignis, wenn das Abo abläuft. Der Ereignistyp für dieses Lebenszyklusereignis ist google.workspace.events.subscription.v1.expired.

Abgelaufene Abos werden über die Google Workspace Events API endgültig gelöscht. Wenn Ihr Abo abläuft, können Sie mit der Methode subscriptions.create() ein neues Abo erstellen. Weitere Informationen finden Sie unter Google Workspace-Abo erstellen.

Im Folgenden sehen Sie ein CloudEvent für ein Lebenszyklusereignis zu einem abgelaufenen Google Workspace-Abo:

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