Package google.apps.card.v1

فهرست

اکشن

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

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

فیلدها
function

string

یک تابع سفارشی که هنگام کلیک یا فعال شدن عنصر حاوی آن، فراخوانی می‌شود.

برای مثال، به بخش «خواندن داده‌های فرم» مراجعه کنید.

parameters[]

ActionParameter

فهرست پارامترهای عملیاتی

loadIndicator

LoadIndicator

نشانگر بارگذاری را مشخص می‌کند که اکشن هنگام فراخوانی اکشن نمایش می‌دهد.

persistValues

bool

نشان می‌دهد که آیا مقادیر فرم پس از انجام عمل باقی می‌مانند یا خیر. مقدار پیش‌فرض false است.

اگر true ، مقادیر فرم پس از اجرای اکشن باقی می‌مانند. برای اینکه کاربر بتواند در حین پردازش اکشن، تغییراتی ایجاد کند، LoadIndicator روی NONE تنظیم کنید. برای پیام‌های کارت در برنامه‌های چت، باید ResponseType اکشن را نیز روی UPDATE_MESSAGE تنظیم کنید و از همان card_id کارتی که اکشن در آن قرار دارد استفاده کنید.

اگر false ، مقادیر فرم هنگام اجرای اکشن پاک می‌شوند. برای جلوگیری از ایجاد تغییرات توسط کاربر در حین پردازش اکشن، LoadIndicator روی SPINNER تنظیم کنید.

interaction

Interaction

اختیاری. هنگام باز کردن یک کادر محاوره‌ای الزامی است.

در پاسخ به تعامل با کاربر، مانند کلیک کاربر روی دکمه‌ای در یک پیام کارتی، چه باید کرد؟

اگر مشخص نشده باشد، برنامه با اجرای یک action - مانند باز کردن یک لینک یا اجرای یک تابع - به صورت عادی پاسخ می‌دهد.

با مشخص کردن یک interaction ، برنامه می‌تواند به روش‌های تعاملی خاصی پاسخ دهد. برای مثال، با تنظیم interaction روی OPEN_DIALOG ، برنامه می‌تواند یک کادر محاوره‌ای باز کند. در صورت مشخص شدن، نشانگر بارگیری نشان داده نمی‌شود. اگر برای یک افزونه مشخص شود، کل کارت حذف می‌شود و هیچ چیزی در کلاینت نشان داده نمی‌شود.

برای برنامه‌های Google Chat در دسترس است و برای افزونه‌های Google Workspace در دسترس نیست.

requiredWidgets[]

string

اختیاری. این لیست را با نام ویجت‌هایی که این اقدام برای ارسال معتبر به آنها نیاز دارد، پر کنید.

اگر ویجت‌های فهرست‌شده در اینجا هنگام فراخوانی این اقدام مقداری نداشته باشند، ارسال فرم لغو می‌شود.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

allWidgetsAreRequired

bool

اختیاری. اگر این مقدار درست باشد، تمام ویجت‌ها توسط این اقدام الزامی در نظر گرفته می‌شوند.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

پارامتر عمل

فهرست پارامترهای رشته‌ای که هنگام فراخوانی متد اکشن باید ارائه شوند. برای مثال، سه دکمه‌ی چرت زدن را در نظر بگیرید: چرت زدن الان، چرت زدن یک روز، یا چرت زدن هفته‌ی بعد. می‌توانید از action method = snooze() استفاده کنید و نوع چرت زدن و زمان چرت زدن را در فهرست پارامترهای رشته‌ای وارد کنید.

برای کسب اطلاعات بیشتر، به CommonEventObject مراجعه کنید.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

فیلدها
key

string

نام پارامتر برای اسکریپت اکشن.

value

string

مقدار پارامتر.

تعامل

اختیاری. هنگام باز کردن یک کادر محاوره‌ای الزامی است.

در پاسخ به تعامل با کاربر، مانند کلیک کاربر روی دکمه‌ای در یک پیام کارتی، چه باید کرد؟

اگر مشخص نشده باشد، برنامه با اجرای یک action - مانند باز کردن یک لینک یا اجرای یک تابع - به صورت عادی پاسخ می‌دهد.

با مشخص کردن یک interaction ، برنامه می‌تواند به روش‌های تعاملی خاصی پاسخ دهد. برای مثال، با تنظیم interaction روی OPEN_DIALOG ، برنامه می‌تواند یک کادر محاوره‌ای باز کند.

در صورت مشخص شدن، نشانگر بارگیری نشان داده نمی‌شود. اگر برای یک افزونه مشخص شود، کل کارت حذف می‌شود و هیچ چیزی در کلاینت نشان داده نمی‌شود.

برای برنامه‌های Google Chat در دسترس است و برای افزونه‌های Google Workspace در دسترس نیست.

انوم‌ها
INTERACTION_UNSPECIFIED مقدار پیش‌فرض. action به صورت عادی اجرا می‌شود.
OPEN_DIALOG

یک کادر محاوره‌ای ، یک رابط کاربری پنجره‌ای و مبتنی بر کارت که برنامه‌های چت برای تعامل با کاربران از آن استفاده می‌کنند، باز می‌کند.

فقط توسط برنامه‌های چت در پاسخ به کلیک روی دکمه روی پیام‌های کارت پشتیبانی می‌شود. اگر برای یک افزونه مشخص شود، کل کارت حذف می‌شود و هیچ چیزی در کلاینت نشان داده نمی‌شود.

برای برنامه‌های Google Chat در دسترس است و برای افزونه‌های Google Workspace در دسترس نیست.

شاخص بار

نشانگر بارگذاری را مشخص می‌کند که اکشن هنگام فراخوانی اکشن نمایش می‌دهد.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

انوم‌ها
SPINNER یک چرخنده را نمایش می‌دهد تا نشان دهد که محتوا در حال بارگذاری است.
NONE هیچ چیزی نمایش داده نمی‌شود.

خطای مجوز

افزونه‌هایی که به سرویس‌های ۳P دسترسی دارند یا به دامنه‌های oAuth بیشتری از گوگل نیاز دارند، باید در صورت عدم دسترسی به اطلاعات ورود (مثلاً توکن‌های OAuth) به کاربر نهایی یک کارت مجوز نشان دهند. افزونه‌ها باید شیء AuthorizationError را برای رندر کردن کارت مجوز برگردانند.

فیلدها

rendering فیلد یونیون.

rendering می‌تواند فقط یکی از موارد زیر باشد:

basicAuthorizationPrompt

BasicAuthorizationAction

بگذارید پلتفرم کارت مجوز پایه را بسازد. توسعه‌دهنده فقط باید URL مجوز را ارائه دهد. اقدام پایه می‌تواند توسط افزونه‌هایی که قصد انتشار عمومی ندارند، استفاده شود.

customAuthorizationPrompt

RenderActions

دستورالعمل‌های مربوط به کارت مجوز سفارشی را ارائه دهید. در طول فرآیند بررسی Google Workspace Marketplace، یک درخواست مجوز سفارشی اجرا خواهد شد. کاربران نهایی باید یک کارت مجوز سفارشی را مشاهده کنند که به وضوح نشان می‌دهد کاربر نهایی در حال تأیید دسترسی به خدمات خارجی 3P است.

requestingGoogleScopes

RequestingGoogleScopes

وقتی رضایت‌نامه‌ی oAuth بدون محدودیت فعال باشد، افزونه‌ی HTTP ممکن است نیاز به درخواست دامنه‌های بیشتری از Google oAuth داشته باشد. افزونه باید این شیء را برای رندر کردن کارت مجوز برگرداند. Manage granular permissions مراجعه کنید.

اقدام مجوز پایه

اقدامی که به پلتفرم اجازه می‌دهد یک کارت مجوز اولیه برای کاربران نهایی بسازد.

فیلدها
authorizationUrl

string

اگر افزونه از OAuth2 برای اتصال به سرویس 3P استفاده می‌کند، این آدرس اینترنتی مجوز OAuth2 خواهد بود.

resource

string

متنی که در صورت عدم احراز هویت یک منبع محافظت‌شده به کاربر نهایی نمایش داده می‌شود. مقادیر مثال عبارتند از: «حساب Salesforce» یا «داده‌های Salesforce».

استایل حاشیه

گزینه‌های سبک برای حاشیه یک کارت یا ویجت، شامل نوع و رنگ حاشیه.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

فیلدها
type

BorderType

نوع حاشیه.

strokeColor

Color

رنگ‌هایی که باید هنگام تعیین نوع BORDER_TYPE_STROKE استفاده شوند.

برای تنظیم رنگ خط دور متن، مقداری را برای فیلدهای red ، green و blue مشخص کنید. این مقدار باید یک عدد اعشاری بین ۰ و ۱ بر اساس مقدار رنگ RGB باشد، که در آن 0 (۰/۲۵۵) نشان‌دهنده عدم وجود رنگ و 1 (۲۵۵/۲۵۵) نشان‌دهنده حداکثر شدت رنگ است.

برای مثال، کد زیر رنگ را در حداکثر شدت خود به قرمز تنظیم می‌کند:

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

فیلد alpha برای رنگ خط دور متن در دسترس نیست. در صورت مشخص شدن، این فیلد نادیده گرفته می‌شود.

cornerRadius

int32

شعاع گوشه برای حاشیه.

نوع حاشیه

انواع حاشیه‌ای که برای ویجت‌ها اعمال می‌شود را نشان می‌دهد.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

انوم‌ها
BORDER_TYPE_UNSPECIFIED استفاده نکنید. نامشخص.
NO_BORDER بدون مرز.
STROKE مقدار پیش‌فرض. طرح کلی.

دکمه

یک دکمه متنی، آیکون یا ترکیبی از متن و آیکون که کاربران می‌توانند روی آن کلیک کنند. برای مثال در برنامه‌های چت گوگل، به «افزودن دکمه» مراجعه کنید.

برای تبدیل یک تصویر به دکمه‌ی قابل کلیک، یک Image (نه یک ImageComponent ) مشخص کنید و یک اکشن onClick تنظیم کنید.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

فیلدها
text

string

متنی که درون دکمه نمایش داده می‌شود.

icon

Icon

یک آیکون درون دکمه نمایش داده می‌شود. اگر هم icon و هم text تنظیم شده باشند، آیکون قبل از متن ظاهر می‌شود.

color

Color

اختیاری. رنگ دکمه. در صورت تنظیم، type دکمه روی FILLED تنظیم می‌شود و رنگ فیلدهای text و icon برای خوانایی بیشتر، روی رنگی متضاد تنظیم می‌شود. برای مثال، اگر رنگ دکمه روی آبی تنظیم شود، هر متن یا آیکونی در دکمه روی سفید تنظیم می‌شود.

برای تنظیم رنگ دکمه، مقداری را برای فیلدهای red ، green و blue مشخص کنید. این مقدار باید یک عدد اعشاری بین ۰ و ۱ بر اساس مقدار رنگ RGB باشد، که در آن 0 (۰/۲۵۵) نشان‌دهنده عدم وجود رنگ و 1 (۲۵۵/۲۵۵) نشان‌دهنده حداکثر شدت رنگ است.

برای مثال، کد زیر رنگ را در حداکثر شدت خود به قرمز تنظیم می‌کند:

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

فیلد alpha برای رنگ دکمه در دسترس نیست. در صورت مشخص شدن، این فیلد نادیده گرفته می‌شود.

onClick

OnClick

الزامی. عملی که هنگام کلیک کاربر روی دکمه انجام می‌شود، مانند باز کردن یک لینک یا اجرای یک تابع سفارشی.

disabled

bool

اگر true ، دکمه در حالت غیرفعال نمایش داده می‌شود و به اقدامات کاربر پاسخ نمی‌دهد.

altText

string

متن جایگزینی که برای دسترسی‌پذیری استفاده می‌شود.

متن توصیفی تنظیم کنید که به کاربران اطلاع دهد دکمه چه کاری انجام می‌دهد. برای مثال، اگر دکمه‌ای یک هایپرلینک را باز می‌کند، می‌توانید بنویسید: «یک تب جدید در مرورگر باز می‌کند و به مستندات توسعه‌دهندگان گوگل چت در https://developers.google.com/workspace/chat هدایت می‌شود» .

type

Type

اختیاری. نوع دکمه. در صورت عدم تنظیم، نوع دکمه به صورت پیش‌فرض OUTLINED خواهد بود. اگر فیلد color تنظیم شود، نوع دکمه به صورت FILLED تنظیم می‌شود و هر مقداری که برای این فیلد تنظیم شود، نادیده گرفته می‌شود.

نوع

اختیاری. نوع دکمه. اگر فیلد color تنظیم شده باشد، type آن به صورت اجباری FILLED می‌شود.

برای برنامه‌های Google Chat در دسترس است و برای افزونه‌های Google Workspace در دسترس نیست.

انوم‌ها
TYPE_UNSPECIFIED استفاده نکنید. نامشخص.
OUTLINED دکمه‌های با حاشیه‌ی مشخص، دکمه‌هایی با تأکید متوسط ​​هستند. آن‌ها معمولاً شامل اقداماتی هستند که مهم هستند، اما اقدام اصلی در یک برنامه‌ی چت یا یک افزونه نیستند.
FILLED یک دکمه‌ی توپر، دارای یک محفظه با رنگ ثابت است. این دکمه بیشترین تأثیر بصری را دارد و برای انجام اقدامات مهم و اصلی در یک برنامه‌ی چت یا یک افزونه توصیه می‌شود.
FILLED_TONAL دکمه‌های با تُن رنگی توپر، حد وسط بین دکمه‌های توپر و دکمه‌های با تُن رنگی مشخص هستند. این دکمه‌ها در مواردی مفید هستند که یک دکمه با اولویت پایین‌تر، به تأکید بیشتری نسبت به دکمه با تُن رنگی مشخص نیاز داشته باشد.
BORDERLESS یک دکمه در حالت پیش‌فرض دارای یک محفظه نامرئی نیست. اغلب برای اقدامات با اولویت پایین استفاده می‌شود، به خصوص هنگام ارائه چندین گزینه.

لیست دکمه

فهرستی از دکمه‌ها که به صورت افقی قرار گرفته‌اند. برای مثال در برنامه‌های چت گوگل، به «افزودن یک دکمه» مراجعه کنید.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

