Action

کنشی که رفتار را هنگام ارسال فرم شرح می‌دهد. برای مثال، می‌توانید یک اسکریپت Apps Script را برای مدیریت فرم فراخوانی کنید. اگر کنش راه‌اندازی شود، مقادیر فرم به سرور ارسال می‌شود.

برای برنامه‌های 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 دردسترس نیست.