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

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

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

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

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

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

  • العوامل المشغِّلة السياقية: يقدّم كل تطبيق مضيف مجموعة مختلفة من عوامل التفعيل السياقية التي يتم تفعيلها عندما يدخل المستخدم سياقًا معيّنًا. على سبيل المثال:

    • يقدّم Gmail عامل تشغيل سياقيًا عندما يفتح مستخدم رسالة وعامل تشغيل آخر عندما ينشئ مستخدم رسالة.
    • يقدّم "تقويم Google" عامل تشغيل سياقيًا عندما يفتح مستخدم حدثًا.
    • يوفّر Google Drive عامل تشغيل سياقيًا عندما يختار أحد المستخدِمين ملفات Drive.

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

  • إجراءات التطبيقات المصغّرة تُستخدَم عناصر الأحداث أيضًا لتوفير تفاعل لشريحة التطبيق ، باستخدام نموذج الإجراءات نفسه الذي تستخدمه إضافات Gmail . تستخدِم إضافات Google Workspace جميع وظائف معالِج التطبيقات المصغّرة والعناصر Action والاستجابات للإجراءات نفسها. في المقابل، في إضافات Google Workspace، تشمل عناصر أحداث الإجراءات مزيدًا من المعلومات التي يمكن لوظيفة الاستدعاء الردّ عليها.

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

  • عوامل تشغيل معاينة الرابط في "مستندات Google" و"جداول بيانات Google" و"العروض التقديمية من Google"، يمكنك ضبط معاينات الروابط للخدمات التابعة لجهات خارجية استنادًا إلى أنماط عناوين URL معيّنة. عندما يتفاعل المستخدمون مع رابط يلبي والنمط، linkPreviewTriggers ويتم تمرير كائن حدث يحتوي على الرابط إلى ملف . يمكن أن تستخدم الإضافة كائن الحدث هذا لإنشاء شريحة ذكية وبطاقة تعرضان معلومات حول الرابط داخل المضيف التطبيق. يمكنك أيضًا إنشاء إجراءات التطبيقات المصغّرة للسماح للمستخدمين بالتفاعل مع بطاقة المعاينة ومحتوياتها.

بنية عنصر الحدث

يوضح الجدول التالي هيكل المستوى الأعلى كائنات أحداث إضافات Google Workspace تتضمّن بنية حدث العنصر حقل commonEventObject أعلى مستوى للمعلومات غير المستندة إلى المضيف. يمكن أيضًا لكل كائن حدث أحد حقول المستوى الأعلى التالية الخاصة بالمضيف، والتي يتم تحديدها بواسطة تطبيق المضيف النشط: gmailEventObject، calendarEventObject أو driveEventObject.

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

عنصر الحدث
eventObject.commonEventObject Common fields object
كائن يحتوي على معلومات شائعة بين جميع عناصر الأحداث، بغض النظر عن التطبيق المضيف.
eventObject.calendar Calendar event object
لا يظهر هذا الحقل إلّا إذا كان المضيف المتصل هو "تقويم Google". عنصر يحتوي على معلومات التقويم والأحداث
eventObject.drive Drive event object
لا يظهر هذا الحقل إلا إذا كان المضيف المُتصل هو Google Drive. كائن يحتوي على معلومات Drive.
eventObject.gmail Gmail event object
لا يظهر هذا الحقل إلّا إذا كان المضيف المتصل هو Gmail. كائن تحتوي على معلومات Gmail.
eventObject.docs Docs event object
لا يظهر هذا الحقل إلا إذا كان المضيف المُتصل هو "مستندات Google". عنصر يحتوي على معلومات عن "مستندات Google"
eventObject.sheets
Sheets event object مشاركة العرض فقط إذا كان مضيف الاتصال هو "جداول بيانات Google" كائن تحتوي على معلومات جداول البيانات.
eventObject.slides
Slides event object مشاركة العرض فقط إذا كان مضيف الاتصال هو "العروض التقديمية من 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
يشير إلى مصدر الحدث ("الويب" أو "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: 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
أي معلمات إضافية قمتَ باستخدامها إلى Action باستخدام Action.setParameters()
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 بالتوقيت العالمي المنسق (UTC) في 1 كانون الثاني (يناير) 1970).
عنصر TimeInput
timeInput.hours number
رقم الساعة الذي اختاره المستخدم
timeInput.minutes number
رقم الدقيقة الذي اختاره المستخدم

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

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

يسرد الجدول التالي الحقول المتوفّرة في حقل calendarEventObject لعنصر الحدث. الحقول التي تحمل علامة بيانات من إنشاء المستخدمين: في كائن الحدث فقط إذا كانت البيانات متوفرة في تقويم الحدث وتضبط الإضافة 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
حالة ردّ الضيف. تشمل القيم المحتمَلة ما يلي:
  • 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
معرّف الموارد المنتظم للرمز المرئي للمستخدمين والذي يمثّل حلّ المؤتمرات هذا.
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
خريطة لمفاتيح وقيم سلسلة المَعلمات يحدد مطوّر الإضافة هذه المفاتيح والقيم لإرفاقها المعلومات إلى مكالمة فيديو محددة لاستخدام الإضافة.

نقطة الإدخال

تحتوي عناصر نقاط الدخول على معلومات عن وسائل الوصول المعتمَدة إلى اجتماع معيّن، مثل الهاتف أو الفيديو. تظهر هذه المعلومات في عنصر الحدث إذا كانت البيانات متوفّرة في حدث "تقويم Google" فقط، وصنّفت الإضافة حقل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
رمز المنطقة لرقم الهاتف مطلوب من المستخدمين إذا لم يتضمّن معرّف الموارد المنتظم رمز بلد. تستند القيم إلى القائمة العلنية لقائمة رموز المناطق في CLDR.
entryPoint.uri string
معرّف الموارد المنتظم (URI) لنقطة الدخول. الحد الأقصى لعدد الأحرف هو 1300 حرف. يعتمد التنسيق على نوع نقطة الإدخال:
  • more: http: أو https: 360 درجة.
  • phone: يجب توفُّر مخطّط tel:. يجب أن يتضمّن معرّف الموارد المتّصل (URI) تسلسل الاتصال بالكامل (على سبيل المثال، "tel:+12345678900,,,12345678;1234").
  • sip: sip: أو sips: 360 درجة. على سبيل المثال، "sip:12345678@myprovider.com".
  • video: http: أو https: 360 درجة.

عنصر حدث 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
لا تشارك العرض إلا في حال استيفاء الشروط التالية:
  • تم تفويض 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. عنوان جدول البيانات مفتوح في جداول البيانات واجهة مستخدم
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"
  }
}