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

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

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

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

allWidgetsAreRequired

bool

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

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

ActionParameter

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

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

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

فیلدها
key

string

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

value

string

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

تعامل

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

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

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

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

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

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

Enums
INTERACTION_UNSPECIFIED مقدار پیش فرض action به طور معمول اجرا می شود.
OPEN_DIALOG

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

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

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

LoadIndicator

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

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

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

BorderStyle

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

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

فیلدها
type

BorderType

نوع حاشیه.

strokeColor

Color

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

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

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

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

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

cornerRadius

int32

شعاع گوشه برای مرز.

نوع مرزی

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

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

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

دکمه

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

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

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

فیلدها
text

string

متن نمایش داده شده در داخل دکمه

icon

Icon

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

color

Color

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

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

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

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

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

onClick

OnClick

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

disabled

bool

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

altText

string

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

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

type

Type

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

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

تایپ کنید

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

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

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

ButtonList

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

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

فیلدها
buttons[]

Button

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

کارت

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

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

طراحی و پیش نمایش کارت ها با Card Builder.

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

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

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

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

برای ایجاد پیام کارت نمونه در 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

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

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 باعث ایجاد خطا می شود. برای برنامه‌های گپ، می‌توانید از فوترهای ثابت در گفتگوها استفاده کنید، اما از پیام‌های کارت استفاده نکنید.

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

displayStyle

DisplayStyle

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

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

peekCardHeader

CardHeader

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

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

CardAction

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

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

فیلدها
actionLabel

string

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

onClick

OnClick

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

CardFixedFooter

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

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

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

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

فیلدها
primaryButton

Button

دکمه اصلی فوتر ثابت. دکمه باید یک دکمه متنی با متن و مجموعه رنگ باشد.

secondaryButton

Button

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

سربرگ کارت

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

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

فیلدها
title

string

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

subtitle

string

زیرنویس هدر کارت. در صورت مشخص شدن، در خط خودش زیر title ظاهر می شود.

imageType

ImageType

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

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

imageUrl

string

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

imageAltText

string

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

DisplayStyle

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

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

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

DividerStyle

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

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

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

بخش

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

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

فیلدها
header

string

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

widgets[]

Widget

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

collapsible

bool

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

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

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

uncollapsibleWidgetsCount

int32

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

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

collapseControl

CollapseControl

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

تراشه

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

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

ChipList

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

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

فیلدها
layout

Layout

چیدمان لیست تراشه مشخص شده

chips[]

Chip

مجموعه ای از تراشه ها.

طرح بندی

چیدمان لیست تراشه ها

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

CollapseControl

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

فیلدها
horizontalAlignment

HorizontalAlignment

تراز افقی دکمه گسترش و جمع کردن.

expandButton

Button

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

collapseButton

Button

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

ستون ها

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

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

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

  • در وب، اگر عرض صفحه کمتر یا مساوی 480 پیکسل باشد، ستون دوم بسته می شود.
  • در دستگاه‌های iOS، اگر عرض صفحه کمتر یا مساوی 300 pt باشد، ستون دوم بسته می‌شود.
  • در دستگاه‌های Android، اگر عرض صفحه کمتر یا مساوی 320 dp باشد، ستون دوم بسته می‌شود.

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

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

  • هنگامی که کاربران افزونه را از پیش نویس ایمیل باز می کنند، گفتگو نمایش داده می شود.
  • هنگامی که کاربران افزونه را از منوی افزودن پیوست در یک رویداد Google Calendar باز می‌کنند، گفتگو نمایش داده می‌شود.
فیلدها
columnItems[]

Column

آرایه ای از ستون ها. می توانید حداکثر 2 ستون را در یک کارت یا گفتگو قرار دهید.

ستون

یک ستون

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

فیلدها
horizontalSizeStyle

HorizontalSizeStyle

نحوه پر کردن عرض کارت توسط یک ستون را مشخص می کند.

horizontalAlignment

HorizontalAlignment

تعیین می کند که آیا ویجت ها در سمت چپ، راست یا مرکز یک ستون تراز شوند.

verticalAlignment

VerticalAlignment

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

widgets[]

Widgets

آرایه ای از ویجت های موجود در یک ستون. ویجت ها به ترتیبی که مشخص شده اند ظاهر می شوند.

HorizontalSizeStyle

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

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

Enums
HORIZONTAL_SIZE_STYLE_UNSPECIFIED استفاده نکنید. نامشخص
FILL_AVAILABLE_SPACE مقدار پیش فرض ستون فضای موجود را پر می کند، تا 70٪ از عرض کارت. اگر هر دو ستون روی FILL_AVAILABLE_SPACE تنظیم شده باشند، هر ستون 50٪ از فضا را پر می کند.
FILL_MINIMUM_SPACE ستون کمترین فضای ممکن را پر می کند و بیش از 30 درصد عرض کارت را ندارد.

تراز عمودی

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

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

Enums
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 Chat در دسترس است و برای افزونه‌های Google Workspace در دسترس نیست.

DateTimePicker

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

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

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

فیلدها
name

string

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

برای جزئیات کار با ورودی های فرم، به دریافت داده های فرم مراجعه کنید.

label

string

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

type

DateTimePickerType

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

valueMsEpoch

int64

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

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

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

int32

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

onChangeAction

Action

هنگامی که کاربر روی Save یا Clear از رابط DateTimePicker کلیک می کند، فعال می شود.

validation

Validation

اختیاری. اعتبار مورد نیاز برای این انتخابگر تاریخ تایمر را مشخص کنید.

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

DateTimePickerType

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

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

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

متن تزئین شده

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

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

فیلدها
icon
(deprecated)

Icon

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

startIcon

Icon

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

topLabel

string

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

text

string

مورد نیاز. متن اولیه

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

wrapText

bool

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

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

bottomLabel

string

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

onClick

OnClick

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

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

Button

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

switchControl

SwitchControl

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

endIcon

Icon

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

پشتیبانی از آیکون های داخلی و سفارشی

SwitchControl

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

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

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

فیلدها
name

string

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

برای جزئیات کار با ورودی های فرم، به دریافت داده های فرم مراجعه کنید.

value

string

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

برای جزئیات کار با ورودی های فرم، به دریافت داده های فرم مراجعه کنید.

selected

bool

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

onChangeAction

Action

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

controlType

ControlType

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

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

نوع کنترل

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

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

Enums
SWITCH یک سوئیچ به سبک ضامن.
CHECKBOX به نفع CHECK_BOX منسوخ شد.
CHECK_BOX یک چک باکس.

تقسیم کننده

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

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

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

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

"divider": {}

EndNavigation

عمل جریان گفتگو.

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

فیلدها
action

Action

عمل رندر برای مشتری برای پایان دادن به یک جریان گفتگو.

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

اقدام

انواع عملکرد رندر برای سرویس گیرنده برای پایان دادن به یک جریان گفتگو.

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

Enums
ACTION_UNSPECIFIED اقدام نامشخص
CLOSE_DIALOG جریان گفتگو را ببندید.
CLOSE_DIALOG_AND_EXECUTE جریان گفتگو را ببندید و کارتی را که جریان گفتگو را باز کرده است، بازخوانی کنید.

GetAutocompletionResponse

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

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

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

Suggestions

schema

string

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

شبکه

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

یک شبکه از هر تعداد ستون و آیتم پشتیبانی می کند. تعداد سطرها بر اساس موارد تقسیم بر ستون تعیین می شود. یک شبکه با 10 مورد و 2 ستون دارای 5 ردیف است. یک شبکه با 11 مورد و 2 ستون دارای 6 ردیف است.

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

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

"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

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

GridItem

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

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

فیلدها
id

string

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

image

ImageComponent

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

title

string

عنوان آیتم گرید.

subtitle

string

