Package google.apps.card.v1

string

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

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

ActionParameter

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

LoadIndicator

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

bool

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

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

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

Interaction

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

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

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

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

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

string

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

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

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

bool

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

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

string

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

string

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

BorderType

نوع حاشیه.

Color

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

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

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

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

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

int32

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

string

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

Icon

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

Color

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

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

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

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

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

OnClick

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

bool

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

string

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

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

Type

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

Button

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

CardHeader

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

Section

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

DividerStyle

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

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

string

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

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

CardFixedFooter

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

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

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

DisplayStyle

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

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

CardHeader

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

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

string

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

OnClick

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

Button

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

Button

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

string

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

string

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

ImageType

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

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

string

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

string

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

TextParagraph

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

ButtonList

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

Image

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

string

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

Widget

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

bool

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

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

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

int32

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

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

CollapseControl

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

CarouselCard

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

NestedWidget

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

NestedWidget

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

Icon

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

string

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

OnClick

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

bool

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

bool

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

string

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

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

Layout

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

Chip

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

HorizontalAlignment

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

Button

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

Button

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

Column

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

HorizontalSizeStyle

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

HorizontalAlignment

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

VerticalAlignment

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

Widgets

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

TextParagraph

ویجت TextParagraph

Image

ویجت Image .

DecoratedText

ویجت DecoratedText

ButtonList

ویجت ButtonList

TextInput

ویجت TextInput

SelectionInput

ویجت SelectionInput .

DateTimePicker

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

ChipList

ویجت ChipList .

HostAppDataActionMarkup

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

string

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

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

string

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

DateTimePickerType

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

int64

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

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

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

int32

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

Action

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

Icon

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

Icon

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

VerticalAlignment

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

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

string

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

TextParagraph

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

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

string

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

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

TextParagraph

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

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

bool

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

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

string

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

TextParagraph

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

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

OnClick

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

Button

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

SwitchControl

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

Icon

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

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

string

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

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

string

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

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

bool

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

Action

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

ControlType

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

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

Action

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

Suggestions

string

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

string

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

GridItem

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

BorderStyle

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

int32

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

OnClick

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

string

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

ImageComponent

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

string

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

string

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

GridItemLayout

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

string

Optional. 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

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.

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 .

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

Display one of the Google Material Icons .

For example, to display a checkbox icon , use

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

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

string

The HTTPS URL that hosts the image.

برای مثال:

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

OnClick

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

string

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

string

The image URL.

string

The accessibility label for the image.

ImageCropStyle

The crop style to apply to the image.

BorderStyle

The border style to apply to the image.

ImageCropType

The crop type.

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
}

string

URL of the link to return to the add-on.

string

Title of the link to return to the add-on.

Card

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

string

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

string

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

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.

bool

Whether the icon renders as filled. Default value is false.

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

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 .

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 .

UpdateWidget

For add-ons in Google Chat , updates a widget in a card or dialog.

SelectionInputWidgetSuggestions

For selectionInput widgets, an array of suggested items in a multiselect menu. When a multiselect menu uses an external data source to populate its items, the widget can dynamically populate suggestions based on what they type into the menu. For more information, see Collect information from Google Chat users .

SelectionItem

An array of selectable items that appear to a user after they type into a multiselect menu.

bool

Pops all cards off except the root card.

bool

Pops one card off.

string

Pops all cards above the specified card with given card name.

Card

Pushes a card onto the card stack.

For dialogs in Google Chat , opens or updates a dialog.

Card

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

For dialogs in Google Chat , opens or updates a dialog.

EndNavigation

For add-ons in Google Chat , closes a dialog .

string

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

Action

If specified, an action is triggered by this onClick .

OpenLink

If specified, this onClick triggers an open link action.

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

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

If specified, this onClick opens an overflow menu.

string

The URL to open.

OpenAs

How to open a link.

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

OnClose

Whether the client forgets about a link after opening it, or observes it until the window closes.

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

OverflowMenuItem

Required. The list of menu options.

Icon

The icon displayed in front of the text.

string

Required. The text that identifies or describes the item to users.

OnClick

Required. 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.

bool

Whether the menu option is disabled. Defaults to false.

Action

The action that add-ons can use to update the UI.

Add-ons in Google Chat .

HostAppActionMarkup

Actions handled by individual host apps.

string

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

Navigation

Pushes, pops, or updates a card.

Add-ons in Google Chat .

OpenLink

Opens the target link in a new tab or pop-up window.

Notification

Displays a notification in the host Google Workspace application when a user interacts with a card.

For add-ons in Google Chat , displays a notification when users submit and close a dialog .

LinkPreview

Available in Google Docs, Google Sheets, and Google Slides. Previews links with smart chips and card. For details, see Preview links with smart chips .

Link

Available in Google Docs. Returns a link from a third-party resource and converts it to a smart chip in the host application. Formatted as an array of objects with one item.

For more information, see Create third-party resources from the @ menu .

ModifyCard

For add-ons in Google Chat , updates a card based on a user interaction. The array must only contain a single object.

string

Required. The name that identifies the selection input in a form input event.

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

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

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.

SelectionItem

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

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 .

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.

int32

For multiselect menus, the number of text characters that a user inputs before the menu returns suggested selection items.

If unset, the multiselect menu uses the following default values:

• If the menu uses a static array of SelectionInput items, defaults to 0 characters and immediately populates items from the array.
• If the menu uses a dynamic data source ( multi_select_data_source ), defaults to 3 characters before querying the data source to return suggested items.

string

Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible.

Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.

Action

An external data source, such as a relational database.

PlatformDataSource

A data source from Google Workspace.

CommonDataSource

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

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 .

string

The text that identifies or describes the item to users.

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 .

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.

string

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

string

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.

bool

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

string

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

SuggestionItem

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

string

The value of a suggested input to a text input field. This is equivalent to what users enter themselves.

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 .

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.

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.

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

How a text input field appears in the user interface. For example, whether the field is single or multi-line.

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.

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.

Action

Optional. 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

Specify the input format validation necessary for this text field.

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

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 .

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

string

The text that's shown in the widget.

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.

TextSyntax

The syntax of the text. If not set, the text is rendered as HTML.

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

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

Specify the type of the input widgets.

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

HorizontalAlignment

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

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

Displays an 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

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

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

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

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

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

Displays a horizontal line divider between widgets.

For example, the following JSON creates a divider:

"divider": {
}

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

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

Carousel

A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs.

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

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