Tworzenie subskrypcji Google Workspace

Na tej stronie dowiesz się, jak za pomocą interfejsu Google Workspace Event API utworzyć subskrypcję zasobu Google Workspace. Subskrypcja Google Workspace umożliwia aplikacji otrzymywanie informacji o zdarzeniach Google Workspace, które reprezentują zmiany w zasobie Google Workspace. Aby dowiedzieć się, jakie zasoby i typy zdarzeń obsługuje Google Workspace Event API, zapoznaj się z omówieniem Google Workspace Event API.

Na tej stronie znajdziesz instrukcje tworzenia subskrypcji Google Workspace:

  1. skonfigurować środowisko,
  2. Utwórz i zasubskrybuj temat Google Cloud Pub/Sub. Używaj tego tematu jako punktu końcowego do odbierania zdarzeń Google Workspace.
  3. Wywołaj metodę create() interfejsu Google Workspace Event API w zasobie Subscription.
  4. Przetestuj subskrypcję Google Workspace, aby upewnić się, że temat Pub/Sub otrzymuje subskrybowane zdarzenia.
  5. Opcjonalnie możesz skonfigurować sposób przekazywania zdarzeń do punktu końcowego aplikacji, aby aplikacja mogła przetworzyć zdarzenie i w razie potrzeby podjąć działanie.

Wymagania wstępne

Google Apps Script

  • Aby użyć poleceń Google Cloud CLI w tym przewodniku:
    1. Zainstaluj Google Cloud CLI.
    2. Aby zainicjować interfejs wiersza poleceń gcloud, uruchom ten kod:
    3.   gcloud init
        
  • Zasób docelowy subskrypcji:
    • Aby zasubskrybować pokój Google Chat, musisz mieć pokój czatu, do którego należy uwierzytelniony użytkownik. Użytkownik musi być członkiem pokoju za pomocą swojego konta Google Workspace lub konta Google (użytkownicy, którzy są w pokoju za pomocą grupy dyskusyjnej Google, nie są obsługiwani).
    • aby zasubskrybować miejsce spotkań w Google Meet, w którym właścicielem jest uwierzytelniony użytkownik. Aby utworzyć pokój, zapoznaj się z dokumentacją Google Meet dotyczącą korzystania z pokoi konferencyjnych.
    • Aby zasubskrybować użytkownika Google Meet, podaj identyfikator user interfejsu Cloud Identity API.
  • Projekt Google Cloud z włączonymi płatnościami. W przypadku subskrypcji Google Chat musisz też włączyć interfejs Chat API w projekcie Cloud i skonfigurować pola Nazwa aplikacji, Adres URL awatara oraz Opis. Więcej informacji znajdziesz w artykule Tworzenie aplikacji Google Chat.
  • Wymaga uwierzytelniania użytkownika z ekranem zgody OAuth skonfigurowanym dla aplikacji. Podczas konfigurowania ekranu zgody musisz określić zakres do obsługi poszczególnych typów zdarzeń związanych z subskrypcją. Informacje o tym, jak skonfigurować ekran zgody i zidentyfikować wymagane zakresy, znajdziesz w sekcji Wybieranie zakresów.
  • 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
      
  • Aby użyć poleceń Google Cloud CLI w tym przewodniku:
    1. Zainstaluj Google Cloud CLI.
    2. Aby zainicjować interfejs wiersza poleceń gcloud, uruchom ten kod:
    3.   gcloud init
        
  • Zasób docelowy subskrypcji:
    • Aby zasubskrybować pokój Google Chat, musisz mieć pokój czatu, do którego należy uwierzytelniony użytkownik. Użytkownik musi być członkiem pokoju za pomocą swojego konta Google Workspace lub konta Google (użytkownicy, którzy są w pokoju za pomocą grupy dyskusyjnej Google, nie są obsługiwani).
    • aby zasubskrybować miejsce spotkań w Google Meet, w którym właścicielem jest uwierzytelniony użytkownik. Aby utworzyć pokój, zapoznaj się z dokumentacją Google Meet dotyczącą korzystania z pokoi konferencyjnych.
    • Aby zasubskrybować użytkownika Google Meet, podaj identyfikator user interfejsu Cloud Identity API.
  • Projekt Google Cloud z włączonymi płatnościami. W przypadku subskrypcji Google Chat musisz też włączyć interfejs Chat API w projekcie Cloud i skonfigurować pola Nazwa aplikacji, Adres URL awatara oraz Opis. Więcej informacji znajdziesz w artykule Tworzenie aplikacji Google Chat.
  • Wymaga uwierzytelniania użytkownika z ekranem zgody OAuth skonfigurowanym dla aplikacji. Podczas konfigurowania ekranu zgody musisz określić zakres do obsługi poszczególnych typów zdarzeń związanych z subskrypcją. Informacje o tym, jak skonfigurować ekran zgody i zidentyfikować wymagane zakresy, znajdziesz w sekcji Wybieranie zakresów.

