Package google.apps.card.v1

شاخص

اقدام

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

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

فیلدها
function

string

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

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

parameters[]

ActionParameter

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

load Indicator

LoadIndicator

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

persist Values

bool

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

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

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

interaction

Interaction

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

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

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

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

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

required Widgets[]

string

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

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

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

all Widgets Are Required

bool

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

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

ActionParameter

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

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

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

فیلدها
key

string

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

value

string

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

تعامل

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

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

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

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

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

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

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

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

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

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

LoadIndicator

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

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

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

BorderStyle

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

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

فیلدها
type

BorderType

نوع حاشیه.

stroke Color

Color

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

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

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

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

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

corner Radius

int32

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

نوع مرزی

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

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

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

دکمه

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

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

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

فیلدها
text

string

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

icon

Icon

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

color

Color

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

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

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

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

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

on Click

OnClick

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

disabled

bool

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

alt Text

string

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

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

type

Type

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

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

تایپ کنید

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

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

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

ButtonList

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

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

فیلدها
buttons[]

Button

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

کارت

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

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

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

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

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

توجه: شما می توانید تا 100 ویجت در هر کارت اضافه کنید. هر ویجت فراتر از این حد نادیده گرفته می شود. این محدودیت هم برای پیام‌ها و گفتگوهای کارت در برنامه‌های چت Google و هم برای کارت‌های موجود در افزونه‌های 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"
                             }
                           ]
                         }
                       }
                     }
                   ]
                 }
               }
             ]
           }
         ]
       }
    }
  ]
}
فیلدها
header

CardHeader

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

sections[]

Section

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

section Divider Style

DividerStyle

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

card Actions[]

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 در دسترس نیست.

fixed Footer

CardFixedFooter

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

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

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

display Style

DisplayStyle

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

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

peek Card Header

CardHeader

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

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

CardAction

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

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

فیلدها
action Label

string

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

on Click

OnClick

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

CardFixedFooter

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

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

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

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

فیلدها
primary Button

Button

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

secondary Button

Button

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

سربرگ کارت

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

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

فیلدها
title

string

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

subtitle

string

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

image Type

ImageType

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

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

image Url

string

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

image Alt Text

string

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

DisplayStyle

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

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

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

DividerStyle

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

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

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

NestedWidget

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

فیلدها

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

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

text Paragraph

TextParagraph

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

button List

ButtonList

ویجت فهرست دکمه.

image

Image

ویجت تصویر

بخش

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

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

فیلدها
header

string

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

widgets[]

Widget

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

collapsible

bool

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

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

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

uncollapsible Widgets Count

int32

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

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

collapse Control

CollapseControl

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

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

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

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

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

فیلدها
carousel Cards[]

CarouselCard

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

CarouselCard

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

فیلدها
widgets[]

NestedWidget

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

footer Widgets[]

NestedWidget

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

تراشه

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

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

فیلدها
icon

Icon

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

label

string

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

on Click

OnClick

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

enabled
(deprecated)

bool

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

disabled

bool

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

alt Text

string

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

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

ChipList

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

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

فیلدها
layout

Layout

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

chips[]

Chip

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

طرح بندی

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

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

CollapseControl

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

فیلدها
horizontal Alignment

HorizontalAlignment

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

expand Button

Button

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

collapse Button

Button

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

ستون ها

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

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

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

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

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

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

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

Column

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

ستون

یک ستون

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

فیلدها
horizontal Size Style

HorizontalSizeStyle

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

horizontal Alignment

HorizontalAlignment

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

vertical Alignment

VerticalAlignment

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

widgets[]

Widgets

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

HorizontalSizeStyle

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

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

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

تراز عمودی

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

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

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

ابزارک ها

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

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

فیلدها

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

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

text Paragraph

TextParagraph

ویجت TextParagraph .

image

Image

ویجت Image

decorated Text

DecoratedText

ویجت DecoratedText .

button List

ButtonList

ویجت ButtonList .

text Input

TextInput

ویجت TextInput

selection Input

SelectionInput

ویجت SelectionInput .

date Time Picker

DateTimePicker

ویجت DateTimePicker .

chip List

ChipList

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

DataActions

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

فیلدها
host App Data Action

HostAppDataActionMarkup

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

DateTimePicker

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

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

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

فیلدها
name

string

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

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

label

string

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

type

DateTimePickerType

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

value Ms Epoch

int64

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

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

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

int32

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

on Change Action

Action

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

validation

Validation

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

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

