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

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

تتضمن هذه الصفحة الخطوات التالية لإنشاء اشتراك في Google Workspace:

  1. إعداد البيئة
  2. إنشاء موضوع Google Cloud Pub/Sub والاشتراك فيه يمكنك استخدام هذا الموضوع كنقطة نهاية لتلقّي أحداث Google Workspace.
  3. عليك استدعاء طريقة create() في Google Workspace Events API في المرجع Subscription.
  4. اختبِر اشتراكك في Google Workspace للتأكّد من أنّ موضوع النشر/الاشتراك يتلقّى الأحداث التي اشتركت فيها.
  5. يمكنك اختياريًا ضبط كيفية إرسال الأحداث إلى نقطة نهاية في تطبيقك، حتى يتمكّن تطبيقك من معالجة الحدث واتّخاذ إجراء إذا لزم الأمر.

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

برمجة تطبيقات

  • لاستخدام أوامر Google Cloud CLI في هذا الدليل:
    1. ثبِّت Google Cloud CLI.
    2. لتهيئة واجهة سطر الأوامر gcloud، شغِّل الرمز التالي:
      3.   gcloud init
  • مورد مستهدف للاشتراك:
    • للاشتراك في مساحة Google Chat، تكون مساحة Chat عضوًا فيها يكون المستخدم الذي تمت المصادقة عليه عضوًا. يجب أن يكون المستخدم عضوًا في المساحة من خلال حسابه على Google Workspace أو حسابه على Google (لا يمكن استخدام حساب المستخدمين الأعضاء في مساحة من خلال "مجموعة Google").
    • للاشتراك في مساحة اجتماع على Google Meet، مساحة اجتماع يكون فيها المستخدم الذي تمت المصادقة عليه هو المالك. لإنشاء مساحة، يُرجى الاطّلاع على مقالة العمل باستخدام مساحات الاجتماعات في مستندات Google Meet.
    • للاشتراك في حساب مستخدم Google Meet، يجب أن يتوفّر معرّف user الخاص بواجهة Cloud Identity API.
  • مشروع على Google Cloud مع تفعيل الفوترة فيه. بالنسبة إلى الاشتراكات في Chat، عليك أيضًا تفعيل Chat API في مشروعك على السحابة الإلكترونية وإعداد الحقول اسم التطبيق وعنوان URL للصورة الرمزية والوصف. لمعرفة التفاصيل، يُرجى الاطّلاع على مقالة إنشاء تطبيق Google Chat.
  • يتطلب هذا الخيار مصادقة المستخدم مع إعداد شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth للتطبيق. وعند ضبط شاشة الموافقة، عليك تحديد نطاق لإتاحة كل نوع من أنواع الأحداث الخاصة بالاشتراك. لضبط شاشة الموافقة وتحديد النطاقات المطلوبة، يمكنك الاطّلاع على اختيار النطاقات.
  • مشروع "برمجة تطبيقات Google":
    • يمكنك استخدام مشروعك على Google Cloud بدلاً من المشروع التلقائي الذي يتم إنشاؤه تلقائيًا من خلال "برمجة التطبيقات".
    • بالنسبة إلى أي نطاقات أضفتها لإعداد شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth، عليك أيضًا إضافة النطاقات إلى ملف appsscript.json في مشروع "برمجة تطبيقات Google". مثال: 
      • "oauthScopes": [
  "https://www.googleapis.com/auth/chat.messages.readonly"
]
    • تفعيل خدمة Google Workspace Events المتقدّمة