Konfigurowanie środowiska

Z tej sekcji dowiesz się, jak skonfigurować środowisko przed utworzeniem subskrypcji Google Workspace.

Włączanie interfejsów Google Workspace Event API i Google Cloud Pub/Sub API

Zanim zaczniesz korzystać z interfejsów API Google, musisz włączyć je w projekcie Google Cloud. W jednym projekcie Google Cloud możesz włączyć 1 lub więcej interfejsów API.

Konsola Google Cloud

W konsoli Google Cloud otwórz projekt Google Cloud odpowiadający Twojej aplikacji i włącz interfejsy Google Workspace Event API oraz Pub/Sub API:

Włączanie interfejsów API

gcloud

  1. W katalogu roboczym zaloguj się na konto Google:

    gcloud auth login
    
  2. Ustaw projekt na projekt Cloud dla aplikacji:

    gcloud config set project PROJECT_ID
    

    Zastąp PROJECT_ID identyfikatorem projektu projektu Cloud dla Twojej aplikacji.

  3. Włącz interfejsy Google Workspace Event API i Google Cloud Pub/Sub API:

    gcloud services enable pubsub.googleapis.com workspaceevents.googleapis.com
    

Utwórz dane uwierzytelniające identyfikator klienta OAuth

Wybierz typ aplikacji, aby uzyskać szczegółowe instrukcje tworzenia identyfikatora klienta OAuth:

Aplikacja internetowa

  1. W konsoli Google Cloud kliknij Menu > Interfejsy API i usługi > Dane logowania.

    Otwórz stronę Dane logowania

  2. Kliknij Utwórz dane logowania > Identyfikator klienta OAuth.
  3. Kliknij Typ aplikacji > Aplikacja internetowa.
  4. W polu Nazwa wpisz nazwę danych logowania. Ta nazwa jest widoczna tylko w konsoli Google Cloud.
  5. Dodaj autoryzowane identyfikatory URI powiązane z Twoją aplikacją:
    • Aplikacje po stronie klienta (JavaScript) – w sekcji Autoryzowane źródła JavaScript kliknij Dodaj identyfikator URI. Następnie wpisz identyfikator URI, którego będziesz używać w przypadku żądań przeglądarki. Identyfikuje ona domeny, z których aplikacja może wysyłać żądania interfejsu API do serwera OAuth 2.0.
    • Aplikacje po stronie serwera (Java, Python i inne) – w sekcji Autoryzowane identyfikatory URI przekierowania kliknij Dodaj identyfikator URI. Następnie wpisz identyfikator URI punktu końcowego, do którego serwer OAuth 2.0 może wysyłać odpowiedzi.
  6. Kliknij Utwórz. Pojawi się ekran utworzony przez klienta OAuth zawierający nowy identyfikator i tajny klucz klienta.

    Zapisz identyfikator klienta. Tajne klucze klienta nie są używane w przypadku aplikacji internetowych.

  7. Kliknij OK. Nowo utworzone dane logowania pojawią się w sekcji Identyfikatory klientów OAuth 2.0.

