Cards v2

object ( CardHeader )

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

object ( Section )

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

enum ( DividerStyle )

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

object ( CardAction )

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

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

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

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

string

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

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

object ( CardFixedFooter )

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

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

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

enum ( DisplayStyle )

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

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

object ( CardHeader )

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

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

string

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

string

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

enum ( ImageType )

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

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

string

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

string

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

string

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

object ( Widget )

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

boolean

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

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

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

integer

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

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

object ( CollapseControl )

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

enum ( HorizontalAlignment )

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

object ( TextParagraph )

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

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

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

object ( Image )

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

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

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

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

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

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

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

object ( DateTimePicker )

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

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

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

object ( Divider )

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

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

"divider": {
}

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

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

object ( Carousel )

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

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

object ( ChipList )

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

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

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

string

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

integer

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

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

enum ( TextSyntax )

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

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

string

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

برای مثال:

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

object ( OnClick )

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

string

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

object ( Action )

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

object ( OpenLink )

اگر مشخص شده باشد، این onClick یک عمل باز کردن لینک را فعال می‌کند.

object ( Action )

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

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

object ( Card )

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

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

object ( OverflowMenu )

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

string

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

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

object ( ActionParameter )

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

enum ( LoadIndicator )

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

boolean

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

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

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

enum ( Interaction )

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

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

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

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

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

string

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

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

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

boolean

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

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

string

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

string

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

string

آدرس اینترنتی (URL) برای باز کردن.

enum ( OpenAs )

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

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

enum ( OnClose )

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

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

object ( OverflowMenuItem )

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

object ( Icon )

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

string

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

object ( OnClick )

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

boolean

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

string

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

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

enum ( ImageType )

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

string

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

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

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

string

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

برای مثال:

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

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

object ( MaterialIcon )

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

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

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

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

string

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

boolean

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

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

integer

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

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

integer

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

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

object ( Icon )

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

object ( Icon )

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

enum ( VerticalAlignment )

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

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

string

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

object ( TextParagraph )

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

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

string

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

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

object ( TextParagraph )

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

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

boolean

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

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

string

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

object ( TextParagraph )

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

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

object ( OnClick )

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

object ( Button )

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

object ( SwitchControl )

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

object ( Icon )

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

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

string

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

object ( Icon )

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

object ( Color )

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

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

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

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

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

object ( OnClick )

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

boolean

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

string

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

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

enum ( Type )

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

number

مقدار قرمزی در رنگ به عنوان مقداری در بازه [0، 1].

number

مقدار رنگ سبز در رنگ به عنوان مقداری در بازه [0، 1].

number

مقدار آبی در رنگ به عنوان مقداری در بازه [0، 1].

number

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

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

این بدان معناست که مقدار ۱.۰ مربوط به یک رنگ ثابت است، در حالی که مقدار ۰.۰ مربوط به یک رنگ کاملاً شفاف است. این روش به جای یک عدد اعشاری ساده، از یک پیام پوششی استفاده می‌کند تا بتوان بین مقدار پیش‌فرض و مقداری که تنظیم نشده است، تمایز قائل شد. در صورت حذف، این شیء رنگ به صورت یک رنگ ثابت رندر می‌شود (گویی به مقدار آلفا به صراحت مقدار ۱.۰ داده شده است).

string

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

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

string

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

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

boolean

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

object ( Action )

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

enum ( ControlType )

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

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

object ( Button )

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

string

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

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

string

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

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

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

string

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

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

string

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

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

enum ( Type )

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

object ( Action )

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

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

object ( Suggestions )

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

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

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

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

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

object ( Action )

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

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

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

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

object ( Validation )

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

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

string

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

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

Action

Navigation

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

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

Card

Pushes a card onto the card stack.

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

Card

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

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

object ( SuggestionItem )

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

string

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

integer

Specify the character limit for text input widgets. Note that this is only used for text input and is ignored for other widgets.

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

enum ( InputType )

Specify the type of the input widgets.

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

string

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

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

string

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

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

enum ( SelectionType )

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

object ( SelectionItem )

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

object ( Action )

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

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

integer

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

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

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

integer

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

object ( Action )

An external data source, such as a relational database.

object ( PlatformDataSource )

A data source from Google Workspace.

string

The text that identifies or describes the item to users.

string

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

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

boolean

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

string

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

string

enum ( CommonDataSource )

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

object ( HostAppDataSourceMarkup )

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

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

object ( ChatClientDataSourceMarkup )

A data source from Google Chat.

object ( SpaceDataSource )

Google Chat spaces that the user is a member of.

boolean

If set to true , the multiselect menu selects the current Google Chat space as an item by default.

string

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

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

string

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

enum ( DateTimePickerType )

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

string ( int64 format)

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

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

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

integer

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

object ( Action )

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

string

The text that displays in the grid header.

object ( GridItem )

The items to display in the grid.

object ( BorderStyle )

The border style to apply to each grid item.

integer

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

object ( OnClick )

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

string

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

object ( ImageComponent )

The image that displays in the grid item.

string

The grid item's title.

string

The grid item's subtitle.

enum ( GridItemLayout )

The layout to use for the grid item.

string

The image URL.

string

The accessibility label for the image.

object ( ImageCropStyle )

The crop style to apply to the image.

object ( BorderStyle )

The border style to apply to the image.

enum ( ImageCropType )

The crop type.

number

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

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

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

enum ( BorderType )

The border type.

object ( Color )

The colors to use when the type is BORDER_TYPE_STROKE .

To set the stroke color, specify a value for the red , green , and blue fields. The value must be a float number between 0 and 1 based on the RGB color value, where 0 (0/255) represents the absence of color and 1 (255/255) represents the maximum intensity of the color.

For example, the following sets the color to red at its maximum intensity:

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

The alpha field is unavailable for stroke color. If specified, this field is ignored.

integer

The corner radius for the border.

object ( Column )

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

enum ( HorizontalSizeStyle )

Specifies how a column fills the width of the card.

enum ( HorizontalAlignment )

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

enum ( VerticalAlignment )

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

object ( Widgets )

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

object ( TextParagraph )

TextParagraph widget.

object ( Image )

Image widget.

object ( DecoratedText )

DecoratedText widget.

object ( ButtonList )

ButtonList widget.

object ( TextInput )

TextInput widget.

object ( SelectionInput )

SelectionInput widget.

object ( DateTimePicker )

DateTimePicker widget.

object ( ChipList )

ChipList widget.

enum ( Layout )

Specified chip list layout.

object ( Chip )

An array of chips.

object ( Icon )

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

string

The text displayed inside the chip.

object ( OnClick )

Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function.

boolean

Whether the chip is in an active state and responds to user actions. Defaults to true . Deprecated. Use disabled instead.

boolean

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

string

The alternative text that's used for accessibility.

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

object ( CarouselCard )

A list of cards included in the carousel.

object ( NestedWidget )

A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified.

object ( NestedWidget )

A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified.

object ( TextParagraph )

A text paragraph widget.

object ( ButtonList )

A button list widget.

object ( Image )

An image widget.

enum ( HorizontalAlignment )

The horizontal alignment of the expand and collapse button.

object ( Button )

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

object ( Button )

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

string

The label that displays as the action menu item.

object ( OnClick )

The onClick action for this action item.

object ( Button )

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

object ( Button )

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