Python

  • Python 3.6 أو أحدث
  • أداة إدارة الحزمة pip
  • أحدث مكتبات عملاء Google للغة Python. لتثبيتها أو تحديثها، شغِّل الأمر التالي في واجهة سطر الأوامر: 
      pip3 install --upgrade google-api-python-client google-auth-oauthlib
  • لاستخدام أوامر Google Cloud CLI في هذا الدليل:
    1. ثبِّت Google Cloud CLI.
    2. لتهيئة واجهة سطر الأوامر gcloud، شغِّل الرمز التالي:
      3.   gcloud init
  • مورد مستهدف للاشتراك:
    • للاشتراك في مساحة Google Chat، تكون مساحة Chat عضوًا فيها يكون المستخدم الذي تمت المصادقة عليه عضوًا. يجب أن يكون المستخدم عضوًا في المساحة من خلال حسابه على Google Workspace أو حسابه على Google (لا يمكن استخدام حساب المستخدمين الأعضاء في مساحة من خلال "مجموعة Google").
    • للاشتراك في مساحة اجتماع على Google Meet، مساحة اجتماع يكون فيها المستخدم الذي تمت المصادقة عليه هو المالك. لإنشاء مساحة، يُرجى الاطّلاع على مقالة العمل باستخدام مساحات الاجتماعات في مستندات Google Meet.
    • للاشتراك في حساب مستخدم Google Meet، يجب أن يتوفّر معرّف user الخاص بواجهة Cloud Identity API.
  • مشروع على Google Cloud مع تفعيل الفوترة فيه. بالنسبة إلى الاشتراكات في Chat، عليك أيضًا تفعيل Chat API في مشروعك على السحابة الإلكترونية وإعداد الحقول اسم التطبيق وعنوان URL للصورة الرمزية والوصف. لمعرفة التفاصيل، يُرجى الاطّلاع على مقالة إنشاء تطبيق Google Chat.
  • يتطلب هذا الخيار مصادقة المستخدم مع إعداد شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth للتطبيق. وعند ضبط شاشة الموافقة، عليك تحديد نطاق لإتاحة كل نوع من أنواع الأحداث الخاصة بالاشتراك. لضبط شاشة الموافقة وتحديد النطاقات المطلوبة، يمكنك الاطّلاع على اختيار النطاقات.

إعداد البيئة

يوضّح القسم التالي كيفية إعداد بيئتك قبل إنشاء اشتراك Google Workspace.

تفعيل Google Workspace Events API وGoogle Cloud Pub/Sub API

قبل استخدام Google APIs، عليك تفعيلها في مشروع على Google Cloud. يمكنك تفعيل واجهة برمجة تطبيقات واحدة أو أكثر في مشروع واحد على Google Cloud.

وحدة تحكُّم Google Cloud

في Google Cloud Console، افتح مشروع Google Cloud لتطبيقك وفعِّل Google Workspace Events API وPub/Sub API:

تفعيل واجهات برمجة التطبيقات

gcloud

  1. في دليل العمل، سجِّل الدخول إلى حسابك على Google:

    gcloud auth login

  2. اضبط مشروعك على المشروع على السحابة الإلكترونية لتطبيقك:

    gcloud config set project PROJECT_ID

    استبدِل PROJECT_ID برقم تعريف مشروع المشروع على السحابة الإلكترونية لتطبيقك.

  3. فعِّل Google Workspace Events API وGoogle Cloud Pub/Sub واجهة برمجة التطبيقات:

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

إنشاء بيانات اعتماد معرِّف عميل OAuth

اختَر نوع التطبيق للحصول على تعليمات محدَّدة حول كيفية إنشاء معرِّف عميل OAuth:

تطبيق ويب

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

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

  2. انقر على إنشاء بيانات اعتماد > معرِّف عميل OAuth.
  3. انقر على نوع التطبيق > تطبيق الويب.
  4. في حقل الاسم، اكتب اسمًا لبيانات الاعتماد. لا يظهر هذا الاسم إلا في Google Cloud Console.
  5. أضِف معرّفات الموارد المنتظمة (URI) المعتمَدة والمرتبطة بتطبيقك:
    • التطبيقات من جهة العميل (JavaScript): ضمن مصادر JavaScript المسموح بها، انقر على إضافة معرّف الموارد المنتظم (URI). بعد ذلك، أدخِل معرّف الموارد المنتظم (URI) لاستخدامه مع طلبات المتصفّح. يحدد هذا النطاق النطاقات التي يمكن لتطبيقك من خلالها إرسال طلبات واجهة برمجة التطبيقات إلى خادم OAuth 2.0.
    • التطبيقات من جهة الخادم (Java وPython وغيرهما): ضمن معرِّفات الموارد المنتظمة (URI) المعتمَدة لإعادة التوجيه، انقر على إضافة معرِّف الموارد المنتظم (URI). بعد ذلك، أدخِل معرّف الموارد المنتظم (URI) لنقطة النهاية الذي يمكن لخادم OAuth 2.0 إرسال ردود إليه.
  6. انقر على إنشاء. تظهر الشاشة التي تم إنشاؤها من خلال عميل OAuth، وتعرض معرِّف العميل وسر العميل الجديد.

    سجِّل معرِّف العميل. لا يتم استخدام أسرار العملاء لتطبيقات الويب.

  7. انقر على موافق. تظهر بيانات الاعتماد التي تم إنشاؤها حديثًا ضمن معرِّفات عملاء OAuth 2.0.

