كائنات الأحداث

توضّح هذه الصفحة بنية عناصر الأحداث في إضافات Google Workspace.

كائنات الأحداث هي بُنى JSON يتم إنشاؤها وتمريرها تلقائيًا كمَعلمات إلى دوال المشغّلات أو دوال رد الاتصال عندما يتفاعل المستخدم مع إضافة. تحمل عناصر الأحداث معلومات من جهة العميل حول التطبيق المضيف والسياق الحالي إلى دالة رد الاتصال من جهة الخادم للإضافة.

تستخدم إضافات Google Workspace عناصر الأحداث في الأماكن التالية:

  • عوامل تشغيل الصفحة الرئيسية: يتم تلقائيًا تمرير كائن حدث لكل دالة homepageTrigger تحدّدها عند تنشيط دالة مشغّل الصفحة الرئيسية. يمكنك استخدام هذا العنصر في دالة تشغيل الصفحة الرئيسية لتحديد التطبيق المضيف النشط والنظام الأساسي للعميل ولغة المستخدم ومعلومات أخرى.

    لا تحتوي عناصر الأحداث التي يتم إنشاؤها عند تنشيط مشغّلات الصفحة الرئيسية على جميع الحقول المضمّنة في الحالات الأخرى، ويتم حذف الحقول المتعلّقة بالتطبيقات المصغّرة والمعلومات السياقية.

  • المحفّزات السياقية: يوفّر كل تطبيق مضيف مجموعة مختلفة من المشغّلات السياقية التي يتم تفعيلها عندما يدخل المستخدم في سياق معيّن:

    عندما يتم تنشيط مشغّل سياقي، يستدعي التطبيق المضيف 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 الأصلية" وليست جزءًا من commonEventObject.

تم إيقاف حقول إضافة ميزات Gmail الأصلية نهائيًا. عند تطوير أو نقل إضافة Google Workspace، استخدِم بنية كائن الحدث الأحدث بدلاً من ذلك. وقد تتم إزالة هذه الحقول في تحديث مستقبلي.

كائن الحدث
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.gmail.accessToken.

eventObject.messageMetadata.messageId string
متوقّف نهائيًا. رقم تعريف الرسالة لسلسلة المحادثات المفتوحة في واجهة مستخدم Gmail

بالنسبة إلى إضافات Google Workspace، يمكنك العثور على هذه المعلومات في الحقل eventObject.gmail.messageId.

eventObject.clientPlatform string
متوقّف نهائيًا. تشير إلى مصدر الحدث (الويب أو iOS أو Android).

بالنسبة إلى إضافات Google Workspace، يمكنك العثور على هذه المعلومات في الحقل eventObject.commonEventObject.platform.

eventObject.formInput object
متوقّف نهائيًا. تمثّل هذه السمة خريطة للقيم الحالية لجميع التطبيقات المصغّرة للنماذج في البطاقة، وتقتصر على قيمة واحدة لكل تطبيق مصغّر. المفاتيح هي معرّفات السلاسل المرتبطة بعناصر واجهة المستخدم، والقيم هي سلاسل. يوفّر عنصر الحدث formInput لتسهيل قراءة البيانات من تطبيقات مصغّرة متعددة ذات قيم مفردة متوقعة، مثل حقول إدخال النص ومفاتيح التبديل. بالنسبة إلى التطبيقات المصغّرة المتعددة القيم، مثل مربّعات الاختيار، يمكنك قراءة كل قيمة من formInputs بدلاً من ذلك.

بالنسبة إلى إضافات Google Workspace، يمكنك العثور على هذه المعلومات في الحقل eventObject.commonEventObject.formInputs بدلاً من ذلك، ويتم تمثيل التطبيقات المصغّرة ذات القيم الفردية كمصفوفات تحتوي على عنصر واحد.