فیلدها
buttons[]

Button

مجموعه‌ای از دکمه‌ها.

کارت

رابط کارتی که در یک پیام Google Chat یا افزونه Google Workspace نمایش داده می‌شود.

کارت‌ها از یک طرح‌بندی تعریف‌شده، عناصر رابط کاربری تعاملی مانند دکمه‌ها و رسانه‌های غنی مانند تصاویر پشتیبانی می‌کنند. از کارت‌ها برای ارائه اطلاعات دقیق، جمع‌آوری اطلاعات از کاربران و راهنمایی کاربران برای برداشتن گام بعدی استفاده کنید.

با استفاده از ابزار ساخت کارت، کارت‌ها را طراحی و پیش‌نمایش کنید.

سازنده کارت را باز کنید

برای آشنایی با نحوه ساخت کارت‌ها، به مستندات زیر مراجعه کنید:

توجه: می‌توانید تا ۱۰۰ ویجت به هر کارت اضافه کنید. هر ویجتی که فراتر از این محدودیت باشد نادیده گرفته می‌شود. این محدودیت هم برای پیام‌ها و پنجره‌های گفتگو در برنامه‌های Google Chat و هم برای کارت‌های موجود در افزونه‌های Google Workspace اعمال می‌شود.

مثال: پیام کارت برای برنامه Google Chat

نمونه کارت تماس

برای ایجاد پیام کارت نمونه در گوگل چت، از JSON زیر استفاده کنید:

{
  "cardsV2": [
    {
      "cardId": "unique-card-id",
      "card": {
        "header": {
           "title": "Sasha",
           "subtitle": "Software Engineer",
           "imageUrl":
           "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
           "imageType": "CIRCLE",
           "imageAltText": "Avatar for Sasha"
         },
         "sections": [
           {
             "header": "Contact Info",
             "collapsible": true,
             "uncollapsibleWidgetsCount": 1,
             "widgets": [
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "EMAIL"
                   },
                   "text": "sasha@example.com"
                 }
               },
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "PERSON"
                   },
                   "text": "<font color=\"#80e27e\">Online</font>"
                 }
               },
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "PHONE"
                   },
                   "text": "+1 (555) 555-1234"
                 }
               },
               {
                 "buttonList": {
                   "buttons": [
                     {
                       "text": "Share",
                       "onClick": {
                        "openLink": {
                           "url": "https://example.com/share"
                         }
                       }
                     },
                     {
                       "text": "Edit",
                       "onClick": {
                         "action": {
                           "function": "goToView",
                           "parameters": [
                             {
                               "key": "viewType",
                               "value": "EDIT"
                             }
                           ]
                         }
                       }
                     }
                   ]
                 }
               }
             ]
           }
         ]
       }
    }
  ]
}
فیلدها
header

CardHeader

سربرگ کارت. سربرگ معمولاً شامل یک تصویر در ابتدای کارت و یک عنوان است. سربرگ‌ها همیشه در بالای کارت ظاهر می‌شوند.

sections[]

Section

شامل مجموعه‌ای از ویجت‌ها است. هر بخش، سربرگ اختیاری مخصوص به خود را دارد. بخش‌ها به صورت بصری توسط یک جداکننده خط از هم جدا می‌شوند. برای مثال در برنامه‌های چت گوگل، به بخش تعریف یک بخش از یک کارت مراجعه کنید.

sectionDividerStyle

DividerStyle

سبک جداکننده بین سرصفحه، بخش‌ها و پاصفحه.

cardActions[]

CardAction

اقدامات کارت. اقدامات به منوی نوار ابزار کارت اضافه می‌شوند.

برای افزونه‌های Google Workspace در دسترس است و برای برنامه‌های Google Chat در دسترس نیست.

برای مثال، JSON زیر یک منوی عملیات کارت با گزینه‌های Settings و Send Feedback می‌سازد:

"cardActions": [
  {
    "actionLabel": "Settings",
    "onClick": {
      "action": {
        "functionName": "goToView",
        "parameters": [
          {
            "key": "viewType",
            "value": "SETTING"
         }
        ],
        "loadIndicator": "LoadIndicator.SPINNER"
      }
    }
  },
  {
    "actionLabel": "Send Feedback",
    "onClick": {
      "openLink": {
        "url": "https://example.com/feedback"
      }
    }
  }
]
name

string

نام کارت. به عنوان شناسه کارت در پیمایش کارت استفاده می‌شود.

برای افزونه‌های Google Workspace در دسترس است و برای برنامه‌های Google Chat در دسترس نیست.

fixedFooter

CardFixedFooter

پاورقی ثابت که در پایین این کارت نشان داده شده است.

تنظیم fixedFooter بدون مشخص کردن primaryButton یا secondaryButton باعث خطا می‌شود. برای برنامه‌های چت، می‌توانید از fixed footers در دیالوگ‌ها استفاده کنید، اما نمی‌توانید از card messages استفاده کنید.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

displayStyle

DisplayStyle

در افزونه‌های Google Workspace، ویژگی‌های نمایش peekCardHeader را تنظیم می‌کند.

برای افزونه‌های Google Workspace در دسترس است و برای برنامه‌های Google Chat در دسترس نیست.

peekCardHeader

CardHeader

هنگام نمایش محتوای متنی، هدر کارت Peek به عنوان یک نگهدارنده عمل می‌کند تا کاربر بتواند بین کارت‌های صفحه اصلی و کارت‌های متنی به جلو حرکت کند.

برای افزونه‌های Google Workspace در دسترس است و برای برنامه‌های Google Chat در دسترس نیست.

expressionData[]

ExpressionData

داده‌های عبارت برای کارت.

برای افزونه‌های Google Workspace که Google Workspace Studio را توسعه می‌دهند، در دسترس است. برای برنامه‌های Google Chat در دسترس نیست.

کارت اکشن

یک اقدام کارت، عملی است که با کارت مرتبط است. برای مثال، یک کارت فاکتور ممکن است شامل اقداماتی مانند حذف فاکتور، ایمیل کردن فاکتور یا باز کردن فاکتور در مرورگر باشد.

برای افزونه‌های Google Workspace در دسترس است و برای برنامه‌های Google Chat در دسترس نیست.

فیلدها
actionLabel

string

برچسبی که به عنوان آیتم منوی عملیات نمایش داده می‌شود.

onClick

OnClick

عمل onClick برای این مورد عملیاتی.

پاورقی ثابت کارت

یک پاورقی (چسبنده) ثابت که در پایین کارت ظاهر می‌شود.

تنظیم fixedFooter بدون مشخص کردن primaryButton یا secondaryButton باعث خطا می‌شود.

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

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

فیلدها
primaryButton

Button

دکمه اصلی پاورقی ثابت. این دکمه باید یک دکمه متنی با متن و رنگ تنظیم شده باشد.

secondaryButton

Button

دکمه ثانویه پاورقی ثابت. این دکمه باید یک دکمه متنی با متن و رنگ تنظیم شده باشد. اگر secondaryButton تنظیم شده باشد، باید primaryButton نیز تنظیم کنید.

هدر کارت

نشان‌دهنده‌ی سربرگ کارت است. برای مثال در برنامه‌های چت گوگل، به افزودن سربرگ مراجعه کنید.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

فیلدها
title

string

الزامی. عنوان سربرگ کارت. سربرگ ارتفاع ثابتی دارد: اگر هم عنوان و هم زیرعنوان مشخص شده باشند، هر کدام یک خط را اشغال می‌کنند. اگر فقط عنوان مشخص شده باشد، هر دو خط را اشغال می‌کند.

subtitle

string

عنوان فرعی سربرگ کارت. در صورت مشخص بودن، در خط جداگانه‌ای زیر title ظاهر می‌شود.

imageType

ImageType

شکلی که برای برش تصویر استفاده می‌شود.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

imageUrl

string

آدرس اینترنتی HTTPS تصویر در هدر کارت.

imageAltText

string

متن جایگزین این تصویر که برای دسترسی‌پذیری استفاده می‌شود.

سبک نمایش

در افزونه‌های Google Workspace، نحوه نمایش یک کارت را تعیین می‌کند.

برای افزونه‌های Google Workspace در دسترس است و برای برنامه‌های Google Chat در دسترس نیست.

انوم‌ها
DISPLAY_STYLE_UNSPECIFIED استفاده نکنید. نامشخص.
PEEK سربرگ کارت در پایین نوار کناری ظاهر می‌شود و تا حدی کارت بالایی فعلی دسته کارت‌ها را می‌پوشاند. کلیک روی سربرگ، کارت را به دسته کارت‌ها منتقل می‌کند. اگر کارت سربرگ نداشته باشد، به جای آن از یک سربرگ تولید شده استفاده می‌شود.
REPLACE مقدار پیش‌فرض. کارت با جایگزینی نمای کارت بالایی در دسته کارت‌ها نمایش داده می‌شود.

سبک جداکننده

سبک جداکننده کارت. در حال حاضر فقط برای جداکننده‌های بین بخش‌های کارت استفاده می‌شود.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

انوم‌ها
DIVIDER_STYLE_UNSPECIFIED استفاده نکنید. نامشخص.
SOLID_DIVIDER گزینه پیش‌فرض. یک جداکننده‌ی محکم ایجاد کنید.
NO_DIVIDER اگر تنظیم شود، هیچ جداکننده‌ای رندر نمی‌شود. این استایل جداکننده را به طور کامل از طرح‌بندی حذف می‌کند. نتیجه معادل این است که اصلاً جداکننده‌ای اضافه نشود.

ویجت تودرتو

فهرستی از ویجت‌ها که می‌توانند در یک طرح‌بندی شامل، مانند یک CarouselCard ، نمایش داده شوند. برای برنامه‌های Google Chat در دسترس است و برای افزونه‌های Google Workspace در دسترس نیست.

فیلدها

data فیلد اتحادیه.

data می‌توانند فقط یکی از موارد زیر باشند:

textParagraph

TextParagraph

ویجت پاراگراف متنی.

buttonList

ButtonList

یک ویجت لیست دکمه‌ای.

image

Image

یک ویجت تصویر.

بخش

یک بخش شامل مجموعه‌ای از ویجت‌ها است که به ترتیب مشخص شده به صورت عمودی رندر می‌شوند.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

فیلدها
header

string

متنی که در بالای یک بخش ظاهر می‌شود. از متن ساده با قالب‌بندی HTML پشتیبانی می‌کند. برای اطلاعات بیشتر در مورد قالب‌بندی متن، به افزونه‌های قالب‌بندی متن در برنامه‌های چت گوگل و قالب‌بندی متن در افزونه‌های فضای کاری گوگل مراجعه کنید.

widgets[]

Widget

تمام ابزارک‌های موجود در بخش. باید حداقل شامل یک ابزارک باشد.

collapsible

bool

نشان می‌دهد که آیا این بخش قابل جمع شدن است یا خیر.

بخش‌های قابل جمع شدن، برخی یا همه ویجت‌ها را پنهان می‌کنند، اما کاربران می‌توانند با کلیک روی «نمایش بیشتر» بخش را گسترش دهند تا ویجت‌های پنهان شده آشکار شوند. کاربران می‌توانند با کلیک روی «نمایش کمتر» دوباره ویجت‌ها را پنهان کنند.

برای تعیین اینکه کدام ویجت‌ها پنهان هستند، uncollapsibleWidgetsCount را مشخص کنید.

uncollapsibleWidgetsCount

int32

تعداد ویجت‌های غیرقابل‌جمع که حتی با جمع شدن یک بخش، قابل مشاهده باقی می‌مانند.

برای مثال، وقتی یک بخش شامل پنج ویجت باشد و uncollapsibleWidgetsCount روی 2 تنظیم شده باشد، دو ویجت اول همیشه نمایش داده می‌شوند و سه ویجت آخر به طور پیش‌فرض جمع می‌شوند. uncollapsibleWidgetsCount فقط زمانی در نظر گرفته می‌شود که collapsible true باشد.

id

string

یک شناسه منحصر به فرد که به بخشی اختصاص داده می‌شود که برای شناسایی بخشی که قرار است تغییر کند، استفاده می‌شود. این شناسه محدودیت کاراکتری ۶۴ کاراکتر دارد و باید به شکل [a-zA-Z0-9-]+ باشد.

برای افزونه‌های Google Workspace که Google Workspace Studio را توسعه می‌دهند، در دسترس است. برای برنامه‌های Google Chat در دسترس نیست.

collapseControl

CollapseControl

اختیاری. دکمه باز و بسته کردن بخش را تعریف کنید. این دکمه فقط در صورتی نمایش داده می‌شود که بخش قابل باز شدن باشد. اگر این فیلد تنظیم نشود، دکمه پیش‌فرض استفاده می‌شود.

قابلیت مشاهده

مشخص می‌کند که آیا یک عنصر رابط کاربری قابل مشاهده یا پنهان باشد.

برای افزونه‌های Google Workspace که Google Workspace Studio را توسعه می‌دهند، در دسترس است. برای برنامه‌های Google Chat در دسترس نیست.

انوم‌ها
VISIBILITY_UNSPECIFIED میزان دید نامشخص. استفاده نکنید.
VISIBLE عنصر رابط کاربری قابل مشاهده است.
HIDDEN عنصر رابط کاربری پنهان است.

یک چرخ فلک که به عنوان اسلایدر نیز شناخته می‌شود، می‌چرخد و لیستی از ویجت‌ها را در قالب نمایش اسلاید نمایش می‌دهد، با دکمه‌هایی که به ویجت قبلی یا بعدی می‌روند.

برای مثال، این یک نمایش JSON از یک چرخ و فلک است که شامل سه ویجت پاراگراف متنی است.

{
  "carouselCards": [
    {
      "widgets": [
        {
          "textParagraph": {
            "text": "First text paragraph in carousel",
          }
        }
      ]
    },
    {
      "widgets": [
        {
          "textParagraph": {
            "text": "Second text paragraph in carousel",
          }
        }
      ]
    },
    {
      "widgets": [
        {
          "textParagraph": {
            "text": "Third text paragraph in carousel",
          }
        }
      ]
    }
  ]
}

