Tworzenie subskrypcji Google Workspace

Google Apps Script

• Aby użyć poleceń Google Cloud CLI opisanych w tym przewodniku:
  1. Zainstaluj interfejs wiersza poleceń Google Cloud.
  2. Do zainicjuj interfejs wiersza poleceń gcloud, uruchom ten kod:

    gcloud init
    

• projekt Google Cloud; z włączonymi płatnościami. Aby zasubskrybować Google Chat, musisz: włącz też interfejs Chat API w projekcie Cloud oraz skonfiguruj pola Nazwa aplikacji, URL awatara i Opis. . Więcej informacji: Utwórz aplikację Google Chat.
• Wymaga uwierzytelniania użytkownika za pomocą ekranu zgody OAuth skonfigurowanym dla aplikację. Podczas konfigurowania ekranu zgody musisz określić zakres Obsługują każdy typ zdarzenia w ramach subskrypcji. Aby skonfigurować prośbę o zgodę na przetwarzanie danych i zidentyfikowaniu wymaganych zakresów. Więcej informacji Wybierz zakresy.

• Projekt Apps Script:
  • Użyj swojego projektu Google Cloud zamiast domyślnego projektu utworzonego automatycznie przez Apps Script.
  • We wszystkich zakresach dodanych w celu skonfigurowania ekranu zgody OAuth musisz też dodać parametr ogranicza się 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 w wersji 3.6 lub nowszej
• narzędzie do zarządzania pakietami pip;
• Najnowsze biblioteki klienta Google dla języka Python. Aby je zainstalować lub zaktualizować, uruchom to w interfejsie wiersza poleceń:

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
    

• Aby użyć poleceń Google Cloud CLI opisanych w tym przewodniku:
  1. Zainstaluj interfejs wiersza poleceń Google Cloud.
  2. Do zainicjuj interfejs wiersza poleceń gcloud, uruchom ten kod:

    gcloud init
    

• projekt Google Cloud; z włączonymi płatnościami. Aby zasubskrybować Google Chat, musisz: włącz też interfejs Chat API w projekcie Cloud oraz skonfiguruj pola Nazwa aplikacji, URL awatara i Opis. . Więcej informacji: Utwórz aplikację Google Chat.
• Wymaga uwierzytelniania użytkownika za pomocą ekranu zgody OAuth skonfigurowanym dla aplikację. Podczas konfigurowania ekranu zgody musisz określić zakres Obsługują każdy typ zdarzenia w ramach subskrypcji. Aby skonfigurować prośbę o zgodę na przetwarzanie danych i zidentyfikowaniu wymaganych zakresów. Więcej informacji Wybierz zakresy.

Google Cloud Console

W konsoli Google Cloud otwórz projekt Google Cloud dla swojej aplikacji i włącz Interfejs Google Workspace Events API i Pub/Sub API:

Włączanie interfejsów API

gcloud

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

   gcloud auth login
   

2. Ustaw projekt aplikacji w Google Cloud:

   gcloud config set project PROJECT_ID
   

   Zamień PROJECT_ID na identyfikator projektu Cloud dla Twojej aplikacji.

3. Włączanie interfejsu Google Workspace Events API i Google Cloud Pub/Sub Interfejs API:

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

Google Cloud Console

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

   Otwórz Google Cloud Pub/Sub

   Upewnij się, że wybrany jest projekt Google Cloud dla Twojej aplikacji.

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

   1. Wpisz nazwę tematu, np. workspace-events-topic.
   2. Pozostaw zaznaczone pole Dodaj domyślną subskrypcję. Pub/Sub nadaje nazwę subskrypcję domyślną podobną do nazwy Twojego tematu, na przykład workspace-events-topic-sub
   3. Opcjonalnie: zaktualizuj lub skonfiguruj dodatkowe właściwości danego tematu.

3. Kliknij Utwórz. Pełna nazwa tematu jest sformatowana w ten sposób: projects/PROJECT_ID/topics/TOPIC_ID Użyjesz tego imienia i nazwiska w kolejnym kroku.

4. Przyznaj uprawnienia do publikowania wiadomości Pub/Sub w temacie:

   1. Na stronie tematu przejdź do panelu bocznego i otwórz Uprawnienia.
   2. Kliknij Dodaj podmiot zabezpieczeń.
   3. W polu Dodaj podmioty zabezpieczeń dodaj konto usługi dla: Aplikacja Google Workspace, która dostarcza zdarzenia do subskrypcja:
      1. W przypadku wydarzeń 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ń może potrwać kilka minut danego tematu.

gcloud

1. W projekcie Cloud utwórz temat, uruchamiając to polecenie polecenie:

   gcloud pubsub topics create TOPIC_ID
   

   Zastąp TOPIC_ID unikalnym identyfikatorem tematu, takim jak jako workspace-events-topic.

   W danych wyjściowych zostanie wyświetlona pełna nazwa tematu w formacie projects/PROJECT_ID/topics/TOPIC_ID Zanotuj nazwę i upewnij się, że wartość dla argumentu PROJECT_ID to identyfikator projektu Cloud dla Twojej aplikacji. Użyjesz jej w następnym kroku. subskrypcję Google Workspace.