زیرنویس مورد گرید.

layout

GridItemLayout

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

GridItemLayout

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

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

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

نماد

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

پشتیبانی از آیکون های داخلی و سفارشی

برای برنامه‌های 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 فیلد اتحادیه نماد نمایش داده شده در ویجت روی کارت. 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

یکی از نمادهای Google Material را نمایش دهید.

به عنوان مثال، برای نمایش نماد چک باکس ، استفاده کنید

"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

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

ImageComponent

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

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

فیلدها
imageUri

string

آدرس تصویر.

altText

string

برچسب دسترسی برای تصویر.

cropStyle

ImageCropStyle

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

borderStyle

BorderStyle

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

ImageCropStyle

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

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

برای مثال، در اینجا نحوه اعمال نسبت تصویر 16:9 آمده است:

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

ImageCropType

نوع محصول

aspectRatio

double

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

برای مثال، در اینجا نحوه اعمال نسبت تصویر 16:9 آمده است:

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

ImageCropType

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

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

Enums
IMAGE_CROP_TYPE_UNSPECIFIED استفاده نکنید. نامشخص
SQUARE مقدار پیش فرض برش مربع را اعمال می کند.
CIRCLE برش دایره ای را اعمال می کند.
RECTANGLE_CUSTOM یک برش مستطیلی با نسبت ابعاد سفارشی اعمال می کند. نسبت ابعاد سفارشی را با aspectRatio تنظیم کنید.
RECTANGLE_4_3 یک برش مستطیلی با نسبت تصویر 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

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

linkPreviewTitle

string

عنوانی که در پیش نمایش پیوند نمایش داده می شود. اگر تنظیم نشود، پیش‌نمایش پیوند سرصفحه preview_card را نشان می‌دهد.

MaterialIcon

یک نماد Google Material ، که شامل بیش از 2500 گزینه است.

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

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

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

فیلدها
name

string

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

fill

bool

آیا نماد به عنوان پر شده است. مقدار پیش فرض نادرست است.

برای پیش نمایش تنظیمات مختلف نماد ، به نمادهای Google Font بروید و تنظیمات را تحت Customize تنظیم کنید.

weight

int32

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

برای پیش نمایش تنظیمات مختلف نماد ، به نمادهای Google Font بروید و تنظیمات را تحت Customize تنظیم کنید.

grade

int32

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

برای پیش نمایش تنظیمات مختلف نماد ، به نمادهای Google Font بروید و تنظیمات را تحت Customize تنظیم کنید.

اقدام کارت که پشته کارت را دستکاری می کند.

به عنوان مثال:

1) یک کارت جدید به پشته اضافه کنید (به جلو حرکت کنید). برای برنامه های چت ، فقط برای برنامه برنامه در دسترس است.

برای برنامه های Google CHAT و افزودنی های فضای کاری Google در دسترس است.

 navigations : {
    pushCard : CARD
  }

2) کارت را در بالای پشته به روز کنید (به روزرسانی در مکان).

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

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

3) بدون به روزرسانی یک قدم به عقب برگردید.

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

  navigations : {
    popCard : true,
  }

4) چندین مرحله را برگردانید و آن کارت را به روز کنید.

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

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

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

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

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

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

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

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

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

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

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

8) کارت بالا را با کارت جدید جایگزین کنید. برای برنامه های چت ، فقط برای برنامه برنامه در دسترس است.

برای برنامه های Google CHAT و افزودنی های فضای کاری Google در دسترس است.

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

Union Field navigate_action .

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

popToRoot

bool

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

pop

bool

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

popToCard

string

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

pushCard

Card

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

updateCard

Card

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

endNavigation

EndNavigation

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

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

اطلاع رسانی

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

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

فیلدها
text

string

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

OnClick

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

برای برنامه های Google CHAT و افزودنی های فضای کاری Google در دسترس است.

فیلدها

data میدانی اتحادیه.

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

action

Action

در صورت مشخص شدن ، یک عمل توسط این onClick انجام می شود.

openDynamicLinkAction

Action

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

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

card

Card

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

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

overflowMenu

OverflowMenu

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

OnClose

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

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

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

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

Enums
NOTHING مقدار پیش فرض کارت بارگیری مجدد نمی شود. هیچ اتفاقی نمی افتد
RELOAD

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

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

عید

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

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

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

سرریز

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

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

فیلدها
items[]

OverflowMenuItem

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

سرریز

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

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

فیلدها
startIcon

Icon

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

text

string

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

onClick

OnClick

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

disabled

bool

آیا گزینه منو غیرفعال است. پیش فرض به غلط.

عمل

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

برای برنامه های Google CHAT و افزودنی های فضای کاری Google در دسترس است.

فیلدها
action

Action

hostAppAction

HostAppActionMarkup

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

schema

string

این یک زمینه طرحواره ای NO-OP است که ممکن است در نشانه گذاری برای بررسی نحو وجود داشته باشد.

اقدام

فیلدها
navigations[]

Navigation

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

notification

Notification

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

linkPreview

LinkPreview

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

انتخاب

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

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

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

برای برنامه های Google CHAT و افزودنی های فضای کاری Google در دسترس است.

فیلدها
name

string

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

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

label

string

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

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

type

SelectionType

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

items[]

SelectionItem

مجموعه ای از موارد قابل انتخاب. به عنوان مثال ، مجموعه ای از دکمه های رادیویی یا کادر انتخاب. حداکثر 100 مورد را پشتیبانی می کند.

onChangeAction

Action

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

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

multiSelectMaxSelectedItems

int32

برای منوهای چند منتخب ، حداکثر تعداد مواردی که کاربر می تواند انتخاب کند. حداقل مقدار 1 مورد است. اگر نامشخص باشد ، به 3 مورد پیش فرض کنید.

multiSelectMinQueryLength

int32

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

در صورت نامشخص ، برای منابع داده استاتیک و 3 کاراکتر برای منابع داده خارجی به 0 کاراکتر پیش فرض می شود.

validation

Validation

برای منوهای کشویی ، اعتبار این قسمت ورودی انتخاب.

برای برنامه های Google CHAT و افزودنی های فضای کاری Google در دسترس است.

Union Field multi_select_data_source . برای یک منوی چند منتخب ، منبع داده ای که موارد انتخاب را جمع می کند.

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

externalDataSource

Action

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

platformDataSource

PlatformDataSource

یک منبع داده از فضای کاری Google.

PlatformDatasource

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

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

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

CommonDataSource

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

hostAppDataSource

HostAppDataSourceMarkup

منبع داده ای که منحصر به یک برنامه میزبان فضای کاری Google است ، چنین فضاهایی در Google Chat.

این زمینه از کتابخانه های مشتری Google API پشتیبانی می کند اما در کتابخانه های مشتری Cloud در دسترس نیست. برای کسب اطلاعات بیشتر ، به نصب کتابخانه های مشتری مراجعه کنید.

محرمانه

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

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

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

انتخاب

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

برای برنامه های Google CHAT و افزودنی های فضای کاری Google در دسترس است.

فیلدها
text

string

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

value

string

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

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

selected

bool

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

startIconUri

string

برای منوهای چند منتخب ، URL برای نماد نمایش داده شده در کنار قسمت text مورد. از پرونده های PNG و JPEG پشتیبانی می کند. باید یک URL HTTPS باشد. به عنوان مثال ، https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png .

bottomText

string

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

نوع انتخاب

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

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

برای برنامه های Google CHAT و افزودنی های فضای کاری Google در دسترس است.

Enums
CHECK_BOX مجموعه ای از کادر چک. کاربران می توانند یک یا چند کادر انتخاب را انتخاب کنند.
RADIO_BUTTON مجموعه ای از دکمه های رادیویی. کاربران می توانند یک دکمه رادیویی را انتخاب کنند.
SWITCH مجموعه ای از سوئیچ ها. کاربران می توانند یک یا چند سوئیچ را روشن کنند.
DROPDOWN منوی کشویی. کاربران می توانند یک مورد را از منو انتخاب کنند.
MULTI_SELECT

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

