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

Na tej stronie znajdziesz informacje o zdarzeniach cyklu życia subskrypcji Google Workspace oraz o tym, jak możesz ich używać do utrzymywania aktywnej subskrypcji.

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

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

Zdarzenia cyklu życia z interfejsu Events API w Google Workspace są ustrukturyzowane zgodnie ze specyfikacją CloudEvents. Więcej informacji znajdziesz w artykule Struktura wydarzeń Google Workspace.

Wydarzenia związane z zawieszeniem

Gdy wystąpi błąd w subskrypcji Google Workspace, interfejs Events API w Google Workspace zawiesza subskrypcję i uniemożliwia jej otrzymywanie zdarzeń. Przed ponownym aktywowaniem subskrypcji musisz naprawić wszystkie błędy.

Aby powiadomić Cię o zawieszeniu, interfejs Events API w Google Workspace wysyła zdarzenie cyklu życia o typie google.workspace.events.subscription.v1.suspended.

Po otrzymaniu powiadomienia o zawieszeniu możesz dowiedzieć się, dlaczego doszło do zawieszenia, usunąć błędy i ponownie aktywować subskrypcję. Szczegółowe informacje znajdziesz w artykule Rozwiązywanie problemów i ponowna aktywacja subskrypcji Google Workspace.

Poniżej przedstawiono CloudEvent dla zdarzenia cyklu życia dotyczącego abonamentu Google Workspace, który został zawieszony 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",
      ...
    }
  }
}

Zdarzenia przypomnienia o wygaśnięciu

Po wygaśnięciu subskrypcji interfejs Google Workspace Events API usuwa ją na stałe, przez co nie można jej odnowić ani ponownie aktywować.

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

Gdy otrzymasz zdarzenie przypomnienia o wygaśnięciu, możesz użyć metody subscriptions.update(), aby zaktualizować czas wygaśnięcia. Szczegółowe informacje znajdziesz w artykule Aktualizowanie lub odnawianie subskrypcji Google Workspace.

Poniżej przedstawiono CloudEvent dla 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 dotyczące wygaśnięcia subskrypcji

Gdy subskrypcja wygaśnie, interfejs Events API w Google Workspace wyśle Ci zdarzenie cyklu życia. Typ tego zdarzenia cyklu życia to google.workspace.events.subscription.v1.expired.

Interfejs Events API w Google Workspace trwale usuwa wygasłe subskrypcje. Jeśli Twoja subskrypcja wygaśnie, możesz użyć metody subscriptions.create(), aby utworzyć kolejną subskrypcję. Więcej informacji znajdziesz w artykule Tworzenie subskrypcji Google Workspace.

Poniżej przedstawiono CloudEvent dotyczący zdarzenia cyklu życia dotyczącego wygasłej 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.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",
      ...
    }
  }
}