Android

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

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

  2. انقر على إنشاء بيانات اعتماد > معرِّف عميل OAuth.
  3. انقر على نوع التطبيق > Android.
  4. في حقل "الاسم"، اكتب اسمًا لبيانات الاعتماد. لا يظهر هذا الاسم إلا في Google Cloud Console.
  5. في حقل "اسم الحزمة"، أدخِل اسم الحزمة من ملف AndroidManifest.xml.
  6. في حقل "الملف المرجعي لشهادة SHA-1"، أدخِل الملف المرجعي لشهادة SHA-1 الذي تم إنشاؤه.
  7. انقر على إنشاء. ستظهر شاشة إنشاء عميل OAuth، وتعرض معرّف العميل الجديد.
  8. انقر على موافق. تظهر بيانات الاعتماد التي تم إنشاؤها حديثًا ضمن "معرّفات عملاء OAuth 2.0".

iOS

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

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

  2. انقر على إنشاء بيانات اعتماد > معرِّف عميل OAuth.
  3. انقر على نوع التطبيق > iOS.
  4. في حقل "الاسم"، اكتب اسمًا لبيانات الاعتماد. لا يظهر هذا الاسم إلا في Google Cloud Console.
  5. في حقل "معرّف الحزمة"، أدخِل معرّف الحزمة كما هو وارد في ملف Info.plist الخاص بالتطبيق.
  6. اختياري: إذا ظهر تطبيقك في متجر Apple App Store، أدخِل رقم تعريف App Store.
  7. اختياري: في حقل "رقم تعريف الفريق"، أدخِل السلسلة الفريدة المكونة من 10 أحرف والتي أنشأتها Apple وتم تخصيصها لفريقك.
  8. انقر على إنشاء. تظهر الشاشة التي تم إنشاؤها من خلال عميل OAuth، وتعرض معرِّف العميل وسر العميل الجديد.
  9. انقر على موافق. تظهر بيانات الاعتماد التي تم إنشاؤها حديثًا ضمن "معرّفات عملاء OAuth 2.0".

تطبيق Chrome

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

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

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

تطبيق لأجهزة الكمبيوتر المكتبي

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

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

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

أجهزة التلفزيون وأجهزة الإدخال المحدود

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

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

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

Universal Windows Platform (منصة Windows العالمية)

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

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

  2. انقر على إنشاء بيانات اعتماد > معرِّف عميل OAuth.
  3. انقر على نوع التطبيق > Universal Windows Platform (UWP).
  4. في حقل "الاسم"، اكتب اسمًا لبيانات الاعتماد. لا يظهر هذا الاسم إلا في Google Cloud Console.
  5. في حقل "رقم تعريف المتجر"، أدخِل قيمة رقم تعريف المتجر الفريدة لتطبيقك والمؤلّفة من 12 حرفًا. يمكنك العثور على هذا المعرّف في عنوان URL لتطبيقك على Microsoft Store وفي مركز الشركاء.
  6. انقر على إنشاء. تظهر الشاشة التي تم إنشاؤها من خلال عميل OAuth، وتعرض معرِّف العميل وسر العميل الجديد.
  7. انقر على موافق. تظهر بيانات الاعتماد التي تم إنشاؤها حديثًا ضمن "معرّفات عملاء OAuth 2.0".

تنزيل ملف JSON لسر العميل

ملف سر العميل هو تمثيل JSON لبيانات اعتماد معرِّف عميل OAuth التي يمكن لتطبيقك الرجوع إليها عند تقديم بيانات الاعتماد.

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

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

  2. ضمن معرِّفات عملاء OAuth 2.0، انقر على معرِّف العميل الذي أنشأته.

  3. انقر على Download JSON (تنزيل JSON).

  4. احفظ الملف باسم "client_secrets.json".

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

