Naprawianie błędów i ponowne aktywowanie subskrypcji Google Workspace

Z tej strony dowiesz się, jak ponownie aktywować zawieszony abonament Google Workspace , rozwiązując problemy i wywołując metodę subscriptions.reactivate.

Abonamenty Google Workspace są zawieszane, gdy błąd uniemożliwia subskrypcji otrzymywanie zdarzeń. Subskrypcja jest na przykład zawieszana, gdy nie można znaleźć jej zasobu docelowego lub punktu końcowego powiadomień. Po rozwiązaniu wszystkich problemów z subskrypcją możesz ją ponownie aktywować, aby znów otrzymywać zdarzenia.

Informacje o zawieszonej subskrypcji możesz uzyskać na te sposoby:

  • Twoja aplikacja otrzymuje zdarzenie cyklu życia dotyczące zawieszenia. Jeśli subskrypcja zostanie zawieszona z powodu błędu w punkcie końcowym, możesz nie otrzymać zdarzenia cyklu życia.
  • Użyj metod subscriptions.get lub subscriptions.list, aby sprawdzić, czy pole state subskrypcji ma wartość SUSPENDED.
  • Otrzymasz powiadomienie o nieudanym dostarczeniu do punktu końcowego powiadomień. Więcej informacji o monitorowaniu nieudanych dostaw do tematów Google Cloud Pub/Sub znajdziesz w artykule Obsługa błędów wiadomości.

Ponownie aktywowane subskrypcje zachowują pierwotną datę wygaśnięcia. Aby przedłużyć czas wygaśnięcia abonamentu, przeczytaj artykuł Aktualizowanie lub odnawianie abonamentu Google Workspace.

Apps Script

  • Projekt Apps Script:
    • Zamiast domyślnego projektu utworzonego automatycznie przez Apps Script użyj projektu w chmurze Google Cloud.
    • W przypadku wszystkich zakresów dodanych do skonfigurowania ekranu zgody OAuth musisz też dodać zakresy do pliku appsscript.json w projekcie Apps Script. Jeśli na przykład określisz zakres chat.messages, dodaj te informacje: 
      • "oauthScopes": [
  "https://www.googleapis.com/auth/chat.messages"
]
    • Włącz usługę zaawansowaną Google Workspace Events.

Python

  • Python 3.6 lub nowszy
  • Narzędzie do zarządzania pakietami pip
  • Najnowsze biblioteki klienta Google dla Pythona. Aby je zainstalować lub zaktualizować, w interfejsie wiersza poleceń uruchom to polecenie: 
      pip3 install --upgrade google-api-python-client google-auth-oauthlib

Identyfikowanie i rozwiązywanie błędów

Aby zidentyfikować błąd subskrypcji, sprawdź pole suspensionReason subskrypcji. To pole znajdziesz, gdy otrzymasz zdarzenie cyklu życia dotyczące zawieszenia lub gdy użyjesz metody subscriptions.get, aby sprawdzić wszystkie pola subskrypcji.

W tabeli poniżej znajdziesz informacje o możliwych błędach subskrypcji oraz, jeśli to możliwe, o sposobach ich rozwiązania. Jeśli nie możesz rozwiązać problemu, możesz usunąć subskrypcję lub poczekać aż wygaśnie. Interfejs Google Workspace Events API automatycznie usuwa wygasłe subskrypcje.

Błąd Opis Sposoby rozwiązania

USER_SCOPE_REVOKED

Użytkownik autoryzujący cofnął przyznanie co najmniej 1 zakresu OAuth, który jest wymagany w przypadku subskrypcji. Uzyskaj kolejny token dostępu. Szczegółowe informacje znajdziesz w artykule Uzyskiwanie tokena dostępu z serwera autoryzacji Google.

RESOURCE_DELETED

Zasób docelowy subskrypcji został usunięty. Jeśli zasób zostanie przywrócony, wywołaj metodę reactivate. W przeciwnym razie nie musisz nic robić, ponieważ nie możesz ponownie aktywować subskrypcji bez jej pierwotnego zasobu docelowego.

USER_AUTHORIZATION_FAILURE

Użytkownik autoryzujący nie ma już dostępu do zasobu subskrypcji. Nie musisz nic robić. Nie możesz ponownie aktywować subskrypcji, ponieważ użytkownik, który ją autoryzował, nie ma dostępu do zasobu docelowego.

ENDPOINT_PERMISSION_DENIED

Aplikacja Google Workspace nie ma dostępu do dostarczania zdarzeń do punktu końcowego powiadomień. Przyznaj dostęp do konta usługi aplikacji Google Workspace, która dostarcza zdarzenia.