برای برنامه‌های Google Chat در دسترس است و برای افزونه‌های Google Workspace در دسترس نیست.

فیلدها
carouselCards[]

CarouselCard

فهرستی از کارت‌های موجود در چرخ و فلک.

کارت چرخ فلک

کارتی که می‌تواند به عنوان یک آیتم چرخ و فلکی نمایش داده شود. برای برنامه‌های Google Chat در دسترس است و برای افزونه‌های Google Workspace در دسترس نیست.

فیلدها
widgets[]

NestedWidget

فهرستی از ابزارک‌های نمایش داده شده در کارت چرخ فلک. ابزارک‌ها به ترتیبی که مشخص شده‌اند نمایش داده می‌شوند.

footerWidgets[]

NestedWidget

فهرستی از ابزارک‌ها که در پایین کارت چرخ فلک نمایش داده می‌شود. ابزارک‌ها به ترتیبی که مشخص شده‌اند نمایش داده می‌شوند.

تراشه

یک متن، آیکون یا متن و آیکون که کاربران می‌توانند روی آن کلیک کنند.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

فیلدها
icon

Icon

تصویر آیکون. اگر هم icon و هم text تنظیم شده باشند، آیکون قبل از متن ظاهر می‌شود.

label

string

متنی که درون تراشه نمایش داده می‌شود.

onClick

OnClick

اختیاری. عملی که هنگام کلیک کاربر روی تراشه انجام می‌شود، مانند باز کردن یک لینک یا اجرای یک تابع سفارشی.

enabled
(deprecated)

bool

اینکه آیا تراشه در حالت فعال است و به اقدامات کاربر پاسخ می‌دهد یا خیر. مقدار پیش‌فرض true است. منسوخ شده است. به جای آن disabled استفاده کنید.

disabled

bool

اینکه آیا تراشه در حالت غیرفعال است و اقدامات کاربر را نادیده می‌گیرد یا خیر. مقدار پیش‌فرض false است.

altText

string

متن جایگزینی که برای دسترسی‌پذیری استفاده می‌شود.

متن توصیفی تنظیم کنید که به کاربران اطلاع دهد تراشه چه کاری انجام می‌دهد. برای مثال، اگر تراشه یک پیوند را باز می‌کند، بنویسید: «یک برگه مرورگر جدید باز می‌کند و به مستندات توسعه‌دهنده Google Chat در https://developers.google.com/workspace/chat می‌رود» .

چیپ لیست

فهرستی از تراشه‌ها که به صورت افقی چیده شده‌اند، که می‌توانند به صورت افقی اسکرول شوند یا به خط بعدی بروند.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

فیلدها
layout

Layout

طرح‌بندی لیست تراشه‌های مشخص‌شده.

chips[]

Chip

مجموعه‌ای از چیپس‌ها.

طرح بندی

طرح لیست تراشه‌ها.

انوم‌ها
LAYOUT_UNSPECIFIED استفاده نکنید. نامشخص.
WRAPPED مقدار پیش‌فرض. اگر فضای افقی کافی وجود نداشته باشد، لیست تراشه‌ها به خط بعدی می‌رود.
HORIZONTAL_SCROLLABLE اگر چیپ‌ها در فضای موجود جا نشوند، به صورت افقی حرکت می‌کنند.

کنترل جمع‌شونده

نمایانگر یک کنترل باز و بسته شدن است.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

فیلدها
horizontalAlignment

HorizontalAlignment

تراز افقی دکمه‌ی باز و بسته شدن.

expandButton

Button

اختیاری. یک دکمه قابل تنظیم برای گسترش بخش تعریف کنید. هر دو فیلد expandButton و collapseButton باید تنظیم شوند. فقط تنظیم یک فیلد اعمال نمی‌شود. اگر این فیلد تنظیم نشود، از دکمه پیش‌فرض استفاده می‌شود.

collapseButton

Button

اختیاری. یک دکمه قابل تنظیم برای جمع کردن بخش تعریف کنید. هر دو فیلد expandButton و collapseButton باید تنظیم شوند. فقط تنظیم یک فیلد اعمال نمی‌شود. اگر این فیلد تنظیم نشود، از دکمه پیش‌فرض استفاده می‌شود.

ستون‌ها

ویجت Columns حداکثر ۲ ستون را در یک کارت یا کادر محاوره‌ای نمایش می‌دهد. می‌توانید به هر ستون ویجت اضافه کنید؛ ویجت‌ها به ترتیبی که مشخص شده‌اند ظاهر می‌شوند. برای مثال در برنامه‌های چت گوگل، به نمایش کارت‌ها و کادرهای محاوره‌ای در ستون‌ها مراجعه کنید.

ارتفاع هر ستون توسط ستون بلندتر تعیین می‌شود. برای مثال، اگر ستون اول از ستون دوم بلندتر باشد، هر دو ستون ارتفاع ستون اول را دارند. از آنجا که هر ستون می‌تواند شامل تعداد متفاوتی از ویجت‌ها باشد، نمی‌توانید ردیف تعریف کنید یا ویجت‌ها را بین ستون‌ها تراز کنید.

ستون‌ها در کنار هم نمایش داده می‌شوند. می‌توانید عرض هر ستون را با استفاده از فیلد HorizontalSizeStyle تنظیم کنید. اگر عرض صفحه نمایش کاربر خیلی باریک باشد، ستون دوم زیر ستون اول قرار می‌گیرد:

  • در وب، ستون دوم در صورتی که عرض صفحه نمایش کمتر یا مساوی ۴۸۰ پیکسل باشد، جمع می‌شود.
  • در دستگاه‌های iOS، اگر عرض صفحه نمایش کمتر یا مساوی ۳۰۰ pt باشد، ستون دوم جمع می‌شود.
  • در دستگاه‌های اندروید، اگر عرض صفحه نمایش کمتر یا مساوی ۳۲۰ dp باشد، ستون دوم جمع می‌شود.

برای اضافه کردن بیش از دو ستون یا استفاده از ردیف‌ها، از ویجت Grid استفاده کنید.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است. رابط‌های کاربری افزونه‌هایی که از ستون‌ها پشتیبانی می‌کنند عبارتند از:

  • کادر محاوره‌ای که هنگام باز کردن افزونه از پیش‌نویس ایمیل توسط کاربران نمایش داده می‌شود.
  • کادر محاوره‌ای که هنگام باز کردن افزونه از منوی «افزودن پیوست» در رویداد تقویم گوگل توسط کاربران نمایش داده می‌شود.
فیلدها
columnItems[]

Column

آرایه‌ای از ستون‌ها. می‌توانید تا ۲ ستون را در یک کارت یا کادر محاوره‌ای قرار دهید.

ستون

یک ستون.

افزونه‌های Google Workspace و برنامه‌های چت

فیلدها
horizontalSizeStyle

HorizontalSizeStyle

مشخص می‌کند که یک ستون چگونه عرض کارت را پر کند.

horizontalAlignment

HorizontalAlignment

مشخص می‌کند که آیا ویجت‌ها در سمت چپ، راست یا مرکز یک ستون ترازبندی شوند.

verticalAlignment

VerticalAlignment

مشخص می‌کند که آیا ویجت‌ها در بالا، پایین یا مرکز یک ستون ترازبندی شوند یا خیر.

widgets[]

Widgets

آرایه‌ای از ویجت‌ها که در یک ستون قرار گرفته‌اند. ویجت‌ها به ترتیبی که مشخص شده‌اند، نمایش داده می‌شوند.

سبک اندازه افقی

مشخص می‌کند که یک ستون چگونه عرض کارت را پر می‌کند. عرض هر ستون به HorizontalSizeStyle و عرض ویجت‌های درون ستون بستگی دارد.

افزونه‌های Google Workspace و برنامه‌های چت

انوم‌ها
HORIZONTAL_SIZE_STYLE_UNSPECIFIED استفاده نکنید. نامشخص.
FILL_AVAILABLE_SPACE مقدار پیش‌فرض. ستون فضای موجود را تا ۷۰٪ از عرض کارت پر می‌کند. اگر هر دو ستون روی FILL_AVAILABLE_SPACE تنظیم شده باشند، هر ستون ۵۰٪ از فضا را پر می‌کند.
FILL_MINIMUM_SPACE ستون کمترین فضای ممکن را اشغال می‌کند و نباید بیش از 30٪ از عرض کارت باشد.

ترازبندی عمودی

مشخص می‌کند که آیا ویجت‌ها در بالا، پایین یا مرکز یک ستون ترازبندی شوند یا خیر.

افزونه‌های Google Workspace و برنامه‌های چت

انوم‌ها
VERTICAL_ALIGNMENT_UNSPECIFIED استفاده نکنید. نامشخص.
CENTER مقدار پیش‌فرض. ویجت‌ها را در مرکز ستون تراز می‌کند.
TOP ویجت‌ها را در بالای یک ستون تراز می‌کند.
BOTTOM ویجت‌ها را در پایین ستون تراز می‌کند.

ابزارک‌ها

ویجت‌های پشتیبانی‌شده‌ای که می‌توانید در یک ستون قرار دهید.

افزونه‌های Google Workspace و برنامه‌های چت

فیلدها

data فیلد اتحادیه.

data می‌توانند فقط یکی از موارد زیر باشند:

textParagraph

TextParagraph

ویجت TextParagraph

image

Image

ویجت Image .

decoratedText

DecoratedText

ویجت DecoratedText

buttonList

ButtonList

ویجت ButtonList

textInput

TextInput

ویجت TextInput

selectionInput

SelectionInput

ویجت SelectionInput .

dateTimePicker

DateTimePicker

ویجت انتخابگر DateTimePicker

chipList

ChipList

ویجت ChipList .

وضعیت

بیانگر شرطی است که می‌تواند برای شروع یک عمل استفاده شود.

برای افزونه‌های Google Workspace که Google Workspace Studio را توسعه می‌دهند، در دسترس است. برای برنامه‌های Google Chat در دسترس نیست.

فیلدها
actionRuleId

string

شناسه منحصر به فرد ActionRule.

condition فیلد Union. شرط. condition می‌تواند فقط یکی از موارد زیر باشد:
expressionDataCondition

ExpressionDataCondition

شرطی که توسط داده‌های عبارت تعیین می‌شود.

شرط داده بیانی

بیانگر شرطی است که با استفاده از CEL ارزیابی می‌شود.

برای افزونه‌های Google Workspace که Google Workspace Studio را توسعه می‌دهند، در دسترس است. برای برنامه‌های Google Chat در دسترس نیست.

فیلدها
conditionType

ConditionType

نوع شرط.

نوع وضعیت

نوع شرط.

انوم‌ها
CONDITION_TYPE_UNSPECIFIED نوع شرط نامشخص.
EXPRESSION_EVALUATION_SUCCESS ارزیابی عبارت با موفقیت انجام شد.
EXPRESSION_EVALUATION_FAILURE ارزیابی عبارت ناموفق بود.

اقدامات داده

یک افزونه که داده‌های Google Workspace را به‌روزرسانی می‌کند.

فیلدها
hostAppDataAction

HostAppDataActionMarkup

نحوه به‌روزرسانی داده‌های Google Workspace را تعریف می‌کند.

پیکربندی منبع داده

یک شیء پیکربندی که به پیکربندی منابع داده برای یک ویجت کمک می‌کند.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace که Google Workspace Studio را گسترش می‌دهند، در دسترس است.

فیلدها
فیلد یونیون data_source . منبع داده data_source فقط می‌تواند یکی از موارد زیر باشد:
remoteDataSource

Action

داده‌ها از یک ارائه‌دهنده داده از راه دور است.

platformDataSource

PlatformDataSource

داده‌ها از برنامه Google Workspace گرفته شده‌اند.

minCharactersTrigger

int32

حداقل تعداد کاراکترهایی که کاربر باید قبل از فعال شدن این ارائه دهنده داده (یعنی قبل از شروع به بازگرداندن نتایج) وارد کند.

انتخابگر تاریخ و زمان

به کاربران اجازه می‌دهد تاریخ، زمان یا هر دو را وارد کنند. از اعتبارسنجی ارسال فرم پشتیبانی می‌کند. وقتی Action.all_widgets_are_required روی true تنظیم شده باشد یا این ویجت در Action.required_widgets مشخص شده باشد، عملیات ارسال مسدود می‌شود مگر اینکه مقداری انتخاب شود. برای مثال در برنامه‌های چت گوگل، به بخش «اجازه دهید کاربر تاریخ و زمان را انتخاب کند» مراجعه کنید.

کاربران می‌توانند متن را وارد کنند یا از انتخابگر برای انتخاب تاریخ و زمان استفاده کنند. اگر کاربران تاریخ یا زمان نامعتبری وارد کنند، انتخابگر خطایی را نشان می‌دهد که از کاربران می‌خواهد اطلاعات را به درستی وارد کنند.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

فیلدها
name

string

نامی که DateTimePicker در رویداد ورودی فرم با آن شناسایی می‌شود.

برای جزئیات بیشتر در مورد کار با ورودی‌های فرم، به بخش «دریافت داده‌های فرم» مراجعه کنید.

label

string

متنی که کاربران را به وارد کردن تاریخ، زمان یا تاریخ و زمان ترغیب می‌کند. برای مثال، اگر کاربران در حال برنامه‌ریزی قرار ملاقات هستند، از برچسبی مانند Appointment date یا Appointment date and time استفاده کنید.

type

DateTimePickerType

اینکه آیا ویجت از وارد کردن تاریخ، زمان یا تاریخ و زمان پشتیبانی می‌کند یا خیر.

valueMsEpoch

int64

مقدار پیش‌فرض نمایش داده شده در ویجت، بر حسب میلی‌ثانیه از زمان آغاز یونیکس .

مقدار را بر اساس نوع انتخابگر ( DateTimePickerType ) مشخص کنید:

  • DATE_AND_TIME : یک تاریخ و زمان تقویمی بر حسب UTC. برای مثال، برای نمایش ۱ ژانویه ۲۰۲۳ در ساعت ۱۲:۰۰ بعد از ظهر به وقت UTC، 1672574400000 استفاده کنید.
  • DATE_ONLY : یک تاریخ تقویمی در ساعت 00:00:00 UTC. برای مثال، برای نمایش ۱ ژانویه ۲۰۲۳، 1672531200000 استفاده کنید.
  • TIME_ONLY : زمان بر حسب UTC. برای مثال، برای نمایش ساعت ۱۲:۰۰ بعد از ظهر، 43200000 (یا 12 * 60 * 60 * 1000 ) استفاده کنید.