Android

  1. W konsoli Google Cloud kliknij Menu > Interfejsy API i usługi > Dane logowania.

    Otwórz stronę Dane logowania

  2. Kliknij Utwórz dane logowania > Identyfikator klienta OAuth.
  3. Kliknij Typ aplikacji > Android.
  4. W polu „Nazwa” wpisz nazwę danych logowania. Ta nazwa jest widoczna tylko w konsoli Google Cloud.
  5. W polu „Nazwa pakietu” wpisz nazwę pakietu z pliku AndroidManifest.xml.
  6. W polu „Odcisk cyfrowy certyfikatu SHA-1” wpisz wygenerowany odcisk cyfrowy certyfikatu SHA-1.
  7. Kliknij Utwórz. Pojawi się ekran utworzony przez klienta OAuth zawierający nowy identyfikator klienta.
  8. Kliknij OK. Nowo utworzone dane logowania pojawią się w sekcji „Identyfikatory klienta OAuth 2.0”.

iOS

  1. W konsoli Google Cloud kliknij Menu > Interfejsy API i usługi > Dane logowania.

    Otwórz stronę Dane logowania

  2. Kliknij Utwórz dane logowania > Identyfikator klienta OAuth.
  3. Kliknij Typ aplikacji > iOS.
  4. W polu „Nazwa” wpisz nazwę danych logowania. Ta nazwa jest widoczna tylko w konsoli Google Cloud.
  5. W polu „Identyfikator pakietu” wpisz identyfikator pakietu podany w pliku Info.plist aplikacji.
  6. Opcjonalnie: jeśli Twoja aplikacja jest widoczna w Apple App Store, wpisz jej identyfikator.
  7. Opcjonalnie: w polu „Identyfikator zespołu” wpisz unikalny 10-znakowy ciąg znaków wygenerowany przez Apple i przypisany do Twojego zespołu.
  8. Kliknij Utwórz. Pojawi się ekran utworzony przez klienta OAuth zawierający nowy identyfikator i tajny klucz klienta.
  9. Kliknij OK. Nowo utworzone dane logowania pojawią się w sekcji „Identyfikatory klienta OAuth 2.0”.

Aplikacja Chrome

  1. W konsoli Google Cloud kliknij Menu > Interfejsy API i usługi > Dane logowania.

    Otwórz stronę Dane logowania

  2. Kliknij Utwórz dane logowania > Identyfikator klienta OAuth.
  3. Kliknij Typ aplikacji > Aplikacja Chrome.
  4. W polu „Nazwa” wpisz nazwę danych logowania. Ta nazwa jest widoczna tylko w konsoli Google Cloud.
  5. W polu „Identyfikator aplikacji” wpisz niepowtarzalny 32-znakowy identyfikator aplikacji. Tę wartość identyfikatora znajdziesz w adresie URL aplikacji w sklepie Chrome Web Store oraz w panelu dewelopera Chrome Web Store.
  6. Kliknij Utwórz. Pojawi się ekran utworzony przez klienta OAuth zawierający nowy identyfikator i tajny klucz klienta.
  7. Kliknij OK. Nowo utworzone dane logowania pojawią się w sekcji „Identyfikatory klienta OAuth 2.0”.

Aplikacja komputerowa

  1. W konsoli Google Cloud kliknij Menu > Interfejsy API i usługi > Dane logowania.

    Otwórz stronę Dane logowania

  2. Kliknij Utwórz dane logowania > Identyfikator klienta OAuth.
  3. Kliknij Typ aplikacji > Aplikacja komputerowa.
  4. W polu Nazwa wpisz nazwę danych logowania. Ta nazwa jest widoczna tylko w konsoli Google Cloud.
  5. Kliknij Utwórz. Pojawi się ekran utworzony przez klienta OAuth zawierający nowy identyfikator i tajny klucz klienta.
  6. Kliknij OK. Nowo utworzone dane logowania pojawią się w sekcji Identyfikatory klienta OAuth 2.0.

