Tworzenie subskrypcji Google Workspace

Google Apps Script

• Aby używać poleceń interfejsu wiersza poleceń Google Cloud w tym przewodniku:
  1. Zainstaluj Google Cloud CLI.
  2. Aby zainicjować interfejs wiersza poleceń gcloud, uruchom ten kod:

    gcloud init
    

• Projekt Apps Script:
  • Używaj projektu Google Cloud zamiast domyślnego projektu utworzonego automatycznie przez Apps Script.
  • Wszystkie zakresy dodane w celu skonfigurowania ekranu zgody OAuth musisz też dodać do pliku appsscript.json w projekcie Apps Script. Jeśli na przykład określono zakres chat.messages, dodaj ten kod:

  "oauthScopes": [
    "https://www.googleapis.com/auth/chat.messages"
  ]
      

  • Włącz Google Workspace Events usługę zaawansowaną.

• projekt Google Cloud z włączonymi płatnościami; W przypadku subskrypcji Google Chat musisz też włączyć interfejs Chat API w projekcie w chmurze i skonfigurować pola Nazwa aplikacji, Adres URL awatara i Opis. Szczegółowe informacje znajdziesz w artykule Tworzenie aplikacji Google Chat.
• Wymaga uwierzytelniania i odpowiedniego zakresu autoryzacji dla każdego typu zdarzenia w subskrypcji:
  • Zwykle wymaga uwierzytelnienia użytkownika za pomocą ekranu zgody OAuth skonfigurowanego dla aplikacji. Podczas konfigurowania ekranu zgody musisz określić zakres, aby obsługiwać każdy typ zdarzenia w przypadku subskrypcji. Aby skonfigurować ekran zgody i określić wymagane zakresy, przeczytaj artykuł Wybieranie zakresów.
  • Subskrybowanie zdarzenia w Google Chat jako aplikacja do obsługi czatu wymaga uwierzytelnienia aplikacji z jednorazowym zatwierdzeniem przez administratora.

Python

• Python 3.6 lub nowszy
• 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
    

• Aby używać poleceń interfejsu wiersza poleceń Google Cloud w tym przewodniku:
  1. Zainstaluj Google Cloud CLI.
  2. Aby zainicjować interfejs wiersza poleceń gcloud, uruchom ten kod:

    gcloud init
    

• projekt Google Cloud z włączonymi płatnościami; W przypadku subskrypcji Google Chat musisz też włączyć interfejs Chat API w projekcie w chmurze i skonfigurować pola Nazwa aplikacji, Adres URL awatara i Opis. Szczegółowe informacje znajdziesz w artykule Tworzenie aplikacji Google Chat.
• Wymaga uwierzytelniania i odpowiedniego zakresu autoryzacji dla każdego typu zdarzenia w subskrypcji:
  • Zwykle wymaga uwierzytelnienia użytkownika za pomocą ekranu zgody OAuth skonfigurowanego dla aplikacji. Podczas konfigurowania ekranu zgody musisz określić zakres, aby obsługiwać każdy typ zdarzenia w przypadku subskrypcji. Aby skonfigurować ekran zgody i określić wymagane zakresy, przeczytaj artykuł Wybieranie zakresów.
  • Subskrybowanie zdarzenia w Google Chat jako aplikacja do obsługi czatu wymaga uwierzytelnienia aplikacji z jednorazowym zatwierdzeniem przez administratora.

Konsola Google Cloud

W konsoli Google Cloud otwórz projekt w chmurze Google Cloud dla swojej aplikacji i włącz interfejsy 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 w chmurze dla aplikacji:

   gcloud config set project PROJECT_ID

   Zastąp PROJECT_ID identyfikatorem projektu projektu w chmurze dla Twojej aplikacji.

3. Włącz interfejs Google Workspace Events API i Google Cloud Pub/Sub API:

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

Konsola interfejsów API Google

1. W konsoli interfejsów API Google otwórz stronę Pub/Sub:

   Otwórz Google Cloud Pub/Sub

   Sprawdź, czy wybrany jest projekt w chmurze dla Twojej aplikacji.

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

   1. Wpisz nazwę tematu, np. workspace-events-topic.
   2. Pozostaw zaznaczoną opcję Dodaj subskrypcję domyślną. Pub/Sub nadaje tej domyślnej subskrypcji nazwę podobną do nazwy tematu, np. workspace-events-topic-sub.
   3. Opcjonalnie: zaktualizuj lub skonfiguruj dodatkowe właściwości tematu.

