- EventObject
- CommonEventObject
- HostApp
- المنصة
- TimeZone
- المدخلات
- StringInputs
- DateTimeInput
- DateInput
- TimeInput
- AuthorizationEventObject
- CalendarEventObject
- المنظِّم
- المشاركون
- ConferenceData
- ConferenceSolution
- المفتاح
- EntryPoint
- المعلَمات
- AddOnParameters
- الإمكانات
- DriveEventObject
- DriveItemMetadata
- GmailEventObject
- SheetsEventObject
- MatchedUrl
- SlidesEventObject
- DocsEventObject
- ChatEventObject
- EventType
- MessagePayload
- AddedToSpacePayload
- RemovedFromSpacePayload
- ButtonClickedPayload
- DialogEventType
- WidgetUpdatedPayload
- AppCommandPayload
- AppCommandMetadata
- AppCommandType
- SystemCommandPayload
- SystemCommandMetadata
- CancelStream
- WorkflowEventObject
- ActionInvocation
- VariableData
- ResourceReference
- ResourceType
- WorkflowTextFormat
- TextFormatElement
- Chip
- الرمز
- StyledText
- النمط
- FontWeight
- WrapStyle
- Hyperlink
- ListContainer
- ListType
- ListItem
- FlowLevelContext
- StepContext
- TriggerCreation
- TriggerType
- TriggerDeletion
- ResourceRetrieval
- ElementConfiguration
- DisplayDestination
- VariableReference
- DataType
- BasicType
- ValueMetadata
- SemanticDescriptor
- DynamicSchema
- ResourceFieldsDefinitionRetrieval
- ElementUiAutocomplete
- ExecutionMetadata
- TriggerEventSource
EventObject
حدث تفاعل مع إضافة Google يحتوي على بيانات حول تفاعل المستخدم مع إضافة ضمن تطبيق مضيف.
يتم تمرير كائن الحدث بتنسيق JSON إلى دالة رد الاتصال أو المشغّل (لـ AppsScript) أو نقطة نهاية https (لـ HTTP) الخاصة بإضافة، وذلك عندما يتفاعل مستخدم مع إضافة داخل تطبيق مضيف. يخزّن كائن الحدث كائن حدث تطبيق مضيف يحدّده كل تطبيق مضيف، بالإضافة إلى كائن حدث شائع يحتوي على بعض الحقول الشائعة ذات الصلة بالحدث.
لمزيد من المعلومات، يُرجى الاطّلاع على كائنات الأحداث.
| تمثيل JSON |
|---|
{ "commonEventObject": { object ( |
| الحقول | |
|---|---|
commonEventObject |
كائن يحتوي على معلومات مشتركة بين جميع كائنات الأحداث، بغض النظر عن التطبيق المضيف. |
authorizationEventObject |
يتم ضبطها فقط للطلبات المرسَلة إلى نقاط نهاية HTTP |
| في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ: | |
calendar |
لا يتم عرض هذه السمة إلا إذا كان المضيف الذي يطلب البيانات هو "تقويم Google". عنصر يحتوي على معلومات التقويم والحدث |
drive |
لا يظهر إلا إذا كان المضيف المتصل هو Google Drive. عنصر يحتوي على معلومات Drive |
gmail |
لا يظهر هذا الخيار إلا إذا كان المضيف المتصل هو Gmail. عنصر يحتوي على معلومات Gmail |
sheets |
لا تظهر إلا إذا كان المضيف الذي يستدعيها هو "جداول بيانات Google". عنصر يحتوي على معلومات "جداول بيانات Google". |
slides |
لا تظهر إلا إذا كان المضيف الذي يطلبها هو "العروض التقديمية من Google". عنصر يحتوي على معلومات "العروض التقديمية من Google". |
docs |
لا تظهر إلا إذا كان المضيف الذي يطلبها هو "مستندات Google". عنصر يحتوي على معلومات "مستندات Google". |
chat |
لا تظهر إلا إذا كان مضيف المكالمة هو Google Chat. عنصر يحتوي على معلومات Chat. |
workflow |
لا يظهر إلا إذا كان المضيف المتصل هو Google Workspace Studio. عنصر يحتوي على معلومات سير العمل |
| نهاية الحقول التي يستبعد كل منها الآخر | |
CommonEventObject
كائن الحدث الشائع هو جزء من كائن الحدث العام الذي يحمل معلومات عامة ومستقلة عن المضيف إلى الإضافة من برنامج المستخدم. وتشمل هذه المعلومات تفاصيل مثل لغة المستخدم والتطبيق المضيف والمنصة.
بالإضافة إلى الصفحة الرئيسية والمشغّلات المستندة إلى السياق، تنشئ الإضافات كائنات الأحداث وتمرّرها إلى دوال رد الاتصال للإجراءات عندما يتفاعل المستخدم مع التطبيقات المصغّرة. يمكن لدالة رد الاتصال في الإضافة الاستعلام عن كائن الحدث الشائع لتحديد محتوى التطبيقات المصغّرة المفتوحة في برنامج المستخدم. على سبيل المثال، يمكن للإضافة تحديد مكان النص الذي أدخله المستخدم في تطبيق مصغّر TextInput في الكائن eventObject.commentEventObject.formInputs.
بالنسبة إلى تطبيقات Chat، يشير هذا الحقل إلى اسم الدالة التي استدعاها المستخدم عند التفاعل مع تطبيق مصغّر.
| تمثيل JSON |
|---|
{ "userLocale": string, "hostApp": enum ( |
| الحقول | |
|---|---|
userLocale |
يكون غير مفعَّل تلقائيًا. معرّف لغة المستخدم وبلده/منطقته بتنسيق رمز اللغة ISO 639-رمز البلد/المنطقة ISO 3166. مثلاً: لتفعيل هذا الحقل، يجب ضبط |
hostApp |
يشير إلى التطبيق المضيف الذي تكون الإضافة نشطة فيه عند إنشاء كائن الحدث. تشمل القيم المحتملة ما يلي:
|
platform |
تعداد النظام الأساسي الذي يشير إلى النظام الأساسي الذي ينشأ منه الحدث ( |
timeZone |
يكون غير مفعَّل تلقائيًا. معرّف المنطقة الزمنية وفرق التوقيت عن التوقيت العالمي المنسّق (UTC). لتفعيل هذا الحقل، يجب ضبط لا يتوفّر هذا الحقل إلا لنوعَي الأحداث |
formInputs |
خريطة تحتوي على القيم الحالية للتطبيقات المصغّرة في البطاقة المعروضة مفاتيح الخريطة هي قيم السلسلة تعتمد بنية عنصر قيمة الخريطة على نوع التطبيق المصغّر: ملاحظة: تم تنسيق الأمثلة التالية لوقت تشغيل V8 في "برمجة تطبيقات Google". إذا كنت تستخدم وقت تشغيل Rhino، يجب إضافة
مثال: بالنسبة إلى تطبيق مصغّر لإدخال النص يتضمّن
مثال: بالنسبة إلى تطبيق مصغّر متعدد القيم يتضمّن
مثال: بالنسبة إلى أداة اختيار تتضمّن
مثال: بالنسبة إلى أداة اختيار تتضمّن
مثال: بالنسبة إلى أداة اختيار تتضمّن عنصر يحتوي على قائمة بأزواج |
parameters |
أي مَعلمات إضافية تقدّمها لإجراء معيّن باستخدام معاينة المطوّر: بالنسبة إلى الإضافات التي توسّع Google Chat، لاقتراح عناصر استنادًا إلى ما يكتبه المستخدمون في قوائم الاختيار المتعدّد، استخدِم قيمة مفتاح عنصر يحتوي على قائمة بأزواج |
invokedFunction |
اسم الدالة المطلوب استدعاؤها لا تتم تعبئة هذا الحقل لإضافات Google Workspace التي توسّع Google Chat. بدلاً من ذلك، لتلقّي بيانات الدوال، مثل المعرّفات، يجب أن تستخدم الإضافات التي توسّع 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 |
رمز قاعدة بيانات المنطقة الزمنية IANA TZ، مثل "America/Toronto". |
offset |
يشير هذا الحقل إلى إزاحة المنطقة الزمنية للمستخدم، بالمللي ثانية، عن التوقيت العالمي المنسّق (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 |
قيم إدخال التاريخ والوقت من تطبيق مصغّر |
dateInput |
قيم إدخال التاريخ من تطبيق مصغّر |
timeInput |
قيم إدخال الوقت من تطبيق مصغّر |
| نهاية الحقول التي يستبعد كل منها الآخر | |
StringInputs
مَعلمة الإدخال للأدوات العادية بالنسبة إلى التطبيقات المصغّرة ذات القيمة الواحدة، تكون القيمة قائمة بقيمة واحدة. بالنسبة إلى التطبيقات المصغّرة المتعدّدة القيم، مثل مربّع الاختيار، يتم عرض جميع القيم.
| تمثيل JSON |
|---|
{ "value": [ string ] } |
| الحقول | |
|---|---|
value[] |
قائمة بالسلاسل التي أدخلها المستخدم |
DateTimeInput
قيم إدخال التاريخ والوقت
| تمثيل JSON |
|---|
{ "msSinceEpoch": string, "hasDate": boolean, "hasTime": boolean } |
| الحقول | |
|---|---|
msSinceEpoch |
الوقت منذ بداية حقبة معيّنة، بالملي ثانية |
hasDate |
ما إذا كان إدخال |
hasTime |
ما إذا كان إدخال |
DateInput
قيم إدخال التاريخ
| تمثيل JSON |
|---|
{ "msSinceEpoch": string } |
| الحقول | |
|---|---|
msSinceEpoch |
الوقت منذ بداية حقبة معيّنة، بالملي ثانية |
TimeInput
قيم إدخال الوقت
| تمثيل JSON |
|---|
{ "hours": integer, "minutes": integer } |
| الحقول | |
|---|---|
hours |
الساعة بتنسيق 24 ساعة |
minutes |
عدد الدقائق بعد الساعة القيم الصالحة هي من 0 إلى 59. |
AuthorizationEventObject
تتضمّن معلومات التفويض لطلب الإضافة
| تمثيل JSON |
|---|
{ "userOAuthToken": string, "userIdToken": string, "systemIdToken": string, "authorizedScopes": [ string ] } |
| الحقول | |
|---|---|
userOAuthToken |
رمز الدخول لبروتوكول OAuth الخاص بالمستخدم النهائي، والمصرَّح به مع النطاقات المطلوبة (بعد إلغاء تجميع موافقة OAuth، سيتم تفويض ذلك باستخدام النطاقات المفوَّضة للمستخدم النهائي) |
userIdToken |
رمز مميّز لرقم تعريف المستخدم النهائي، إذا تم طلب نطاقات أرقام تعريف مناسبة |
systemIdToken |
رمز مميّز للتعريف لحساب خدمة إضافات G Suite لعملية النشر هذه |
authorizedScopes[] |
قائمة بنطاقات OAuth التي سمح بها المستخدم |
CalendarEventObject
كائن حدث "تقويم Google" هو جزء من كائن الحدث العام الذي يحمل معلومات عن تقويم المستخدم وأحداث التقويم. ولا يتوفّر إلا في كائن حدث إذا كان التطبيق المضيف هو "تقويم Google".
يسرد الجدول التالي الحقول الموجودة في الحقل calendar لكائن حدث. تكون الحقول التي تم وضع علامة بيانات من إنشاء المستخدمين عليها موجودة في كائن الحدث فقط إذا كانت البيانات موجودة في حدث في التقويم وضبطت الإضافة حقل addOns.calendar.currentEventAccess البيان على READ أو READ_WRITE.
| تمثيل JSON |
|---|
{ "id": string, "recurringEventId": string, "calendarId": string, "organizer": { object ( |
| الحقول | |
|---|---|
id |
رقم تعريف الحدث |
recurringEventId |
رقم تعريف حدث متكرّر |
calendarId |
رقم تعريف التقويم |
organizer |
عنصر يمثّل منظّم الحدث |
attendees[] |
البيانات من إنشاء المستخدمين: قائمة بالمشاركين في الحدث في التقويم |
conferenceData |
البيانات من إنشاء المستخدمين: عنصر يمثّل أي بيانات اجتماع مرتبطة بهذا الحدث، مثل تفاصيل اجتماع Google Meet. |
capabilities |
البيانات من إنشاء المستخدمين: عنصر يصف إمكانات الإضافة لعرض معلومات الحدث أو تعديلها. |
المنظّم
| تمثيل JSON |
|---|
{ "email": string } |
| الحقول | |
|---|---|
email |
عنوان البريد الإلكتروني لمنظّم الحدث |
المشارك
تحمل عناصر المشاركين معلومات عن المشاركين الفرديين في أحداث "تقويم 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 |
عنوان البريد الإلكتروني للمشارك |
displayName |
الاسم المعروض للمشارك |
organizer |
صحيح إذا كان المشارك منظِّمًا لهذا الحدث. |
self |
صحيح إذا كان هذا المشارك يمثّل التقويم الذي يظهر فيه هذا الحدث، وخطأ في الحالات الأخرى. |
resource |
صحيح إذا كان المشارك يمثّل موردًا، مثل غرفة أو قطعة من المعدات، وخطأ في الحالات الأخرى. |
optional |
صحيح إذا تم وضع علامة على حضور هذا المشارك على أنّه اختياري، وخطأ في الحالات الأخرى. |
responseStatus |
تمثّل هذه السمة حالة ردّ المشارك. تشمل القيم المحتملة ما يلي:
|
comment |
تعليق ردّ المشارك، إن وُجد. |
additionalGuests |
عدد الضيوف الإضافيين الذين أشار المشارك إلى أنّه سيحضرهم وتكون القيم التلقائية صفرًا. |
ConferenceData
تحمل عناصر بيانات الاجتماعات معلومات عن الاجتماعات المرفقة بأحداث "تقويم Google". ويمكن أن تكون هذه الاجتماعات من خلال منصات لمكالمات فيديو من Google، مثل Google Meet، أو من خلال منصات تابعة لجهات خارجية. تتوفّر هذه المعلومات في كائن حدث فقط إذا كانت البيانات متوفّرة في حدث في التقويم وضبطت الإضافة حقل addOns.calendar.currentEventAccess في البيان على READ أو READ_WRITE.
| تمثيل JSON |
|---|
{ "conferenceId": string, "conferenceSolution": { object ( |
| الحقول | |
|---|---|
conferenceId |
رقم تعريف مكالمة الفيديو يهدف هذا المعرّف إلى السماح للتطبيقات بتتبُّع الاجتماعات، لذا يجب عدم عرضه للمستخدمين. |
conferenceSolution |
عنصر يمثّل منصة لمكالمات الفيديو، مثل Hangouts أو Google Meet |
entryPoints[] |
قائمة نقاط الدخول إلى الاجتماع، مثل عناوين URL أو أرقام الهواتف |
notes |
ملاحظات إضافية (مثل تعليمات من مشرف النطاق أو إشعارات قانونية) حول الاجتماع لعرضها للمستخدم يمكن أن يحتوي على HTML. الحد الأقصى لعدد الأحرف هو 2048 حرفًا. |
parameters |
عنصر يحتوي على خريطة لبيانات المَعلمات المحدّدة لتستخدمها الإضافة. |
ConferenceSolution
| تمثيل JSON |
|---|
{
"iconUri": string,
"key": {
object ( |
| الحقول | |
|---|---|
iconUri |
معرّف الموارد المنتظم (URI) للرمز المرئي للمستخدم الذي يمثّل منصة مكالمات الفيديو هذه. |
key |
المفتاح الذي يحدّد بشكل فريد منصة مكالمات الفيديو لهذا الحدث |
name |
اسم منصة مكالمات الفيديو هذه الذي يظهر للمستخدم (غير مترجَم) |
المفتاح
| تمثيل JSON |
|---|
{ "type": string } |
| الحقول | |
|---|---|
type |
نوع منصة مكالمات الفيديو تشمل القيم المحتملة ما يلي:
|
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 |
رمز الدخول المستخدَم للانضمام إلى المكالمة الجماعية الحد الأقصى للطول هو 128 حرفًا. عادةً ما يستخدم مقدّمو خدمات الاجتماعات مجموعة فرعية فقط من {accessCode, meetingCode, passcode, password, pin} لتوفير إمكانية الوصول إلى الاجتماعات. مطابقة الحقول التي يستخدمها مقدّم خدمة الاجتماعات وعرضها فقط |
entryPointType |
نوع نقطة الدخول القيم المحتمَلة هي:
|
label |
التصنيف المرئي للمستخدم لمعرّف الموارد المنتظم (URI) لنقطة الدخول (غير مترجَم) |
meetingCode |
رمز الاجتماع المستخدَم للوصول إلى الاجتماع الحد الأقصى للطول هو 128 حرفًا. عادةً ما يستخدم مقدّمو خدمات الاجتماعات مجموعة فرعية فقط من {accessCode, meetingCode, passcode, password, pin} لتوفير إمكانية الوصول إلى الاجتماعات. مطابقة الحقول التي يستخدمها مقدّم خدمة الاجتماعات وعرضها فقط |
passcode |
رمز المرور المستخدَم للوصول إلى المؤتمر الحد الأقصى للطول هو 128 حرفًا. عادةً ما يستخدم مقدّمو خدمات الاجتماعات مجموعة فرعية فقط من {accessCode, meetingCode, passcode, password, pin} لتوفير إمكانية الوصول إلى الاجتماعات. مطابقة الحقول التي يستخدمها مقدّم خدمة الاجتماعات وعرضها فقط |
password |
كلمة المرور المستخدَمة للوصول إلى المؤتمر الحد الأقصى للطول هو 128 حرفًا. عادةً ما يستخدم مقدّمو خدمات الاجتماعات مجموعة فرعية فقط من {accessCode, meetingCode, passcode, password, pin} لتوفير إمكانية الوصول إلى الاجتماعات. مطابقة الحقول التي يستخدمها مقدّم خدمة الاجتماعات وعرضها فقط |
pin |
رقم التعريف الشخصي المستخدَم للوصول إلى الاجتماع الحد الأقصى للطول هو 128 حرفًا. عادةً ما يستخدم مقدّمو خدمات الاجتماعات مجموعة فرعية فقط من {accessCode, meetingCode, passcode, password, pin} لتوفير إمكانية الوصول إلى الاجتماعات. مطابقة الحقول التي يستخدمها مقدّم خدمة الاجتماعات وعرضها فقط |
uri |
معرّف الموارد المنتظم (URI) لنقطة الدخول الحد الأقصى للطول هو 1,300 حرف. يعتمد التنسيق على نوع نقطة الدخول:
|
regionCode |
رمز منطقة رقم الهاتف يحتاج إليه المستخدمون إذا لم يتضمّن معرّف الموارد المنتظم (URI) رمز بلد. تستند القيم إلى قائمة رموز المناطق العامة في CLDR. |
entryPointFeatures[] |
ميزات نقطة الدخول في الوقت الحالي، تنطبق هذه الميزات على نقاط الدخول عبر الهاتف فقط:
|
المعلمات
| تمثيل JSON |
|---|
{
"addOnParameters": {
object ( |
| الحقول | |
|---|---|
addOnParameters |
تمثّل هذه السمة خريطة لمفاتيح وقيم سلاسل المَعلمات. يحدّد مطوّر الإضافة هذه المفاتيح والقيم لإرفاق المعلومات باجتماع معيّن لاستخدام الإضافة. |
AddOnParameters
| تمثيل JSON |
|---|
{ "parameters": { string: string, ... } } |
| الحقول | |
|---|---|
parameters |
عنصر يحتوي على قائمة بأزواج |
الإمكانات
| تمثيل JSON |
|---|
{ "canSeeAttendees": boolean, "canAddAttendees": boolean, "canSeeConferenceData": boolean, "canSetConferenceData": boolean, "canAddAttachments": boolean } |
| الحقول | |
|---|---|
canSeeAttendees |
البيانات التي ينشئها المستخدم: صحيح إذا كان بإمكان الإضافة قراءة قائمة المدعوين إلى الحدث، وخطأ في الحالات الأخرى. |
canAddAttendees |
البيانات التي ينشئها المستخدم: صحيح إذا كان بإمكان الإضافة إضافة مشاركين جُدد إلى قائمة المشاركين في الحدث، وخطأ في الحالات الأخرى. |
canSeeConferenceData |
البيانات التي ينشئها المستخدم: صحيح إذا كان بإمكان الإضافة قراءة بيانات اجتماع الحدث، وخطأ في الحالات الأخرى. |
canSetConferenceData |
بيانات من إنشاء المستخدمين: صحيح إذا كان بإمكان الإضافة تعديل بيانات اجتماع الحدث، وخطأ في الحالات الأخرى |
canAddAttachments |
البيانات التي ينشئها المستخدم: صحيح إذا كان بإمكان الإضافة إدراج مرفقات جديدة إلى الحدث، وخطأ في الحالات الأخرى. |
DriveEventObject
كائن حدث Drive هو جزء من كائن الحدث العام الذي يحمل معلومات حول Google Drive الخاص بالمستخدم ومحتواه. ولا يتوفّر إلا في كائن حدث إذا كان التطبيق المضيف هو Google Drive.
| تمثيل JSON |
|---|
{ "selectedItems": [ { object ( |
| الحقول | |
|---|---|
selectedItems[] |
قائمة بالعناصر (الملفات أو المجلدات) المحدّدة في Drive |
activeCursorItem |
ملف Drive النشط حاليًا |
DriveItemMetadata
تحمل عناصر Drive معلومات حول عناصر معيّنة في Drive، مثل الملفات أو المجلدات.
| تمثيل JSON |
|---|
{ "id": string, "iconUrl": string, "mimeType": string, "title": string, "addonHasFileScopePermission": boolean } |
| الحقول | |
|---|---|
id |
معرّف العنصر المحدّد |
iconUrl |
عنوان URL للرمز الذي يمثّل العنصر المحدّد |
mimeType |
نوع MIME للعنصر المحدّد |
title |
عنوان العنصر المحدّد |
addonHasFileScopePermission |
إذا كانت القيمة 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 |
رقم تعريف رسالة Gmail المفتوحة حاليًا |
threadId |
رقم تعريف سلسلة محادثات Gmail المفتوحة حاليًا |
accessToken |
رمز الدخول الخاص بـ Gmail يمكنك استخدام هذا الرمز المميّز مع طريقة |
toRecipients[] |
يكون غير مفعَّل تلقائيًا. قائمة عناوين البريد الإلكتروني للمستلِمين في الحقل "إلى:" المضمّنة حاليًا في مسودة تنشئها الإضافة لتفعيل هذا الحقل، يجب ضبط الحقل |
ccRecipients[] |
يكون غير مفعَّل تلقائيًا. قائمة عناوين البريد الإلكتروني للمستلِمين في الحقل "نسخة إلى:" المضمّنة حاليًا في مسودة تنشئها الإضافة لتفعيل هذا الحقل، يجب ضبط الحقل |
bccRecipients[] |
يكون غير مفعَّل تلقائيًا. قائمة عناوين البريد الإلكتروني للمستلِمين في حقل "نسخة مخفية الوجهة" المضمّنة حاليًا في مسودة تنشئها الإضافة. لتفعيل هذا الحقل، يجب ضبط الحقل |
SheetsEventObject
كائن حدث "جداول بيانات Google" هو جزء من كائن الحدث العام الذي يحمل معلومات عن مستند المستخدم ومحتواه. ولا يتوفّر إلا في كائن حدث إذا كانت الإضافة توسّع "جداول بيانات Google".
| تمثيل JSON |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| الحقول | |
|---|---|
id |
لا يظهر هذا الحقل إلا إذا منح المستخدم الإذن للنطاق |
title |
لا يظهر هذا الحقل إلا إذا منح المستخدم الإذن للنطاق |
addonHasFileScopePermission |
إذا كانت القيمة |
matchedUrl |
لا تظهر إلا في حال استيفاء الشروط التالية:
عنوان URL للرابط الذي ينشئ معاينة في "جداول بيانات Google". لاستخدام هذا الحقل، يجب ضبط مثال على الحمولة عندما يعاين المستخدم الرابط |
MatchedUrl
كائن الحدث الذي يتم عرضه مع طلبات معاينة الروابط
| تمثيل JSON |
|---|
{ "url": string } |
| الحقول | |
|---|---|
url |
عنوان URL الذي تمت مطابقته |
SlidesEventObject
كائن حدث "العروض التقديمية من Google" هو جزء من كائن الحدث العام الذي يحمل معلومات عن مستند المستخدم ومحتواه. ولا يتوفّر إلا في كائن حدث إذا كانت الإضافة توسّع "العروض التقديمية من Google".
| تمثيل JSON |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| الحقول | |
|---|---|
id |
لا يظهر هذا الحقل إلا إذا منح المستخدم الإذن للنطاق |
title |
لا يظهر هذا الحقل إلا إذا منح المستخدم الإذن للنطاق |
addonHasFileScopePermission |
إذا كانت القيمة |
matchedUrl |
لا تظهر إلا في حال استيفاء الشروط التالية:
عنوان URL للرابط الذي ينشئ معاينة في "العروض التقديمية من Google" لاستخدام هذا الحقل، يجب ضبط مثال على الحمولة عندما يعاين المستخدم الرابط |
DocsEventObject
كائن حدث "مستندات Google" هو جزء من كائن الحدث العام الذي يحمل معلومات حول مستند المستخدم ومحتوياته. ولا يتوفّر إلا في كائن حدث إذا كانت الإضافة توسّع "مستندات Google".
| تمثيل JSON |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| الحقول | |
|---|---|
id |
لا يظهر هذا الحقل إلا إذا منح المستخدم الإذن للنطاق |
title |
لا يظهر هذا الحقل إلا إذا منح المستخدم الإذن للنطاق |
addonHasFileScopePermission |
إذا كانت القيمة |
matchedUrl |
لا تظهر إلا في حال استيفاء الشروط التالية:
عنوان URL للرابط الذي ينشئ معاينة في "مستندات Google". لاستخدام هذا الحقل، يجب ضبط مثال على الحمولة عندما يعاين المستخدم الرابط |
ChatEventObject
حمولة كائن حدث تطبيق Google Chat يتم إرسالها من خادم Google إلى الإضافات. يمكن استخدام الحمولة لتحديد نوع الحدث.
| تمثيل JSON |
|---|
{ "type": enum ( |
| الحقول | |
|---|---|
type |
نوع الحدث، ويتم ملؤه فقط لأحداث "الصفحة الرئيسية للتطبيق" في تطبيقات Chat التي ليست إضافات. |
user |
المستخدم الذي يتفاعل مع تطبيق Chat |
space |
المساحة التي وقع فيها الحدث، وتتم تعبئتها فقط لأحداث "الصفحة الرئيسية للتطبيق" في تطبيقات Chat التي ليست إضافات. |
eventTime |
الطابع الزمني الذي يشير إلى وقت حدوث كائن الحدث يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: |
| حمولة كائن الحدث تعتمد الحمولات على نوع كائن الحدث. في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ: | |
messagePayload |
يرسل المستخدم رسالة إلى تطبيق Chat أو يشير إليه باستخدام @في مساحة. يتم إرسال طلبات تشغيل التطبيقات (مثل الأوامر التي تبدأ بشرطة مائلة والأوامر السريعة) في |
addedToSpacePayload |
يضيف مستخدم تطبيق Chat إلى مساحة Chat، أو يثبّت مشرف حسابات Google Workspace تطبيق Chat في مساحات الرسائل المباشرة للمستخدمين في مؤسسته. |
removedFromSpacePayload |
يزيل مستخدم تطبيق Chat من مساحة. |
buttonClickedPayload |
تمثّل بيانات الحمولة عندما يتفاعل مستخدم مع عنصر تفاعلي في بطاقة أو مربّع حوار يؤدي إلى استدعاء إذا تفاعل مستخدم مع مربّع حوار، يتم ضبط الحقل تتضمّن الحمولة الكاملة أيضًا |
widgetUpdatedPayload |
يعدّل المستخدم تطبيقًا مصغّرًا في بطاقة ضمن ساحة المشاركات أو في مربّع حوار. تتضمّن الحمولة الكاملة أيضًا |
appCommandPayload |
يستدعي المستخدم أمر تطبيق. |
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 |
الحقل مطلوب. مساحة Chat التي يحدث فيها كائن الحدث |
message |
الرسالة التي تؤدي إلى تفعيل كائن الحدث |
configCompleteRedirectUri |
اختيارية: عنوان URL الذي يجب أن يعيد تطبيق Chat توجيه المستخدم إليه بعد إكمال مسار التفويض أو الإعداد خارج Google Chat. لمزيد من المعلومات، يُرجى الاطّلاع على المقالة ربط تطبيق في Chat بخدمات وأدوات أخرى. |
AddedToSpacePayload
يضيف مستخدم تطبيق Chat إلى مساحة، أو يتم إنشاء رسالة مباشرة بين التطبيق والمستخدم.
| تمثيل JSON |
|---|
{
"space": {
object ( |
| الحقول | |
|---|---|
space |
الحقل مطلوب. مساحة Chat التي يحدث فيها كائن الحدث |
interactionAdd |
ما إذا تمت إضافة التطبيق إلى المساحة من خلال تفاعل المستخدم (مثلاً، من خلال الإشارة إلى تطبيق Chat باستخدام @ أو استدعائه باستخدام أمر يبدأ بشرطة مائلة) إذا تم ضبط هذه السياسة على "صحيح"، سيتم إرسال كائن حدث منفصل مرتبط بالتفاعل نفسه إلى تطبيق Chat. |
configCompleteRedirectUri |
اختيارية: عنوان URL الذي يجب أن يعيد تطبيق Chat توجيه المستخدم إليه بعد إكمال مسار التفويض أو الإعداد خارج Google Chat. لمزيد من المعلومات، يُرجى الاطّلاع على المقالة ربط تطبيق في Chat بخدمات وأدوات أخرى. |
RemovedFromSpacePayload
يزيل مستخدم تطبيق Chat من مساحة.
| تمثيل JSON |
|---|
{
"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 |
الحقل مطلوب. مساحة Chat التي يحدث فيها كائن الحدث |
message |
الرسالة التي تؤدي إلى تفعيل كائن الحدث |
isDialogEvent |
بالنسبة إلى كائنات الأحداث |
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 |
الحقل مطلوب. مساحة Chat التي يحدث فيها كائن الحدث |
AppCommandPayload
يستدعي المستخدم أمر تطبيق.
| تمثيل JSON |
|---|
{ "appCommandMetadata": { object ( |
| الحقول | |
|---|---|
appCommandMetadata |
يتم ملؤه لأوامر التطبيقات، بما في ذلك الأوامر التي تبدأ بشرطة مائلة والأوامر السريعة. |
space |
اختيارية: مساحة Chat التي يحدث فيها كائن الحدث |
thread |
اختيارية: سلسلة المحادثات التي يظهر فيها كائن الحدث، إن توفّرت تتم تعبئة هذا الحقل إذا كان كائن الحدث مرتبطًا برسالة أو سلسلة محادثات معيّنة. |
message |
اختيارية: الرسالة التي تؤدي إلى تشغيل كائن الحدث، إن وُجدت لا تتم تعبئة هذا الحقل إلا للأوامر التي تبدأ بشرطة مائلة. |
configCompleteRedirectUri |
اختيارية: عنوان URL الذي يجب إعادة توجيه المستخدم إليه بعد إكمال عملية التفويض أو الإعداد خارج Google Chat. لمزيد من المعلومات، يُرجى الاطّلاع على المقالة ربط تطبيق في Chat بخدمات وأدوات أخرى. |
isDialogEvent |
اختيارية: ما إذا كان المستخدم يتفاعل مع مربّع حوار أو على وشك التفاعل معه |
dialogEventType |
اختيارية: نوع كائن حدث مربّع الحوار الذي تم تلقّيه لا ينطبق هذا الحقل إلا إذا كانت قيمة |
AppCommandMetadata
البيانات الوصفية حول أمر تطبيق Chat.
| تمثيل JSON |
|---|
{
"appCommandId": integer,
"appCommandType": enum ( |
| الحقول | |
|---|---|
appCommandId |
رقم تعريف الأمر المحدّد في إعدادات Chat API |
appCommandType |
نوع أمر تطبيق Chat |
AppCommandType
نوع أمر تطبيق Chat لمعرفة التفاصيل، يُرجى الاطّلاع على أنواع أوامر تطبيقات Chat.
| عمليات التعداد | |
|---|---|
APP_COMMAND_TYPE_UNSPECIFIED |
القيمة التلقائية غير محدد |
SLASH_COMMAND |
أمر يبدأ بشرطة مائلة يرسل المستخدم الأمر في رسالة محادثة. |
QUICK_COMMAND |
طلب سريع يختار المستخدم الأمر من قائمة Chat في قسم الرد على الرسالة. |
MESSAGE_ACTION |
إجراء مقترح يختار المستخدم الأمر من قائمة سياق الرسالة في Chat. |
SystemCommandPayload
يستدعي المستخدم أمرًا من أوامر النظام.
| تمثيل JSON |
|---|
{ "systemCommandMetadata": { object ( |
| الحقول | |
|---|---|
systemCommandMetadata |
البيانات الوصفية حول أمر النظام الذي تم استدعاؤه |
space |
اختيارية: مساحة Chat التي يحدث فيها كائن الحدث |
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 |
أمر لإلغاء رسالة بث نشطة |
| نهاية الحقول التي يستبعد كل منها الآخر | |
CancelStream
أمر لإلغاء رسالة بث نشطة
| تمثيل JSON |
|---|
{ "streamMessage": string } |
| الحقول | |
|---|---|
streamMessage |
الحقل مطلوب. اسم المورد لرسالة البث التي تم تنفيذ أمر الإلغاء عليها التنسيق: |
WorkflowEventObject
LINT.IfChange كائن الحدث الذي تم تمريره إلى إضافات سير العمل
| تمثيل JSON |
|---|
{ "executionMetadata": { object ( |
| الحقول | |
|---|---|
executionMetadata |
البيانات الوصفية حول تنفيذ سير العمل |
triggerEventSource |
مصدر الأحداث التي تؤدي إلى تفعيل الإجراءات |
| نوع حمولة بيانات حدث سير العمل في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ: | |
actionInvocation |
استدعاء إجراء سير عمل |
triggerCreation |
إنشاء مشغِّل سير عمل |
triggerDeletion |
حذف مشغِّل سير العمل |
resourceRetrieval |
استرداد مورد (يُستخدَم لتضخيم المتغيّرات) |
elementConfiguration |
إعدادات عنصر سير العمل |
resourceFieldsDefinitionRetrieval |
استرداد تعريفات الحقول التي يتيحها المورد |
elementUiAutocomplete |
اقتراحات الإكمال التلقائي للبطاقة المعروضة حاليًا |
| نهاية الحقول التي يستبعد كل منها الآخر | |
ActionInvocation
استدعاء إجراء سير عمل
| تمثيل JSON |
|---|
{ "inputs": { string: { object ( |
| الحقول | |
|---|---|
inputs |
تمثّل هذه المَعلمة خريطة لمتغيّرات الإدخال التي يتم تحديدها حسب اسم متغيّر الإدخال. عنصر يحتوي على قائمة بأزواج |
triggerId |
رقم تعريف عامل التشغيل الذي سيتم استخدامه لردود الإجراءات غير المتزامنة |
flowLevelContext |
اختيارية: سياق على مستوى المسار من الخطوات السابقة |
VariableData
تمثّل هذه السمة بيانات متغيّرة يمكن أن تحتوي على قيم متعدّدة من أنواع مختلفة.
| تمثيل JSON |
|---|
{ "booleanValues": [ boolean ], "integerValues": [ string ], "floatValues": [ number ], "stringValues": [ string ], "timestampValues": [ string ], "resourceReferences": [ { object ( |
| الحقول | |
|---|---|
booleanValues[] |
القيم المنطقية |
integerValues[] |
قيم الأعداد الصحيحة |
floatValues[] |
قيم عائمة |
stringValues[] |
قيم السلاسل |
timestampValues[] |
قيم الطابع الزمني يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: |
resourceReferences[] |
مراجع الموارد (أرقام التعريف) |
emailAddressValues[] |
قيم عناوين البريد الإلكتروني |
googleUserValues[] |
قيم مستخدمي Google بالتنسيق |
textFormatValues[] |
قيم تنسيق النص في سير العمل |
ResourceReference
قيمة معرّف المورد الخاص بالتطبيق
| تمثيل JSON |
|---|
{
"resourceType": {
object ( |
| الحقول | |
|---|---|
resourceType |
نوع المورد الذي يشير إليه هذا المعرّف |
resourceId |
رقم تعريف المرجع |
ResourceType
اسم نوع المورد المخصّص
| تمثيل JSON |
|---|
{ "workflowBundleId": string, "workflowResourceDefinitionId": string } |
| الحقول | |
|---|---|
workflowBundleId |
معرّف حزمة سير العمل التي تملك نوع المورد هذا هذا الحقل اختياري، وإذا تُرك فارغًا، سيتم اعتباره الحزمة نفسها التي يتم استخدامها. |
workflowResourceDefinitionId |
المعرّف الفريد للمورد يجب أن يكون هذا المعرّف فريدًا ضمن الحزمة نفسها فقط. |
WorkflowTextFormat
مجموعة من النصوص مع خيارات تنسيق متقدّمة، بما في ذلك الأنماط والروابط التشعّبية والعناصر التفاعلية
| تمثيل JSON |
|---|
{
"textFormatElements": [
{
object ( |
| الحقول | |
|---|---|
textFormatElements[] |
مجموعة من عناصر تنسيق النص |
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 ( |
| الحقول | |
|---|---|
| عنصر يمثّل أحد عناصر تنسيق النص المتعددة المحتملة في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ: | |
text |
النص بتنسيق النص |
chip |
شريحة قابلة للنقر بتنسيق نصي |
styledText |
نص منمّق بتنسيق النص |
hyperlink |
رابط تشعّبي بتنسيق النص |
listContainer |
حاوية القائمة بتنسيق النص |
| نهاية الحقول التي يستبعد كل منها الآخر | |
شريحة
شريحة قابلة للنقر بتنسيق نصي
| تمثيل JSON |
|---|
{
"icon": {
object ( |
| الحقول | |
|---|---|
icon |
الرمز المعروض في الشريحة |
label |
النص المعروض في الشريحة |
url |
عنوان 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 |
عرض رمز مخصّص مستضاف على عنوان URL يستخدم HTTPS على سبيل المثال: تشمل أنواع الملفات المتوافقة |
materialIconName |
اسم الرمز المحدّد في رمز Google Material، على سبيل المثال، |
| نهاية الحقول التي يستبعد كل منها الآخر | |
StyledText
عنصر نصي يتضمّن أنماطًا مثل الخط الغامق والمائل واللون
| تمثيل JSON |
|---|
{ "text": string, "styles": [ enum ( |
| الحقول | |
|---|---|
text |
المحتوى الرئيسي للنص |
styles[] |
مجموعة من الأنماط المطبَّقة على النص |
fontWeight |
كثافة خط النص |
color |
لون النص |
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 |
بلا نمط التفاف |
Hyperlink
عنصر رابط تشعّبي يتضمّن نصًا ورابطًا
| تمثيل JSON |
|---|
{ "link": string, "text": string } |
| الحقول | |
|---|---|
link |
عنوان URL المقصود للرابط التشعبي |
text |
تمثّل هذه السمة نص الرابط التشعّبي. |
ListContainer
حاوية لعناصر القائمة، حيث يمكن أن يحتوي كل عنصر قائمة على عدة عناصر TextFormatElement.
| تمثيل JSON |
|---|
{ "listNestLevel": string, "listType": enum ( |
| الحقول | |
|---|---|
listNestLevel |
مستوى دمج القائمة تبدأ من 0 للمستوى الأعلى، وتزيد بمقدار 1 لكل قائمة متداخلة. |
listType |
نوع القائمة |
listItems[] |
مجموعة من عناصر القائمة |
ListType
قائمة تعداد لأنواع القوائم المختلفة
| عمليات التعداد | |
|---|---|
LIST_TYPE_UNSPECIFIED |
لم يتم تحديد نوع القائمة. DO NOT USE. |
ORDERED |
قائمة مع ترتيب |
UNORDERED |
قائمة بدون ترتيب |
BLOCKQUOTE |
تمثّل قائمة اقتباسات. |
ListItem
عنصر قائمة
| تمثيل JSON |
|---|
{
"textFormatElements": [
{
object ( |
| الحقول | |
|---|---|
textFormatElements[] |
مجموعة من عناصر تنسيق النص |
FlowLevelContext
سياق على مستوى المسار يحتوي على مخرجات من الخطوات السابقة
| تمثيل JSON |
|---|
{
"stepContexts": [
{
object ( |
| الحقول | |
|---|---|
stepContexts[] |
اختيارية: قائمة بالخطوات السابقة الترتيب مهم، لذا تأكَّد من الحفاظ على ترتيب التنفيذ في هذه القائمة. |
StepContext
البيانات الوصفية لسياق الخطوة والمخرجات للسياق على مستوى التدفق.
| تمثيل JSON |
|---|
{
"stepId": string,
"outputs": {
string: {
object ( |
| الحقول | |
|---|---|
stepId |
اختيارية: المعرّف الفريد للخطوة في الرسم البياني لسير العمل |
outputs |
اختيارية: تمثّل هذه المَعلمة خريطة لمتغيّرات الناتج التي تم إنشاؤها في هذه الخطوة، ويتم تحديدها حسب اسم المتغيّر. عنصر يحتوي على قائمة بأزواج |
TriggerCreation
إنشاء مشغِّل سير عمل
| تمثيل JSON |
|---|
{ "triggerId": string, "triggerType": enum ( |
| الحقول | |
|---|---|
triggerId |
المعرّف الفريد لعامل التفعيل الذي تم تقديمه أثناء الإنشاء |
triggerType |
نوع المشغّل |
inputs |
تمثّل هذه المَعلمة خريطة لمتغيّرات الإدخال التي يتم تحديدها حسب اسم متغيّر الإدخال. عنصر يحتوي على قائمة بأزواج |
notifyUri |
نقطة النهاية التي سيتم استدعاؤها عند تنشيط المشغّل. |
TriggerType
نوع المشغّل
| عمليات التعداد | |
|---|---|
TRIGGER_TYPE_UNDEFINED |
القيمة التلقائية DO NOT USE. |
REPEATING |
سيتم تنشيط المشغّل في كل مرة يتم فيها استيفاء شروط الإدخال. |
TriggerDeletion
حذف مشغِّل سير العمل
| تمثيل JSON |
|---|
{ "triggerId": string } |
| الحقول | |
|---|---|
triggerId |
المعرّف الفريد لعامل التفعيل الذي تم تقديمه أثناء الإنشاء |
ResourceRetrieval
استرداد مورد
| تمثيل JSON |
|---|
{
"resourceReference": {
object ( |
| الحقول | |
|---|---|
resourceReference |
نوع المرجع ورقم تعريفه المطلوب استردادهما |
ElementConfiguration
الاستدعاء عند ضبط عنصر سير عمل
| تمثيل JSON |
|---|
{ "inputs": { string: { object ( |
| الحقول | |
|---|---|
inputs |
تمثّل هذه المَعلمة خريطة لمتغيّرات الإدخال التي يتم تحديدها حسب اسم متغيّر الإدخال. قد تكون هذه الخريطة فارغة. يُستخدَم هذا المصطلح عند ضبط عنصر واحد في سير العمل (مشغّل أو إجراء) في الصفحة الرئيسية لسير العمل. عنصر يحتوي على قائمة بأزواج |
displayDestination |
وجهة بطاقة إعدادات العنصر يمكن أن تستخدم العناصر هذا الحقل لعرض تنسيقات مختلفة لبطاقات الإعدادات استنادًا إلى الوجهة. |
nodeId |
تمثّل هذه السمة رقم تعريف العقدة للإعدادات الأساسية التي يتم عرضها. |
workflowId |
معرّف سير العمل للإعدادات الأساسية التي يتم عرضها |
availableVariables[] |
المتغيّرات المتاحة مرتّبة حسب موضع العقدة |
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 ( |
| الحقول | |
|---|---|
parentElementId |
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 |
رقم التعريف المرجعي للعقدة |
path |
توقيع مسار أداة اختيار المتغيّرات |
dataType |
نوع بيانات المتغيّر |
iconUrl |
عنوان URL لرمز العنصر الأساسي الذي ينتج هذا المتغيّر. |
stepNumber |
رقم خطوة العنصر الأساسي الذي ينتج هذا المتغيّر. |
descriptionText |
وصف المتغيّر |
displayText |
النص المعروض لشريحة المتغيّر |
DataType
نوع المتغيّر
| تمثيل JSON |
|---|
{ "valueMetadata": { object ( |
| الحقول | |
|---|---|
valueMetadata |
بيانات وصفية حول القيم المحتمَلة لمتغيّر معيّن |
| نوع البيانات في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ: | |
basicType |
نوع البيانات الأساسي |
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 ( |
| الحقول | |
|---|---|
enumValues[] |
اختيارية: تحدّد القيم المسموح بها لسلسلة. لا يمكن ضبط هذه السياسة إلا إذا كانت قيمة |
dynamicTypes[] |
اختيارية: تحدّد هذه السياسة الأنواع المسموح بها والتي يمكن تحويلها ديناميكيًا لمتغيّر معيّن. لا يمكن ضبط هذه السمة إلا إذا كان DataType هو سلسلة وكان المتغيّر هو مخرجات. |
semanticDescriptors[] |
اختيارية: يساعد في وصف المعنى الدلالي للمتغيّر. |
dynamicSchema |
اختيارية: إعدادات لحلّ مخطط هذا المتغيّر ديناميكيًا |
defaultValue |
اختيارية: سلسلة تحدّد القيمة التلقائية لهذا المتغيّر. على سبيل المثال، بالنسبة إلى القيم المنطقية، يمكن ضبط |
SemanticDescriptor
بيانات وصفية حول المعنى الدلالي لمتغيّر
| تمثيل JSON |
|---|
{ "resourceAttribute": string, "disallowedResourceAttributes": [ string ] } |
| الحقول | |
|---|---|
resourceAttribute |
يشير إلى أنّ المتغيّر يتوافق مع سمة معيّنة لمورد. ويُعدّ ذلك مفيدًا بشكل خاص للمتغيّرات التي تمثّل معرّفًا لمورد (المعرّف وعنوان URL والمفتاح وما إلى ذلك). التنسيق المقترَح هو: - أمثلة: - سيستخدم العميل هذه المعلومات لتلميح المستخدم إلى متغيرات الإخراج المتوافقة مع مدخلات معينة. |
disallowedResourceAttributes[] |
اختيارية: ينطبق ذلك على الإدخالات فقط، ويتم تجاهله في المخرجات. السمات غير المسموح بها والتي تتوافق مع هذا الواصف الدلالي. سيمنع العميل صراحةً اختيار المتغيّرات للمخرجات التي تتوافق مع أي من سمات الموارد غير المسموح بها هذه. |
DynamicSchema
إعدادات لحلّ مخطط هذا المتغيّر ديناميكيًا في وقت التشغيل
| تمثيل JSON |
|---|
{ "requiredInputIds": [ string ], "strictEnum": boolean } |
| الحقول | |
|---|---|
requiredInputIds[] |
أرقام تعريف متغيّرات الإدخال الشقيقة التي يجب تقديمها قبل أن يتم حلّ مخطط هذا المتغيّر ديناميكيًا. |
strictEnum |
عندما تكون القيمة "صحيح"، يجب أن تتطابق قيمة المتغيّر مع إحدى قيم التعداد التي تم حلّها ديناميكيًا. عند ضبط القيمة على "خطأ"، يتم التعامل مع القيم التي تم حلّها ديناميكيًا كاقتراحات غير صارمة. |
ResourceFieldsDefinitionRetrieval
تسترد هذه الطريقة تعريف الحقول التي يتيحها مورد معيّن.
| تمثيل JSON |
|---|
{
"elementId": string,
"inputs": {
string: {
object ( |
| الحقول | |
|---|---|
elementId |
تحدّد هذه السمة معرّف العنصر الذي سيتم جلب مخطّط الموارد الديناميكية الخاص به. |
inputs |
يتألف ذلك من إدخالات حقول العقدة التي توفّر المتغيّر. تمثّل هذه المَعلمة خريطة لمتغيّرات الإدخال التي يتم تحديدها حسب اسم متغيّر الإدخال. عنصر يحتوي على قائمة بأزواج |
ElementUiAutocomplete
اقتراحات الإكمال التلقائي للبطاقة المعروضة حاليًا
| تمثيل JSON |
|---|
{
"query": string,
"inputs": {
string: {
object ( |
| الحقول | |
|---|---|
query |
طلب البحث المطلوب إكماله تلقائيًا |
inputs |
تمثّل هذه المَعلمة خريطة لمتغيّرات الإدخال التي يتم تحديدها حسب اسم متغيّر الإدخال. عنصر يحتوي على قائمة بأزواج |
invokedFunction |
الدالة التي تم استدعاؤها والمرتبطة بعنصر واجهة المستخدم |
resourceId |
رقم تعريف المورد الذي يجب إكماله تلقائيًا هذا الحقل اختياري وقد لا يتم ضبطه. |
operationId |
رقم تعريف العملية التي قدّمت المورد المطلوب إكماله تلقائيًا. هذا الحقل اختياري وقد لا يتم ضبطه. |
ExecutionMetadata
البيانات الوصفية حول تنفيذ سير العمل
| تمثيل JSON |
|---|
{ "versionId": integer, "timeZone": string, "stepNumber": integer } |
| الحقول | |
|---|---|
versionId |
إصدار عنصر سير العمل الذي يتم استدعاؤه |
timeZone |
المنطقة الزمنية لسير العمل الذي يتم حفظه، مثل "America/Los_Angeles". |
stepNumber |
يمثّل رقم خطوة العنصر الأساسي الذي يتم استدعاؤه. |
TriggerEventSource
مصدر حدث التفعيل الذي أدّى إلى هذا التنفيذ
| عمليات التعداد | |
|---|---|
TRIGGER_EVENT_SOURCE_UNSPECIFIED |
القيمة التلقائية DO NOT USE. |
TRIGGER_EVENT_SOURCE_AUTOMATED |
يتم تشغيل التنفيذ تلقائيًا من خلال الأحداث. |
TRIGGER_EVENT_SOURCE_TEST_RUN |
يتم بدء التنفيذ من خلال التشغيل التجريبي. |