Obserwowanie wydarzeń dotyczących spotkań za pomocą Pythona i interfejsu Google Meet REST API

Ten samouczek pokazuje, jak używać interfejsu REST Google Meet razem z interfejsem Events API w Google Workspace i Google Cloud Pub/Sub, aby obserwować zdarzenia w pokoju spotkań w Meet i na nie reagować. Przykładowa aplikacja rejestruje, kiedy konferencje się zaczynają i kończą, kiedy uczestnicy dołączają i opuszczają spotkanie oraz kiedy są dostępne wygenerowane artefakty.

Zamiast subskrybować konkretny pokój spotkań możesz subskrybować użytkownika Meet, aby otrzymywać informacje o wydarzeniach w dowolnym pokoju spotkań, którego użytkownik jest właścicielem lub organizatorem. Szczegółowe informacje znajdziesz w sekcji Subskrybowanie zdarzeń Google Meet w dokumentacji interfejsu Events API w Google Workspace.

Wymagania wstępne

Jeśli chcesz włączyć te wymagania w swojej organizacji, poproś administratora Google Workspace o ich włączenie:

• Konto Google Workspace z dostępem do Google Meet.
• dostęp do tworzenia projektu Google Cloud.
• Zainstalowany Python 3.
• Zainstalowany interfejs wiersza poleceń gcloud.

Przygotowywanie środowiska

W tej sekcji dowiesz się, jak utworzyć i skonfigurować środowisko lokalne oraz projekt Google Cloud do celów tego samouczka.

Tworzenie katalogu roboczego i środowiska wirtualnego Pythona

Aby utworzyć i aktywować nowe środowisko wirtualne, uruchom w terminalu te polecenia.

mkdir meet-tutorial
cd meet-tutorial
python3 -mvenv env
source env/bin/activate

mkdir meet-tutorial
cd meet-tutorial
python3 -mvenv env
env/bin/activate.bat

mkdir meet-tutorial
cd meet-tutorial
python3 -mvenv env
env/bin/activate.ps1

Tworzenie projektu Google Cloud

Włączanie płatności w projekcie Google Cloud

Konfigurowanie uwierzytelniania i autoryzacji

Uwierzytelnianie i autoryzacja umożliwiają aplikacji dostęp do zasobów interfejsu API REST Meet. Aby wywołać interfejs Meet API REST, musisz uzyskać autoryzację użytkownika. Z tej sekcji dowiesz się, jak skonfigurować dane logowania użytkownika i poprosić o autoryzację.

Konfigurowanie ekranu zgody OAuth i wybieranie zakresów

W następnych krokach znajdziesz informacje zastępcze, które pomogą Ci skonfigurować ekran zgody OAuth w aplikacji. Przed opublikowaniem aplikacji na zewnątrz zaktualizuj te informacje.

1. W konsoli Google Cloud kliknij Menu menu > Interfejsy API i usługi > Ekran zgody OAuth.

   Otwórz ekran zgody OAuth

2. W sekcji Typ użytkownika wybierz Wewnętrzny, a potem kliknij Utwórz.
3. W polu Nazwa aplikacji wpisz Meet REST API Tutorial.
4. Wypełnij formularz rejestracji aplikacji, a potem kliknij Zapisz i kontynuuj.
5. Kliknij Dodaj lub usuń zakresy. Pojawi się panel z listą zakresów dostępu do każdego interfejsu API włączonego w projekcie Google Cloud.
6. W sekcji Ręczne dodawanie zakresów wklej te zakresy:
   • https://www.googleapis.com/auth/meetings.space.created
7. Kliknij Dodaj do tabeli.
8. Kliknij Aktualizuj.
9. Po wybraniu zakresów wymaganych przez aplikację kliknij Zapisz i kontynuuj.
10. Jeśli jako typ użytkownika wybierzesz Zewnętrzny, dodaj użytkowników testowych:
    1. W sekcji Użytkownicy testowi kliknij Dodaj użytkowników.
    2. Wpisz swój adres e-mail i adresy e-mail innych autoryzowanych użytkowników testu, a potem kliknij Zapisz i kontynuuj.
