Card

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

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

کارت‌ها را با «کارت‌ساز» طراحی و پیش‌نمایش کنید.

باز کردن «کارت‌ساز»

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

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

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

کارت مخاطب نمونه

برای ایجاد پیام کارتی نمونه در Google Chat، از JSON زیر استفاده کنید:

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

object (CardHeader)

سرصفحه کارت. سرایند معمولاً حاوی تصویر اصلی و عنوان است. سرصفحه‌ها همیشه در بالای کارت نشان داده می‌شوند.
sections[]

object (Section)

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

enum (DividerStyle)

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

object (CardAction)

کنش‌های کارت. کنش‌ها به منوِ نوارابزار کارت اضافه می‌شود. تا ۱۰ مورد CardAction را پشتیبانی می‌کند.

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

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

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

string

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

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

enum (DisplayStyle)

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

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

object (CardHeader)

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

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

object (ExpressionData)

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

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

CardHeader

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

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

نمایش JSON 
{
  "title": string,
  "subtitle": string,
  "imageType": enum (ImageType),
  "imageUrl": string,
  "imageAltText": string
}
فیلدها
title

string

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

string

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

enum (ImageType)

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

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

string

نشانی وب HTTPS تصویر در سرصفحه کارت.
imageAltText

string

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

بخش

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

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

نمایش JSON 
{
  "header": string,
  "widgets": [
    {
      object (Widget)
    }
  ],
  "collapsible": boolean,
  "uncollapsibleWidgetsCount": integer,
  "id": string,
  "collapseControl": {
    object (CollapseControl)
  }
}
فیلدها
header

string

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

object (Widget)

همه ابزاره‌های موجود در بخش. باید حداقل یک ابزاره داشته باشد. کارت از حداکثر ۱۰۰ ابزاره در همه بخش‌ها پشتیبانی می‌کند.
collapsible

boolean

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

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

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

integer

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

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

string

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

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

object (CollapseControl)

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

ابزاره

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

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

نمایش JSON 
{
  "horizontalAlignment": enum (HorizontalAlignment),
  "id": string,
  "visibility": enum (Visibility),
  "eventActions": [
    {
      object (EventAction)
    }
  ],

  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "decoratedText": {
    object (DecoratedText)
  },
  "buttonList": {
    object (ButtonList)
  },
  "textInput": {
    object (TextInput)
  },
  "selectionInput": {
    object (SelectionInput)
  },
  "dateTimePicker": {
    object (DateTimePicker)
  },
  "divider": {
    object (Divider)
  },
  "grid": {
    object (Grid)
  },
  "columns": {
    object (Columns)
  },
  "carousel": {
    object (Carousel)
  },
  "chipList": {
    object (ChipList)
  }
}
فیلدها
horizontalAlignment

enum (HorizontalAlignment)

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

string

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

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

enum (Visibility)

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

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

object (EventAction)

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

برای برافزاهای Google Workspace که Google Workspace Studio را گسترش می‌دهند دردسترس است. برای برنامه‌های Google Chat دردسترس نیست.
ابزاره فقط می‌تواند یکی از موارد زیر را داشته باشد. می‌توانید از چندین فیلد ابزاره برای نمایش موارد بیشتر استفاده کنید. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
textParagraph

object (TextParagraph)

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

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

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

object (Image)

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

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

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

object (DecoratedText)

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

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

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

object (ButtonList)

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

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

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

object (TextInput)

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

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

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

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

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

object (SelectionInput)

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

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

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

object (DateTimePicker)

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

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

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

object (Divider)

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

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

"divider": {
}
grid

object (Grid)

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

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

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

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

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

object (Columns)

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

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

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

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

object (Carousel)

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

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

object (ChipList)

فهرستی از تراشه‌ها.

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

