فهرست
-
Action(پیام) -
Action.ActionParameter(پیام) -
Action.Interaction(enum) -
Action.LoadIndicator(شمارشی) -
AuthorizationError(پیام) -
BasicAuthorizationAction(پیام) -
BorderStyle(پیام) -
BorderStyle.BorderType(شمارشی) -
Button(پیام) -
Button.Type(شمارشی) -
ButtonList(پیام) -
Card(پیام) -
Card.CardAction(پیام) -
Card.CardFixedFooter(پیام) -
Card.CardHeader(پیام) -
Card.DisplayStyle(شمارشی) -
Card.DividerStyle(شمارشی) -
Card.NestedWidget(پیام) -
Card.Section(پیام) -
Card.Visibility(شمارشی) -
Carousel(پیام) -
Carousel.CarouselCard(پیام) -
Chip(پیام) -
ChipList(پیام) -
ChipList.Layout(شمارشی) -
CollapseControl(پیام) -
Columns(پیام) -
Columns.Column(پیام) -
Columns.Column.HorizontalSizeStyle(شمارشی) - ترازبندی
Columns.Column.VerticalAlignment(شمارشی) -
Columns.Column.Widgets(پیام) -
Condition(پیام) -
Condition.ExpressionDataCondition(پیام) -
Condition.ExpressionDataCondition.ConditionType(شمارشی) -
DataActions(پیام) -
DataSourceConfig(پیام) -
DateTimePicker(پیام) - نوع
DateTimePicker.DateTimePickerType(شمارشی) -
DecoratedText(پیام) -
DecoratedText.SwitchControl(پیام) -
DecoratedText.SwitchControl.ControlType(شمارشی) -
Divider(پیام) -
EndNavigation(پیام) -
EndNavigation.Action(شمارشی) -
EventAction(پیام) -
EventAction.CommonWidgetAction(پیام) -
EventAction.CommonWidgetAction.UpdateVisibilityAction(پیام) -
ExpressionData(پیام) -
GetAutocompletionResponse(پیام) -
Grid(پیام) -
Grid.GridItem(پیام) -
Grid.GridItem.GridItemLayout(شمارشی) -
Icon(پیام) -
Image(پیام) -
ImageComponent(پیام) -
ImageCropStyle(پیام) -
ImageCropStyle.ImageCropType(شمارشی) -
Link(پیام) -
LinkPreview(پیام) -
MaterialIcon(پیام) -
ModifyCard(پیام) -
ModifyCard.UpdateWidget(پیام) -
ModifyCard.UpdateWidget.SelectionInputWidgetSuggestions(پیام) -
Navigation(پیام) -
Notification(پیام) -
OnClick(پیام) -
OpenLink(پیام) -
OpenLink.OnClose(شمارشی) -
OpenLink.OpenAs(شمارشی) -
OverflowMenu(پیام) -
OverflowMenu.OverflowMenuItem(پیام) -
RenderActions(پیام) -
RenderActions.Action(پیام) -
RequestingGoogleScopes(پیام) -
SelectionInput(پیام) -
SelectionInput.PlatformDataSource(پیام) -
SelectionInput.PlatformDataSource.CommonDataSource(شمارشی) -
SelectionInput.SelectionItem(پیام) -
SelectionInput.SelectionType(شمارشی) -
SubmitFormResponse(پیام) -
Suggestions(پیام) -
Suggestions.SuggestionItem(پیام) -
TextInput(پیام) -
TextInput.Type(شمارشی) -
TextParagraph(پیام) -
TextParagraph.TextSyntax(enum) -
Trigger(پیام) -
Validation(پیام) -
Validation.InputType(enum) -
Widget(پیام) -
Widget.HorizontalAlignment(شمارشی) -
Widget.ImageType(شمارشی) - ترازبندی عمودی
Widget.VerticalAlignment(شمارشی)
اکشن
عملی که رفتار هنگام ارسال فرم را توصیف میکند. برای مثال، میتوانید یک اسکریپت Apps Script را برای مدیریت فرم فراخوانی کنید. اگر این عمل اجرا شود، مقادیر فرم به سرور ارسال میشوند.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| فیلدها | |
|---|---|
function | یک تابع سفارشی که هنگام کلیک یا فعال شدن عنصر حاوی آن، فراخوانی میشود. برای مثال، به بخش «خواندن دادههای فرم» مراجعه کنید. |
parameters[] | فهرست پارامترهای عملیاتی |
loadIndicator | نشانگر بارگذاری را مشخص میکند که اکشن هنگام فراخوانی اکشن نمایش میدهد. |
persistValues | نشان میدهد که آیا مقادیر فرم پس از انجام عمل باقی میمانند یا خیر. مقدار پیشفرض اگر اگر |
interaction | اختیاری. هنگام باز کردن یک کادر محاورهای الزامی است. در پاسخ به تعامل با کاربر، مانند کلیک کاربر روی دکمهای در یک پیام کارتی، چه باید کرد؟ اگر مشخص نشده باشد، برنامه با اجرای یک با مشخص کردن یک
|
requiredWidgets[] | اختیاری. این لیست را با نام ویجتهایی که این اقدام برای ارسال معتبر به آنها نیاز دارد، پر کنید. اگر ویجتهای فهرستشده در اینجا هنگام فراخوانی این اقدام مقداری نداشته باشند، ارسال فرم لغو میشود.
|
allWidgetsAreRequired | اختیاری. اگر این مقدار درست باشد، تمام ویجتها توسط این اقدام الزامی در نظر گرفته میشوند.
|
پارامتر عمل
فهرست پارامترهای رشتهای که هنگام فراخوانی متد اکشن باید ارائه شوند. برای مثال، سه دکمهی چرت زدن را در نظر بگیرید: چرت زدن الان، چرت زدن یک روز، یا چرت زدن هفتهی بعد. میتوانید از action method = snooze() استفاده کنید و نوع چرت زدن و زمان چرت زدن را در فهرست پارامترهای رشتهای وارد کنید.
برای کسب اطلاعات بیشتر، به CommonEventObject مراجعه کنید.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| فیلدها | |
|---|---|
key | نام پارامتر برای اسکریپت اکشن. |
value | مقدار پارامتر. |
تعامل
اختیاری. هنگام باز کردن یک کادر محاورهای الزامی است.
در پاسخ به تعامل با کاربر، مانند کلیک کاربر روی دکمهای در یک پیام کارتی، چه باید کرد؟
اگر مشخص نشده باشد، برنامه با اجرای یک action - مانند باز کردن یک لینک یا اجرای یک تابع - به صورت عادی پاسخ میدهد.
با مشخص کردن یک interaction ، برنامه میتواند به روشهای تعاملی خاصی پاسخ دهد. برای مثال، با تنظیم interaction روی OPEN_DIALOG ، برنامه میتواند یک کادر محاورهای باز کند.
در صورت مشخص شدن، نشانگر بارگیری نشان داده نمیشود. اگر برای یک افزونه مشخص شود، کل کارت حذف میشود و هیچ چیزی در کلاینت نشان داده نمیشود.
برای برنامههای Google Chat در دسترس است و برای افزونههای Google Workspace در دسترس نیست.
| انومها | |
|---|---|
INTERACTION_UNSPECIFIED | مقدار پیشفرض. action به صورت عادی اجرا میشود. |
OPEN_DIALOG | یک کادر محاورهای ، یک رابط کاربری پنجرهای و مبتنی بر کارت که برنامههای چت برای تعامل با کاربران از آن استفاده میکنند، باز میکند. فقط توسط برنامههای چت در پاسخ به کلیک روی دکمه روی پیامهای کارت پشتیبانی میشود. اگر برای یک افزونه مشخص شود، کل کارت حذف میشود و هیچ چیزی در کلاینت نشان داده نمیشود.
|
شاخص بار
نشانگر بارگذاری را مشخص میکند که اکشن هنگام فراخوانی اکشن نمایش میدهد.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| انومها | |
|---|---|
SPINNER | یک چرخنده را نمایش میدهد تا نشان دهد که محتوا در حال بارگذاری است. |
NONE | هیچ چیزی نمایش داده نمیشود. |
خطای مجوز
افزونههایی که به سرویسهای ۳P دسترسی دارند یا به دامنههای oAuth بیشتری از گوگل نیاز دارند، باید در صورت عدم دسترسی به اطلاعات ورود (مثلاً توکنهای OAuth) به کاربر نهایی یک کارت مجوز نشان دهند. افزونهها باید شیء AuthorizationError را برای رندر کردن کارت مجوز برگردانند.
| فیلدها | |
|---|---|
| |
basicAuthorizationPrompt | بگذارید پلتفرم کارت مجوز پایه را بسازد. توسعهدهنده فقط باید URL مجوز را ارائه دهد. اقدام پایه میتواند توسط افزونههایی که قصد انتشار عمومی ندارند، استفاده شود. |
customAuthorizationPrompt | دستورالعملهای مربوط به کارت مجوز سفارشی را ارائه دهید. در طول فرآیند بررسی Google Workspace Marketplace، یک درخواست مجوز سفارشی اجرا خواهد شد. کاربران نهایی باید یک کارت مجوز سفارشی را مشاهده کنند که به وضوح نشان میدهد کاربر نهایی در حال تأیید دسترسی به خدمات خارجی 3P است. |
requestingGoogleScopes | وقتی رضایتنامهی oAuth بدون محدودیت فعال باشد، افزونهی HTTP ممکن است نیاز به درخواست دامنههای بیشتری از Google oAuth داشته باشد. افزونه باید این شیء را برای رندر کردن کارت مجوز برگرداند. |
اقدام مجوز پایه
اقدامی که به پلتفرم اجازه میدهد یک کارت مجوز اولیه برای کاربران نهایی بسازد.
| فیلدها | |
|---|---|
authorizationUrl | اگر افزونه از OAuth2 برای اتصال به سرویس 3P استفاده میکند، این آدرس اینترنتی مجوز OAuth2 خواهد بود. |
resource | متنی که در صورت عدم احراز هویت یک منبع محافظتشده به کاربر نهایی نمایش داده میشود. مقادیر مثال عبارتند از: «حساب Salesforce» یا «دادههای Salesforce». |
استایل حاشیه
گزینههای سبک برای حاشیه یک کارت یا ویجت، شامل نوع و رنگ حاشیه.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| فیلدها | |
|---|---|
type | نوع حاشیه. |
strokeColor | رنگهایی که باید هنگام تعیین نوع برای تنظیم رنگ خط دور متن، مقداری را برای فیلدهای برای مثال، کد زیر رنگ را در حداکثر شدت خود به قرمز تنظیم میکند: فیلد |
cornerRadius | شعاع گوشه برای حاشیه. |
نوع حاشیه
انواع حاشیهای که برای ویجتها اعمال میشود را نشان میدهد.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| انومها | |
|---|---|
BORDER_TYPE_UNSPECIFIED | استفاده نکنید. نامشخص. |
NO_BORDER | بدون مرز. |
STROKE | مقدار پیشفرض. طرح کلی. |
دکمه
یک دکمه متنی، آیکون یا ترکیبی از متن و آیکون که کاربران میتوانند روی آن کلیک کنند. برای مثال در برنامههای چت گوگل، به «افزودن دکمه» مراجعه کنید.
برای تبدیل یک تصویر به دکمهی قابل کلیک، یک (نه یک Image ) مشخص کنید و یک اکشن ImageComponentonClick تنظیم کنید.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| فیلدها | |
|---|---|
text | متنی که درون دکمه نمایش داده میشود. |
icon | یک آیکون درون دکمه نمایش داده میشود. اگر هم |
color | اختیاری. رنگ دکمه. در صورت تنظیم، برای تنظیم رنگ دکمه، مقداری را برای فیلدهای برای مثال، کد زیر رنگ را در حداکثر شدت خود به قرمز تنظیم میکند: فیلد |
onClick | الزامی. عملی که هنگام کلیک کاربر روی دکمه انجام میشود، مانند باز کردن یک لینک یا اجرای یک تابع سفارشی. |
disabled | اگر |
altText | متن جایگزینی که برای دسترسیپذیری استفاده میشود. متن توصیفی تنظیم کنید که به کاربران اطلاع دهد دکمه چه کاری انجام میدهد. برای مثال، اگر دکمهای یک هایپرلینک را باز میکند، میتوانید بنویسید: «یک تب جدید در مرورگر باز میکند و به مستندات توسعهدهندگان گوگل چت در https://developers.google.com/workspace/chat هدایت میشود» . |
type | اختیاری. نوع دکمه. در صورت عدم تنظیم، نوع دکمه به صورت پیشفرض |
نوع
اختیاری. نوع دکمه. اگر فیلد color تنظیم شده باشد، type آن به صورت اجباری FILLED میشود.
برای برنامههای Google Chat در دسترس است و برای افزونههای Google Workspace در دسترس نیست.
| انومها | |
|---|---|
TYPE_UNSPECIFIED | استفاده نکنید. نامشخص. |
OUTLINED | دکمههای با حاشیهی مشخص، دکمههایی با تأکید متوسط هستند. آنها معمولاً شامل اقداماتی هستند که مهم هستند، اما اقدام اصلی در یک برنامهی چت یا یک افزونه نیستند. |
FILLED | یک دکمهی توپر، دارای یک محفظه با رنگ ثابت است. این دکمه بیشترین تأثیر بصری را دارد و برای انجام اقدامات مهم و اصلی در یک برنامهی چت یا یک افزونه توصیه میشود. |
FILLED_TONAL | دکمههای با تُن رنگی توپر، حد وسط بین دکمههای توپر و دکمههای با تُن رنگی مشخص هستند. این دکمهها در مواردی مفید هستند که یک دکمه با اولویت پایینتر، به تأکید بیشتری نسبت به دکمه با تُن رنگی مشخص نیاز داشته باشد. |
BORDERLESS | یک دکمه در حالت پیشفرض دارای یک محفظه نامرئی نیست. اغلب برای اقدامات با اولویت پایین استفاده میشود، به خصوص هنگام ارائه چندین گزینه. |
لیست دکمه
فهرستی از دکمهها که به صورت افقی قرار گرفتهاند. برای مثال در برنامههای چت گوگل، به «افزودن یک دکمه» مراجعه کنید.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| فیلدها | |
|---|---|
buttons[] | مجموعهای از دکمهها. |
کارت
رابط کارتی که در یک پیام Google Chat یا افزونه Google Workspace نمایش داده میشود.
کارتها از یک طرحبندی تعریفشده، عناصر رابط کاربری تعاملی مانند دکمهها و رسانههای غنی مانند تصاویر پشتیبانی میکنند. از کارتها برای ارائه اطلاعات دقیق، جمعآوری اطلاعات از کاربران و راهنمایی کاربران برای برداشتن گام بعدی استفاده کنید.
با استفاده از ابزار ساخت کارت، کارتها را طراحی و پیشنمایش کنید.
سازنده کارت را باز کنیدبرای آشنایی با نحوه ساخت کارتها، به مستندات زیر مراجعه کنید:
- برای برنامههای چت گوگل، به بخش طراحی اجزای یک کارت یا کادر محاورهای مراجعه کنید.
- برای افزونههای Google Workspace، به رابطهای مبتنی بر کارت مراجعه کنید.
توجه: میتوانید تا ۱۰۰ ویجت به هر کارت اضافه کنید. هر ویجتی که فراتر از این محدودیت باشد نادیده گرفته میشود. این محدودیت هم برای پیامها و پنجرههای گفتگو در برنامههای Google Chat و هم برای کارتهای موجود در افزونههای Google Workspace اعمال میشود.
مثال: پیام کارت برای برنامه Google Chat