برای جمع آوری موارد برای یک منوی چند منتخب ، می توانید از یکی از انواع زیر منابع داده استفاده کنید:

  • داده های استاتیک: موارد به عنوان اشیاء SelectionItem در ویجت مشخص می شوند. حداکثر 100 مورد
  • Google WorksPace Data: موارد با استفاده از داده های فضای کاری Google ، مانند کاربران Google Workspace یا فضای Google Chat ، جمع می شوند.
  • داده های خارجی: موارد از یک منبع داده خارجی در خارج از فضای کاری Google جمع می شوند.

برای نمونه هایی از نحوه اجرای منوهای چند منتخب ، به یک منوی چند منتخب اضافه کنید .

برای برنامه های Google CHAT و افزودنی های فضای کاری Google در دسترس است.

زیر نظر

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

در دسترس برای افزودنی های فضای کاری Google و برای برنامه های 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 ، برخی از کاربران ممکن است وارد javascript java script و برخی دیگر شوند. پیشنهاد JavaScript می تواند نحوه تعامل کاربران با برنامه شما را استاندارد کند.

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

برای برنامه های Google CHAT و افزودنی های فضای کاری Google در دسترس است.

فیلدها
items[]

SuggestionItem

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

پیشنهاد

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

برای برنامه های Google CHAT و افزودنی های فضای کاری Google در دسترس است.

فیلدها

content میدان اتحادیه.

content می تواند تنها یکی از موارد زیر باشد:

text

string

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

دارایی

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

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

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

برای برنامه های Google CHAT و افزودنی های فضای کاری Google در دسترس است.

فیلدها
name

string

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

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

label

string

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

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

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

hintText

string

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

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

value

string

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

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

type

Type

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

onChangeAction

Action

وقتی تغییر در قسمت ورودی متن رخ می دهد چه کاری باید انجام شود. به عنوان مثال ، کاربر اضافه شده به قسمت یا حذف متن.

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

initialSuggestions

Suggestions

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

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

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

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

برای برنامه های Google CHAT و افزودنی های فضای کاری Google در دسترس است.

autoCompleteAction

Action

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

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

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

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

validation

Validation

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

برای برنامه های Google CHAT و افزودنی های فضای کاری Google در دسترس است.

placeholderText

string

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

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

تایپ کنید

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

برای برنامه های Google CHAT و افزودنی های فضای کاری Google در دسترس است.

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

تانگراگراف

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

برای برنامه های Google CHAT و افزودنی های فضای کاری Google در دسترس است.

فیلدها
text

string

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

maxLines

int32

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

مقدار پیش فرض 0 است ، که در این حالت تمام زمینه نمایش داده می شود. مقادیر منفی نادیده گرفته می شوند. برای برنامه‌های Google Chat در دسترس است و برای افزونه‌های Google Workspace در دسترس نیست.

اعتبار سنجی

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

برای برنامه های Google CHAT و افزودنی های فضای کاری Google در دسترس است.

فیلدها
characterLimit

int32

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

برای برنامه های Google CHAT و افزودنی های فضای کاری Google در دسترس است.

inputType

InputType

نوع ابزارک های ورودی را مشخص کنید.

برای برنامه های Google CHAT و افزودنی های فضای کاری Google در دسترس است.

نوع ورودی

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

Enums
INPUT_TYPE_UNSPECIFIED نوع نامشخص استفاده نکنید.
TEXT متن منظم که همه شخصیت ها را می پذیرد.
INTEGER یک مقدار عدد صحیح
FLOAT یک مقدار شناور
EMAIL یک آدرس ایمیل
EMOJI_PICKER ایموجی انتخاب شده از انتخاب کننده ایموجی با سیستم.

ویجت

هر کارت از ابزارک تشکیل شده است.

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

فیلدها
horizontalAlignment

HorizontalAlignment

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

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

TextParagraph

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

به عنوان مثال ، 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

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

یک شبکه از هر تعداد ستون و موارد پشتیبانی می کند. تعداد ردیف ها توسط مرزهای بالایی از موارد شماره تقسیم بر تعداد ستون ها تعیین می شود. یک شبکه با 10 مورد و 2 ستون دارای 5 ردیف است. یک شبکه با 11 مورد و 2 ستون دارای 6 ردیف است.

برای برنامه های Google CHAT و افزودنی های فضای کاری Google در دسترس است.

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

"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

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

برای شامل بیش از 2 ستون یا استفاده از ردیف ها ، از ویجت Grid استفاده کنید.

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

"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"
          }
        }
      ]
    }
  ]
}
chipList

ChipList

لیستی از تراشه ها.

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

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

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

افقی

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

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

Enums
HORIZONTAL_ALIGNMENT_UNSPECIFIED استفاده نکنید. نامشخص
START مقدار پیش فرض ابزارک ها را به موقعیت شروع ستون تراز می کند. برای چیدمان های چپ به راست ، تراز در سمت چپ. برای چیدمان های راست به چپ ، به سمت راست تراز کنید.
CENTER ابزارک ها را به مرکز ستون تراز می کند.
END ابزارک ها را به موقعیت انتهایی ستون تراز می کند. برای طرح های چپ به راست ، ابزارک ها را به سمت راست تراز می کند. برای طرح های راست به چپ ، ابزارک های سمت چپ را تراز می کند.

تصویر

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

برای برنامه های Google CHAT و افزودنی های فضای کاری Google در دسترس است.

Enums
SQUARE مقدار پیش فرض یک ماسک مربع را برای تصویر اعمال می کند. به عنوان مثال ، یک تصویر 4x3 3x3 می شود.
CIRCLE ماسک دایره ای را روی تصویر اعمال می کند. به عنوان مثال ، یک تصویر 4x3 به دایره ای با قطر 3 تبدیل می شود.
،

شاخص

اقدام

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

برای برنامه های Google CHAT و افزودنی های فضای کاری Google در دسترس است.

فیلدها
function

string

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

به عنوان مثال استفاده ، به داده های فرم خواندن مراجعه کنید.

parameters[]

ActionParameter

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

loadIndicator

LoadIndicator

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

persistValues

bool

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

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

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

interaction

Interaction

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

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

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

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

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

requiredWidgets[]

string

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

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

برای برنامه های Google CHAT و افزودنی های فضای کاری Google در دسترس است.

allWidgetsAreRequired

bool

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

برای برنامه های Google CHAT و افزودنی های فضای کاری Google در دسترس است.

عمل پارامتر

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

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

برای برنامه های Google CHAT و افزودنی های فضای کاری Google در دسترس است.

فیلدها
key

string

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

value

string

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

تعامل

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

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

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

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

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

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

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

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

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

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

لود کننده

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

برای برنامه های Google CHAT و افزودنی های فضای کاری Google در دسترس است.

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

هموار

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

برای برنامه های Google CHAT و افزودنی های فضای کاری Google در دسترس است.

فیلدها
type

BorderType

نوع مرزی

strokeColor

Color

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

برای تنظیم رنگ سکته مغزی ، مقداری را برای زمینه های red ، green و blue مشخص کنید. مقدار باید یک عدد شناور بین 0 تا 1 بر اساس مقدار رنگ RGB باشد ، جایی که 0 (0/255) نشان دهنده عدم وجود رنگ است و 1 (255/255) حداکثر شدت رنگ را نشان می دهد.

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

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

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

cornerRadius

int32

شعاع گوشه ای برای مرز.

نوع مرزی

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

برای برنامه های Google CHAT و افزودنی های فضای کاری Google در دسترس است.

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