timezoneOffsetDate

int32

عددی که نشان‌دهنده‌ی اختلاف منطقه‌ی زمانی نسبت به UTC، بر حسب دقیقه است. در صورت تنظیم، value_ms_epoch در منطقه‌ی زمانی مشخص شده نمایش داده می‌شود. در صورت عدم تنظیم، مقدار پیش‌فرض روی تنظیمات منطقه‌ی زمانی کاربر تنظیم می‌شود.

onChangeAction

Action

زمانی که کاربر روی ذخیره یا پاک کردن از رابط DateTimePicker کلیک کند، فعال می‌شود.

فیلد یونیونی data_source . منبع داده‌ای که برای نمایش تاریخ و زمان مشخص شده است. data_source فقط می‌تواند یکی از موارد زیر باشد:
hostAppDataSource

HostAppDataSourceMarkup

منبع داده‌ای که مختص برنامه میزبان Google Workspace است، مانند ایمیل‌های Gmail، رویدادهای Google Calendar یا پیام‌های Google Chat.

برای افزونه‌های Google Workspace که Google Workspace Studio را توسعه می‌دهند، در دسترس است. برای برنامه‌های Google Chat در دسترس نیست.

نوع انتخابگر تاریخ و زمان

قالب تاریخ و زمان در ویجت DateTimePicker . تعیین می‌کند که آیا کاربران می‌توانند تاریخ، زمان یا هر دو را وارد کنند.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

انوم‌ها
DATE_AND_TIME کاربران تاریخ و زمان را وارد می‌کنند.
DATE_ONLY کاربران یک تاریخ وارد می‌کنند.
TIME_ONLY کاربران یک زمان وارد می‌کنند.

متن تزئین‌شده

ویجتی که متن را با تزئینات اختیاری مانند برچسب در بالا یا پایین متن، یک نماد در جلوی متن، یک ویجت انتخاب یا یک دکمه بعد از متن نمایش می‌دهد. برای مثال در برنامه‌های چت گوگل، به نمایش متن با متن تزئینی مراجعه کنید.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

فیلدها
icon
(deprecated)

Icon

به نفع startIcon منسوخ شده است.

startIcon

Icon

آیکونی که در جلوی متن نمایش داده می‌شود.

startIconVerticalAlignment

VerticalAlignment

اختیاری. تراز عمودی آیکون شروع. اگر تنظیم نشود، آیکون به صورت عمودی در مرکز قرار می‌گیرد.

برای برنامه‌های Google Chat در دسترس است و برای افزونه‌های Google Workspace در دسترس نیست.

topLabel

string

متنی که بالای text ظاهر می‌شود. همیشه کوتاه می‌شود.

topLabelText

TextParagraph

معادل TextParagraph top_label . همیشه کوتاه می‌کند. امکان قالب‌بندی پیچیده‌تری نسبت به top_label فراهم می‌کند.

برای برنامه‌های Google Chat در دسترس است و برای افزونه‌های Google Workspace در دسترس نیست.

text

string

متن اصلی الزامی است.

از قالب‌بندی ساده پشتیبانی می‌کند. برای اطلاعات بیشتر در مورد قالب‌بندی متن، به افزونه‌های قالب‌بندی متن در برنامه‌های چت گوگل و قالب‌بندی متن در فضای کاری گوگل مراجعه کنید.

contentText

TextParagraph

معادل text در TextParagraph ). امکان قالب‌بندی پیچیده‌تری نسبت به text را فراهم می‌کند.

برای برنامه‌های Google Chat در دسترس است و برای افزونه‌های Google Workspace در دسترس نیست.

wrapText

bool

تنظیم متن پوششی. اگر true ، متن پوشش داده شده و در چند خط نمایش داده می‌شود. در غیر این صورت، متن کوتاه می‌شود.

فقط روی text اعمال می‌شود، نه topLabel و bottomLabel .

bottomLabel

string

متنی که زیر text ظاهر می‌شود. همیشه متن را می‌پوشاند.

bottomLabelText

TextParagraph

معادل TextParagraph bottom_label . همیشه در بر می‌گیرد. امکان قالب‌بندی پیچیده‌تری نسبت به bottom_label فراهم می‌کند.

برای برنامه‌های Google Chat در دسترس است و برای افزونه‌های Google Workspace در دسترس نیست.

onClick

OnClick

این اکشن زمانی فعال می‌شود که کاربران روی topLabel یا bottomLabel کلیک کنند.

control فیلد Union. یک دکمه، سوئیچ، کادر انتخاب یا تصویری که در سمت راست متن در ویجت decoratedText ظاهر می‌شود. control می‌تواند فقط یکی از موارد زیر باشد:
button

Button

دکمه‌ای که کاربر می‌تواند با کلیک روی آن، عملی را انجام دهد.

switchControl

SwitchControl

یک ویجت سوئیچ که کاربر می‌تواند با کلیک روی آن، وضعیت آن را تغییر داده و عملی را انجام دهد.

endIcon

Icon

نمادی که بعد از متن نمایش داده می‌شود.

پشتیبانی از آیکون‌های پیش‌فرض و سفارشی

سوئیچ کنترل

یا یک سوئیچ به سبک toggle یا یک کادر انتخاب درون یک ویجت decoratedText .

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

فقط در ویجت decoratedText پشتیبانی می‌شود.

فیلدها
name

string

نامی که ویجت سوئیچ در رویداد ورودی فرم با آن شناسایی می‌شود.

برای جزئیات بیشتر در مورد کار با ورودی‌های فرم، به بخش «دریافت داده‌های فرم» مراجعه کنید.

value

string

مقداری که توسط کاربر وارد شده و به عنوان بخشی از رویداد ورودی فرم برگردانده می‌شود.

برای جزئیات بیشتر در مورد کار با ورودی‌های فرم، به بخش «دریافت داده‌های فرم» مراجعه کنید.

selected

bool

وقتی true ، سوئیچ انتخاب شده است.

onChangeAction

Action

عملی که هنگام تغییر حالت سوئیچ باید انجام شود، مانند اینکه چه تابعی اجرا شود.

controlType

ControlType

نحوه نمایش سوئیچ در رابط کاربری.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

نوع کنترل

نحوه نمایش سوئیچ در رابط کاربری.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

انوم‌ها
SWITCH یک کلید به سبک تاگل.
CHECKBOX به نفع CHECK_BOX منسوخ شده است.
CHECK_BOX یک کادر انتخاب.

تقسیم کننده

این نوع هیچ فیلدی ندارد.

جداکننده‌ای بین ابزارک‌ها را به صورت یک خط افقی نمایش می‌دهد. برای مثال در برنامه‌های چت گوگل، به بخش «افزودن جداکننده افقی بین ابزارک‌ها» مراجعه کنید.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

برای مثال، JSON زیر یک جداکننده ایجاد می‌کند:

"divider": {}

پایان ناوبری

برای افزونه‌ها در گوگل چت ، یک کادر محاوره‌ای را می‌بندد.

فیلدها
action

Action

برای افزونه‌های موجود در گوگل چت ، عملی که یک کادر محاوره‌ای را می‌بندد.

برای افزونه‌های Google Workspace در دسترس است و برای برنامه‌های Google Chat در دسترس نیست.

اکشن

برای افزونه‌ها در گوگل چت ، اقداماتی برای بستن یک پنجره گفتگو .

انوم‌ها
ACTION_UNSPECIFIED اقدام مشخص نشده است.
CLOSE_DIALOG یک کادر محاوره‌ای را می‌بندد.
CLOSE_DIALOG_AND_EXECUTE یک کادر محاوره‌ای را می‌بندد و کارتی را که کادر محاوره‌ای را باز کرده است، به‌روزرسانی می‌کند.

رویداداکشن

نشان‌دهنده عملی است که می‌تواند روی یک عنصر ui انجام شود.

برای افزونه‌های Google Workspace که Google Workspace Studio را توسعه می‌دهند، در دسترس است. برای برنامه‌های Google Chat در دسترس نیست.

فیلدها
actionRuleId

string

شناسه منحصر به فرد ActionRule.

postEventTriggers[]

Trigger

فهرست محرک‌هایی که پس از اجرای EventAction فعال می‌شوند.

action میدانی اتحادیه. اقدامی که باید انجام شود. action می‌تواند فقط یکی از موارد زیر باشد:
commonWidgetAction

CommonWidgetAction

عملکرد ویجت رایج.

CommonWidgetAction

نشان‌دهنده‌ی عملی است که مختص یک ویجت نیست.

برای افزونه‌های Google Workspace که Google Workspace Studio را توسعه می‌دهند، در دسترس است. برای برنامه‌های Google Chat در دسترس نیست.

فیلدها
action میدانی اتحادیه. اقدامی که باید انجام شود. action می‌تواند فقط یکی از موارد زیر باشد:
updateVisibilityAction

UpdateVisibilityAction

عملی برای به‌روزرسانی قابلیت مشاهده‌ی یک ویجت.

به‌روزرسانی قابلیت مشاهده (UpdateVisibilityAction)

نشان‌دهنده‌ی عملی است که قابلیت مشاهده‌ی یک ویجت را به‌روزرسانی می‌کند.

برای افزونه‌های Google Workspace که Google Workspace Studio را توسعه می‌دهند، در دسترس است. برای برنامه‌های Google Chat در دسترس نیست.

فیلدها
visibility

Visibility

قابلیت دید جدید.

اکسپرشن دیتا

نشان‌دهنده‌ی داده‌هایی است که برای ارزیابی یک عبارت استفاده می‌شوند.

برای افزونه‌های Google Workspace که Google Workspace Studio را توسعه می‌دهند، در دسترس است. برای برنامه‌های Google Chat در دسترس نیست.

فیلدها
id

string

شناسه منحصر به فرد ExpressionData.

expression

string

عبارت کامپایل نشده.

conditions[]

Condition

فهرست شرایطی که توسط نتیجه ارزیابی عبارت تعیین می‌شوند.

eventActions[]

EventAction

فهرست اقداماتی که ExpressionData می‌تواند مورد استفاده قرار گیرد.

دریافت پاسخ تکمیل خودکار

پاسخی برای دریافت ظرف تکمیل خودکار، که شامل عناصر لازم برای نمایش موارد تکمیل خودکار برای فیلد متنی است.

برای افزونه‌های Google Workspace موجود است و برای برنامه‌های Google Chat موجود نیست. برای مثال:

{
  "autoComplete": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}
فیلدها
autoComplete

Suggestions

schema

string

این یک فیلد طرحواره بدون عملیات است که ممکن است در نشانه‌گذاری برای بررسی نحو وجود داشته باشد.

شبکه

یک شبکه با مجموعه‌ای از آیتم‌ها را نمایش می‌دهد. آیتم‌ها فقط می‌توانند شامل متن یا تصویر باشند. برای ستون‌های واکنش‌گرا یا برای افزودن بیش از متن یا تصویر، Columns استفاده کنید. برای مثال در برنامه‌های چت گوگل، به نمایش یک شبکه با مجموعه‌ای از آیتم‌ها مراجعه کنید.

یک شبکه می‌تواند از هر تعداد ستون و آیتم پشتیبانی کند. تعداد ردیف‌ها با تقسیم آیتم‌ها بر ستون‌ها تعیین می‌شود. یک شبکه با ۱۰ آیتم و ۲ ستون، ۵ ردیف دارد. یک شبکه با ۱۱ آیتم و ۲ ستون، ۶ ردیف دارد.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

برای مثال، JSON زیر یک جدول دو ستونی با یک آیتم ایجاد می‌کند:

"grid": {
  "title": "A fine collection of items",
  "columnCount": 2,
  "borderStyle": {
    "type": "STROKE",
    "cornerRadius": 4
  },
  "items": [
    {
      "image": {
        "imageUri": "https://www.example.com/image.png",
        "cropStyle": {
          "type": "SQUARE"
        },
        "borderStyle": {
          "type": "STROKE"
        }
      },
      "title": "An item",
      "textAlignment": "CENTER"
    }
  ],
  "onClick": {
    "openLink": {
      "url": "https://www.example.com"
    }
  }
}
فیلدها
title

string

متنی که در هدر شبکه نمایش داده می‌شود.

items[]

GridItem

مواردی که باید در شبکه نمایش داده شوند.

borderStyle

BorderStyle

سبک حاشیه‌ای که برای هر آیتم شبکه‌ای اعمال می‌شود.

columnCount

int32

تعداد ستون‌هایی که در جدول نمایش داده می‌شوند. اگر این فیلد مشخص نشده باشد، از مقدار پیش‌فرض استفاده می‌شود و آن مقدار پیش‌فرض بسته به محل نمایش جدول (کادر محاوره‌ای در مقابل کادر محاوره‌ای) متفاوت است.

onClick

OnClick

این تابع فراخوانی توسط هر آیتم شبکه به صورت جداگانه مورد استفاده مجدد قرار می‌گیرد، اما شناسه و اندیس آیتم در لیست آیتم‌ها به پارامترهای تابع فراخوانی اضافه می‌شود.

آیتم شبکه‌ای

یک آیتم را در یک طرح شبکه‌ای نشان می‌دهد. آیتم‌ها می‌توانند شامل متن، تصویر یا متن و تصویر باشند.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

فیلدها
id

string

یک شناسه‌ی مشخص‌شده توسط کاربر برای این آیتم شبکه. این شناسه در پارامترهای فراخوانی onClick شبکه‌ی والد بازگردانده می‌شود.

image

ImageComponent

تصویری که در آیتم شبکه‌ای نمایش داده می‌شود.

title

string

عنوان آیتم شبکه‌ای.

subtitle

string

زیرعنوان آیتم شبکه‌ای.

layout

GridItemLayout

طرح‌بندی مورد استفاده برای آیتم شبکه‌ای.

طرح‌بندی آیتم شبکه‌ای

