EventObject

EventObject

حدث تفاعل مع إضافة Google يحتوي على بيانات حول تفاعل المستخدم مع إضافة ضمن تطبيق مضيف.

يتم تمرير كائن الحدث بتنسيق JSON إلى دالة رد الاتصال أو المشغّل (لـ AppsScript) أو نقطة نهاية https (لـ HTTP) الخاصة بإضافة، وذلك عندما يتفاعل مستخدم مع إضافة داخل تطبيق مضيف. يخزّن كائن الحدث كائن حدث تطبيق مضيف يحدّده كل تطبيق مضيف، بالإضافة إلى كائن حدث شائع يحتوي على بعض الحقول الشائعة ذات الصلة بالحدث.

لمزيد من المعلومات، يُرجى الاطّلاع على كائنات الأحداث.

تمثيل JSON
{
  "commonEventObject": {
    object (CommonEventObject)
  },
  "authorizationEventObject": {
    object (AuthorizationEventObject)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "calendar": {
    object (CalendarEventObject)
  },
  "drive": {
    object (DriveEventObject)
  },
  "gmail": {
    object (GmailEventObject)
  },
  "sheets": {
    object (SheetsEventObject)
  },
  "slides": {
    object (SlidesEventObject)
  },
  "docs": {
    object (DocsEventObject)
  },
  "chat": {
    object (ChatEventObject)
  },
  "workflow": {
    object (WorkflowEventObject)
  }
  // End of mutually exclusive fields.
}
الحقول
commonEventObject

object (CommonEventObject)

كائن يحتوي على معلومات مشتركة بين جميع كائنات الأحداث، بغض النظر عن التطبيق المضيف.

authorizationEventObject

object (AuthorizationEventObject)

يتم ضبطها فقط للطلبات المرسَلة إلى نقاط نهاية HTTP

في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ:
calendar

object (CalendarEventObject)

لا يتم عرض هذه السمة إلا إذا كان المضيف الذي يطلب البيانات هو "تقويم Google". عنصر يحتوي على معلومات التقويم والحدث

drive

object (DriveEventObject)

لا يظهر إلا إذا كان المضيف المتصل هو Google Drive. عنصر يحتوي على معلومات Drive

gmail

object (GmailEventObject)

لا يظهر هذا الخيار إلا إذا كان المضيف المتصل هو Gmail. عنصر يحتوي على معلومات Gmail

sheets

object (SheetsEventObject)

لا تظهر إلا إذا كان المضيف الذي يستدعيها هو "جداول بيانات Google". عنصر يحتوي على معلومات "جداول بيانات Google".

slides

object (SlidesEventObject)

لا تظهر إلا إذا كان المضيف الذي يطلبها هو "العروض التقديمية من Google". عنصر يحتوي على معلومات "العروض التقديمية من Google".

docs

object (DocsEventObject)

لا تظهر إلا إذا كان المضيف الذي يطلبها هو "مستندات Google". عنصر يحتوي على معلومات "مستندات Google".

chat

object (ChatEventObject)

لا تظهر إلا إذا كان مضيف المكالمة هو Google Chat. عنصر يحتوي على معلومات Chat.

workflow

object (WorkflowEventObject)

لا يظهر إلا إذا كان المضيف المتصل هو Google Workspace Studio. عنصر يحتوي على معلومات سير العمل

نهاية الحقول التي يستبعد كل منها الآخر

CommonEventObject

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

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

بالنسبة إلى تطبيقات Chat، يشير هذا الحقل إلى اسم الدالة التي استدعاها المستخدم عند التفاعل مع تطبيق مصغّر.

تمثيل JSON
{
  "userLocale": string,
  "hostApp": enum (HostApp),
  "platform": enum (Platform),
  "timeZone": {
    object (TimeZone)
  },
  "formInputs": {
    string: {
      object (Inputs)
    },
    ...
  },
  "parameters": {
    string: string,
    ...
  },
  "invokedFunction": string
}
الحقول
userLocale

string

يكون غير مفعَّل تلقائيًا. معرّف لغة المستخدم وبلده/منطقته بتنسيق رمز اللغة ISO 639-رمز البلد/المنطقة ISO 3166. مثلاً: en-US.

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

hostApp

enum (HostApp)

يشير إلى التطبيق المضيف الذي تكون الإضافة نشطة فيه عند إنشاء كائن الحدث. تشمل القيم المحتملة ما يلي:

  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
  • CHAT
platform

enum (Platform)

تعداد النظام الأساسي الذي يشير إلى النظام الأساسي الذي ينشأ منه الحدث (WEB أو IOS أو ANDROID). لا تتيح تطبيقات Chat استخدام هذه السمة.

timeZone

object (TimeZone)

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

لا يتوفّر هذا الحقل إلا لنوعَي الأحداث CARD_CLICKED وSUBMIT_DIALOG.

formInputs

map (key: string, value: object (Inputs))

خريطة تحتوي على القيم الحالية للتطبيقات المصغّرة في البطاقة المعروضة مفاتيح الخريطة هي قيم السلسلة name المخصّصة لكل تطبيق مصغّر للإدخال (مثل TextInput.name أو SelectionInput.name أو DateTimePicker.name أو DecoratedText.SwitchControl.name).

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

ملاحظة: تم تنسيق الأمثلة التالية لوقت تشغيل V8 في "برمجة تطبيقات Google". إذا كنت تستخدم وقت تشغيل Rhino، يجب إضافة [""] بعد القيمة. على سبيل المثال، بدلاً من e.commonEventObject.formInputs.employeeName.stringInputs.value[0]، يمكنك تنسيق كائن الحدث على النحو التالي: e.commonEventObject.formInputs.employeeName[""].stringInputs.value[0]. لمزيد من المعلومات حول أوقات التشغيل في "برمجة تطبيقات Google"، يُرجى الاطّلاع على نظرة عامة على وقت تشغيل V8.

  • التطبيقات المصغّرة ذات القيمة الواحدة (على سبيل المثال، تطبيق مصغّر TextInput أو تطبيق مصغّر SelectionInput من النوع DROPDOWN أو RADIO_BUTTON): عنصر StringInputs يحتوي على قائمة ذات عنصر واحد (أو قائمة فارغة في حال عدم إجراء أي اختيار).

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

  • التطبيقات المصغّرة المتعدّدة القيم (على سبيل المثال، تطبيق مصغّر SelectionInput من النوع CHECK_BOX أو SWITCH أو MULTI_SELECT): عنصر StringInputs يحتوي على قائمة بسلاسل value للعناصر المحدّدة.

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

  • ‫DecoratedText.SwitchControl widget: عنصر StringInputs. عندما تكون قيمة selected هي true، يحتوي stringInputs.value على حقل value الخاص بمفتاح التبديل (أو "" إذا لم يتم تحديد value، وإذا كانت هناك عدة مفاتيح تبديل تشترك في القيمة نفسها لـ name، يتم تضمين قيمة value لكل مفتاح تبديل محدّد في القائمة). عندما يكون selected هو false، يتم حذف value من stringInputs.value.

  • أداة اختيار التاريخ والوقت (DateTimePickerType.DATE_AND_TIME): DateTimeInput object.

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

  • أداة اختيار التاريخ فقط (DateTimePickerType.DATE_ONLY): DateInput object.

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

  • أداة اختيار الوقت فقط (DateTimePickerType.TIME_ONLY): TimeInput object.

مثال: بالنسبة إلى أداة اختيار تتضمّن name من myTimePicker، يمكنك الوصول إلى عنصر TimeInput باستخدام e.commonEventObject.formInputs.myTimePicker.timeInput.

عنصر يحتوي على قائمة بأزواج "key": value. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }

parameters

map (key: string, value: string)

أي مَعلمات إضافية تقدّمها لإجراء معيّن باستخدام actionParameters أو Action.setParameters().

معاينة المطوّر: بالنسبة إلى الإضافات التي توسّع Google Chat، لاقتراح عناصر استنادًا إلى ما يكتبه المستخدمون في قوائم الاختيار المتعدّد، استخدِم قيمة مفتاح "autocomplete_widget_query" (event.commonEventObject.parameters["autocomplete_widget_query"]). يمكنك استخدام هذه القيمة لطلب البحث في قاعدة بيانات واقتراح عناصر قابلة للاختيار للمستخدمين أثناء الكتابة. لمعرفة التفاصيل، يُرجى الاطّلاع على مقالة جمع المعلومات من مستخدمي Google Chat ومعالجتها.

عنصر يحتوي على قائمة بأزواج "key": value. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }

invokedFunction

string

اسم الدالة المطلوب استدعاؤها

