Otrzymywanie zdarzeń cyklu życia subskrypcji Google Workspace i odpowiadanie na nie

Na tej stronie opisujemy zdarzenia cyklu życia, które otrzymujesz w przypadku subskrypcji Google Workspace, oraz wyjaśniamy, jak za ich pomocą utrzymywać aktywną subskrypcję.

Interfejs Google Workspace Event API wysyła te typy zdarzeń cyklu życia:

Aplikacja powinna wyraźnie obsługiwać te typy zdarzeń cyklu życia i ignorować nowe, które mogą się pojawić w przyszłości.

Zdarzenia cyklu życia z interfejsu Google Workspace events API są uporządkowane zgodnie ze specyfikacją CloudEvents. Więcej informacji znajdziesz w artykule Struktura zdarzeń Google Workspace.

Zdarzenia zawieszenia

Gdy w przypadku subskrypcji Google Workspace wystąpi błąd, interfejs Google Workspace Event API zawiesza subskrypcję i uniemożliwia jej odbieranie zdarzeń. Zanim ponownie aktywujesz subskrypcję, musisz naprawić wszystkie błędy.

Aby powiadomić Cię o zawieszeniu, interfejs Google Workspace Event API wysyła zdarzenie cyklu życia z typem zdarzenia google.workspace.events.subscription.v1.suspended.

Gdy otrzymasz takie zdarzenie, możesz dowiedzieć się więcej o jego przyczynie, naprawić ewentualne błędy i ponownie aktywować subskrypcję. Więcej informacji znajdziesz w artykule Naprawianie błędów i ponowne aktywowanie subskrypcji Google Workspace.

Poniżej znajdziesz zdarzenie CloudEvent związane ze zdarzeniem cyklu życia subskrypcji Google Workspace, która została zawieszona z powodu błędu 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",
      ...
    }
  }
}

Przypomnienia o wygaśnięciu

Po wygaśnięciu subskrypcji interfejs Google Workspace Event API trwale ją usuwa i nie można jej odnawiać ani aktywować.

Aby powiadomić Cię o wygaśnięciu subskrypcji, interfejs Google Workspace Event API wysyła zdarzenia cyklu życia na 12 godzin i 1 godzinę przed upływem czasu jej wygaśnięcia. Typ zdarzenia dla zdarzeń cyklu życia to google.workspace.events.subscription.v1.expirationReminder.

Gdy otrzymasz przypomnienie o wygaśnięciu, możesz zaktualizować czas ważności za pomocą metody subscriptions.update(). Więcej informacji znajdziesz w artykule Aktualizowanie i odnawianie subskrypcji Google Workspace.

Poniżej znajdziesz zdarzenie CloudEvent w przypadku zdarzenia cyklu życia dotyczącego wygasającej subskrypcji 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",
      ...
    }
  }
}

Zdarzenia, których subskrypcja wygasła

Po wygaśnięciu subskrypcji interfejs Google Workspace Event API wysyła Ci zdarzenie cyklu życia. Typ zdarzenia dla tego zdarzenia cyklu życia to google.workspace.events.subscription.v1.expired.

Google Workspace Event API trwale usuwa wygasłe subskrypcje. Gdy subskrypcja wygaśnie, możesz utworzyć kolejną subskrypcję za pomocą metody subscriptions.create(). Szczegółowe informacje znajdziesz w artykule Tworzenie subskrypcji Google Workspace.

Poniżej znajdziesz zdarzenie CloudEvent związane ze zdarzeniem cyklu życia, którego subskrypcja Google Workspace wygasła:

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