برای ایجاد پیام کارت نمونه در گوگل چت، از JSON زیر استفاده کنید:
{
"cardsV2": [
{
"cardId": "unique-card-id",
"card": {
"header": {
"title": "Sasha",
"subtitle": "Software Engineer",
"imageUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
"imageType": "CIRCLE",
"imageAltText": "Avatar for Sasha"
},
"sections": [
{
"header": "Contact Info",
"collapsible": true,
"uncollapsibleWidgetsCount": 1,
"widgets": [
{
"decoratedText": {
"startIcon": {
"knownIcon": "EMAIL"
},
"text": "sasha@example.com"
}
},
{
"decoratedText": {
"startIcon": {
"knownIcon": "PERSON"
},
"text": "<font color=\"#80e27e\">Online</font>"
}
},
{
"decoratedText": {
"startIcon": {
"knownIcon": "PHONE"
},
"text": "+1 (555) 555-1234"
}
},
{
"buttonList": {
"buttons": [
{
"text": "Share",
"onClick": {
"openLink": {
"url": "https://example.com/share"
}
}
},
{
"text": "Edit",
"onClick": {
"action": {
"function": "goToView",
"parameters": [
{
"key": "viewType",
"value": "EDIT"
}
]
}
}
}
]
}
}
]
}
]
}
}
]
}
| فیلدها | |
|---|---|
header | سربرگ کارت. سربرگ معمولاً شامل یک تصویر در ابتدای کارت و یک عنوان است. سربرگها همیشه در بالای کارت ظاهر میشوند. |
sections[] | شامل مجموعهای از ویجتها است. هر بخش، سربرگ اختیاری مخصوص به خود را دارد. بخشها به صورت بصری توسط یک جداکننده خط از هم جدا میشوند. برای مثال در برنامههای چت گوگل، به بخش تعریف یک بخش از یک کارت مراجعه کنید. |
sectionDividerStyle | سبک جداکننده بین سرصفحه، بخشها و پاصفحه. |
cardActions[] | اقدامات کارت. اقدامات به منوی نوار ابزار کارت اضافه میشوند.
برای مثال، JSON زیر یک منوی عملیات کارت با گزینههای |
name | نام کارت. به عنوان شناسه کارت در پیمایش کارت استفاده میشود.
|
fixedFooter | پاورقی ثابت که در پایین این کارت نشان داده شده است. تنظیم
|
displayStyle | در افزونههای Google Workspace، ویژگیهای نمایش
|
peekCardHeader | هنگام نمایش محتوای متنی، هدر کارت Peek به عنوان یک نگهدارنده عمل میکند تا کاربر بتواند بین کارتهای صفحه اصلی و کارتهای متنی به جلو حرکت کند.
|
expressionData[] | دادههای عبارت برای کارت. برای افزونههای Google Workspace که Google Workspace Studio را توسعه میدهند، در دسترس است. برای برنامههای Google Chat در دسترس نیست. |
کارت اکشن
یک اقدام کارت، عملی است که با کارت مرتبط است. برای مثال، یک کارت فاکتور ممکن است شامل اقداماتی مانند حذف فاکتور، ایمیل کردن فاکتور یا باز کردن فاکتور در مرورگر باشد.
برای افزونههای Google Workspace در دسترس است و برای برنامههای Google Chat در دسترس نیست.
| فیلدها | |
|---|---|
actionLabel | برچسبی که به عنوان آیتم منوی عملیات نمایش داده میشود. |
onClick | عمل |
هدر کارت
نشاندهندهی سربرگ کارت است. برای مثال در برنامههای چت گوگل، به افزودن سربرگ مراجعه کنید.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| فیلدها | |
|---|---|
title | الزامی. عنوان سربرگ کارت. سربرگ ارتفاع ثابتی دارد: اگر هم عنوان و هم زیرعنوان مشخص شده باشند، هر کدام یک خط را اشغال میکنند. اگر فقط عنوان مشخص شده باشد، هر دو خط را اشغال میکند. |
subtitle | عنوان فرعی سربرگ کارت. در صورت مشخص بودن، در خط جداگانهای زیر |
imageType | شکلی که برای برش تصویر استفاده میشود.
|
imageUrl | آدرس اینترنتی HTTPS تصویر در هدر کارت. |
imageAltText | متن جایگزین این تصویر که برای دسترسیپذیری استفاده میشود. |
سبک نمایش
در افزونههای Google Workspace، نحوه نمایش یک کارت را تعیین میکند.
برای افزونههای Google Workspace در دسترس است و برای برنامههای Google Chat در دسترس نیست.
| انومها | |
|---|---|
DISPLAY_STYLE_UNSPECIFIED | استفاده نکنید. نامشخص. |
PEEK | سربرگ کارت در پایین نوار کناری ظاهر میشود و تا حدی کارت بالایی فعلی دسته کارتها را میپوشاند. کلیک روی سربرگ، کارت را به دسته کارتها منتقل میکند. اگر کارت سربرگ نداشته باشد، به جای آن از یک سربرگ تولید شده استفاده میشود. |
REPLACE | مقدار پیشفرض. کارت با جایگزینی نمای کارت بالایی در دسته کارتها نمایش داده میشود. |
سبک جداکننده
سبک جداکننده کارت. در حال حاضر فقط برای جداکنندههای بین بخشهای کارت استفاده میشود.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| انومها | |
|---|---|
DIVIDER_STYLE_UNSPECIFIED | استفاده نکنید. نامشخص. |
SOLID_DIVIDER | گزینه پیشفرض. یک جداکنندهی محکم ایجاد کنید. |
NO_DIVIDER | اگر تنظیم شود، هیچ جداکنندهای رندر نمیشود. این استایل جداکننده را به طور کامل از طرحبندی حذف میکند. نتیجه معادل این است که اصلاً جداکنندهای اضافه نشود. |
ویجت تودرتو
فهرستی از ویجتها که میتوانند در یک طرحبندی شامل، مانند یک CarouselCard ، نمایش داده شوند. برای برنامههای Google Chat در دسترس است و برای افزونههای Google Workspace در دسترس نیست.
| فیلدها | |
|---|---|
| |
textParagraph | ویجت پاراگراف متنی. |
buttonList | یک ویجت لیست دکمهای. |
image | یک ویجت تصویر. |
بخش
یک بخش شامل مجموعهای از ویجتها است که به ترتیب مشخص شده به صورت عمودی رندر میشوند.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| فیلدها | |
|---|---|
header | متنی که در بالای یک بخش ظاهر میشود. از متن ساده با قالببندی HTML پشتیبانی میکند. برای اطلاعات بیشتر در مورد قالببندی متن، به افزونههای قالببندی متن در برنامههای چت گوگل و قالببندی متن در افزونههای فضای کاری گوگل مراجعه کنید. |
widgets[] | تمام ابزارکهای موجود در بخش. باید حداقل شامل یک ابزارک باشد. |
collapsible | نشان میدهد که آیا این بخش قابل جمع شدن است یا خیر. بخشهای قابل جمع شدن، برخی یا همه ویجتها را پنهان میکنند، اما کاربران میتوانند با کلیک روی «نمایش بیشتر» بخش را گسترش دهند تا ویجتهای پنهان شده آشکار شوند. کاربران میتوانند با کلیک روی «نمایش کمتر» دوباره ویجتها را پنهان کنند. برای تعیین اینکه کدام ویجتها پنهان هستند، |
uncollapsibleWidgetsCount | تعداد ویجتهای غیرقابلجمع که حتی با جمع شدن یک بخش، قابل مشاهده باقی میمانند. برای مثال، وقتی یک بخش شامل پنج ویجت باشد و |
id | یک شناسه منحصر به فرد که به بخشی اختصاص داده میشود که برای شناسایی بخشی که قرار است تغییر کند، استفاده میشود. این شناسه محدودیت کاراکتری ۶۴ کاراکتر دارد و باید به شکل برای افزونههای Google Workspace که Google Workspace Studio را توسعه میدهند، در دسترس است. برای برنامههای Google Chat در دسترس نیست. |
collapseControl | اختیاری. دکمه باز و بسته کردن بخش را تعریف کنید. این دکمه فقط در صورتی نمایش داده میشود که بخش قابل باز شدن باشد. اگر این فیلد تنظیم نشود، دکمه پیشفرض استفاده میشود. |
قابلیت مشاهده
مشخص میکند که آیا یک عنصر رابط کاربری قابل مشاهده یا پنهان باشد.
برای افزونههای Google Workspace که Google Workspace Studio را توسعه میدهند، در دسترس است. برای برنامههای Google Chat در دسترس نیست.
| انومها | |
|---|---|
VISIBILITY_UNSPECIFIED | میزان دید نامشخص. استفاده نکنید. |
VISIBLE | عنصر رابط کاربری قابل مشاهده است. |
HIDDEN | عنصر رابط کاربری پنهان است. |
چرخ فلک
یک چرخ فلک که به عنوان اسلایدر نیز شناخته میشود، میچرخد و لیستی از ویجتها را در قالب نمایش اسلاید نمایش میدهد، با دکمههایی که به ویجت قبلی یا بعدی میروند.
برای مثال، این یک نمایش JSON از یک چرخ و فلک است که شامل سه ویجت پاراگراف متنی است.
{
"carouselCards": [
{
"widgets": [
{
"textParagraph": {
"text": "First text paragraph in carousel",
}
}
]
},
{
"widgets": [
{
"textParagraph": {
"text": "Second text paragraph in carousel",
}
}
]
},
{
"widgets": [
{
"textParagraph": {
"text": "Third text paragraph in carousel",
}
}
]
}
]
}
برای برنامههای Google Chat در دسترس است و برای افزونههای Google Workspace در دسترس نیست.
| فیلدها | |
|---|---|
carouselCards[] | فهرستی از کارتهای موجود در چرخ و فلک. |
کارت چرخ فلک
کارتی که میتواند به عنوان یک آیتم چرخ و فلکی نمایش داده شود. برای برنامههای Google Chat در دسترس است و برای افزونههای Google Workspace در دسترس نیست.
| فیلدها | |
|---|---|
widgets[] | فهرستی از ابزارکهای نمایش داده شده در کارت چرخ فلک. ابزارکها به ترتیبی که مشخص شدهاند نمایش داده میشوند. |
footerWidgets[] | فهرستی از ابزارکها که در پایین کارت چرخ فلک نمایش داده میشود. ابزارکها به ترتیبی که مشخص شدهاند نمایش داده میشوند. |
تراشه
یک متن، آیکون یا متن و آیکون که کاربران میتوانند روی آن کلیک کنند.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| فیلدها | |
|---|---|
icon | تصویر آیکون. اگر هم |
label | متنی که درون تراشه نمایش داده میشود. |
onClick | اختیاری. عملی که هنگام کلیک کاربر روی تراشه انجام میشود، مانند باز کردن یک لینک یا اجرای یک تابع سفارشی. |
enabled | اینکه آیا تراشه در حالت فعال است و به اقدامات کاربر پاسخ میدهد یا خیر. مقدار پیشفرض |
disabled | اینکه آیا تراشه در حالت غیرفعال است و اقدامات کاربر را نادیده میگیرد یا خیر. مقدار پیشفرض |
altText | متن جایگزینی که برای دسترسیپذیری استفاده میشود. متن توصیفی تنظیم کنید که به کاربران اطلاع دهد تراشه چه کاری انجام میدهد. برای مثال، اگر تراشه یک پیوند را باز میکند، بنویسید: «یک برگه مرورگر جدید باز میکند و به مستندات توسعهدهنده Google Chat در https://developers.google.com/workspace/chat میرود» . |
چیپ لیست
فهرستی از تراشهها که به صورت افقی چیده شدهاند، که میتوانند به صورت افقی اسکرول شوند یا به خط بعدی بروند.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| فیلدها | |
|---|---|
layout | طرحبندی لیست تراشههای مشخصشده. |
chips[] | مجموعهای از چیپسها. |
طرح بندی
طرح لیست تراشهها.
| انومها | |
|---|---|
LAYOUT_UNSPECIFIED | استفاده نکنید. نامشخص. |
WRAPPED | مقدار پیشفرض. اگر فضای افقی کافی وجود نداشته باشد، لیست تراشهها به خط بعدی میرود. |
HORIZONTAL_SCROLLABLE | اگر چیپها در فضای موجود جا نشوند، به صورت افقی حرکت میکنند. |
کنترل جمعشونده
نمایانگر یک کنترل باز و بسته شدن است.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| فیلدها | |
|---|---|
horizontalAlignment | تراز افقی دکمهی باز و بسته شدن. |
expandButton | اختیاری. یک دکمه قابل تنظیم برای گسترش بخش تعریف کنید. هر دو فیلد expandButton و collapseButton باید تنظیم شوند. فقط تنظیم یک فیلد اعمال نمیشود. اگر این فیلد تنظیم نشود، از دکمه پیشفرض استفاده میشود. |
collapseButton | اختیاری. یک دکمه قابل تنظیم برای جمع کردن بخش تعریف کنید. هر دو فیلد expandButton و collapseButton باید تنظیم شوند. فقط تنظیم یک فیلد اعمال نمیشود. اگر این فیلد تنظیم نشود، از دکمه پیشفرض استفاده میشود. |
ستونها
ویجت Columns حداکثر ۲ ستون را در یک کارت یا کادر محاورهای نمایش میدهد. میتوانید به هر ستون ویجت اضافه کنید؛ ویجتها به ترتیبی که مشخص شدهاند ظاهر میشوند. برای مثال در برنامههای چت گوگل، به نمایش کارتها و کادرهای محاورهای در ستونها مراجعه کنید.
ارتفاع هر ستون توسط ستون بلندتر تعیین میشود. برای مثال، اگر ستون اول از ستون دوم بلندتر باشد، هر دو ستون ارتفاع ستون اول را دارند. از آنجا که هر ستون میتواند شامل تعداد متفاوتی از ویجتها باشد، نمیتوانید ردیف تعریف کنید یا ویجتها را بین ستونها تراز کنید.
ستونها در کنار هم نمایش داده میشوند. میتوانید عرض هر ستون را با استفاده از فیلد HorizontalSizeStyle تنظیم کنید. اگر عرض صفحه نمایش کاربر خیلی باریک باشد، ستون دوم زیر ستون اول قرار میگیرد:
- در وب، ستون دوم در صورتی که عرض صفحه نمایش کمتر یا مساوی ۴۸۰ پیکسل باشد، جمع میشود.
- در دستگاههای iOS، اگر عرض صفحه نمایش کمتر یا مساوی ۳۰۰ pt باشد، ستون دوم جمع میشود.
- در دستگاههای اندروید، اگر عرض صفحه نمایش کمتر یا مساوی ۳۲۰ dp باشد، ستون دوم جمع میشود.
برای اضافه کردن بیش از دو ستون یا استفاده از ردیفها، از ویجت استفاده کنید. Grid
برای برنامههای Google Chat و افزونههای Google Workspace موجود است. رابطهای کاربری افزونههایی که از ستونها پشتیبانی میکنند عبارتند از:
- کادر محاورهای که هنگام باز کردن افزونه از پیشنویس ایمیل توسط کاربران نمایش داده میشود.
- کادر محاورهای که هنگام باز کردن افزونه از منوی «افزودن پیوست» در رویداد تقویم گوگل توسط کاربران نمایش داده میشود.
| فیلدها | |
|---|---|
columnItems[] | آرایهای از ستونها. میتوانید تا ۲ ستون را در یک کارت یا کادر محاورهای قرار دهید. |
ستون
یک ستون.
| فیلدها | |
|---|---|
horizontalSizeStyle | مشخص میکند که یک ستون چگونه عرض کارت را پر کند. |
horizontalAlignment | مشخص میکند که آیا ویجتها در سمت چپ، راست یا مرکز یک ستون ترازبندی شوند. |
verticalAlignment | مشخص میکند که آیا ویجتها در بالا، پایین یا مرکز یک ستون ترازبندی شوند یا خیر. |
widgets[] | آرایهای از ویجتها که در یک ستون قرار گرفتهاند. ویجتها به ترتیبی که مشخص شدهاند، نمایش داده میشوند. |
سبک اندازه افقی
مشخص میکند که یک ستون چگونه عرض کارت را پر میکند. عرض هر ستون به HorizontalSizeStyle و عرض ویجتهای درون ستون بستگی دارد.
| انومها | |
|---|---|
HORIZONTAL_SIZE_STYLE_UNSPECIFIED | استفاده نکنید. نامشخص. |
FILL_AVAILABLE_SPACE | مقدار پیشفرض. ستون فضای موجود را تا ۷۰٪ از عرض کارت پر میکند. اگر هر دو ستون روی FILL_AVAILABLE_SPACE تنظیم شده باشند، هر ستون ۵۰٪ از فضا را پر میکند. |
FILL_MINIMUM_SPACE | ستون کمترین فضای ممکن را اشغال میکند و نباید بیش از 30٪ از عرض کارت باشد. |
ترازبندی عمودی
مشخص میکند که آیا ویجتها در بالا، پایین یا مرکز یک ستون ترازبندی شوند یا خیر.
| انومها | |
|---|---|
VERTICAL_ALIGNMENT_UNSPECIFIED | استفاده نکنید. نامشخص. |
CENTER | مقدار پیشفرض. ویجتها را در مرکز ستون تراز میکند. |
TOP | ویجتها را در بالای یک ستون تراز میکند. |
BOTTOM | ویجتها را در پایین ستون تراز میکند. |
ابزارکها
ویجتهای پشتیبانیشدهای که میتوانید در یک ستون قرار دهید.
| فیلدها | |
|---|---|
| |
textParagraph | ویجت |
image | ویجت |
decoratedText | ویجت |
buttonList | ویجت |
textInput | ویجت |
selectionInput | ویجت |
dateTimePicker | ویجت انتخابگر |
chipList | ویجت |
وضعیت
بیانگر شرطی است که میتواند برای شروع یک عمل استفاده شود.
برای افزونههای Google Workspace که Google Workspace Studio را توسعه میدهند، در دسترس است. برای برنامههای Google Chat در دسترس نیست.
| فیلدها | |
|---|---|
actionRuleId | شناسه منحصر به فرد ActionRule. |
condition فیلد Union. شرط. condition میتواند فقط یکی از موارد زیر باشد: | |
expressionDataCondition | شرطی که توسط دادههای عبارت تعیین میشود. |
شرط داده بیانی
بیانگر شرطی است که با استفاده از CEL ارزیابی میشود.
برای افزونههای Google Workspace که Google Workspace Studio را توسعه میدهند، در دسترس است. برای برنامههای Google Chat در دسترس نیست.
| فیلدها | |
|---|---|
conditionType | نوع شرط. |
نوع وضعیت
نوع شرط.
| انومها | |
|---|---|
CONDITION_TYPE_UNSPECIFIED | نوع شرط نامشخص. |
EXPRESSION_EVALUATION_SUCCESS | ارزیابی عبارت با موفقیت انجام شد. |
EXPRESSION_EVALUATION_FAILURE | ارزیابی عبارت ناموفق بود. |
اقدامات داده
یک افزونه که دادههای Google Workspace را بهروزرسانی میکند.
| فیلدها | |
|---|---|
hostAppDataAction | نحوه بهروزرسانی دادههای Google Workspace را تعریف میکند. |
پیکربندی منبع داده
یک شیء پیکربندی که به پیکربندی منابع داده برای یک ویجت کمک میکند.
برای برنامههای Google Chat و افزونههای Google Workspace که Google Workspace Studio را گسترش میدهند، در دسترس است.
| فیلدها | |
|---|---|
فیلد یونیون data_source . منبع داده data_source فقط میتواند یکی از موارد زیر باشد: | |
remoteDataSource | دادهها از یک ارائهدهنده داده از راه دور است. |
platformDataSource | دادهها از برنامه Google Workspace گرفته شدهاند. |
minCharactersTrigger | حداقل تعداد کاراکترهایی که کاربر باید قبل از فعال شدن این ارائه دهنده داده (یعنی قبل از شروع به بازگرداندن نتایج) وارد کند. |
انتخابگر تاریخ و زمان
به کاربران اجازه میدهد تاریخ، زمان یا هر دو را وارد کنند. از اعتبارسنجی ارسال فرم پشتیبانی میکند. وقتی Action.all_widgets_are_required روی true تنظیم شده باشد یا این ویجت در Action.required_widgets مشخص شده باشد، عملیات ارسال مسدود میشود مگر اینکه مقداری انتخاب شود. برای مثال در برنامههای چت گوگل، به بخش «اجازه دهید کاربر تاریخ و زمان را انتخاب کند» مراجعه کنید.
کاربران میتوانند متن را وارد کنند یا از انتخابگر برای انتخاب تاریخ و زمان استفاده کنند. اگر کاربران تاریخ یا زمان نامعتبری وارد کنند، انتخابگر خطایی را نشان میدهد که از کاربران میخواهد اطلاعات را به درستی وارد کنند.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| فیلدها | |
|---|---|
name | نامی که برای جزئیات بیشتر در مورد کار با ورودیهای فرم، به بخش «دریافت دادههای فرم» مراجعه کنید. |
label | متنی که کاربران را به وارد کردن تاریخ، زمان یا تاریخ و زمان ترغیب میکند. برای مثال، اگر کاربران در حال برنامهریزی قرار ملاقات هستند، از برچسبی مانند |
type | اینکه آیا ویجت از وارد کردن تاریخ، زمان یا تاریخ و زمان پشتیبانی میکند یا خیر. |
valueMsEpoch | مقدار پیشفرض نمایش داده شده در ویجت، بر حسب میلیثانیه از زمان آغاز یونیکس . مقدار را بر اساس نوع انتخابگر (
|
timezoneOffsetDate | عددی که نشاندهندهی اختلاف منطقهی زمانی نسبت به UTC، بر حسب دقیقه است. در صورت تنظیم، |
onChangeAction | زمانی که کاربر روی ذخیره یا پاک کردن از رابط |
فیلد یونیونی data_source . منبع دادهای که برای نمایش تاریخ و زمان مشخص شده است. data_source فقط میتواند یکی از موارد زیر باشد: | |
hostAppDataSource | منبع دادهای که مختص برنامه میزبان Google Workspace است، مانند ایمیلهای Gmail، رویدادهای Google Calendar یا پیامهای Google Chat. برای افزونههای Google Workspace که Google Workspace Studio را توسعه میدهند، در دسترس است. برای برنامههای Google Chat در دسترس نیست. |
نوع انتخابگر تاریخ و زمان
قالب تاریخ و زمان در ویجت DateTimePicker . تعیین میکند که آیا کاربران میتوانند تاریخ، زمان یا هر دو را وارد کنند.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| انومها | |
|---|---|
DATE_AND_TIME | کاربران تاریخ و زمان را وارد میکنند. |
DATE_ONLY | کاربران یک تاریخ وارد میکنند. |
TIME_ONLY | کاربران یک زمان وارد میکنند. |
متن تزئینشده
ویجتی که متن را با تزئینات اختیاری مانند برچسب در بالا یا پایین متن، یک نماد در جلوی متن، یک ویجت انتخاب یا یک دکمه بعد از متن نمایش میدهد. برای مثال در برنامههای چت گوگل، به نمایش متن با متن تزئینی مراجعه کنید.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| فیلدها | |
|---|---|
icon | به نفع |
startIcon | آیکونی که در جلوی متن نمایش داده میشود. |
startIconVerticalAlignment | اختیاری. تراز عمودی آیکون شروع. اگر تنظیم نشود، آیکون به صورت عمودی در مرکز قرار میگیرد.
|
topLabel | متنی که بالای |
topLabelText | معادل
|
text | متن اصلی الزامی است. از قالببندی ساده پشتیبانی میکند. برای اطلاعات بیشتر در مورد قالببندی متن، به افزونههای قالببندی متن در برنامههای چت گوگل و قالببندی متن در فضای کاری گوگل مراجعه کنید. |
contentText | معادل
|
wrapText | تنظیم متن پوششی. اگر فقط روی |
bottomLabel | متنی که زیر |
bottomLabelText | معادل
|
onClick | این اکشن زمانی فعال میشود که کاربران روی |
control فیلد Union. یک دکمه، سوئیچ، کادر انتخاب یا تصویری که در سمت راست متن در ویجت decoratedText ظاهر میشود. control میتواند فقط یکی از موارد زیر باشد: | |
button | دکمهای که کاربر میتواند با کلیک روی آن، عملی را انجام دهد. |
switchControl | یک ویجت سوئیچ که کاربر میتواند با کلیک روی آن، وضعیت آن را تغییر داده و عملی را انجام دهد. |
endIcon | نمادی که بعد از متن نمایش داده میشود. |
سوئیچ کنترل
یا یک سوئیچ به سبک toggle یا یک کادر انتخاب درون یک ویجت decoratedText .
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
فقط در ویجت decoratedText پشتیبانی میشود.
| فیلدها | |
|---|---|
name | نامی که ویجت سوئیچ در رویداد ورودی فرم با آن شناسایی میشود. برای جزئیات بیشتر در مورد کار با ورودیهای فرم، به بخش «دریافت دادههای فرم» مراجعه کنید. |
value | مقداری که توسط کاربر وارد شده و به عنوان بخشی از رویداد ورودی فرم برگردانده میشود. برای جزئیات بیشتر در مورد کار با ورودیهای فرم، به بخش «دریافت دادههای فرم» مراجعه کنید. |
selected | وقتی |
onChangeAction | عملی که هنگام تغییر حالت سوئیچ باید انجام شود، مانند اینکه چه تابعی اجرا شود. |
controlType | نحوه نمایش سوئیچ در رابط کاربری.
|
نوع کنترل
نحوه نمایش سوئیچ در رابط کاربری.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| انومها | |
|---|---|
SWITCH | یک کلید به سبک تاگل. |
CHECKBOX | به نفع CHECK_BOX منسوخ شده است. |
CHECK_BOX | یک کادر انتخاب. |
تقسیم کننده
این نوع هیچ فیلدی ندارد.
جداکنندهای بین ابزارکها را به صورت یک خط افقی نمایش میدهد. برای مثال در برنامههای چت گوگل، به بخش «افزودن جداکننده افقی بین ابزارکها» مراجعه کنید.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
برای مثال، JSON زیر یک جداکننده ایجاد میکند:
"divider": {}
رویداداکشن
نشاندهنده عملی است که میتواند روی یک عنصر ui انجام شود.
برای افزونههای Google Workspace که Google Workspace Studio را توسعه میدهند، در دسترس است. برای برنامههای Google Chat در دسترس نیست.
| فیلدها | |
|---|---|
actionRuleId | شناسه منحصر به فرد ActionRule. |
postEventTriggers[] | فهرست محرکهایی که پس از اجرای EventAction فعال میشوند. |
action میدانی اتحادیه. اقدامی که باید انجام شود. action میتواند فقط یکی از موارد زیر باشد: | |
commonWidgetAction | عملکرد ویجت رایج. |
CommonWidgetAction
نشاندهندهی عملی است که مختص یک ویجت نیست.
برای افزونههای Google Workspace که Google Workspace Studio را توسعه میدهند، در دسترس است. برای برنامههای Google Chat در دسترس نیست.
| فیلدها | |
|---|---|
action میدانی اتحادیه. اقدامی که باید انجام شود. action میتواند فقط یکی از موارد زیر باشد: | |
updateVisibilityAction | عملی برای بهروزرسانی قابلیت مشاهدهی یک ویجت. |
بهروزرسانی قابلیت مشاهده (UpdateVisibilityAction)
نشاندهندهی عملی است که قابلیت مشاهدهی یک ویجت را بهروزرسانی میکند.
برای افزونههای Google Workspace که Google Workspace Studio را توسعه میدهند، در دسترس است. برای برنامههای Google Chat در دسترس نیست.
| فیلدها | |
|---|---|
visibility | قابلیت دید جدید. |
اکسپرشن دیتا
نشاندهندهی دادههایی است که برای ارزیابی یک عبارت استفاده میشوند.
برای افزونههای Google Workspace که Google Workspace Studio را توسعه میدهند، در دسترس است. برای برنامههای Google Chat در دسترس نیست.
| فیلدها | |
|---|---|
id | شناسه منحصر به فرد ExpressionData. |
expression | عبارت کامپایل نشده. |
conditions[] | فهرست شرایطی که توسط نتیجه ارزیابی عبارت تعیین میشوند. |
eventActions[] | فهرست اقداماتی که ExpressionData میتواند مورد استفاده قرار گیرد. |
دریافت پاسخ تکمیل خودکار
پاسخی برای دریافت ظرف تکمیل خودکار، که شامل عناصر لازم برای نمایش موارد تکمیل خودکار برای فیلد متنی است.
برای افزونههای Google Workspace موجود است و برای برنامههای Google Chat موجود نیست. برای مثال:
{
"autoComplete": {
"items": [
{
"text": "C++"
},
{
"text": "Java"
},
{
"text": "JavaScript"
},
{
"text": "Python"
}
]
}
}
| فیلدها | |
|---|---|
autoComplete | |
schema | این یک فیلد طرحواره بدون عملیات است که ممکن است در نشانهگذاری برای بررسی نحو وجود داشته باشد. |
شبکه
یک شبکه با مجموعهای از آیتمها را نمایش میدهد. آیتمها فقط میتوانند شامل متن یا تصویر باشند. برای ستونهای واکنشگرا یا برای افزودن بیش از متن یا تصویر، استفاده کنید. برای مثال در برنامههای چت گوگل، به نمایش یک شبکه با مجموعهای از آیتمها مراجعه کنید.Columns
یک شبکه میتواند از هر تعداد ستون و آیتم پشتیبانی کند. تعداد ردیفها با تقسیم آیتمها بر ستونها تعیین میشود. یک شبکه با ۱۰ آیتم و ۲ ستون، ۵ ردیف دارد. یک شبکه با ۱۱ آیتم و ۲ ستون، ۶ ردیف دارد.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
برای مثال، JSON زیر یک جدول دو ستونی با یک آیتم ایجاد میکند:
"grid": {
"title": "A fine collection of items",
"columnCount": 2,
"borderStyle": {
"type": "STROKE",
"cornerRadius": 4
},
"items": [
{
"image": {
"imageUri": "https://www.example.com/image.png",
"cropStyle": {
"type": "SQUARE"
},
"borderStyle": {
"type": "STROKE"
}
},
"title": "An item",
"textAlignment": "CENTER"
}
],
"onClick": {
"openLink": {
"url": "https://www.example.com"
}
}
}
| فیلدها | |
|---|---|
title | متنی که در هدر شبکه نمایش داده میشود. |
items[] | مواردی که باید در شبکه نمایش داده شوند. |
borderStyle | سبک حاشیهای که برای هر آیتم شبکهای اعمال میشود. |
columnCount | تعداد ستونهایی که در جدول نمایش داده میشوند. اگر این فیلد مشخص نشده باشد، از مقدار پیشفرض استفاده میشود و آن مقدار پیشفرض بسته به محل نمایش جدول (کادر محاورهای در مقابل کادر محاورهای) متفاوت است. |
onClick | این تابع فراخوانی توسط هر آیتم شبکه به صورت جداگانه مورد استفاده مجدد قرار میگیرد، اما شناسه و اندیس آیتم در لیست آیتمها به پارامترهای تابع فراخوانی اضافه میشود. |
آیتم شبکهای
یک آیتم را در یک طرح شبکهای نشان میدهد. آیتمها میتوانند شامل متن، تصویر یا متن و تصویر باشند.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| فیلدها | |
|---|---|
id | یک شناسهی مشخصشده توسط کاربر برای این آیتم شبکه. این شناسه در پارامترهای فراخوانی |
image | تصویری که در آیتم شبکهای نمایش داده میشود. |
title | عنوان آیتم شبکهای. |
subtitle | زیرعنوان آیتم شبکهای. |
layout | طرحبندی مورد استفاده برای آیتم شبکهای. |
طرحبندی آیتم شبکهای
گزینههای مختلف طرحبندی موجود برای یک آیتم شبکهای را نشان میدهد.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| انومها | |
|---|---|
GRID_ITEM_LAYOUT_UNSPECIFIED | استفاده نکنید. نامشخص. |
TEXT_BELOW | عنوان و زیرعنوان در زیر تصویر آیتم شبکهای نشان داده میشوند. |
TEXT_ABOVE | عنوان و زیرعنوان در بالای تصویر آیتم شبکهای نشان داده میشوند. |
آیکون
نمادی که در یک ابزارک روی کارت نمایش داده میشود. برای مثال در برنامههای چت گوگل، به افزودن یک نماد مراجعه کنید.
پشتیبانی از آیکونهای پیشفرض و سفارشی
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| فیلدها | |
|---|---|
altText | اختیاری. توضیحی در مورد آیکون مورد استفاده برای دسترسیپذیری. در صورت عدم تعیین مقدار، مقدار پیشفرض اگر آیکون در یک |
imageType | سبک برش اعمال شده بر روی تصویر. در برخی موارد، اعمال برش |
icons فیلد Union. آیکونی که در ویجت روی کارت نمایش داده میشود. icons میتوانند فقط یکی از موارد زیر باشند: | |
knownIcon | یکی از آیکونهای داخلی ارائه شده توسط Google Workspace را نمایش دهید. برای مثال، برای نمایش آیکون هواپیما، برای لیست کامل آیکونهای پشتیبانیشده، به آیکونهای داخلی مراجعه کنید. |
iconUrl | یک آیکون سفارشی که در یک URL HTTPS میزبانی میشود را نمایش دهید. برای مثال: انواع فایلهای پشتیبانیشده شامل |
materialIcon | یکی از آیکونهای متریال گوگل را نمایش دهید. برای مثال، برای نمایش آیکون چکباکس ، از
|
تصویر
تصویری که توسط یک URL مشخص شده است و میتواند یک عمل onClick داشته باشد. برای مثال، به افزودن یک تصویر مراجعه کنید.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| فیلدها | |
|---|---|
imageUrl | URL HTTPS که تصویر را میزبانی میکند. برای مثال: |
onClick | وقتی کاربر روی تصویر کلیک میکند، این عمل انجام میشود. |
altText | متن جایگزین این تصویر که برای دسترسیپذیری استفاده میشود. |
کامپوننت تصویر
نشان دهنده یک تصویر است.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| فیلدها | |
|---|---|
imageUri | آدرس اینترنتی تصویر. |
altText | برچسب دسترسیپذیری برای تصویر. |
cropStyle | سبک برش (crop) که باید روی تصویر اعمال شود. |
borderStyle | سبک حاشیهای که باید روی تصویر اعمال شود. |
سبک برش تصویر
نشان دهنده سبک برش اعمال شده بر روی تصویر است.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
برای مثال، در اینجا نحوه اعمال نسبت تصویر ۱۶:۹ آورده شده است:
cropStyle {
"type": "RECTANGLE_CUSTOM",
"aspectRatio": 16/9
}
| فیلدها | |
|---|---|
type | نوع محصول. |
aspectRatio | نسبت ابعادی که در صورت انتخاب نوع برش برای مثال، در اینجا نحوه اعمال نسبت تصویر ۱۶:۹ آورده شده است: |
نوع برش تصویر
نشان دهنده سبک برش اعمال شده بر روی تصویر است.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| انومها | |
|---|---|
IMAGE_CROP_TYPE_UNSPECIFIED | استفاده نکنید. نامشخص. |
SQUARE | مقدار پیشفرض. برش مربعی اعمال میکند. |
CIRCLE | یک برش دایرهای اعمال میکند. |
RECTANGLE_CUSTOM | یک برش مستطیلی با نسبت ابعاد سفارشی اعمال میکند. نسبت ابعاد سفارشی را با aspectRatio تنظیم کنید. |
RECTANGLE_4_3 | یک برش مستطیلی با نسبت ابعاد ۴:۳ اعمال میکند. |
پیوند
شیء پیوند برای منبع شخص ثالث که به افزونه بازگردانده شده است. برای اطلاعات بیشتر، به ایجاد منابع شخص ثالث از منوی @ مراجعه کنید.
برای افزونههای Google Workspace در دسترس است و برای برنامههای Google Chat در دسترس نیست.
| فیلدها | |
|---|---|
url | نشانی اینترنتی (URL) لینک برای بازگشت به افزونه. |
title | عنوان پیوند برای بازگشت به افزونه. |
پیشنمایش لینک
عملکرد کارت که با نمایش کارت و تراشه هوشمند، پیشنمایشی از یک لینک شخص ثالث را نمایش میدهد. برای کسب اطلاعات بیشتر، به پیشنمایش لینکها با تراشههای هوشمند مراجعه کنید.
برای افزونههای 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 | کارتی که اطلاعات مربوط به لینکی از یک سرویس شخص ثالث را نمایش میدهد. |
title | عنوانی که در تراشه هوشمند برای پیشنمایش پیوند نمایش داده میشود. اگر تنظیم نشود، تراشه هوشمند سربرگ |
linkPreviewTitle | عنوانی که در پیشنمایش پیوند نمایش داده میشود. اگر تنظیم نشده باشد، پیشنمایش پیوند، سربرگ |
آیکون متریال
یک آیکون متریال گوگل ، که شامل بیش از ۲۵۰۰ گزینه است.
برای مثال، برای نمایش یک آیکون چکباکس با وزن و درجه سفارشی، موارد زیر را بنویسید:
{
"name": "check_box",
"fill": true,
"weight": 300,
"grade": -25
}
برای برنامههای Google Chat در دسترس است و برای افزونههای Google Workspace در دسترس نیست.
| فیلدها | |
|---|---|
name | نام آیکون تعریف شده در Google Material Icon ، برای مثال، |
fill | آیا آیکون به صورت پر شده نمایش داده شود یا خیر. مقدار پیشفرض false است. برای پیشنمایش تنظیمات مختلف آیکون، به Google Font Icons بروید و تنظیمات را در قسمت Customize تنظیم کنید. |
weight | ضخامت خط دور آیکون. از بین {100، 200، 300، 400، 500، 600، 700} یکی را انتخاب کنید. در صورت عدم وجود، مقدار پیشفرض 400 است. اگر مقدار دیگری مشخص شود، مقدار پیشفرض استفاده میشود. برای پیشنمایش تنظیمات مختلف آیکون، به Google Font Icons بروید و تنظیمات را در قسمت Customize تنظیم کنید. |
grade | وزن و درجه بر ضخامت یک نماد تأثیر میگذارند. تنظیمات درجه نسبت به تنظیمات وزن، جزئیتر هستند و تأثیر کمی بر اندازه نماد دارند. از بین {-25، 0، 200} یکی را انتخاب کنید. در صورت عدم وجود، مقدار پیشفرض 0 است. اگر مقدار دیگری مشخص شود، از مقدار پیشفرض استفاده میشود. برای پیشنمایش تنظیمات مختلف آیکون، به Google Font Icons بروید و تنظیمات را در قسمت Customize تنظیم کنید. |
کارت اصلاح
برای افزونهها در گوگل چت ، یک کارت را بر اساس تعامل کاربر بهروزرسانی میکند. آرایه فقط باید شامل یک شیء واحد باشد.
| فیلدها | |
|---|---|
operation میدانی اتحادیه. عملیاتی که باید انجام شود. operation میتواند فقط یکی از موارد زیر باشد: | |
updateWidget | برای افزونهها در گوگل چت ، یک ویجت را در یک کارت یا کادر محاورهای بهروزرسانی میکند. |
ویجت بهروزرسانی
برای افزونههای موجود در گوگل چت ، یک ویجت را در یک کارت یا کادر محاورهای بهروزرسانی میکند. این ویجت برای ارائه پیشنهادات تکمیل خودکار هنگام تایپ کاربر در یک کادر ورودی استفاده میشود. برای جزئیات بیشتر به پیشنهاد موارد چندگزینهای مراجعه کنید.
| فیلدها | |
|---|---|
فیلد union updated_widget . بهروزرسانیهای یک ویجت. updated_widget فقط میتواند یکی از موارد زیر باشد: | |
selectionInputWidgetSuggestions | برای ویجتهای |
ابزارک ورودی انتخابی، پیشنهادات
برای یک ویجت selectionInput که از یک منوی چندگزینهای استفاده میکند، موارد انتخاب را از یک منبع داده پویای خارجی برمیگرداند.
| فیلدها | |
|---|---|
suggestions[] | آرایهای از آیتمهای قابل انتخاب که پس از تایپ در یک منوی چندگزینهای، برای کاربر نمایش داده میشود. |
اعلان
عملی که هنگام تعامل کاربر با یک کارت، اعلانی را در برنامه میزبان Google Workspace نمایش میدهد.
برای افزونههای موجود در گوگل چت ، هنگام ارسال و بستن پنجره توسط کاربران، اعلانی نمایش داده میشود.
برای افزونههای Google Workspace در دسترس است و برای برنامههای Google Chat در دسترس نیست.
| فیلدها | |
|---|---|
text | متن ساده برای نمایش اعلان، بدون تگهای HTML. |
آنکلیک
نحوهی پاسخ دادن به کلیک کاربران روی یک عنصر تعاملی روی کارت، مانند یک دکمه، را نشان میدهد.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| فیلدها | |
|---|---|
| |
action | در صورت مشخص شدن، یک عمل توسط این |
openLink | اگر مشخص شده باشد، این |
openDynamicLinkAction | یک افزونه این عمل را زمانی که عمل نیاز به باز کردن یک لینک دارد، فعال میکند. این با
|
card | در صورت مشخص شدن، پس از کلیک کردن، یک کارت جدید به دسته کارتها اضافه میشود.
|
overflowMenu | اگر مشخص شده باشد، این |
اوپن لینک
نشان دهنده یک رویداد onClick است که یک لینک را باز میکند.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| فیلدها | |
|---|---|
url | آدرس اینترنتی (URL) برای باز کردن. آدرسهای اینترنتی HTTP به HTTPS تبدیل میشوند. |
openAs | نحوه باز کردن لینک.
|
onClose | اینکه آیا کلاینت پس از باز کردن یک لینک، آن را فراموش میکند یا تا زمان بسته شدن پنجره، آن را مشاهده میکند.
|
روشن/خاموش
کاری که کلاینت هنگام بسته شدن لینکی که توسط یک اکشن OnClick باز شده است، انجام میدهد.
پیادهسازی به قابلیتهای پلتفرم کلاینت بستگی دارد. برای مثال، یک مرورگر وب ممکن است با استفاده از یک کنترلکننده OnClose لینکی را در یک پنجره پاپآپ باز کند.
اگر هر دو کنترلکنندهی OnOpen و OnClose تنظیم شده باشند و پلتفرم کلاینت نتواند از هر دو مقدار پشتیبانی کند، OnClose اولویت پیدا میکند.
برای افزونههای Google Workspace در دسترس است و برای برنامههای Google Chat در دسترس نیست.
| انومها | |
|---|---|
NOTHING | مقدار پیشفرض. کارت دوباره شارژ نمیشود؛ هیچ اتفاقی نمیافتد. |
RELOAD | پس از بسته شدن پنجره فرزند، کارت را دوباره بارگذاری میکند. اگر همراه با |
اوپنآس
وقتی یک عمل OnClick یک لینک را باز میکند، کلاینت میتواند آن را به صورت یک پنجره با اندازه کامل (اگر فریم مورد استفاده کلاینت باشد) یا یک پوشش (مانند یک پنجره بازشو) باز کند. پیادهسازی آن به قابلیتهای پلتفرم کلاینت بستگی دارد و اگر کلاینت از مقدار انتخاب شده پشتیبانی نکند، ممکن است نادیده گرفته شود. FULL_SIZE توسط همه کلاینتها پشتیبانی میشود.
برای افزونههای Google Workspace در دسترس است و برای برنامههای Google Chat در دسترس نیست.
| انومها | |
|---|---|
FULL_SIZE | لینک به صورت یک پنجره با اندازه کامل باز میشود (اگر این همان قابی باشد که کلاینت از آن استفاده میکند). |
OVERLAY | لینک به صورت یک پوشش، مانند یک پنجره بازشو، باز میشود. |
منوی سرریز
ویجتی که یک منوی پاپآپ با یک یا چند عمل ارائه میدهد که کاربران میتوانند آنها را فراخوانی کنند. به عنوان مثال، نمایش اعمال غیر اصلی در یک کارت. میتوانید از این ویجت زمانی استفاده کنید که اعمال در فضای موجود جا نمیشوند. برای استفاده، این ویجت را در عمل OnClick ویجتهایی که از آن پشتیبانی میکنند، مشخص کنید. به عنوان مثال، در یک Button .
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| فیلدها | |
|---|---|
items[] | الزامی. فهرست گزینههای منو. |
آیتم منوی سرریز
گزینهای که کاربران میتوانند در یک منوی سرریز (overflow menu) فراخوانی کنند.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| فیلدها | |
|---|---|
startIcon | آیکونی که در جلوی متن نمایش داده میشود. |
text | الزامی. متنی که آیتم را برای کاربران شناسایی یا توصیف میکند. |
onClick | الزامی. عملی که هنگام انتخاب یک گزینه از منو فراخوانی میشود. این |
disabled | آیا گزینه منو غیرفعال است یا خیر. مقدار پیشفرض false است. |
رندر اکشنها
مجموعهای از دستورالعملهای رندر که به برنامه میزبان میگوید چگونه یک کارت را رندر کند یا در پاسخ به تعامل کاربر، عملی را انجام دهد.
برای افزونههای Google Workspace در دسترس است و برای برنامههای Google Chat در دسترس نیست.
| فیلدها | |
|---|---|
action | عملی که افزونهها میتوانند برای بهروزرسانی رابط کاربری از آن استفاده کنند. |
hostAppAction | اقداماتی که توسط برنامههای میزبان منفرد انجام میشوند. |
schema | این یک فیلد طرحواره بدون عملیات است که ممکن است در نشانهگذاری برای بررسی نحو وجود داشته باشد. |
اکشن
اقداماتی که افزونهها میتوانند در کارتها یا برنامه میزبان استفاده کنند.
برای افزونههای Google Workspace در دسترس است و برای برنامههای Google Chat در دسترس نیست.
| فیلدها | |
|---|---|
navigations[] | یک کارت را فشار میدهد، بیرون میآورد یا بهروزرسانی میکند. |
link | لینک هدف را در یک تب جدید یا پنجره پاپآپ باز میکند. |
notification | وقتی کاربر با یک کارت تعامل میکند، یک اعلان در برنامه میزبان Google Workspace نمایش میدهد. برای افزونههای موجود در گوگل چت ، هنگام ارسال و بستن پنجره توسط کاربران، اعلانی نمایش داده میشود. |
linkPreview | موجود در Google Docs، Google Sheets و Google Slides. پیشنمایش لینکها با تراشههای هوشمند و کارت. برای جزئیات بیشتر، به پیشنمایش لینکها با تراشههای هوشمند مراجعه کنید. |
links[] | موجود در اسناد گوگل. یک لینک از یک منبع شخص ثالث را برمیگرداند و آن را به یک تراشه هوشمند در برنامه میزبان تبدیل میکند. به صورت آرایهای از اشیاء با یک آیتم قالببندی شده است. برای اطلاعات بیشتر، به بخش ایجاد منابع شخص ثالث از منوی @ مراجعه کنید. |
modifyOperations[] | برای افزونهها در گوگل چت ، یک کارت را بر اساس تعامل کاربر بهروزرسانی میکند. آرایه فقط باید شامل یک شیء واحد باشد. |
درخواست GoogleScopes
وقتی رضایتنامهی oAuth بدون محدودیت فعال باشد، افزونهی HTTP ممکن است نیاز به درخواست دامنههای بیشتری از Google oAuth داشته باشد. افزونه باید این شیء را برای رندر کردن کارت مجوز برگرداند. Manage granular permissions مراجعه کنید.
| فیلدها | |
|---|---|
scopes[] | محدودههایی که افزونه درخواست میکند. |
allScopes | اگر درست باشد، افزونه تمام محدودهها را از مانیفست درخواست میکند. در این مورد، فیلد محدودهها باید خالی باشد. |
ورودی انتخاب
ویجتی که یک یا چند آیتم رابط کاربری ایجاد میکند که کاربران میتوانند آنها را انتخاب کنند. فقط از اعتبارسنجی ارسال فرم برای منوهای dropdown و multiselect پشتیبانی میکند. وقتی Action.all_widgets_are_required روی true تنظیم شده باشد یا این ویجت در Action.required_widgets مشخص شده باشد، عمل ارسال مسدود میشود مگر اینکه مقداری انتخاب شود. به عنوان مثال، یک منوی کشویی یا کادرهای انتخاب. میتوانید از این ویجت برای جمعآوری دادههایی که قابل پیشبینی یا شمارش هستند استفاده کنید. برای مثال در برنامههای چت گوگل، به افزودن عناصر رابط کاربری قابل انتخاب مراجعه کنید.
برنامههای چت میتوانند مقدار مواردی را که کاربران انتخاب یا وارد میکنند، پردازش کنند. برای جزئیات بیشتر در مورد کار با ورودیهای فرم، به بخش «دریافت دادههای فرم» مراجعه کنید.
برای جمعآوری دادههای تعریفنشده یا انتزاعی از کاربران، از ویجت TextInput استفاده کنید.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| فیلدها | |
|---|---|
name | الزامی. نامی که ورودی انتخاب را در رویداد ورودی فرم مشخص میکند. برای جزئیات بیشتر در مورد کار با ورودیهای فرم، به بخش «دریافت دادههای فرم» مراجعه کنید. |
label | متنی که در بالای فیلد ورودی انتخاب در رابط کاربری ظاهر میشود. متنی را مشخص کنید که به کاربر کمک کند اطلاعات مورد نیاز برنامه شما را وارد کند. برای مثال، اگر کاربران فوریت یک تیکت کاری را از منوی کشویی انتخاب میکنند، برچسب ممکن است «فوریت» یا «انتخاب فوریت» باشد. |
type | نوع آیتمهایی که در ویجت |
items[] | آرایهای از آیتمهای قابل انتخاب. برای مثال، آرایهای از دکمههای رادیویی یا چکباکسها. تا ۱۰۰ آیتم را پشتیبانی میکند. |
onChangeAction | اگر مشخص شود، فرم با تغییر انتخاب ارسال میشود. اگر مشخص نشود، باید دکمهی جداگانهای برای ارسال فرم تعیین کنید. برای جزئیات بیشتر در مورد کار با ورودیهای فرم، به بخش «دریافت دادههای فرم» مراجعه کنید. |
multiSelectMinQueryLength | برای منوهای چندگزینهای، تعداد کاراکترهای متنی که کاربر قبل از نمایش گزینههای پیشنهادی منو وارد میکند. اگر تنظیم نشده باشد، منوی چندگزینهای از مقادیر پیشفرض زیر استفاده میکند:
|
dataSourceConfigs[] | اختیاری. پیکربندیهای منبع داده برای کنترل انتخاب. این فیلد کنترل دقیقتری بر منبع داده ارائه میدهد. در صورت مشخص شدن، فیلدهای برای افزونههای Google Workspace که Google Workspace Studio را گسترش میدهند، در دسترس است. برای |
multiSelectMaxSelectedItems | برای منوهای چندگزینهای، حداکثر تعداد آیتمهایی که کاربر میتواند انتخاب کند. حداقل مقدار ۱ آیتم است. اگر مشخص نشود، پیشفرض ۳ آیتم است. |
hintText | اختیاری. متنی که در زیر فیلد ورودی انتخاب ظاهر میشود و برای کمک به کاربران با وادار کردن آنها به وارد کردن مقدار خاصی طراحی شده است. این متن همیشه قابل مشاهده است. برای افزونههای Google Workspace که Google Workspace Studio را توسعه میدهند، در دسترس است. برای برنامههای Google Chat در دسترس نیست. |
فیلد یونیونی
| |
externalDataSource | یک منبع داده خارجی، مانند یک پایگاه داده رابطهای. |
platformDataSource | منبع داده از Google Workspace. |
منبع داده پلتفرم
برای یک ویجت که از یک منوی چند انتخابی استفاده میکند، یک منبع داده از Google Workspace. برای پر کردن موارد در یک منوی چند انتخابی استفاده میشود. SelectionInput
برای برنامههای Google Chat در دسترس است و برای افزونههای Google Workspace در دسترس نیست.
| فیلدها | |
|---|---|
فیلد یونیون data_source . منبع داده data_source فقط میتواند یکی از موارد زیر باشد: | |
commonDataSource | منبع دادهای که توسط همه برنامههای Google Workspace، مانند کاربران یک سازمان Google Workspace، به اشتراک گذاشته شده است. |
hostAppDataSource | منبع دادهای که مختص برنامه میزبان Google Workspace است، مانند فضاهای موجود در Google Chat. این فیلد از کتابخانههای کلاینت API گوگل پشتیبانی میکند اما در کتابخانههای کلاینت ابری موجود نیست. برای کسب اطلاعات بیشتر، به نصب کتابخانههای کلاینت مراجعه کنید. |
منبع داده مشترک
منبع دادهای که توسط همه برنامههای Google Workspace به اشتراک گذاشته شده است.
برای برنامههای Google Chat در دسترس است و برای افزونههای Google Workspace در دسترس نیست.
| انومها | |
|---|---|
UNKNOWN | مقدار پیشفرض. استفاده نکنید. |
USER | کاربران Google Workspace. کاربر فقط میتواند کاربران سازمان Google Workspace خود را مشاهده و انتخاب کند. |
مورد انتخابی
موردی که کاربران میتوانند در یک ورودی انتخاب، مانند یک چکباکس یا سوئیچ، انتخاب کنند. تا ۱۰۰ مورد را پشتیبانی میکند.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| فیلدها | |
|---|---|
text | متنی که کالا را برای کاربران شناسایی یا توصیف میکند. |
value | مقدار مرتبط با این آیتم. کلاینت باید از این به عنوان مقدار ورودی فرم استفاده کند. برای جزئیات بیشتر در مورد کار با ورودیهای فرم، به بخش «دریافت دادههای فرم» مراجعه کنید. |
selected | آیا آیتم به طور پیشفرض انتخاب شده است یا خیر. اگر ورودی انتخاب فقط یک مقدار را میپذیرد (مانند دکمههای رادیویی یا منوی کشویی)، این فیلد را فقط برای یک آیتم تنظیم کنید. |
bottomText | برای منوهای چندگزینهای، یک توضیح متنی یا برچسب که در زیر فیلد |
فیلد یونیون startIcon . برای منوهای چندگزینهای، آدرس اینترنتی (URL) آیکون در کنار فیلد text آیتم نمایش داده میشود. از فایلهای PNG و JPEG پشتیبانی میکند. باید یک آدرس اینترنتی HTTPS باشد. برای مثال، https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png . startIcon فقط میتواند یکی از موارد زیر باشد: | |
startIconUri | |
نوع انتخاب
قالب مواردی که کاربران میتوانند انتخاب کنند. گزینههای مختلف از انواع مختلف تعاملات پشتیبانی میکنند. به عنوان مثال، کاربران میتوانند چندین کادر انتخاب را انتخاب کنند، اما فقط میتوانند یک مورد را از منوی کشویی انتخاب کنند.
هر ورودی انتخاب از یک نوع انتخاب پشتیبانی میکند. برای مثال، ترکیب چکباکسها و سوئیچها پشتیبانی نمیشود.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| انومها | |
|---|---|
CHECK_BOX | مجموعهای از چکباکسها. کاربران میتوانند یک یا چند چکباکس را انتخاب کنند. |
RADIO_BUTTON | مجموعهای از دکمههای رادیویی. کاربران میتوانند یک دکمه رادیویی را انتخاب کنند. |
SWITCH | مجموعهای از سوئیچها. کاربران میتوانند یک یا چند سوئیچ را فعال کنند. |
DROPDOWN | یک منوی کشویی. کاربران میتوانند یک مورد را از منو انتخاب کنند. برای برنامههای Google Chat، میتوانید موارد را با استفاده از یک منبع داده پویا پر کنید و همزمان با تایپ کاربران در منو، موارد را به صورت خودکار پیشنهاد دهید. به عنوان مثال، کاربران میتوانند شروع به تایپ نام یک فضای Google Chat کنند و ویجت به صورت خودکار آن فضا را پیشنهاد میدهد. برای پر کردن پویای موارد برای یک منوی کشویی، از یکی از انواع منابع داده زیر استفاده کنید:
برای مثالهایی از نحوه پیادهسازی منوهای کشویی برای برنامههای چت، به «افزودن یک منوی کشویی» و «منوهای کشویی را به صورت پویا پر کنید» مراجعه کنید.
|
MULTI_SELECT | منویی با یک کادر متن. کاربران میتوانند یک یا چند مورد را تایپ و انتخاب کنند. برای افزونههای Google Workspace، باید موارد را با استفاده از یک آرایه استاتیک از اشیاء برای برنامههای گوگل چت، میتوانید موارد را با استفاده از یک منبع داده پویا پر کنید و همزمان با تایپ کاربران در منو، موارد را به صورت خودکار پیشنهاد دهید. به عنوان مثال، کاربران میتوانند شروع به تایپ نام یک فضای گوگل چت کنند و ویجت به صورت خودکار آن فضا را پیشنهاد میدهد. برای پر کردن پویای موارد برای یک منوی چند انتخابی، از یکی از انواع منابع داده زیر استفاده کنید:
برای مثالهایی از نحوه پیادهسازی منوهای چندگزینهای برای برنامههای چت، به افزودن یک منوی چندگزینهای مراجعه کنید.
|
ارسال فرم پاسخ
پاسخی به ارسال فرم به غیر از دریافت یک ظرف تکمیل خودکار، که شامل اقداماتی است که کارت باید انجام دهد و/یا برنامه میزبان افزونه باید انجام دهد، و اینکه آیا وضعیت کارت تغییر کرده است یا خیر.
برای افزونههای Google Workspace موجود است و برای برنامههای Google Chat موجود نیست. برای مثال:
{
"renderActions": {
"action": {
"notification": {
"text": "Email address is added: salam.heba@example.com"
}
},
"hostAppAction": {
"gmailAction": {
"openCreatedDraftAction": {
"draftId": "msg-a:r-79766936926021702",
"threadServerPermId": "thread-f:15700999851086004"
}
}
}
}
}
| فیلدها | |
|---|---|
renderActions | مجموعهای از دستورالعملهای رندر که به کارت میگوید عملی را انجام دهد و/یا به برنامه میزبان افزونه میگوید عملی خاص برنامه را انجام دهد. |
stateChanged | اینکه آیا وضعیت کارتها تغییر کرده است و دادههای موجود در کارتهای موجود قدیمی شدهاند یا خیر. |
schema | این یک فیلد طرحواره بدون عملیات است که ممکن است در نشانهگذاری برای بررسی نحو وجود داشته باشد. |
پیشنهادات
مقادیر پیشنهادی که کاربران میتوانند وارد کنند. این مقادیر زمانی ظاهر میشوند که کاربران درون فیلد ورودی متن کلیک کنند. همزمان با تایپ کاربران، مقادیر پیشنهادی به صورت پویا فیلتر میشوند تا با آنچه کاربران تایپ کردهاند مطابقت داشته باشند.
برای مثال، یک فیلد ورودی متن برای زبان برنامهنویسی ممکن است جاوا، جاوا اسکریپت، پایتون و ++C را پیشنهاد دهد. وقتی کاربران شروع به تایپ Jav میکنند، لیست پیشنهادات برای نمایش Java و JavaScript فیلتر میشود.
مقادیر پیشنهادی به کاربران کمک میکنند تا مقادیری را وارد کنند که برنامه شما بتواند آنها را درک کند. هنگام اشاره به جاوا اسکریپت، برخی از کاربران ممکن است javascript و برخی دیگر java script وارد کنند. پیشنهاد JavaScript میتواند نحوه تعامل کاربران با برنامه شما را استاندارد کند.
وقتی مشخص شود، TextInput.type همیشه SINGLE_LINE است، حتی اگر روی MULTIPLE_LINE تنظیم شده باشد.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| فیلدها | |
|---|---|
items[] | فهرستی از پیشنهادها که برای تکمیل خودکار توصیهها در فیلدهای ورودی متن استفاده میشوند. |
پیشنهاد
یک مقدار پیشنهادی که کاربران میتوانند در فیلد ورودی متن وارد کنند.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| فیلدها | |
|---|---|
| |
text | مقدار ورودی پیشنهادی برای یک فیلد ورودی متن. این معادل مقداری است که کاربران خودشان وارد میکنند. |
ورودی متن
فیلدی که کاربران میتوانند در آن متن وارد کنند. از پیشنهادها و اقدامات هنگام تغییر پشتیبانی میکند. از اعتبارسنجی ارسال فرم پشتیبانی میکند. وقتی Action.all_widgets_are_required روی true تنظیم شده باشد یا این ویجت در Action.required_widgets مشخص شده باشد، عملیات ارسال مسدود میشود مگر اینکه مقداری وارد شود. برای مثال در برنامههای چت گوگل، به افزودن فیلدی که کاربر بتواند در آن متن وارد کند ، مراجعه کنید.
برنامههای چت میتوانند مقدار متن وارد شده را در طول رویدادهای ورودی فرم دریافت و پردازش کنند. برای جزئیات بیشتر در مورد کار با ورودیهای فرم، به دریافت دادههای فرم مراجعه کنید.
وقتی نیاز به جمعآوری دادههای تعریفنشده یا انتزاعی از کاربران دارید، از ورودی متنی استفاده کنید. برای جمعآوری دادههای تعریفشده یا شمارششده از کاربران، از ویجت SelectionInput استفاده کنید.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| فیلدها | |
|---|---|
name | نامی که ورودی متن در رویداد ورودی فرم با آن مشخص میشود. برای جزئیات بیشتر در مورد کار با ورودیهای فرم، به بخش «دریافت دادههای فرم» مراجعه کنید. |
label | متنی که در بالای فیلد ورودی متن در رابط کاربری ظاهر میشود. متنی را مشخص کنید که به کاربر کمک کند اطلاعات مورد نیاز برنامه شما را وارد کند. برای مثال، اگر نام کسی را میپرسید، اما به طور خاص به نام خانوادگی او نیاز دارید، به جای اگر |
hintText | متنی که در زیر فیلد ورودی متن ظاهر میشود و برای کمک به کاربران با وادار کردن آنها به وارد کردن مقدار خاصی طراحی شده است. این متن همیشه قابل مشاهده است. اگر |
value | مقداری که توسط کاربر وارد شده و به عنوان بخشی از رویداد ورودی فرم برگردانده میشود. برای جزئیات بیشتر در مورد کار با ورودیهای فرم، به بخش «دریافت دادههای فرم» مراجعه کنید. |
type | نحوه نمایش یک فیلد ورودی متن در رابط کاربری. به عنوان مثال، اینکه آیا فیلد تک خطی است یا چند خطی. |
onChangeAction | وقتی تغییری در فیلد ورودی متن رخ میدهد، چه باید کرد. مثلاً کاربری متنی را به فیلد اضافه میکند یا حذف میکند. نمونههایی از اقداماتی که باید انجام شود شامل اجرای یک تابع سفارشی یا باز کردن یک کادر محاورهای در گوگل چت است. |
initialSuggestions | مقادیر پیشنهادی که کاربران میتوانند وارد کنند. این مقادیر زمانی ظاهر میشوند که کاربران درون فیلد ورودی متن کلیک کنند. همزمان با تایپ کاربران، مقادیر پیشنهادی به صورت پویا فیلتر میشوند تا با آنچه کاربران تایپ کردهاند مطابقت داشته باشند. برای مثال، یک فیلد ورودی متن برای زبان برنامهنویسی ممکن است جاوا، جاوا اسکریپت، پایتون و ++C را پیشنهاد دهد. وقتی کاربران شروع به تایپ کردن مقادیر پیشنهادی به کاربران کمک میکنند تا مقادیری را وارد کنند که برنامه شما بتواند آنها را درک کند. هنگام اشاره به جاوا اسکریپت، برخی از کاربران ممکن است وقتی مشخص شود،
|
autoCompleteAction | اختیاری. مشخص کنید وقتی فیلد ورودی متن به کاربرانی که با آن تعامل دارند پیشنهاد میدهد، چه اقدامی انجام شود. اگر مشخص نشده باشد، پیشنهادات توسط اگر مشخص شده باشد، برنامه عملی را که در اینجا مشخص شده است، مانند اجرای یک تابع سفارشی، انجام میدهد.
|
validation | اعتبارسنجی قالب ورودی لازم برای این فیلد متنی را مشخص کنید.
|
placeholderText | متنی که در فیلد ورودی متن، زمانی که فیلد خالی است، نمایش داده میشود. از این متن برای ترغیب کاربران به وارد کردن مقدار استفاده کنید. برای مثال،
|
فیلد متحد | |
hostAppDataSource | منبع دادهای که مختص برنامه میزبان Google Workspace است، مانند ایمیلهای Gmail، رویدادهای Google Calendar یا پیامهای Google Chat. برای افزونههای Google Workspace که Google Workspace Studio را توسعه میدهند، در دسترس است. برای برنامههای Google Chat در دسترس نیست. |
نوع
نحوه نمایش یک فیلد ورودی متن در رابط کاربری. برای مثال، آیا یک فیلد ورودی تک خطی است یا یک ورودی چند خطی. اگر initialSuggestions مشخص شده باشد، type همیشه SINGLE_LINE است، حتی اگر روی MULTIPLE_LINE تنظیم شده باشد.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| انومها | |
|---|---|
SINGLE_LINE | فیلد ورودی متن دارای ارتفاع ثابت یک خط است. |
MULTIPLE_LINE | فیلد ورودی متن دارای ارتفاع ثابتی معادل چندین خط است. |
متنپاراگراف
یک پاراگراف از متن که از قالببندی پشتیبانی میکند. برای مثال در برنامههای Google Chat، به افزودن یک پاراگراف از متن قالببندیشده مراجعه کنید. برای اطلاعات بیشتر در مورد قالببندی متن، به قالببندی متن در برنامههای Google Chat و افزونههای قالببندی متن در Google Workspace مراجعه کنید.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| فیلدها | |
|---|---|
text | متنی که در ابزارک نمایش داده میشود. |
maxLines | حداکثر تعداد خطوط متنی که در ویجت نمایش داده میشود. اگر متن از حداکثر تعداد خطوط مشخص شده بیشتر باشد، محتوای اضافی پشت دکمه نمایش بیشتر پنهان میشود. اگر متن برابر یا کوتاهتر از حداکثر تعداد خطوط مشخص شده باشد، دکمه نمایش بیشتر نمایش داده نمیشود. مقدار پیشفرض ۰ است، در این صورت تمام متن نمایش داده میشود. مقادیر منفی نادیده گرفته میشوند. |
textSyntax | نحو متن. اگر تنظیم نشود، متن به صورت HTML نمایش داده میشود.
|
نحو متن
سینتکسی که برای قالببندی متن استفاده میشود.
برای برنامههای Google Chat در دسترس است و برای افزونههای Google Workspace در دسترس نیست.
| انومها | |
|---|---|
TEXT_SYNTAX_UNSPECIFIED | اگر متن مشخص نشده باشد، به صورت HTML نمایش داده میشود. |
HTML | متن به صورت HTML رندر میشود. این مقدار پیشفرض است. |
MARKDOWN | متن به صورت Markdown رندر میشود. |
ماشه
نشان دهنده یک تریگر است.
برای افزونههای Google Workspace که Google Workspace Studio را توسعه میدهند، در دسترس است. برای برنامههای Google Chat در دسترس نیست.
| فیلدها | |
|---|---|
actionRuleId | شناسه منحصر به فرد ActionRule. |
اعتبارسنجی
دادههای لازم برای اعتبارسنجی ویجتی که به آن متصل شده است را نشان میدهد.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| فیلدها | |
|---|---|
characterLimit | محدودیت کاراکتر برای ویجتهای ورودی متن را مشخص کنید. توجه داشته باشید که این فقط برای ورودی متن استفاده میشود و برای سایر ویجتها نادیده گرفته میشود.
|
inputType | نوع ویجتهای ورودی را مشخص کنید.
|
نوع ورودی
نوع ویجت ورودی.
| انومها | |
|---|---|
INPUT_TYPE_UNSPECIFIED | نوع نامشخص. استفاده نکنید. |
TEXT | متن معمولی که همه کاراکترها را میپذیرد. |
INTEGER | یک مقدار عدد صحیح. |
FLOAT | یک مقدار اعشاری (float). |
EMAIL | یک آدرس ایمیل. |
EMOJI_PICKER | یک ایموجی انتخاب شده از انتخابگر ایموجی ارائه شده توسط سیستم. |
ویجت
هر کارت از ویجتهایی تشکیل شده است.
یک ویجت یک شیء مرکب است که میتواند یکی از انواع متن، تصویر، دکمه و سایر اشیاء را نمایش دهد.
| فیلدها | |
|---|---|
horizontalAlignment | مشخص میکند که آیا ویجتها در سمت چپ، راست یا مرکز یک ستون ترازبندی شوند. |
id | یک شناسه منحصر به فرد که به ویجت اختصاص داده شده و برای شناسایی ویجتی که قرار است تغییر کند، استفاده میشود. این شناسه محدودیت کاراکتری ۶۴ کاراکتر دارد و باید به شکل برای افزونههای Google Workspace که Google Workspace Studio را توسعه میدهند، در دسترس است. برای برنامههای Google Chat در دسترس نیست. |
visibility | مشخص میکند که آیا ویجت قابل مشاهده یا پنهان باشد. مقدار پیشفرض برای افزونههای Google Workspace که Google Workspace Studio را توسعه میدهند، در دسترس است. برای برنامههای Google Chat در دسترس نیست. |
eventActions[] | اقدامات رویدادی را که میتوانند روی ویجت انجام شوند، مشخص میکند. برای افزونههای Google Workspace که Google Workspace Studio را توسعه میدهند، در دسترس است. برای برنامههای Google Chat در دسترس نیست. |
data فیلد Union. یک ویجت فقط میتواند یکی از موارد زیر را داشته باشد. میتوانید از چندین فیلد ویجت برای نمایش موارد بیشتر استفاده کنید. data فقط میتوانند یکی از موارد زیر باشند: | |
textParagraph | یک پاراگراف متنی را نمایش میدهد. از متن ساده با قالببندی HTML پشتیبانی میکند. برای اطلاعات بیشتر در مورد قالببندی متن، به افزونههای قالببندی متن در برنامههای چت گوگل و قالببندی متن در افزونههای فضای کاری گوگل مراجعه کنید. برای مثال، JSON زیر یک متن پررنگ ایجاد میکند: |
image | یک تصویر را نمایش میدهد. برای مثال، JSON زیر تصویری با متن جایگزین ایجاد میکند: |
decoratedText | یک آیتم متنی تزئینشده را نمایش میدهد. برای مثال، JSON زیر یک ویجت متنی تزئینشده ایجاد میکند که آدرس ایمیل را نشان میدهد: |
buttonList | فهرستی از دکمهها. برای مثال، JSON زیر دو دکمه ایجاد میکند. اولی یک دکمه متنی آبی رنگ و دومی یک دکمه تصویری است که یک لینک را باز میکند: |
textInput | یک کادر متنی نمایش میدهد که کاربران میتوانند در آن تایپ کنند. برای مثال، JSON زیر یک ورودی متنی برای آدرس ایمیل ایجاد میکند: به عنوان مثالی دیگر، JSON زیر یک ورودی متنی برای یک زبان برنامهنویسی با پیشنهادهای ایستا ایجاد میکند: |
selectionInput | یک کنترل انتخاب را نمایش میدهد که به کاربران امکان انتخاب موارد را میدهد. کنترلهای انتخاب میتوانند کادرهای انتخاب، دکمههای رادیویی، سوئیچها یا منوهای کشویی باشند. برای مثال، JSON زیر یک منوی کشویی ایجاد میکند که به کاربران اجازه میدهد اندازه را انتخاب کنند: |
dateTimePicker | ویجتی را نمایش میدهد که به کاربران امکان میدهد تاریخ، زمان یا تاریخ و زمان را وارد کنند. برای مثال، JSON زیر یک انتخابگر تاریخ و زمان برای تعیین وقت ملاقات ایجاد میکند: |
divider | یک جداکننده خط افقی بین ابزارکها نمایش میدهد. برای مثال، JSON زیر یک جداکننده ایجاد میکند: |
grid | یک شبکه با مجموعهای از آیتمها را نمایش میدهد. یک شبکه میتواند هر تعداد ستون و آیتم را پشتیبانی کند. تعداد ردیفها با تقسیم کران بالای تعداد آیتمها بر تعداد ستونها تعیین میشود. یک شبکه با ۱۰ آیتم و ۲ ستون، ۵ ردیف دارد. یک شبکه با ۱۱ آیتم و ۲ ستون، ۶ ردیف دارد.
برای مثال، JSON زیر یک جدول دو ستونی با یک آیتم ایجاد میکند: |
columns | حداکثر ۲ ستون را نمایش میدهد. برای اضافه کردن بیش از ۲ ستون یا استفاده از ردیفها، از ویجت برای مثال، JSON زیر دو ستون ایجاد میکند که هر کدام شامل پاراگرافهای متنی هستند: |
carousel | یک carousel شامل مجموعهای از ویجتهای تو در تو است. برای مثال، این یک نمایش JSON از یک carousel است که شامل دو پاراگراف متنی است. |
chipList | فهرستی از چیپسها For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: |
HorizontalAlignment
مشخص میکند که آیا ویجتها در سمت چپ، راست یا مرکز یک ستون ترازبندی شوند.
برای برنامههای Google Chat در دسترس است و برای افزونههای Google Workspace در دسترس نیست.
| انومها | |
|---|---|
HORIZONTAL_ALIGNMENT_UNSPECIFIED | استفاده نکنید. نامشخص. |
START | Default value. Aligns widgets to the start position of the column. For left-to-right layouts, aligns to the left. For right-to-left layouts, aligns to the right. |
CENTER | Aligns widgets to the center of the column. |
END | Aligns widgets to the end position of the column. For left-to-right layouts, aligns widgets to the right. For right-to-left layouts, aligns widgets to the left. |
ImageType
شکلی که برای برش تصویر استفاده میشود.
برای برنامههای Google Chat و افزونههای Google Workspace موجود است.
| انومها | |
|---|---|
SQUARE | Default value. Applies a square mask to the image. For example, a 4x3 image becomes 3x3. |
CIRCLE | Applies a circular mask to the image. For example, a 4x3 image becomes a circle with a diameter of 3. |
ترازبندی عمودی
Represents vertical alignment attribute.
| انومها | |
|---|---|
VERTICAL_ALIGNMENT_UNSPECIFIED | Unspecified type. Do not use. |
TOP | Alignment to the top position. |
MIDDLE | Alignment to the middle position. |
BOTTOM | Alignment to the bottom position. |