لا تتم تعبئة هذا الحقل لإضافات Google Workspace التي توسّع Google Chat. بدلاً من ذلك، لتلقّي بيانات الدوال، مثل المعرّفات، يجب أن تستخدم الإضافات التي توسّع Chat الحقل parameters. يُرجى الاطّلاع على المقالة إنشاء واجهات تفاعلية لتطبيقات Chat.

HostApp

تطبيق Google Workspace لإضافة Google Workspace أو تطبيق Google Chat

بالنسبة إلى الإضافات، هو تطبيق Workspace الذي يتم تشغيل إضافة Google Workspace منه. بالنسبة إلى تطبيقات Chat، يكون التطبيق المضيف دائمًا هو CHAT.

عمليات التعداد
UNSPECIFIED_HOST_APP لا يمكن لـ Google تحديد تطبيق مضيف.
GMAIL يتم تشغيل الإضافة من Gmail.
CALENDAR يتم تشغيل الإضافة من "تقويم Google".
DRIVE يتم تشغيل الإضافة من Google Drive.
DEMO غير مستخدَم
DOCS يتم تشغيل الإضافة من "مستندات Google".
MEET يتم تشغيل الإضافة من Google Meet.
SHEETS يتم تشغيل الإضافة من "جداول بيانات Google".
SLIDES يتم تشغيل الإضافة من "العروض التقديمية من Google".
DRAWINGS يتم تشغيل الإضافة من "رسومات Google".
CHAT تطبيق Google Chat

النظام الأساسي

تحدّد هذه السمة المنصة التي نشأت منها هذه المكالمة.

عمليات التعداد
UNKNOWN_PLATFORM
WEB
IOS
ANDROID

TimeZone

معرّف المنطقة الزمنية وفرق التوقيت عن التوقيت العالمي المنسّق (UTC). لا يتوفّر هذا الحقل إلا لنوعَي الأحداث CARD_CLICKED وSUBMIT_DIALOG.

تمثيل JSON
{
  "id": string,
  "offset": integer
}
الحقول
id

string

رمز قاعدة بيانات المنطقة الزمنية IANA TZ، مثل "America/Toronto".

offset

integer

يشير هذا الحقل إلى إزاحة المنطقة الزمنية للمستخدم، بالمللي ثانية، عن التوقيت العالمي المنسّق (UTC).

الإدخالات

أنواع البيانات التي يمكن للمستخدمين إدخالها في البطاقات أو مربّعات الحوار يعتمد نوع الإدخال على نوع القيم التي يقبلها التطبيق المصغّر.

تمثيل JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "stringInputs": {
    object (StringInputs)
  },
  "dateTimeInput": {
    object (DateTimeInput)
  },
  "dateInput": {
    object (DateInput)
  },
  "timeInput": {
    object (TimeInput)
  }
  // End of mutually exclusive fields.
}
الحقول
في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ:
stringInputs

object (StringInputs)

قائمة بالسلاسل التي تمثّل القيم التي يُدخلها المستخدم في تطبيق مصغّر

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

dateTimeInput

object (DateTimeInput)

قيم إدخال التاريخ والوقت من تطبيق مصغّر DateTimePicker يقبل كلاً من التاريخ والوقت.

dateInput

object (DateInput)

قيم إدخال التاريخ من تطبيق مصغّر DateTimePicker يقبل قيم التاريخ فقط

timeInput

object (TimeInput)

قيم إدخال الوقت من تطبيق مصغّر DateTimePicker لا يقبل سوى قيم الوقت.

نهاية الحقول التي يستبعد كل منها الآخر

StringInputs

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

تمثيل JSON
{
  "value": [
    string
  ]
}
الحقول
value[]

string

قائمة بالسلاسل التي أدخلها المستخدم

DateTimeInput

قيم إدخال التاريخ والوقت

تمثيل JSON
{
  "msSinceEpoch": string,
  "hasDate": boolean,
  "hasTime": boolean
}
الحقول
msSinceEpoch

string (int64 format)

الوقت منذ بداية حقبة معيّنة، بالملي ثانية

hasDate

boolean

ما إذا كان إدخال datetime يتضمّن تاريخًا في التقويم

hasTime

boolean

ما إذا كان إدخال datetime يتضمّن طابعًا زمنيًا

DateInput

قيم إدخال التاريخ

تمثيل JSON
{
  "msSinceEpoch": string
}
الحقول
msSinceEpoch

string (int64 format)

الوقت منذ بداية حقبة معيّنة، بالملي ثانية

TimeInput

قيم إدخال الوقت

تمثيل JSON
{
  "hours": integer,
  "minutes": integer
}
الحقول
hours

integer

الساعة بتنسيق 24 ساعة

minutes

integer

عدد الدقائق بعد الساعة القيم الصالحة هي من 0 إلى 59.

AuthorizationEventObject

تتضمّن معلومات التفويض لطلب الإضافة

تمثيل JSON
{
  "userOAuthToken": string,
  "userIdToken": string,
  "systemIdToken": string,
  "authorizedScopes": [
    string
  ]
}
الحقول
userOAuthToken

string

رمز الدخول لبروتوكول OAuth الخاص بالمستخدم النهائي، والمصرَّح به مع النطاقات المطلوبة (بعد إلغاء تجميع موافقة OAuth، سيتم تفويض ذلك باستخدام النطاقات المفوَّضة للمستخدم النهائي)

userIdToken

string

رمز مميّز لرقم تعريف المستخدم النهائي، إذا تم طلب نطاقات أرقام تعريف مناسبة

systemIdToken

string

رمز مميّز للتعريف لحساب خدمة إضافات G Suite لعملية النشر هذه

authorizedScopes[]

string

قائمة بنطاقات OAuth التي سمح بها المستخدم

CalendarEventObject

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

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

تمثيل JSON
{
  "id": string,
  "recurringEventId": string,
  "calendarId": string,
  "organizer": {
    object (Organizer)
  },
  "attendees": [
    {
      object (Attendee)
    }
  ],
  "conferenceData": {
    object (ConferenceData)
  },
  "capabilities": {
    object (Capabilities)
  }
}
الحقول
id

string

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

recurringEventId

string

رقم تعريف حدث متكرّر

calendarId

string

رقم تعريف التقويم

organizer

object (Organizer)

عنصر يمثّل منظّم الحدث

attendees[]

object (Attendee)

البيانات من إنشاء المستخدمين: قائمة بالمشاركين في الحدث في التقويم

conferenceData

object (ConferenceData)

البيانات من إنشاء المستخدمين: عنصر يمثّل أي بيانات اجتماع مرتبطة بهذا الحدث، مثل تفاصيل اجتماع Google Meet.

capabilities

object (Capabilities)

البيانات من إنشاء المستخدمين: عنصر يصف إمكانات الإضافة لعرض معلومات الحدث أو تعديلها.

المنظّم

تمثيل JSON
{
  "email": string
}
الحقول
email

string

عنوان البريد الإلكتروني لمنظّم الحدث

المشارك

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

تمثيل JSON
{
  "email": string,
  "displayName": string,
  "organizer": boolean,
  "self": boolean,
  "resource": boolean,
  "optional": boolean,
  "responseStatus": string,
  "comment": string,
  "additionalGuests": integer
}
الحقول
email

string

عنوان البريد الإلكتروني للمشارك

displayName

string

الاسم المعروض للمشارك

organizer

boolean

صحيح إذا كان المشارك منظِّمًا لهذا الحدث.

self

boolean

صحيح إذا كان هذا المشارك يمثّل التقويم الذي يظهر فيه هذا الحدث، وخطأ في الحالات الأخرى.

resource

boolean

صحيح إذا كان المشارك يمثّل موردًا، مثل غرفة أو قطعة من المعدات، وخطأ في الحالات الأخرى.

optional

boolean

صحيح إذا تم وضع علامة على حضور هذا المشارك على أنّه اختياري، وخطأ في الحالات الأخرى.

responseStatus

string

تمثّل هذه السمة حالة ردّ المشارك. تشمل القيم المحتملة ما يلي:

  • accepted: قبل المشارك دعوة الحدث.
  • declined: رفض المشارك دعوة الحدث.
  • needsAction: لم يردّ المشارِك على دعوة الحدث.
  • tentative: يشير إلى أنّ المشارِك قد قبل دعوة الحدث بشكل مبدئي.
comment

string

تعليق ردّ المشارك، إن وُجد.

additionalGuests

integer

عدد الضيوف الإضافيين الذين أشار المشارك إلى أنّه سيحضرهم وتكون القيم التلقائية صفرًا.

ConferenceData

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

تمثيل JSON
{
  "conferenceId": string,
  "conferenceSolution": {
    object (ConferenceSolution)
  },
  "entryPoints": [
    {
      object (EntryPoint)
    }
  ],
  "notes": string,
  "parameters": {
    object (Parameters)
  }
}
الحقول
conferenceId

string