في هذا القسم، يمكنك إنشاء موضوع نشر/اشتراك في الموضوع. يعمل موضوع النشر/الاشتراك كنقطة نهاية للإشعار حيث يتلقّى اشتراكك في Google Workspace الأحداث.

لمزيد من المعلومات حول إنشاء مواضيع النشر/الاشتراك وإدارتها، يُرجى الاطّلاع على وثائق النشر/الاشتراك .

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

وحدة تحكُّم Google Cloud

  1. في وحدة التحكّم في Google Cloud، انتقِل إلى صفحة النشر/الاشتراك:

    الانتقال إلى Google Cloud Pub/Sub

    تأكَّد من اختيار المشروع على السحابة الإلكترونية لتطبيقك.

  2. انقر على إنشاء موضوع ونفِّذ ما يلي:

    1. أدخِل اسمًا لموضوعك، مثل workspace-events-topic.
    2. اترك الخيار إضافة اشتراك تلقائي محدّدًا. تسمي ميزة النشر/الاشتراك هذا الاشتراك التلقائي على غرار اسم الموضوع، مثل workspace-events-topic-sub.
    3. اختياري: يمكنك تعديل خصائص إضافية أو ضبطها لموضوعك.

  3. انقر على إنشاء. تنسيق اسم الموضوع بالكامل على النحو التالي projects/PROJECT_ID/topics/TOPIC_ID. وستستخدم هذا الاسم الكامل في خطوة لاحقة.

  4. منح الإذن بالوصول لنشر رسائل النشر/الاشتراك في موضوعك:

    1. في صفحة موضوعك، انتقِل إلى اللوحة الجانبية وافتح علامة التبويب الأذونات.
    2. انقر على إضافة عنوان رئيسي.
    3. في حقل إضافة العناصر الرئيسية، أضِف حساب الخدمة لتطبيق Google Workspace الذي يسلم الأحداث إلى اشتراكك:
      1. بالنسبة إلى أحداث Chat، chat-api-push@system.gserviceaccount.com.
      2. بالنسبة إلى أحداث Meet، meet-api-event-push@system.gserviceaccount.com.
    4. في قائمة إسناد الأدوار، اختَر Pub/Sub Publisher.
    5. انقر على حفظ. يمكن أن يستغرق تعديل الأذونات لموضوعك بضع دقائق.

gcloud

  1. في مشروعك على Google Cloud، أنشئ موضوعًا من خلال تنفيذ الأمر التالي:

    gcloud pubsub topics create TOPIC_ID

    استبدل TOPIC_ID بمعرّف فريد لموضوعك، مثل workspace-events-topic.

    تعرض النتيجة اسم الموضوع الكامل بالتنسيق projects/PROJECT_ID/topics/TOPIC_ID. دوِّن الاسم وتأكَّد من أنّ قيمة PROJECT_ID هي رقم تعريف مشروع Google Cloud لتطبيقك. عليك استخدام اسم الموضوع في الخطوة التالية وإنشاء اشتراك Google Workspace لاحقًا.

  2. منح الإذن بالوصول لنشر الرسائل المتعلقة بموضوعك:

    gcloud pubsub topics add-iam-policy-binding TOPIC_NAME --member='serviceAccount:GOOGLE_WORKSPACE_APPLICATION' --role='roles/pubsub.publisher'

    استبدل ما يلي:

    • TOPIC_NAME: اسم الموضوع الكامل، وهو نتيجة الخطوة السابقة تم تنسيقها كـ projects/PROJECT_ID/topics/TOPIC_ID.

    • GOOGLE_WORKSPACE_APPLICATION: تطبيق Google Workspace الذي يجب أن يوفّر الأحداث إلى اشتراكك:

      • لتلقّي الأحداث من Chat، استخدِم chat-api-push@system.gserviceaccount.com.
      • لتلقّي الأحداث من Meet، استخدِم meet-api-event-push@system.gserviceaccount.com.

    يمكن أن يستغرق تعديل الأذونات لموضوعك بضع دقائق.

  3. إنشاء اشتراك في نشرة/اشتراك للموضوع:

     gcloud pubsub subscriptions create SUBSCRIPTION_NAME --topic=TOPIC_NAME

    استبدل ما يلي:

    • SUBSCRIPTION_NAME: اسم الاشتراك، مثل workspace-events-subscription
    • TOPIC_NAME: اسم الموضوع الذي أنشأته في الخطوة السابقة

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