eventObject.formInputs object
متوقّف نهائيًا. تمثّل هذه السمة خريطة للقيم الحالية لعناصر واجهة المستخدم في البطاقة، ويتم عرضها كقوائم سلاسل. المفاتيح هي معرّفات السلاسل المرتبطة بالأداة. بالنسبة إلى التطبيقات المصغّرة ذات القيمة الواحدة، يتم عرض القيمة في مصفوفة ذات عنصر واحد. بالنسبة إلى التطبيقات المصغّرة المتعددة القيم، مثل مجموعات مربّعات الاختيار، يتم عرض جميع القيم في قائمة.

بالنسبة إلى إضافات Google Workspace، يمكنك العثور على هذه المعلومات في الحقل eventObject.commonEventObject.formInputs.

eventObject.parameters object
متوقّف نهائيًا. تمثّل هذه السمة خريطة لأي مَعلمات إضافية تقدّمها إلى Action باستخدام Action.setParameters. وتكون مفاتيح الخريطة وقيمها عبارة عن سلاسل.

بالنسبة إلى إضافات Google Workspace، يمكنك العثور على هذه المعلومات في الحقل eventObject.commonEventObject.parameters.

eventObject.userCountry string
تم إيقاف هذه الميزة نهائيًا وهي غير مفعَّلة تلقائيًا. يشير الرمز المكوّن من حرفَين إلى بلد المستخدم أو منطقته. ويمكن أن يكون أيضًا رمز بلد رقميًا وفقًا لمعيار UN M49.

بالنسبة إلى إضافات Google Workspace، يمكنك العثور على هذه المعلومات في الحقل eventObject.commonEventObject.userLocale.

eventObject.userLocale string
تم إيقاف هذه الميزة نهائيًا وهي غير مفعَّلة تلقائيًا. رمز ISO 639 المكوّن من حرفَين والذي يشير إلى لغة المستخدم لمزيد من التفاصيل، يُرجى الاطّلاع على الوصول إلى المنطقة الزمنية والإعدادات المحلية للمستخدم.

بالنسبة إلى إضافات Google Workspace، يمكنك العثور على هذه المعلومات في الحقل eventObject.commonEventObject.userLocale.

eventObject.userTimezone.id string
تم إيقاف هذه الميزة نهائيًا وهي غير مفعَّلة تلقائيًا. معرّف المنطقة الزمنية للمستخدم على سبيل المثال: America/New_York وEurope/Vienna وAsia/Seoul. لمزيد من التفاصيل، يُرجى الاطّلاع على الوصول إلى اللغة والمنطقة الزمنية للمستخدم.

بالنسبة إلى إضافات Google Workspace، يمكنك العثور على هذه المعلومات في الحقل eventObject.commonEventObject.timeZone.id.

eventObject.userTimezone.offset string
تم إيقاف هذه الميزة نهائيًا وهي غير مفعَّلة تلقائيًا. يمثّل فرق التوقيت عن التوقيت العالمي المنسّق (UTC) للمنطقة الزمنية الخاصة بالمستخدم، ويتم قياسه بالملي ثانية. لمزيد من التفاصيل، يُرجى الاطّلاع على الوصول إلى اللغة والمنطقة الزمنية للمستخدم.

بالنسبة إلى إضافات Google Workspace، يمكنك العثور على هذه المعلومات في الحقل eventObject.commonEventObject.timeZone.offset.

كائن الحدث الشائع

كائن الحدث الشائع هو جزء من كائن الحدث العام الذي يحمل معلومات عامة مستقلة عن المضيف إلى الإضافة من برنامج المستخدم. وتشمل هذه المعلومات تفاصيل مثل لغة المستخدم والتطبيق المضيف والمنصة.

بالإضافة إلى الصفحة الرئيسية والمشغّلات السياقية، تنشئ الإضافات كائنات الأحداث وتمرّرها إلى دوال رد الاتصال للإجراءات عندما يتفاعل المستخدم مع التطبيقات المصغّرة. يمكن لدالّة رد الاتصال في الإضافة الاستعلام عن كائن الحدث الشائع لتحديد محتوى التطبيقات المصغّرة المفتوحة في برنامج المستخدم. على سبيل المثال، يمكن لإضافتك تحديد مكان النص الذي أدخله المستخدم في تطبيق مصغّر TextInput في الكائن eventObject.commentEventObject.formInputs.