"chipList": {
  "chips": [
    {
      "label": "Edit",
      "disabled": true
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}
پایان فیلدهای متقابلاً انحصاری.

TextParagraph

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

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

نمایش JSON 
{
  "text": string,
  "maxLines": integer,
  "textSyntax": enum (TextSyntax)
}
فیلدها
text

string

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

integer

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

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

enum (TextSyntax)

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

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

TextSyntax

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

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

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

تصویر

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

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

نمایش JSON 
{
  "imageUrl": string,
  "onClick": {
    object (OnClick)
  },
  "altText": string
}
فیلدها
imageUrl

string

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

برای مثال:

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

object (OnClick)

وقتی کاربر روی تصویر کلیک می‌کند، این کنش با کلیک راه‌اندازی می‌شود.
altText

string

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

DecoratedText

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

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

نمایش JSON 
{
  "icon": {
    object (Icon)
  },
  "startIcon": {
    object (Icon)
  },
  "startIconVerticalAlignment": enum (VerticalAlignment),
  "topLabel": string,
  "topLabelText": {
    object (TextParagraph)
  },
  "text": string,
  "contentText": {
    object (TextParagraph)
  },
  "wrapText": boolean,
  "bottomLabel": string,
  "bottomLabelText": {
    object (TextParagraph)
  },
  "onClick": {
    object (OnClick)
  },

  "button": {
    object (Button)
  },
  "switchControl": {
    object (SwitchControl)
  },
  "endIcon": {
    object (Icon)
  }
}
فیلدها
icon
(deprecated)

object (Icon)

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

object (Icon)

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

enum (VerticalAlignment)

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

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

string

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

object (TextParagraph)

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

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

string

الزامی. نوشتار اصلی.

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

object (TextParagraph)

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

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

boolean

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

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

string

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

object (TextParagraph)

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

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

object (OnClick)

این کنش زمانی راه‌اندازی می‌شود که کاربران روی هرجایی از ابزاره DecoratedText (ازجمله text، topLabel، bottomLabel، و نمادها) کلیک کنند، به‌جز زمانی که روی کنترل تعاملی جداگانه‌ای (button یا switchControl) کلیک کنند.
دکمه، کلید، چارگوش انتخاب، یا تصویری که در سمت راست نوشتار در ابزاره decoratedText نشان داده می‌شود. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
button

object (Button)

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

object (SwitchControl)

ابزاره کلیدی که کاربر می‌تواند با کلیک کردن روی آن، وضعیتش را تغییر دهد و کنشی را راه‌اندازی کند.
endIcon

object (Icon)

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

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

VerticalAlignment

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

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

SwitchControl

یا کلید سبک ضامن یا چارگوش انتخاب در ابزارک decoratedText.

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

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

نمایش JSON 
{
  "name": string,
  "value": string,
  "selected": boolean,
  "onChangeAction": {
    object (Action)
  },
  "controlType": enum (ControlType)
}
فیلدها
name

string

نامی که با آن ابزاره کلید در رویداد ورودی فرم شناسایی می‌شود (به‌عنوان کلید در CommonEventObject.form_inputs).

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

string

مقداری که درصورت انتخاب کلید در CommonEventObject.form_inputs[name].string_inputs برگردانده می‌شود (selected برابر با true است). اگر selected برابر با true باشد و value تنظیم نشده باشد، رشته خالی ("") در stringInputs.value برگردانده می‌شود. وقتی selected برابر با false است، این مقدار از stringInputs.value حذف می‌شود.

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

boolean

وقتی true، کلید انتخاب می‌شود و value آن در CommonEventObject.form_inputs[name].string_inputs.value گنجانده می‌شود.
onChangeAction

object (Action)

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

enum (ControlType)

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

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

ControlType

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

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

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

TextInput

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

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

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

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

نمایش JSON 
{
  "name": string,
  "label": string,
  "hintText": string,
  "value": string,
  "type": enum (Type),
  "onChangeAction": {
    object (Action)
  },
  "initialSuggestions": {
    object (Suggestions)
  },
  "autoCompleteAction": {
    object (Action)
  },
  "validation": {
    object (Validation)
  },
  "placeholderText": string,

  "hostAppDataSource": {
    object (HostAppDataSourceMarkup)
  }
}
فیلدها
name

string

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

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

string

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

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

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

string

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

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

string

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

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

enum (Type)

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

object (Action)

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

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

object (Suggestions)

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

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

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

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

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

object (Action)

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

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

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

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

object (Validation)

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

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

string

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

برای برنامه‌های Google Chat دردسترس است و برای برافزاهای Google Workspace دردسترس نیست.
در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
hostAppDataSource

object (HostAppDataSourceMarkup)

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

برای برافزاهای Google Workspace که Google Workspace Studio را گسترش می‌دهند دردسترس است. برای برنامه‌های Google Chat دردسترس نیست.
پایان فیلدهای متقابلاً انحصاری.

نوع

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

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

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

RenderActions

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

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

فیلدها
action

Action

کنش

فیلدها
navigations[]

Navigation

کارت را اضافه، حذف، یا به‌روز می‌کند.

برافزاها در Google Chat.

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

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

navigations: {
  pushCard: CARD
}

کارت بالایی را با کارت جدیدی جایگزین کنید. برای برنامه‌های Chat، فقط برای صفحه اصلی برنامه دردسترس است.

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

navigations: {
  updateCard: CARD
}

پیشنهادها

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

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

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

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

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

نمایش JSON 
{
  "items": [
    {
      object (SuggestionItem)
    }
  ]
}
فیلدها
items[]

object (SuggestionItem)

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

SuggestionItem

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

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

نمایش JSON 
{

  "text": string
}
فیلدها
در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
text

string

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

اعتبارسنجی

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

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

نمایش JSON 
{
  "characterLimit": integer,
  "inputType": enum (InputType)
}
فیلدها
characterLimit

integer

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

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

enum (InputType)

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

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

InputType

نوع ابزارک ورودی.

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

HostAppDataSourceMarkup

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

نمایش JSON 
{

  "chatDataSource": {
    object (ChatClientDataSourceMarkup)
  },
  "workflowDataSource": {
    object (WorkflowDataSourceMarkup)
  }
}
فیلدها
برنامه Google Workspace که موارد دردسترس را برای ابزاره پر می‌کند. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
chatDataSource

object (ChatClientDataSourceMarkup)

منبع داده‌ای از Google Chat.
workflowDataSource

object (WorkflowDataSourceMarkup)

منبع داده‌ای از Google Workflow.
پایان فیلدهای متقابلاً انحصاری.

ChatClientDataSourceMarkup

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

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

نمایش JSON 
{

  "spaceDataSource": {
    object (SpaceDataSource)
  }
}
فیلدها
منبع داده Google Chat. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
spaceDataSource

object (SpaceDataSource)

فضاهای Google Chat که کاربر عضو آن‌ها است.
پایان فیلدهای متقابلاً انحصاری.

SpaceDataSource

منبع داده‌ای که فضاهای Google Chat را به‌عنوان موارد انتخابی برای منو چندانتخابی پر می‌کند. فقط فضاهایی را که کاربر عضو آن‌ها است پر می‌کند.

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

نمایش JSON 
{
  "defaultToCurrentSpace": boolean
}
فیلدها
defaultToCurrentSpace

boolean

اگر روی true تنظیم شود، منو چندانتخابی به‌طور پیش‌فرض فضای Google Chat فعلی را به‌عنوان یک مورد انتخاب می‌کند.

WorkflowDataSourceMarkup

* فقط توسط «جریان کار Google Workspace» پشتیبانی می‌شود، اما توسط برنامه‌های Google Chat یا برافزاهای Google Workspace پشتیبانی نمی‌شود.

In a TextInput or SelectionInput widget with MULTI_SELECT type or a DateTimePicker, provide data source from Google.

نمایش JSON 
{
  "includeVariables": boolean,
  "type": enum (Type)
}
فیلدها
includeVariables

boolean

اینکه متغیرهای مرحله قبلی در منبع داده گنجانده شود یا نه.
type

enum (Type)

نوع منبع داده.

نوع

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

شمارشی‌ها
UNKNOWN مقدار پیش‌فرض. استفاده نشود.
USER کاربران Google Workspace. کاربر فقط می‌تواند کاربران سازمان Google Workspace خود را مشاهده و انتخاب کند.
SPACE فضاهای Google Chat که کاربر عضو آن‌ها است.
USER_WITH_FREE_FORM کاربران می‌توانند انتخاب کنند که اعضای موجود را از سازمان Google Workspace خود مشاهده و انتخاب کنند یا به‌صورت دستی نشانی ایمیل یا دامنه معتبری را وارد کنند.

SelectionInput

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

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

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

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

نمایش JSON 
{
  "name": string,
  "label": string,
  "type": enum (SelectionType),
  "items": [
    {
      object (SelectionItem)
    }
  ],
  "onChangeAction": {
    object (Action)
  },
  "multiSelectMinQueryLength": integer,
  "dataSourceConfigs": [
    {
      object (DataSourceConfig)
    }
  ],
  "multiSelectMaxSelectedItems": integer,
  "hintText": string,

  "externalDataSource": {
    object (Action)
  },
  "platformDataSource": {
    object (PlatformDataSource)
  }
}
فیلدها
name

string

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

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

string

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

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

enum (SelectionType)

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

object (SelectionItem)

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

object (Action)

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

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

integer

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

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

  • اگر منو از آرایه ثابتی از SelectionInput مورد استفاده می‌کند، به‌طور پیش‌فرض ۰ نویسه دارد و فوراً موارد را از آرایه پر می‌کند.
  • اگر منو از منبع داده پویا (multi_select_data_source) استفاده می‌کند، پیش‌فرض ۳ نویسه است تا منبع داده را برای برگرداندن موارد پیشنهادی پُرسمان کند.
dataSourceConfigs[]

object (DataSourceConfig)

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

درصورت مشخص شدن، فیلد multiSelectMaxSelectedItems، فیلد multiSelectMinQueryLength، فیلد externalDataSource، و فیلد platformDataSource نادیده گرفته می‌شوند.

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

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

integer

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

string

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

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

برای منو چندانتخابی، منبع داده‌ای که به‌طور پویا موارد انتخاب را پر می‌کند.

برای برنامه‌های Google Chat دردسترس است و برای برافزاهای Google Workspace دردسترس نیست. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
externalDataSource

object (Action)

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

object (PlatformDataSource)

منبع داده‌ای از Google Workspace.
پایان فیلدهای متقابلاً انحصاری.

SelectionType

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PlatformDataSource

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

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

نمایش JSON 
{

  "commonDataSource": enum (CommonDataSource),
  "hostAppDataSource": {
    object (HostAppDataSourceMarkup)
  }
}
فیلدها
منبع داده. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
commonDataSource

enum (CommonDataSource)

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

object (HostAppDataSourceMarkup)

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

این فیلد از «کتابخانه‌های کارخواه Google API» پشتیبانی می‌کند اما در «کتابخانه‌های کارخواه Cloud» دردسترس نیست. برای کسب اطلاعات بیشتر، به نصب کتابخانه‌های کارخواه مراجعه کنید.
پایان فیلدهای متقابلاً انحصاری.

CommonDataSource

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

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

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

DataSourceConfig

شیء پیکربندی که به پیکربندی منابع داده برای ابزاره کمک می‌کند.

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

نمایش JSON 
{

  "remoteDataSource": {
    object (Action)
  },
  "platformDataSource": {
    object (PlatformDataSource)
  }
  "minCharactersTrigger": integer
}
فیلدها
منبع داده. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
remoteDataSource

object (Action)

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

object (PlatformDataSource)

داده‌ها از برنامه Google Workspace است.
پایان فیلدهای متقابلاً انحصاری.
minCharactersTrigger

integer

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

DateTimePicker

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

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

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

نمایش JSON 
{
  "name": string,
  "label": string,
  "type": enum (DateTimePickerType),
  "valueMsEpoch": string,
  "timezoneOffsetDate": integer,
  "onChangeAction": {
    object (Action)
  },

  "hostAppDataSource": {
    object (HostAppDataSourceMarkup)
  }
}
فیلدها
name

string

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

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

string

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

enum (DateTimePickerType)

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

string (int64 format)

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

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

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

integer

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

توجه: این فیلد برحسب دقیقه است، درحالی‌که بار داده رویداد تعامل کاربر معمولاً اختلاف منطقه زمانی را برحسب میلی‌ثانیه ارائه می‌دهد (برای تبدیل، بر 60000 تقسیم کنید).
onChangeAction

object (Action)

وقتی کاربر روی ذخیره یا پاک کردن در میانای DateTimePicker کلیک می‌کند، راه‌اندازی می‌شود.
منبع داده مشخص‌شده برای نشان دادن تاریخ و ساعت. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
hostAppDataSource

object (HostAppDataSourceMarkup)

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

برای برافزاهای Google Workspace که Google Workspace Studio را گسترش می‌دهند دردسترس است. برای برنامه‌های Google Chat دردسترس نیست.
پایان فیلدهای متقابلاً انحصاری.

DateTimePickerType

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

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

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

تقسیم‌کننده

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

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

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

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

"divider": {}

شناسه عرضه جهانی (GRid)

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

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

برای برنامه‌های 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"
    }
  }
}
نمایش JSON 
{
  "title": string,
  "items": [
    {
      object (GridItem)
    }
  ],
  "borderStyle": {
    object (BorderStyle)
  },
  "columnCount": integer,
  "onClick": {
    object (OnClick)
  }
}
فیلدها
title