گزینه‌های مختلف طرح‌بندی موجود برای یک آیتم شبکه‌ای را نشان می‌دهد.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

انوم‌ها
GRID_ITEM_LAYOUT_UNSPECIFIED استفاده نکنید. نامشخص.
TEXT_BELOW عنوان و زیرعنوان در زیر تصویر آیتم شبکه‌ای نشان داده می‌شوند.
TEXT_ABOVE عنوان و زیرعنوان در بالای تصویر آیتم شبکه‌ای نشان داده می‌شوند.

آیکون

نمادی که در یک ابزارک روی کارت نمایش داده می‌شود. برای مثال در برنامه‌های چت گوگل، به افزودن یک نماد مراجعه کنید.

پشتیبانی از آیکون‌های پیش‌فرض و سفارشی

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

فیلدها
altText

string

اختیاری. توضیحی در مورد آیکون مورد استفاده برای دسترسی‌پذیری. در صورت عدم تعیین مقدار، مقدار پیش‌فرض Button ارائه می‌شود. به عنوان یک رویه بهتر، باید توضیحی مفید برای آنچه آیکون نمایش می‌دهد و در صورت لزوم، کاری که انجام می‌دهد، تنظیم کنید. به عنوان مثال، A user's account portrait ، یا Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat .

اگر آیکون در یک Button تنظیم شده باشد، متن altText به عنوان متن کمکی هنگام قرار گرفتن ماوس روی دکمه نمایش داده می‌شود. با این حال، اگر دکمه text نیز تنظیم کند، altText آیکون نادیده گرفته می‌شود.

imageType

ImageType

سبک برش اعمال شده بر روی تصویر. در برخی موارد، اعمال برش CIRCLE باعث می‌شود تصویر بزرگتر از یک آیکون داخلی رسم شود.

icons فیلد Union. آیکونی که در ویجت روی کارت نمایش داده می‌شود. icons می‌توانند فقط یکی از موارد زیر باشند:
knownIcon

string

یکی از آیکون‌های داخلی ارائه شده توسط Google Workspace را نمایش دهید.

برای مثال، برای نمایش آیکون هواپیما، AIRPLANE را مشخص کنید. برای اتوبوس، BUS را مشخص کنید.

برای لیست کامل آیکون‌های پشتیبانی‌شده، به آیکون‌های داخلی مراجعه کنید.

iconUrl

string

یک آیکون سفارشی که در یک URL HTTPS میزبانی می‌شود را نمایش دهید.

برای مثال:

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

انواع فایل‌های پشتیبانی‌شده شامل .png ‎ و .jpg ‎ هستند.

materialIcon

MaterialIcon

یکی از آیکون‌های متریال گوگل را نمایش دهید.

برای مثال، برای نمایش آیکون چک‌باکس ، از

"materialIcon": {
  "name": "check_box"
}

برای برنامه‌های Google Chat در دسترس است و برای افزونه‌های Google Workspace در دسترس نیست.

تصویر

تصویری که توسط یک URL مشخص شده است و می‌تواند یک عمل onClick داشته باشد. برای مثال، به افزودن یک تصویر مراجعه کنید.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

فیلدها
imageUrl

string

URL HTTPS که تصویر را میزبانی می‌کند.

برای مثال:

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

OnClick

وقتی کاربر روی تصویر کلیک می‌کند، این عمل انجام می‌شود.

altText

string

متن جایگزین این تصویر که برای دسترسی‌پذیری استفاده می‌شود.

کامپوننت تصویر

نشان دهنده یک تصویر است.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

فیلدها
imageUri

string

آدرس اینترنتی تصویر.

altText

string

برچسب دسترسی‌پذیری برای تصویر.

cropStyle

ImageCropStyle

سبک برش (crop) که باید روی تصویر اعمال شود.

borderStyle

BorderStyle

سبک حاشیه‌ای که باید روی تصویر اعمال شود.

سبک برش تصویر

نشان دهنده سبک برش اعمال شده بر روی تصویر است.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

برای مثال، در اینجا نحوه اعمال نسبت تصویر ۱۶:۹ آورده شده است:

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}
فیلدها
type

ImageCropType

نوع محصول.

aspectRatio

double

نسبت ابعادی که در صورت انتخاب نوع برش RECTANGLE_CUSTOM استفاده می‌شود.

برای مثال، در اینجا نحوه اعمال نسبت تصویر ۱۶:۹ آورده شده است:

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}

نوع برش تصویر

نشان دهنده سبک برش اعمال شده بر روی تصویر است.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

انوم‌ها
IMAGE_CROP_TYPE_UNSPECIFIED استفاده نکنید. نامشخص.
SQUARE مقدار پیش‌فرض. برش مربعی اعمال می‌کند.
CIRCLE یک برش دایره‌ای اعمال می‌کند.
RECTANGLE_CUSTOM یک برش مستطیلی با نسبت ابعاد سفارشی اعمال می‌کند. نسبت ابعاد سفارشی را با aspectRatio تنظیم کنید.
RECTANGLE_4_3 یک برش مستطیلی با نسبت ابعاد ۴:۳ اعمال می‌کند.

پیش‌نمایش لینک

عملکرد کارت که با نمایش کارت و تراشه هوشمند، پیش‌نمایشی از یک لینک شخص ثالث را نمایش می‌دهد. برای کسب اطلاعات بیشتر، به پیش‌نمایش لینک‌ها با تراشه‌های هوشمند مراجعه کنید.

برای افزونه‌های Google Workspace در دسترس است و برای برنامه‌های Google Chat در دسترس نیست.

برای مثال، JSON زیر یک عنوان منحصر به فرد برای پیش‌نمایش لینک و تراشه هوشمند آن، و یک کارت پیش‌نمایش با سربرگ و توضیحات متنی برمی‌گرداند:

