Action

إجراء يصف السلوك عند إرسال النموذج على سبيل المثال، يمكنك استدعاء نص برمجي في "برمجة تطبيقات Google" لمعالجة النموذج. إذا تم تفعيل الإجراء، يتم إرسال قيم النموذج إلى الخادم.

تتوفّر هذه الميزة لتطبيقات Google Chat وإضافات Google Workspace.

تمثيل JSON
{
  "function": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ],
  "loadIndicator": enum (LoadIndicator),
  "persistValues": boolean,
  "interaction": enum (Interaction),
  "requiredWidgets": [
    string
  ],
  "allWidgetsAreRequired": boolean
}
الحقول
function

string

دالة مخصّصة يتم استدعاؤها عند النقر على العنصر الذي يتضمّنها أو تفعيله بطريقة أخرى

للاطّلاع على مثال على الاستخدام، يُرجى مراجعة قراءة بيانات النموذج.

parameters[]

object (ActionParameter)

قائمة بمَعلمات الإجراءات

loadIndicator

enum (LoadIndicator)

يحدّد مؤشر التحميل الذي يعرضه الإجراء أثناء إجراء المكالمة للإجراء.

persistValues

boolean

تشير إلى ما إذا كانت قيم النموذج ستبقى بعد الإجراء. تكون القيمة التلقائية false.

إذا كانت القيمة true، تظل قيم النموذج كما هي بعد بدء الإجراء. للسماح للمستخدم بإجراء تغييرات أثناء معالجة الإجراء، اضبط LoadIndicator على NONE. بالنسبة إلى رسائل البطاقات في تطبيقات Chat، يجب أيضًا ضبط ResponseType للإجراء على UPDATE_MESSAGE واستخدام cardId نفسه من البطاقة التي تحتوي على الإجراء.

إذا كانت القيمة false، يتم محو قيم النموذج عند بدء الإجراء. لمنع المستخدم من إجراء تغييرات أثناء معالجة الإجراء، اضبط LoadIndicator على SPINNER.

interaction

enum (Interaction)

اختياريّ. مطلوب عند فتح مربّع حوار.

ما يجب فعله استجابةً للتفاعل مع مستخدم، مثل نقر المستخدم على زر في رسالة بطاقة.

إذا لم يتم تحديد ذلك، يستجيب التطبيق من خلال تنفيذ action، مثل فتح رابط أو تشغيل دالة، كالمعتاد.

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

متاحة لتطبيقات Google Chat وغير متاحة لإضافات Google Workspace.

requiredWidgets[]

string

اختياريّ. املأ هذه القائمة بأسماء التطبيقات المصغّرة التي يحتاجها هذا الإجراء لإرسال طلب صالح.

إذا لم تكن التطبيقات المصغّرة المدرَجة هنا تحتوي على قيمة عند استدعاء هذا الإجراء، يتم إلغاء إرسال النموذج.

تتوفّر هذه الميزة لتطبيقات Google Chat وإضافات Google Workspace.

allWidgetsAreRequired

boolean

اختياريّ. إذا كانت هذه القيمة صحيحة، يتم اعتبار جميع التطبيقات المصغّرة مطلوبة لهذا الإجراء.

تتوفّر هذه الميزة لتطبيقات Google Chat وإضافات Google Workspace.

ActionParameter

قائمة بمَعلمات السلسلة التي يجب توفيرها عند استدعاء طريقة الإجراء على سبيل المثال، فكِّر في ثلاثة أزرار للتأجيل: التأجيل الآن أو التأجيل ليوم واحد أو التأجيل للأسبوع القادم. يمكنك استخدام action method = snooze()، مع تمرير نوع التأجيل ووقت التأجيل في قائمة مَعلمات السلسلة.

لمزيد من المعلومات، يُرجى الاطّلاع على CommonEventObject.

تتوفّر هذه الميزة لتطبيقات Google Chat وإضافات Google Workspace.

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

string

اسم مَعلمة نص الإجراء البرمجي

value

string

قيمة المَعلمة

LoadIndicator

يحدّد مؤشر التحميل الذي يعرضه الإجراء أثناء إجراء المكالمة للإجراء.

تتوفّر هذه الميزة لتطبيقات Google Chat وإضافات Google Workspace.

عمليات التعداد
SPINNER يعرض مؤشر تحميل للإشارة إلى أنّه يتم تحميل المحتوى.
NONE لا يتم عرض أي شيء.

التفاعل

اختياريّ. مطلوب عند فتح مربّع حوار.

ما يجب فعله استجابةً للتفاعل مع مستخدم، مثل نقر المستخدم على زر في رسالة بطاقة.

إذا لم يتم تحديد ذلك، يستجيب التطبيق من خلال تنفيذ action، مثل فتح رابط أو تشغيل دالة، كالمعتاد.

من خلال تحديد interaction، يمكن للتطبيق الاستجابة بطرق تفاعلية خاصة. على سبيل المثال، من خلال ضبط السياسة interaction على OPEN_DIALOG، يمكن للتطبيق فتح مربّع حوار.

عند تحديد هذه السمة، لا يظهر مؤشر التحميل. في حال تحديدها لإضافة، يتم تجريد البطاقة بالكامل ولا يظهر أي شيء في العميل.

متاحة لتطبيقات Google Chat وغير متاحة لإضافات Google Workspace.

عمليات التعداد
INTERACTION_UNSPECIFIED القيمة التلقائية يتم تنفيذ action كالمعتاد.
OPEN_DIALOG

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

لا تتوافق إلا مع تطبيقات Chat استجابةً للنقرات على الأزرار في رسائل البطاقات. في حال تحديدها لإضافة، يتم تجريد البطاقة بالكامل ولا يظهر أي شيء في العميل.

متاحة لتطبيقات Google Chat وغير متاحة لإضافات Google Workspace.