إنشاء اشتراك 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 للتأكُّد من أنّ خدمة Pub/Sub الموضوع يتلقى الأحداث التي اشتركت فيها.
  5. يمكنك اختياريًا ضبط كيفية إرسال الأحداث إلى نقطة نهاية لتطبيقك، وبالتالي يستطيع تطبيقك معالجة الحدث واتخاذ إجراء، إذا لزم الأمر.

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

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

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

Python

  • Python 3.6 أو أعلى
  • أداة إدارة حزم pip
  • أحدث مكتبات برامج Google للغة بايثون. لتثبيتها أو تحديثها، شغِّل ما يلي الأمر في واجهة سطر الأوامر: 
      pip3 install --upgrade google-api-python-client google-auth-oauthlib
  • مشروع على Google Cloud مع تفعيل الفوترة. بالنسبة إلى اشتراكات Chat، عليك استيفاء الشروط التالية: تفعيل Chat API أيضًا في مشروعك على Google Cloud اضبط اسم التطبيق وعنوان 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، افتح مشروع Google Cloud لتطبيقك وفعِّل واجهة برمجة التطبيقات لفعاليات Google Workspace وواجهة برمجة التطبيقات Pub/Sub:

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

gcloud

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

    gcloud auth login

  2. يجب إعداد مشروعك على Google Cloud لتطبيقك:

    gcloud config set project PROJECT_ID

    استبدال PROJECT_ID بـ رقم تعريف المشروع الخاص بتطبيقك على Google Cloud.

  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.
  5. أضِف معرّفات موارد منتظمة (URI) معتمَدة ذات صلة بتطبيقك:
    • التطبيقات من جهة العميل (JavaScript): ضمن مصادر JavaScript المعتمَدة، انقر على إضافة معرّف موارد منتظم (URI). بعد ذلك، أدخِل عنوان URL لاستخدامه في طلبات المتصفّح. يحدِّد ذلك النطاقات التي يمكن لتطبيقك من خلالها إرسال طلبات واجهة برمجة التطبيقات إلى خادم 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.
  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.
  5. في "معرّف الحزمة" أدخِل معرِّف الحزمة كما هو مُدرَج في ملف Info.plist للتطبيق.
  6. اختياري: إذا كان تطبيقك يظهر في Apple App Store، أدخِل رقم تعريف متجر التطبيقات.
  7. اختياري: في "رقم تعريف الفريق" أدخِل السلسلة الفريدة المكوّنة من 10 أحرف التي أنشأتها Apple وتم تخصيصها لفريقك.
  8. انقر على إنشاء. تظهر الشاشة التي تم إنشاؤها من خلال عميل OAuth، وتعرض معرِّف العميل الجديد وسر العميل.
  9. انقر على موافق. تظهر بيانات الاعتماد التي تم إنشاؤها حديثًا ضمن "معرّفات عميل OAuth 2.0".

تطبيق Chrome

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

وحدة التحكّم في Google Cloud

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

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

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

  2. انقر على إنشاء موضوع و قم بما يلي:

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

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

  4. امنح إمكانية الوصول لنشر رسائل Pub/Sub على موضوعك:

    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

في هذا القسم، يمكنك الاشتراك في مورد Google Workspace الذي وتريد مراقبتها بحثًا عن الأحداث.

اختيار المورد المستهدف وتحديده

في اشتراك Google Workspace، يكون المورد المستهدف هو مرجع Google Workspace الذي يتم تتبُّعه للأحداث الهدف يتم تمثيل المورد في حقل targetResource للاشتراك، والذي تم تنسيقه باستخدام اسم المورد الكامل. على سبيل المثال، بالنسبة إلى الاشتراك الذي يراقب مساحة Google Chat (spaces/AAAABBBBBBB)، قيمة targetResource هي //chat.googleapis.com/spaces/AAAABBBBBBB

قبل إنشاء الاشتراك، يُرجى الاطّلاع على الأقسام التالية للتعرّف على كيفية تحديد المورد المستهدف وتنسيقه.

تحديد مورد مستهدف في Chat

المورد المستهدف التنسيق القيود
مسافة

//chat.googleapis.com/spaces/SPACE

حيث SPACE هو المعرّف في اسم المورد الخاص بمورد space في Chat API. يمكنك الحصول على المعرّف من عنوان URL للمساحة أو باستخدام spaces.list().

 على مستخدم Chat الذي يسمح بالاشتراك: أن تكون عضوًا في مساحة العمل من خلال Google Workspace أو Google الحساب.
جميع المساحات لمستخدم

//chat.googleapis.com/spaces/-

 لا يتلقّى الاشتراك إلا أحداث المساحات التي يكون المستخدم فيها فرد من خلال حسابه على Google Workspace أو Google.
مستخدم

//cloudidentity.googleapis.com/users/USER

حيث USER هو المعرّف في اسم المورد الخاص بمورد user في Chat API. للحصول على التفاصيل، يُرجى مراجعة التحديد والتحديد مستخدمو Google Chat

لا يتلقّى الاشتراك إلا الأحداث المتعلقة بالمستخدم الذي قد صادقوا على الاشتراك. لا يمكن للمستخدم تفويض اشتراك في بالنيابة عن المستخدمين الآخرين.

تحديد مورد مستهدف في Meet

المورد المستهدف التنسيق القيود (إذا كانت منطبقة)
مساحة اجتماعات //meet.googleapis.com/spaces/SPACE

حيث SPACE هو المعرّف في اسم المورد الخاص بمورد space لواجهة برمجة تطبيقات REST API. للحصول على التفاصيل، يُرجى مراجعة الطريقة يحدِّد تطبيق Meet مساحة اجتماعات.
مستخدم //cloudidentity.googleapis.com/users/USER

حيث USER هو المعرّف في signedinUser.user في مرجع Meet API REST API participant. للحصول على التفاصيل، يُرجى مراجعة العمل مع المشاركين:

يتلقى الاشتراك أحداثًا حول مساحات الاجتماعات التي تتضمن مستخدم واحد مما يلي:

  • مالك مساحة الاجتماعات
  • منظّم البيانات من حدث "تقويم Google" المرتبط بمساحة الاجتماع.

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

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

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

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

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

  1. في مشروع "برمجة تطبيقات Google"، أنشئ ملف نص برمجي جديدًا الاسم 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: الاسم الكامل لموضوع النشر/الاشتراك الذي الذي أنشأته في مشروعك على Google Cloud تم التنسيق كـ 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: الاسم الكامل لموضوع النشر/الاشتراك الذي الذي أنشأته في مشروعك على Google Cloud تم التنسيق كـ 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 Console، انتقِل إلى صفحة النشر/الاشتراك:

    الانتقال إلى نشر/اشتراك

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

  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 بدأته، تظهر رسالة إلى اشتراك Pub/Sub يحتوي على الحدث. للحصول على التفاصيل، يُرجى مراجعة تلقّي الأحداث كرسائل Google Cloud Pub/Sub

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

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

للتعرف على مزيد من المعلومات حول إعداد اشتراك نشر/اشتراك، يمكنك الاطلاع على صفحة النشر/الاشتراك. ذات الصلة.