تتبُّع أحداث الاجتماعات باستخدام Python وGoogle Meet REST API

يشرح هذا الدليل التوجيهي كيفية استخدام واجهة برمجة التطبيقات Google Meet REST API إلى جانب Google Workspace Events API وGoogle Cloud Pub/Sub لمراقبة الأحداث والتفاعل معها. في مساحة اجتماعات Meet. يسجِّل نموذج التطبيق وقت بدء المؤتمرات وانتهائها، ووقت انضمام المشاركين أو مغادرتهم، ووقت توفُّر أي مواد عرض تم إنشاؤها للاجتماع.

بدلاً من الاشتراك في مساحة اجتماعات معيّنة، يمكنك الاشتراك في مستخدم Meet لتلقّي أحداث أي مساحة اجتماعات يملكها المستخدم أو ينظّمها. للحصول على التفاصيل، يمكنك مراجعة الاشتراك في أحداث Google Meet في مستندات Google Workspace Events API

المتطلبات الأساسية

في حال الحاجة إلى تفعيل أي من هذه المتطلبات الأساسية لمؤسستك، اطلب لتفعيلها، يمكن لمشرف Google Workspace:

• حساب Google Workspace مع Google Meet
• الإذن بالوصول لإنشاء مشروع على Google Cloud
• تثبيت Python 3.
• تم تثبيت واجهة سطر أوامر gcloud.

إعداد البيئة

يوضح هذا القسم كيفية إنشاء بيئتك المحلية وتهيئتها بالإضافة إلى مشروع 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 الموارد. يجب الحصول على إذن المستخدم لطلب واجهة برمجة تطبيقات Meet REST. يوضّح لك هذا القسم كيفية ضبط بيانات اعتماد المستخدمين وطلب التفويض.

ضبط شاشة موافقة OAuth واختيار النطاقات

تقترح الخطوات التالية معلومات العنصر النائب لإعداده شاشة موافقة OAuth تطبيقك. عليك تعديل هذه المعلومات قبل نشر التطبيق خارجيًا.

1. في وحدة التحكّم في Google Cloud، انتقِل إلى القائمة menu. > واجهات برمجة التطبيقات الخدمات > شاشة موافقة OAuth.

   الانتقال إلى شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth

2. ضمن نوع المستخدم، اختَر داخلي، ثم انقر على إنشاء.
3. في اسم التطبيق، أدخِل Meet REST API Tutorial.
4. أكمِل نموذج تسجيل التطبيق، ثم انقر على حفظ ومتابعة.
5. انقر على إضافة نطاقات أو إزالتها. تظهر لوحة تحتوي على قائمة بالنطاقات لكل واجهة برمجة تطبيقات فعَّلتها في مشروعك على Google Cloud.
6. ضمن إضافة النطاقات يدويًا، الصِق النطاقات التالية:
   • https://www.googleapis.com/auth/meetings.space.created
7. انقر على إضافة إلى الجدول.
8. انقر على تعديل.
9. بعد اختيار النطاقات المطلوبة بجانب تطبيقك، انقر على حفظ ومتابعة.
10. في حال اختيار خارجي لنوع المستخدم، أضِف مستخدمين تجريبيين:
    1. ضمن مستخدمو الاختبار، انقر على إضافة مستخدمين.
    2. أدخِل عنوان بريدك الإلكتروني وأي مستخدمين تجريبيين معتمَدين آخرين، ثم انقر على حفظ ومتابعة.
11. مراجعة ملخّص تسجيل التطبيق لإجراء تغييرات، انقر على تعديل. إذا كان التطبيق التسجيل يبدو على ما يرام، انقر على الرجوع إلى لوحة التحكم.

إنشاء معرِّف عميل

يعمل معرِّف العميل كبيانات اعتماد لتطبيقك أثناء OAuth 2.0. التدفقات. بما أنّ التطبيق يعمل محليًا، عليك إنشاء معرِّف عميل على الكمبيوتر المكتبي.

1. في وحدة تحكُّم Google Cloud، انتقِل إلى القائمة menu > واجهات برمجة التطبيقات الخدمات > بيانات الاعتماد.

   الانتقال إلى بيانات الاعتماد

2. انقر على إنشاء بيانات اعتماد > معرِّف عميل OAuth.
3. انقر على نوع التطبيق > تطبيق الكمبيوتر المكتبي.
4. في حقل الاسم، اكتب اسمًا لبيانات الاعتماد. ولا يظهر هذا الاسم إلا في وحدة تحكُّم Google Cloud.
5. انقر على إنشاء. تظهر شاشة "تم إنشاء عميل OAuth"، والتي تعرض معرّف العميل الجديد وسرّه.
6. انقر على موافق. تظهر بيانات الاعتماد التي تم إنشاؤها حديثًا ضمن معرِّفات عملاء OAuth 2.0.

تثبيت مكتبات المصادقة من Google

ثبِّت مكتبات المصادقة من Google:

pip install google-auth google-auth-oauthlib

تنفيذ التفويض