{
  "action": {
    "linkPreview": {
      "title": "Smart chip title",
      "linkPreviewTitle": "Link preview title",
      "previewCard": {
        "header": {
          "title": "Preview card header",
        },
        "sections": [
          {
            "widgets": [
              {
                "textParagraph": {
                  "text": "Description of the link."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

این مثال پیش‌نمایش لینک زیر را برمی‌گرداند:

پیش‌نمایش لینک نمونه

فیلدها
previewCard

Card

کارتی که اطلاعات مربوط به لینکی از یک سرویس شخص ثالث را نمایش می‌دهد.

title

string

عنوانی که در تراشه هوشمند برای پیش‌نمایش پیوند نمایش داده می‌شود. اگر تنظیم نشود، تراشه هوشمند سربرگ previewCard را نمایش می‌دهد.

linkPreviewTitle

string

عنوانی که در پیش‌نمایش پیوند نمایش داده می‌شود. اگر تنظیم نشده باشد، پیش‌نمایش پیوند، سربرگ previewCard را نمایش می‌دهد.

آیکون متریال

یک آیکون متریال گوگل ، که شامل بیش از ۲۵۰۰ گزینه است.

برای مثال، برای نمایش یک آیکون چک‌باکس با وزن و درجه سفارشی، موارد زیر را بنویسید:

{
  "name": "check_box",
  "fill": true,
  "weight": 300,
  "grade": -25
}

برای برنامه‌های Google Chat در دسترس است و برای افزونه‌های Google Workspace در دسترس نیست.

فیلدها
name

string

نام آیکون تعریف شده در Google Material Icon ، برای مثال، check_box . هر نام نامعتبری رها شده و با رشته خالی جایگزین می‌شود و منجر به عدم نمایش آیکون می‌شود.

fill

bool

آیا آیکون به صورت پر شده نمایش داده شود یا خیر. مقدار پیش‌فرض false است.

برای پیش‌نمایش تنظیمات مختلف آیکون، به Google Font Icons بروید و تنظیمات را در قسمت Customize تنظیم کنید.

weight

int32

ضخامت خط دور آیکون. از بین {100، 200، 300، 400، 500، 600، 700} یکی را انتخاب کنید. در صورت عدم وجود، مقدار پیش‌فرض 400 است. اگر مقدار دیگری مشخص شود، مقدار پیش‌فرض استفاده می‌شود.

برای پیش‌نمایش تنظیمات مختلف آیکون، به Google Font Icons بروید و تنظیمات را در قسمت Customize تنظیم کنید.

grade

int32

وزن و درجه بر ضخامت یک نماد تأثیر می‌گذارند. تنظیمات درجه نسبت به تنظیمات وزن، جزئی‌تر هستند و تأثیر کمی بر اندازه نماد دارند. از بین {-25، 0، 200} یکی را انتخاب کنید. در صورت عدم وجود، مقدار پیش‌فرض 0 است. اگر مقدار دیگری مشخص شود، از مقدار پیش‌فرض استفاده می‌شود.

برای پیش‌نمایش تنظیمات مختلف آیکون، به Google Font Icons بروید و تنظیمات را در قسمت Customize تنظیم کنید.

کارت اصلاح

برای افزونه‌ها در گوگل چت ، یک کارت را بر اساس تعامل کاربر به‌روزرسانی می‌کند. آرایه فقط باید شامل یک شیء واحد باشد.

فیلدها
operation میدانی اتحادیه. عملیاتی که باید انجام شود. operation می‌تواند فقط یکی از موارد زیر باشد:
updateWidget

UpdateWidget

برای افزونه‌ها در گوگل چت ، یک ویجت را در یک کارت یا کادر محاوره‌ای به‌روزرسانی می‌کند.

ویجت به‌روزرسانی

برای افزونه‌های موجود در گوگل چت ، یک ویجت را در یک کارت یا کادر محاوره‌ای به‌روزرسانی می‌کند. این ویجت برای ارائه پیشنهادات تکمیل خودکار هنگام تایپ کاربر در یک کادر ورودی استفاده می‌شود. برای جزئیات بیشتر به پیشنهاد موارد چندگزینه‌ای مراجعه کنید.

فیلدها
فیلد union updated_widget . به‌روزرسانی‌های یک ویجت. updated_widget فقط می‌تواند یکی از موارد زیر باشد:
selectionInputWidgetSuggestions

SelectionInputWidgetSuggestions

برای ویجت‌های selectionInput ، آرایه‌ای از آیتم‌های پیشنهادی در یک منوی چندگزینه‌ای. وقتی یک منوی چندگزینه‌ای از یک منبع داده خارجی برای پر کردن آیتم‌های خود استفاده می‌کند، ویجت می‌تواند به صورت پویا پیشنهادات را بر اساس آنچه در منو تایپ می‌کنند، پر کند. برای اطلاعات بیشتر، به بخش جمع‌آوری اطلاعات از کاربران Google Chat مراجعه کنید.

ابزارک ورودی انتخابی، پیشنهادات

برای یک ویجت selectionInput که از یک منوی چندگزینه‌ای استفاده می‌کند، موارد انتخاب را از یک منبع داده پویای خارجی برمی‌گرداند.

فیلدها
suggestions[]

SelectionItem

آرایه‌ای از آیتم‌های قابل انتخاب که پس از تایپ در یک منوی چندگزینه‌ای، برای کاربر نمایش داده می‌شود.

کارت‌های موجود در یک دسته کارت را به‌روزرسانی یا بین آنها پیمایش می‌کند .

برای افزونه‌های Google Workspace در دسترس است و برای برنامه‌های Google Chat در دسترس نیست.

برای مثال:

۱) یک کارت جدید برگردانید (به جلو بروید).

 navigations : {
    pushCard : CARD
  }

۲) کارت روی دسته کارت‌ها را به‌روزرسانی کنید (به‌روزرسانی درجا).

  navigations : {
    popCard : true,
  }, {
    pushCard : CARD
  }

۳) بدون به‌روزرسانی، یک مرحله به عقب برگردید.

  navigations : {
    popCard : true,
  }

۴) چندین مرحله به عقب برگردید و آن کارت را به‌روزرسانی کنید.

  navigations : {
    popCard : true,
  }, ... {
    pushCard : CARD
  }

۵) چندین مرحله به عقب برگردید تا به یک CARD_NAME تعریف شده برسید.

  navigations : {
    popToCardName : CARD_NAME,
  }, {
    pushCard : CARD
  }

۶) به ریشه برگردید و آن کارت را به‌روزرسانی کنید.

  navigations : {
    popToRoot : true
  }, {
    pushCard : CARD
  }

۷) به کارت مشخص شده بروید و آن را نیز بیرون بیاورید.

navigations : { popToCardName : CARD_NAME }, { popCard : true, }

۸) کارت بالایی را با یک کارت جدید جایگزین کنید.

  navigations : {
    updateCard : CARD
  }
فیلدها

فیلد اتحادیه navigate_action .

navigate_action فقط می‌تواند یکی از موارد زیر باشد:

popToRoot

bool

همه کارت‌ها را به جز کارت اصلی (ریشه) برمی‌دارد.

pop

bool

یک کارت را از دست می‌دهد.

popToCard

string

تمام کارت‌های بالای کارت مشخص‌شده با نام کارت داده‌شده را نمایش می‌دهد.

pushCard

Card

یک کارت را روی دسته کارت‌ها فشار می‌دهد.

برای پنجره‌های گفتگو در گوگل چت ، یک پنجره گفتگو را باز یا به‌روزرسانی می‌کند.

updateCard

Card

کارت بالایی را با یک کارت جدید به‌روزرسانی می‌کند و مقادیر فیلدهای پر شده فرم را حفظ می‌کند. برای فیلدهای نامعادل، مقدار حذف می‌شود.

برای پنجره‌های گفتگو در گوگل چت ، یک پنجره گفتگو را باز یا به‌روزرسانی می‌کند.

endNavigation

EndNavigation

برای افزونه‌ها در گوگل چت ، یک کادر محاوره‌ای را می‌بندد.

اعلان

عملی که هنگام تعامل کاربر با یک کارت، اعلانی را در برنامه میزبان Google Workspace نمایش می‌دهد.

برای افزونه‌های موجود در گوگل چت ، هنگام ارسال و بستن پنجره توسط کاربران، اعلانی نمایش داده می‌شود.

برای افزونه‌های Google Workspace در دسترس است و برای برنامه‌های Google Chat در دسترس نیست.

فیلدها
text

string

متن ساده برای نمایش اعلان، بدون تگ‌های HTML.

آن‌کلیک

نحوه‌ی پاسخ دادن به کلیک کاربران روی یک عنصر تعاملی روی کارت، مانند یک دکمه، را نشان می‌دهد.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

فیلدها

data فیلد اتحادیه.

data می‌توانند فقط یکی از موارد زیر باشند:

action

Action

در صورت مشخص شدن، یک عمل توسط این onClick آغاز می‌شود.

openDynamicLinkAction

Action

یک افزونه این عمل را زمانی که عمل نیاز به باز کردن یک لینک دارد، فعال می‌کند. این با open_link بالا متفاوت است، زیرا این عمل برای دریافت لینک باید با سرور ارتباط برقرار کند. بنابراین، قبل از اینکه پاسخ عمل باز کردن لینک برگردد، کلاینت وب باید برخی کارهای آماده‌سازی را انجام دهد.

برای افزونه‌های Google Workspace در دسترس است و برای برنامه‌های Google Chat در دسترس نیست.

card

Card

در صورت مشخص شدن، پس از کلیک کردن، یک کارت جدید به دسته کارت‌ها اضافه می‌شود.

برای افزونه‌های Google Workspace در دسترس است و برای برنامه‌های Google Chat در دسترس نیست.

overflowMenu

OverflowMenu

اگر مشخص شده باشد، این onClick یک منوی سرریز باز می‌کند.

روشن/خاموش

کاری که کلاینت هنگام بسته شدن لینکی که توسط یک اکشن OnClick باز شده است، انجام می‌دهد.

پیاده‌سازی به قابلیت‌های پلتفرم کلاینت بستگی دارد. برای مثال، یک مرورگر وب ممکن است با استفاده از یک کنترل‌کننده OnClose لینکی را در یک پنجره پاپ‌آپ باز کند.

اگر هر دو کنترل‌کننده‌ی OnOpen و OnClose تنظیم شده باشند و پلتفرم کلاینت نتواند از هر دو مقدار پشتیبانی کند، OnClose اولویت پیدا می‌کند.

برای افزونه‌های Google Workspace در دسترس است و برای برنامه‌های Google Chat در دسترس نیست.

انوم‌ها
NOTHING مقدار پیش‌فرض. کارت دوباره شارژ نمی‌شود؛ هیچ اتفاقی نمی‌افتد.
RELOAD

پس از بسته شدن پنجره فرزند، کارت را دوباره بارگذاری می‌کند.

اگر همراه با OpenAs.OVERLAY استفاده شود، پنجره فرزند به عنوان یک پنجره محاوره‌ای عمل می‌کند و کارت والد تا زمان بسته شدن پنجره فرزند مسدود می‌شود.

اوپن‌آس

وقتی یک عمل OnClick یک لینک را باز می‌کند، کلاینت می‌تواند آن را به صورت یک پنجره با اندازه کامل (اگر فریم مورد استفاده کلاینت باشد) یا یک پوشش (مانند یک پنجره بازشو) باز کند. پیاده‌سازی آن به قابلیت‌های پلتفرم کلاینت بستگی دارد و اگر کلاینت از مقدار انتخاب شده پشتیبانی نکند، ممکن است نادیده گرفته شود. FULL_SIZE توسط همه کلاینت‌ها پشتیبانی می‌شود.

برای افزونه‌های Google Workspace در دسترس است و برای برنامه‌های Google Chat در دسترس نیست.

انوم‌ها
FULL_SIZE لینک به صورت یک پنجره با اندازه کامل باز می‌شود (اگر این همان قابی باشد که کلاینت از آن استفاده می‌کند).
OVERLAY لینک به صورت یک پوشش، مانند یک پنجره بازشو، باز می‌شود.

منوی سرریز

ویجتی که یک منوی پاپ‌آپ با یک یا چند عمل ارائه می‌دهد که کاربران می‌توانند آنها را فراخوانی کنند. به عنوان مثال، نمایش اعمال غیر اصلی در یک کارت. می‌توانید از این ویجت زمانی استفاده کنید که اعمال در فضای موجود جا نمی‌شوند. برای استفاده، این ویجت را در عمل OnClick ویجت‌هایی که از آن پشتیبانی می‌کنند، مشخص کنید. به عنوان مثال، در یک Button .

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

فیلدها
items[]

OverflowMenuItem

الزامی. فهرست گزینه‌های منو.

آیتم منوی سرریز

گزینه‌ای که کاربران می‌توانند در یک منوی سرریز (overflow menu) فراخوانی کنند.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

فیلدها
startIcon

Icon

آیکونی که در جلوی متن نمایش داده می‌شود.

text

string

الزامی. متنی که آیتم را برای کاربران شناسایی یا توصیف می‌کند.

onClick

OnClick

الزامی. عملی که هنگام انتخاب یک گزینه از منو فراخوانی می‌شود. این OnClick نمی‌تواند شامل OverflowMenu باشد، هر OverflowMenu مشخص شده حذف شده و آیتم منو غیرفعال می‌شود.

disabled

bool

آیا گزینه منو غیرفعال است یا خیر. مقدار پیش‌فرض false است.

رندر اکشن‌ها

مجموعه‌ای از دستورالعمل‌های رندر که به برنامه میزبان می‌گوید چگونه یک کارت را رندر کند یا در پاسخ به تعامل کاربر، عملی را انجام دهد.

برای افزونه‌های Google Workspace در دسترس است و برای برنامه‌های Google Chat در دسترس نیست.

فیلدها
action

Action

عملی که افزونه‌ها می‌توانند برای به‌روزرسانی رابط کاربری از آن استفاده کنند.

افزونه‌ها در گوگل چت

hostAppAction

HostAppActionMarkup

اقداماتی که توسط برنامه‌های میزبان منفرد انجام می‌شوند.

schema

string

این یک فیلد طرحواره بدون عملیات است که ممکن است در نشانه‌گذاری برای بررسی نحو وجود داشته باشد.

اکشن

اقداماتی که افزونه‌ها می‌توانند در کارت‌ها یا برنامه میزبان استفاده کنند.

برای افزونه‌های Google Workspace در دسترس است و برای برنامه‌های Google Chat در دسترس نیست.

فیلدها
navigations[]

Navigation

یک کارت را فشار می‌دهد، بیرون می‌آورد یا به‌روزرسانی می‌کند.

افزونه‌ها در گوگل چت

notification

Notification

وقتی کاربر با یک کارت تعامل می‌کند، یک اعلان در برنامه میزبان Google Workspace نمایش می‌دهد.

برای افزونه‌های موجود در گوگل چت ، هنگام ارسال و بستن پنجره توسط کاربران، اعلانی نمایش داده می‌شود.

linkPreview

LinkPreview

موجود در Google Docs، Google Sheets و Google Slides. پیش‌نمایش لینک‌ها با تراشه‌های هوشمند و کارت. برای جزئیات بیشتر، به پیش‌نمایش لینک‌ها با تراشه‌های هوشمند مراجعه کنید.

modifyOperations[]

ModifyCard

برای افزونه‌ها در گوگل چت ، یک کارت را بر اساس تعامل کاربر به‌روزرسانی می‌کند. آرایه فقط باید شامل یک شیء واحد باشد.

درخواست GoogleScopes

وقتی رضایت‌نامه‌ی oAuth بدون محدودیت فعال باشد، افزونه‌ی HTTP ممکن است نیاز به درخواست دامنه‌های بیشتری از Google oAuth داشته باشد. افزونه باید این شیء را برای رندر کردن کارت مجوز برگرداند. Manage granular permissions مراجعه کنید.

فیلدها
scopes[]

string

محدوده‌هایی که افزونه درخواست می‌کند.

allScopes

bool

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

ورودی انتخاب

ویجتی که یک یا چند آیتم رابط کاربری ایجاد می‌کند که کاربران می‌توانند آنها را انتخاب کنند. فقط از اعتبارسنجی ارسال فرم برای منوهای dropdown و multiselect پشتیبانی می‌کند. وقتی Action.all_widgets_are_required روی true تنظیم شده باشد یا این ویجت در Action.required_widgets مشخص شده باشد، عمل ارسال مسدود می‌شود مگر اینکه مقداری انتخاب شود. به عنوان مثال، یک منوی کشویی یا کادرهای انتخاب. می‌توانید از این ویجت برای جمع‌آوری داده‌هایی که قابل پیش‌بینی یا شمارش هستند استفاده کنید. برای مثال در برنامه‌های چت گوگل، به افزودن عناصر رابط کاربری قابل انتخاب مراجعه کنید.

برنامه‌های چت می‌توانند مقدار مواردی را که کاربران انتخاب یا وارد می‌کنند، پردازش کنند. برای جزئیات بیشتر در مورد کار با ورودی‌های فرم، به بخش «دریافت داده‌های فرم» مراجعه کنید.

برای جمع‌آوری داده‌های تعریف‌نشده یا انتزاعی از کاربران، از ویجت TextInput استفاده کنید.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

فیلدها
name

string

الزامی. نامی که ورودی انتخاب را در رویداد ورودی فرم مشخص می‌کند.

برای جزئیات بیشتر در مورد کار با ورودی‌های فرم، به بخش «دریافت داده‌های فرم» مراجعه کنید.

label

string

متنی که در بالای فیلد ورودی انتخاب در رابط کاربری ظاهر می‌شود.

متنی را مشخص کنید که به کاربر کمک کند اطلاعات مورد نیاز برنامه شما را وارد کند. برای مثال، اگر کاربران فوریت یک تیکت کاری را از منوی کشویی انتخاب می‌کنند، برچسب ممکن است «فوریت» یا «انتخاب فوریت» باشد.

type

SelectionType

نوع آیتم‌هایی که در ویجت SelectionInput به کاربران نمایش داده می‌شوند. انواع انتخاب از انواع مختلف تعاملات پشتیبانی می‌کنند. برای مثال، کاربران می‌توانند یک یا چند کادر انتخاب را انتخاب کنند، اما فقط می‌توانند یک مقدار را از منوی کشویی انتخاب کنند.

items[]

SelectionItem

آرایه‌ای از آیتم‌های قابل انتخاب. برای مثال، آرایه‌ای از دکمه‌های رادیویی یا چک‌باکس‌ها. تا ۱۰۰ آیتم را پشتیبانی می‌کند.

onChangeAction

Action

اگر مشخص شود، فرم با تغییر انتخاب ارسال می‌شود. اگر مشخص نشود، باید دکمه‌ی جداگانه‌ای برای ارسال فرم تعیین کنید.

برای جزئیات بیشتر در مورد کار با ورودی‌های فرم، به بخش «دریافت داده‌های فرم» مراجعه کنید.

multiSelectMinQueryLength

int32

برای منوهای چندگزینه‌ای، تعداد کاراکترهای متنی که کاربر قبل از نمایش گزینه‌های پیشنهادی منو وارد می‌کند.

اگر تنظیم نشده باشد، منوی چندگزینه‌ای از مقادیر پیش‌فرض زیر استفاده می‌کند:

  • اگر منو از یک آرایه استاتیک از آیتم‌های SelectionInput استفاده کند، به طور پیش‌فرض روی 0 کاراکتر تنظیم می‌شود و بلافاصله آیتم‌ها را از آرایه پر می‌کند.
  • اگر منو از یک منبع داده پویا ( multi_select_data_source ) استفاده کند، قبل از پرس و جو از منبع داده برای بازگرداندن موارد پیشنهادی، به طور پیش‌فرض ۳ کاراکتر خواهد بود.
dataSourceConfigs[]

DataSourceConfig

اختیاری. پیکربندی‌های منبع داده برای کنترل انتخاب. این فیلد کنترل دقیق‌تری بر منبع داده ارائه می‌دهد.

در صورت مشخص شدن، فیلدهای multi_select_max_selected_items ، multi_select_min_query_length ، external_data_source و platform_data_source نادیده گرفته می‌شوند.

برای افزونه‌های Google Workspace که Google Workspace Studio را گسترش می‌دهند، در دسترس است.

برای Dropdown widget در برنامه‌های چت گوگل موجود است. برای ویجت Dropdown در برنامه‌های چت گوگل، فقط از یک DataSourceConfig پشتیبانی می‌شود. اگر چندین DataSourceConfig تنظیم شده باشند، فقط از اولین مورد استفاده می‌شود.

multiSelectMaxSelectedItems

int32

برای منوهای چندگزینه‌ای، حداکثر تعداد آیتم‌هایی که کاربر می‌تواند انتخاب کند. حداقل مقدار ۱ آیتم است. اگر مشخص نشود، پیش‌فرض ۳ آیتم است.

hintText

string

اختیاری. متنی که در زیر فیلد ورودی انتخاب ظاهر می‌شود و برای کمک به کاربران با وادار کردن آنها به وارد کردن مقدار خاصی طراحی شده است. این متن همیشه قابل مشاهده است.

برای افزونه‌های Google Workspace که Google Workspace Studio را توسعه می‌دهند، در دسترس است. برای برنامه‌های Google Chat در دسترس نیست.

فیلد یونیونی multi_select_data_source . برای یک منوی چندگزینه‌ای، یک منبع داده که به صورت پویا آیتم‌های انتخاب را پر می‌کند.

برای برنامه‌های Google Chat در دسترس است و برای افزونه‌های Google Workspace در دسترس نیست. multi_select_data_source فقط می‌تواند یکی از موارد زیر باشد:

externalDataSource

Action

یک منبع داده خارجی، مانند یک پایگاه داده رابطه‌ای.

platformDataSource

PlatformDataSource

منبع داده از Google Workspace.

منبع داده پلتفرم

برای یک ویجت SelectionInput که از یک منوی چند انتخابی استفاده می‌کند، یک منبع داده از Google Workspace. برای پر کردن موارد در یک منوی چند انتخابی استفاده می‌شود.

برای برنامه‌های Google Chat در دسترس است و برای افزونه‌های Google Workspace در دسترس نیست.

فیلدها
فیلد یونیون data_source . منبع داده data_source فقط می‌تواند یکی از موارد زیر باشد:
commonDataSource

CommonDataSource

منبع داده‌ای که توسط همه برنامه‌های Google Workspace، مانند کاربران یک سازمان Google Workspace، به اشتراک گذاشته شده است.

hostAppDataSource

HostAppDataSourceMarkup

منبع داده‌ای که مختص برنامه میزبان Google Workspace است، مانند فضاهای موجود در Google Chat.

این فیلد از کتابخانه‌های کلاینت API گوگل پشتیبانی می‌کند اما در کتابخانه‌های کلاینت ابری موجود نیست. برای کسب اطلاعات بیشتر، به نصب کتابخانه‌های کلاینت مراجعه کنید.

منبع داده مشترک

منبع داده‌ای که توسط همه برنامه‌های Google Workspace به اشتراک گذاشته شده است.

برای برنامه‌های Google Chat در دسترس است و برای افزونه‌های Google Workspace در دسترس نیست.

انوم‌ها
UNKNOWN مقدار پیش‌فرض. استفاده نکنید.
USER کاربران Google Workspace. کاربر فقط می‌تواند کاربران سازمان Google Workspace خود را مشاهده و انتخاب کند.

مورد انتخابی

موردی که کاربران می‌توانند در یک ورودی انتخاب، مانند یک چک‌باکس یا سوئیچ، انتخاب کنند. تا ۱۰۰ مورد را پشتیبانی می‌کند.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

فیلدها
text

string

متنی که کالا را برای کاربران شناسایی یا توصیف می‌کند.

value

string

مقدار مرتبط با این آیتم. کلاینت باید از این به عنوان مقدار ورودی فرم استفاده کند.

برای جزئیات بیشتر در مورد کار با ورودی‌های فرم، به بخش «دریافت داده‌های فرم» مراجعه کنید.

selected

bool

آیا آیتم به طور پیش‌فرض انتخاب شده است یا خیر. اگر ورودی انتخاب فقط یک مقدار را می‌پذیرد (مانند دکمه‌های رادیویی یا منوی کشویی)، این فیلد را فقط برای یک آیتم تنظیم کنید.

bottomText

string

برای منوهای چندگزینه‌ای، یک توضیح متنی یا برچسب که در زیر فیلد text آیتم نمایش داده می‌شود.

فیلد یونیون startIcon . برای منوهای چندگزینه‌ای، آدرس اینترنتی (URL) آیکون در کنار فیلد text آیتم نمایش داده می‌شود. از فایل‌های PNG و JPEG پشتیبانی می‌کند. باید یک آدرس اینترنتی HTTPS باشد. برای مثال، https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png . startIcon فقط می‌تواند یکی از موارد زیر باشد:
startIconUri

string

نوع انتخاب

قالب مواردی که کاربران می‌توانند انتخاب کنند. گزینه‌های مختلف از انواع مختلف تعاملات پشتیبانی می‌کنند. به عنوان مثال، کاربران می‌توانند چندین کادر انتخاب را انتخاب کنند، اما فقط می‌توانند یک مورد را از منوی کشویی انتخاب کنند.

هر ورودی انتخاب از یک نوع انتخاب پشتیبانی می‌کند. برای مثال، ترکیب چک‌باکس‌ها و سوئیچ‌ها پشتیبانی نمی‌شود.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

انوم‌ها
CHECK_BOX مجموعه‌ای از چک‌باکس‌ها. کاربران می‌توانند یک یا چند چک‌باکس را انتخاب کنند.
RADIO_BUTTON مجموعه‌ای از دکمه‌های رادیویی. کاربران می‌توانند یک دکمه رادیویی را انتخاب کنند.
SWITCH مجموعه‌ای از سوئیچ‌ها. کاربران می‌توانند یک یا چند سوئیچ را فعال کنند.
DROPDOWN

یک منوی کشویی. کاربران می‌توانند یک مورد را از منو انتخاب کنند.

برای برنامه‌های Google Chat، می‌توانید موارد را با استفاده از یک منبع داده پویا پر کنید و همزمان با تایپ کاربران در منو، موارد را به صورت خودکار پیشنهاد دهید. به عنوان مثال، کاربران می‌توانند شروع به تایپ نام یک فضای Google Chat کنند و ویجت به صورت خودکار آن فضا را پیشنهاد می‌دهد. برای پر کردن پویای موارد برای یک منوی کشویی، از یکی از انواع منابع داده زیر استفاده کنید:

  • داده‌های Google Workspace: موارد با استفاده از داده‌های Google Workspace، مانند کاربران Google Workspace یا فضاهای Google Chat، پر می‌شوند.
  • داده‌های خارجی: موارد از یک منبع داده خارجی خارج از Google Workspace پر می‌شوند.

برای مثال‌هایی از نحوه پیاده‌سازی منوهای کشویی برای برنامه‌های چت، به «افزودن یک منوی کشویی» و «منوهای کشویی را به صورت پویا پر کنید» مراجعه کنید.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

MULTI_SELECT

منویی با یک کادر متن. کاربران می‌توانند یک یا چند مورد را تایپ و انتخاب کنند. برای افزونه‌های Google Workspace، باید موارد را با استفاده از یک آرایه استاتیک از اشیاء SelectionItem پر کنید.

برای برنامه‌های گوگل چت، می‌توانید موارد را با استفاده از یک منبع داده پویا پر کنید و همزمان با تایپ کاربران در منو، موارد را به صورت خودکار پیشنهاد دهید. به عنوان مثال، کاربران می‌توانند شروع به تایپ نام یک فضای گوگل چت کنند و ویجت به صورت خودکار آن فضا را پیشنهاد می‌دهد. برای پر کردن پویای موارد برای یک منوی چند انتخابی، از یکی از انواع منابع داده زیر استفاده کنید:

  • داده‌های Google Workspace: موارد با استفاده از داده‌های Google Workspace، مانند کاربران Google Workspace یا فضاهای Google Chat، پر می‌شوند.
  • داده‌های خارجی: موارد از یک منبع داده خارجی خارج از Google Workspace پر می‌شوند.

برای مثال‌هایی از نحوه پیاده‌سازی منوهای چندگزینه‌ای برای برنامه‌های چت، به افزودن یک منوی چندگزینه‌ای مراجعه کنید.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

ارسال فرم پاسخ

پاسخی به ارسال فرم به غیر از دریافت یک ظرف تکمیل خودکار، که شامل اقداماتی است که کارت باید انجام دهد و/یا برنامه میزبان افزونه باید انجام دهد، و اینکه آیا وضعیت کارت تغییر کرده است یا خیر.

برای افزونه‌های Google Workspace موجود است و برای برنامه‌های Google Chat موجود نیست. برای مثال:

{
  "renderActions": {
    "action": {
      "notification": {
        "text": "Email address is added: salam.heba@example.com"
      }
    },
    "hostAppAction": {
      "gmailAction": {
        "openCreatedDraftAction": {
          "draftId": "msg-a:r-79766936926021702",
          "threadServerPermId": "thread-f:15700999851086004"
        }
      }
    }
  }
}
فیلدها
renderActions

RenderActions

مجموعه‌ای از دستورالعمل‌های رندر که به کارت می‌گوید عملی را انجام دهد و/یا به برنامه میزبان افزونه می‌گوید عملی خاص برنامه را انجام دهد.

stateChanged

bool

اینکه آیا وضعیت کارت‌ها تغییر کرده است و داده‌های موجود در کارت‌های موجود قدیمی شده‌اند یا خیر.

schema

string

این یک فیلد طرحواره بدون عملیات است که ممکن است در نشانه‌گذاری برای بررسی نحو وجود داشته باشد.

پیشنهادات

مقادیر پیشنهادی که کاربران می‌توانند وارد کنند. این مقادیر زمانی ظاهر می‌شوند که کاربران درون فیلد ورودی متن کلیک کنند. همزمان با تایپ کاربران، مقادیر پیشنهادی به صورت پویا فیلتر می‌شوند تا با آنچه کاربران تایپ کرده‌اند مطابقت داشته باشند.

برای مثال، یک فیلد ورودی متن برای زبان برنامه‌نویسی ممکن است جاوا، جاوا اسکریپت، پایتون و ++C را پیشنهاد دهد. وقتی کاربران شروع به تایپ Jav می‌کنند، لیست پیشنهادات برای نمایش Java و JavaScript فیلتر می‌شود.

مقادیر پیشنهادی به کاربران کمک می‌کنند تا مقادیری را وارد کنند که برنامه شما بتواند آنها را درک کند. هنگام اشاره به جاوا اسکریپت، برخی از کاربران ممکن است javascript و برخی دیگر java script وارد کنند. پیشنهاد JavaScript می‌تواند نحوه تعامل کاربران با برنامه شما را استاندارد کند.

وقتی مشخص شود، TextInput.type همیشه SINGLE_LINE است، حتی اگر روی MULTIPLE_LINE تنظیم شده باشد.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

فیلدها
items[]

SuggestionItem

فهرستی از پیشنهادها که برای تکمیل خودکار توصیه‌ها در فیلدهای ورودی متن استفاده می‌شوند.

پیشنهاد

یک مقدار پیشنهادی که کاربران می‌توانند در فیلد ورودی متن وارد کنند.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

فیلدها

content فیلد اتحادیه.

content می‌تواند فقط یکی از موارد زیر باشد:

text

string

مقدار ورودی پیشنهادی برای یک فیلد ورودی متن. این معادل مقداری است که کاربران خودشان وارد می‌کنند.

ورودی متن

فیلدی که کاربران می‌توانند در آن متن وارد کنند. از پیشنهادها و اقدامات هنگام تغییر پشتیبانی می‌کند. از اعتبارسنجی ارسال فرم پشتیبانی می‌کند. وقتی Action.all_widgets_are_required روی true تنظیم شده باشد یا این ویجت در Action.required_widgets مشخص شده باشد، عملیات ارسال مسدود می‌شود مگر اینکه مقداری وارد شود. برای مثال در برنامه‌های چت گوگل، به افزودن فیلدی که کاربر بتواند در آن متن وارد کند ، مراجعه کنید.

برنامه‌های چت می‌توانند مقدار متن وارد شده را در طول رویدادهای ورودی فرم دریافت و پردازش کنند. برای جزئیات بیشتر در مورد کار با ورودی‌های فرم، به دریافت داده‌های فرم مراجعه کنید.

وقتی نیاز به جمع‌آوری داده‌های تعریف‌نشده یا انتزاعی از کاربران دارید، از ورودی متنی استفاده کنید. برای جمع‌آوری داده‌های تعریف‌شده یا شمارش‌شده از کاربران، از ویجت SelectionInput استفاده کنید.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

فیلدها
name

string

نامی که ورودی متن در رویداد ورودی فرم با آن مشخص می‌شود.

برای جزئیات بیشتر در مورد کار با ورودی‌های فرم، به بخش «دریافت داده‌های فرم» مراجعه کنید.

label

string

متنی که در بالای فیلد ورودی متن در رابط کاربری ظاهر می‌شود.

متنی را مشخص کنید که به کاربر کمک کند اطلاعات مورد نیاز برنامه شما را وارد کند. برای مثال، اگر نام کسی را می‌پرسید، اما به طور خاص به نام خانوادگی او نیاز دارید، به جای name ، surname بنویسید.

اگر hintText مشخص نشده باشد، الزامی است. در غیر این صورت، اختیاری است.

hintText

string

متنی که در زیر فیلد ورودی متن ظاهر می‌شود و برای کمک به کاربران با وادار کردن آنها به وارد کردن مقدار خاصی طراحی شده است. این متن همیشه قابل مشاهده است.

اگر label مشخص نشده باشد، الزامی است. در غیر این صورت، اختیاری است.

value

string

مقداری که توسط کاربر وارد شده و به عنوان بخشی از رویداد ورودی فرم برگردانده می‌شود.

برای جزئیات بیشتر در مورد کار با ورودی‌های فرم، به بخش «دریافت داده‌های فرم» مراجعه کنید.

type

Type

نحوه نمایش یک فیلد ورودی متن در رابط کاربری. به عنوان مثال، اینکه آیا فیلد تک خطی است یا چند خطی.

onChangeAction

Action

وقتی تغییری در فیلد ورودی متن رخ می‌دهد، چه باید کرد. مثلاً کاربری متنی را به فیلد اضافه می‌کند یا حذف می‌کند.

نمونه‌هایی از اقداماتی که باید انجام شود شامل اجرای یک تابع سفارشی یا باز کردن یک کادر محاوره‌ای در گوگل چت است.

initialSuggestions

Suggestions

مقادیر پیشنهادی که کاربران می‌توانند وارد کنند. این مقادیر زمانی ظاهر می‌شوند که کاربران درون فیلد ورودی متن کلیک کنند. همزمان با تایپ کاربران، مقادیر پیشنهادی به صورت پویا فیلتر می‌شوند تا با آنچه کاربران تایپ کرده‌اند مطابقت داشته باشند.

برای مثال، یک فیلد ورودی متن برای زبان برنامه‌نویسی ممکن است جاوا، جاوا اسکریپت، پایتون و ++C را پیشنهاد دهد. وقتی کاربران شروع به تایپ کردن Jav می‌کنند، لیست پیشنهادات فیلتر می‌شود تا فقط Java و JavaScript نشان دهد.

مقادیر پیشنهادی به کاربران کمک می‌کنند تا مقادیری را وارد کنند که برنامه شما بتواند آنها را درک کند. هنگام اشاره به جاوا اسکریپت، برخی از کاربران ممکن است javascript و برخی دیگر java script وارد کنند. پیشنهاد JavaScript می‌تواند نحوه تعامل کاربران با برنامه شما را استاندارد کند.

وقتی مشخص شود، TextInput.type همیشه SINGLE_LINE است، حتی اگر روی MULTIPLE_LINE تنظیم شده باشد.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

autoCompleteAction

Action

اختیاری. مشخص کنید وقتی فیلد ورودی متن به کاربرانی که با آن تعامل دارند پیشنهاد می‌دهد، چه اقدامی انجام شود.

اگر مشخص نشده باشد، پیشنهادات توسط initialSuggestions تنظیم شده و توسط کلاینت پردازش می‌شوند.

اگر مشخص شده باشد، برنامه عملی را که در اینجا مشخص شده است، مانند اجرای یک تابع سفارشی، انجام می‌دهد.

برای افزونه‌های Google Workspace در دسترس است و برای برنامه‌های Google Chat در دسترس نیست.

validation

Validation

اعتبارسنجی قالب ورودی لازم برای این فیلد متنی را مشخص کنید.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

placeholderText

string

متنی که در فیلد ورودی متن، زمانی که فیلد خالی است، نمایش داده می‌شود. از این متن برای ترغیب کاربران به وارد کردن مقدار استفاده کنید. برای مثال، Enter a number from 0 to 100 .

برای برنامه‌های Google Chat در دسترس است و برای افزونه‌های Google Workspace در دسترس نیست.

فیلد متحد data_source .

data_source فقط می‌تواند یکی از موارد زیر باشد:

hostAppDataSource

HostAppDataSourceMarkup

منبع داده‌ای که مختص برنامه میزبان Google Workspace است، مانند ایمیل‌های Gmail، رویدادهای Google Calendar یا پیام‌های Google Chat.

برای افزونه‌های Google Workspace که Google Workspace Studio را توسعه می‌دهند، در دسترس است. برای برنامه‌های Google Chat در دسترس نیست.

نوع

نحوه نمایش یک فیلد ورودی متن در رابط کاربری. برای مثال، آیا یک فیلد ورودی تک خطی است یا یک ورودی چند خطی. اگر initialSuggestions مشخص شده باشد، type همیشه SINGLE_LINE است، حتی اگر روی MULTIPLE_LINE تنظیم شده باشد.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

انوم‌ها
SINGLE_LINE فیلد ورودی متن دارای ارتفاع ثابت یک خط است.
MULTIPLE_LINE فیلد ورودی متن دارای ارتفاع ثابتی معادل چندین خط است.

متنپاراگراف

یک پاراگراف از متن که از قالب‌بندی پشتیبانی می‌کند. برای مثال در برنامه‌های Google Chat، به افزودن یک پاراگراف از متن قالب‌بندی‌شده مراجعه کنید. برای اطلاعات بیشتر در مورد قالب‌بندی متن، به قالب‌بندی متن در برنامه‌های Google Chat و افزونه‌های قالب‌بندی متن در Google Workspace مراجعه کنید.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

فیلدها
text

string

متنی که در ابزارک نمایش داده می‌شود.

maxLines

int32

حداکثر تعداد خطوط متنی که در ویجت نمایش داده می‌شود. اگر متن از حداکثر تعداد خطوط مشخص شده بیشتر باشد، محتوای اضافی پشت دکمه نمایش بیشتر پنهان می‌شود. اگر متن برابر یا کوتاه‌تر از حداکثر تعداد خطوط مشخص شده باشد، دکمه نمایش بیشتر نمایش داده نمی‌شود.

مقدار پیش‌فرض ۰ است، در این صورت تمام متن نمایش داده می‌شود. مقادیر منفی نادیده گرفته می‌شوند.

textSyntax

TextSyntax

نحو متن. اگر تنظیم نشود، متن به صورت HTML نمایش داده می‌شود.

برای برنامه‌های Google Chat در دسترس است و برای افزونه‌های Google Workspace در دسترس نیست.

نحو متن

سینتکسی که برای قالب‌بندی متن استفاده می‌شود.

برای برنامه‌های Google Chat در دسترس است و برای افزونه‌های Google Workspace در دسترس نیست.

انوم‌ها
TEXT_SYNTAX_UNSPECIFIED اگر متن مشخص نشده باشد، به صورت HTML نمایش داده می‌شود.
HTML متن به صورت HTML رندر می‌شود. این مقدار پیش‌فرض است.
MARKDOWN متن به صورت Markdown رندر می‌شود.

ماشه

نشان دهنده یک تریگر است.

برای افزونه‌های Google Workspace که Google Workspace Studio را توسعه می‌دهند، در دسترس است. برای برنامه‌های Google Chat در دسترس نیست.

فیلدها
actionRuleId

string

شناسه منحصر به فرد ActionRule.

اعتبارسنجی

داده‌های لازم برای اعتبارسنجی ویجتی که به آن متصل شده است را نشان می‌دهد.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

فیلدها
characterLimit

int32

محدودیت کاراکتر برای ویجت‌های ورودی متن را مشخص کنید. توجه داشته باشید که این فقط برای ورودی متن استفاده می‌شود و برای سایر ویجت‌ها نادیده گرفته می‌شود.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

inputType

InputType

نوع ویجت‌های ورودی را مشخص کنید.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

نوع ورودی

نوع ویجت ورودی.

انوم‌ها
INPUT_TYPE_UNSPECIFIED نوع نامشخص. استفاده نکنید.
TEXT متن معمولی که همه کاراکترها را می‌پذیرد.
INTEGER یک مقدار عدد صحیح.
FLOAT یک مقدار اعشاری (float).
EMAIL یک آدرس ایمیل.
EMOJI_PICKER یک ایموجی انتخاب شده از انتخابگر ایموجی ارائه شده توسط سیستم.

ویجت

هر کارت از ویجت‌هایی تشکیل شده است.

یک ویجت یک شیء مرکب است که می‌تواند یکی از انواع متن، تصویر، دکمه و سایر اشیاء را نمایش دهد.

فیلدها
horizontalAlignment

HorizontalAlignment

مشخص می‌کند که آیا ویجت‌ها در سمت چپ، راست یا مرکز یک ستون ترازبندی شوند.

id

string

یک شناسه منحصر به فرد که به ویجت اختصاص داده شده و برای شناسایی ویجتی که قرار است تغییر کند، استفاده می‌شود. این شناسه محدودیت کاراکتری ۶۴ کاراکتر دارد و باید به شکل [a-zA-Z0-9-]+ باشد.

برای افزونه‌های Google Workspace که Google Workspace Studio را توسعه می‌دهند، در دسترس است. برای برنامه‌های Google Chat در دسترس نیست.

visibility

Visibility

مشخص می‌کند که آیا ویجت قابل مشاهده یا پنهان باشد. مقدار پیش‌فرض VISIBLE است.

برای افزونه‌های Google Workspace که Google Workspace Studio را توسعه می‌دهند، در دسترس است. برای برنامه‌های Google Chat در دسترس نیست.

eventActions[]

EventAction

اقدامات رویدادی را که می‌توانند روی ویجت انجام شوند، مشخص می‌کند.

برای افزونه‌های Google Workspace که Google Workspace Studio را توسعه می‌دهند، در دسترس است. برای برنامه‌های Google Chat در دسترس نیست.

data فیلد Union. یک ویجت فقط می‌تواند یکی از موارد زیر را داشته باشد. می‌توانید از چندین فیلد ویجت برای نمایش موارد بیشتر استفاده کنید. data فقط می‌توانند یکی از موارد زیر باشند:
textParagraph

TextParagraph

یک پاراگراف متنی را نمایش می‌دهد. از متن ساده با قالب‌بندی HTML پشتیبانی می‌کند. برای اطلاعات بیشتر در مورد قالب‌بندی متن، به افزونه‌های قالب‌بندی متن در برنامه‌های چت گوگل و قالب‌بندی متن در افزونه‌های فضای کاری گوگل مراجعه کنید.

برای مثال، JSON زیر یک متن پررنگ ایجاد می‌کند:

"textParagraph": {
  "text": "  <b>bold text</b>"
}
image

Image

یک تصویر را نمایش می‌دهد.

برای مثال، JSON زیر تصویری با متن جایگزین ایجاد می‌کند:

"image": {
  "imageUrl":
  "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
  "altText": "Chat app avatar"
}
decoratedText

DecoratedText

یک آیتم متنی تزئین‌شده را نمایش می‌دهد.

برای مثال، JSON زیر یک ویجت متنی تزئین‌شده ایجاد می‌کند که آدرس ایمیل را نشان می‌دهد:

"decoratedText": {
  "icon": {
    "knownIcon": "EMAIL"
  },
  "topLabel": "Email Address",
  "text": "sasha@example.com",
  "bottomLabel": "This is a new Email address!",
  "switchControl": {
    "name": "has_send_welcome_email_to_sasha",
    "selected": false,
    "controlType": "CHECKBOX"
  }
}
buttonList

ButtonList

فهرستی از دکمه‌ها.

برای مثال، JSON زیر دو دکمه ایجاد می‌کند. اولی یک دکمه متنی آبی رنگ و دومی یک دکمه تصویری است که یک لینک را باز می‌کند:

"buttonList": {
  "buttons": [
    {
      "text": "Edit",
      "color": {
        "red": 0,
        "green": 0,
        "blue": 1,
      },
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}
textInput

TextInput

یک کادر متنی نمایش می‌دهد که کاربران می‌توانند در آن تایپ کنند.

برای مثال، JSON زیر یک ورودی متنی برای آدرس ایمیل ایجاد می‌کند:

"textInput": {
  "name": "mailing_address",
  "label": "Mailing Address"
}

به عنوان مثالی دیگر، JSON زیر یک ورودی متنی برای یک زبان برنامه‌نویسی با پیشنهادهای ایستا ایجاد می‌کند:

"textInput": {
  "name": "preferred_programing_language",
  "label": "Preferred Language",
  "initialSuggestions": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}
selectionInput

SelectionInput

یک کنترل انتخاب را نمایش می‌دهد که به کاربران امکان انتخاب موارد را می‌دهد. کنترل‌های انتخاب می‌توانند کادرهای انتخاب، دکمه‌های رادیویی، سوئیچ‌ها یا منوهای کشویی باشند.

برای مثال، JSON زیر یک منوی کشویی ایجاد می‌کند که به کاربران اجازه می‌دهد اندازه را انتخاب کنند:

"selectionInput": {
  "name": "size",
  "label": "Size"
  "type": "DROPDOWN",
  "items": [
    {
      "text": "S",
      "value": "small",
      "selected": false
    },
    {
      "text": "M",
      "value": "medium",
      "selected": true
    },
    {
      "text": "L",
      "value": "large",
      "selected": false
    },
    {
      "text": "XL",
      "value": "extra_large",
      "selected": false
    }
  ]
}
dateTimePicker

DateTimePicker

ویجتی را نمایش می‌دهد که به کاربران امکان می‌دهد تاریخ، زمان یا تاریخ و زمان را وارد کنند.

برای مثال، JSON زیر یک انتخابگر تاریخ و زمان برای تعیین وقت ملاقات ایجاد می‌کند:

"dateTimePicker": {
  "name": "appointment_time",
  "label": "Book your appointment at:",
  "type": "DATE_AND_TIME",
  "valueMsEpoch": 796435200000
}
divider

Divider

یک جداکننده خط افقی بین ابزارک‌ها نمایش می‌دهد.

برای مثال، JSON زیر یک جداکننده ایجاد می‌کند:

"divider": {
}
grid

Grid

یک شبکه با مجموعه‌ای از آیتم‌ها را نمایش می‌دهد.

یک شبکه می‌تواند هر تعداد ستون و آیتم را پشتیبانی کند. تعداد ردیف‌ها با تقسیم کران بالای تعداد آیتم‌ها بر تعداد ستون‌ها تعیین می‌شود. یک شبکه با ۱۰ آیتم و ۲ ستون، ۵ ردیف دارد. یک شبکه با ۱۱ آیتم و ۲ ستون، ۶ ردیف دارد.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

برای مثال، JSON زیر یک جدول دو ستونی با یک آیتم ایجاد می‌کند:

"grid": {
  "title": "A fine collection of items",
  "columnCount": 2,
  "borderStyle": {
    "type": "STROKE",
    "cornerRadius": 4
  },
  "items": [
    {
      "image": {
        "imageUri": "https://www.example.com/image.png",
        "cropStyle": {
          "type": "SQUARE"
        },
        "borderStyle": {
          "type": "STROKE"
        }
      },
      "title": "An item",
      "textAlignment": "CENTER"
    }
  ],
  "onClick": {
    "openLink": {
      "url": "https://www.example.com"
    }
  }
}
columns

Columns

حداکثر ۲ ستون را نمایش می‌دهد.

برای اضافه کردن بیش از ۲ ستون یا استفاده از ردیف‌ها، از ویجت Grid استفاده کنید.

برای مثال، JSON زیر دو ستون ایجاد می‌کند که هر کدام شامل پاراگراف‌های متنی هستند:

"columns": {
  "columnItems": [
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "First column text paragraph"
          }
        }
      ]
    },
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "Second column text paragraph"
          }
        }
      ]
    }
  ]
}
carousel

