Cards v2

کارت

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

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

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

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

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

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

نمونه کارت تماس

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

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

object ( CardHeader )

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

sections[]

object ( Section )

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

sectionDividerStyle

enum ( DividerStyle )

سبک تقسیم کننده بین بخش ها.

cardActions[]

object ( CardAction )

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

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

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

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

string

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

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

displayStyle

enum ( DisplayStyle )

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

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

peekCardHeader

object ( CardHeader )

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

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

سربرگ کارت

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

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

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

string

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

subtitle

string

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

imageType

enum ( ImageType )

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

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

imageUrl

string

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

imageAltText

string

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

ImageType

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

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

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

بخش

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

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

نمایندگی JSON
{
  "header": string,
  "widgets": [
    {
      object (Widget)
    }
  ],
  "collapsible": boolean,
  "uncollapsibleWidgetsCount": integer
}
زمینه های
header

string

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

widgets[]

object ( Widget )

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

collapsible

boolean

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

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

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

uncollapsibleWidgetsCount

integer

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

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

ویجت

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

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

نمایندگی JSON
{
  "horizontalAlignment": enum (HorizontalAlignment),

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "decoratedText": {
    object (DecoratedText)
  },
  "buttonList": {
    object (ButtonList)
  },
  "textInput": {
    object (TextInput)
  },
  "selectionInput": {
    object (SelectionInput)
  },
  "dateTimePicker": {
    object (DateTimePicker)
  },
  "divider": {
    object (Divider)
  },
  "grid": {
    object (Grid)
  },
  "columns": {
    object (Columns)
  }
  // End of list of possible types for union field data.
}
زمینه های
horizontalAlignment

enum ( HorizontalAlignment )

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

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

object ( TextParagraph )

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

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

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

object ( Image )

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

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

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

object ( DecoratedText )

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

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

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

object ( ButtonList )

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

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

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

object ( TextInput )

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

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

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

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

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

object ( SelectionInput )

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

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

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

object ( DateTimePicker )

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

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

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

object ( Divider )

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

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

"divider": {
}
grid

object ( Grid )

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

یک شبکه از هر تعداد ستون و آیتم پشتیبانی می کند. تعداد سطرها با کران های بالای آیتم های عددی تقسیم بر تعداد ستون ها تعیین می شود. یک شبکه با 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"
    }
  }
}
columns

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

متن پاراگراف

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

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

نمایندگی JSON
{
  "text": string
}
زمینه های
text

string

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

تصویر

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

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

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

string

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

مثلا:

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

object ( OnClick )

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

altText

string

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

OnClick

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

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

نمایندگی JSON
{

  // Union field data can be only one of the following:
  "action": {
    object (Action)
  },
  "openLink": {
    object (OpenLink)
  },
  "openDynamicLinkAction": {
    object (Action)
  },
  "card": {
    object (Card)
  }
  // End of list of possible types for union field data.
}
زمینه های

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

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

action

object ( Action )

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

card

object ( Card )

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

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

عمل

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

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

نمایندگی JSON
{
  "function": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ],
  "loadIndicator": enum (LoadIndicator),
  "persistValues": boolean,
  "interaction": enum (Interaction)
}
زمینه های
function

string

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

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

parameters[]

object ( ActionParameter )

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

loadIndicator

enum ( LoadIndicator )

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

persistValues

boolean

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

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

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

interaction

enum ( Interaction )

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

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

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

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

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

ActionParameter

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

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

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

نمایندگی JSON
{
  "key": string,
  "value": string
}
زمینه های
key

string

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

value

string

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

LoadIndicator

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

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

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

اثر متقابل

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

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

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

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

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

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

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

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

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

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

OpenAs

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

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

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

OnClose

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

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

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

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

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

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

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

متن تزئین شده

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

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

نمایندگی JSON
{
  "icon": {
    object (Icon)
  },
  "startIcon": {
    object (Icon)
  },
  "topLabel": string,
  "text": string,
  "wrapText": boolean,
  "bottomLabel": string,
  "onClick": {
    object (OnClick)
  },

  // Union field control can be only one of the following:
  "button": {
    object (Button)
  },
  "switchControl": {
    object (SwitchControl)
  },
  "endIcon": {
    object (Icon)
  }
  // End of list of possible types for union field control.
}
زمینه های
icon
(deprecated)

