使用 Python 和 Google Meet REST API 觀察會議事件

本教學課程將示範如何使用 Google Meet REST API 和 透過 Google Workspace Events API 和 Google Cloud Pub/Sub 觀察事件並做出回應 會議活動。範例應用程式會記錄會議開始和結束時間， 參與者加入或離開，以及系統產生的會議成果 廣告。

如要進一步瞭解如何處理活動，請參閱「訂閱 Google Meet」 Google Workspace Event API 中的事件 說明文件。

必要條件

如果貴機構需要啟用上述任何必備條件，可以參閱 請按照下列步驟開啟這項功能：

• 具備以下角色的 Google Workspace 帳戶： 應使用 Google Meet。
• 具備建立 Google Cloud 專案的權限。
• 已安裝 Python 3。
• 已安裝 gcloud CLI。

準備環境

本節說明如何建立及設定本機環境，以及 用於這個教學課程的 Google Cloud 專案

建立工作目錄和 Python 虛擬環境

如何建立並啟用新的虛擬帳號 環境，請在下列項目中執行 指令。

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

建立 Google Cloud 專案

啟用 Google Cloud 專案的計費功能

設定驗證與授權

通過驗證及授權後，應用程式就能存取 Meet REST API 再複習一下，機構節點 是所有 Google Cloud Platform 資源的根節點需要使用者授權才能呼叫 Meet REST API。 本節將說明如何設定使用者憑證和要求 或授權。

設定 OAuth 同意畫面並選擇範圍

下列步驟建議設定預留位置資訊 使用者的 OAuth 同意畫面 請先更新這項資訊，再對外發布應用程式。

1. 在 Google Cloud 控制台中，前往「選單」圖示 menu > API 與服務 >「OAuth 同意畫面」。

   前往 OAuth 同意畫面

2. 在「使用者類型」下方選取「內部」，然後點選「建立」。
3. 在「App name」(應用程式名稱) 中輸入 Meet REST API Tutorial。
4. 填寫應用程式註冊表單，然後按一下「儲存並繼續」。
5. 按一下「新增或移除範圍」。畫面上會顯示包含範圍清單的面板 。
6. 在「手動新增範圍」下方，貼上下列範圍：
   • https://www.googleapis.com/auth/meetings.space.created
7. 按一下「Add to Table」。
8. 按一下「更新」。
9. 選取需要的範圍後 請按一下「儲存並繼續」。
10. 如果您為使用者類型選取「外部」，請新增測試使用者：
    1. 在「測試使用者」下方，按一下「新增使用者」。
    2. 輸入您的電子郵件地址和其他任何授權測試使用者，然後按一下 儲存並繼續。
11. 查看應用程式註冊摘要。如要修改資訊，請按一下「編輯」。如果應用程式 註冊看起來沒有問題，請按一下 [返回資訊主頁]。

建立用戶端 ID

用戶端 ID 在 OAuth 2.0 期間可做為應用程式的憑證 流程由於應用程式在本機執行，因此請建立電腦用戶端 ID。

1. 在 Google Cloud 控制台中，依序點選「選單」圖示 menu > 「API 與」「服務」 >「憑證」。

   前往「憑證」

2. 依序點選「建立憑證」>「OAuth 用戶端 ID」。
3. 依序按一下「應用程式類型」>「電腦版應用程式」。
4. 在「名稱」欄位中輸入憑證的名稱。這個名稱只會顯示在 Google Cloud 控制台中。
5. 按一下「建立」，系統隨即會顯示已建立 OAuth 用戶端的畫面，並顯示您的新用戶端 ID 和用戶端密鑰。
6. 按一下「OK」(確定)。新建立的憑證會顯示在「OAuth 2.0 用戶端 ID」之下。

安裝 Google Auth 程式庫

安裝 Google 驗證程式庫：

pip install google-auth google-auth-oauthlib

執行授權

Meet REST API 需要使用者憑證，格式為 OAuth 2.0 存取權杖在本節中，您將實作 OAuth 2.0 流程以要求 使用者的存取權杖和更新權杖。

1. 在工作目錄中，建立 main.py 檔案並新增下列內容 內容：

   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. 如要執行程式碼，用戶端 ID 和稍早建立的密鑰都在 這通常代表交易 不會十分要求關聯語意將下載的用戶端密鑰檔案複製到正常運作的專案 並重新命名為 client_secret.json。

3. 如果您想要測試授權的運作方式，請執行下列指令。 應用程式會提示授權，並在token.json 專案工作目錄

   python3 main.py
   