11. Sprawdź podsumowanie rejestracji aplikacji. Aby wprowadzić zmiany, kliknij Edytuj. Jeśli rejestracja aplikacji wygląda dobrze, kliknij Powrót do panelu.

Tworzenie identyfikatora klienta

Identyfikator klienta pełni funkcję danych logowania w procesach OAuth 2.0. Ponieważ aplikacja działa lokalnie, utwórz identyfikator klienta na komputery.

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

   Przejdź do danych logowania

2. Kliknij Utwórz dane logowania > Identyfikator klienta OAuth.
3. Kliknij Typ aplikacji > Aplikacja na komputer.
4. W polu Nazwa wpisz nazwę danych logowania. Ta nazwa jest wyświetlana tylko w konsoli Google Cloud.
5. Kliknij Utwórz. Pojawi się ekran utworzonego klienta OAuth z nowym identyfikatorem klienta i tajnym kluczem klienta.
6. Kliknij OK. Nowo utworzone dane logowania pojawią się w sekcji Identyfikatory klienta OAuth 2.0.

Instalowanie bibliotek uwierzytelniania Google

Zainstaluj biblioteki uwierzytelniania Google:

pip install google-auth google-auth-oauthlib

Wykonywanie autoryzacji

Interfejs Meet REST wymaga danych logowania użytkownika w postaci tokena dostępu OAuth 2.0. W tej sekcji zaimplementujesz przepływ danych OAuth 2.0, aby poprosić użytkownika o token dostępu i token odświeżania.

1. W katalogu roboczym utwórz plik main.py z podaną niżej treścią:

   import os
   import json
   
   from google.auth.transport import requests
   from google.oauth2.credentials import Credentials
   from google_auth_oauthlib.flow import InstalledAppFlow
   
   def authorize() -> Credentials:
       """Ensure valid credentials for calling the Meet REST API."""
       CLIENT_SECRET_FILE = "./client_secret.json"
       credentials = None
   
       if os.path.exists('token.json'):
           credentials = Credentials.from_authorized_user_file('token.json')
   
       if credentials is None:
           flow = InstalledAppFlow.from_client_secrets_file(
               CLIENT_SECRET_FILE,
               scopes=[
                   'https://www.googleapis.com/auth/meetings.space.created',
               ])
           flow.run_local_server(port=0)
           credentials = flow.credentials
   
       if credentials and credentials.expired:
           credentials.refresh(requests.Request())
   
       if credentials is not None:
           with open("token.json", "w") as f:
               f.write(credentials.to_json())
   
       return credentials
   
   USER_CREDENTIALS = authorize()
   

2. Aby uruchomić kod, musisz podać identyfikator klienta i klucz tajny utworzone wcześniej. Skopiuj pobrany plik obiektu tajnego klienta do katalogu roboczego projektu i zmień jego nazwę na client_secret.json.

3. Jeśli chcesz przetestować, jak działa autoryzacja, uruchom to polecenie. Po zatwierdzeniu prośby aplikacja poprosi o autoryzację i utworzy plik token.json w katalogu roboczym projektu.

   python3 main.py

Dodawanie interfejsu API REST Meet

Teraz, gdy kod autoryzacji jest gotowy, możesz włączyć interfejs Meet REST API i go wywołać.

Włącz interfejsy API

Chociaż ta sekcja skupia się na interfejsie Meet REST API, w samouczku używamy też interfejsu Google Cloud Pub/Sub i interfejsu Events API w Google Workspace.

Instalowanie biblioteki klienta Meet REST API

Aby zainstalować bibliotekę klienta interfejsu Meet REST API:

1. Uruchom to polecenie:

   pip install google-apps-meet

2. Aby zaimportować klienta, otwórz plik main.py i zrób w nim to:

   from google.apps import meet_v2 as meet
   

Utwórz pokój

