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

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

• لاستخدام أوامر Google Cloud CLI في هذا الدليل:
  1. ثبِّت واجهة سطر الأوامر في Google Cloud.
  2. إلى تهيئة واجهة سطر الأوامر gcloud، ثم تشغيل الرمز التالي:

    gcloud init
    

• مشروع على 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 CLI في هذا الدليل:
  1. ثبِّت واجهة سطر الأوامر في Google Cloud.
  2. إلى تهيئة واجهة سطر الأوامر gcloud، ثم تشغيل الرمز التالي:

    gcloud init
    

• مشروع على Google Cloud مع تفعيل الفوترة. بالنسبة إلى اشتراكات Chat، عليك استيفاء الشروط التالية: تفعيل Chat API أيضًا في مشروعك على Google Cloud اضبط اسم التطبيق وعنوان URL للصورة الرمزية والوصف. الحقول. للحصول على التفاصيل، يمكنك مراجعة إنشاء تطبيق Google Chat
• يجب إجراء مصادقة للمستخدم من خلال إعداد شاشة موافقة OAuth التي تم ضبطها من أجل: التطبيق. عند ضبط شاشة الموافقة، عليك تحديد نطاق كل نوع من أنواع الأحداث الخاصة بالاشتراك لضبط إعدادات الموافقة فحص وتحديد النطاقات المطلوبة، ومعرفة اختيار النطاقات:

وحدة التحكّم في 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
   

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

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

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

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

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

   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: اسم الموضوع الذي أنشأته في الخطوة السابقة.

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

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 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: الحد الأقصى لعدد رسائل النشر/الاشتراك التي تريد سحبها.

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