حقول كائن الحدث الشائعة
commonEventObject.platform string
يشير إلى مصدر الحدث (`WEB` أو `IOS` أو `ANDROID`).
commonEventObject.formInputs object
خريطة تحتوي على القيم الحالية للويدجت في البطاقة المعروضة مفاتيح الخريطة هي معرّفات السلسلة المخصّصة لكل تطبيق مصغّر.

تعتمد بنية عنصر قيمة الخريطة على نوع التطبيق المصغّر:

  • التطبيقات المصغّرة ذات القيمة الواحدة (مثل مربّع النص): قائمة بالسلاسل (عنصر واحد فقط)

    مثال: بالنسبة إلى تطبيق مصغّر لإدخال النص يحمل المعرّف employeeName، يمكنك الوصول إلى قيمة إدخال النص باستخدام: e.commonEventObject.formInputs.employeeName.stringInputs.value[0]

  • عناصر واجهة المستخدم المتعددة القيم (مثل مجموعات مربّعات الاختيار): قائمة بالسلاسل

    مثال: بالنسبة إلى تطبيق مصغّر متعدد القيم يحمل المعرّف participants، يمكنك الوصول إلى مصفوفة القيم باستخدام e.commonEventObject.formInputs.participants.stringInputs.value.

  • ‫A date-time picker: DateTimeInput object.

    مثال: بالنسبة إلى أداة اختيار برقم تعريف myDTPicker، يمكنك الوصول إلى عنصر DateTimeInput باستخدام e.commonEventObject.formInputs.myDTPicker.dateTimeInput.

  • A date-only picker: DateInput object.

    مثال: بالنسبة إلى أداة اختيار برقم تعريف myDatePicker، يمكنك الوصول إلى عنصر DateInput باستخدام e.commonEventObject.formInputs.myDatePicker.dateInput.

  • A time-only picker: TimeInput object.

    مثال: بالنسبة إلى أداة اختيار برقم تعريف myTimePicker، يمكنك الوصول إلى عنصر TimeInput باستخدام e.commonEventObject.formInputs.myTimePicker.timeInput.
commonEventObject.hostApp string
تشير إلى التطبيق المضيف الذي تكون الإضافة نشطة فيه عند إنشاء عنصر الحدث. تشمل القيم المحتملة ما يلي:
  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
commonEventObject.parameters object
أي مَعلمات إضافية تقدّمها لإجراء معيّن باستخدام actionParameters أو Action.setParameters.

معاينة المطوّر: بالنسبة إلى تطبيقات Google Chat، لاقتراح عناصر استنادًا إلى ما يكتبه المستخدمون في قوائم الاختيار المتعدّد، استخدِم قيمة المفتاح "autocomplete_widget_query" (event.commonEventObject.parameters["autocomplete_widget_query"]). يمكنك استخدام هذه القيمة لطلب البحث في قاعدة بيانات واقتراح عناصر قابلة للاختيار للمستخدمين أثناء الكتابة. لمعرفة التفاصيل، يُرجى الاطّلاع على مقالة جمع المعلومات من مستخدمي Google Chat ومعالجتها.
commonEventObject.userLocale string
غير مفعَّل تلقائيًا تمثّل هذه السمة معرّف لغة المستخدِم وبلده/منطقته بتنسيق رمز اللغة ISO 639-رمز البلد/المنطقة ISO 3166. على سبيل المثال، en-US.