Teraz, gdy interfejs Meet REST API jest dostępny, zdefiniuj funkcję, która utworzy salę spotkań, do której można się zapisać.

Edytuj main.py i dodaj:

def create_space() -> meet.Space:
    """Create a meeting space."""
    client = meet.SpacesServiceClient(credentials=USER_CREDENTIALS)
    request = meet.CreateSpaceRequest()
    return client.create_space(request=request)

Subskrybowanie zdarzeń

Aby otrzymywać zdarzenia dotyczące pokoju spotkań, utwórz subskrypcję za pomocą interfejsu Events API w Google Workspace. Musisz też utworzyć temat Google Cloud Pub/Sub i subskrybować go. Temat ten będzie pełnił rolę punktu końcowego powiadomień, w którym aplikacja będzie otrzymywać zdarzenia.

Konfigurowanie Google Cloud Pub/Sub

Aby utworzyć temat Pub/Sub i się do niego zasubskrybować:

Zapisz nazwę tematu i upewnij się, że wartość {project} to identyfikator projektu Cloud Twojej aplikacji. Nazwy tematu użyjesz później do utworzenia subskrypcji Google Workspace.

Tworzenie konta usługi

Korzystanie z konta usługi

Po utworzeniu konta usługi przyznaj sobie uprawnienia do podszywania się pod to konto.

Instalowanie biblioteki klienta Pub/Sub

1. Aby zainstalować bibliotekę klienta Pub/Sub, użyj pip:

   pip install google-cloud-pubsub

2. Następnie edytuj main.py, aby zaimportować klienta:

   from google.cloud import pubsub_v1
   

Tworzenie subskrypcji Google Workspace

Dodaj ten kod do pliku main.py, aby zdefiniować metodę subskrypcji zdarzeń Meet. Ten kod subskrybuje wszystkie zdarzenia dotyczące pokoju spotkania. Po zasubskrybowaniu zdarzenia są publikowane w temacie Pub/Sub.

def subscribe_to_space(space_name: str = None, topic_name: str = None):
    """Subscribe to events for a meeting space."""
    session = requests.AuthorizedSession(USER_CREDENTIALS)
    body = {
        'targetResource': f"//meet.googleapis.com/{space_name}",
        "eventTypes": [
            "google.workspace.meet.conference.v2.started",
            "google.workspace.meet.conference.v2.ended",
            "google.workspace.meet.participant.v2.joined",
            "google.workspace.meet.participant.v2.left",
            "google.workspace.meet.recording.v2.fileGenerated",
            "google.workspace.meet.transcript.v2.fileGenerated",
        ],
        "payloadOptions": {
            "includeResource": False,
        },
        "notificationEndpoint": {
            "pubsubTopic": topic_name
        },
        "ttl": "86400s",
    }
    response = session.post("https://workspaceevents.googleapis.com/v1/subscriptions", json=body)
    return response

Następnie dodaj odpowiedni kod, aby pobierać i przetwarzać zdarzenia.

Nasłuchiwanie zdarzeń i obsługa

Kontynuuj edycję main.py i dodaj ten przykładowy kod. Ten kod implementuje stronę odbierającą i używa interfejsu Google Cloud Pub/Sub API do pobierania zdarzeń w miarę ich udostępniania. Różne metody obsługi wyświetlają informacje o odpowiednich zdarzeniach.

def format_participant(participant: meet.Participant) -> str:
    """Formats a participant for display on the console."""
    if participant.anonymous_user:
        return f"{participant.anonymous_user.display_name} (Anonymous)"

    if participant.signedin_user:
        return f"{participant.signedin_user.display_name} (ID: {participant.signedin_user.user})"

    if participant.phone_user:
        return f"{participant.phone_user.display_name} (Phone)"

    return "Unknown participant"


def fetch_participant_from_session(session_name: str) -> meet.Participant:
    """Fetches the participant for a session."""
    client = meet.ConferenceRecordsServiceClient(credentials=USER_CREDENTIALS)
    # Use the parent path of the session to fetch the participant details
    parsed_session_path = client.parse_participant_session_path(session_name)
    participant_resource_name = client.participant_path(
        parsed_session_path["conference_record"],
        parsed_session_path["participant"])
    return client.get_participant(name=participant_resource_name)