دکمه

یک دکمه متن ، نماد یا متن و آیکون که کاربران می توانند روی آن کلیک کنند. برای مثال در برنامه های گپ Google ، به اضافه کردن یک دکمه مراجعه کنید.

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

برای برنامه های Google CHAT و افزودنی های فضای کاری Google در دسترس است.

فیلدها
text

string

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

icon

Icon

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

color

Color

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

برای تنظیم رنگ دکمه ، مقداری را برای زمینه های red ، green و blue مشخص کنید. مقدار باید یک عدد شناور بین 0 تا 1 بر اساس مقدار رنگ RGB باشد ، جایی که 0 (0/255) نشان دهنده عدم وجود رنگ است و 1 (255/255) حداکثر شدت رنگ را نشان می دهد.

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

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

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

onClick

OnClick

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

disabled

bool

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

altText

string

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

متن توصیفی را تنظیم کنید که به کاربران اجازه می دهد دکمه را بداند. For example, if a button opens a hyperlink, you might write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat" .

type

Type

اختیاری. The type of a button. If unset, button type defaults to OUTLINED . If the color field is set, the button type is forced to FILLED and any value set for this field is ignored.

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

تایپ کنید

اختیاری. The type of a button. If color field is set, the type is forced to FILLED .

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

Enums
TYPE_UNSPECIFIED استفاده نکنید. نامشخص
OUTLINED Outlined buttons are medium-emphasis buttons. They usually contain actions that are important, but aren't the primary action in a Chat app or an add-on.
FILLED A filled button has a container with a solid color. It has the most visual impact and is recommended for the important and primary action in a Chat app or an add-on.
FILLED_TONAL A filled tonal button is an alternative middle ground between filled and outlined buttons. They're useful in contexts where a lower-priority button requires slightly more emphasis than an outline button would give.
BORDERLESS A button does not have an invisible container in its default state. It is often used for the lowest priority actions, especially when presenting multiple options.

ButtonList

A list of buttons layed out horizontally. For an example in Google Chat apps, see Add a button .

Available for Google Chat apps and Google Workspace Add-ons.

فیلدها
buttons[]

Button

An array of buttons.

کارت

A card interface displayed in a Google Chat message or Google Workspace Add-on.

Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step.

Design and preview cards with the Card Builder.

Open the Card Builder

To learn how to build cards, see the following documentation:

Example: Card message for a Google Chat app

Example contact card

To create the sample card message in Google Chat, use the following 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

The header of the card. A header usually contains a leading image and a title. Headers always appear at the top of a card.

sections[]

Section

Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see Define a section of a card .

sectionDividerStyle

DividerStyle

The divider style between the header, sections and footer.

cardActions[]

CardAction

The card's actions. Actions are added to the card's toolbar menu.

Available for Google Workspace Add-ons and unavailable for Google Chat apps.

For example, the following JSON constructs a card action menu with Settings and Send Feedback options:

"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

Name of the card. Used as a card identifier in card navigation.

Available for Google Workspace Add-ons and unavailable for Google Chat apps.

fixedFooter

CardFixedFooter

The fixed footer shown at the bottom of this card.

Setting fixedFooter without specifying a primaryButton or a secondaryButton causes an error. For Chat apps, you can use fixed footers in dialogs , but not card messages .

Available for Google Chat apps and Google Workspace Add-ons.

displayStyle

DisplayStyle

In Google Workspace Add-ons, sets the display properties of the peekCardHeader .

Available for Google Workspace Add-ons and unavailable for Google Chat apps.

peekCardHeader

CardHeader

When displaying contextual content, the peek card header acts as a placeholder so that the user can navigate forward between the homepage cards and the contextual cards.

Available for Google Workspace Add-ons and unavailable for Google Chat apps.

CardAction

A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser.

Available for Google Workspace Add-ons and unavailable for Google Chat apps.

فیلدها
actionLabel

string

The label that displays as the action menu item.

onClick

OnClick

The onClick action for this action item.

CardFixedFooter

A persistent (sticky) footer that that appears at the bottom of the card.

Setting fixedFooter without specifying a primaryButton or a secondaryButton causes an error.

For Chat apps, you can use fixed footers in dialogs , but not card messages . For an example in Google Chat apps, see Add a persistent footer .

Available for Google Chat apps and Google Workspace Add-ons.

فیلدها
primaryButton

Button

The primary button of the fixed footer. The button must be a text button with text and color set.

secondaryButton

Button

The secondary button of the fixed footer. The button must be a text button with text and color set. If secondaryButton is set, you must also set primaryButton .

CardHeader

Represents a card header. For an example in Google Chat apps, see Add a header .

Available for Google Chat apps and Google Workspace Add-ons.

فیلدها
title

string

مورد نیاز. The title of the card header. The header has a fixed height: if both a title and subtitle are specified, each takes up one line. If only the title is specified, it takes up both lines.

subtitle

string

The subtitle of the card header. If specified, appears on its own line below the title .

imageType

ImageType

The shape used to crop the image.

Available for Google Chat apps and Google Workspace Add-ons.

imageUrl

string

The HTTPS URL of the image in the card header.

imageAltText

string

The alternative text of this image that's used for accessibility.

DisplayStyle

In Google Workspace Add-ons, determines how a card is displayed.

Available for Google Workspace Add-ons and unavailable for Google Chat apps.

Enums
DISPLAY_STYLE_UNSPECIFIED استفاده نکنید. نامشخص
PEEK The header of the card appears at the bottom of the sidebar, partially covering the current top card of the stack. Clicking the header pops the card into the card stack. If the card has no header, a generated header is used instead.
REPLACE Default value. The card is shown by replacing the view of the top card in the card stack.

DividerStyle

The divider style of a card. Currently only used for dividers betweens card sections.

Available for Google Chat apps and Google Workspace Add-ons.

Enums
DIVIDER_STYLE_UNSPECIFIED استفاده نکنید. نامشخص
SOLID_DIVIDER Default option. Render a solid divider.
NO_DIVIDER If set, no divider is rendered. This style completely removes the divider from the layout. The result is equivalent to not adding a divider at all.

بخش

A section contains a collection of widgets that are rendered vertically in the order that they're specified.

Available for Google Chat apps and Google Workspace Add-ons.

فیلدها
header

string

Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons .

widgets[]

Widget

All the widgets in the section. Must contain at least one widget.

collapsible

bool

Indicates whether this section is collapsible.

Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking Show more . Users can hide the widgets again by clicking Show less .

To determine which widgets are hidden, specify uncollapsibleWidgetsCount .

uncollapsibleWidgetsCount

int32

The number of uncollapsible widgets which remain visible even when a section is collapsed.

For example, when a section contains five widgets and the uncollapsibleWidgetsCount is set to 2 , the first two widgets are always shown and the last three are collapsed by default. The uncollapsibleWidgetsCount is taken into account only when collapsible is true .

collapseControl

CollapseControl

اختیاری. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. برای برنامه‌های Google Chat در دسترس است و برای افزونه‌های Google Workspace در دسترس نیست.

تراشه

A text, icon, or text and icon chip that users can click.

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

فیلدها
icon

Icon

The icon image. If both icon and text are set, then the icon appears before the text.

label

string

The text displayed inside the chip.

onClick

OnClick

اختیاری. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function.

enabled
(deprecated)

bool

Whether the chip is in an active state and responds to user actions. Defaults to true . منسوخ شده است. Use disabled instead.

disabled

bool

Whether the chip is in an inactive state and ignores user actions. Defaults to false .

altText

string

The alternative text that's used for accessibility.

Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat" .

ChipList

A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line.

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

فیلدها
layout

Layout

Specified chip list layout.

chips[]

Chip

An array of chips.

طرح بندی

The chip list layout.