3. Kliknij Utwórz. Pełna nazwa tematu ma format projects/PROJECT_ID/topics/TOPIC_ID. Użyj tego imienia i nazwiska w późniejszym kroku.

4. Przyznaj dostęp do publikowania wiadomości Pub/Sub w temacie:

   1. Na stronie tematu otwórz panel boczny i kliknij kartę Uprawnienia.
   2. Kliknij Dodaj podmiot zabezpieczeń.
   3. W polu Dodaj podmioty zabezpieczeń dodaj konto usługi aplikacji Google Workspace, która dostarcza wydarzenia do Twojej subskrypcji:
      1. W przypadku wydarzeń na czacie:
         • W przypadku aplikacji Google Chat (utworzonych jako dodatki do Google Workspace, które rozszerzają funkcje tej usługi) użyj adresu e-mail konta usługi na stronie konfiguracji interfejsu Chat API. Więcej informacji znajdziesz w artykule Tworzenie aplikacji Google Chat, która korzysta z Pub/Sub.
         • W przypadku aplikacji do obsługi czatu, które nie są dodatkami do Google Workspace, użyj chat-api-push@system.gserviceaccount.com. Więcej informacji znajdziesz w artykule Tworzenie aplikacji Google Chat, która korzysta z Pub/Sub.
      2. W przypadku wydarzeń na Dysku:drive-api-event-push@system.gserviceaccount.com
      3. 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ń do tematu może potrwać kilka minut.

gcloud

1. W projekcie w chmurze utwórz temat, 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 w chmurze dla Twojej aplikacji. Użyj nazwy tematu w następnym kroku i później, aby utworzyć 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 te elementy:

   • TOPIC_NAME: pełna nazwa tematu, która jest wynikiem poprzedniego kroku. Sformatowano jako projects/PROJECT_ID/topics/TOPIC_ID.

   • GOOGLE_WORKSPACE_APPLICATION: aplikacja Google Workspace, która musi dostarczać zdarzenia do Twojej subskrypcji:

     • Aby otrzymywać zdarzenia z Google Chat, użyj jednego z tych kont usługi:
       • W przypadku aplikacji Google Chat (utworzonych jako dodatki do Google Workspace, które rozszerzają funkcje tej usługi) użyj adresu e-mail konta usługi na stronie konfiguracji interfejsu Chat API. Więcej informacji znajdziesz w artykule Tworzenie aplikacji Google Chat, która korzysta z Pub/Sub.
       • W przypadku aplikacji do obsługi czatu, które nie są dodatkami, użyj chat-api-push@system.gserviceaccount.com. Więcej informacji znajdziesz w artykule Tworzenie aplikacji Google Chat, która korzysta z Pub/Sub.
     • Aby otrzymywać zdarzenia z Dysku, użyj drive-api-event-push@system.gserviceaccount.com.
     • Aby otrzymywać zdarzenia z Meet, użyj meet-api-event-push@system.gserviceaccount.com.

   Aktualizacja uprawnień do 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 te elementy:

   • SUBSCRIPTION_NAME: Nazwa subskrypcji, np. workspace-events-subscription.
   • TOPIC_NAME: Nazwa tematu utworzonego w poprzednim kroku.

Google Apps Script

