Dowiedz się więcej o subskrypcji Google Workspace

Z tej strony dowiesz się, jak uzyskać szczegółowe informacje o subskrypcji Google Workspace za pomocą subscriptions.get() metody.

Gdy wywołasz tę metodę z uwierzytelnianiem użytkownika, zwróci ona szczegóły subskrypcji autoryzowanej przez użytkownika. Gdy używasz uwierzytelniania aplikacji, metoda może zwrócić szczegóły dowolnej subskrypcji aplikacji.

Wymagania wstępne

Apps Script

  • Projekt Apps Script:
    • Zamiast domyślnego projektu utworzonego automatycznie przez Apps Script użyj projektu Google Cloud.
    • Wszystkie zakresy dodane do skonfigurowania ekranu akceptacji OAuth musisz też dodać do zakresów w 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 w wersji 3.6 lub nowszej
  • 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
      

Pobieranie subskrypcji autoryzowanej przez użytkownika

Ten przykład kodu pobiera szczegóły zasobu Subscription za pomocą uwierzytelniania użytkownika. Po uwierzytelnieniu jako użytkownik metoda zwraca subskrypcję, którą użytkownik autoryzował aplikację do utworzenia.

Aby pobrać subskrypcję autoryzowaną przez użytkownika:

Apps Script

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

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

    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 pobrać subskrypcję, w projekcie Apps Script uruchom funkcję getSubscription.

Python

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

    """Get 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('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'
    subscription = service.subscriptions().get(name=NAME).execute()
    print(subscription)
    

    Zastąp następujące elementy:

    • SCOPE: zakres OAuth, który obsługuje co najmniej 1 typ zdarzenia z subskrypcji. Jeśli na przykład subskrypcja otrzymuje zdarzenia zaktualizowanego pokoju Google Chat, użyj zakresu https://www.googleapis.com/auth/chat.spaces.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. Ten przykład kodu 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 pobrać subskrypcję, w terminalu uruchom to polecenie:

    python3 get_subscription.py