DateTimePickerType

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

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

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

متن تزئین شده

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

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

فیلدها
icon
(deprecated)

Icon

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

start Icon

Icon

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

top Label

string

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

text

string

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

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

wrap Text

bool

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

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

bottom Label

string

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

on Click

OnClick

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

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

Button

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

switch Control

SwitchControl

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

end Icon

Icon

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

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

SwitchControl

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

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

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

فیلدها
name

string

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

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

value

string

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

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

selected

bool

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

on Change Action

Action

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

control Type

ControlType

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

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

نوع کنترل

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

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

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

تقسیم کننده

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

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

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

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

"divider": {}

EndNavigation

برای افزونه‌ها در Google Chat ، یک گفتگو را می‌بندد.

فیلدها
action

Action

برای افزونه‌ها در Google Chat ، اقدامی که یک گفتگو را می‌بندد.

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

اقدام

برای افزونه‌ها در Google Chat ، اقدامات مربوط به EndNavigation .

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

GetAutocompletionResponse

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

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

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

Suggestions

schema

string

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

شبکه

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

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

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

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

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

string

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

items[]

GridItem

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

border Style

BorderStyle

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

column Count

int32

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

on Click

OnClick

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

GridItem

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

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

فیلدها
id

string

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

image

ImageComponent

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

title

string

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

subtitle

string

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

layout

GridItemLayout

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

GridItemLayout

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

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

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

نماد

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

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

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

فیلدها
alt Text

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 نماد نادیده گرفته می‌شود.

image Type

ImageType

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

icons فیلد اتحادیه نماد نمایش داده شده در ویجت روی کارت. icons فقط می توانند یکی از موارد زیر باشند:
known Icon

string

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

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

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

icon Url

string

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

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

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

انواع فایل های پشتیبانی شده عبارتند از .png و .jpg .

material Icon

MaterialIcon

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

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

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

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

تصویر

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

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

فیلدها
image Url

string

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

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

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

OnClick

وقتی کاربر روی تصویر کلیک می کند، کلیک این عمل را آغاز می کند.

alt Text

string

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

ImageComponent

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

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

فیلدها
image Uri

string

آدرس تصویر.

alt Text

string

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

crop Style

ImageCropStyle

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

border Style

BorderStyle

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

ImageCropStyle

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

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

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

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

ImageCropType

نوع محصول

aspect Ratio

double

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

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

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

ImageCropType

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

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

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

پیش نمایش لینک

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

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

به عنوان مثال ، JSON زیر یک عنوان منحصر به فرد برای پیش نمایش لینک و تراشه هوشمند آن ، و کارت پیش نمایش با هدر و توضیحات متن را برمی گرداند:

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

مثال پیش نمایش لینک زیر را برمی گرداند:

پیش نمایش لینک مثال

فیلدها
preview Card

Card

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

title

string

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

link Preview Title

string

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

مادی

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

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

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

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

فیلدها
name

string

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

fill

bool

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

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

weight

int32

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

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

grade

int32

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

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

کارتن

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

فیلدها

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

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

update Widget

UpdateWidget

برای افزودنیهای موجود در Google Chat ، ویجت را در کارت یا گفتگو به روز می کند.

به روزرسانی widget

برای افزودنیهای موجود در Google Chat ، ویجت را در کارت یا گفتگو به روز می کند.

فیلدها
فیلد اتحادیه updated_widget . به روزرسانی های ویجت. updated_widget فقط می تواند یکی از موارد زیر باشد:
selection Input Widget Suggestions

SelectionInputWidgetSuggestions

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

SelectionInputWidgetSuggests

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

فیلدها
suggestions[]

SelectionItem

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

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

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

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

1) کارت جدید را برگردانید (به جلو حرکت کنید).

 navigations : {
    pushCard : CARD
  }

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

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

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

  navigations : {
    popCard : true,
  }

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

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

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

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

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

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

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

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

8) کارت بالا را با کارت جدید جایگزین کنید. 

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

Union Field navigate_action .

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

pop To Root

bool

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

pop

bool

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

pop To Card

string

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

push Card

Card

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

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

update Card

Card

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

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

end Navigation

EndNavigation

برای افزودنیهای موجود در Google Chat ، گفتگو را می بندد.

اطلاع رسانی

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

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

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

فیلدها
text

string

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

OnClick

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

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

فیلدها

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

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

action

Action

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

open Dynamic Link Action

Action

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

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

card

Card

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

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

overflow Menu

OverflowMenu

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

