Wyświetlenie listy subskrypcji Google Workspace

Z tego artykułu dowiesz się, jak wyświetlić listę subskrypcji Google Workspace za pomocą metody subscriptions.list().

Gdy wywołujesz tę metodę z uwierzytelnianiem użytkownika, zwraca ona listę subskrypcji autoryzowanych przez użytkownika. Gdy korzystasz z uwierzytelniania aplikacji, może ona zwrócić listę zawierającą dowolną subskrypcję aplikacji.

Wymagania wstępne

Google Apps Script

  • Projekt Apps Script:
    • Użyj swojego projektu Google Cloud zamiast domyślnego utworzonego automatycznie przez Apps Script.
    • W przypadku wszystkich zakresów, które zostały dodane w celu skonfigurowania ekranu zgody OAuth, musisz też dodać 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 języka Python. Aby je zainstalować lub zaktualizować, uruchom to polecenie w interfejsie wiersza poleceń: 
      pip3 install --upgrade google-api-python-client google-auth-oauthlib

  • abonament Google Workspace. Aby je utworzyć, zapoznaj się z informacjami o tworzeniu subskrypcji.

  • Wymaga uwierzytelniania:

    • W przypadku uwierzytelniania użytkowników wymagany jest zakres, który obsługuje co najmniej 1 typ zdarzeń w ramach subskrypcji. Informacje o zakresie zakresu znajdziesz w sekcji Zakresy według typu zdarzenia.
    • Do uwierzytelniania aplikacji wymagany jest zakres chat.bot (tylko aplikacje Google Chat).

Wyświetl listę subskrypcji autoryzowanych przez użytkownika

Aby wyświetlić listę subskrypcji, musisz przefiltrować dane według co najmniej 1 typu zdarzenia. Możesz też filtrować zapytanie według co najmniej jednego zasobu docelowego. Więcej informacji o obsługiwanych filtrach zapytań znajdziesz w dokumentacji metody list().

Poniższy przykładowy kod zwraca tablicę obiektów Subscription przefiltrowanych według typu zdarzenia i zasobu docelowego. Po uwierzytelnieniu użytkownika jako użytkownika metoda zwraca tylko listę subskrypcji, do utworzenia których aplikacja autoryzował użytkownik.

Aby wyświetlić listę subskrypcji dla określonego typu zdarzenia i zasobu docelowego:

Google Apps Script

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

    function listSubscriptions() {
  // Filter for event type (required).
  const eventType = 'EVENT_TYPE';

  // Filter for target resource (optional).
  const targetResource = 'TARGET_RESOURCE';

  const filter = `event_types:"${eventType}" AND target_resource="${targetResource}"`

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

    Zastąp następujące elementy:

    • EVENT_TYPE: typ zdarzenia sformatowany zgodnie ze specyfikacją CloudEvents. Aby na przykład odfiltrować subskrypcje, które otrzymują zdarzenia dotyczące nowych subskrypcji w pokoju Google Chat, google.workspace.chat.message.v1.created.
    • TARGET_RESOURCE: zasób docelowy w formacie pełnej nazwy zasobu. Aby na przykład filtrować według subskrypcji pokoju Google Chat, użyj //chat.googleapis.com/spaces/SPACE_ID, gdzie spaces/SPACE_ID reprezentuje pole name zasobu Space.

  2. Aby wyświetlić listę subskrypcji, uruchom funkcję listSubscriptions w projekcie Apps Script.

Python

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

    """List subscriptions."""

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,
)

# Filter for event type (required).
EVENT_TYPE = 'EVENT_TYPE'

# Filter for target resource (optional).
TARGET_RESOURCE = 'TARGET_RESOURCE'

FILTER = f'event_types:"{EVENT_TYPE}" AND target_resource="{TARGET_RESOURCE}"'
response = service.subscriptions().list(filter=FILTER).execute()
print(response)

    Zastąp następujące elementy:

    • SCOPE: zakres protokołu OAuth, który obsługuje co najmniej 1 typ zdarzenia z subskrypcji. Jeśli na przykład Twoja subskrypcja odbiera zdarzenia ze zaktualizowanego pokoju czatu, https://www.googleapis.com/auth/chat.spaces.readonly.
    • EVENT_TYPE: typ zdarzenia sformatowany zgodnie ze specyfikacją CloudEvents. Aby na przykład odfiltrować subskrypcje, które otrzymują zdarzenia dotyczące nowych subskrypcji w pokoju Google Chat, google.workspace.chat.message.v1.created.
    • TARGET_RESOURCE: zasób docelowy w formacie pełnej nazwy zasobu. Aby na przykład filtrować według subskrypcji pokoju Google Chat, użyj //chat.googleapis.com/spaces/SPACE_ID, gdzie spaces/SPACE_ID reprezentuje pole name zasobu Space.

  2. Sprawdź, czy w katalogu roboczym są zapisane dane logowania identyfikatora klienta OAuth i nadaj mu nazwę client_secrets.json. Przykładowy kod używa tego pliku JSON do uwierzytelniania w Google Workspace i pobierania danych logowania użytkownika. Instrukcje znajdziesz w artykule Tworzenie danych logowania identyfikatora klienta OAuth.

  3. Aby wyświetlić listę subskrypcji, uruchom w terminalu to polecenie:

    python3 list_subscriptions.py

Interfejs Google Workspace Event API zwraca podzielone na strony tablice obiektów Subscription, które pasują do filtra w Twoim zapytaniu.