Quan sát các sự kiện họp bằng Python và API REST của Google Meet

Hướng dẫn này trình bày cách sử dụng API REST của Google Meet cùng với API Sự kiện của Google Workspace và Google Cloud Pub/Sub để quan sát và phản ứng với các sự kiện trong không gian họp trên Meet. Ứng dụng mẫu ghi lại thời điểm bắt đầu và kết thúc hội nghị, thời điểm người tham gia tham gia hoặc rời khỏi cuộc họp và thời điểm có bất kỳ cấu phần phần mềm cuộc họp nào được tạo.

Thay vì đăng ký một không gian họp cụ thể, bạn có thể đăng ký một người dùng Meet để nhận sự kiện cho mọi không gian họp mà người dùng đó sở hữu hoặc tổ chức. Để biết thông tin chi tiết, hãy xem phần Đăng ký sự kiện trên Google Meet trong tài liệu về API Sự kiện của Google Workspace.

Điều kiện tiên quyết

Nếu bạn cần bật bất kỳ điều kiện tiên quyết nào sau đây cho tổ chức của mình, hãy yêu cầu quản trị viên Google Workspace bật các điều kiện đó:

• Tài khoản Google Workspace có quyền truy cập vào Google Meet.
• Quyền tạo dự án trên Google Cloud.
• Đã cài đặt Python 3.
• Đã cài đặt gcloud CLI.

Chuẩn bị môi trường

Phần này hướng dẫn cách tạo và định cấu hình môi trường cục bộ cũng như dự án Google Cloud cho hướng dẫn này.

Tạo thư mục làm việc và môi trường ảo Python

Để tạo và kích hoạt một môi trường ảo mới, hãy chạy các lệnh sau trong dòng lệnh.

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

Tạo dự án trên Google Cloud

Bật tính năng thanh toán cho dự án trên Google Cloud

Thiết lập tính năng xác thực và uỷ quyền

Tính năng xác thực và uỷ quyền cho phép ứng dụng truy cập vào các tài nguyên API Meet REST. Bạn phải được người dùng uỷ quyền thì mới có thể gọi API Meet REST. Phần này hướng dẫn bạn cách định cấu hình thông tin xác thực người dùng và yêu cầu uỷ quyền.

Định cấu hình màn hình xin phép bằng OAuth và chọn phạm vi

Các bước sau đây đề xuất thông tin phần giữ chỗ để định cấu hình màn hình đồng ý OAuth cho ứng dụng. Trước khi phát hành ứng dụng ra bên ngoài, hãy cập nhật thông tin này.

1. Trong Google Cloud Console, hãy chuyển đến Trình đơn menu > API và dịch vụ > Màn hình đồng ý OAuth.

   Chuyển đến màn hình xin phép bằng OAuth

2. Trong mục Loại người dùng, hãy chọn Nội bộ, rồi nhấp vào Tạo.
3. Trong App name (Tên ứng dụng), hãy nhập Meet REST API Tutorial.
4. Hoàn tất biểu mẫu đăng ký ứng dụng, sau đó nhấp vào Lưu và tiếp tục.
5. Nhấp vào Thêm hoặc xoá phạm vi. Một bảng điều khiển sẽ xuất hiện với danh sách các phạm vi cho từng API mà bạn đã bật trong dự án Google Cloud.
6. Trong mục Thêm phạm vi theo cách thủ công, hãy dán các phạm vi sau:
   • https://www.googleapis.com/auth/meetings.space.created
7. Nhấp vào Thêm vào bảng.
8. Nhấp vào Cập nhật.
9. Sau khi chọn các phạm vi mà ứng dụng của bạn yêu cầu, hãy nhấp vào Lưu và tiếp tục.
10. Nếu bạn đã chọn Bên ngoài cho loại người dùng, hãy thêm người dùng thử nghiệm:
    1. Trong phần Người dùng thử nghiệm, hãy nhấp vào Thêm người dùng.
    2. Nhập địa chỉ email của bạn và mọi người dùng thử nghiệm được uỷ quyền khác, sau đó nhấp vào Lưu và tiếp tục.
11. Xem lại thông tin tóm tắt về việc đăng ký ứng dụng. Để chỉnh sửa, hãy nhấp vào Chỉnh sửa. Nếu quá trình đăng ký ứng dụng có vẻ ổn, hãy nhấp vào Quay lại trang tổng quan.