Telewizory i urządzenia wejściowe z ograniczonym dostępem

  1. W konsoli Google Cloud kliknij Menu > Interfejsy API i usługi > Dane logowania.

    Otwórz stronę Dane logowania

  2. Kliknij Utwórz dane logowania > Identyfikator klienta OAuth.
  3. Kliknij Typ aplikacji > Telewizory i urządzenia wejściowe z ograniczonym dostępem.
  4. W polu „Nazwa” wpisz nazwę danych logowania. Ta nazwa jest widoczna tylko w konsoli Google Cloud.
  5. Kliknij Utwórz. Pojawi się ekran utworzony przez klienta OAuth zawierający nowy identyfikator i tajny klucz klienta.
  6. Kliknij OK. Nowo utworzone dane logowania pojawią się w sekcji „Identyfikatory klienta OAuth 2.0”.

Universal Windows Platform (UWP)

  1. W konsoli Google Cloud kliknij Menu > Interfejsy API i usługi > Dane logowania.

    Otwórz stronę Dane logowania

  2. Kliknij Utwórz dane logowania > Identyfikator klienta OAuth.
  3. Kliknij Typ aplikacji > Universal Windows Platform (UWP).
  4. W polu „Nazwa” wpisz nazwę danych logowania. Ta nazwa jest widoczna tylko w konsoli Google Cloud.
  5. W polu „Identyfikator sklepu” wpisz niepowtarzalną, 12-znakową wartość identyfikatora sklepu Microsoft Store aplikacji. Znajdziesz go w adresie URL swojej aplikacji w Microsoft Store oraz w Centrum Partnerów.
  6. Kliknij Utwórz. Pojawi się ekran utworzony przez klienta OAuth zawierający nowy identyfikator i tajny klucz klienta.
  7. Kliknij OK. Nowo utworzone dane logowania pojawią się w sekcji „Identyfikatory klienta OAuth 2.0”.

Pobierz plik JSON z tajnym kluczem klienta

Plik tajnego klucza klienta reprezentuje dane logowania w formacie JSON, z których może się odwoływać aplikacja podczas podawania danych logowania.

  1. W konsoli Google Cloud kliknij Menu > Interfejsy API i usługi > Dane logowania.

    Otwórz stronę Dane logowania

  2. W sekcji Identyfikatory klienta OAuth 2.0 kliknij utworzony identyfikator klienta.

  3. Kliknij Pobierz JSON.

  4. Zapisz plik jako client_secrets.json.

Tworzenie i subskrybowanie tematu Pub/Sub

W tej sekcji utworzysz temat Pub/Sub i subskrypcję do tematu. Temat Pub/Sub służy jako punkt końcowy powiadomień, w którym Twoja subskrypcja Google Workspace odbiera zdarzenia.

Aby dowiedzieć się więcej o tworzeniu tematów Pub/Sub i zarządzaniu nimi, zapoznaj się z dokumentacją Pub/Sub.

Aby utworzyć i zasubskrybować temat Pub/Sub:

Konsola Google Cloud

  1. W konsoli Google Cloud otwórz stronę Pub/Sub:

    Otwórz Google Cloud Pub/Sub

    Sprawdź, czy wybrany jest projekt Cloud dla Twojej aplikacji.

  2. Kliknij Utwórz temat i wykonaj te czynności:

    1. Wpisz nazwę tematu, np. workspace-events-topic.
    2. Zostaw zaznaczoną opcję Dodaj subskrypcję domyślną. Pub/Sub nadaje tej domyślnej subskrypcji nazwę podobną do nazwy tematu, na przykład workspace-events-topic-sub.
    3. Opcjonalnie: zaktualizuj lub skonfiguruj właściwości tematu.
  3. Kliknij Utwórz. Pełna nazwa tematu ma format projects/PROJECT_ID/topics/TOPIC_ID. Użyjesz tego imienia i nazwiska w późniejszym kroku.

  4. Przyznaj dostęp z możliwością publikowania wiadomości Pub/Sub w temacie:

    1. Na stronie tematu przejdź na panel boczny i otwórz kartę Uprawnienia.
    2. Kliknij Dodaj podmiot zabezpieczeń.
    3. W polu Dodaj podmioty zabezpieczeń dodaj konto usługi dla aplikacji Google Workspace, która dostarcza zdarzenia do subskrypcji:
      1. W przypadku zdarzeń w Google Chat: chat-api-push@system.gserviceaccount.com.
      2. W przypadku wydarzeń w Meet: meet-api-event-push@system.gserviceaccount.com.
    4. W menu Przypisz role wybierz Pub/Sub Publisher.
    5. Kliknij Zapisz. Aktualizacja uprawnień tematu może zająć kilka minut.