string

نوشتاری که در سرصفحه شبکه نمایش داده می‌شود.
items[]

object (GridItem)

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

object (BorderStyle)

سبک حاشیه برای اعمال بر هر مورد جدول.
columnCount

integer

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

object (OnClick)

این فراخوانی برگشتی توسط هریک از موارد جدول به‌طور جداگانه استفاده می‌شود، اما شناسه مورد به پارامترهای فراخوانی برگشتی (تحت کلید "grid_item_identifier") اضافه می‌شود.

GridItem

نشان‌دهنده موردی در چیدمان شبکه‌ای است. موارد می‌توانند حاوی نوشتار، تصویر، یا نوشتار و تصویر باشند.

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

نمایش JSON 
{
  "id": string,
  "image": {
    object (ImageComponent)
  },
  "title": string,
  "subtitle": string,
  "layout": enum (GridItemLayout)
}
فیلدها
id

string

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

object (ImageComponent)

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

string

عنوان مورد شبکه.
subtitle

string

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

enum (GridItemLayout)

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

ImageComponent

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

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

نمایش JSON 
{
  "imageUri": string,
  "altText": string,
  "cropStyle": {
    object (ImageCropStyle)
  },
  "borderStyle": {
    object (BorderStyle)
  }
}
فیلدها
imageUri