لتفعيل هذا الحقل، يجب ضبط addOns.common.useLocaleFromApp على true في ملف بيان الإضافة. يجب أن تتضمّن قائمة نطاقات الإضافة أيضًا https://www.googleapis.com/auth/script.locale. لمزيد من التفاصيل، يُرجى الاطّلاع على الوصول إلى اللغة والمنطقة الزمنية للمستخدم.

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. ويشمل ذلك قيم التاريخ أو الوقت التي اختارها المستخدم في التطبيقات المصغّرة لاختيار التاريخ أو الوقت. تختلف بنية المعلومات حسب ما إذا تم ضبط التطبيق المصغّر كأداة اختيار التاريخ والوقت أو أداة اختيار التاريخ فقط أو أداة اختيار الوقت فقط. في ما يلي الاختلافات في البنية:

عنصر DateTimeInput
dateTimeInput.hasDate boolean
true إذا كان التاريخ والوقت المُدخلان يتضمّنان تاريخًا، وfalse إذا كانا يتضمّنان وقتًا فقط
dateTimeInput.hasTime boolean
true إذا كان التاريخ والوقت المُدخلان يتضمّنان وقتًا، وfalse إذا كانا يتضمّنان تاريخًا فقط
dateTimeInput.msSinceEpoch string
الوقت الذي اختاره المستخدم، بالملي ثانية منذ بداية حقبة يونكس (00:00:00 بالتوقيت العالمي المنسق في 1 يناير 1970).
عنصر DateInput
dateInput.msSinceEpoch string
الوقت الذي اختاره المستخدم، بالملي ثانية منذ بداية حقبة يونكس (00:00:00 بالتوقيت العالمي المنسق في 1 يناير 1970).
عنصر TimeInput
timeInput.hours number
رقم الساعة الذي اختاره المستخدم
timeInput.minutes number
رقم الدقيقة الذي اختاره المستخدم

عنصر حدث Chat

كائن حدث Chat هو جزء من كائن الحدث العام الذي يحمل معلومات حول تفاعلات المستخدم مع تطبيق Chat. ولا يتوفّر إلا في كائن حدث إذا كانت الإضافة توسّع Google Chat.

محادثة
chat.user object (User)
مستخدم Chat الذي تفاعل مع تطبيق Chat
chat.space object (Space)
مساحة Chat التي تفاعل فيها المستخدم مع تطبيق Chat
chat.eventTime

string (Timestamp format)

وقت حدوث التفاعل

حقل الربط payload بالنسبة إلى مشغّل App Home (عندما يفتح المستخدم علامة التبويب Home)، لا يتم ضبط payload ويحتوي chat على chat.user وchat.eventTime.

يمكن أن يكون التعليق payload إحدى القيم التالية فقط:
chat.messagePayload

object (MessagePayload)

الحمولة التي تتلقّاها تطبيقات Chat من مشغّل رسالة.
chat.addedToSpacePayload

object (AddedToSpacePayload)

الحمولة التي تتلقّاها تطبيقات Chat من مشغّل تمت الإضافة إلى المساحة.
chat.removedFromSpacePayload

object (RemovedFromSpacePayload)

الحمولة التي تتلقّاها تطبيقات Chat من مشغّل تمت الإزالة من المساحة.
chat.buttonClickedPayload

object (ButtonClickedPayload)

الحمولة التي تتلقّاها تطبيقات Chat عندما ينقر المستخدمون على زر من رسالة أو بطاقة. إذا نقر مستخدم على زر لإرسال معلومات، يحتوي الكائن commonEventObject.formInputs على القيم التي تم جمعها من المستخدم. لمعرفة التفاصيل، يُرجى الاطّلاع على مقالة جمع المعلومات من مستخدمي Google Chat.
chat.widgetUpdatedPayload

object (WidgetUpdatedPayload)

تمثّل هذه السمة الحمولة التي تتلقّاها تطبيقات Chat عندما يكتب المستخدمون نصًا في قائمة الاختيار المتعدّد في تطبيق مصغّر من النوع selectionInput. يمكن لتطبيقات Chat استخدام عنصر الحدث هذا لتعبئة العناصر المقترَحة من مصدر بيانات ديناميكي. على سبيل المثال، لتعبئة طلبات الحصول على الدعم من مصدر بيانات خارجي، يمكن لتطبيق Chat الاستعلام عن مصدر البيانات استنادًا إلى ما يكتبه المستخدم في القائمة، ثم عرض طلبات الحصول على الدعم المطابقة كعناصر قابلة للاختيار.