object ( Icon )

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

startIcon

object ( Icon )

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

topLabel

string

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

text

string

ضروری. متن اولیه

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

wrapText

boolean

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

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

bottomLabel

string

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

onClick

object ( OnClick )

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

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

object ( Button )

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

switchControl

object ( SwitchControl )

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

endIcon

object ( Icon )

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

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

آیکون

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

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

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

نمایندگی JSON
{
  "altText": string,
  "imageType": enum (ImageType),

  // Union field icons can be only one of the following:
  "knownIcon": string,
  "iconUrl": string,
  "materialIcon": {
    object (MaterialIcon)
  }
  // End of list of possible types for union field icons.
}
زمینه های
altText

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

enum ( ImageType )

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

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

string

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

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

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

iconUrl

string

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

مثلا:

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

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

materialIcon

object ( MaterialIcon )

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

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

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

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

MaterialIcon

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

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

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

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

نمایندگی JSON
{
  "name": string,
  "fill": boolean,
  "weight": integer,
  "grade": integer
}
زمینه های
name

string

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

fill

boolean

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

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

weight

integer

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

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

grade

integer

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

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

دکمه

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

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

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

نمایندگی JSON
{
  "text": string,
  "icon": {
    object (Icon)
  },
  "color": {
    object (Color)
  },
  "onClick": {
    object (OnClick)
  },
  "disabled": boolean,
  "altText": string
}
زمینه های
text

string

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

icon

object ( Icon )

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

color

object ( Color )

اگر تنظیم شود، دکمه با رنگ پس‌زمینه ثابت پر می‌شود و رنگ فونت برای حفظ کنتراست با رنگ پس‌زمینه تغییر می‌کند. برای مثال، تنظیم یک پس‌زمینه آبی احتمالاً منجر به ایجاد متن سفید می‌شود.

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

برای قرمز، سبز و آبی، مقدار هر فیلد یک عدد float است که می توانید آن را به دو روش بیان کنید: به صورت عددی بین 0 و 255 تقسیم بر 255 (153/255)، یا به عنوان مقداری بین 0 و 1 (0.6). 0 نشان دهنده عدم وجود یک رنگ و 1 یا 255/255 نشان دهنده حضور کامل آن رنگ در مقیاس RGB است.

به صورت اختیاری alpha را تنظیم کنید، که سطح شفافیت را با استفاده از این معادله تعیین می کند:

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

برای alpha ، مقدار 1 با یک رنگ ثابت و مقدار 0 با یک رنگ کاملا شفاف مطابقت دارد.

به عنوان مثال، رنگ زیر یک قرمز نیمه شفاف را نشان می دهد:

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
   "alpha": 0.5
}
onClick

object ( OnClick )

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

disabled

boolean

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

altText

string

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

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

رنگ

یک رنگ را در فضای رنگی RGBA نشان می دهد. این نمایش برای سادگی تبدیل به و از نمایش رنگ در زبان های مختلف بیش از فشرده سازی طراحی شده است. به عنوان مثال، فیلدهای این نمایش را می توان به صورت بی اهمیت در اختیار سازنده java.awt.Color در جاوا قرار داد. همچنین می‌توان آن را به روش UIColor +colorWithRed:green:blue:alpha در iOS ارائه کرد. و فقط با کمی کار می توان آن را به راحتی در یک رشته CSS rgba() در جاوا اسکریپت قالب بندی کرد.

این صفحه مرجع اطلاعاتی درباره فضای رنگ مطلقی که باید برای تفسیر مقدار RGB استفاده شود ندارد - برای مثال، sRGB، Adobe RGB، DCI-P3، و BT.2020. به طور پیش فرض، برنامه ها باید فضای رنگی sRGB را در نظر بگیرند.