string

نشانی وب تصویر.
altText

string

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

object (ImageCropStyle)

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

object (BorderStyle)

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

ImageCropStyle

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

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

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

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}
نمایش JSON 
{
  "type": enum (ImageCropType),
  "aspectRatio": number
}
فیلدها
type

enum (ImageCropType)

نوع محصول.
aspectRatio

number

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

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

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

ImageCropType

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

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

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

BorderStyle

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

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

نمایش JSON 
{
  "type": enum (BorderType),
  "strokeColor": {
    object (Color)
  },
  "cornerRadius": integer
}
فیلدها
type

enum (BorderType)

نوع حاشیه.
strokeColor

object (Color)

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

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

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

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

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

integer

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

BorderType

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

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

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

GridItemLayout

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

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

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

ستون‌ها

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

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

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

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

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

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

  • کادر گفتگویی که وقتی کاربران برافزا را از پیش‌نویس ایمیل باز می‌کنند نمایش داده می‌شود.
  • کادر گفتگویی که وقتی کاربران برافزا را از منو افزودن پیوست در رویداد «تقویم Google» باز می‌کنند نمایش داده می‌شود.
نمایش JSON 
{
  "columnItems": [
    {
      object (Column)
    }
  ]
}
فیلدها
columnItems[]

object (Column)

