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

توضّح هذه الصفحة بنية كائنات أحداث إضافات 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" كائن يحتوي على معلومات محرر المستندات.
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
تشير إلى المكان الذي نشأ فيه الحدث (`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
أي معلمات إضافية قمتَ باستخدامها إلى 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 بالتوقيت العالمي المنسق) في 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 أو مكالمات الفيديو التابعة لجهات خارجية تتوفر هذه المعلومات في في حالة وجود البيانات في حدث التقويم تضبط هذه الإضافة 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 حرف. يعتمد التنسيق على نقطة الدخول type:
  • more: http: أو https: 360 درجة.
  • phone: يجب استخدام مخطط tel:. تشير رسالة الأشكال البيانية ينبغي أن يتضمن معرف الموارد المنتظم (URI) تسلسل الاتصال بالكامل (على سبيل المثال، "رقم الهاتف:+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"
  }
}