def on_conference_started(message: pubsub_v1.subscriber.message.Message):
    """Display information about a conference when started."""
    payload = json.loads(message.data)
    resource_name = payload.get("conferenceRecord").get("name")
    client = meet.ConferenceRecordsServiceClient(credentials=USER_CREDENTIALS)
    conference = client.get_conference_record(name=resource_name)
    print(f"Conference (ID {conference.name}) started at {conference.start_time.rfc3339()}")


def on_conference_ended(message: pubsub_v1.subscriber.message.Message):
    """Display information about a conference when ended."""
    payload = json.loads(message.data)
    resource_name = payload.get("conferenceRecord").get("name")
    client = meet.ConferenceRecordsServiceClient(credentials=USER_CREDENTIALS)
    conference = client.get_conference_record(name=resource_name)
    print(f"Conference (ID {conference.name}) ended at {conference.end_time.rfc3339()}")


def on_participant_joined(message: pubsub_v1.subscriber.message.Message):
    """Display information about a participant when they join a meeting."""
    payload = json.loads(message.data)
    resource_name = payload.get("participantSession").get("name")
    client = meet.ConferenceRecordsServiceClient(credentials=USER_CREDENTIALS)
    session = client.get_participant_session(name=resource_name)
    participant = fetch_participant_from_session(resource_name)
    display_name = format_participant(participant)
    print(f"{display_name} joined at {session.start_time.rfc3339()}")


def on_participant_left(message: pubsub_v1.subscriber.message.Message):
    """Display information about a participant when they leave a meeting."""
    payload = json.loads(message.data)
    resource_name = payload.get("participantSession").get("name")
    client = meet.ConferenceRecordsServiceClient(credentials=USER_CREDENTIALS)
    session = client.get_participant_session(name=resource_name)
    participant = fetch_participant_from_session(resource_name)
    display_name = format_participant(participant)
    print(f"{display_name} left at {session.end_time.rfc3339()}")


def on_recording_ready(message: pubsub_v1.subscriber.message.Message):
    """Display information about a recorded meeting when artifact is ready."""
    payload = json.loads(message.data)
    resource_name = payload.get("recording").get("name")
    client = meet.ConferenceRecordsServiceClient(credentials=USER_CREDENTIALS)
    recording = client.get_recording(name=resource_name)
    print(f"Recording available at {recording.drive_destination.export_uri}")


def on_transcript_ready(message: pubsub_v1.subscriber.message.Message):
    """Display information about a meeting transcript when artifact is ready."""
    payload = json.loads(message.data)
    resource_name = payload.get("transcript").get("name")
    client = meet.ConferenceRecordsServiceClient(credentials=USER_CREDENTIALS)
    transcript = client.get_transcript(name=resource_name)
    print(f"Transcript available at {transcript.docs_destination.export_uri}")


def on_message(message: pubsub_v1.subscriber.message.Message) -> None:
    """Handles an incoming event from the Google Cloud Pub/Sub API."""
    event_type = message.attributes.get("ce-type")
    handler = {
        "google.workspace.meet.conference.v2.started": on_conference_started,
        "google.workspace.meet.conference.v2.ended": on_conference_ended,
        "google.workspace.meet.participant.v2.joined": on_participant_joined,
        "google.workspace.meet.participant.v2.left": on_participant_left,
        "google.workspace.meet.recording.v2.fileGenerated": on_recording_ready,
        "google.workspace.meet.transcript.v2.fileGenerated": on_transcript_ready,
    }.get(event_type)

    try:
        if handler is not None:
            handler(message)
        message.ack()
    except Exception as error:
        print("Unable to process event")
        print(error)


