Usuwanie subskrypcji Google Workspace

Z tej strony dowiesz się, jak usunąć subskrypcję Google Workspace za pomocą metody subscriptions.delete().

Gdy usuniesz subskrypcję, Twoja aplikacja przestanie otrzymywać zdarzenia. Jeśli subskrypcja wygaśnie, interfejs Google Workspace Events API usunie ją automatycznie.

Wymagania wstępne

Google Apps Script

  • projekt Apps Script:
    • Zamiast domyślnego projektu utworzonego automatycznie przez Apps Script użyj swojego projektu Google Cloud.
    • W przypadku zakresów, które dodano do skonfigurowania ekranu zgody OAuth, musisz też dodać te zakresy do pliku appsscript.json w projekcie Apps Script. Na przykład:
    • "oauthScopes": [
        "https://www.googleapis.com/auth/chat.messages.readonly"
      ]
          
    • 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ć, uruchom w interfejsie wiersza poleceń to polecenie:
      pip3 install --upgrade google-api-python-client google-auth-oauthlib
      
  • Abonament Google Workspace. Aby ją utworzyć, zapoznaj się z artykułem Tworzenie subskrypcji.

  • Wymaga uwierzytelnienia:

    • W przypadku uwierzytelniania użytkownika wymagany jest zakres, który obsługuje co najmniej 1 z typów zdarzeń w ramach subskrypcji. Aby określić zakres, zapoznaj się z artykułem Zakresy według typu zdarzenia.
    • Uwierzytelnianie aplikacji wymaga zakresu chat.bot (dotyczy tylko aplikacji Google Chat).

Usuwanie subskrypcji autoryzowanej przez użytkownika

Ten przykładowy kod usuwa zasób Subscription za pomocą uwierzytelniania użytkownika.

Aby usunąć subskrypcję:

Google Apps Script

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

    function deleteSubscription() {
      // The name of the subscription to delete.
      const name = 'subscriptions/SUBSCRIPTION_ID';
    
      // Call the Workspace Events API using the advanced service.
      const response = WorkspaceEvents.Subscriptions.remove(name);
      console.log(response);
    }
    

    Zastąp następujące elementy:

    • SUBSCRIPTION_ID: identyfikator subskrypcji. Aby uzyskać identyfikator, możesz użyć jednej z tych opcji:
      • Wartość pola uid.
      • Identyfikator nazwy zasobu w polu name. Jeśli na przykład nazwa zasobu to subscriptions/subscription-123, użyj subscription-123.
  2. Aby usunąć subskrypcję, uruchom funkcję deleteSubscription w projekcie Apps Script.

Python

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

    """Delete subscription."""
    
    from google_auth_oauthlib.flow import InstalledAppFlow
    from googleapiclient.discovery import build
    
    # Specify required scopes.
    SCOPES = ['SCOPE']
    
    # Authenticate with Google Workspace and get user authentication.
    flow = InstalledAppFlow.from_client_secrets_file('client_secrets.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().delete(name=NAME).execute()
    print(response)
    

    Zastąp następujące elementy:

    • SCOPE: zakres OAuth, który obsługuje co najmniej jeden typ zdarzenia z subskrypcji. Jeśli na przykład Twoja subskrypcja otrzymuje zdarzenia zaktualizowanego pokoju czatu, https://www.googleapis.com/auth/chat.spaces.readonly.
    • SUBSCRIPTION_ID: identyfikator subskrypcji. Aby uzyskać identyfikator, możesz użyć jednej z tych opcji:
      • Wartość pola uid.
      • Identyfikator nazwy zasobu w polu name. Jeśli na przykład nazwa zasobu to subscriptions/subscription-123, użyj subscription-123.
  2. Sprawdź, czy w katalogu roboczym masz zapisane dane uwierzytelniające klienta OAuth i czy plik ma nazwę client_secrets.json. Plik ten służy do uwierzytelniania się w Google Workspace i uzyskiwania danych logowania użytkownika. Instrukcje znajdziesz w artykule Tworzenie danych logowania klienta OAuth.

  3. Aby usunąć subskrypcję, uruchom w terminalu to polecenie:

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