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 verwenden, um ein aktives Abo aufrechtzuerhalten.

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

Sperrungsereignisse, die Sie benachrichtigen, wenn Ihr Abo aufgrund eines Fehlers gesperrt wird.
Erinnerungsereignisse zum Ablauf, die Sie darüber informieren, dass Ihr Abo bald abläuft.
Abgelaufene Ereignisse, die Sie benachrichtigen, wenn Ihr Abo abläuft.

Ihre App sollte diese Arten von Lebenszyklusereignissen explizit verarbeiten und neue Ereignistypen, die in Zukunft möglicherweise hinzukommen, ignorieren.

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

Sperrereignisse

Wenn bei einem Google Workspace-Abo ein Fehler auftritt, wird das Abo von der Google Workspace Events API gesperrt und kann keine Ereignisse mehr empfangen. Beheben Sie alle Fehler im Zusammenhang mit dem Abo, bevor Sie es reaktivieren.

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

Nachdem Sie eine Sperrung erhalten haben, können Sie den Grund für die Sperrung herausfinden, alle Fehler beheben und das Abo reaktivieren. Weitere Informationen finden Sie unter Fehler beheben und Google Workspace-Abo reaktivieren.

Das Folgende zeigt ein CloudEvent für ein Lebenszyklusereignis zu einem Google Workspace-Abo, das aufgrund des Fehlers ENDPOINT_PERMISSION_DENIED gesperrt 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",
      ...
    }
  }
}

Erinnerungen an den Ablauf

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

Um Sie über ein ablaufendes Abo zu benachrichtigen, sendet die Google Workspace Events API 12 Stunden und eine Stunde vor dem Ablaufzeitpunkt Lebenszyklusereignisse. Der Ereignistyp für Lebenszyklusereignisse ist google.workspace.events.subscription.v1.expirationReminder.

Wenn Sie eine Erinnerung an den Ablauf erhalten, verwenden Sie die Methode subscriptions.update(), um die Ablaufzeit zu aktualisieren. Weitere Informationen finden Sie unter Google Workspace-Abo aktualisieren oder verlängern.

Das Folgende zeigt 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 bei Aboablauf

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.

Mit der Google Workspace Events API werden abgelaufene Abos endgültig gelöscht. Wenn Ihr Abo abläuft, verwenden Sie die Methode subscriptions.create(), um ein weiteres Abo zu erstellen. Weitere Informationen finden Sie unter Google Workspace-Abo erstellen.

Das Folgende zeigt 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",
      ...
    }
  }
}