توضّح هذه الصفحة بنية عناصر أحداث "إضافات Google Workspace".
كائنات الأحداث هي بُنى JSON يتم إنشاؤها وتمريرها تلقائيًا كمَعلمات لتشغيل وظائف أو معاودة الاتصال عندما يتفاعل المستخدم مع إضافة. تحمل عناصر الأحداث معلومات من جهة العميل حول التطبيق المضيف والسياق الحالي لوظيفة معاودة الاتصال من جهة الخادم في الإضافة.
تستخدم إضافات Google Workspace عناصر الأحداث في الأماكن التالية:
عوامل تشغيل الصفحة الرئيسية: يتم تلقائيًا تمرير كائن حدث إلى كل دالة
homepageTrigger
تحدّدها عند تنشيط دالة تشغيل الصفحة الرئيسية. يمكنك استخدام هذا الكائن في وظيفة تشغيل الصفحة الرئيسية لتحديد تطبيق المضيف النشط والنظام الأساسي للعميل ولغة المستخدم ومعلومات أخرى.إنّ كائنات الحدث التي تم إنشاؤها عند تنشيط الصفحة الرئيسية لا تحتوي على جميع الحقول المضمّنة في الحالتَين الأخريين، إذ يتم حذف الحقول المتعلّقة بالتطبيقات المصغّرة والمعلومات السياقية.
عوامل الانضمام إلى المحتوى: يوفر كل تطبيق مضيف مجموعة مختلفة من المشغلات السياقية التي يتم تنشيطها عندما يدخل المستخدم سياقًا محددًا. مثال:
- يوفر Gmail عامل تشغيل سياقي عند فتح المستخدم لرسالة ومشغّل آخر عند إنشاء المستخدم لرسالة.
- ويوفّر "تقويم Google" عامل تشغيل سياقي عندما يفتح المستخدِم حدثًا.
- يوفر Google Drive عامل تشغيل سياقي عندما يختار المستخدم ملفات Drive.
عند تنشيط مشغِّل سياقي، يستدعي التطبيق المضيف علامة
runFunction
المقابلة المدرَجة في بيان الإضافة، ويمرِّره كائن حدث باعتباره معلَمة. إنّ كائنات الأحداث التي يتمّ إنشاؤها عند تنشيط المشغِّلات السياقية تحتوي على جميع الحقول المضمّنة في كائنات أحداث مشغِّل الصفحة الرئيسية، بالإضافة إلى الحقول التي تحتوي على معلومات سياقية.إجراءات الأداة: تُستخدم كائنات الأحداث أيضًا لتوفير تفاعل التطبيقات المصغّرة، باستخدام نموذج الإجراء نفسه الذي تستخدمه إضافات Gmail. تستخدم "إضافات Google Workspace" جميع دوال معالج الأدوات وكائنات
Action
واستجابات الإجراءات نفسها. ومع ذلك، في "إضافات Google Workspace"، تتضمّن كائنات أحداث الإجراءات المزيد من المعلومات التي يمكن لدالة معاودة الاتصال العمل وفقًا لها.تحتوي كائنات الأحداث التي يتم إنشاؤها نتيجة لإجراءات الأداة على جميع الحقول المضمّنة في كائنات أحداث عامل التشغيل السياقي، بالإضافة إلى الحقول التي تحتوي على معلومات الأدوات.
عوامل تشغيل روابط المعاينة: في "مستندات Google" و"جداول بيانات Google" و"العروض التقديمية من Google"، يمكنك ضبط معاينات الروابط للخدمات التابعة لجهات خارجية استنادًا إلى أنماط عناوين URL محدَّدة. عندما يتفاعل المستخدمون مع رابط يفي بالنمط، يتم نقل
linkPreviewTriggers
وكائن الحدث الذي يحتوي على الرابط إلى وظيفة معاودة الاتصال لدى المشغّل. يمكن أن تستخدم الإضافة كائن الحدث هذا لإنشاء شريحة ذكية وبطاقة تعرض معلومات حول الرابط في التطبيق المضيف. يمكنك أيضًا إنشاء إجراءات للتطبيق المصغّر للسماح للمستخدمين بالتفاعل مع بطاقة المعاينة ومحتواها.
بنية عنصر الحدث
يوضِّح الجدول التالي البنية ذات المستوى الأعلى لعناصر أحداث "إضافات Google Workspace". تتضمّن بنية كائن الحدث حقل المستوى الأعلى commonEventObject
للمعلومات المستقلة عن المضيف. يمكن أيضًا لكل كائن حدث أن يحتوي على أحد حقول المستوى الأعلى التالية الخاصة بالمضيف، والذي يحدده تطبيق المضيف النشط: gmailEventObject
، أو calendarEventObject
، أو driveEventObject
.
للتوافق مع الأنظمة القديمة، تشتمل كائنات أحداث "إضافات Google Workspace" أيضًا على جميع الحقول الأصلية المستخدمة في كائنات أحداث إجراءات إضافات Gmail. يتم إدراج هذه الحقول في الجدول أدناه ضمن "حقول إضافة Gmail الأصلية" ويتم إعادة إنتاج المعلومات الواردة في هذه الحقول في بنية العناصر الجديدة.
كائن الحدث | |
---|---|
eventObject.commonEventObject |
Common fields object
كائن يحتوي على معلومات شائعة بين جميع كائنات الأحداث، بصرف النظر عن التطبيق المضيف. |
eventObject.calendar |
Calendar event object
لا تتوفّر هذه الميزة إلا إذا كان مضيف الاتصال هو "تقويم Google". كائن يحتوي على معلومات عن التقويم والفعاليات. |
eventObject.drive |
Drive event object
لا تتوفّر هذه الميزة إلا إذا كان مضيف الاتصال هو Google Drive. عنصر يحتوي على معلومات Drive. |
eventObject.gmail |
Gmail event object
لا تتوفّر هذه الميزة إلا إذا كان مضيف الاتصال هو Gmail. عنصر يحتوي على معلومات Gmail. |
eventObject.docs |
Docs event object
لا تتوفّر هذه الميزة إلا إذا كان مضيف الاتصال هو "مستندات Google". عنصر يحتوي على معلومات "مستندات Google". |
eventObject.sheets |
Sheets event object
لا تتوفّر هذه الميزة إلا إذا كان مضيف الاتصال هو "جداول بيانات Google". كائن يحتوي على معلومات في "جداول بيانات Google". |
eventObject.slides |
Slides event object
لا تتوفّر هذه الميزة إلا إذا كان مضيف الاتصال هو "العروض التقديمية من Google". كائن يحتوي على معلومات "العروض التقديمية من Google". |
حقول إضافة Gmail الأصلية | |
eventObject.messageMetadata.accessToken |
string تمت إزالة هذا العمود. رمز الدخول. يمكنك استخدام هذا الخيار لتفعيل الوصول إلى بيانات المستخدمين باستخدام النطاقات المؤقتة لإضافة Gmail.
بالنسبة إلى إضافات Google Workspace، يمكنك العثور على هذه المعلومات في الحقل
|
eventObject.messageMetadata.messageId |
string تمت إزالة هذا العمود. يتم فتح رقم تعريف رسالة سلسلة المحادثات في واجهة مستخدم Gmail.
بالنسبة إلى إضافات Google Workspace، يمكنك العثور على هذه المعلومات في الحقل
|
eventObject.clientPlatform |
string تمت إزالة هذا العمود. يشير إلى المكان الذي نشأ منه الحدث (على الويب أو iOS أو Android).
بالنسبة إلى إضافات Google Workspace، يمكنك العثور على هذه المعلومات في الحقل
|
eventObject.formInput |
object تمت إزالة هذا العمود. خريطة للقيم الحالية لجميع أشكال التطبيقات المصغّرة في البطاقة، محصورة بقيمة واحدة لكل تطبيق مصغّر والمفاتيح هي أرقام تعريف السلاسل المرتبطة بالأدوات، والقيم عبارة عن سلاسل. يوفر كائن الحدث formInput
لتسهيل الأمر عندما تحتاج إلى قراءة البيانات من عدة تطبيقات مصغّرة
بقيم مفردة متوقعة، مثل إدخالات النص ومفاتيح التبديل. بالنسبة إلى التطبيقات المصغّرة متعددة القيم، مثل مربّعات الاختيار، يمكنك قراءة كل قيمة من formInputs بدلاً من ذلك.
بالنسبة إلى إضافات Google Workspace، يمكنك العثور على هذه المعلومات في الحقل |
eventObject.formInputs |
object تمت إزالة هذا العمود. خريطة للقيم الحالية للتطبيقات المصغّرة في البطاقة، يتم عرضها في شكل قوائم من السلاسل المفاتيح هي أرقام تعريف السلاسل المرتبطة بالأداة. بالنسبة إلى التطبيقات المصغّرة ذات القيمة الفردية، يتم تقديم القيمة في مصفوفة مكوّنة من عنصر واحد. بالنسبة إلى التطبيقات المصغّرة متعددة القيم، مثل مجموعات مربّعات الاختيار، يتم عرض جميع القيم في قائمة.
بالنسبة إلى إضافات Google Workspace، يمكنك العثور على هذه المعلومات في الحقل
|
eventObject.parameters |
object تمت إزالة هذا العمود. خريطة لأي معلَمات إضافية تقدّمها إلى Action باستخدام
Action.setParameters() . مفاتيح الخريطة وقيمها عبارة عن سلاسل.
بالنسبة إلى إضافات Google Workspace، يمكنك العثور على هذه المعلومات في الحقل
|
eventObject.userCountry |
string تم إيقاف العمل به وإيقافه تلقائيًا. تمثّل هذه السمة الرمز المكوَّن من حرفين والذي يشير إلى بلد المستخدم أو منطقته. ويمكن أيضًا أن يكون رمز البلد UN M49 رقميًا.
بالنسبة إلى إضافات Google Workspace، يمكنك العثور على هذه المعلومات في الحقل
|
eventObject.userLocale |
string تم إيقاف العمل به وإيقافه تلقائيًا. تمثّل هذه السمة رمز ISO 639 المكوّن من حرفَين والذي يشير إلى لغة المستخدم. لمزيد من التفاصيل، يمكنك الاطّلاع على الوصول إلى لغة المستخدم ومنطقته الزمنية.
بالنسبة إلى إضافات Google Workspace، يمكنك العثور على هذه المعلومات في الحقل
|
eventObject.userTimezone.id |
string تم إيقاف العمل به وإيقافه تلقائيًا. تمثّل هذه السمة معرّف المنطقة الزمنية للمنطقة الزمنية للمستخدِم. ومن الأمثلة على ذلك: America/New_York وEurope/Vienna
وAsia/Seoul . لمزيد من التفاصيل، يمكنك الاطّلاع على
الوصول إلى لغة المستخدم ومنطقته الزمنية.
بالنسبة إلى إضافات Google Workspace، يمكنك العثور على هذه المعلومات في الحقل
|
eventObject.userTimezone.offset |
string تم إيقاف العمل به وإيقافه تلقائيًا. معادلة الوقت من التوقيت العالمي المنسَّق (UTC) للمنطقة الزمنية للمستخدم، مُقاس بالمللي ثانية. لمزيد من التفاصيل، يمكنك الاطّلاع على الوصول إلى لغة المستخدم ومنطقته الزمنية.
بالنسبة إلى إضافات Google Workspace، يمكنك العثور على هذه المعلومات في الحقل
|
كائن الحدث الشائع
كائن الحدث الشائع هو جزء من كائن الحدث الكلي الذي يحمل معلومات عامة ومستقلة عن المضيف إلى الإضافة من عميل المستخدم. وتشمل هذه المعلومات تفاصيل مثل لغة المستخدم وتطبيق المضيف والنظام الأساسي.
بالإضافة إلى الصفحة الرئيسية وعوامل التشغيل السياقية، تُنشئ الإضافات كائنات الأحداث وتمرِّرها إلى وظائف معاودة الاتصال بالإجراءات عندما يتفاعل المستخدِم مع التطبيقات المصغّرة. يمكن لوظيفة معاودة الاتصال في الإضافة الاستعلام عن كائن الحدث الشائع لتحديد محتويات التطبيقات المصغّرة المفتوحة في برنامج المستخدم. على سبيل المثال، يمكن للإضافة تحديد موقع النص الذي أدخله المستخدم في تطبيق TextInput
المصغّر داخل عنصر eventObject.commentEventObject.formInputs
.
حقول عناصر الأحداث الشائعة | |
---|---|
commonEventObject.platform |
string يشير إلى مكان انطلاق الحدث (`WEB` أو "IOS" أو "ANDROID"). |
commonEventObject.formInputs |
object خريطة تحتوي على القيم الحالية للتطبيقات المصغّرة في البطاقة المعروضة مفاتيح الخريطة هي أرقام تعريف السلاسل المخصّصة لكل تطبيق مصغّر. تعتمد بنية كائن قيمة الخريطة على نوع التطبيق المصغّر:
|
commonEventObject.hostApp |
string يشير إلى تطبيق المضيف الذي تكون الإضافة نشطة فيه عند إنشاء كائن الحدث. وتشمل القيم المتاحة ما يلي:
|
commonEventObject.parameters |
object أي معلَمات إضافية تقدّمها إلى
Action باستخدام
Action.setParameters() :
|
commonEventObject.userLocale |
string تكون هذه الميزة غير مفعَّلة تلقائيًا. تمثّل هذه السمة معرّف اللغة والبلد/المنطقة للمستخدم بتنسيق رمز اللغة ISO 639، أي رمز البلد/المنطقة وفقًا لمعيار ISO 3166. مثلاً: en-US
لتفعيل هذا الحقل، يجب ضبط |
commonEventObject.timeZone |
string تكون هذه الميزة غير مفعَّلة تلقائيًا. رقم تعريف المنطقة الزمنية والإزاحة لتفعيل هذا الحقل، يجب ضبط addOns.common.useLocaleFromApp على true في ملف بيان الإضافة.
يجب أن تتضمن قائمة نطاق الإضافة أيضًا https://www.googleapis.com/auth/script.locale .
لمزيد من التفاصيل، يمكنك الاطّلاع على
الوصول إلى لغة المستخدم ومنطقته الزمنية.
|
commonEventObject.timeZone.id |
string معرّف المنطقة الزمنية للمنطقة الزمنية للمستخدِم. ومن الأمثلة على ذلك: America/New_York وEurope/Vienna
وAsia/Seoul . لتفعيل هذا الحقل، يجب ضبط
addOns.common.useLocaleFromApp على true في ملف بيان الإضافة.
يجب أن تتضمن قائمة نطاق الإضافة أيضًا https://www.googleapis.com/auth/script.locale . لمزيد من التفاصيل، يمكنك الاطّلاع على
الوصول إلى لغة المستخدم ومنطقته الزمنية.
|
commonEventObject.timeZone.offset |
string معادلة الوقت من التوقيت العالمي المنسَّق (UTC) للمنطقة الزمنية للمستخدم، مُقاسًا بالمللي ثانية. لمزيد من التفاصيل، يمكنك الاطّلاع على الوصول إلى لغة المستخدم ومنطقته الزمنية. |
إدخالات نموذج أداة اختيار التاريخ والوقت
يمكن أن تتلقّى دوال معاودة الاتصال بالإجراءات
قيم التطبيقات المصغّرة الحالية في الحقل commonEventObject.formInputs
.
ويتضمّن ذلك قيم التاريخ والوقت التي اختارها المستخدم في أدوات اختيار التاريخ أو الوقت.
ومع ذلك، تختلف بنية المعلومات بناءً على ما إذا كان قد تمت تهيئة التطبيق المصغَّر ليكون منتقي التاريخ والوقت، أو منتقي التاريخ فقط، أو منتقي الوقت فقط. يتم توضيح الاختلافات الهيكلية في الجدول التالي:
عنصر حدث في التقويم
كائن الحدث في "تقويم Google" هو جزء من كائن الحدث الكلي الذي يحمل معلومات حول تقويم المستخدم وأحداث التقويم. يتوفّر فقط في كائن حدث إذا كان التطبيق المضيف هو "تقويم Google".
يسرد الجدول التالي الحقول المتوفّرة في الحقل calendarEventObject
لكائن الحدث. لا تتوفّر الحقول المميّزة ببيانات من إنشاء المستخدم في كائن الحدث إلا إذا كانت البيانات متوفّرة في حدث "تقويم Google" وضبطت الإضافة حقل addOns.calendar.currentEventAccess
البيان
على
READ
أو READ_WRITE
.
عنصر حدث في التقويم | |
---|---|
calendar.attendees[] |
list of attendee objects البيانات التي ينشئها المستخدمون: تمثّل هذه السمة قائمة بضيوف الفعالية في التقويم. |
calendar.calendarId |
string رقم تعريف التقويم |
calendar.capabilities |
object البيانات التي ينشئها المستخدم: كائن يصف قدرات الإضافة لعرض معلومات الفعاليات أو تعديلها. |
calendar.capabilities.canAddAttendees |
boolean البيانات التي ينشئها المستخدم: true
إذا كان بإمكان الإضافة إضافة ضيوف جدد إلى قائمة الضيوف للحدث،
بخلاف ذلك،
false . |
calendar.capabilities.canSeeAttendees |
boolean البيانات التي ينشئها المستخدم: true
إذا كان بإمكان الإضافة قراءة قائمة الضيوف في الفعالية، أو false
بخلاف ذلك. |
calendar.capabilities.canSeeConferenceData |
boolean البيانات التي ينشئها المستخدم: true
إذا كان بإمكان الإضافة قراءة بيانات مكالمات الفيديو الخاصة بالفعاليات، أو false
بخلاف ذلك. |
calendar.capabilities.canSetConferenceData |
boolean البيانات التي ينشئها المستخدم: true
إذا كان بإمكان الإضافة تعديل بيانات مكالمات الفيديو الخاصة بالفعاليات، أو false
بخلاف ذلك. |
calendar.capabilities.canAddAttachments |
boolean البيانات التي ينشئها المستخدم: true
إذا كان بإمكان الإضافة إضافة مرفقات جديدة إلى الحدث،
أو false في الحالات الأخرى.
|
calendar.conferenceData |
Conference data object البيانات التي ينشئها المستخدمون: كائن يمثّل أي بيانات لمكالمات الفيديو مرتبطة بهذا الحدث، مثل تفاصيل مكالمات الفيديو على Google Meet. |
calendar.id |
string رقم تعريف الحدث |
calendar.organizer |
object كائن يمثّل منظِّم الفعالية. |
calendar.organizer.email |
string عنوان البريد الإلكتروني لمنظِّم الحدث |
calendar.recurringEventId |
string رقم تعريف حدث متكرّر |
الضيوف
وتحمل كائنات الضيوف معلومات عن الضيوف الفرديين في أحداث "تقويم Google". لا تتوفّر هذه المعلومات في كائن الحدث إلا إذا كانت البيانات متوفّرة في حدث "تقويم Google" وضبطت الإضافة حقل
addOns.calendar.currentEventAccess
البيان الخاص بها على
READ
أو READ_WRITE
.
كائن الضيوف | |
---|---|
attendee.additionalGuests |
number عدد الضيوف الإضافيين الذين أشاروا إلى أنّه سيحضرهم. وتكون القيم التلقائية صفرًا. |
attendee.comment |
string تعليق على ردّ الضيف، إن وجد |
attendee.displayName |
string الاسم المعروض للضيف |
attendee.email |
string عنوان البريد الإلكتروني للضيف |
attendee.optional |
boolean true إذا كان حضور هذا
الضيف اختياري، أو false في الحالات الأخرى.
|
attendee.organizer |
boolean true إذا كان الضيف منظِّمًا لهذا الحدث.
|
attendee.resource |
boolean true إذا كان الضيف يمثّل موردًا، مثل غرفة أو قطعة من المعدات، false في الحالات الأخرى.
|
attendee.responseStatus |
string حالة ردّ الضيف وتشمل القيم المحتمَلة ما يلي:
|
attendee.self |
boolean true إذا كان هذا الضيف يمثّل
التقويم الذي سيظهر فيه هذا الحدث، وبخلاف ذلك، false .
|
بيانات مكالمة الفيديو
تحتوي عناصر بيانات مكالمات الفيديو على معلومات حول مكالمات الفيديو المرفقة بأحداث "تقويم Google". قد تكون هذه حلول مؤتمرات من Google،
مثل Google Meet أو مكالمات فيديو تابعة لجهات خارجية. لا تتوفّر هذه المعلومات في كائن الحدث إلا إذا كانت البيانات متوفّرة في حدث "تقويم Google" وضبطت الإضافة حقل addOns.calendar.currentEventAccess
البيان الخاص بها على READ
أو READ_WRITE
.
كائن بيانات مكالمة الفيديو | |
---|---|
conferenceData.conferenceId |
string رقم تعريف مكالمة الفيديو يهدف رقم التعريف هذا إلى السماح للتطبيقات بتتبُّع مكالمات الفيديو، وبالتالي يجب عدم عرض رقم التعريف هذا للمستخدمين. |
conferenceData.conferenceSolution |
object عنصر يمثّل حلّ المؤتمر، مثل Hangouts أو Google Meet |
conferenceData.conferenceSolution.iconUri |
string معرّف الموارد المنتظم (URI) للرمز المرئي للمستخدم الذي يمثّل حلّ مكالمات الفيديو هذا |
conferenceData.conferenceSolution.key |
object المفتاح الذي يحدّد بشكل فريد حل مكالمات الفيديو الخاص بهذه الفعالية. |
conferenceData.conferenceSolution.key.type |
string نوع حلّ مكالمات الفيديو وتشمل القيم المتاحة ما يلي:
|
conferenceData.conferenceSolution.name |
string الاسم المرئي للمستخدم لحل مكالمة الفيديو هذا (غير مترجم). |
conferenceData.entryPoints[] |
list of entry point objects
قائمة بنقاط دخول مكالمات الفيديو، مثل عناوين URL أو أرقام الهواتف |
conferenceData.notes |
string ملاحظات إضافية (مثل التعليمات الواردة من مشرف النطاق أو الإشعارات القانونية) حول المؤتمر لعرضها للمستخدم. يمكن أن تحتوي على HTML. الحدّ الأقصى لعدد الأحرف هو 2,048 حرفًا. |
conferenceData.parameters |
object عنصر يحتوي على خريطة لبيانات المعلَمات المحدّدة لاستخدامها بواسطة الإضافة. |
conferenceData.parameters.addOnParameters |
object خريطة لمفاتيح سلسلة المَعلمات وقيمها ويحدِّد مطوّر الإضافة هذه المفاتيح والقيم لإرفاق المعلومات بمؤتمر معيّن من أجل استخدام الإضافة. |
نقطة الإدخال
تحمل كائنات نقطة الدخول معلومات حول الوسائل المعمول بها للدخول إلى مؤتمر معين، مثل الهاتف أو الفيديو. لا تتوفّر هذه المعلومات في
كائن الحدث إلا إذا كانت البيانات متوفّرة في حدث "تقويم Google"
وضبطت الإضافة حقل addOns.calendar.currentEventAccess
البيان
على READ
أو READ_WRITE
.
عنصر نقطة الدخول | |
---|---|
entryPoint.accessCode |
string رمز الدخول المستخدَم للوصول إلى مكالمة الفيديو الحد الأقصى لعدد الأحرف المسموح به هو 128 حرفًا. يستخدم عادةً موفّرو مكالمات الفيديو مجموعة فرعية من { accessCode ، meetingCode ،
passcode ، password ، pin }
لتوفير إمكانية الوصول إلى مكالمات الفيديو. يمكنك مطابقة الحقول التي يستخدمها مقدّم خدمة مكالمات الفيديو وعرضها فقط.
|
entryPoint.entryPointFeatures |
list ميزات نقطة الدخول في الوقت الحالي، لا تسري هذه الميزات إلا على نقاط دخول phone :
|
entryPoint.entryPointType |
string نوع نقطة الدخول في ما يلي القيم المحتمَلة لهذه الحالة:
|
entryPoint.label |
string التصنيف المرئي للمستخدمين لمعرّف الموارد المنتظم (URI) لنقطة الدخول (غير مترجَم). |
entryPoint.meetingCode |
string رمز الاجتماع المُستخدَم للوصول إلى مكالمة الفيديو الحد الأقصى لعدد الأحرف المسموح به هو 128 حرفًا. يستخدم عادةً موفّرو مكالمات الفيديو مجموعة فرعية من { accessCode ، meetingCode ،
passcode ، password ، pin }
لتوفير إمكانية الوصول إلى مكالمات الفيديو. يمكنك مطابقة الحقول التي يستخدمها مقدّم خدمة مكالمات الفيديو وعرضها فقط.
|
entryPoint.passcode |
string رمز المرور المُستخدَم للوصول إلى مكالمة الفيديو الحد الأقصى لعدد الأحرف المسموح به هو 128 حرفًا. يستخدم عادةً موفّرو مكالمات الفيديو مجموعة فرعية من { accessCode ، meetingCode ،
passcode ، password ، pin }
لتوفير إمكانية الوصول إلى مكالمات الفيديو. يمكنك مطابقة الحقول التي يستخدمها مقدّم خدمة مكالمات الفيديو وعرضها فقط.
|
entryPoint.password |
string كلمة المرور المستخدمة للوصول إلى مكالمة الفيديو الحد الأقصى لعدد الأحرف المسموح به هو 128 حرفًا. يستخدم عادةً موفّرو مكالمات الفيديو مجموعة فرعية من { accessCode ، meetingCode ،
passcode ، password ، pin }
لتوفير إمكانية الوصول إلى مكالمات الفيديو. يمكنك مطابقة الحقول التي يستخدمها مقدّم خدمة مكالمات الفيديو وعرضها فقط.
|
entryPoint.pin |
string رقم التعريف الشخصي المستخدَم للدخول إلى مكالمة الفيديو الحد الأقصى لعدد الأحرف المسموح به هو 128 حرفًا. يستخدم عادةً موفّرو مكالمات الفيديو مجموعة فرعية من { accessCode ، meetingCode ،
passcode ، password ، pin }
لتوفير إمكانية الوصول إلى مكالمات الفيديو. يمكنك مطابقة الحقول التي يستخدمها مقدّم خدمة مكالمات الفيديو وعرضها فقط.
|
entryPoint.regionCode |
string رمز المنطقة لرقم الهاتف ويحتاجه المستخدمون إذا كان معرّف الموارد المنتظم (URI) لا يتضمّن رمز بلد. تستند القيم إلى قائمة CLDR العامة لرموز المناطق. |
entryPoint.uri |
string معرّف الموارد المنتظم لنقطة الدخول ويبلغ الحدّ الأقصى للطول 1,300 حرف. ويعتمد التنسيق على نوع نقطة الإدخال:
|
عنصر حدث Drive
كائن حدث Drive هو جزء من كائن الحدث الكلي الذي يحمل معلومات عن حساب Google Drive الخاص بالمستخدم ومحتواه. وهو موجود فقط في كائن حدث إذا كان التطبيق المضيف هو Google Drive.
عنصر حدث Drive | |
---|---|
drive.activeCursorItem |
Drive item object عنصر Drive نشط حاليًا. |
drive.selectedItems[] |
list of Drive item objects قائمة بالعناصر (الملفات أو المجلدات) التي تم اختيارها في Drive. |
عنصر Drive
تتضمن كائنات عناصر Drive معلومات عن عناصر محددة في Drive، مثل الملفات أو المجلدات.
كائن عنصر Drive | |
---|---|
item.addonHasFileScopePermission |
boolean إذا كانت الإضافة true ، يعني ذلك أنّ الإضافة قد طلبت الحصول على تفويض نطاق https://www.googleapis.com/auth/drive.file لهذا العنصر وتلقته، وإلا فإنّ هذا الحقل هو false .
|
item.id |
string رقم تعريف العنصر المحدّد |
item.iconUrl |
string عنوان URL للرمز الذي يمثّل العنصر الذي تم اختياره |
item.mimeType |
string نوع MIME للعنصر المحدد. |
item.title |
string عنوان العنصر الذي تم اختياره |
كائن حدث Gmail
كائن حدث Gmail هو جزء من كائن الحدث الكلي الذي يحمل معلومات عن رسائل Gmail لمستخدم معيَّن. لا يتوفّر في كائن حدث إلا إذا كان التطبيق المضيف هو Gmail.
كائن حدث Gmail | |
---|---|
gmail.accessToken |
string رمز الدخول الخاص بـ Gmail. يمكنك استخدام هذا الرمز المميّز مع طريقة GmailApp.setCurrentMessageAccessToken(accessToken)
لمنح الإضافة إذن الوصول المؤقت إلى رسالة Gmail
المفتوحة حاليًا للمستخدم أو السماح لإضافتك بإنشاء مسودات جديدة.
|
gmail.bccRecipients[] |
list of strings تكون هذه الميزة غير مفعَّلة تلقائيًا. قائمة عناوين البريد الإلكتروني للمستلِمين "نسخة مخفية الوجهة:" المضمّنة حاليًا في مسودة تنشئها الإضافة. لتفعيل هذا الحقل، يجب ضبط الحقل addOns.gmail.composeTrigger.draftAccess في ملف البيان على
METADATA .
|
gmail.ccRecipients[] |
list of strings تكون هذه الميزة غير مفعَّلة تلقائيًا. تمثّل هذه السمة عناوين البريد الإلكتروني للمستلِمين "نسخة إلى:" المضمّنة حاليًا في مسودة تنشئها الإضافة. لتفعيل هذا الحقل، يجب ضبط الحقل addOns.gmail.composeTrigger.draftAccess في ملف البيان على
METADATA .
|
gmail.messageId |
string رقم تعريف رسالة Gmail المفتوحة حاليًا |
gmail.threadId |
string رقم تعريف سلسلة المحادثات المفتوحة حاليًا في Gmail |
gmail.toRecipients[] |
list of strings تكون هذه الميزة غير مفعَّلة تلقائيًا. تمثّل هذه السمة عناوين البريد الإلكتروني للمستلِمين "إلى:" المضمّنة حاليًا في مسودة تنشئها الإضافة. لتفعيل هذا الحقل، يجب ضبط الحقل addOns.gmail.composeTrigger.draftAccess في ملف البيان على
METADATA .
|
كائن حدث "مستندات Google"
كائن الحدث "مستندات Google" هو جزء من كائن الحدث الكلي الذي يحمل معلومات عن مستند المستخدم ومحتواه. لا يتوفّر في كائن حدث إلا إذا كان التطبيق المضيف هو "مستندات Google".
كائن حدث "مستندات Google" | |
---|---|
docs.id |
string لا يظهر هذا الخيار إلا إذا سمح المستخدم بعرض النطاق
https://www.googleapis.com/auth/drive.file .رقم تعريف المستند مفتوح في واجهة مستخدم "مستندات Google". |
docs.title |
string لا يظهر هذا الخيار إلا إذا سمح المستخدم بعرض النطاق
https://www.googleapis.com/auth/drive.file .عنوان المستند مفتوحًا في واجهة مستخدم "مستندات Google". |
docs.addonHasFileScopePermission |
boolean في حال الخطأ true ، يعني ذلك أنّ الإضافة طلبت الحصول على تفويض نطاق https://www.googleapis.com/auth/drive.file للمستند مفتوحًا في واجهة مستخدم "مستندات Google"، وإلّا، فإنّ هذا الحقل هو false .
|
docs.matchedUrl.url |
string
لا تتوفّر هذه الميزة إلا في حال استيفاء الشروط التالية:
عنوان URL للرابط الذي يؤدي إلى إنشاء معاينة في "مستندات Google" لاستخدام هذا الحقل، يجب إعداد LinkPreviewTriggers في بيان الإضافة. لمزيد من التفاصيل، يُرجى الاطّلاع على معاينة الروابط باستخدام الشرائح الذكية.
مثال على حمولة البيانات عندما يعاين المستخدم الرابط "docs" : { "matchedUrl" : { "url" : "https://www.example.com/12345" } } |
كائن الحدث في "جداول بيانات Google"
كائن الحدث "جداول بيانات Google" هو جزء من كائن الحدث الكلي الذي يحمل معلومات عن مستند المستخدم ومحتواه. ويتوفر فقط في كائن حدث إذا كان التطبيق المضيف هو "جداول بيانات Google".
كائن الحدث في "جداول بيانات Google" | |
---|---|
sheets.id |
string لا تتوفّر هذه الميزة إلا إذا سمح المستخدم بالوصول إلى نطاق
https://www.googleapis.com/auth/drive.file . يتم فتح رقم تعريف جدول البيانات في واجهة مستخدم "جداول بيانات Google".
|
sheets.title |
string لا تتوفّر هذه الميزة إلا إذا سمح المستخدم بالوصول إلى نطاق
https://www.googleapis.com/auth/drive.file . يتم فتح عنوان جدول البيانات في واجهة مستخدم "جداول بيانات Google".
|
sheets.addonHasFileScopePermission |
boolean في حال تم رصد true ، يعني ذلك أنّ الإضافة طلبت الحصول على تفويض نطاق https://www.googleapis.com/auth/drive.file لجدول البيانات مفتوح في واجهة مستخدم "جداول بيانات Google"، وإلّا يعني ذلك أنّ الإضافة هي false .
|
sheets.matchedUrl.url |
string
لا تتوفّر هذه الميزة إلا في حال استيفاء الشروط التالية:
عنوان URL للرابط الذي ينشئ معاينة في "جداول بيانات Google". لاستخدام هذا الحقل، يجب إعداد LinkPreviewTriggers في بيان الإضافة. لمزيد من التفاصيل، يُرجى الاطّلاع على معاينة الروابط باستخدام الشرائح الذكية.
مثال على حمولة البيانات عندما يعاين المستخدم الرابط "sheets" : { "matchedUrl" : { "url" : "https://www.example.com/12345" } } |
كائن حدث "العروض التقديمية من Google"
كائن حدث "العروض التقديمية من Google" هو جزء من كائن الحدث الكلي الذي يحمل معلومات عن مستند المستخدم ومحتواه. يوجد فقط في كائن حدث إذا كان التطبيق المضيف هو Google Slides.
كائن حدث "العروض التقديمية من Google" | |
---|---|
slides.id |
string لا تتوفّر هذه الميزة إلا إذا سمح المستخدم بالوصول إلى نطاق
https://www.googleapis.com/auth/drive.file . رقم تعريف العرض التقديمي مفتوح في واجهة مستخدم "العروض التقديمية من Google".
|
slides.title |
string لا تتوفّر هذه الميزة إلا إذا سمح المستخدم بالوصول إلى نطاق
https://www.googleapis.com/auth/drive.file . عنوان العرض التقديمي مفتوح في واجهة مستخدم "العروض التقديمية من Google".
|
slides.addonHasFileScopePermission |
boolean في حال الخطأ true ، تكون الإضافة قد طلبت الحصول على تفويض نطاق https://www.googleapis.com/auth/drive.file للعرض التقديمي وتحصل عليه مفتوح في واجهة مستخدم "العروض التقديمية من Google"، وإلا سيكون هذا الحقل false .
|
slides.matchedUrl.url |
string
لا تتوفّر هذه الميزة إلا في حال استيفاء الشروط التالية:
عنوان URL للرابط الذي ينشئ معاينة في "العروض التقديمية من Google". لاستخدام هذا الحقل، يجب إعداد LinkPreviewTriggers في بيان الإضافة.
لمزيد من التفاصيل، يُرجى الاطّلاع على معاينة الروابط باستخدام الشرائح الذكية.
مثال على حمولة البيانات عندما يعاين المستخدم الرابط "slides" : { "matchedUrl" : { "url" : "https://www.example.com/12345" } } |