هنگامی که نیاز به تصمیم گیری در مورد برابری رنگ است، پیاده سازی ها، مگر اینکه به گونه ای دیگر مستند شده باشد، اگر تمام مقادیر قرمز، سبز، آبی و آلفا هر کدام حداکثر 1e-5 متفاوت باشد، با دو رنگ برابر رفتار می کنند.

مثال (جاوا):

 import com.google.type.Color;

 // ...
 public static java.awt.Color fromProto(Color protocolor) {
   float alpha = protocolor.hasAlpha()
       ? protocolor.getAlpha().getValue()
       : 1.0;

   return new java.awt.Color(
       protocolor.getRed(),
       protocolor.getGreen(),
       protocolor.getBlue(),
       alpha);
 }

 public static Color toProto(java.awt.Color color) {
   float red = (float) color.getRed();
   float green = (float) color.getGreen();
   float blue = (float) color.getBlue();
   float denominator = 255.0;
   Color.Builder resultBuilder =
       Color
           .newBuilder()
           .setRed(red / denominator)
           .setGreen(green / denominator)
           .setBlue(blue / denominator);
   int alpha = color.getAlpha();
   if (alpha != 255) {
     result.setAlpha(
         FloatValue
             .newBuilder()
             .setValue(((float) alpha) / denominator)
             .build());
   }
   return resultBuilder.build();
 }
 // ...

مثال (iOS / Obj-C):

 // ...
 static UIColor* fromProto(Color* protocolor) {
    float red = [protocolor red];
    float green = [protocolor green];
    float blue = [protocolor blue];
    FloatValue* alpha_wrapper = [protocolor alpha];
    float alpha = 1.0;
    if (alpha_wrapper != nil) {
      alpha = [alpha_wrapper value];
    }
    return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
 }

 static Color* toProto(UIColor* color) {
     CGFloat red, green, blue, alpha;
     if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
       return nil;
     }
     Color* result = [[Color alloc] init];
     [result setRed:red];
     [result setGreen:green];
     [result setBlue:blue];
     if (alpha <= 0.9999) {
       [result setAlpha:floatWrapperWithValue(alpha)];
     }
     [result autorelease];
     return result;
}
// ...

مثال (جاوا اسکریپت):

// ...

var protoToCssColor = function(rgb_color) {
   var redFrac = rgb_color.red || 0.0;
   var greenFrac = rgb_color.green || 0.0;
   var blueFrac = rgb_color.blue || 0.0;
   var red = Math.floor(redFrac * 255);
   var green = Math.floor(greenFrac * 255);
   var blue = Math.floor(blueFrac * 255);

   if (!('alpha' in rgb_color)) {
      return rgbToCssColor(red, green, blue);
   }

   var alphaFrac = rgb_color.alpha.value || 0.0;
   var rgbParams = [red, green, blue].join(',');
   return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
};

var rgbToCssColor = function(red, green, blue) {
  var rgbNumber = new Number((red << 16) | (green << 8) | blue);
  var hexString = rgbNumber.toString(16);
  var missingZeros = 6 - hexString.length;
  var resultBuilder = ['#'];
  for (var i = 0; i < missingZeros; i++) {
     resultBuilder.push('0');
  }
  resultBuilder.push(hexString);
  return resultBuilder.join('');
};

// ...
نمایندگی JSON
{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}
زمینه های
red

number

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

green

number

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

blue

number

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

alpha

number

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

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

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

تغییر کنترل

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

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

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

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

string

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

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

value

string

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

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

selected

boolean

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

onChangeAction

object ( Action )

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

controlType

enum ( ControlType )

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

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

نوع کنترل

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

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

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

ButtonList

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

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

نمایندگی JSON
{
  "buttons": [
    {
      object (Button)
    }
  ]
}
زمینه های
buttons[]

object ( Button )

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

TextInput

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

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

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

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

نمایندگی JSON
{
  "name": string,
  "label": string,
  "hintText": string,
  "value": string,
  "type": enum (Type),
  "onChangeAction": {
    object (Action)
  },
  "initialSuggestions": {
    object (Suggestions)
  },
  "autoCompleteAction": {
    object (Action)
  },
  "placeholderText": string
}
زمینه های
name