في هذا القسم، ستستخدم طريقة subscriptions.create() على Google Workspace Events API لإنشاء مرجع Subscription. عليك تحديد الحقول التالية:

  • targetResource: مورد Google Workspace لمراقبة الأحداث، مثل مساحة Chat.
  • eventTypes: مصفوفة من نوع واحد أو أكثر من الأحداث التي تريد تلقّيها حول المورد. على سبيل المثال، إذا كان تطبيقك يحتاج فقط إلى معرفة الرسائل الجديدة التي تم نشرها في "مساحة Chat"، يمكن لتطبيقك الاشتراك فقط في الأحداث الخاصة بالرسائل التي تم إنشاؤها.
  • notificationEndpoint: نقطة نهاية للإشعار، حيث يعرض اشتراكك في Google Workspace الأحداث يمكنك استخدام موضوع النشر/الاشتراك الذي أنشأته في القسم السابق.
  • payloadOptions: خيارات لتحديد مقدار بيانات الموارد التي سيتم تضمينها في حمولة الحدث. تؤثّر هذه الإعدادات في وقت انتهاء صلاحية اشتراكك. للمزيد من المعلومات، اطّلِع على بيانات الأحداث.

لإنشاء اشتراك في Google Workspace، يُرجى اتّباع الخطوات التالية:

برمجة تطبيقات

  1. في مشروع برمجة التطبيقات، أنشئ ملف نص برمجي جديدًا باسم createSubscription وأضف الرمز التالي:

    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);
}

    استبدل ما يلي:

    • TARGET_RESOURCE: مورد Google Workspace الذي تشترك فيه، ويكون منسَّقًا كاسم مورده الكامل. على سبيل المثال، للاشتراك في مساحة Google Chat برقم تعريف المساحة AAAABBBB، استخدِم //chat.googleapis.com/spaces/AAAABBBB.
    • EVENT_TYPES: نوع واحد أو أكثر من أنواع الأحداث التي تريد الاشتراك فيها في المورد المستهدف. عليك التنسيق كمصفوفة من السلاسل مثل 'google.workspace.chat.message.v1.created'.
    • TOPIC_NAME: الاسم الكامل لموضوع النشر/الاشتراك الذي أنشأته في مشروعك على السحابة الإلكترونية. تم تنسيقها كـ projects/PROJECT_ID/topics/TOPIC_ID.

    • RESOURCE_DATA: قيمة منطقية تحدّد ما إذا كان الاشتراك يتضمّن بيانات موارد في الحمولة:

      • True: يتضمّن جميع بيانات الموارد. لتحديد الحقول التي يتم تضمينها، أضِف الحقل fieldMask وحدِّد حقلاً واحدًا على الأقل للمورد الذي تم تغييره. ولا يشمل ذلك سوى الاشتراكات في موارد Chat، بما في ذلك بيانات الموارد.
      • False: يستثني بيانات الموارد.

  2. لإنشاء اشتراك Google Workspace، شغِّل الدالة createSubscription في مشروع "برمجة تطبيقات Google".