آرایه‌ای از ستون‌ها. می‌توانید حداکثر ۲ ستون در کارت یا کادر گفتگو اضافه کنید.

ستون

یک ستون.

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

نمایش JSON 
{
  "horizontalSizeStyle": enum (HorizontalSizeStyle),
  "horizontalAlignment": enum (HorizontalAlignment),
  "verticalAlignment": enum (VerticalAlignment),
  "widgets": [
    {
      object (Widgets)
    }
  ]
}
فیلدها
horizontalSizeStyle

enum (HorizontalSizeStyle)

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

enum (HorizontalAlignment)

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

enum (VerticalAlignment)

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

object (Widgets)

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

HorizontalSizeStyle

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

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

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

HorizontalAlignment

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

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

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

VerticalAlignment

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

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

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

ابزاره‌ها

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

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

نمایش JSON 
{

  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "decoratedText": {
    object (DecoratedText)
  },
  "buttonList": {
    object (ButtonList)
  },
  "textInput": {
    object (TextInput)
  },
  "selectionInput": {
    object (SelectionInput)
  },
  "dateTimePicker": {
    object (DateTimePicker)
  },
  "chipList": {
    object (ChipList)
  }
}
فیلدها
در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
textParagraph

object (TextParagraph)

ابزاره TextParagraph.
image