Service accounts:
  • Zdarzenia w Google Chat: chat-api-push@system.gserviceaccount.com
  • Zdarzenia na Dysku Google: drive-api-event-push@system.gserviceaccount.com
  • Zdarzenia w Google Meet: meet-api-event-push@system.gserviceaccount.com

W przypadku tematów Pub/Sub przyznaj kontu usługi rolę publikującego w Pub/Sub (roles/pubsub.publisher) .

ENDPOINT_NOT_FOUND

Punkt końcowy powiadomień nie istnieje lub nie można go znaleźć. Sprawdź, czy punkt końcowy jest nadal aktywny i działa. Aby rozwiązać problemy z tematami Pub/Sub, zapoznaj się z dokumentacją dotyczącą rozwiązywania problemów.

ENDPOINT_RESOURCE_EXHAUSTED

Punkt końcowy powiadomień nie otrzymał zdarzeń z powodu niewystarczającego limitu lub osiągnięcia limitu liczby żądań. Poproś o zwiększenie limitu.

APP_SCOPE_REVOKED

Administrator domeny cofnął przyznanie co najmniej 1 zakresu OAuth aplikacji do obsługi czatu. Uzyskaj zgodę administratora.

APP_AUTHORIZATION_FAILURE

Aplikacja do obsługi czatu, która autoryzowała utworzenie subskrypcji, nie ma już dostępu do zasobu docelowego subskrypcji. Odzyskaj dostęp do zasobu docelowego. Jeśli na przykład zasobem docelowym jest pokój w Google Chat, aplikacja do obsługi czatu może wymagać członkostwa w tym pokoju.

Ponowne aktywowanie subskrypcji

Po rozwiązaniu problemu, który spowodował zawieszenie subskrypcji, użyj metody reactivate, aby subskrypcja znów mogła otrzymywać zdarzenia. Metoda sprawdza, czy wszystkie błędy zostały rozwiązane, i zmienia pole state subskrypcji z SUSPENDED na ACTIVE.

Aby ponownie aktywować abonament Google Workspace:

Apps Script

  1. W projekcie Apps Script utwórz nowy plik skryptu o nazwie reactivateSubscription i dodaj ten kod:

    function reactivateSubscription() {
  // The name of the subscription to reactivate.
  const name = 'subscriptions/SUBSCRIPTION_ID';

  // Call the Workspace Events API using the advanced service.
  const response = WorkspaceEvents.Subscriptions.reactivate({}, name);
  console.log(response);
}

    Zastąp następujące elementy:

    • SUBSCRIPTION_ID: identyfikator subskrypcji. Aby uzyskać identyfikator, możesz użyć dowolnego z tych elementów:
      • Wartość pola uid.
      • Identyfikator nazwy zasobu reprezentowany w polu name. Jeśli na przykład nazwa zasobu to subscriptions/subscription-123, użyj subscription-123.

  2. Aby ponownie aktywować abonament Google Workspace, w projekcie Apps Script uruchom funkcję reactivateSubscription.

Python

  1. W katalogu roboczym utwórz plik o nazwie reactivate_subscription.py i dodaj ten kod:

    """Reactivate subscription."""

from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build

# Specify required scopes.
SCOPES = [SCOPES]

# Authenticate with Google Workspace and get user authentication.
flow = InstalledAppFlow.from_client_secrets_file('credentials.json', SCOPES)
CREDENTIALS = flow.run_local_server()

# Call the Workspace Events API using the service endpoint.
service = build(
    'workspaceevents',
    'v1',
    credentials=CREDENTIALS,
)

NAME = 'subscriptions/SUBSCRIPTION_ID'
response = service.subscriptions().reactivate(name=NAME).execute()
print(response)

    Zastąp następujące elementy:

    • SCOPES: co najmniej 1 zakres OAuth, który obsługuje każdy typ zdarzenia w subskrypcji. Sformatowany jako tablica ciągów znaków. Aby podać kilka zakresów, rozdziel je przecinkami. Na przykład: 'https://www.googleapis.com/auth/chat.spaces.readonly', 'https://www.googleapis.com/auth/chat.memberships.readonly'.
    • SUBSCRIPTION_ID: identyfikator subskrypcji. Aby uzyskać identyfikator, możesz użyć dowolnego z tych elementów:
      • Wartość pola uid.
      • Identyfikator nazwy zasobu reprezentowany w polu name. Jeśli na przykład nazwa zasobu to subscriptions/subscription-123, użyj subscription-123.

  2. W katalogu roboczym upewnij się, że masz zapisane dane logowania identyfikatora klienta OAuth i że plik ma nazwę credentials.json. Przykładowy kod używa tego pliku JSON do uwierzytelniania w Google Workspace i uzyskiwania danych logowania użytkownika. Instrukcje znajdziesz w artykule Tworzenie danych logowania identyfikatora klienta OAuth.

  3. Aby ponownie aktywować abonament Google Workspace, uruchom w terminalu następujące polecenie:

    python3 reactivate_subscription.py