رقم تعريف مكالمة الفيديو يهدف هذا المعرّف إلى السماح للتطبيقات بتتبُّع الاجتماعات، لذا يجب عدم عرضه للمستخدمين.

conferenceSolution

object (ConferenceSolution)

عنصر يمثّل منصة لمكالمات الفيديو، مثل Hangouts أو Google Meet

entryPoints[]

object (EntryPoint)

قائمة نقاط الدخول إلى الاجتماع، مثل عناوين URL أو أرقام الهواتف

notes

string

ملاحظات إضافية (مثل تعليمات من مشرف النطاق أو إشعارات قانونية) حول الاجتماع لعرضها للمستخدم يمكن أن يحتوي على HTML. الحد الأقصى لعدد الأحرف هو 2048 حرفًا.

parameters

object (Parameters)

عنصر يحتوي على خريطة لبيانات المَعلمات المحدّدة لتستخدمها الإضافة.

ConferenceSolution

تمثيل JSON
{
  "iconUri": string,
  "key": {
    object (Key)
  },
  "name": string
}
الحقول
iconUri

string

معرّف الموارد المنتظم (URI) للرمز المرئي للمستخدم الذي يمثّل منصة مكالمات الفيديو هذه.

key

object (Key)

المفتاح الذي يحدّد بشكل فريد منصة مكالمات الفيديو لهذا الحدث

name

string

اسم منصة مكالمات الفيديو هذه الذي يظهر للمستخدم (غير مترجَم)

المفتاح

تمثيل JSON
{
  "type": string
}
الحقول
type

string

نوع منصة مكالمات الفيديو تشمل القيم المحتملة ما يلي:

EntryPoint

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

تمثيل JSON
{
  "accessCode": string,
  "entryPointType": string,
  "label": string,
  "meetingCode": string,
  "passcode": string,
  "password": string,
  "pin": string,
  "uri": string,
  "regionCode": string,
  "entryPointFeatures": [
    string
  ]
}
الحقول
accessCode

string

رمز الدخول المستخدَم للانضمام إلى المكالمة الجماعية الحد الأقصى للطول هو 128 حرفًا. عادةً ما يستخدم مقدّمو خدمات الاجتماعات مجموعة فرعية فقط من {accessCode, meetingCode, passcode, password, pin} لتوفير إمكانية الوصول إلى الاجتماعات. مطابقة الحقول التي يستخدمها مقدّم خدمة الاجتماعات وعرضها فقط

entryPointType

string

نوع نقطة الدخول القيم المحتمَلة هي:

  • more: تعليمات إضافية للانضمام إلى الاجتماع، مثل أرقام الهواتف البديلة يمكن أن يحتوي اجتماع الفيديو على نقطة دخول إضافية واحدة فقط، وفي حال توفّرها، يجب أيضًا توفّر نوع آخر واحد على الأقل من نقاط الدخول.
  • phone: للانضمام إلى الاجتماع عبر رقم هاتف يمكن أن يتضمّن الاجتماع صفرًا أو أكثر من نقاط الدخول عبر الهاتف. يعرض "تقويم Google" أول نقطتَي دخول عبر الهاتف فقط، بعد التنسيق والترتيب أبجديًا.
  • sip: للانضمام إلى المؤتمر عبر بروتوكول SIP. يمكن أن يحتوي الاجتماع على نقطة دخول واحدة من نوع sip كحد أقصى.
  • video: للانضمام إلى الاجتماع عبر HTTP يمكن أن يتضمّن الاجتماع نقطة دخول فيديو واحدة كحدّ أقصى.
label

string

التصنيف المرئي للمستخدم لمعرّف الموارد المنتظم (URI) لنقطة الدخول (غير مترجَم)

meetingCode

string

رمز الاجتماع المستخدَم للوصول إلى الاجتماع الحد الأقصى للطول هو 128 حرفًا. عادةً ما يستخدم مقدّمو خدمات الاجتماعات مجموعة فرعية فقط من {accessCode, meetingCode, passcode, password, pin} لتوفير إمكانية الوصول إلى الاجتماعات. مطابقة الحقول التي يستخدمها مقدّم خدمة الاجتماعات وعرضها فقط

passcode

string

رمز المرور المستخدَم للوصول إلى المؤتمر الحد الأقصى للطول هو 128 حرفًا. عادةً ما يستخدم مقدّمو خدمات الاجتماعات مجموعة فرعية فقط من {accessCode, meetingCode, passcode, password, pin} لتوفير إمكانية الوصول إلى الاجتماعات. مطابقة الحقول التي يستخدمها مقدّم خدمة الاجتماعات وعرضها فقط

password

string

كلمة المرور المستخدَمة للوصول إلى المؤتمر الحد الأقصى للطول هو 128 حرفًا. عادةً ما يستخدم مقدّمو خدمات الاجتماعات مجموعة فرعية فقط من {accessCode, meetingCode, passcode, password, pin} لتوفير إمكانية الوصول إلى الاجتماعات. مطابقة الحقول التي يستخدمها مقدّم خدمة الاجتماعات وعرضها فقط

pin

string

رقم التعريف الشخصي المستخدَم للوصول إلى الاجتماع الحد الأقصى للطول هو 128 حرفًا. عادةً ما يستخدم مقدّمو خدمات الاجتماعات مجموعة فرعية فقط من {accessCode, meetingCode, passcode, password, pin} لتوفير إمكانية الوصول إلى الاجتماعات. مطابقة الحقول التي يستخدمها مقدّم خدمة الاجتماعات وعرضها فقط

uri

string

معرّف الموارد المنتظم (URI) لنقطة الدخول الحد الأقصى للطول هو 1,300 حرف. يعتمد التنسيق على نوع نقطة الدخول:

  • مزيد من المعلومات: يجب استخدام المخطط http:‎ أو https:‎.
  • phone: يجب استخدام المخطط tel:‎. يجب أن يتضمّن معرّف الموارد المنتظم (URI) تسلسل الاتصال بالكامل (على سبيل المثال، "tel:+12345678900,,,12345678;1234").
  • sip: يجب استخدام المخطط sip:‎ أو sips:‎. على سبيل المثال "sip:12345678@myprovider.com".
  • ‫video: يجب استخدام المخطط http: أو https:.
regionCode

string

رمز منطقة رقم الهاتف يحتاج إليه المستخدمون إذا لم يتضمّن معرّف الموارد المنتظم (URI) رمز بلد. تستند القيم إلى قائمة رموز المناطق العامة في CLDR.

entryPointFeatures[]

string

ميزات نقطة الدخول في الوقت الحالي، تنطبق هذه الميزات على نقاط الدخول عبر الهاتف فقط:

  • toll: نقطة الدخول هي مكالمة هاتفية برسوم.
  • ‫toll_free: نقطة الدخول هي مكالمة هاتفية مجانية.

المعلمات

تمثيل JSON
{
  "addOnParameters": {
    object (AddOnParameters)
  }
}
الحقول
addOnParameters

object (AddOnParameters)

تمثّل هذه السمة خريطة لمفاتيح وقيم سلاسل المَعلمات. يحدّد مطوّر الإضافة هذه المفاتيح والقيم لإرفاق المعلومات باجتماع معيّن لاستخدام الإضافة.

AddOnParameters

تمثيل JSON
{
  "parameters": {
    string: string,
    ...
  }
}
الحقول
parameters

map (key: string, value: string)

عنصر يحتوي على قائمة بأزواج "key": value. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }

الإمكانات

تمثيل JSON
{
  "canSeeAttendees": boolean,
  "canAddAttendees": boolean,
  "canSeeConferenceData": boolean,
  "canSetConferenceData": boolean,
  "canAddAttachments": boolean
}
الحقول
canSeeAttendees

boolean

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

canAddAttendees

boolean

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

canSeeConferenceData

boolean

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

canSetConferenceData

boolean

بيانات من إنشاء المستخدمين: صحيح إذا كان بإمكان الإضافة تعديل بيانات اجتماع الحدث، وخطأ في الحالات الأخرى

canAddAttachments

boolean

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

DriveEventObject

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

تمثيل JSON
{
  "selectedItems": [
    {
      object (DriveItemMetadata)
    }
  ],
  "activeCursorItem": {
    object (DriveItemMetadata)
  }
}
الحقول
selectedItems[]

object (DriveItemMetadata)

قائمة بالعناصر (الملفات أو المجلدات) المحدّدة في Drive

activeCursorItem

object (DriveItemMetadata)

ملف Drive النشط حاليًا

DriveItemMetadata

تحمل عناصر Drive معلومات حول عناصر معيّنة في Drive، مثل الملفات أو المجلدات.

تمثيل JSON
{
  "id": string,
  "iconUrl": string,
  "mimeType": string,
  "title": string,
  "addonHasFileScopePermission": boolean
}
الحقول
id

