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

توضّح هذه الصفحة بنية عناصر أحداث إضافات 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. كائن يحتوي على معلومات المحادثة
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: a DateTimeInput object.

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

  • A date-only picker: a DateInput object.

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

  • A time-only picker: a 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، ولا يظهر إلا في عنصر الحدث إذا كان تلك الإضافة توسّع نطاق Google Chat.

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

string (Timestamp format)

الوقت الذي حدث فيه التفاعل

حقل الربط payload بالنسبة إلى مشغّل صفحة التطبيق الرئيسية (عندما يفتح المستخدم علامة التبويب الصفحة الرئيسية)، لا يتم ضبط 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. يمكن لتطبيقات المحادثة استخدام عنصر الحدث هذا لتعبئة العناصر المقترَحة من مصدر بيانات ديناميكي. على سبيل المثال، لملء طلبات الدعم من مصدر بيانات خارجي، يمكن لتطبيق محادثة طلب البحث من مصدر البيانات استنادًا إلى ما يكتبه المستخدم في القائمة، ثم عرض طلبات الدعم المطابقة كعناصر قابلة للتحديد.

يحتوي العنصر 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، يشير ذلك إلى نوع التفاعل في مربع حوار.

قيمة التعداد 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.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)
يمثّل هذا الحقل نوع التفاعل مع مربّع حوار.

قيمة التعداد DialogEventType

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

string (int64 format)

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

قيمة التعداد AppCommandType

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

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

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

يسرد الجدول التالي الحقول المتوفّرة في حقل calendarEventObject لكائن حدث. تتوفّر الحقول التي تم وضع علامة بيانات من إنشاء المستخدم عليها في عنصر الحدث فقط إذا كانت البيانات متوفّرة في حدث "تقويم Google" وإذا ضبطت الإضافة الحقل 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". تتوفّر هذه المعلومات في عنصر الحدث إذا كانت البيانات متوفّرة في حدث "تقويم Google" وإذا كان حقل addOns.calendar.currentEventAccess manifest في الإضافة مضبوطًا على 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 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
تمثّل هذه السمة نوع حلّ المؤتمرات. تشمل القيم المحتمَلة ما يلي:
  • 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. الحد الأقصى للطول هو 2,048 حرفًا.
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:
  • 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
رمز المنطقة لرقم الهاتف مطلوب من المستخدمين إذا لم يتضمّن معرّف الموارد المنتظم رمز البلد. تستند القيم إلى قائمة رموز المناطق CLDR العامة.
entryPoint.uri string
تمثّل هذه السمة معرّف الموارد المنتظم (URI) لنقطة الدخول. يجب ألا يتجاوز عدد الأحرف 1300 حرف. يعتمد التنسيق على نوع نقطة الدخول:
  • more: يجب توفير مخطّط http: أو https:.
  • ‫phone: يجب استخدام مخطّط tel:. يجب أن يتضمّن معرّف الموارد الموحّد تسلسل الاتصال الكامل (على سبيل المثال، "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"
  }
}