Enums
LAYOUT_UNSPECIFIED استفاده نکنید. نامشخص
WRAPPED Default value. The chip list wraps to the next line if there isn't enough horizontal space.
HORIZONTAL_SCROLLABLE The chips scroll horizontally if they don't fit in the available space.

CollapseControl

Represent an expand and collapse control. برای برنامه‌های Google Chat در دسترس است و برای افزونه‌های Google Workspace در دسترس نیست.

فیلدها
horizontalAlignment

HorizontalAlignment

The horizontal alignment of the expand and collapse button.

expandButton

Button

اختیاری. Define a customizable button to expand the section. Both expandButton and collapseButton field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used.

collapseButton

Button

اختیاری. Define a customizable button to collapse the section. Both expandButton and collapseButton field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used.

ستون ها

The Columns widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see Display cards and dialogs in columns .

The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns.

Columns are displayed side-by-side. You can customize the width of each column using the HorizontalSizeStyle field. If the user's screen width is too narrow, the second column wraps below the first:

  • On web, the second column wraps if the screen width is less than or equal to 480 pixels.
  • On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt.
  • On Android devices, the second column wraps if the screen width is less than or equal to 320 dp.

To include more than two columns, or to use rows, use the Grid widget.

Available for Google Chat apps and Google Workspace Add-ons. The add-on UIs that support columns include:

  • The dialog displayed when users open the add-on from an email draft.
  • The dialog displayed when users open the add-on from the Add attachment menu in a Google Calendar event.
فیلدها
columnItems[]

Column

An array of columns. You can include up to 2 columns in a card or dialog.

ستون

یک ستون

Google Workspace Add-ons and Chat apps

فیلدها
horizontalSizeStyle

HorizontalSizeStyle

Specifies how a column fills the width of the card.

horizontalAlignment

HorizontalAlignment

Specifies whether widgets align to the left, right, or center of a column.

verticalAlignment

VerticalAlignment

Specifies whether widgets align to the top, bottom, or center of a column.

widgets[]

Widgets

An array of widgets included in a column. Widgets appear in the order that they are specified.

HorizontalSizeStyle

Specifies how a column fills the width of the card. The width of each column depends on both the HorizontalSizeStyle and the width of the widgets within the column.

Google Workspace Add-ons and Chat apps

Enums
HORIZONTAL_SIZE_STYLE_UNSPECIFIED استفاده نکنید. نامشخص
FILL_AVAILABLE_SPACE Default value. Column fills the available space, up to 70% of the card's width. If both columns are set to FILL_AVAILABLE_SPACE , each column fills 50% of the space.
FILL_MINIMUM_SPACE Column fills the least amount of space possible and no more than 30% of the card's width.

VerticalAlignment

Specifies whether widgets align to the top, bottom, or center of a column.

Google Workspace Add-ons and Chat apps

Enums
VERTICAL_ALIGNMENT_UNSPECIFIED استفاده نکنید. نامشخص
CENTER Default value. Aligns widgets to the center of a column.
TOP Aligns widgets to the top of a column.
BOTTOM Aligns widgets to the bottom of a column.

ابزارک ها

The supported widgets that you can include in a column.

Google Workspace Add-ons and Chat apps

فیلدها

Union field data .

data can be only one of the following:

textParagraph

TextParagraph

TextParagraph widget.

image

Image

Image widget.

decoratedText

DecoratedText

DecoratedText widget.

buttonList

ButtonList

ButtonList widget.

textInput

TextInput

TextInput widget.

selectionInput

SelectionInput

SelectionInput widget.

dateTimePicker

DateTimePicker

DateTimePicker widget.

chipList

ChipList

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

DateTimePicker

Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see Let a user pick a date and time .

Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly.

Available for Google Chat apps and Google Workspace Add-ons.

فیلدها
name

string

The name by which the DateTimePicker is identified in a form input event.

For details about working with form inputs, see Receive form data .

label

string

The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as Appointment date or Appointment date and time .

type

DateTimePickerType

Whether the widget supports inputting a date, a time, or the date and time.

valueMsEpoch

int64

The default value displayed in the widget, in milliseconds since Unix epoch time .

Specify the value based on the type of picker ( DateTimePickerType ):

  • DATE_AND_TIME : a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use 1672574400000 .
  • DATE_ONLY : a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use 1672531200000 .
  • TIME_ONLY : a time in UTC. For example, to represent 12:00 PM, use 43200000 (or 12 * 60 * 60 * 1000 ).
timezoneOffsetDate

int32

The number representing the time zone offset from UTC, in minutes. If set, the value_ms_epoch is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting.

onChangeAction

Action

Triggered when the user clicks Save or Clear from the DateTimePicker interface.

validation

Validation

اختیاری. Specify the validation required for this datetimer picker.

Available for Google Chat apps and Google Workspace Add-ons.

DateTimePickerType

The format for the date and time in the DateTimePicker widget. Determines whether users can input a date, a time, or both a date and time.

Available for Google Chat apps and Google Workspace Add-ons.

Enums
DATE_AND_TIME Users input a date and time.
DATE_ONLY Users input a date.
TIME_ONLY Users input a time.

DecoratedText

A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see Display text with decorative text .

Available for Google Chat apps and Google Workspace Add-ons.

فیلدها
icon
(deprecated)

Icon

Deprecated in favor of startIcon .

startIcon

Icon

The icon displayed in front of the text.

topLabel

string

The text that appears above text . Always truncates.

text

string

مورد نیاز. The primary text.

Supports simple formatting. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons .

wrapText

bool

The wrap text setting. If true , the text wraps and displays on multiple lines. Otherwise, the text is truncated.

Only applies to text , not topLabel and bottomLabel .

bottomLabel

string

The text that appears below text . Always wraps.

onClick

OnClick

This action is triggered when users click topLabel or bottomLabel .

Union field control . A button, switch, checkbox, or image that appears to the right-hand side of text in the decoratedText widget. control can be only one of the following:
button

Button

A button that a user can click to trigger an action.

switchControl

SwitchControl

A switch widget that a user can click to change its state and trigger an action.

endIcon

Icon

An icon displayed after the text.

Supports built-in and custom icons.

SwitchControl

Either a toggle-style switch or a checkbox inside a decoratedText widget.

Available for Google Chat apps and Google Workspace Add-ons.

Only supported in the decoratedText widget.

فیلدها
name

string

The name by which the switch widget is identified in a form input event.

For details about working with form inputs, see Receive form data .

value

string

The value entered by a user, returned as part of a form input event.

For details about working with form inputs, see Receive form data .

selected

bool

When true , the switch is selected.

onChangeAction

Action

The action to perform when the switch state is changed, such as what function to run.

controlType

ControlType

How the switch appears in the user interface.

Available for Google Chat apps and Google Workspace Add-ons.

ControlType

How the switch appears in the user interface.

Available for Google Chat apps and Google Workspace Add-ons.

Enums
SWITCH A toggle-style switch.
CHECKBOX Deprecated in favor of CHECK_BOX .
CHECK_BOX A checkbox.

تقسیم کننده

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

Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see Add a horizontal divider between widgets .

Available for Google Chat apps and Google Workspace Add-ons.

For example, the following JSON creates a divider:

"divider": {}

EndNavigation

Dialog flow action.

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

فیلدها
action

Action

The render action for the client to end a dialog flow.

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

اقدام

The render action types for the client to end a dialog flow.

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

Enums
ACTION_UNSPECIFIED Action unspecified.
CLOSE_DIALOG Close the dialog flow.
CLOSE_DIALOG_AND_EXECUTE Close the dialog flow and refresh the card that opened the dialog flow.

GetAutocompletionResponse

A response to getting autocomplete container, which includes elements necessary for showing auto complete items for text field.

Available for Google Workspace Add-ons and unavailable for Google Chat apps. به عنوان مثال:

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