object (Image)

ابزاره Image.
decoratedText

object (DecoratedText)

ابزاره DecoratedText.
buttonList

object (ButtonList)

ابزاره ButtonList.
textInput

object (TextInput)

ابزاره TextInput.
selectionInput

object (SelectionInput)

ابزاره SelectionInput.
dateTimePicker

object (DateTimePicker)

ابزاره DateTimePicker.
chipList

object (ChipList)

ابزاره ChipList.
پایان فیلدهای متقابلاً انحصاری.

ChipList

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

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

نمایش JSON 
{
  "layout": enum (Layout),
  "chips": [
    {
      object (Chip)
    }
  ]
}
فیلدها
layout

enum (Layout)

چیدمان فهرست تراشه مشخص‌شده.
chips[]

object (Chip)

آرایه‌ای از تراشه‌ها.

چیدمان

چیدمان فهرست تراشه.

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

تراشه

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

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

نمایش JSON 
{
  "icon": {
    object (Icon)
  },
  "label": string,
  "onClick": {
    object (OnClick)
  },
  "enabled": boolean,
  "disabled": boolean,
  "altText": string
}
فیلدها
icon

object (Icon)

تصویر نماد. اگر هم icon و هم label تنظیم شده باشد، نماد قبل‌از برچسب نشان داده می‌شود.
label

string

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

object (OnClick)

اختیاری. کنشی که وقتی کاربر روی تراشه کلیک می‌کند انجام می‌شود، مثل باز کردن اَبَرپیوند یا اجرای تابع سفارشی.
enabled
(deprecated)

boolean

منسوخ‌شده: درعوض از disabled استفاده کنید.

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

boolean

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

string

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

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

CarouselCard

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

نمایش JSON 
{
  "widgets": [
    {
      object (NestedWidget)
    }
  ],
  "footerWidgets": [
    {
      object (NestedWidget)
    }
  ]
}
فیلدها
widgets[]

object (NestedWidget)

فهرستی از ابزارک‌های نمایش‌داده‌شده در کارت گردونه. ابزاره‌ها به ترتیبی که مشخص شده‌اند نمایش داده می‌شوند.
footerWidgets[]

object (NestedWidget)

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

NestedWidget

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

نمایش JSON 
{

  "textParagraph": {
    object (TextParagraph)
  },
  "buttonList": {
    object (ButtonList)
  },
  "image": {
    object (Image)
  }
}
فیلدها
در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
textParagraph

object (TextParagraph)