string

معرّف العنصر المحدّد

iconUrl

string

عنوان URL للرمز الذي يمثّل العنصر المحدّد

mimeType

string

نوع MIME للعنصر المحدّد

title

string

عنوان العنصر المحدّد

addonHasFileScopePermission

boolean

إذا كانت القيمة true، يعني ذلك أنّ الإضافة طلبت تفويض النطاق https://www.googleapis.com/auth/drive.file لهذا العنصر وحصلت عليه. وإلا، ستكون قيمة هذا الحقل false.

إذا كانت الإضافة تستخدم نطاقًا أكثر تساهلاً، مثل https://www.googleapis.com/auth/drive أو https://www.googleapis.com/auth/drive.readonly، لن يكون هذا الحقل ذا صلة. استخدِم دائمًا أقل نطاقات ممكنة عند تصميم الإضافات لحماية معلومات المستخدمين.

GmailEventObject

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

تمثيل JSON
{
  "messageId": string,
  "threadId": string,
  "accessToken": string,
  "toRecipients": [
    string
  ],
  "ccRecipients": [
    string
  ],
  "bccRecipients": [
    string
  ]
}
الحقول
messageId

string

رقم تعريف رسالة Gmail المفتوحة حاليًا

threadId

string

رقم تعريف سلسلة محادثات Gmail المفتوحة حاليًا

accessToken

string

رمز الدخول الخاص بـ Gmail يمكنك استخدام هذا الرمز المميّز مع طريقة GmailApp.setCurrentMessageAccessToken(accessToken) لمنح الإضافة إمكانية الوصول المؤقت إلى رسالة Gmail المفتوحة حاليًا للمستخدم أو السماح للإضافة بإنشاء مسودات جديدة.

toRecipients[]

string

يكون غير مفعَّل تلقائيًا. قائمة عناوين البريد الإلكتروني للمستلِمين في الحقل "إلى:" المضمّنة حاليًا في مسودة تنشئها الإضافة لتفعيل هذا الحقل، يجب ضبط الحقل addOns.gmail.composeTrigger.draftAccess في ملف البيان على METADATA.

ccRecipients[]

string

يكون غير مفعَّل تلقائيًا. قائمة عناوين البريد الإلكتروني للمستلِمين في الحقل "نسخة إلى:" المضمّنة حاليًا في مسودة تنشئها الإضافة لتفعيل هذا الحقل، يجب ضبط الحقل addOns.gmail.composeTrigger.draftAccess في ملف البيان على METADATA.

bccRecipients[]

string

يكون غير مفعَّل تلقائيًا. قائمة عناوين البريد الإلكتروني للمستلِمين في حقل "نسخة مخفية الوجهة" المضمّنة حاليًا في مسودة تنشئها الإضافة. لتفعيل هذا الحقل، يجب ضبط الحقل addOns.gmail.composeTrigger.draftAccess في ملف البيان على METADATA.

SheetsEventObject

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

تمثيل JSON
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
الحقول
id

string

لا يظهر هذا الحقل إلا إذا منح المستخدم الإذن للنطاق https://www.googleapis.com/auth/drive.file. رقم تعريف جدول البيانات المفتوح في واجهة مستخدم "جداول بيانات Google"

title

string

لا يظهر هذا الحقل إلا إذا منح المستخدم الإذن للنطاق https://www.googleapis.com/auth/drive.file. عنوان جدول البيانات المفتوح في واجهة مستخدم "جداول بيانات Google"

addonHasFileScopePermission

boolean

إذا كانت القيمة true، يعني ذلك أنّ الإضافة طلبت وحصلت على تفويض نطاق https://www.googleapis.com/auth/drive.file لجدول البيانات المفتوح في واجهة مستخدم "جداول بيانات Google". وفي حال عدم حدوث ذلك، تكون قيمة هذا الحقل false.

matchedUrl

object (MatchedUrl)

لا تظهر إلا في حال استيفاء الشروط التالية:

  • تم منح الإذن لـ "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"
  }
}

MatchedUrl

كائن الحدث الذي يتم عرضه مع طلبات معاينة الروابط

تمثيل JSON
{
  "url": string
}
الحقول
url

string

عنوان URL الذي تمت مطابقته

SlidesEventObject

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

تمثيل JSON
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
الحقول
id

string

لا يظهر هذا الحقل إلا إذا منح المستخدم الإذن للنطاق https://www.googleapis.com/auth/drive.file. رقم تعريف العرض التقديمي المفتوح في واجهة مستخدم "العروض التقديمية من Google"

title

string

لا يظهر هذا الحقل إلا إذا منح المستخدم الإذن للنطاق https://www.googleapis.com/auth/drive.file. عنوان العرض التقديمي المفتوح في واجهة مستخدم "العروض التقديمية من Google"

addonHasFileScopePermission

boolean

إذا كانت القيمة true، يعني ذلك أنّ الإضافة طلبت وحصلت على تفويض النطاق https://www.googleapis.com/auth/drive.file للعرض التقديمي المفتوح في واجهة مستخدم "العروض التقديمية من Google". وفي الحالات الأخرى، تكون قيمة هذا الحقل false.

matchedUrl

object (MatchedUrl)

لا تظهر إلا في حال استيفاء الشروط التالية:

  • تم منح الإذن لـ "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"
  }
}

DocsEventObject

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

تمثيل JSON
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
الحقول
id

string

لا يظهر هذا الحقل إلا إذا منح المستخدم الإذن للنطاق https://www.googleapis.com/auth/drive.file. رقم تعريف المستند المفتوح في واجهة مستخدم "مستندات Google"

title

string

لا يظهر هذا الحقل إلا إذا منح المستخدم الإذن للنطاق https://www.googleapis.com/auth/drive.file. عنوان المستند المفتوح في واجهة مستخدم "مستندات Google"

addonHasFileScopePermission

boolean

إذا كانت القيمة true، يعني ذلك أنّ الإضافة طلبت وحصلت على إذن الوصول إلى النطاق https://www.googleapis.com/auth/drive.file للمستند المفتوح في واجهة مستخدم "مستندات Google". وفي حال عدم الحصول على الإذن، تكون قيمة هذا الحقل false.

matchedUrl

object (MatchedUrl)

لا تظهر إلا في حال استيفاء الشروط التالية:

  • تم منح الإذن لـ "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"
  }
}

ChatEventObject

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

تمثيل JSON
{
  "type": enum (EventType),
  "user": {
    object (User)
  },
  "space": {
    object (Space)
  },
  "eventTime": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "messagePayload": {
    object (MessagePayload)
  },
  "addedToSpacePayload": {
    object (AddedToSpacePayload)
  },
  "removedFromSpacePayload": {
    object (RemovedFromSpacePayload)
  },
  "buttonClickedPayload": {
    object (ButtonClickedPayload)
  },
  "widgetUpdatedPayload": {
    object (WidgetUpdatedPayload)
  },
  "appCommandPayload": {
    object (AppCommandPayload)
  },
  "systemCommandPayload": {
    object (SystemCommandPayload)
  }
  // End of mutually exclusive fields.
}
الحقول
type

enum (EventType)

نوع الحدث، ويتم ملؤه فقط لأحداث "الصفحة الرئيسية للتطبيق" في تطبيقات Chat التي ليست إضافات.

user

object (User)

المستخدم الذي يتفاعل مع تطبيق Chat

space

object (Space)

المساحة التي وقع فيها الحدث، وتتم تعبئتها فقط لأحداث "الصفحة الرئيسية للتطبيق" في تطبيقات Chat التي ليست إضافات.

eventTime

string (Timestamp format)

الطابع الزمني الذي يشير إلى وقت حدوث كائن الحدث

يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30"

حمولة كائن الحدث تعتمد الحمولات على نوع كائن الحدث. في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ:
messagePayload

object (MessagePayload)

يرسل المستخدم رسالة إلى تطبيق Chat أو يشير إليه باستخدام @في مساحة. يتم إرسال طلبات تشغيل التطبيقات (مثل الأوامر التي تبدأ بشرطة مائلة والأوامر السريعة) في appCommandPayload بدلاً من ذلك.

addedToSpacePayload

object (AddedToSpacePayload)

يضيف مستخدم تطبيق Chat إلى مساحة Chat، أو يثبّت مشرف حسابات Google Workspace تطبيق Chat في مساحات الرسائل المباشرة للمستخدمين في مؤسسته.

removedFromSpacePayload

object (RemovedFromSpacePayload)

يزيل مستخدم تطبيق Chat من مساحة.

buttonClickedPayload

object (ButtonClickedPayload)