Suggestions

schema

string

This is a no-op schema field that might be present in the markup for syntax checking.

شبکه

Displays a grid with a collection of items. Items can only include text or images. For responsive columns, or to include more than text or images, use Columns . For an example in Google Chat apps, see Display a Grid with a collection of items .

A grid supports any number of columns and items. The number of rows is determined by items divided by columns. A grid with 10 items and 2 columns has 5 rows. A grid with 11 items and 2 columns has 6 rows.

Available for Google Chat apps and Google Workspace Add-ons.

For example, the following JSON creates a 2 column grid with a single item:

"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

The text that displays in the grid header.

items[]

GridItem

The items to display in the grid.

borderStyle

BorderStyle

The border style to apply to each grid item.

columnCount

int32

The number of columns to display in the grid. A default value is used if this field isn't specified, and that default value is different depending on where the grid is shown (dialog versus companion).

onClick

OnClick

This callback is reused by each individual grid item, but with the item's identifier and index in the items list added to the callback's parameters.

GridItem

Represents an item in a grid layout. Items can contain text, an image, or both text and an image.

Available for Google Chat apps and Google Workspace Add-ons.

فیلدها
id

string

A user-specified identifier for this grid item. This identifier is returned in the parent grid's onClick callback parameters.

image

ImageComponent

The image that displays in the grid item.

title

string

The grid item's title.

subtitle

string

The grid item's subtitle.

layout

GridItemLayout

The layout to use for the grid item.

GridItemLayout

Represents the various layout options available for a grid item.

Available for Google Chat apps and Google Workspace Add-ons.

Enums
GRID_ITEM_LAYOUT_UNSPECIFIED استفاده نکنید. نامشخص
TEXT_BELOW The title and subtitle are shown below the grid item's image.
TEXT_ABOVE The title and subtitle are shown above the grid item's image.

نماد

An icon displayed in a widget on a card. For an example in Google Chat apps, see Add an icon .

Supports built-in and custom icons.

Available for Google Chat apps and Google Workspace Add-ons.

فیلدها
altText

string

اختیاری. A description of the icon used for accessibility. If unspecified, the default value Button is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, A user's account portrait , or Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat .

If the icon is set in a Button , the altText appears as helper text when the user hovers over the button. However, if the button also sets text , the icon's altText is ignored.

imageType

ImageType

The crop style applied to the image. In some cases, applying a CIRCLE crop causes the image to be drawn larger than a built-in icon.

Union field icons . The icon displayed in the widget on the card. icons can be only one of the following:
knownIcon

string

Display one of the built-in icons provided by Google Workspace.

For example, to display an airplane icon, specify AIRPLANE . For a bus, specify BUS .

For a full list of supported icons, see built-in icons .

iconUrl

string

Display a custom icon hosted at an HTTPS URL.

به عنوان مثال:

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

Supported file types include .png and .jpg .

materialIcon

MaterialIcon

Display one of the Google Material Icons .

For example, to display a checkbox icon , use

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

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

تصویر

An image that is specified by a URL and can have an onClick action. For an example, see Add an image .

Available for Google Chat apps and Google Workspace Add-ons.

فیلدها
imageUrl

string

The HTTPS URL that hosts the image.

به عنوان مثال:

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

OnClick

When a user clicks the image, the click triggers this action.

altText

string

The alternative text of this image that's used for accessibility.

ImageComponent

Represents an image.

Available for Google Chat apps and Google Workspace Add-ons.

فیلدها
imageUri

string

The image URL.

altText

string

The accessibility label for the image.

cropStyle

ImageCropStyle

The crop style to apply to the image.

borderStyle

BorderStyle

The border style to apply to the image.

ImageCropStyle

Represents the crop style applied to an image.

Available for Google Chat apps and Google Workspace Add-ons.

For example, here's how to apply a 16:9 aspect ratio:

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

ImageCropType

The crop type.

aspectRatio

double

The aspect ratio to use if the crop type is RECTANGLE_CUSTOM .

For example, here's how to apply a 16:9 aspect ratio:

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

ImageCropType

Represents the crop style applied to an image.

Available for Google Chat apps and Google Workspace Add-ons.

Enums
IMAGE_CROP_TYPE_UNSPECIFIED استفاده نکنید. نامشخص
SQUARE Default value. Applies a square crop.
CIRCLE Applies a circular crop.
RECTANGLE_CUSTOM Applies a rectangular crop with a custom aspect ratio. Set the custom aspect ratio with aspectRatio .
RECTANGLE_4_3 Applies a rectangular crop with a 4:3 aspect ratio.

LinkPreview

Card action that previews a third-party link by displaying a card and smart chip. To learn more, see Preview links with smart chips .

Available for Google Workspace Add-ons and unavailable for Google Chat apps.

For example, the following JSON returns a unique title for the link preview and its smart chip, and a preview card with a header and text description:

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

The example returns the following link preview:

Example link preview

فیلدها
previewCard

Card

A card that displays information about a link from a third-party service.

title

string

The title that displays in the smart chip for the link preview. If unset, the smart chip displays the header of the preview_card .

linkPreviewTitle

string

The title that displays in the link preview. If unset, the link preview displays the header of the preview_card .

MaterialIcon

A Google Material Icon , which includes over 2500+ options.

For example, to display a checkbox icon with customized weight and grade, write the following:

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

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

فیلدها
name

string

The icon name defined in the Google Material Icon , for example, check_box . Any invalid names are abandoned and replaced with empty string and results in the icon failing to render.

fill

bool

Whether the icon renders as filled. مقدار پیش فرض نادرست است.

To preview different icon settings, go to Google Font Icons and adjust the settings under Customize .

weight

int32

The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used.

To preview different icon settings, go to Google Font Icons and adjust the settings under Customize .

grade

int32

Weight and grade affect a symbol's thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used.

To preview different icon settings, go to Google Font Icons and adjust the settings under Customize .

Card action that manipulates the card stack.

به عنوان مثال:

1) Add a new card to the stack (navigate forward). For Chat apps, only available for app home .

Available for Google Chat apps and Google Workspace Add-ons.

 navigations : {
    pushCard : CARD
  }

2) Update the card on top of the stack (in place update).

Available for Google Workspace Add-ons and unavailable for Google Chat apps.

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

3) Go back one step without updating.

Available for Google Workspace Add-ons and unavailable for Google Chat apps.

  navigations : {
    popCard : true,
  }

4) Go back multiple steps and update that card.

Available for Google Workspace Add-ons and unavailable for Google Chat apps.

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

5) Go back multiple steps to a defined CARD_NAME .

Available for Google Workspace Add-ons and unavailable for Google Chat apps.

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

6) Go back to the root and update that card.

Available for Google Workspace Add-ons and unavailable for Google Chat apps.

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

7) Pop to the specified card and pop that one as well.

Available for Google Workspace Add-ons and unavailable for Google Chat apps.

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

8) Replace the top card with a new card. For Chat apps, only available for app home .

Available for Google Chat apps and Google Workspace Add-ons.

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

Union field navigate_action .

navigate_action can be only one of the following:

popToRoot

bool

Card stack pops all cards off except the root card.

pop

bool

Card stack pops one card off.

popToCard

string

Card stack pops all cards above the specified card with given card name.

pushCard

Card

Card stack pushes a card onto the card stack.

updateCard

Card

Card stack updates the top card with a new card and preserves filled form fields values. For a non-equivalent field, the value is dropped.

endNavigation

EndNavigation

Dialog flow end navigation action. For more information, see Build a homepage for a Google Chat app

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

اطلاع رسانی

Card action that displays a notification in the host app.

Available for Google Workspace Add-ons and unavailable for Google Chat apps.

فیلدها
text

string

Plain text to display for the notification, without HTML tags.