ابزاره پاراگراف نوشتاری.
buttonList

object (ButtonList)

ابزاره فهرست دکمه.
image

object (Image)

ابزاره تصویر.
پایان فیلدهای متقابلاً انحصاری.

نمایان بودن

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

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

شمارشی‌ها
VISIBILITY_UNSPECIFIED رؤیت‌پذیری نامشخص. استفاده نکنید.
VISIBLE عنصر میانای کاربر رؤیت‌پذیر است.
HIDDEN عنصر میانای کاربر پنهان است.

EventAction

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

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

نمایش JSON 
{
  "actionRuleId": string,
  "postEventTriggers": [
    {
      object (Trigger)
    }
  ],

  "commonWidgetAction": {
    object (CommonWidgetAction)
  }
}
فیلدها
actionRuleId

string

شناسه یکتای ActionRule.
postEventTriggers[]

object (Trigger)

فهرست راه‌اندازهایی که پس‌از اجرای EventAction راه‌اندازی خواهند شد.
کنشی که باید انجام شود. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
commonWidgetAction

object (CommonWidgetAction)

کنش ابزاره رایج.
پایان فیلدهای متقابلاً انحصاری.

راه‌انداز

نشان‌دهنده راه‌انداز است.

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

نمایش JSON 
{
  "actionRuleId": string
}
فیلدها
actionRuleId

string

شناسه یکتای ActionRule.

CommonWidgetAction

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

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

نمایش JSON 
{

  "updateVisibilityAction": {
    object (UpdateVisibilityAction)
  }
}
فیلدها
کنشی که باید انجام شود. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
updateVisibilityAction

object (UpdateVisibilityAction)

کنش به‌روزرسانی رؤیت‌پذیری ابزاره.
پایان فیلدهای متقابلاً انحصاری.

UpdateVisibilityAction

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

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

نمایش JSON 
{
  "visibility": enum (Visibility)
}
فیلدها
visibility

enum (Visibility)

رؤیت‌پذیری جدید.

CollapseControl

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

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

نمایش JSON 
{
  "horizontalAlignment": enum (HorizontalAlignment),
  "expandButton": {
    object (Button)
  },
  "collapseButton": {
    object (Button)
  }
}
فیلدها
horizontalAlignment

enum (HorizontalAlignment)

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

object (Button)

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

object (Button)

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

DividerStyle

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

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

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

CardAction

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

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

نمایش JSON 
{
  "actionLabel": string,
  "onClick": {
    object (OnClick)
  }
}
فیلدها
actionLabel

string

برچسبی که به‌عنوان مورد منوِ کنش‌ها نمایش داده می‌شود.
onClick

object (OnClick)

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

CardFixedFooter

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

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

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

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

نمایش JSON 
{
  "primaryButton": {
    object (Button)
  },
  "secondaryButton": {
    object (Button)
  }
}
فیلدها
primaryButton

object (Button)

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

object (Button)

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

DisplayStyle

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

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

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

ExpressionData

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

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

نمایش JSON 
{
  "id": string,
  "expression": string,
  "conditions": [
    {
      object (Condition)
    }
  ],
  "eventActions": [
    {
      object (EventAction)
    }
  ]
}
فیلدها
id

string

شناسه یکتای ExpressionData.
expression

string

عبارت کامپایل‌نشده.
conditions[]

object (Condition)

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

object (EventAction)

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

شرایط

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

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

نمایش JSON 
{
  "actionRuleId": string,

  "expressionDataCondition": {
    object (ExpressionDataCondition)
  }
}
فیلدها
actionRuleId

string

شناسه یکتای ActionRule.
شرایط. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
expressionDataCondition

object (ExpressionDataCondition)

شرطی که با داده‌های عبارت تعیین می‌شود.
پایان فیلدهای متقابلاً انحصاری.

ExpressionDataCondition

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

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

نمایش JSON 
{
  "conditionType": enum (ConditionType)
}
فیلدها
conditionType

enum (ConditionType)

نوع شرط.

ConditionType

نوع شرط.

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