تمثّل بيانات الحمولة عندما يتفاعل مستخدم مع عنصر تفاعلي في بطاقة أو مربّع حوار يؤدي إلى استدعاء Action. على الرغم من الاسم، تتم تعبئة هذه الحمولة لجميع عمليات استدعاء البطاقات ومربّعات الحوار Action، ليس فقط النقرات على الأزرار، ولكن أيضًا مشغّلات onChangeAction وإجراءات onClick والنقرات على CardAction وإرسال مربّع الحوار أو إلغاؤه (SUBMIT_DIALOG وCANCEL_DIALOG).

إذا تفاعل مستخدم مع مربّع حوار، يتم ضبط الحقل isDialogEvent في ButtonClickedPayload على true ويتضمّن DialogEventType.

تتضمّن الحمولة الكاملة أيضًا commonEventObject.formInputs وcommonEventObject.parameters.

widgetUpdatedPayload

object (WidgetUpdatedPayload)

يعدّل المستخدم تطبيقًا مصغّرًا في بطاقة ضمن ساحة المشاركات أو في مربّع حوار.

تتضمّن الحمولة الكاملة أيضًا CommonEventObject.parameters['autocomplete_widget_query'].

appCommandPayload

object (AppCommandPayload)

يستدعي المستخدم أمر تطبيق.

systemCommandPayload

object (SystemCommandPayload)

يستدعي المستخدم أمرًا من أوامر النظام.

نهاية الحقول التي يستبعد كل منها الآخر

EventType

نوع الحدث، ويتم ملؤه فقط لأحداث "الصفحة الرئيسية للتطبيق" في تطبيقات Chat التي ليست إضافات.

عمليات التعداد
EVENT_TYPE_UNSPECIFIED القيمة التلقائية للتعداد DO NOT USE.
APP_HOME يفتح المستخدم رسالة مباشرة من تطبيق Chat يستخدم الصفحة الرئيسية للتطبيق. يتم تضمين الحقول type وuser وspace فقط للأحداث من هذا النوع. لمزيد من المعلومات، يُرجى الاطّلاع على المقالة إنشاء صفحة رئيسية لتطبيق Google Chat.
SUBMIT_FORM يرسل المستخدم معلومات في بطاقة الصفحة الرئيسية للتطبيق. يتم تضمين الحقول type وuser وspace فقط للأحداث من هذا النوع. لمزيد من المعلومات، يُرجى الاطّلاع على [إنشاء صفحة رئيسية لتطبيق Google Chat]((https://developers.google.com/workspace/chat/send-app-home-card-message).

MessagePayload

يرسل المستخدم رسالة إلى تطبيق Chat أو يشير إليه باستخدام @في مساحة. تستخدم عمليات استدعاء أوامر التطبيقات (مثل الأوامر التي تبدأ بشرطة مائلة والأوامر السريعة) AppCommandPayload بدلاً من ذلك.

تمثيل JSON
{
  "space": {
    object (Space)
  },
  "message": {
    object (Message)
  },
  "configCompleteRedirectUri": string
}
الحقول
space

object (Space)

الحقل مطلوب. مساحة Chat التي يحدث فيها كائن الحدث

message

object (Message)

الرسالة التي تؤدي إلى تفعيل كائن الحدث

configCompleteRedirectUri

string

اختيارية: عنوان URL الذي يجب أن يعيد تطبيق Chat توجيه المستخدم إليه بعد إكمال مسار التفويض أو الإعداد خارج Google Chat. لمزيد من المعلومات، يُرجى الاطّلاع على المقالة ربط تطبيق في Chat بخدمات وأدوات أخرى.

AddedToSpacePayload

يضيف مستخدم تطبيق Chat إلى مساحة، أو يتم إنشاء رسالة مباشرة بين التطبيق والمستخدم.

تمثيل JSON
{
  "space": {
    object (Space)
  },
  "interactionAdd": boolean,
  "configCompleteRedirectUri": string
}
الحقول
space

object (Space)

الحقل مطلوب. مساحة Chat التي يحدث فيها كائن الحدث

interactionAdd

boolean

ما إذا تمت إضافة التطبيق إلى المساحة من خلال تفاعل المستخدم (مثلاً، من خلال الإشارة إلى تطبيق Chat باستخدام @ أو استدعائه باستخدام أمر يبدأ بشرطة مائلة) إذا تم ضبط هذه السياسة على "صحيح"، سيتم إرسال كائن حدث منفصل مرتبط بالتفاعل نفسه إلى تطبيق Chat.

configCompleteRedirectUri

string

اختيارية: عنوان URL الذي يجب أن يعيد تطبيق Chat توجيه المستخدم إليه بعد إكمال مسار التفويض أو الإعداد خارج Google Chat. لمزيد من المعلومات، يُرجى الاطّلاع على المقالة ربط تطبيق في Chat بخدمات وأدوات أخرى.

RemovedFromSpacePayload

يزيل مستخدم تطبيق Chat من مساحة.

تمثيل JSON
{
  "space": {
    object (Space)
  }
}
الحقول
space

object (Space)

الحقل مطلوب. مساحة Chat التي يحدث فيها كائن الحدث

ButtonClickedPayload

يتفاعل المستخدم مع عنصر تفاعلي في بطاقة أو مربّع حوار من إضافة Chat التي تؤدي إلى استدعاء Action. على الرغم من الاسم، تتم تعبئة هذه الحمولة لجميع عمليات استدعاء Action للبطاقات ومربّعات الحوار، بما في ذلك النقرات على الأزرار ومُشغِّلات onChangeAction وإجراءات onClick والنقرات على CardAction وإرسال مربّع الحوار أو إلغائه (SUBMIT_DIALOG وCANCEL_DIALOG).

إذا تفاعل مستخدم مع مربّع حوار، يتم ضبط الحقل isDialogEvent في ButtonClickedPayload على true ويتضمّن DialogEventType. يتم ربط هذه الحمولة بنوعَي الحدث SUBMIT_FORM وCARD_CLICKED لتطبيقات Chat التي ليست إضافات.

تتضمّن الحمولة الكاملة أيضًا CommonEventObject.form_inputs وCommonEventObject.parameters.

تمثيل JSON
{
  "space": {
    object (Space)
  },
  "message": {
    object (Message)
  },
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType)
}
الحقول
space

object (Space)

الحقل مطلوب. مساحة Chat التي يحدث فيها كائن الحدث

message

object (Message)

الرسالة التي تؤدي إلى تفعيل كائن الحدث

isDialogEvent

boolean

بالنسبة إلى كائنات الأحداث ButtonClicked وMessage، يشير هذا الحقل إلى ما إذا كان المستخدم يتفاعل مع مربّع حوار أو على وشك التفاعل معه.

dialogEventType

enum (DialogEventType)

نوع كائن حدث مربّع الحوار الذي تم تلقّيه

DialogEventType

بالنسبة إلى كائنات الأحداث التي تحتوي على حمولات أحداث ButtonClicked أو AppCommand، أنواع التفاعلات مع مربّعات الحوار.

لمزيد من المعلومات عن كائنات أحداث تطبيقات Google Chat، يُرجى الاطّلاع على مقالة تلقّي التفاعلات مع تطبيق Google Chat والردّ عليها.

عمليات التعداد
DIALOG_EVENT_TYPE_UNSPECIFIED القيمة التلقائية غير محدد
REQUEST_DIALOG يفتح المستخدم مربّع حوار.
SUBMIT_DIALOG ينقر المستخدم على عنصر تفاعلي في مربّع حوار. على سبيل المثال، يملأ المستخدم المعلومات في مربع حوار وينقر على زر لإرسال المعلومات.
CANCEL_DIALOG يغلق المستخدم مربّع حوار بدون إرسال معلومات، أو يتم إلغاء مربّع الحوار.

WidgetUpdatedPayload

يعدّل المستخدم تطبيقًا مصغّرًا في بطاقة أو مربّع حوار ضمن ساحة المشاركات.

تتضمّن الحمولة الكاملة أيضًا CommonEventObject.parameters['autocomplete_widget_query'].

تمثيل JSON
{
  "space": {
    object (Space)
  }
}
الحقول
space

object (Space)

الحقل مطلوب. مساحة Chat التي يحدث فيها كائن الحدث

AppCommandPayload

يستدعي المستخدم أمر تطبيق.

تمثيل JSON
{
  "appCommandMetadata": {
    object (AppCommandMetadata)
  },
  "space": {
    object (Space)
  },
  "thread": {
    object (Thread)
  },
  "message": {
    object (Message)
  },
  "configCompleteRedirectUri": string,
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType)
}
الحقول
appCommandMetadata

object (AppCommandMetadata)

يتم ملؤه لأوامر التطبيقات، بما في ذلك الأوامر التي تبدأ بشرطة مائلة والأوامر السريعة.

space

object (Space)

اختيارية: مساحة Chat التي يحدث فيها كائن الحدث

thread

object (Thread)