OnClick

Represents how to respond when users click an interactive element on a card, such as a button.

Available for Google Chat apps and Google Workspace Add-ons.

فیلدها

Union field data .

data can be only one of the following:

action

Action

If specified, an action is triggered by this onClick .

openDynamicLinkAction

Action

An add-on triggers this action when the action needs to open a link. This differs from the open_link above in that this needs to talk to server to get the link. Thus some preparation work is required for web client to do before the open link action response comes back.

Available for Google Workspace Add-ons and unavailable for Google Chat apps.

card

Card

A new card is pushed to the card stack after clicking if specified.

Available for Google Workspace Add-ons and unavailable for Google Chat apps.

overflowMenu

OverflowMenu

If specified, this onClick opens an overflow menu. برای برنامه‌های Google Chat در دسترس است و برای افزونه‌های Google Workspace در دسترس نیست.

OnClose

What the client does when a link opened by an OnClick action is closed.

Implementation depends on client platform capabilities. For example, a web browser might open a link in a pop-up window with an OnClose handler.

If both OnOpen and OnClose handlers are set, and the client platform can't support both values, OnClose takes precedence.

Available for Google Workspace Add-ons and unavailable for Google Chat apps.

Enums
NOTHING Default value. The card doesn't reload; هیچ اتفاقی نمی افتد
RELOAD

Reloads the card after the child window closes.

If used in conjunction with OpenAs.OVERLAY , the child window acts as a modal dialog and the parent card is blocked until the child window closes.

OpenAs