gcloud

  1. Utwórz temat w projekcie Cloud, uruchamiając to polecenie:

    gcloud pubsub topics create TOPIC_ID
    

    Zastąp TOPIC_ID unikalnym identyfikatorem tematu, np. workspace-events-topic.

    Dane wyjściowe zawierają pełną nazwę tematu w formacie projects/PROJECT_ID/topics/TOPIC_ID. Zanotuj nazwę i upewnij się, że wartość PROJECT_ID to identyfikator projektu Cloud Twojej aplikacji. Użyjesz nazwy tematu w kolejnym kroku, a subskrypcję Google Workspace utworzysz później.

  2. Przyznawanie dostępu do publikowania wiadomości w temacie:

    gcloud pubsub topics add-iam-policy-binding TOPIC_NAME --member='serviceAccount:GOOGLE_WORKSPACE_APPLICATION' --role='roles/pubsub.publisher'
    

    Zastąp następujące elementy:

    • TOPIC_NAME: pełna nazwa tematu, czyli wynik uzyskany w poprzednim kroku. Sformatowany jako projects/PROJECT_ID/topics/TOPIC_ID.
    • GOOGLE_WORKSPACE_APPLICATION: aplikacja Google Workspace, która musi dostarczać zdarzenia do subskrypcji:

      • Aby otrzymywać wydarzenia z Google Chat, użyj chat-api-push@system.gserviceaccount.com.
      • Aby odbierać wydarzenia z Meet, użyj adresu meet-api-event-push@system.gserviceaccount.com.

    Aktualizacja uprawnień tematu może potrwać kilka minut.

  3. Utwórz subskrypcję Pub/Sub dla tematu:

     gcloud pubsub subscriptions create SUBSCRIPTION_NAME --topic=TOPIC_NAME
    

    Zastąp następujące elementy:

    • SUBSCRIPTION_NAME: nazwa subskrypcji, na przykład workspace-events-subscription.
    • TOPIC_NAME: nazwa tematu utworzona w poprzednim kroku.

Tworzenie subskrypcji Google Workspace

W tej sekcji utworzysz zasób Subscription za pomocą metody subscriptions.create() interfejsu Google Workspace Event API. Musisz wypełnić te pola:

  • targetResource: zasób Google Workspace do monitorowania zdarzeń, np. pokój czatu.
  • eventTypes: tablica z co najmniej 1 typem zdarzenia, które chcesz otrzymywać dotyczące zasobu. Jeśli na przykład aplikacja potrzebuje tylko informacji o nowych wiadomościach opublikowanych w pokoju czatu, może tylko subskrybować zdarzenia dotyczące utworzonych wiadomości.
  • notificationEndpoint: punkt końcowy powiadomień, w którym subskrypcja Google Workspace dostarcza zdarzenia. Możesz użyć tematu Pub/Sub utworzonego w poprzedniej sekcji.
  • payloadOptions: opcje określające ilość danych zasobów, które mają być uwzględnione w ładunku zdarzenia. Ta konfiguracja wpływa na czas wygaśnięcia subskrypcji. Więcej informacji znajdziesz w sekcji Dane zdarzeń.