def listen_for_events(subscription_name: str = None):
    """Subscribe to events on the subscription."""
    subscriber = pubsub_v1.SubscriberClient()
    with subscriber:
        future = subscriber.subscribe(subscription_name, callback=on_message)
        print("Listening for events")
        try:
            future.result()
        except KeyboardInterrupt:
            future.cancel()
    print("Done")

Finalizowanie kodu

Dodaj do main.py ten kod, aby wywołać metody tworzenia przestrzeni, subskrybowania zdarzeń i słuchania. Zmień stałe TOPIC_NAME i SUBSCRIPTION_NAME na wcześniej utworzone przez siebie nazwy tematów i subskrypcji.

1. Dodaj kod do pliku main.py:

   space = create_space()
   print(f"Join the meeting at {space.meeting_uri}")
   
   TOPIC_NAME = "projects/PROJECT_ID/topics/TOPIC_ID"
   SUBSCRIPTION_NAME = "projects/PROJECT_ID/subscriptions/SUBSCRIPTION_ID"
   
   subscription = subscribe_to_space(topic_name=TOPIC_NAME, space_name=space.name)
   listen_for_events(subscription_name=SUBSCRIPTION_NAME)
   

   Zastąp następujące elementy:

   • PROJECT_ID: unikalny identyfikator projektu Cloud Twojej aplikacji, np. my-sample-project-191923.

   • TOPIC_ID: nazwa tematu Pub/Sub utworzonego w projekcie Cloud.

   • SUBSCRIPTION_ID: nazwa subskrypcji, np. workspace-events-sub.

2. Uruchom program:

   python3 main.py

Jeśli program nie był wcześniej uruchamiany, po raz pierwszy pojawi się prośba o autoryzację. przyznać aplikacji dostęp do interfejsu Meet REST API, Po uruchomieniu programu powinny pojawić się dane wyjściowe podobne do tych:

Join the meeting at https://meet.google.com/abc-mnop-xyz

Dołączanie do konferencji

Aby wygenerować zdarzenia dla aplikacji, dołącz do konferencji, korzystając z adresu URL wyświetlanego przez aplikację. Po dołączeniu możesz wykonać te czynności, aby wywołać zdarzenia:

• Opuść spotkanie i dołącz do niego ponownie.
• Zaproś inne osoby lub połącz się przez telefon.
• Włącz nagrywanie i tworzenie transkrypcji.

Każda z tych czynności powoduje wygenerowanie zdarzenia, które aplikacja odbiera i rejestruje w konsoli Google Cloud.

Gdy skończysz, przerwij program, używając ctrl-c.

Opcjonalnie: dodatkowe czynności

Aplikacja rejestruje podstawowe informacje o wydarzeniu. Aby dalej poznawać interfejs Meet REST API, spróbuj zmodyfikować aplikację, aby wykonać te dodatkowe czynności.

• Użyj interfejsu People API, aby pobrać dodatkowe informacje o zalogowanych uczestnikach.
• Pobierz nagrania i transkrypcje za pomocą interfejsu Google Drive API.
• Zamiast pobierać transkrypcje z Dysku Google, możesz je pobierać za pomocą metod tworzenia uporządkowanych transkrypcji w interfejsie Meet REST API.

Opcjonalnie: oczyszczenie

Aby uniknąć obciążenia konta konsoli Google Cloud opłatami za zasoby zużyte w tym samouczku, zalecamy usunięcie wszystkich utworzonych zasobów i projektów.

Aby usunąć subskrypcję:

Aby usunąć temat:

Aby usunąć projekt:

Powiązane artykuły

• Dowiedz się więcej o typach wydarzeń w Meet, do których możesz się zapisać.
• Dowiedz się więcej o tym, co potrafi interfejs Google Meet REST API, i zapoznaj się z dokumentacją referencyjną.
• Utwórz subskrypcję Google Workspace dla sal konferencyjnych Meet lub użytkowników za pomocą interfejsu Google Workspace Events API.
• Więcej informacji o uwierzytelnianiu znajdziesz w artykule Konfigurowanie ekranu zgody OAuth i wybieranie zakresów.