Interfejs Google Workspace Events API zwraca długo trwającą operację, która zawiera instancję zasobu Subscription.

Jeśli żądanie się nie powiedzie, zapoznaj się z sekcją poniżej, aby rozwiązać dodatkowe problemy.

Ponowne aktywowanie subskrypcji jako aplikacji do obsługi czatu

Subskrypcję zdarzeń w Google Chat możesz ponownie aktywować jako aplikacja do obsługi czatu, a nie jako użytkownik. Proces jest podobny, z tym że:

  1. Zamiast uwierzytelniania użytkownika, uwierzytelnij się jako aplikacja do obsługi czatu, uzyskując jednorazową zgodę administratora.

  2. Określ zakresy autoryzacji, które umożliwiają aplikacji do obsługi czatu subskrybowanie zdarzeń w Google Chat. Te zakresy autoryzacji zawsze zaczynają się od chat.app i obejmują te zakresy:

    • https://www.googleapis.com/auth/chat.app.memberships: subskrybuj zdarzenia dotyczące członków pokoju w Google Chat.
    • https://www.googleapis.com/auth/chat.app.memberships.readonly: subskrybuj zdarzenia dotyczące członków pokoju w Google Chat.
    • https://www.googleapis.com/auth/chat.app.messages.readonly: subskrybuj zdarzenia dotyczące wiadomości i reakcji w pokoju w Google Chat.
    • https://www.googleapis.com/auth/chat.app.spaces: subskrybuj zdarzenia dotyczące pokoju w Google Chat.
    • https://www.googleapis.com/auth/chat.app.spaces.readonly: subskrybuj zdarzenia dotyczące pokoju w Google Chat.

Napisz skrypt, który wywołuje interfejs Google Workspace Events API

Ten przykładowy kod ponownie aktywuje abonament Google Workspace aplikacji do Google Chat:

Python 

  """Reactivate subscription."""

  from google.oauth2 import service_account
  from apiclient.discovery import build

  # Specify required scopes.
  SCOPES = [SCOPES]

  # Specify service account details.
  CREDENTIALS = (
      service_account.Credentials.from_service_account_file('credentials.json')
      .with_scopes(SCOPES)
  )

  # Call the Workspace Events API using the service endpoint.
  service = build(
      'workspaceevents',
      'v1beta',
      credentials=CREDENTIALS,
  )

  NAME = 'subscriptions/SUBSCRIPTION_ID'
  response = service.subscriptions().reactivate(name=NAME).execute()
  print(response)

Zastąp następujące elementy:

  • SCOPES: określ zakresy autoryzacji, które umożliwiają aplikacji do obsługi czatu subskrybowanie zdarzeń w Google Chat. Te zakresy autoryzacji zawsze zaczynają się od chat.app i obejmują te zakresy:

    • https://www.googleapis.com/auth/chat.app.memberships: subskrybuj zdarzenia dotyczące członków pokoju w Google Chat.
    • https://www.googleapis.com/auth/chat.app.memberships.readonly: subskrybuj zdarzenia dotyczące członków pokoju w Google Chat.
    • https://www.googleapis.com/auth/chat.app.messages.readonly: subskrybuj zdarzenia dotyczące wiadomości i reakcji w pokoju w Google Chat.
    • https://www.googleapis.com/auth/chat.app.spaces: subskrybuj zdarzenia dotyczące pokoju w Google Chat.
    • https://www.googleapis.com/auth/chat.app.spaces.readonly: subskrybuj zdarzenia dotyczące pokoju w Google Chat.

  • SUBSCRIPTION_ID: identyfikator subskrypcji. Aby uzyskać identyfikator, możesz użyć dowolnego z tych elementów:

    • Wartość pola uid.
    • Identyfikator nazwy zasobu reprezentowany w polu name. Jeśli na przykład nazwa zasobu to subscriptions/subscription-123, użyj subscription-123.

Rozwiązywanie wielu problemów

Jeśli problem, który spowodował zawieszenie subskrypcji, został rozwiązany, a metoda reactivate się nie powiodła, po zawieszeniu subskrypcji mógł wystąpić inny błąd.

Aby zidentyfikować dodatkowe błędy, sprawdź dane wyjściowe nieudanego żądania. Dane wyjściowe zawierają wszystkie błędy, które nadal występują.

Gdy subskrypcja ma wiele błędów, wartość pola suspensionReason zawsze używa pierwotnego błędu, który spowodował zawieszenie subskrypcji.