1. W projekcie Apps Script utwórz nowy plik skryptu o nazwie 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 te elementy:

   • TARGET_RESOURCE: zasób Google Workspace, który subskrybujesz, w formacie pełnej nazwy zasobu. Aby na przykład zasubskrybować pokój Google Chat o identyfikatorze AAAABBBB, użyj //chat.googleapis.com/spaces/AAAABBBB.
   • EVENT_TYPES: co najmniej 1 typ zdarzenia, który chcesz subskrybować w zasobie docelowym. Sformatuj jako tablicę ciągów znaków, np. 'google.workspace.chat.message.v1.created'.
   • TOPIC_NAME: pełna nazwa tematu Pub/Sub utworzonego w projekcie w chmurze. Sformatowano jako projects/PROJECT_ID/topics/TOPIC_ID.

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

     • True: zawiera wszystkie dane zasobów. Aby ograniczyć liczbę 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ą uwzględnianie danych zasobów.
     • False: nie obejmuje danych o zasobach.

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('credentials.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 te elementy:

   • SCOPES: co najmniej 1 zakres OAuth, który obsługuje każdy typ zdarzenia w przypadku subskrypcji. Sformatowane jako tablica ciągów znaków. Aby podać 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 subskrybujesz, w formacie pełnej nazwy zasobu. Aby na przykład zasubskrybować pokój Google Chat o identyfikatorze AAAABBBB, użyj //chat.googleapis.com/spaces/AAAABBBB.
   • EVENT_TYPES: co najmniej 1 typ zdarzenia, który chcesz subskrybować w zasobie docelowym. Sformatuj jako tablicę ciągów znaków, np. 'google.workspace.chat.message.v1.created'.
   • TOPIC_NAME: pełna nazwa tematu Pub/Sub utworzonego w projekcie w chmurze. Sformatowano jako projects/PROJECT_ID/topics/TOPIC_ID.

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

     • True: obejmuje wszystkie dane zasobów. Aby ograniczyć liczbę 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ą uwzględnianie danych zasobów.
     • False: nie obejmuje danych o zasobach.

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

   python3 create_subscription.py

Konsola interfejsów API Google

1. Uruchamiać co najmniej 1 rodzaj zdarzeń w zasobie docelowym subskrypcji Google Workspace. Jeśli na przykład subskrybujesz nowe wiadomości w pokoju czatu, opublikuj w nim wiadomość.

2. W konsoli interfejsów API Google otwórz stronę Pub/Sub:

   Otwórz stronę Pub/Sub

   Sprawdź, czy wybrany jest projekt w chmurze 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. Wygenerowanie wiadomości Pub/Sub przez zdarzenie może potrwać kilka minut.

gcloud

1. Uruchamiać co najmniej 1 rodzaj zdarzeń w zasobie docelowym subskrypcji Google Workspace. Jeśli na przykład subskrybujesz nowe wiadomości w pokoju czatu, opublikuj w nim wiadomość.

2. Uruchom to polecenie:

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

   Zastąp te elementy:

   • PUBSUB_SUBSCRIPTION_NAME: Pełna nazwa subskrypcji Pub/Sub w formacie projects/PROJECT_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.

Python

  """Create subscription."""

  from google.oauth2 import service_account
  from apiclient.discovery import build

  # Specify required scopes.
  SCOPES = ['https://www.googleapis.com/auth/chat.app.messages.readonly']

  # Specify service account details.
  CREDENTIALS = (
      service_account.Credentials.from_service_account_file('credentials.json')
      .with_scopes(SCOPES)
  )

  # The Google Workspace resource to monitor for events.
  TARGET_RESOURCE = '//chat.googleapis.com/spaces/SPACE_ID'

  # The types of events to receive.
  EVENT_TYPES = [
                  'google.workspace.chat.message.v1.created',
                  'google.workspace.chat.message.v1.updated',
                  'google.workspace.chat.message.v1.deleted',
                ]

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

Python

"""Create a customer subscription."""

from google.oauth2 import service_account
from apiclient.discovery import build

# Specify required scopes.
# Replace with the scopes needed for the event types you want to receive.
SCOPES = ['https://www.googleapis.com/auth/chat.app.all.messages.readonly']

# Specify service account details.
CREDENTIALS = (
    service_account.Credentials.from_service_account_file('credentials.json')
    .with_scopes(SCOPES)
)

# Monitor all events for the Google Workspace organization.
TARGET_RESOURCE = '//admin.googleapis.com/customers/CUSTOMER_ID'

# The types of events to receive.
EVENT_TYPES = [
    'google.workspace.chat.message.v1.created',
    'google.workspace.chat.message.v1.updated',
    'google.workspace.chat.message.v1.deleted',
]

# The endpoint to deliver events to.
TOPIC = 'TOPIC_NAME'

# Call the Workspace Events API.
# Note: Use the v1beta endpoint for Developer Preview features.
service = build(
    'workspaceevents',
    'v1beta',
    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)