اختيارية: سلسلة المحادثات التي يظهر فيها كائن الحدث، إن توفّرت تتم تعبئة هذا الحقل إذا كان كائن الحدث مرتبطًا برسالة أو سلسلة محادثات معيّنة.

message

object (Message)

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

configCompleteRedirectUri

string

اختيارية: عنوان URL الذي يجب إعادة توجيه المستخدم إليه بعد إكمال عملية التفويض أو الإعداد خارج Google Chat. لمزيد من المعلومات، يُرجى الاطّلاع على المقالة ربط تطبيق في Chat بخدمات وأدوات أخرى.

isDialogEvent

boolean

اختيارية: ما إذا كان المستخدم يتفاعل مع مربّع حوار أو على وشك التفاعل معه

dialogEventType

enum (DialogEventType)

اختيارية: نوع كائن حدث مربّع الحوار الذي تم تلقّيه لا ينطبق هذا الحقل إلا إذا كانت قيمة isDialogEvent هي true.

AppCommandMetadata

البيانات الوصفية حول أمر تطبيق Chat.

تمثيل JSON
{
  "appCommandId": integer,
  "appCommandType": enum (AppCommandType)
}
الحقول
appCommandId

integer

رقم تعريف الأمر المحدّد في إعدادات Chat API

appCommandType

enum (AppCommandType)

نوع أمر تطبيق Chat

AppCommandType

نوع أمر تطبيق Chat لمعرفة التفاصيل، يُرجى الاطّلاع على أنواع أوامر تطبيقات Chat.

عمليات التعداد
APP_COMMAND_TYPE_UNSPECIFIED القيمة التلقائية غير محدد
SLASH_COMMAND أمر يبدأ بشرطة مائلة يرسل المستخدم الأمر في رسالة محادثة.
QUICK_COMMAND طلب سريع يختار المستخدم الأمر من قائمة Chat في قسم الرد على الرسالة.
MESSAGE_ACTION إجراء مقترح يختار المستخدم الأمر من قائمة سياق الرسالة في Chat.

SystemCommandPayload

يستدعي المستخدم أمرًا من أوامر النظام.

تمثيل JSON
{
  "systemCommandMetadata": {
    object (SystemCommandMetadata)
  },
  "space": string,
  "thread": {
    object (Thread)
  }
}
الحقول
systemCommandMetadata

object (SystemCommandMetadata)

البيانات الوصفية حول أمر النظام الذي تم استدعاؤه

space

string

اختيارية: مساحة Chat التي يحدث فيها كائن الحدث

thread

object (Thread)

اختيارية: سلسلة المحادثات التي يظهر فيها كائن الحدث، إن توفّرت تتم تعبئة هذا الحقل إذا كان كائن الحدث مرتبطًا برسالة أو سلسلة محادثات معيّنة.

SystemCommandMetadata

تمثّل هذه السمة البيانات الوصفية حول أمر نظام يشغّله المستخدم.

تمثيل JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "cancelStream": {
    object (CancelStream)
  }
  // End of mutually exclusive fields.
}
الحقول
أمر النظام الذي تم استدعاؤه في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ:
cancelStream

object (CancelStream)

أمر لإلغاء رسالة بث نشطة

نهاية الحقول التي يستبعد كل منها الآخر

CancelStream

أمر لإلغاء رسالة بث نشطة

تمثيل JSON
{
  "streamMessage": string
}
الحقول
streamMessage

string

الحقل مطلوب. اسم المورد لرسالة البث التي تم تنفيذ أمر الإلغاء عليها

التنسيق: spaces/{space}/streamMessages/{streamMessage}

WorkflowEventObject

‫LINT.IfChange كائن الحدث الذي تم تمريره إلى إضافات سير العمل

تمثيل JSON
{
  "executionMetadata": {
    object (ExecutionMetadata)
  },
  "triggerEventSource": enum (TriggerEventSource),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "actionInvocation": {
    object (ActionInvocation)
  },
  "triggerCreation": {
    object (TriggerCreation)
  },
  "triggerDeletion": {
    object (TriggerDeletion)
  },
  "resourceRetrieval": {
    object (ResourceRetrieval)
  },
  "elementConfiguration": {
    object (ElementConfiguration)
  },
  "resourceFieldsDefinitionRetrieval": {
    object (ResourceFieldsDefinitionRetrieval)
  },
  "elementUiAutocomplete": {
    object (ElementUiAutocomplete)
  }
  // End of mutually exclusive fields.
}
الحقول
executionMetadata

object (ExecutionMetadata)

البيانات الوصفية حول تنفيذ سير العمل

triggerEventSource

enum (TriggerEventSource)

مصدر الأحداث التي تؤدي إلى تفعيل الإجراءات

نوع حمولة بيانات حدث سير العمل في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ:
actionInvocation

object (ActionInvocation)

استدعاء إجراء سير عمل

triggerCreation

object (TriggerCreation)

إنشاء مشغِّل سير عمل

triggerDeletion

object (TriggerDeletion)

حذف مشغِّل سير العمل

resourceRetrieval

object (ResourceRetrieval)

استرداد مورد (يُستخدَم لتضخيم المتغيّرات)

elementConfiguration

object (ElementConfiguration)

إعدادات عنصر سير العمل

resourceFieldsDefinitionRetrieval

object (ResourceFieldsDefinitionRetrieval)

استرداد تعريفات الحقول التي يتيحها المورد

elementUiAutocomplete

object (ElementUiAutocomplete)

اقتراحات الإكمال التلقائي للبطاقة المعروضة حاليًا

نهاية الحقول التي يستبعد كل منها الآخر

ActionInvocation

استدعاء إجراء سير عمل

تمثيل JSON
{
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "triggerId": string,
  "flowLevelContext": {
    object (FlowLevelContext)
  }
}
الحقول
inputs

map (key: string, value: object (VariableData))

تمثّل هذه المَعلمة خريطة لمتغيّرات الإدخال التي يتم تحديدها حسب اسم متغيّر الإدخال.

عنصر يحتوي على قائمة بأزواج "key": value. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }

triggerId

string

رقم تعريف عامل التشغيل الذي سيتم استخدامه لردود الإجراءات غير المتزامنة

flowLevelContext

object (FlowLevelContext)

اختيارية: سياق على مستوى المسار من الخطوات السابقة

VariableData

تمثّل هذه السمة بيانات متغيّرة يمكن أن تحتوي على قيم متعدّدة من أنواع مختلفة.

تمثيل JSON
{
  "booleanValues": [
    boolean
  ],
  "integerValues": [
    string
  ],
  "floatValues": [
    number
  ],
  "stringValues": [
    string
  ],
  "timestampValues": [
    string
  ],
  "resourceReferences": [
    {
      object (ResourceReference)
    }
  ],
  "emailAddressValues": [
    string
  ],
  "googleUserValues": [
    string
  ],
  "textFormatValues": [
    {
      object (WorkflowTextFormat)
    }
  ]
}
الحقول
booleanValues[]

boolean

القيم المنطقية

integerValues[]

string (int64 format)

قيم الأعداد الصحيحة

floatValues[]

number

قيم عائمة

stringValues[]

string

قيم السلاسل

timestampValues[]

string (Timestamp format)

قيم الطابع الزمني

يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30"

resourceReferences[]

object (ResourceReference)

مراجع الموارد (أرقام التعريف)

emailAddressValues[]

string

قيم عناوين البريد الإلكتروني

googleUserValues[]

string

قيم مستخدمي Google بالتنسيق users/{user}

textFormatValues[]

object (WorkflowTextFormat)

قيم تنسيق النص في سير العمل

ResourceReference

قيمة معرّف المورد الخاص بالتطبيق

تمثيل JSON
{
  "resourceType": {
    object (ResourceType)
  },
  "resourceId": string
}
الحقول
resourceType

object (ResourceType)

نوع المورد الذي يشير إليه هذا المعرّف

resourceId

string

رقم تعريف المرجع

ResourceType

اسم نوع المورد المخصّص

تمثيل JSON
{
  "workflowBundleId": string,
  "workflowResourceDefinitionId": string
}
الحقول
workflowBundleId

string

معرّف حزمة سير العمل التي تملك نوع المورد هذا هذا الحقل اختياري، وإذا تُرك فارغًا، سيتم اعتباره الحزمة نفسها التي يتم استخدامها.

workflowResourceDefinitionId

string

المعرّف الفريد للمورد يجب أن يكون هذا المعرّف فريدًا ضمن الحزمة نفسها فقط.

WorkflowTextFormat

مجموعة من النصوص مع خيارات تنسيق متقدّمة، بما في ذلك الأنماط والروابط التشعّبية والعناصر التفاعلية

تمثيل JSON
{
  "textFormatElements": [
    {
      object (TextFormatElement)
    }
  ]
}
الحقول
textFormatElements[]