Aby utworzyć subskrypcję Google Workspace:

Google Apps Script

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

    function createSubscription() {
      // The Google Workspace resource to monitor for events.
      const targetResource = 'TARGET_RESOURCE';
    
      // The types of events to receive.
      const eventTypes = [EVENT_TYPES];
    
      // The endpoint to deliver events to, such as a Google Cloud Pub/Sub topic.
      const pubsubTopic = 'TOPIC_NAME';
    
      // Whether to include resource data or not.
      const resourceData = RESOURCE_DATA;
    
      // Call the Workspace Events API using the advanced service.
      const response = WorkspaceEvents.Subscriptions.create({
        targetResource: targetResource,
        eventTypes: eventTypes,
        notificationEndpoint: {
          pubsubTopic: pubsubTopic,
        },
        payloadOptions: {
          includeResource: resourceData
        }
      });
      console.log(response);
    }
    

    Zastąp następujące elementy:

    • TARGET_RESOURCE: zasób Google Workspace, który subskrybujesz, w formacie pełnej nazwy zasobu. Aby na przykład zasubskrybować pokój w Google Chat o identyfikatorze AAAABBBB, użyj elementu //chat.googleapis.com/spaces/AAAABBBB.
    • EVENT_TYPES: co najmniej jeden typ zdarzenia, które chcesz zasubskrybować w zasobie docelowym. Sformatuj go jako tablicę ciągów tekstowych, np. 'google.workspace.chat.message.v1.created'.
    • TOPIC_NAME: pełna nazwa tematu Pub/Sub utworzonego w projekcie Cloud. Sformatowany jako projects/PROJECT_ID/topics/TOPIC_ID.
    • RESOURCE_DATA: wartość logiczna określająca, czy subskrypcja uwzględnia w ładunku dane zasobów:

      • True: obejmuje wszystkie dane zasobów. Aby ograniczyć zakres uwzględnianych pól, dodaj pole fieldMask i określ co najmniej 1 pole dla zmienionego zasobu. Tylko subskrypcje zasobów Google Chat obsługują dane zasobów.
      • False: wyklucza dane zasobów.
  2. Aby utworzyć subskrypcję Google Workspace, uruchom w projekcie Apps Script funkcję createSubscription.

