Package google.apps.card.v1

string

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

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

ActionParameter

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

LoadIndicator

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

bool

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

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

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

Interaction

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

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

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

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

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

string

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

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

bool

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

string

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

string

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

BorderType

نوع حاشیه.

Color

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

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

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

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

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

int32

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

string

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

Icon

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

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 برای رنگ دکمه در دسترس نیست. اگر مشخص شده باشد، این فیلد نادیده گرفته می شود.

OnClick

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

bool

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

string

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

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

Type

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

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

Button

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

CardHeader

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

Section

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

DividerStyle

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

CardAction

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

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

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

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

string

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

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

CardFixedFooter

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

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

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

DisplayStyle

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

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

CardHeader

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

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

string

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

OnClick

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

Button

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

Button

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

string

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

string

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

ImageType

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

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

string

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

string

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

TextParagraph

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

ButtonList

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

Image

ویجت تصویر

string

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

Widget

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

bool

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

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

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

int32

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

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

CollapseControl

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

CarouselCard

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

NestedWidget

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

NestedWidget

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

Icon

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

string

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

OnClick

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

bool

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

bool

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

string

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

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

Layout

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

Chip

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

HorizontalAlignment

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

Button

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

Button

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

Column

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

HorizontalSizeStyle

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

HorizontalAlignment

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

VerticalAlignment

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

Widgets

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

TextParagraph

ویجت TextParagraph .

Image

ویجت Image

DecoratedText

ویجت DecoratedText .

ButtonList

ویجت ButtonList .

TextInput

ویجت TextInput

SelectionInput

ویجت SelectionInput .

DateTimePicker

ویجت DateTimePicker .

ChipList

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

string

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

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

string

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

DateTimePickerType

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

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 ) استفاده کنید.

int32

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

Action

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

Validation

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

Icon

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

Icon

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

string

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

string

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

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

bool

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

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

string

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

OnClick

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

Button

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

SwitchControl

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

Icon

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

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

string

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

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

string

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

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

bool

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

Action

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

ControlType

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

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

string

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

GridItem

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

BorderStyle

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

int32

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

OnClick

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

string

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

ImageComponent

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

string

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

string

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

GridItemLayout

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

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

ImageType

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

string

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

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

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

string

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

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

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

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

MaterialIcon

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

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

"material_icon": {
  "name": "check_box"
}

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

string

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

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

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

OnClick

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

string

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

string

آدرس تصویر.

string

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

ImageCropStyle

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

BorderStyle

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

ImageCropType

نوع محصول

double

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

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

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

string

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

bool

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

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

int32

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

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

int32

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

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

Action

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

OpenLink

در صورت مشخص شدن ، این onClick باعث ایجاد یک عمل لینک باز می شود.

Action

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

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

Card

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

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

OverflowMenu

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

string

URL برای باز کردن.

OpenAs

نحوه باز کردن پیوند

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

OnClose

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

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

OverflowMenuItem

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

Icon

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

string

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

OnClick

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

bool

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

string

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

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

string

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

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

SelectionType

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

SelectionItem

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

Action

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

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

int32

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

int32

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

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

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

Validation

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

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

Action

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

PlatformDataSource

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

CommonDataSource

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

HostAppDataSourceMarkup

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

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

string

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

string

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

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

bool

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

string

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

string

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

SuggestionItem

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

string

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

string

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

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

string

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

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

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

string

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

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

string

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

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

Type

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

Action

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

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

Suggestions

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

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

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

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

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

Action

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

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

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

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

Validation

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

string

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

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

string

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

int32

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

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

int32

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

InputType

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

HorizontalAlignment

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

TextParagraph

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

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

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

Image

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

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

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

DecoratedText

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

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

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

ButtonList

لیستی از دکمه ها.

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

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

TextInput

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

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

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

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

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

SelectionInput

کنترل انتخابی را نشان می دهد که به کاربران امکان انتخاب موارد را می دهد. کنترل های انتخابی می توانند کادر انتخاب ، دکمه های رادیویی ، سوئیچ ها یا منوهای کشویی باشند.

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

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

DateTimePicker

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

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

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

Divider

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

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

"divider": {
}

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

حداکثر 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

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

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

ChipList

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

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

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

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