OnClose

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

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

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

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

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

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

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

عید

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

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

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

سرریز

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

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

فیلدها
items[]

OverflowMenuItem

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

سرریز

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

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

فیلدها
start Icon

Icon

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

text

string

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

on Click

OnClick

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

disabled

bool

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

عمل

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

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

فیلدها
action

Action

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

پیش نمایش توسعه دهنده : افزودنی ها در Google Chat .

host App Action

HostAppActionMarkup

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

schema

string

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

اقدام

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

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

فیلدها
navigations[]

Navigation

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

پیش نمایش توسعه دهنده : افزودنی ها در Google Chat .

notification

Notification

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

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

link Preview

LinkPreview

در Google Docs ، Google Sheets و Google Slides موجود است. پیش نمایش پیوندها با تراشه های هوشمند و کارت. برای جزئیات بیشتر ، به پیوندهای پیش نمایش با تراشه های هوشمند مراجعه کنید.

modify Operations[]

ModifyCard

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

انتخاب

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

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

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

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

فیلدها
name

string

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

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

label

string

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

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

type

SelectionType

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

items[]

SelectionItem

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

on Change Action

Action

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

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

multi Select Max Selected Items

int32

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

multi Select Min Query Length

int32

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

در صورت عدم استفاده ، منوی Multiselect از مقادیر پیش فرض زیر استفاده می کند:

  • اگر این منو از یک آرایه استاتیک از موارد SelectionInput استفاده می کند ، به طور پیش فرض به 0 کاراکتر و بلافاصله موارد را از آرایه جمع می کند.
  • اگر این منو از یک منبع داده پویا ( multi_select_data_source ) استفاده می کند ، قبل از پرس و جو از منبع داده برای بازگشت موارد پیشنهادی به 3 کاراکتر پیش فرض می شود.
validation

Validation

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

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

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

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

external Data Source

Action

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

platform Data Source

PlatformDataSource

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

PlatformDatasource

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

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

فیلدها
Union Field data_source . منبع داده data_source فقط می تواند یکی از موارد زیر باشد:
common Data Source

CommonDataSource

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

host App Data Source

HostAppDataSourceMarkup

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

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

CommonDataSource

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

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

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

انتخاب

موردی که کاربران می توانند در یک ورودی انتخاب ، مانند کادر انتخاب یا سوئیچ انتخاب کنند. حداکثر 100 مورد را پشتیبانی می کند.

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

فیلدها
text

string

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

value

string

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

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

selected

bool

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

start Icon Uri

string

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

bottom Text

string

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

SelectionType

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

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

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

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

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

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

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

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

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

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

زیر نظر

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

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

{
  "renderActions": {
    "action": {
      "notification": {
        "text": "Email address is added: salam.heba@example.com"
      }
    },
    "hostAppAction": {
      "gmailAction": {
        "openCreatedDraftAction": {
          "draftId": "msg-a:r-79766936926021702",
          "threadServerPermId": "thread-f:15700999851086004"
        }
      }
    }
  }
}
فیلدها
render Actions

RenderActions

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

state Changed

bool

این که آیا وضعیت کارت ها تغییر کرده و داده های موجود در کارتهای موجود بی رنگ است.

schema

string

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

پیشنهادات

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

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

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

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

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

فیلدها
items[]

SuggestionItem

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

پیشنهاد

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

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

فیلدها

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

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

text

string

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

TextInput

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

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

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

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

فیلدها
name

string

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

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

label

string

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

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

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

hint Text

string

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

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

value

string

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

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

type

Type

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

on Change Action

Action

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

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

initial Suggestions

Suggestions

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

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

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

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

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

auto Complete Action

Action

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

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

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

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

validation

Validation

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

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

placeholder Text

string

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

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

تایپ کنید

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

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

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

تانگراگراف

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

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

فیلدها
text

string

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

max Lines

int32

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

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

اعتبار سنجی

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

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

فیلدها
character Limit

int32

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

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

input Type

InputType

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

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

نوع ورودی

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

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

ویجت

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

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

فیلدها
horizontal Alignment

HorizontalAlignment

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

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

TextParagraph

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

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

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

Image

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

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

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

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

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

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

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
    }
  ]
}
date Time Picker

DateTimePicker

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

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

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

Divider

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

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

"divider": {
}
grid

Grid

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

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

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

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

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

Columns

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

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

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

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

Carousel

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

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

ChipList

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

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

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

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

افقی

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

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

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

ImageType

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

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

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