توضّح هذه الصفحة بنية عناصر أحداث إضافات Google Workspace.
عناصر الأحداث هي بنى JSON يتم إنشاؤها وتمريرها تلقائيًا كمعلَمات إلى دوال التشغيل أو دوال الاستدعاء عندما يتفاعل المستخدم مع إضافة. تحمل عناصر الأحداث معلومات من جهة العميل حول التطبيق المضيف والسياق الحالي إلى دالة معاودة الاتصال من جهة الخادم الخاصة بالإضافة.
تستخدم إضافات Google Workspace عناصر الأحداث في المواضع التالية:
علامات تشغيل الصفحة الرئيسية يتم تلقائيًا تمرير عنصر حدث إلى كل دالة
homepageTrigger
تحدّدها عند تشغيل دالة مشغّل الصفحة الرئيسية. يمكنك استخدام هذا العنصر في دالة مشغّل الصفحة الرئيسية لتحديد التطبيق المضيف النشط ونظام تشغيل العميل ولغة المستخدم وغيرها من المعلومات.لا تحتوي عناصر الحدث التي يتم إنشاؤها عند تنشيط مشغّلات الصفحة الرئيسية على جميع الحقول المضمّنة في الحالتين الأخريين، إذ يتم حذف الحقول المتعلّقة بالأدوات والمعلومات السياقية.
علامات التشغيل السياقية: يوفّر كل تطبيق مضيف مجموعة مختلفة من المشغّلات السياقية التي يتم تفعيلها عندما يدخل المستخدم في سياق معيّن. على سبيل المثال:
- يوفّر Gmail مشغّلاً سياقيًا عند فتح المستخدم رسالة ومشغّلاً آخر عند إنشاء المستخدم رسالة.
- يوفّر "تقويم Google" عامل تشغيل سياقيًا عندما يفتح المستخدم حدثًا.
- يوفّر Google Drive عاملاً مشغِّلاً سياقيًا عندما يختار المستخدم ملفات Drive.
عندما يتم تشغيل مشغّل سياقي، يستدعي التطبيق المضيف الدالة
runFunction
المدرَجة في بيان الإضافة، مع تمرير كائن حدث كمعلَمة. تحتوي عناصر الحدث التي يتم إنشاؤها عند تشغيل المشغّلات السياقية على جميع الحقول المضمّنة في عناصر حدث مشغّل الصفحة الرئيسية، بالإضافة إلى الحقول التي تحتوي على معلومات سياقية.إجراءات التطبيق المصغّر تُستخدَم عناصر الأحداث أيضًا لتوفير تفاعلية الأدوات، وذلك باستخدام نموذج الإجراء نفسه الذي تستخدمه إضافات Gmail. تستخدم إضافات Google Workspace جميع وظائف معالجة الأدوات المصغّرة و
Action
والكائنات وردود الإجراءات نفسها. في المقابل، تتضمّن عناصر حدث الإجراء في إضافات Google Workspace المزيد من المعلومات التي يمكن أن تستند إليها دالة رد الاتصال.تحتوي عناصر الحدث التي يتم إنشاؤها نتيجةً لإجراءات التطبيق المصغّر على جميع الحقول المضمّنة في عناصر حدث المشغّل السياقي، بالإضافة إلى الحقول التي تحتوي على معلومات التطبيق المصغّر.
مشغّلات روابط المعاينة في "مستندات Google" و"جداول بيانات Google" و"العروض التقديمية من Google"، يمكنك ضبط معاينات الروابط للخدمات التابعة لجهات خارجية استنادًا إلى أنماط عناوين URL معيّنة. عندما يتفاعل المستخدمون مع رابط يستوفي النمط، يتم تشغيل
linkPreviewTriggers
، ويتم تمرير عنصر حدث يحتوي على الرابط إلى دالة معاودة الاتصال الخاصة بالمشغّل. يمكن أن تستخدم الإضافة عنصر الحدث هذا لإنشاء شريحة ذكية وبطاقة تعرضان معلومات حول الرابط داخل التطبيق المضيف. يمكنك أيضًا إنشاء إجراءات للويدجت تتيح للمستخدمين التفاعل مع بطاقة المعاينة ومحتواها.مشغّلات تطبيق Google Chat في Google Chat، يظهر تطبيقك الإضافي للمستخدمين كتطبيق Chat، ويمكن للمستخدمين التفاعل معه من خلال إضافته إلى المساحات وإرسال الرسائل واستخدام الأوامر التي تبدأ بشرطة مائلة وغير ذلك. لإنشاء ميزات تفاعلية، عليك إعداد واستخدام مشغّلات مختلفة لتطبيق Chat. يرسل كل مشغّل حمولة كائن حدث مختلفة تساعدك في معالجة كل نوع من أنواع التفاعلات أو الردّ عليه.
بنية عنصر الحدث
يوضّح الجدول التالي البنية ذات المستوى الأعلى لعناصر الأحداث في إضافات Google Workspace. يتضمّن بنية عنصر الحدث حقلاً commonEventObject
ذا مستوى أعلى للمعلومات المستقلة عن المضيف. يمكن أن يحتوي كل عنصر حدث أيضًا على أحد الحقول التالية على المستوى الأعلى الخاصة بالمضيف، والتي يحدّدها التطبيق المضيف النشط: gmailEventObject
أو calendarEventObject
أو driveEventObject
.
لضمان التوافق مع الإصدارات القديمة، تتضمّن عناصر أحداث إضافات Google Workspace أيضًا جميع الحقول الأصلية المستخدَمة في عناصر أحداث إجراءات إضافات Gmail. يتم إدراج هذه الحقول في الجدول أدناه ضمن "حقول الإضافة الأصلية في Gmail"، ويتم إعادة إنتاج المعلومات الواردة في هذه الحقول في بنية عنصر جديدة.
عنصر الحدث | |
---|---|
eventObject.commonEventObject |
Common fields object
كائن يحتوي على معلومات مشتركة بين جميع كائنات الأحداث، بغض النظر عن التطبيق المضيف. |
eventObject.calendar |
Calendar event object
يظهر هذا الحقل فقط إذا كان مضيف المكالمة هو "تقويم Google". كائن يحتوي على معلومات التقويم والأحداث |
eventObject.chat |
Chat event object
يظهر هذا الحقل فقط إذا كان مضيف المكالمة هو Google Chat. عنصر يحتوي على معلومات Chat. |
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 تم إيقافها نهائيًا وغير مفعّلة تلقائيًا. رمز مكوّن من حرفين يشير إلى بلد المستخدم أو منطقته. يمكن أن يكون أيضًا رمز بلد رقميًا وفقًا لمعيار 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 أي مَعلمات إضافية تقدّمها لإجراء باستخدام actionParameters أو
Action.setParameters()
معاينة للمطوّرين: بالنسبة إلى
الإضافات التي توسّع نطاق Google Chat،
لاقتراح عناصر استنادًا إلى ما يكتبه المستخدمون في قوائم الاختيار المتعدد، استخدِم قيمة المفتاح |
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
.
ويشمل ذلك قيم التاريخ أو الوقت التي يختارها المستخدم في أدوات اختيار التاريخ أو الوقت.
ومع ذلك، يختلف هيكل المعلومات حسب ما إذا تم ضبط الأداة على أداة اختيار التاريخ والوقت أو أداة اختيار التاريخ فقط أو أداة اختيار الوقت فقط. يتم توضيح الاختلافات البنيوية في الجدول التالي:
عنصر حدث المحادثة
كائن حدث Chat هو جزء من كائن الحدث العام الذي يتضمّن معلومات حول تفاعلات المستخدم مع تطبيق Chat. ولا يظهر إلا في كائن الحدث إذا كان توسيع التطبيق يضيف وظائف إلى Google Chat.
Chat | |
---|---|
chat.user |
object
(User)
مستخدم Chat الذي تفاعل مع تطبيق Chat |
chat.space |
object
(Space)
مساحة Chat التي تفاعل فيها المستخدم مع تطبيق Chat. |
chat.eventTime |
|
حقل الدمج يمكن أن تكون |
|
chat.messagePayload |
الحِزمة التي تتلقّاها تطبيقات Chat من مشغّل رسالة |
chat.addedToSpacePayload |
حمولة البيانات التي تتلقّاها تطبيقات Chat من مشغّل تمت إضافته إلى مساحة |
chat.removedFromSpacePayload |
حمولة البيانات التي تتلقّاها تطبيقات Chat من مشغّل تمت الإزالة من المساحة |
chat.buttonClickedPayload |
الحِمل الذي تتلقّاه تطبيقات Chat عندما ينقر المستخدمون على زر من رسالة أو بطاقة. إذا نقر المستخدم على زر لإرسال المعلومات، سيحتوي العنصر |
chat.widgetUpdatedPayload |
الحِمل الذي تتلقّاه تطبيقات Chat عندما يكتب المستخدمون نصًا في قائمة الاختيار المتعدد الخاصة بأداة
يحتوي العنصر
|
chat.appCommandPayload |
الحِزمة التي تتلقّاها تطبيقات Chat عندما يستخدم المستخدم أمرًا من تطبيق Chat |
الحمولة
استنادًا إلى نوع التفاعل مع تطبيق Chat، يحتوي الحدث على حمولة تتضمّن مرجعًا واحدًا أو أكثر من مراجع Chat API.
حمولة الرسالة
MessagePayload | |
---|---|
chat.messagePayload.message |
object
(Message)
رسالة Chat التي أدت إلى الحدث. |
chat.messagePayload.space |
object
(Space)
مساحة Chat التي أرسل فيها المستخدم الرسالة التي استدعت تطبيق Chat |
chat.messagePayload.configCompleteRedirectUri |
string عنوان URL الذي يجب أن يعيد تطبيق Chat توجيه المستخدم إليه بعد إكمال عملية تفويض أو إعداد خارج Google Chat. لمزيد من المعلومات، يُرجى الاطّلاع على ربط إضافة Google Workspace بخدمة خارجية. |
تمت إضافة حمولة المساحة
AddedToSpacePayload | |
---|---|
chat.addedToSpacePayload.space |
object
(Space)
مساحة Chat التي أضاف إليها المستخدم تطبيق Chat أو ثبّته فيها. عندما يثبّت المشرفون تطبيقات Chat، يتم ضبط الحقل
|
chat.addedToSpacePayload.interactionAdd |
boolean ما إذا كان المستخدم يضيف تطبيق Chat إلى مساحة باستخدام رسالة على سبيل المثال، الإشارة إلى تطبيق Chat باستخدام @ أو استخدام أمر. إذا كان true ، يرسل Chat كائن حدث آخر يتضمّن messagePayload يحتوي على معلومات حول الرسالة.
|
chat.addedToSpacePayload.configCompleteRedirectUri |
string عنوان URL الذي يجب أن يعيد تطبيق Chat توجيه المستخدم إليه بعد إكمال عملية تفويض أو إعداد خارج Google Chat. لمزيد من المعلومات، يُرجى الاطّلاع على ربط إضافة Google Workspace بخدمة خارجية. |
حمولة تمت إزالتها من المساحة
RemovedFromSpacePayload | |
---|---|
chat.removedFromSpacePayload.space |
object
(Space)
مساحة Chat التي أزال المستخدم منها تطبيق Chat أو ألغى تثبيته. عندما يلغي المشرفون تثبيت تطبيقات Chat، يتم ضبط الحقل
|
حمولة النقر على الزر
ButtonClickedPayload | |
---|---|
chat.buttonClickedPayload.message |
object
(Message)
رسالة Chat التي تحتوي على الزر الذي نقر عليه المستخدم. |
chat.buttonClickedPayload.space |
object
(Space)
مساحة Chat التي نقر فيها المستخدم على زر من رسالة تطبيق Chat |
chat.buttonClickedPayload.isDialogEvent |
boolean تُستخدَم لتحديد ما إذا نقر المستخدم على الزر للتفاعل مع مربّع حوار. |
chat.buttonClickedPayload.dialogEventType |
enum (DialogEventType) إذا كانت قيمة isDialogEvent هي true ، يشير ذلك إلى نوع
التفاعل في مربّع حوار.
|
قيمة التعداد يمكن أن تكون قيمة |
|
TYPE_UNSPECIFIED |
القيمة التلقائية غير محدد |
REQUEST_DIALOG |
يطلب المستخدم ظهور مربّع حوار. على سبيل المثال، يستخدمون أمرًا أو ينقرون على زر من رسالة. |
SUBMIT_DIALOG |
ينقر المستخدم على عنصر تفاعلي ضمن مربّع حوار. على سبيل المثال، يملأ المستخدم المعلومات في مربّع حوار وينقر على زر لإرسال المعلومات. |
حمولة التطبيق المصغَّر المُحدَّثة
WidgetUpdatedPayload | |
---|---|
chat.widgetUpdatedPayload.space |
object
(Space)
مساحة Chat التي حدث فيها التفاعل |
حمولة أمر التطبيق
AppCommandPayload | |
---|---|
chat.appCommandPayload.appCommandMetadata |
object
(AppCommandMetadata)
بيانات وصفية حول الأمر الذي استخدمه المستخدم وكيفية تنفيذه. |
chat.appCommandPayload.space |
object
(Space)
مساحة Chat التي استخدم فيها المستخدم الأمر |
chat.appCommandPayload.thread |
object
(Thread)
إذا حدث التفاعل في سلسلة محادثات، تكون سلسلة محادثات Chat التي استخدم فيها المستخدم الأمر. |
chat.appCommandPayload.message |
object
(Message)
بالنسبة إلى الأوامر التي تبدأ بشرطة مائلة، الرسالة التي تحتوي على الأمر الذي يبدأ بشرطة مائلة |
chat.appCommandPayload.configCompleteRedirectUri |
string إذا كان الأمر يتطلّب تفويضًا أو إعدادًا، سيظهر عنوان URL لإعادة توجيه المستخدم إليه بعد إكمال العملية خارج Google Chat. |
chat.appCommandPayload.isDialogEvent |
boolean تحدّد هذه السمة ما إذا كان الأمر يفتح مربّع حوار. |
chat.appCommandPayload.dialogEventType |
enum (DialogEventType) يمثّل هذا الحقل نوع التفاعل مع مربّع حوار. |
قيمة التعداد يمكن أن تكون قيمة |
|
TYPE_UNSPECIFIED |
القيمة التلقائية غير محدد |
REQUEST_DIALOG |
يطلب المستخدم ظهور مربّع حوار. على سبيل المثال، يستخدمون أمرًا أو ينقرون على زر من رسالة. |
SUBMIT_DIALOG |
ينقر المستخدم على عنصر تفاعلي ضمن مربّع حوار. على سبيل المثال، يملأ المستخدم المعلومات في مربّع حوار وينقر على زر لإرسال المعلومات. |
البيانات الوصفية لأوامر التطبيقات
AppCommandMetadata | |
---|---|
chat.appCommandPayload.appCommandMetadata.appCommandId |
معرّف الأمر |
chat.appCommandPayload.appCommandMetadata.appCommandType |
enum (AppCommandType) نوع الأمر. |
قيمة التعداد يمكن أن تكون قيمة |
|
APP_COMMAND_TYPE_UNSPECIFIED |
القيمة التلقائية غير محدد |
SLASH_COMMAND |
يستخدم أحد المستخدمين الأمر من خلال إرسال رسالة تبدأ بشرطة مائلة / . |
QUICK_COMMAND |
يختار المستخدم الأمر من قائمة Chat في مساحة الرد على الرسالة. |
عنصر حدث التقويم
عنصر حدث التقويم هو جزء من عنصر الحدث العام الذي يتضمّن معلومات حول تقويم المستخدم وأحداث التقويم. لا يظهر هذا الحقل في عنصر الحدث إلا إذا كانت الإضافة توسّع نطاق "تقويم 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
manifest على 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
manifest في
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 رمز المنطقة لرقم الهاتف. مطلوب من المستخدمين إذا لم يتضمّن معرّف الموارد المنتظم رمز البلد. تستند القيم إلى قائمة رموز المناطق 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 في ملف البيان الخاص بالإضافة. يمكنك الاطّلاع على معاينة الروابط باستخدام الشرائح الذكية لمزيد من التفاصيل.
مثال على الحمولة عندما يعاين المستخدم الرابط "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".
عنصر الحدث في "العروض التقديمية من 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" } } |