When an OnClick action opens a link, then the client can either open it as a full-size window (if that's the frame used by the client), or an overlay (such as a pop-up). The implementation depends on the client platform capabilities, and the value selected might be ignored if the client doesn't support it. FULL_SIZE is supported by all clients.

Available for Google Workspace Add-ons and unavailable for Google Chat apps.

Enums
FULL_SIZE The link opens as a full-size window (if that's the frame used by the client).
OVERLAY The link opens as an overlay, such as a pop-up.

OverflowMenu

A widget that presents a pop-up menu with one or more actions that users can invoke. For example, showing non-primary actions in a card. You can use this widget when actions don't fit in the available space. To use, specify this widget in the OnClick action of widgets that support it. For example, in a Button .

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

فیلدها
items[]

OverflowMenuItem

مورد نیاز. The list of menu options.

OverflowMenuItem

An option that users can invoke in an overflow menu.

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

فیلدها
startIcon

Icon

The icon displayed in front of the text.

text

string

مورد نیاز. The text that identifies or describes the item to users.

onClick

OnClick

مورد نیاز. The action invoked when a menu option is selected. This OnClick cannot contain an OverflowMenu , any specified OverflowMenu is dropped and the menu item disabled.

disabled

bool

Whether the menu option is disabled. Defaults to false.

RenderActions

A set of render instructions that tells a card to perform an action, or tells the add-on host app or the Chat app to perform an app-specific action.

Available for Google Chat apps and Google Workspace Add-ons.

فیلدها
action

Action

hostAppAction

HostAppActionMarkup

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

schema

string

This is a no-op schema field that might be present in the markup for syntax checking.

اقدام

فیلدها
navigations[]

Navigation

Push, pop, or update displayed cards.

notification

Notification

Display a notification to the end user.

linkPreview

LinkPreview

Display a link preview to the end user.

SelectionInput

A widget that creates one or more UI items that users can select. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see Add selectable UI elements .

Chat apps can process the value of items that users select or input. For details about working with form inputs, see Receive form data .

To collect undefined or abstract data from users, use the TextInput widget.

Available for Google Chat apps and Google Workspace Add-ons.

فیلدها
name

string

مورد نیاز. The name that identifies the selection input in a form input event.

For details about working with form inputs, see Receive form data .

label

string

The text that appears above the selection input field in the user interface.

Specify text that helps the user enter the information your app needs. For example, if users are selecting the urgency of a work ticket from a drop-down menu, the label might be "Urgency" or "Select urgency".

type

SelectionType

The type of items that are displayed to users in a SelectionInput widget. Selection types support different types of interactions. For example, users can select one or more checkboxes, but they can only select one value from a dropdown menu.

items[]

SelectionItem

An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.

onChangeAction

Action

If specified, the form is submitted when the selection changes. If not specified, you must specify a separate button that submits the form.

For details about working with form inputs, see Receive form data .

multiSelectMaxSelectedItems

int32

For multiselect menus, the maximum number of items that a user can select. Minimum value is 1 item. If unspecified, defaults to 3 items.

multiSelectMinQueryLength

int32

For multiselect menus, the number of text characters that a user inputs before the app queries autocomplete and displays suggested items in the menu.

If unspecified, defaults to 0 characters for static data sources and 3 characters for external data sources.

validation

Validation

For dropdown menus, the validation for this selection input field.

Available for Google Chat apps and Google Workspace Add-ons.

Union field multi_select_data_source . For a multiselect menu, the data source that populates selection items.

برای برنامه‌های Google Chat در دسترس است و برای افزونه‌های Google Workspace در دسترس نیست. multi_select_data_source can be only one of the following:

externalDataSource

Action

An external data source, such as a relational data base.

platformDataSource

PlatformDataSource

A data source from Google Workspace.

PlatformDataSource

For a SelectionInput widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu.

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

فیلدها
data_source فیلد اتحادیه . The data source. data_source تنها می تواند یکی از موارد زیر باشد:
commonDataSource

CommonDataSource

A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.

hostAppDataSource

HostAppDataSourceMarkup

A data source that's unique to a Google Workspace host application, such spaces in Google Chat.

This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see Install the client libraries .

CommonDataSource

A data source shared by all Google Workspace applications .

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

Enums
UNKNOWN Default value. استفاده نکنید.
USER Google Workspace users. The user can only view and select users from their Google Workspace organization.

SelectionItem

An item that users can select in a selection input, such as a checkbox or switch.

Available for Google Chat apps and Google Workspace Add-ons.

فیلدها
text

string

The text that identifies or describes the item to users.

value

string

The value associated with this item. The client should use this as a form input value.

For details about working with form inputs, see Receive form data .

selected

bool

Whether the item is selected by default. If the selection input only accepts one value (such as for radio buttons or a dropdown menu), only set this field for one item.

startIconUri

string

For multiselect menus, the URL for the icon displayed next to the item's text field. Supports PNG and JPEG files. Must be an HTTPS URL. For example, https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png .

bottomText

string

For multiselect menus, a text description or label that's displayed below the item's text field.

SelectionType

The format for the items that users can select. Different options support different types of interactions. For example, users can select multiple checkboxes, but can only select one item from a dropdown menu.

Each selection input supports one type of selection. Mixing checkboxes and switches, for example, isn't supported.

Available for Google Chat apps and Google Workspace Add-ons.

Enums
CHECK_BOX A set of checkboxes. Users can select one or more checkboxes.
RADIO_BUTTON A set of radio buttons. Users can select one radio button.
SWITCH A set of switches. Users can turn on one or more switches.
DROPDOWN A dropdown menu. Users can select one item from the menu.
MULTI_SELECT

A multiselect menu for static or dynamic data. From the menu bar, users select one or more items. Users can also input values to populate dynamic data. For example, users can start typing the name of a Google Chat space and the widget autosuggests the space.

To populate items for a multiselect menu, you can use one of the following types of data sources:

  • Static data: Items are specified as SelectionItem objects in the widget. Up to 100 items.
  • Google Workspace data: Items are populated using data from Google Workspace, such as Google Workspace users or Google Chat spaces.
  • External data: Items are populated from an external data source outside of Google Workspace.

For examples of how to implement multiselect menus, see Add a multiselect menu .

Available for Google Chat apps and Google Workspace Add-ons.

SubmitFormResponse

A response to a form submit other than getting an autocomplete container, which contains the actions the card should perform and/or the add-on host app should perform, and whether the card's state has changed.

Available for Google Workspace Add-ons and unavailable for Google Chat apps. به عنوان مثال:

{
  "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

A set of render instructions that tells the card to perform an action and/or tells the add-on host app to perform an app-specific action.

stateChanged

bool

Whether the state of the cards has changed and data in existing cards is stale.

schema

string

This is a no-op schema field that may be present in the markup for syntax checking.

پیشنهادات

Suggested values that users can enter. These values appear when users click inside the text input field. As users type, the suggested values dynamically filter to match what the users have typed.

For example, a text input field for programming language might suggest Java, JavaScript, Python, and C++. When users start typing Jav , the list of suggestions filters to show Java and JavaScript .

Suggested values help guide users to enter values that your app can make sense of. When referring to JavaScript, some users might enter javascript and others java script . Suggesting JavaScript can standardize how users interact with your app.

When specified, TextInput.type is always SINGLE_LINE , even if it's set to MULTIPLE_LINE .

Available for Google Chat apps and Google Workspace Add-ons.

فیلدها
items[]

SuggestionItem

A list of suggestions used for autocomplete recommendations in text input fields.

SuggestionItem

One suggested value that users can enter in a text input field.

Available for Google Chat apps and Google Workspace Add-ons.

فیلدها

Union field content .

content can be only one of the following:

text

string

The value of a suggested input to a text input field. This is equivalent to what users enter themselves.

TextInput

A field in which users can enter text. Supports suggestions and on-change actions. For an example in Google Chat apps, see Add a field in which a user can enter text .

Chat apps receive and can process the value of entered text during form input events. For details about working with form inputs, see Receive form data .

When you need to collect undefined or abstract data from users, use a text input. To collect defined or enumerated data from users, use the SelectionInput widget.

Available for Google Chat apps and Google Workspace Add-ons.

فیلدها
name

string

The name by which the text input is identified in a form input event.

For details about working with form inputs, see Receive form data .

label

string

The text that appears above the text input field in the user interface.

Specify text that helps the user enter the information your app needs. For example, if you are asking someone's name, but specifically need their surname, write surname instead of name .

Required if hintText is unspecified. Otherwise, optional.

hintText

string

Text that appears below the text input field meant to assist users by prompting them to enter a certain value. This text is always visible.

Required if label is unspecified. Otherwise, optional.

value

string

The value entered by a user, returned as part of a form input event.

For details about working with form inputs, see Receive form data .

type

Type

How a text input field appears in the user interface. For example, whether the field is single or multi-line.

onChangeAction

Action

What to do when a change occurs in the text input field. For example, a user adding to the field or deleting text.

Examples of actions to take include running a custom function or opening a dialog in Google Chat.

initialSuggestions

Suggestions

Suggested values that users can enter. These values appear when users click inside the text input field. As users type, the suggested values dynamically filter to match what the users have typed.

For example, a text input field for programming language might suggest Java, JavaScript, Python, and C++. When users start typing Jav , the list of suggestions filters to show just Java and JavaScript .

Suggested values help guide users to enter values that your app can make sense of. When referring to JavaScript, some users might enter javascript and others java script . Suggesting JavaScript can standardize how users interact with your app.

When specified, TextInput.type is always SINGLE_LINE , even if it's set to MULTIPLE_LINE .

Available for Google Chat apps and Google Workspace Add-ons.

autoCompleteAction

Action

اختیاری. Specify what action to take when the text input field provides suggestions to users who interact with it.

If unspecified, the suggestions are set by initialSuggestions and are processed by the client.

If specified, the app takes the action specified here, such as running a custom function.

Available for Google Workspace Add-ons and unavailable for Google Chat apps.

validation

Validation

Specify the validation necessary for this text input field.

Available for Google Chat apps and Google Workspace Add-ons.

placeholderText

string

Text that appears in the text input field when the field is empty. Use this text to prompt users to enter a value. For example, Enter a number from 0 to 100 .

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

تایپ کنید

How a text input field appears in the user interface. For example, whether it's a single line input field, or a multi-line input. If initialSuggestions is specified, type is always SINGLE_LINE , even if it's set to MULTIPLE_LINE .

Available for Google Chat apps and Google Workspace Add-ons.

Enums
SINGLE_LINE The text input field has a fixed height of one line.
MULTIPLE_LINE The text input field has a fixed height of multiple lines.

TextParagraph

A paragraph of text that supports formatting. For an example in Google Chat apps, see Add a paragraph of formatted text . For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons .

Available for Google Chat apps and Google Workspace Add-ons.

فیلدها
text

string

The text that's shown in the widget.

maxLines

int32

The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a show more button. If the text is equal or shorter than the specified maximum number of lines, a show more button isn't displayed.

The default value is 0, in which case all context is displayed. Negative values are ignored. برای برنامه‌های Google Chat در دسترس است و برای افزونه‌های Google Workspace در دسترس نیست.

اعتبار سنجی

Represents the necessary data for validating the widget it's attached to.

Available for Google Chat apps and Google Workspace Add-ons.

فیلدها
characterLimit

int32

Specify the character limit for text input widgets. Note that this is only used for text input and is ignored for other widgets.

Available for Google Chat apps and Google Workspace Add-ons.

inputType

InputType

Specify the type of the input widgets.

Available for Google Chat apps and Google Workspace Add-ons.

InputType

The type of the input widget.

Enums
INPUT_TYPE_UNSPECIFIED Unspecified type. استفاده نکنید.
TEXT Regular text that accepts all characters.
INTEGER An integer value.
FLOAT A float value.
EMAIL An email address.
EMOJI_PICKER A emoji selected from system-provided emoji picker.

ویجت

Each card is made up of widgets.

A widget is a composite object that can represent one of text, images, buttons, and other object types.

فیلدها
horizontalAlignment

HorizontalAlignment

Specifies whether widgets align to the left, right, or center of a column.

Union field data . A widget can only have one of the following items. You can use multiple widget fields to display more items. data can be only one of the following:
textParagraph

TextParagraph

Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons .

For example, the following JSON creates a bolded text:

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

Image

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

For example, the following JSON creates an image with alternative text:

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

DecoratedText

Displays a decorated text item.

For example, the following JSON creates a decorated text widget showing email address:

"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

A list of buttons.

For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link:

"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

Displays a text box that users can type into.

For example, the following JSON creates a text input for an email address:

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

As another example, the following JSON creates a text input for a programming language with static suggestions:

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

SelectionInput

Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus.

For example, the following JSON creates a dropdown menu that lets users choose a size:

"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

Displays a widget that lets users input a date, time, or date and time.

For example, the following JSON creates a date time picker to schedule an appointment:

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

Divider

Displays a horizontal line divider between widgets.

For example, the following JSON creates a divider:

"divider": {
}
grid

Grid

Displays a grid with a collection of items.

A grid supports any number of columns and items. The number of rows is determined by the upper bounds of the number items divided by the number of columns. A grid with 10 items and 2 columns has 5 rows. A grid with 11 items and 2 columns has 6 rows.

Available for Google Chat apps and Google Workspace Add-ons.

For example, the following JSON creates a 2 column grid with a single item:

"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

Displays up to 2 columns.

To include more than 2 columns, or to use rows, use the Grid widget.

For example, the following JSON creates 2 columns that each contain text paragraphs:

"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"
          }
        }
      ]
    }
  ]
}
chipList

ChipList

A list of chips.

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"
        }
      }
    }
  ]
}

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

HorizontalAlignment

Specifies whether widgets align to the left, right, or center of a column.

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

Enums
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

The shape used to crop the image.

Available for Google Chat apps and Google Workspace Add-ons.

Enums
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.