新增 Meet REST API

授權碼完成後，即可啟用授權並呼叫 認識 REST API。

啟用 API

雖然本節的重點放在 Meet REST API，但本教學課程也會使用 Google Cloud Pub/Sub 和 Google Workspace Events API。

安裝 Meet REST API 用戶端程式庫

請按照下列步驟安裝 Meet REST API 用戶端程式庫：

1. 執行下列指令：

   pip install google-apps-meet
   

2. 編輯 main.py 檔案以匯入用戶端：

   from google.apps import meet_v2 as meet
   

建立聊天室

現在 Meet REST API 已可供使用，請定義函式以建立 會議空間

編輯 main.py 並新增：

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

訂閱活動

如要接收會議空間的相關活動，請使用 Google Workspace 事件 API。您還必須建立並訂閱 Google Cloud Pub/Sub 主題，會做為通知端點 接收事件。

設定 Google Cloud Pub/Sub

如要建立並訂閱 Pub/Sub 主題，請按照下列步驟操作：

請記下主題名稱，並確認 {project} 的值為 應用程式的 Cloud 專案 ID。您將會使用主題名稱來建立 Google Workspace 日後訂閱。

建立服務帳戶

使用服務帳戶

建立服務帳戶後，請授予自己模擬服務帳戶的權限 新建立的服務帳戶

安裝 Pub/Sub 用戶端程式庫

1. 使用 pip 安裝 Pub/Sub 的用戶端程式庫：

   pip install google-cloud-pubsub
   

2. 然後編輯 main.py 以匯入用戶端：

   from google.cloud import pubsub_v1
   

建立 Google Workspace 訂閱方案

將以下程式碼加入 main.py 以定義訂閱的方法 Meet 活動。這個代碼可訂閱會議的所有活動 空白鍵。訂閱後，事件會發布至 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

接著，新增對應的程式碼來提取及處理事件。

監聽並處理事件

繼續編輯 main.py，並新增下列程式碼範例。這組代碼 實作接收端，並使用 Google Cloud Pub/Sub API 來提取 發布活動消息各種處理常式方法會列印資訊 關於相應的事件

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

完成程式碼

在 main.py 中加入以下程式碼，即可呼叫建立聊天室的方法。 訂閱事件及監聽更新 TOPIC_NAME 和專屬於您主題的 SUBSCRIPTION_NAME 常數 和訂閱項目名稱 已建立。

1. 將程式碼新增至 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)
   

   更改下列內容：

   • PROJECT_ID： 例如 my-sample-project-191923

   • TOPIC_ID：您的 Pub/Sub 主題名稱 建立專案

   • SUBSCRIPTION_ID：訂閱項目的名稱，例如 使用 workspace-events-sub。

2. 執行程式：

   python3 main.py
   

如果您之前未曾執行該程式，則程式會提示您授權 一切都是從 0 開始將存取權授予應用程式，以便呼叫 Meet REST API。 程式成功執行後，您應該會看到類似以下的輸出內容：

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

加入會議

如要產生應用程式活動，請透過網址加入會議 。加入後，您可以嘗試以下動作， 觸發事件：

• 離開會議並重新加入會議。
• 邀請其他人，或使用手機撥入會議。
• 啟用錄音和轉錄稿功能。

這些活動都會產生一個事件，應用程式接收和 將記錄檔寫入 Google Cloud 控制台

完成後，請使用 ctrl-c 中斷程式。

選用：可嘗試的其他步驟

應用程式會記錄事件的基本詳細資料。如要繼續探索 Meet REST API，請嘗試修改應用程式，以執行這些額外的 動作。

• 請使用 People API 擷取其他資訊 已登入的參與者。
• 使用 Google Drive API 下載錄製內容 和轉錄稿
• 請使用以下方式擷取轉錄稿，而非從 Google 雲端硬碟下載： 結構化轉錄稿 方法 呼叫這些 API

選用：清除

避免系統向您的 Google Cloud 控制台帳戶收取資源費用 我們建議您清除所用資源 已建立。

如要刪除訂閱項目：

如要刪除主題：

如要刪除專案，請進行以下操作：

相關主題

• 進一步瞭解 Google Meet REST API 的功能和 請參閱參考說明文件。
• 瞭解如何使用 Google Workspace 活動訂閱活動 API。
• 如要進一步瞭解驗證，請參閱「設定 OAuth 同意畫面」 並選擇範圍