يحتوي الكائن CommonEventObject.parameters['autocomplete_widget_query'] على قيمة السلسلة التي يكتبها المستخدم في القائمة.

chat.appCommandPayload

object (AppCommandPayload)

تمثّل هذه السمة الحمولة التي تتلقّاها تطبيقات Chat عندما يستخدم المستخدم أمرًا من تطبيق Chat.

الحمولة

استنادًا إلى نوع تفاعل تطبيق Chat، يحتوي الحدث على حمولة تتضمّن موردًا واحدًا أو أكثر من موارد Chat API.

حمولة الرسالة
MessagePayload
chat.messagePayload.message object (Message)
رسالة المحادثة التي أدّت إلى إنشاء الحدث
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، يتم ضبط الحقل space.adminInstalled على true.

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، يتم ضبط الحقل space.adminInstalled على false.

حمولة الزر الذي تم النقر عليه
ButtonClickedPayload
chat.buttonClickedPayload.message object (Message)
رسالة المحادثة التي تحتوي على الزر الذي نقر عليه المستخدم
chat.buttonClickedPayload.space object (Space)
مساحة Chat التي نقر فيها المستخدم على زر من رسالة تطبيق Chat
chat.buttonClickedPayload.isDialogEvent boolean
ما إذا نقر المستخدم على الزر للتفاعل مع مربّع حوار.
chat.buttonClickedPayload.dialogEventType enum (DialogEventType)
إذا كانت قيمة isDialogEvent هي true، يشير ذلك إلى نوع التفاعل في مربّع حوار.

Enum DialogEventType.

يمكن أن تكون قيمة dialogEventType إحدى القيم التالية فقط:
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)
نوع التفاعل مع مربّع حوار

Enum DialogEventType.

يمكن أن تكون قيمة dialogEventType إحدى القيم التالية فقط:
TYPE_UNSPECIFIED القيمة التلقائية غير محدد
REQUEST_DIALOG يطلب المستخدم مربّع حوار. على سبيل المثال، يمكنهم استخدام أمر أو النقر على زر من رسالة.
SUBMIT_DIALOG ينقر المستخدم على عنصر تفاعلي داخل مربّع حوار. على سبيل المثال، يملأ المستخدم المعلومات في مربّع حوار وينقر على زر لإرسال المعلومات.
البيانات الوصفية لأوامر التطبيقات
AppCommandMetadata
chat.appCommandPayload.appCommandMetadata.appCommandId

string (int64 format)

معرّف الأمر
chat.appCommandPayload.appCommandMetadata.appCommandType enum (AppCommandType)
نوع الطلب

Enum AppCommandType.

يمكن أن تكون قيمة AppCommandType إحدى القيم التالية فقط:
APP_COMMAND_TYPE_UNSPECIFIED القيمة التلقائية غير محدد
SLASH_COMMAND يستخدم المستخدم الأمر عن طريق إرسال رسالة تبدأ بشرطة مائلة /.
QUICK_COMMAND يختار المستخدم الأمر من قائمة Chat في قسم الرد على الرسائل.

عنصر حدث في التقويم

كائن حدث "تقويم Google" هو جزء من كائن الحدث العام الذي يحمل معلومات حول تقويم المستخدم وأحداث التقويم. لا يتوفّر هذا الحقل إلا في كائن حدث إذا كانت الإضافة توسّع "تقويم Google".

يسرد الجدول التالي الحقول الموجودة في حقل calendarEventObject لكائن حدث. تكون الحقول التي تم وضع علامة بيانات من إنشاء المستخدم عليها موجودة في عنصر الحدث فقط إذا كانت البيانات موجودة في حدث في التقويم وضبطت الإضافة حقل addOns.calendar.currentEventAccess البيان على READ أو READ_WRITE.