Python

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

    """Create 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('client_secrets.json', SCOPES)
    CREDENTIALS = flow.run_local_server()
    
    # The Google Workspace resource to monitor for events.
    TARGET_RESOURCE = 'TARGET_RESOURCE'
    
    # The types of events to receive.
    EVENT_TYPES = [EVENT_TYPES]
    
    # The endpoint to deliver events to, such as a Google Cloud Pub/Sub topic.
    TOPIC = 'TOPIC_NAME'
    
    # Call the Workspace Events API using the service endpoint.
    service = build(
        'workspaceevents',
        'v1',
        credentials=CREDENTIALS,
    )
    
    BODY = {
        'target_resource': TARGET_RESOURCE,
        'event_types': EVENT_TYPES,
        'notification_endpoint': {'pubsub_topic': TOPIC},
        'payload_options': {'include_resource': RESOURCE_DATA},
    }
    response = service.subscriptions().create(body=BODY).execute()
    print(response)
    

    Zastąp następujące elementy:

    • SCOPES: co najmniej 1 zakres protokołu OAuth, który obsługuje każdy typ zdarzenia w subskrypcji. Sformatowana jako tablica ciągów tekstowych. 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'.
    • TARGET_RESOURCE: zasób Google Workspace, który subskrybujesz, w formacie pełnej nazwy zasobu. Aby na przykład zasubskrybować pokój w Google Chat o identyfikatorze AAAABBBB, użyj elementu //chat.googleapis.com/spaces/AAAABBBB.
    • EVENT_TYPES: co najmniej jeden typ zdarzenia, które chcesz zasubskrybować w zasobie docelowym. Sformatuj go jako tablicę ciągów tekstowych, np. 'google.workspace.chat.message.v1.created'.
    • TOPIC_NAME: pełna nazwa tematu Pub/Sub utworzonego w projekcie Cloud. Sformatowany jako projects/PROJECT_ID/topics/TOPIC_ID.
    • RESOURCE_DATA: wartość logiczna określająca, czy subskrypcja uwzględnia w ładunku dane zasobów:

      • True: obejmuje wszystkie dane zasobów. Aby ograniczyć zakres uwzględnianych pól, dodaj pole fieldMask i określ co najmniej 1 pole dla zmienionego zasobu. Tylko subskrypcje zasobów Google Chat obsługują dane zasobów.
      • False: wyklucza dane zasobów.
  2. Aby utworzyć abonament Google Workspace, uruchom w terminalu to polecenie:

    python3 create_subscription.py
    

Interfejs Google Workspace Event API zwraca ukończoną długo trwającą operację, która zawiera instancję utworzonego zasobu Subscription.

Testowanie subskrypcji Google Workspace

Aby sprawdzić, czy otrzymujesz zdarzenia Google Workspace, możesz aktywować zdarzenie i pobrać wiadomości do subskrypcji Pub/Sub.

Aby przetestować subskrypcję Google Workspace:

Konsola Google Cloud

  1. Wywołuj co najmniej 1 typ zdarzenia w zasobie docelowym subskrypcji Google Workspace. Jeśli na przykład zasubskrybowałeś nowe wiadomości w pokoju czatu, opublikuj wiadomość w tym pokoju.

  2. W konsoli Google Cloud otwórz stronę Pub/Sub:

    Otwórz Pub/Sub

    Sprawdź, czy wybrany jest projekt Cloud dla Twojej aplikacji.

  3. W menu Pub/Sub kliknij Subskrypcje.

  4. W tabeli znajdź subskrypcję Pub/Sub powiązaną z tematem i kliknij jej nazwę.

  5. Kliknij kartę Wiadomości.

  6. Kliknij Pobierz. Wygenerowanie wiadomości Pub/Sub przez zdarzenie może potrwać kilka minut.

gcloud

  1. Wywołuj co najmniej 1 typ zdarzenia w zasobie docelowym subskrypcji Google Workspace. Jeśli na przykład zasubskrybowałeś nowe wiadomości w pokoju czatu, opublikuj wiadomość w tym pokoju.

  2. Uruchom to polecenie:

    gcloud pubsub subscriptions pull PUBSUB_SUBSCRIPTION_NAME --format=json --limit=MESSAGE_COUNT --auto-ack
    

    Zastąp następujące elementy:

    • PUBSUB_SUBSCRIPTION_NAME: pełna nazwa Twojej subskrypcji Pub/Sub w formacie projects/SUBSCRIPTION_ID/subscriptions/SUBSCRIPTION_ID.
    • MESSAGE_COUNT: maksymalna liczba wiadomości Pub/Sub, które chcesz pobrać.

    Wygenerowanie wiadomości Pub/Sub przez zdarzenie może potrwać kilka minut.

Dla każdego wywołanego zdarzenia Google Workspace wiadomość jest dostarczana do subskrypcji Pub/Sub, która zawiera to zdarzenie. Więcej informacji znajdziesz w artykule Odbieranie zdarzeń jako wiadomości Google Cloud Pub/Sub.

Konfigurowanie sposobu odbierania zdarzeń przez aplikację

Utworzona subskrypcja Pub/Sub jest oparta na pobieraniu. Po przetestowaniu subskrypcji Pub/Sub możesz zaktualizować typ dostarczania, aby zmienić sposób, w jaki aplikacja odbiera zdarzenia. Możesz na przykład skonfigurować subskrypcję Pub/Sub pod kątem typu dostarczania push, tak aby aplikacja mogła odbierać zdarzenia bezpośrednio do punktu końcowego aplikacji.

Aby dowiedzieć się więcej o konfigurowaniu subskrypcji Pub/Sub, zapoznaj się z dokumentacją Pub/Sub.