object (TextFormatElement)

مجموعة من عناصر تنسيق النص

TextFormatElement

عنصر واحد ضمن رسالة WorkflowTextFormat، ويمكن أن يكون شريحة أو نصًا منسقًا أو رابطًا تشعبيًا أو حاوية قائمة.

تمثيل JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "text": string,
  "chip": {
    object (Chip)
  },
  "styledText": {
    object (StyledText)
  },
  "hyperlink": {
    object (Hyperlink)
  },
  "listContainer": {
    object (ListContainer)
  }
  // End of mutually exclusive fields.
}
الحقول
عنصر يمثّل أحد عناصر تنسيق النص المتعددة المحتملة في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ:
text

string

النص بتنسيق النص

chip

object (Chip)

شريحة قابلة للنقر بتنسيق نصي

styledText

object (StyledText)

نص منمّق بتنسيق النص

listContainer

object (ListContainer)

حاوية القائمة بتنسيق النص

نهاية الحقول التي يستبعد كل منها الآخر

شريحة

شريحة قابلة للنقر بتنسيق نصي

تمثيل JSON
{
  "icon": {
    object (Icon)
  },
  "label": string,
  "url": string
}
الحقول
icon

object (Icon)

الرمز المعروض في الشريحة

label

string

النص المعروض في الشريحة

url

string

عنوان URL الذي يتم الانتقال إليه عند النقر على الشريحة

رمز

رمز في الشريحة

تمثيل JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "iconUrl": string,
  "materialIconName": string
  // End of mutually exclusive fields.
}
الحقول
الرمز المعروض في الشريحة في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ:
iconUrl

string

عرض رمز مخصّص مستضاف على عنوان URL يستخدم HTTPS

على سبيل المثال:

"iconUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"

تشمل أنواع الملفات المتوافقة .png و.jpg.

materialIconName

string

اسم الرمز المحدّد في رمز Google Material، على سبيل المثال، check_box. يتم تجاهل أي أسماء غير صالحة واستبدالها بسلسلة فارغة، ما يؤدي إلى تعذُّر عرض الرمز.

نهاية الحقول التي يستبعد كل منها الآخر

StyledText

عنصر نصي يتضمّن أنماطًا مثل الخط الغامق والمائل واللون

تمثيل JSON
{
  "text": string,
  "styles": [
    enum (Style)
  ],
  "fontWeight": enum (FontWeight),
  "color": {
    object (Color)
  },
  "wrapStyle": enum (WrapStyle)
}
الحقول
text

string

المحتوى الرئيسي للنص

styles[]

enum (Style)

مجموعة من الأنماط المطبَّقة على النص

fontWeight

enum (FontWeight)

كثافة خط النص

color

object (Color)

لون النص

wrapStyle

enum (WrapStyle)

نمط التفاف النص

النمط

قائمة تعداد لأنماط النص المختلفة، مثل المائل والمسطر وما إلى ذلك.

عمليات التعداد
STYLE_UNSPECIFIED لم يتم تطبيق أي نمط. DO NOT USE.
ITALIC نمط مائل
UNDERLINE نمط التسطير
STRIKETHROUGH نمط النص المشطوب
LINE_BREAK فاصل سطر
UPPERCASE نمط الأحرف الكبيرة
CODE الرمز البرمجي:
CODE_BLOCK مجموعة رموز

FontWeight

قائمة تعداد لأوزان الخطوط المختلفة

عمليات التعداد
FONT_WEIGHT_UNSPECIFIED وزن عادي وسُمك عادي DO NOT USE.
LIGHT وزن أخفّ وسُمك أقلّ
MEDIUM وزن متوسط بين الفاتح والغامق
BOLD وزن أثقل مع زيادة السُمك

WrapStyle

تعداد لأنماط الالتفاف المختلفة

عمليات التعداد
WRAP_STYLE_UNSPECIFIED لم يتم تحديد نمط التفاف.
NO_WRAP بلا نمط التفاف

ListContainer

حاوية لعناصر القائمة، حيث يمكن أن يحتوي كل عنصر قائمة على عدة عناصر TextFormatElement.

تمثيل JSON
{
  "listNestLevel": string,
  "listType": enum (ListType),
  "listItems": [
    {
      object (ListItem)
    }
  ]
}
الحقول
listNestLevel

string (int64 format)

مستوى دمج القائمة تبدأ من 0 للمستوى الأعلى، وتزيد بمقدار 1 لكل قائمة متداخلة.

listType

enum (ListType)

نوع القائمة

listItems[]

object (ListItem)

مجموعة من عناصر القائمة

ListType

قائمة تعداد لأنواع القوائم المختلفة

عمليات التعداد
LIST_TYPE_UNSPECIFIED لم يتم تحديد نوع القائمة. DO NOT USE.
ORDERED قائمة مع ترتيب
UNORDERED قائمة بدون ترتيب
BLOCKQUOTE تمثّل قائمة اقتباسات.

ListItem

عنصر قائمة

تمثيل JSON
{
  "textFormatElements": [
    {
      object (TextFormatElement)
    }
  ]
}
الحقول
textFormatElements[]

object (TextFormatElement)

مجموعة من عناصر تنسيق النص

FlowLevelContext

سياق على مستوى المسار يحتوي على مخرجات من الخطوات السابقة

تمثيل JSON
{
  "stepContexts": [
    {
      object (StepContext)
    }
  ]
}
الحقول
stepContexts[]

object (StepContext)

اختيارية: قائمة بالخطوات السابقة الترتيب مهم، لذا تأكَّد من الحفاظ على ترتيب التنفيذ في هذه القائمة.

StepContext

البيانات الوصفية لسياق الخطوة والمخرجات للسياق على مستوى التدفق.

تمثيل JSON
{
  "stepId": string,
  "outputs": {
    string: {
      object (VariableData)
    },
    ...
  }
}
الحقول
stepId

string

اختيارية: المعرّف الفريد للخطوة في الرسم البياني لسير العمل

outputs

map (key: string, value: object (VariableData))

اختيارية: تمثّل هذه المَعلمة خريطة لمتغيّرات الناتج التي تم إنشاؤها في هذه الخطوة، ويتم تحديدها حسب اسم المتغيّر.

عنصر يحتوي على قائمة بأزواج "key": value. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }

TriggerCreation

إنشاء مشغِّل سير عمل

تمثيل JSON
{
  "triggerId": string,
  "triggerType": enum (TriggerType),
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "notifyUri": string
}
الحقول
triggerId

string

المعرّف الفريد لعامل التفعيل الذي تم تقديمه أثناء الإنشاء

triggerType

enum (TriggerType)

نوع المشغّل

inputs

map (key: string, value: object (VariableData))

تمثّل هذه المَعلمة خريطة لمتغيّرات الإدخال التي يتم تحديدها حسب اسم متغيّر الإدخال.

عنصر يحتوي على قائمة بأزواج "key": value. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }

notifyUri

string

نقطة النهاية التي سيتم استدعاؤها عند تنشيط المشغّل.

TriggerType

نوع المشغّل

عمليات التعداد
TRIGGER_TYPE_UNDEFINED القيمة التلقائية DO NOT USE.
REPEATING سيتم تنشيط المشغّل في كل مرة يتم فيها استيفاء شروط الإدخال.

TriggerDeletion

حذف مشغِّل سير العمل

تمثيل JSON
{
  "triggerId": string
}
الحقول
triggerId

string

المعرّف الفريد لعامل التفعيل الذي تم تقديمه أثناء الإنشاء

ResourceRetrieval

استرداد مورد

تمثيل JSON
{
  "resourceReference": {
    object (ResourceReference)
  }
}
الحقول
resourceReference

object (ResourceReference)

نوع المرجع ورقم تعريفه المطلوب استردادهما

ElementConfiguration

الاستدعاء عند ضبط عنصر سير عمل

تمثيل JSON
{
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "displayDestination": enum (DisplayDestination),
  "nodeId": string,
  "workflowId": string,
  "availableVariables": [
    {
      object (VariableReference)
    }
  ]
}
الحقول
inputs

map (key: string, value: object (VariableData))

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

عنصر يحتوي على قائمة بأزواج "key": value. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }

displayDestination

enum (DisplayDestination)

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

nodeId

string

تمثّل هذه السمة رقم تعريف العقدة للإعدادات الأساسية التي يتم عرضها.

workflowId

string

معرّف سير العمل للإعدادات الأساسية التي يتم عرضها

availableVariables[]

object (VariableReference)

المتغيّرات المتاحة مرتّبة حسب موضع العقدة

DisplayDestination

يشير إلى مكان عرض بطاقة إعدادات العنصر الذي يتم إرجاعه.