بالنسبة إلى العديد من الحقول في هذا العنصر وبنياته الفرعية، هناك ربط مباشر بحقول مورد الحدث في Calendar API التي تحمل الاسم نفسه. إذا اختلفت أوصاف الحقول، تكون المعلومات الواردة في الجدول التالي صحيحة.

عنصر حدث في التقويم
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". تتوفّر هذه المعلومات في عنصر الحدث إذا وفقط إذا كانت البيانات متوفّرة في حدث في التقويم وتضبط الإضافة حقل 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
حالة ردّ المشارك تشمل القيم المحتملة ما يلي:
  • accepted: قبل المشارك دعوة الحدث.
  • declined: رفض المشارِك دعوة الحدث.
  • needsAction: لم يردّ المشارِك على دعوة الحدث.
  • tentative: وافق المشارك على دعوة الحدث بشكل مبدئي.
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
نوع المنصة لمكالمات الفيديو تشمل القيم المحتملة ما يلي:
  • eventHangout لتطبيق Hangouts للمستهلكين (http://hangouts.google.com).
  • eventNamedHangout لتطبيق Hangouts الكلاسيكي لمستخدمي Google Workspace‏ (http://hangouts.google.com).
  • hangoutsMeet لتطبيق Google Meet (http://meet.google.com).
conferenceData.conferenceSolution.name string
اسم منصة مكالمات الفيديو هذه الذي يظهر للمستخدم (غير مترجَم)
conferenceData.entryPoints[] list of entry point objects
قائمة بنقاط الدخول إلى الاجتماع، مثل عناوين URL أو أرقام الهواتف
conferenceData.notes string
ملاحظات إضافية (مثل تعليمات من مشرف النطاق أو إشعارات قانونية) حول الاجتماع لعرضها للمستخدم. يمكن أن يحتوي على HTML. الحد الأقصى للطول هو 2048 حرفًا.
conferenceData.parameters object
عنصر يحتوي على خريطة لبيانات المَعلمات المحدّدة لاستخدامها من قِبل الإضافة.
conferenceData.parameters.addOnParameters object
تمثّل هذه المَعلمة خريطة لمفاتيح وقيم سلاسل المَعلمات. يتم تحديد هذه المفاتيح والقيم من قِبل مطوّر الإضافة لإرفاق معلومات باجتماع معيّن لاستخدام الإضافة.

نقطة الإدخال

تحمل عناصر نقطة الدخول معلومات حول الوسائل المحددة للوصول إلى اجتماع معين، مثل الهاتف أو الفيديو. تتوفّر هذه المعلومات في عنصر الحدث فقط في حال توفّر البيانات في حدث في التقويم وضبط الإضافة لحقل addOns.calendar.currentEventAccess البيان على READ أو READ_WRITE.

عنصر نقطة الدخول
entryPoint.accessCode string
رمز الوصول المستخدَم للوصول إلى المؤتمر. الحد الأقصى للطول هو 128 حرفًا. عادةً ما يستخدم مقدّمو خدمات الاجتماعات مجموعة فرعية فقط من {accessCode وmeetingCode وpasscode وpassword وpin} لتوفير إمكانية الوصول إلى الاجتماعات. يجب مطابقة الحقول التي يستخدمها موفّر خدمة الاجتماعات وعرضها فقط.
entryPoint.entryPointFeatures list
ميزات نقطة الدخول في الوقت الحالي، تنطبق هذه الميزات على نقطتَي الدخول (phone) التاليتَين فقط:
  • ‫toll: نقطة الدخول هي مكالمة هاتفية برسوم.
  • ‫toll_free: نقطة الدخول هي مكالمة هاتفية مجانية.
entryPoint.entryPointType string
نوع نقطة الدخول القيم المحتمَلة هي:
  • more: تعليمات إضافية للانضمام إلى الاجتماع، مثل أرقام الهواتف البديلة يمكن أن يحتوي اجتماع الفيديو على نقطة دخول واحدة فقط من النوع more، وفي حال توفّرها، يجب أيضًا توفّر نوع آخر واحد على الأقل من نقاط الدخول.
  • ‫phone: للانضمام إلى المؤتمر عبر رقم هاتف ويمكن أن يتضمّن الاجتماع صفرًا أو أكثر من نقاط الدخول phone. يعرض "تقويم Google" أول نقطتَي دخول عبر الهاتف فقط، بعد التنسيق والترتيب أبجديًا.
  • ‫sip: للانضمام إلى المؤتمر عبر بروتوكول SIP يمكن أن يحتوي اجتماع الفيديو على نقطة دخول واحدة من النوع sip كحد أقصى.
  • ‫video: للانضمام إلى الاجتماع عبر HTTP يمكن أن يحتوي اجتماع الفيديو على نقطة دخول واحدة من النوع video كحد أقصى.
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 حرف. يعتمد التنسيق على نوع نقطة الدخول:
  • ‫more: يجب استخدام مخطط http: أو https:.
  • ‫phone: يجب توفير مخطط tel:. يجب أن يتضمّن معرّف الموارد المنتظم (URI) تسلسل الاتصال بالكامل (على سبيل المثال، "tel:+12345678900,,,12345678;1234").
  • ‫sip: يجب استخدام مخطط sip: أو sips:. على سبيل المثال، "sip:12345678@myprovider.com".
  • ‫video: يجب استخدام مخطط http: أو https:.

عنصر حدث 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 لمنح الإضافة إمكانية الوصول المؤقت إلى رسالة 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
لا تظهر إلا في حال استيفاء الشروط التالية:
  • تم منح الإذن لـ "https://www.googleapis.com/auth/workspace.linkpreview" من قِبل المستخدم.
  • يتطابق عنوان URL مع نمط المضيف المحدّد في مشغّل LinkPreviewTriggers.

عنوان URL للرابط الذي ينشئ معاينة في "مستندات Google". لاستخدام هذا الحقل، عليك ضبط LinkPreviewTriggers في بيان الإضافة. يمكنك الاطّلاع على معاينة الروابط باستخدام الشرائح الذكية لمزيد من التفاصيل.

مثال على الحمولة عندما يعاين المستخدم الرابط https://www.example.com/12345: 

"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
لا تظهر إلا في حال استيفاء الشروط التالية:
  • تم منح الإذن لـ "https://www.googleapis.com/auth/workspace.linkpreview" من قِبل المستخدم.
  • يتطابق عنوان URL مع نمط المضيف المحدّد في مشغّل LinkPreviewTriggers.

عنوان URL للرابط الذي ينشئ معاينة في "جداول بيانات Google". لاستخدام هذا الحقل، اضبط LinkPreviewTriggers في بيان الإضافة. يمكنك الاطّلاع على معاينة الروابط باستخدام الشرائح الذكية لمزيد من التفاصيل.

مثال على الحمولة عندما يعاين المستخدم الرابط https://www.example.com/12345:

"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
لا تظهر إلا في حال استيفاء الشروط التالية:
  • تم منح الإذن لـ "https://www.googleapis.com/auth/workspace.linkpreview" من قِبل المستخدم.
  • يتطابق عنوان URL مع نمط المضيف المحدّد في مشغّل LinkPreviewTriggers.

عنوان URL للرابط الذي ينشئ معاينة في "العروض التقديمية من Google" لاستخدام هذا الحقل، عليك ضبط LinkPreviewTriggers في ملف بيان الإضافة. يمكنك الاطّلاع على معاينة الروابط باستخدام الشرائح الذكية لمزيد من التفاصيل.

مثال على الحمولة عندما يعاين المستخدم الرابط https://www.example.com/12345:

"slides" : {
  "matchedUrl" : {
      "url" : "https://www.example.com/12345"
  }
}