Python

  1. في دليل العمل، أنشئ ملفًا باسم create_subscription.py وأضِف الرمز التالي:

    """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('client_secrets.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)

    استبدل ما يلي:

    • SCOPES: واحد أو أكثر من نطاقات OAuth التي تتوافق مع كل نوع حدث للاشتراك. يتم تنسيقها كصفيف من السلاسل. لإدراج نطاقات متعددة، افصل بينها بفواصل. مثلاً: 'https://www.googleapis.com/auth/chat.spaces.readonly', 'https://www.googleapis.com/auth/chat.memberships.readonly'
    • TARGET_RESOURCE: مورد Google Workspace الذي تشترك فيه، ويكون منسَّقًا كاسم مورده الكامل. على سبيل المثال، للاشتراك في مساحة Google Chat برقم تعريف المساحة AAAABBBB، استخدِم //chat.googleapis.com/spaces/AAAABBBB.
    • EVENT_TYPES: نوع واحد أو أكثر من أنواع الأحداث التي تريد الاشتراك فيها في المورد المستهدف. عليك التنسيق كمصفوفة من السلاسل مثل 'google.workspace.chat.message.v1.created'.
    • TOPIC_NAME: الاسم الكامل لموضوع النشر/الاشتراك الذي أنشأته في مشروعك على السحابة الإلكترونية. تم تنسيقها كـ projects/PROJECT_ID/topics/TOPIC_ID.

    • RESOURCE_DATA: قيمة منطقية تحدّد ما إذا كان الاشتراك يتضمّن بيانات موارد في الحمولة:

      • True: يتضمّن جميع بيانات الموارد. لتحديد الحقول التي يتم تضمينها، أضِف الحقل fieldMask وحدِّد حقلاً واحدًا على الأقل للمورد الذي تم تغييره. ولا يشمل ذلك سوى الاشتراكات في موارد Chat، بما في ذلك بيانات الموارد.
      • False: يستثني بيانات الموارد.

  2. لإنشاء اشتراك Google Workspace، يجب تشغيل ما يلي في المحطة الطرفية:

    python3 create_subscription.py

تعرض واجهة برمجة التطبيقات Google Workspace Events API عملية طويلة الأمد مكتملة تحتوي على مثيل مورد Subscription الذي أنشأته.

اختبار اشتراكك في Google Workspace

لاختبار أنّك تتلقّى أحداث Google Workspace، يمكنك تشغيل حدث وسحب الرسائل إلى اشتراك النشر/الاشتراك.

لاختبار اشتراكك في Google Workspace، اتّبِع الخطوات التالية:

وحدة تحكُّم Google Cloud

  1. يمكنك تشغيل نوع واحد أو أكثر من الأحداث في المورد المستهدف لاشتراكك في Google Workspace. على سبيل المثال، إذا اشتركت في الرسائل الجديدة في "مساحة Chat"، يمكنك نشر رسالة على المساحة.

  2. في وحدة التحكّم في Google Cloud، انتقِل إلى صفحة النشر/الاشتراك:

    الانتقال إلى صفحة النشر/الاشتراك

    تأكَّد من اختيار المشروع على السحابة الإلكترونية لتطبيقك.

  3. في قائمة النشر/الاشتراك، انقر على الاشتراكات.

  4. في الجدول، ابحث عن اشتراك النشر/الاشتراك لموضوعك وانقر على اسم الاشتراك.

  5. انقر على علامة التبويب الرسائل.

  6. انقر على سحب. قد يستغرق الحدث ما يصل إلى بضع دقائق لإنشاء رسالة نشر/اشتراك.

gcloud

  1. يمكنك تشغيل نوع واحد أو أكثر من الأحداث في المورد المستهدف لاشتراكك في Google Workspace. على سبيل المثال، إذا اشتركت في الرسائل الجديدة في "مساحة Chat"، يمكنك نشر رسالة في المساحة.

  2. نفِّذ الأمر التالي:

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

    استبدل ما يلي:

    • PUBSUB_SUBSCRIPTION_NAME: الاسم الكامل لاشتراكك في النشر/الاشتراك، بالتنسيق التالي: projects/SUBSCRIPTION_ID/subscriptions/SUBSCRIPTION_ID
    • MESSAGE_COUNT: الحد الأقصى لعدد رسائل النشر/الاشتراك التي تريد سحبها.

    قد يستغرق إنشاء رسالة نشر/اشتراك للحدث مدة تصل إلى بضع دقائق.

لكل حدث Google Workspace بدأته، يتم تسليم رسالة إلى اشتراك النشر/الاشتراك الذي يحتوي على الحدث. لمعرفة التفاصيل، يُرجى الاطّلاع على تلقّي الأحداث كرسائل من Google Cloud Pub/Sub.

ضبط كيفية تلقّي تطبيقك للأحداث

اشتراك Pub/Sub الذي أنشأته مستند إلى السحب. بعد التأكّد من أنّ اشتراكك في خدمة النشر/الاشتراك، يمكنك تعديل نوع التسليم لتغيير كيفية تلقّي تطبيقك للأحداث. على سبيل المثال، يمكنك ضبط اشتراك "النشر/الاشتراك" على نوع تسليم تلقائي، وبالتالي يمكن لتطبيقك تلقّي الأحداث مباشرةً في نقطة نهاية التطبيق.

للتعرّف على معلومات حول ضبط اشتراك Pub/Sub، يمكنك الاطّلاع على مستندات النشر/الاشتراك.