توضّح هذه الصفحة بنية عناصر أحداث إضافات Google Workspace.
كائنات الأحداث هي بُنى JSON يتم إنشاؤها تلقائيًا وتمريرها كمعلَمات لتشغيل أو دوال معاودة الاتصال عندما يتفاعل المستخدم مع إضافة. تتضمن كائنات الأحداث معلومات من جهة العميل حول التطبيق المضيف والسياق الحالي لوظيفة معاودة الاتصال من جهة الخادم للإضافة.
تستخدم إضافات Google Workspace عناصر الأحداث في الأماكن التالية:
مشغِّلات الصفحة الرئيسية: يتم تلقائيًا تمرير كائن حدث عند تنشيط دالة تشغيل الصفحة الرئيسية لكل دالة من دوال
homepageTrigger
التي تحدّدها. يمكنك استخدام هذا الكائن في دالة تشغيل صفحتك الرئيسية لتحديد تطبيق المضيف النشط والنظام الأساسي للعميل ولغة المستخدم ومعلومات أخرى.إنّ كائنات الأحداث التي يتم إنشاؤها عند تنشيط الصفحة الرئيسية لا تتضمّن جميع الحقول المضمّنة في الحالتَين الأخريين، وبالتالي يتم حذف الحقول المتعلّقة بالأدوات والمعلومات السياقية.
عوامل التشغيل المستندة إلى السياق: يوفر كل تطبيق مضيف مجموعة مختلفة من المشغلات السياقية التي يتم تنشيطها عندما يُدخل المستخدم سياقًا محددًا. مثلاً:
- يوفر Gmail مشغِّلاً سياقيًا للحالات التي يفتح فيها المستخدم رسالة والعامل الآخر عندما ينشئ المستخدم رسالة.
- يوفر "تقويم Google" عامل تشغيل سياقي عندما يفتح المستخدم حدثًا.
- يوفر Google Drive مشغِّلاً سياقيًا يتم استخدامه عندما يختار المستخدم ملفات Drive.
عند تنشيط مشغِّل سياقي، يستدعي التطبيق المضيف
runFunction
المقابل المدرَج في بيان الإضافة، مع تمريره كائن حدث كمَعلمة. تحتوي كائنات الأحداث التي يتم إنشاؤها عند تنشيط المشغلات السياقية على جميع الحقول المضمّنة في كائنات أحداث تشغيل الصفحة الرئيسية، بالإضافة إلى الحقول التي تحتوي على معلومات سياقية.إجراءات الأدوات. تُستخدم كائنات الأحداث أيضًا لتوفير تفاعل للأدوات، باستخدام نموذج الإجراء نفسه الذي تستخدمه إضافات Gmail. تستخدم إضافات Google Workspace جميع وظائف معالج الأدوات وكائنات
Action
واستجابات الإجراءات نفسها. ومع ذلك، في إضافات Google Workspace، تشتمل كائنات أحداث الإجراءات على مزيد من المعلومات التي يمكن لوظيفة معاودة الاتصال تنفيذ الإجراءات بناءً عليها.تحتوي كائنات الأحداث التي تم إنشاؤها نتيجة لإجراءات الأدوات على جميع الحقول المضمّنة في كائنات أحداث المشغل السياقي، بالإضافة إلى الحقول التي تحتوي على معلومات عن الأدوات.
مشغّلات روابط المعاينة: في "مستندات 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. الحد الأقصى للطول هو 2048 حرفًا. |
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 معرّف الموارد المنتظم (URI) لنقطة الدخول الحد الأقصى للطول هو 1300 حرف. ويعتمد التنسيق على نوع نقطة الدخول:
|
كائن حدث 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 في بيان الإضافة. يُرجى الاطّلاع على معاينة الروابط في "مستندات Google" للحصول على مزيد من التفاصيل.
مثال على حمولة البيانات عندما يعاين المستخدم الرابط "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 .
|
كائن حدث "العروض التقديمية من 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 .
|