string

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

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

label

string

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

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

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

hintText

string

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

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

value

string

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

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

type

enum ( Type )

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

onChangeAction

object ( Action )

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

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

initialSuggestions

object ( Suggestions )

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

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

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

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

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

autoCompleteAction

object ( Action )

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

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

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

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

placeholderText

string

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

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

تایپ کنید

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

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

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

RenderActions

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

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

زمینه های
action

Action

عمل

زمینه های
navigations[]

Navigation

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

یک کارت جدید به پشته اضافه کنید (به جلو حرکت کنید).

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

navigations: {
  pushCard: CARD
}

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

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

navigations: {
  updateCard: CARD
}

پیشنهادات

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

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

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

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

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

نمایندگی JSON
{
  "items": [
    {
      object (SuggestionItem)
    }
  ]
}
زمینه های
items[]

object ( SuggestionItem )

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

آیتم پیشنهادی

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

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

نمایندگی JSON
{

  // Union field content can be only one of the following:
  "text": string
  // End of list of possible types for union field content.
}
زمینه های

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

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

text

string

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

SelectionInput

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

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

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

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

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

  // Union field multi_select_data_source can be only one of the following:
  "externalDataSource": {
    object (Action)
  },
  "platformDataSource": {
    object (PlatformDataSource)
  }
  // End of list of possible types for union field multi_select_data_source.
}
زمینه های
name

string

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

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

label

string

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

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

type

enum ( SelectionType )

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

items[]

object ( SelectionItem )

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

onChangeAction

object ( Action )

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

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

multiSelectMaxSelectedItems

integer

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

multiSelectMinQueryLength

integer

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

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

فیلد اتحادیه multi_select_data_source . برای یک منوی چند انتخابی، منبع داده ای که آیتم های انتخابی را پر می کند.

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

externalDataSource

object ( Action )

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

platformDataSource

object ( PlatformDataSource )

منبع داده از Google Workspace.

SelectionType

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

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

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

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

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

برای پر کردن آیتم‌ها برای منوی چند انتخابی، می‌توانید از یکی از انواع منابع داده زیر استفاده کنید:

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

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

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

انتخاب آیتم

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

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

نمایندگی JSON
{
  "text": string,
  "value": string,
  "selected": boolean,
  "startIconUri": string,
  "bottomText": string
}
زمینه های
text

string

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

value

string

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

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

selected

boolean

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

startIconUri

string

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

bottomText

string

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

PlatformDatasource

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

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

نمایندگی JSON
{

  // Union field data_source can be only one of the following:
  "commonDataSource": enum (CommonDataSource),
  "hostAppDataSource": {
    object (HostAppDataSourceMarkup)
  }
  // End of list of possible types for union field data_source.
}
زمینه های
Union Field data_source . منبع داده data_source فقط می تواند یکی از موارد زیر باشد:
commonDataSource

enum ( CommonDataSource )

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

hostAppDataSource

object ( HostAppDataSourceMarkup )

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

محرمانه

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

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

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

HostappDatasourCemarkup

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

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

نمایندگی JSON
{

  // Union field data_source can be only one of the following:
  "chatDataSource": {
    object (ChatClientDataSourceMarkup)
  }
  // End of list of possible types for union field data_source.
}
زمینه های
Union Field data_source . برنامه فضای کاری Google که مواردی را برای منوی چند انتخابی جمع می کند. data_source فقط می تواند یکی از موارد زیر باشد:
chatDataSource

object ( ChatClientDataSourceMarkup )

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

chatclientdatasourcemarkup

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

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

نمایندگی JSON
{

  // Union field source can be only one of the following:
  "spaceDataSource": {
    object (SpaceDataSource)
  }
  // End of list of possible types for union field source.
}
زمینه های
source میدانی اتحادیه. منبع داده چت Google. source می تواند تنها یکی از موارد زیر باشد:
spaceDataSource

object ( SpaceDataSource )

فضاهای گپ گوگل که کاربر عضو آن است.