تتطلب واجهة برمجة تطبيقات Meet REST بيانات اعتماد المستخدم في شكل 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. لتشغيل الرمز، يجب استخدام كلّ من معرّف العميل والسرية اللذَين تم إنشاؤهما في وقت سابق. نسخ ملف سر العميل الذي تم تنزيله إلى المشروع الذي يعمل الدليل وإعادة تسميته باسم client_secret.json.

3. إذا أردت اختبار طريقة عمل التفويض، شغِّل الأمر التالي. يطلب التطبيق تفويضًا وينشئ ملف token.json في directory directory project بعد الموافقة على الطلب.

   python3 main.py

إضافة Meet REST API

بعد اكتمال رمز التفويض، حان وقت تفعيل واجهة برمجة التطبيقات Meet REST 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 Events API. يجب أيضًا إنشاء Google Cloud Pub/Sub والذي يُعد نقطة نهاية الإشعارات حيث الأحداث.

ضبط إعدادات Google Cloud Pub/Sub

لإنشاء موضوع نشر/اشتراك أو الاشتراك فيه:

دوِّن اسم الموضوع وتأكَّد من أن قيمة {project} هي رقم تعريف مشروع تطبيقك على Google Cloud ستستخدم اسم الموضوع لإنشاء في Google Workspace لاحقًا.

إنشاء حساب خدمة

استخدام حساب الخدمة

بعد إنشاء حساب الخدمة، امنح نفسك حق الوصول لانتحال هوية حساب حساب الخدمة الخاص بك.

تثبيت مكتبة برامج النشر/الاشتراك

1. استخدِم pip لتثبيت مكتبة البرامج للنشر/الاشتراك:

   pip install google-cloud-pubsub

2. بعد ذلك، عدِّل main.py لاستيراد البرنامج:

   from google.cloud import pubsub_v1
   

إنشاء اشتراك Google Workspace

أضِف الرمز التالي إلى main.py لتحديد طريقة للاشتراك في أحداثmeet. يؤدي هذا الرمز إلى الاشتراك في جميع أحداث الاجتماع. مساحة. عند الاشتراك، يتم نشر الأحداث في موضوع النشر/الاشتراك.

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: رقم التعريف الفريد للمشروع على Cloud في النطاق تطبيقك، مثل my-sample-project-191923.

   • TOPIC_ID: اسم موضوع النشر/الاشتراك الذي أجريته التي تم إنشاؤها في مشروعك على Google Cloud.

   • SUBSCRIPTION_ID: اسم اشتراكك، مثل workspace-events-sub

2. شغِّل البرنامج:

   python3 main.py

إذا لم تكن قد قمت بتشغيل البرنامج من قبل، فسوف يطلب منك ترخيص لأول مرة. امنح التطبيق الإذن بالوصول إلى واجهة برمجة تطبيقات Meet REST. بعد تشغيل البرنامج بنجاح، من المفترض أن يظهر لك ناتج مشابه لما يلي:

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

الانضمام إلى المؤتمر

لإنشاء أحداث للتطبيق، انضم إلى المؤتمر باستخدام عنوان URL. التي يعرضها التطبيق. بعد الانضمام، يمكنك تجربة هذه الإجراءات تشغيل الأحداث:

• يُرجى مغادرة الاجتماع والانضمام إليه مجددًا.
• يمكنك دعوة مستخدمين آخرين أو الاتصال باستخدام هاتفك.
• تفعيل التسجيلات وتحويل الصوت إلى نص

ينشئ كل نشاط من هذه الأنشطة حدثًا يتلقاه التطبيق إلى وحدة تحكّم Google Cloud

استخدِم ctrl-c لإيقاف البرنامج عند الانتهاء.

اختياري: خطوات إضافية يمكن تجربتها

يسجِّل التطبيق تفاصيل أساسية عن الأحداث. لمواصلة استكشاف Meet REST API، جرِّب تعديل التطبيق لتنفيذ هذه الإجراءات الإضافية مناسبة.

• استخدام People API لاسترداد معلومات إضافية عن المشاركين الذين سجّلوا دخولهم.
• استخدام Google Drive API لتنزيل التسجيلات والنصوص.
• بدلاً من تنزيل النصوص من Google Drive، يمكنك استردادها باستخدام النص المنظم الطرق في Meet REST API.

اختياري: تنظيف

لتجنُّب تحمُّل أي رسوم من حسابك على Google Cloud Console مقابل الموارد المستخدم في هذا البرنامج التعليمي، فننصحك بتنظيف أي موارد ومشاريع إنشاء.

لحذف الاشتراك:

لحذف الموضوع:

لحذف المشروع:

مواضيع ذات صلة

• يمكنك معرفة المزيد عن أنواع أحداث Meet التي يمكنك الاشتراك فيها.
• يمكنك الاطّلاع على مزيد من المعلومات حول الإجراءات التي يمكن لواجهة برمجة تطبيقات Google Meet REST تنفيذها. يُرجى مراجعة المستندات المرجعية.
• إنشاء اشتراك Google Workspace إلى مساحات اجتماعات Meet أو المستخدمين الذين يستخدمون واجهة برمجة التطبيقات لفعاليات Google Workspace
• لمزيد من المعلومات حول المصادقة، يمكنك الاطّلاع على ضبط شاشة موافقة OAuth. واختيار النطاقات