Carousel

یک carousel شامل مجموعه‌ای از ویجت‌های تو در تو است. برای مثال، این یک نمایش JSON از یک carousel است که شامل دو پاراگراف متنی است.

{
  "widgets": [
    {
      "textParagraph": {
        "text": "First text paragraph in the carousel."
      }
    },
    {
      "textParagraph": {
        "text": "Second text paragraph in the carousel."
      }
    }
  ]
}
chipList

ChipList

فهرستی از چیپس‌ها

For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link:

"chipList": {
  "chips": [
    {
      "text": "Edit",
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}

HorizontalAlignment

مشخص می‌کند که آیا ویجت‌ها در سمت چپ، راست یا مرکز یک ستون ترازبندی شوند.

برای برنامه‌های Google Chat در دسترس است و برای افزونه‌های Google Workspace در دسترس نیست.

انوم‌ها
HORIZONTAL_ALIGNMENT_UNSPECIFIED استفاده نکنید. نامشخص.
START Default value. Aligns widgets to the start position of the column. For left-to-right layouts, aligns to the left. For right-to-left layouts, aligns to the right.
CENTER Aligns widgets to the center of the column.
END Aligns widgets to the end position of the column. For left-to-right layouts, aligns widgets to the right. For right-to-left layouts, aligns widgets to the left.

ImageType

شکلی که برای برش تصویر استفاده می‌شود.

برای برنامه‌های Google Chat و افزونه‌های Google Workspace موجود است.

انوم‌ها
SQUARE Default value. Applies a square mask to the image. For example, a 4x3 image becomes 3x3.
CIRCLE Applies a circular mask to the image. For example, a 4x3 image becomes a circle with a diameter of 3.

ترازبندی عمودی

Represents vertical alignment attribute.

انوم‌ها
VERTICAL_ALIGNMENT_UNSPECIFIED Unspecified type. Do not use.
TOP Alignment to the top position.
MIDDLE Alignment to the middle position.
BOTTOM Alignment to the bottom position.