Tạo mã ứng dụng khách

Mã ứng dụng khách đóng vai trò là thông tin xác thực cho ứng dụng của bạn trong các luồng OAuth 2.0. Vì ứng dụng chạy cục bộ, hãy tạo mã ứng dụng dành cho máy tính.

1. Trong Google Cloud Console, hãy chuyển đến Trình đơn menu > API và dịch vụ > Thông tin xác thực.

   Chuyển đến phần Thông tin xác thực

2. Nhấp vào Tạo thông tin xác thực > Mã ứng dụng OAuth.
3. Nhấp vào Loại ứng dụng > Ứng dụng dành cho máy tính.
4. Trong trường Name (Tên), hãy nhập tên cho thông tin xác thực. Tên này chỉ xuất hiện trong Google Cloud Console.
5. Nhấp vào Tạo. Màn hình ứng dụng khách OAuth đã tạo sẽ xuất hiện, hiển thị Mã ứng dụng khách và Mã xác thực ứng dụng khách mới.
6. Nhấp vào OK. Thông tin xác thực mới tạo sẽ xuất hiện trong phần Mã ứng dụng khách OAuth 2.0.

Cài đặt thư viện xác thực của Google

Cài đặt thư viện xác thực của Google:

pip install google-auth google-auth-oauthlib

Thực thi uỷ quyền

API Meet REST yêu cầu thông tin xác thực người dùng ở dạng mã truy cập OAuth 2.0. Trong phần này, bạn triển khai luồng OAuth 2.0 để yêu cầu mã truy cập và mã làm mới cho người dùng.

1. Trong thư mục đang hoạt động, hãy tạo tệp main.py và thêm nội dung sau:

   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. Để chạy mã, bạn cần có cả mã ứng dụng và mật khẩu đã tạo trước đó. Sao chép tệp bí mật ứng dụng đã tải xuống vào thư mục đang hoạt động của dự án rồi đổi tên tệp đó thành client_secret.json.

3. Nếu bạn muốn kiểm thử cách hoạt động của tính năng uỷ quyền, hãy chạy lệnh sau. Ứng dụng sẽ nhắc bạn uỷ quyền và tạo tệp token.json trong thư mục hoạt động của dự án sau khi yêu cầu được phê duyệt.

   python3 main.py
   

Thêm API Meet REST

Giờ đây, khi mã uỷ quyền đã hoàn tất, đã đến lúc bật và gọi API Meet REST.

Bật API

Mặc dù phần này tập trung vào API Meet REST, nhưng hướng dẫn này cũng sử dụng Google Cloud Pub/Sub và API Sự kiện của Google Workspace.

Cài đặt thư viện ứng dụng Meet REST API

Hãy làm theo các bước sau để cài đặt thư viện ứng dụng Meet REST API:

1. Chạy lệnh:

   pip install google-apps-meet
   

2. Chỉnh sửa tệp main.py để nhập ứng dụng:

   from google.apps import meet_v2 as meet
   

Tạo không gian

Giờ đây, khi API Meet REST đã có sẵn, hãy xác định một hàm để tạo không gian họp mà người dùng có thể đăng ký.

Chỉnh sửa main.py và thêm:

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

Đăng ký sự kiện

Để nhận các sự kiện về không gian họp, bạn tạo một gói thuê bao bằng API Sự kiện của Google Workspace. Bạn cũng phải tạo và đăng ký một chủ đề Google Cloud Pub/Sub đóng vai trò là điểm cuối thông báo nơi ứng dụng của bạn nhận được các sự kiện.

Định cấu hình Google Cloud Pub/Sub

Cách tạo và đăng ký chủ đề Pub/Sub:

Ghi lại tên chủ đề và đảm bảo giá trị của {project} là mã dự án trên Google Cloud cho ứng dụng của bạn. Bạn sẽ sử dụng tên chủ đề này để tạo gói thuê bao Google Workspace sau.

Tạo một tài khoản dịch vụ

Sử dụng tài khoản dịch vụ

Sau khi tạo tài khoản dịch vụ, hãy cấp cho chính bạn quyền mạo danh tài khoản dịch vụ.

Cài đặt thư viện ứng dụng Pub/Sub

1. Sử dụng pip để cài đặt thư viện ứng dụng cho Pub/Sub:

   pip install google-cloud-pubsub
   