فاصله

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

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

نمایندگی JSON
{
  "defaultToCurrentSpace": boolean
}
زمینه های
defaultToCurrentSpace

boolean

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

DateTimePicker

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

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

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

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

string

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

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

label

string

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

type

enum ( DateTimePickerType )

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

valueMsEpoch

string ( int64 format)

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

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

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

integer

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

onChangeAction

object ( Action )

هنگامی که کاربر کلیک می کند از رابط DateTimePicker کلیک می کند یا پاک می شود .

dateTimePickertype

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

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

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

تقسیم کننده

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

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

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

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

"divider": {}

توری

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

یک شبکه از هر تعداد ستون و موارد پشتیبانی می کند. تعداد سطرها بر اساس موارد تقسیم بر ستون تعیین می شود. یک شبکه با 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"
    }
  }
}
نمایندگی JSON
{
  "title": string,
  "items": [
    {
      object (GridItem)
    }
  ],
  "borderStyle": {
    object (BorderStyle)
  },
  "columnCount": integer,
  "onClick": {
    object (OnClick)
  }
}
زمینه های
title

string

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

items[]

object ( GridItem )

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

borderStyle

object ( BorderStyle )

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

columnCount

integer

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

onClick

object ( OnClick )

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

شبکه

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

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

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

string

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

image

object ( ImageComponent )

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

title

string

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

subtitle

string

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

layout

enum ( GridItemLayout )

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

تصویر

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

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

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

string

URL تصویر

altText

string

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

cropStyle

object ( ImageCropStyle )

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

borderStyle

object ( BorderStyle )

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

سبک تصویر

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

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

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

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

enum ( ImageCropType )

نوع محصول

aspectRatio

number

نسبت ابعاد در صورت استفاده از نوع محصول RECTANGLE_CUSTOM است.

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

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

نوع تصویربرداری

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

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

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

هموار

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

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

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

enum ( BorderType )

نوع مرزی

strokeColor

object ( Color )

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

cornerRadius

integer

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

نوع مرزی

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

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

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

رفیق

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

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

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

ستون ها

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

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

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

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

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

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

نمایندگی JSON
{
  "columnItems": [
    {
      object (Column)
    }
  ]
}
زمینه های
columnItems[]

object ( Column )

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

ستون

یک ستون.

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

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

enum ( HorizontalSizeStyle )

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

horizontalAlignment

enum ( HorizontalAlignment )

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

verticalAlignment

enum ( VerticalAlignment )

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

widgets[]

object ( Widgets )

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

سبک افقی

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

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

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

افقی

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

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

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

چیدمان عمودی

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

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

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

ابزارک ها

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

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

نمایندگی JSON
{

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "decoratedText": {
    object (DecoratedText)
  },
  "buttonList": {
    object (ButtonList)
  },
  "textInput": {
    object (TextInput)
  },
  "selectionInput": {
    object (SelectionInput)
  },
  "dateTimePicker": {
    object (DateTimePicker)
  }
  // End of list of possible types for union field data.
}
زمینه های

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

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

textParagraph

object ( TextParagraph )

ویجت TextParagraph .

image

object ( Image )

ویجت Image .

decoratedText

object ( DecoratedText )

ویجت DecoratedText .

buttonList

object ( ButtonList )

ویجت ButtonList .

textInput

object ( TextInput )

ویجت TextInput .

selectionInput

object ( SelectionInput )

ویجت SelectionInput .

dateTimePicker

object ( DateTimePicker )

ویجت DateTimePicker .

تقسیم تقسیم

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

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

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

کاردستی

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

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

نمایندگی JSON
{
  "actionLabel": string,
  "onClick": {
    object (OnClick)
  }
}
زمینه های
actionLabel

string

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

onClick

object ( OnClick )

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

پوتین

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

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

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

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

نمایندگی JSON
{
  "primaryButton": {
    object (Button)
  },
  "secondaryButton": {
    object (Button)
  }
}
زمینه های
primaryButton

object ( Button )

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

secondaryButton

object ( Button )

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

نمایشگاه

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

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

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