2. Przyznaj uprawnienia 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 danych wyjściowych z poprzedniego kroku. Sformatowane jako projects/PROJECT_ID/topics/TOPIC_ID

   • GOOGLE_WORKSPACE_APPLICATION: Aplikacja Google Workspace, która musi przesyłać zdarzenia do subskrypcji:

     • Aby odbierać wydarzenia z Google Chat, użyj chat-api-push@system.gserviceaccount.com
     • Aby odbierać wydarzenia z Meet, użyj 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 utworzonego przez Ciebie tematu. w poprzednim kroku.

Google Apps Script

1. Utwórz nowy plik skryptu w projekcie Apps Script createSubscription i dodaj 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 chcesz zasubskrybować, w formacie pełnej nazwy jego zasobu. Dla: na przykład, aby zasubskrybować pokój Google Chat o identyfikatorze pokoju AAAABBBB, użyj formy płatności //chat.googleapis.com/spaces/AAAABBBB.
   • EVENT_TYPES: co najmniej 1 typ zdarzenia który chcesz subskrybować w zasobie docelowym. Sformatuj jako tablica ciągów znaków, takich jak 'google.workspace.chat.message.v1.created'.
   • TOPIC_NAME: pełna nazwa tematu Pub/Sub, który utworzony w projekcie Cloud. Sformatowane jako projects/PROJECT_ID/topics/TOPIC_ID

   • RESOURCE_DATA: wartość logiczna określająca, czy subskrypcja zawiera w ładunku dane zasobów:

     • True: obejmuje wszystkie dane zasobów. Aby ograniczyć zakres pól należy dodać fieldMask i określ co najmniej jedno pole dla zmienionego zasobu. Tylko subskrypcji pomocy dotyczącej zasobów Google Chat, w tym danych zasobów.
     • False: wyklucza dane zasobów.

2. Aby utworzyć subskrypcję Google Workspace, uruchom funkcję createSubscription w projekcie Apps Script.

Python

1. W katalogu roboczym utwórz plik o nazwie create_subscription.py. i dodaj 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 OAuth obsługujący każdy typ zdarzenia. za subskrypcję. Sformatowana jako tablica ciągów znaków. Aby wymienić kilka zakresów, oddziel 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 chcesz zasubskrybować, w formacie pełnej nazwy jego zasobu. Dla: na przykład, aby zasubskrybować pokój Google Chat o identyfikatorze pokoju AAAABBBB, użyj formy płatności //chat.googleapis.com/spaces/AAAABBBB.
   • EVENT_TYPES: co najmniej 1 typ zdarzenia który chcesz subskrybować w zasobie docelowym. Sformatuj jako tablica ciągów znaków, takich jak 'google.workspace.chat.message.v1.created'.
   • TOPIC_NAME: pełna nazwa tematu Pub/Sub, który utworzony w projekcie Cloud. Sformatowane jako projects/PROJECT_ID/topics/TOPIC_ID

   • RESOURCE_DATA: wartość logiczna określająca, czy subskrypcja zawiera w ładunku dane zasobów:

     • True: obejmuje wszystkie dane zasobów. Aby ograniczyć zakres pól należy dodać fieldMask i określ co najmniej jedno pole dla zmienionego zasobu. Tylko subskrypcji pomocy dotyczącej zasobów Google Chat, w tym danych zasobów.
     • False: wyklucza dane zasobów.

2. Aby utworzyć subskrypcję Google Workspace, uruchom to polecenie w terminal:

   python3 create_subscription.py
   

Google Cloud Console

1. Aktywuj co najmniej jeden typ zdarzenia w zasobie docelowym swojej Abonament Google Workspace. Jeśli na przykład subskrybujesz nowy kanał wiadomości w pokoju czatu, opublikuj wiadomość w tym pokoju.

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

   Otwórz stronę Pub/Sub

   Upewnij się, że wybrany jest projekt Google Cloud dla Twojej aplikacji.

3. W menu Pub/Sub kliknij Subskrypcje.

4. W tabeli znajdź subskrypcję Pub/Sub dla swojego tematu i kliknij nazwę subskrypcji.

5. Kliknij kartę Wiadomości.

6. Kliknij Pobierz. Może minąć kilka minut, zanim zdarzenie wygeneruje Wiadomość Pub/Sub.

gcloud

1. Aktywuj co najmniej jeden typ zdarzenia w zasobie docelowym swojej Abonament Google Workspace. Jeśli na przykład subskrybujesz nowy kanał 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 Twojego Subskrypcja Pub/Sub w formacie projects/SUBSCRIPTION_ID/subscriptions/SUBSCRIPTION_ID
   • MESSAGE_COUNT: maksymalna liczba wiadomości Pub/Sub, które chcesz pobrać.

   Wygenerowanie Pub/Sub przez zdarzenie może potrwać nawet kilka minut .