2. Sau đó, hãy chỉnh sửa main.py để nhập ứng dụng khách:

   from google.cloud import pubsub_v1
   

Tạo gói thuê bao Google Workspace

Thêm mã sau vào main.py để xác định phương thức đăng ký các sự kiện Meet. Mã này đăng ký tất cả sự kiện cho một không gian họp. Khi bạn đăng ký, các sự kiện sẽ được đăng lên chủ đề 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

Tiếp theo, hãy thêm mã tương ứng để lấy và xử lý các sự kiện.

Theo dõi và xử lý sự kiện

Tiếp tục chỉnh sửa main.py và thêm mã mẫu sau. Mã này triển khai bên nhận và sử dụng API Google Cloud Pub/Sub để lấy các sự kiện khi chúng được cung cấp. Các phương thức trình xử lý khác nhau sẽ in thông tin về các sự kiện tương ứng.

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

Hoàn tất mã

Thêm mã sau vào main.py để gọi các phương thức tạo không gian, đăng ký sự kiện và nghe. Cập nhật hằng số TOPIC_NAME và SUBSCRIPTION_NAME bằng tên chủ đề và tên gói thuê bao mà bạn đã tạo trước đó.

1. Thêm mã vào 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)
   

   Thay thế nội dung sau:

   • PROJECT_ID: Mã dự án trên Google Cloud duy nhất cho ứng dụng của bạn, chẳng hạn như my-sample-project-191923.

   • TOPIC_ID: Tên của chủ đề Pub/Sub mà bạn đã tạo trong dự án trên Cloud.

   • SUBSCRIPTION_ID: Tên gói thuê bao, chẳng hạn như workspace-events-sub.

2. Chạy chương trình:

   python3 main.py
   

Nếu bạn chưa chạy chương trình trước đây, thì chương trình sẽ nhắc bạn cấp quyền lần đầu tiên. Cấp quyền truy cập vào ứng dụng để gọi API Meet REST. Sau khi chương trình chạy thành công, bạn sẽ thấy kết quả tương tự như sau:

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

Tham gia hội nghị

Để tạo sự kiện cho ứng dụng, hãy tham gia hội nghị bằng URL mà ứng dụng hiển thị. Sau khi tham gia, bạn có thể thử các thao tác sau để kích hoạt sự kiện:

• Rời khỏi rồi tham gia lại cuộc họp.
• Mời người khác hoặc gọi điện bằng điện thoại.
• Bật bản ghi âm và bản chép lời.

Mỗi hoạt động trong số này sẽ tạo một sự kiện mà ứng dụng sẽ nhận được và ghi lại vào Google Cloud Console.

Sử dụng ctrl-c để làm gián đoạn chương trình khi bạn hoàn tất.

Không bắt buộc: Các bước khác mà bạn có thể thử

Ứng dụng ghi lại thông tin cơ bản về các sự kiện. Để tiếp tục khám phá API Meet REST, hãy thử sửa đổi ứng dụng để thực hiện các thao tác bổ sung này.

• Sử dụng People API để truy xuất thêm thông tin về những người tham gia đã đăng nhập.
• Sử dụng API Google Drive để tải bản ghi âm và bản chép lời xuống.
• Thay vì tải bản chép lời xuống từ Google Drive, hãy truy xuất bản chép lời bằng các phương thức bản chép lời có cấu trúc trong API Meet REST.

Không bắt buộc: Dọn dẹp

Để tránh bị tính phí cho tài khoản Google Cloud Console của bạn đối với các tài nguyên được sử dụng trong hướng dẫn này, bạn nên dọn dẹp mọi tài nguyên và dự án đã tạo.

Cách xoá gói thuê bao:

Cách xoá chủ đề:

Cách xoá dự án:

Chủ đề có liên quan

• Tìm hiểu về các loại sự kiện trên Meet mà bạn có thể đăng ký.
• Tìm hiểu thêm về những việc API REST của Google Meet có thể làm và xem tài liệu tham khảo.
• Tạo gói thuê bao Google Workspace cho các không gian họp hoặc người dùng Meet bằng API sự kiện của Google Workspace.
• Để tìm hiểu thêm về việc xác thực, hãy xem bài viết Định cấu hình màn hình xin phép bằng OAuth và chọn phạm vi.