عمليات التعداد
DISPLAY_DESTINATION_UNSPECIFIED القيمة التلقائية DO NOT USE.
DISPLAY_DESTINATION_SIDE_PANEL سيتم عرض بطاقة الإعدادات في اللوحة الجانبية.
DISPLAY_DESTINATION_FULL_SCREEN سيتم عرض بطاقة الإعداد في تطبيق "ملء الشاشة".

VariableReference

مرجع متغيّر لمتغيّر في سير العمل

تمثيل JSON
{
  "parentElementId": string,
  "nodeId": string,
  "path": string,
  "dataType": {
    object (DataType)
  },
  "iconUrl": string,
  "stepNumber": integer,
  "descriptionText": string,
  "displayText": string
}
الحقول
parentElementId

string

The primitive id of the element that produces the variable We can expand this to WorkflowElement or a more detailed metadata proto if needed.

nodeId

string

رقم التعريف المرجعي للعقدة

path

string

توقيع مسار أداة اختيار المتغيّرات

dataType

object (DataType)

نوع بيانات المتغيّر

iconUrl

string

عنوان URL لرمز العنصر الأساسي الذي ينتج هذا المتغيّر.

stepNumber

integer

رقم خطوة العنصر الأساسي الذي ينتج هذا المتغيّر.

descriptionText

string

وصف المتغيّر

displayText

string

النص المعروض لشريحة المتغيّر

DataType

نوع المتغيّر

تمثيل JSON
{
  "valueMetadata": {
    object (ValueMetadata)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "basicType": enum (BasicType),
  "resourceType": {
    object (ResourceType)
  }
  // End of mutually exclusive fields.
}
الحقول
valueMetadata

object (ValueMetadata)

بيانات وصفية حول القيم المحتمَلة لمتغيّر معيّن

نوع البيانات في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ:
basicType

enum (BasicType)

نوع البيانات الأساسي

resourceType

object (ResourceType)

نوع معرّف مورد التطبيق

نهاية الحقول التي يستبعد كل منها الآخر

BasicType

أنواع البيانات العامة الأساسية

عمليات التعداد
BASIC_TYPE_UNSPECIFIED القيمة التلقائية DO NOT USE.
STRING سلسلة من الأحرف
INTEGER عدد صحيح
FLOAT رقم النقطة الحرة.
TIMESTAMP الطابع الزمني بتنسيق ISO 8601
BOOLEAN قيمة يمكن أن تكون صحيحة أو خاطئة.
EMAIL_ADDRESS عنوان بريد إلكتروني، وهو سلسلة بتنسيق عنوان بريد إلكتروني
GOOGLE_USER مستخدم خدمات Google، بالتنسيق users/{user}
FILE مرجع الملف
FORMATTED_TEXT نص بتنسيق منسّق

ValueMetadata

معلومات عن القيم المحتمَلة لمتغيّر معيّن

تمثيل JSON
{
  "enumValues": [
    string
  ],
  "dynamicTypes": [
    enum (BasicType)
  ],
  "semanticDescriptors": [
    {
      object (SemanticDescriptor)
    }
  ],
  "dynamicSchema": {
    object (DynamicSchema)
  },
  "defaultValue": string
}
الحقول
enumValues[]

string

اختيارية: تحدّد القيم المسموح بها لسلسلة. لا يمكن ضبط هذه السياسة إلا إذا كانت قيمة DataType هي STRING.

dynamicTypes[]

enum (BasicType)

اختيارية: تحدّد هذه السياسة الأنواع المسموح بها والتي يمكن تحويلها ديناميكيًا لمتغيّر معيّن. لا يمكن ضبط هذه السمة إلا إذا كان DataType هو سلسلة وكان المتغيّر هو مخرجات.

semanticDescriptors[]

object (SemanticDescriptor)

اختيارية: يساعد في وصف المعنى الدلالي للمتغيّر.

dynamicSchema

object (DynamicSchema)

اختيارية: إعدادات لحلّ مخطط هذا المتغيّر ديناميكيًا

defaultValue

string

اختيارية: سلسلة تحدّد القيمة التلقائية لهذا المتغيّر. على سبيل المثال، بالنسبة إلى القيم المنطقية، يمكن ضبط defaultValue على true أو false.

SemanticDescriptor

بيانات وصفية حول المعنى الدلالي لمتغيّر

تمثيل JSON
{
  "resourceAttribute": string,
  "disallowedResourceAttributes": [
    string
  ]
}
الحقول
resourceAttribute

string

يشير إلى أنّ المتغيّر يتوافق مع سمة معيّنة لمورد. ويُعدّ ذلك مفيدًا بشكل خاص للمتغيّرات التي تمثّل معرّفًا لمورد (المعرّف وعنوان URL والمفتاح وما إلى ذلك).

التنسيق المقترَح هو: - "{brand}/{appName}/{resource}:{attribute}" {brand} اختياري ويجب حذفه إذا كان مطابقًا لـ {appName}.

أمثلة: - "google/drive/file:id" - "google/drive/folder:id" - "google/docs/document:id" - "google/sheets/spreadsheet:id" - "jira/issue:key" - "slack/channel:id" وما إلى ذلك

سيستخدم العميل هذه المعلومات لتلميح المستخدم إلى متغيرات الإخراج المتوافقة مع مدخلات معينة.

disallowedResourceAttributes[]

string

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

DynamicSchema

إعدادات لحلّ مخطط هذا المتغيّر ديناميكيًا في وقت التشغيل

تمثيل JSON
{
  "requiredInputIds": [
    string
  ],
  "strictEnum": boolean
}
الحقول
requiredInputIds[]

string

أرقام تعريف متغيّرات الإدخال الشقيقة التي يجب تقديمها قبل أن يتم حلّ مخطط هذا المتغيّر ديناميكيًا.

strictEnum

boolean

عندما تكون القيمة "صحيح"، يجب أن تتطابق قيمة المتغيّر مع إحدى قيم التعداد التي تم حلّها ديناميكيًا. عند ضبط القيمة على "خطأ"، يتم التعامل مع القيم التي تم حلّها ديناميكيًا كاقتراحات غير صارمة.

ResourceFieldsDefinitionRetrieval

تسترد هذه الطريقة تعريف الحقول التي يتيحها مورد معيّن.

تمثيل JSON
{
  "elementId": string,
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  }
}
الحقول
elementId

string

تحدّد هذه السمة معرّف العنصر الذي سيتم جلب مخطّط الموارد الديناميكية الخاص به.

inputs

map (key: string, value: object (VariableData))

يتألف ذلك من إدخالات حقول العقدة التي توفّر المتغيّر. تمثّل هذه المَعلمة خريطة لمتغيّرات الإدخال التي يتم تحديدها حسب اسم متغيّر الإدخال.

عنصر يحتوي على قائمة بأزواج "key": value. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }

ElementUiAutocomplete

اقتراحات الإكمال التلقائي للبطاقة المعروضة حاليًا

تمثيل JSON
{
  "query": string,
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "invokedFunction": string,
  "resourceId": string,
  "operationId": string
}
الحقول
query

string

طلب البحث المطلوب إكماله تلقائيًا

inputs

map (key: string, value: object (VariableData))

تمثّل هذه المَعلمة خريطة لمتغيّرات الإدخال التي يتم تحديدها حسب اسم متغيّر الإدخال.

عنصر يحتوي على قائمة بأزواج "key": value. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }

invokedFunction

string

الدالة التي تم استدعاؤها والمرتبطة بعنصر واجهة المستخدم

resourceId

string

رقم تعريف المورد الذي يجب إكماله تلقائيًا هذا الحقل اختياري وقد لا يتم ضبطه.

operationId

string

رقم تعريف العملية التي قدّمت المورد المطلوب إكماله تلقائيًا. هذا الحقل اختياري وقد لا يتم ضبطه.

ExecutionMetadata

البيانات الوصفية حول تنفيذ سير العمل

تمثيل JSON
{
  "versionId": integer,
  "timeZone": string,
  "stepNumber": integer
}
الحقول
versionId

integer

إصدار عنصر سير العمل الذي يتم استدعاؤه

timeZone

string

المنطقة الزمنية لسير العمل الذي يتم حفظه، مثل "America/Los_Angeles".

stepNumber

integer

يمثّل رقم خطوة العنصر الأساسي الذي يتم استدعاؤه.

TriggerEventSource

مصدر حدث التفعيل الذي أدّى إلى هذا التنفيذ

عمليات التعداد
TRIGGER_EVENT_SOURCE_UNSPECIFIED القيمة التلقائية DO NOT USE.
TRIGGER_EVENT_SOURCE_AUTOMATED يتم تشغيل التنفيذ تلقائيًا من خلال الأحداث.
TRIGGER_EVENT_SOURCE_TEST_RUN يتم بدء التنفيذ من خلال التشغيل التجريبي.