Cards v1

کارت

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

نمایش JSON 
{
  "header": {
    object (CardHeader)
  },
  "sections": [
    {
      object (Section)
    }
  ],
  "cardActions": [
    {
      object (CardAction)
    }
  ],
  "name": string
}
فیلدها
header

object (CardHeader)

سرصفحه کارت. سرصفحه معمولاً حاوی عنوان و تصویر است.

sections[]

object (Section)

بخش‌ها با خط جداکننده از هم جدا شده‌اند.

cardActions[]

object (CardAction)

کنش‌های این کارت.

name

string

نام کارت.

CardHeader

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

string

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

subtitle

string

زیرعنوان سرصفحه کارت.

imageStyle

enum (ImageStyle)

نوع تصویر (برای مثال، حاشیه مربعی یا حاشیه دایره‌ای).

imageUrl

string

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

ImageStyle

شمارشی‌ها
IMAGE_STYLE_UNSPECIFIED
IMAGE حاشیه مربعی.
AVATAR حاشیه دایره‌ای.

بخش

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

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

string

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

widgets[]

object (WidgetMarkup)

هر بخش باید حداقل یک ابزاره داشته باشد.

WidgetMarkup

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

نمایش JSON 
{
  "buttons": [
    {
      object (Button)
    }
  ],

  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "keyValue": {
    object (KeyValue)
  }
}
فیلدها
buttons[]

object (Button)

فهرستی از دکمه‌ها. دکمه‌ها نیز oneof data است و فقط یکی از این فیلدها باید تنظیم شود.

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

object (TextParagraph)

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

image

object (Image)

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

keyValue

object (KeyValue)

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

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

TextParagraph

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

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

string

تصویر

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

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

string

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

onClick

object (OnClick)

کنش onclick .

aspectRatio

number

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

OnClick

یک onclick کنش (برای مثال، باز کردن پیوند).

نمایش JSON 
{

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

object (FormAction)

درصورت مشخص شدن، کنش فرم توسط این onclick کنش راه‌اندازی می‌شود.

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

FormAction

کنش فرم رفتار را هنگام ارسال فرم شرح می‌دهد. برای مثال، می‌توانید Apps Script را برای مدیریت فرم فراخوانی کنید.

نمایش JSON 
{
  "actionMethodName": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ]
}
فیلدها
actionMethodName

string

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

parameters[]

object (ActionParameter)

فهرست پارامترهای کنش.

ActionParameter

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

نمایش JSON 
{
  "key": string,
  "value": string
}
فیلدها
key

string

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

value

string

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

KeyValue

عنصر میانای کاربر حاوی یک کلید (برچسب) و یک مقدار (محتوا) است. این عنصر همچنین می‌تواند حاوی برخی کنش‌ها مانند onclick دکمه باشد.

نمایش JSON 
{
  "topLabel": string,
  "content": string,
  "contentMultiline": boolean,
  "bottomLabel": string,
  "onClick": {
    object (OnClick)
  },

  "icon": enum (Icon),
  "iconUrl": string

  "button": {
    object (Button)
  }
}
فیلدها
topLabel

string

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

content

string

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

contentMultiline

boolean

اگر محتوا باید چندخطی باشد.

bottomLabel

string

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

onClick

object (OnClick)

کنش onclick . فقط برچسب بالا، برچسب پایین، و ناحیه محتوا قابل‌کلیک هستند.

حداقل یکی از نمادهای top_label و bottom_label باید تعریف شود. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
icon

enum (Icon)

مقدار شمارشی که Chat API آن را با تصویر نماد مربوطه جایگزین می‌کند.

iconUrl

string

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

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

object (Button)

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

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

نماد

مجموعه نمادهای پشتیبانی‌شده.

شمارشی‌ها
ICON_UNSPECIFIED
AIRPLANE
BOOKMARK
BUS
CAR
CLOCK
CONFIRMATION_NUMBER_ICON
DOLLAR
DESCRIPTION
EMAIL
EVENT_PERFORMER
EVENT_SEAT
FLIGHT_ARRIVAL
FLIGHT_DEPARTURE
HOTEL
HOTEL_ROOM_TYPE
INVITE
MAP_PIN
MEMBERSHIP
MULTIPLE_PEOPLE
OFFER
PERSON
PHONE
RESTAURANT_ICON
SHOPPING_CART
STAR
STORE
TICKET
TRAIN
VIDEO_CAMERA
VIDEO_PLAY

دکمه

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

نمایش JSON 
{

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

object (TextButton)

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

imageButton

object (ImageButton)

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

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

TextButton

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

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

string

نوشتار دکمه.

onClick

object (OnClick)

onclick کنش دکمه.

ImageButton

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

نمایش JSON 
{
  "onClick": {
    object (OnClick)
  },
  "name": string,

  "icon": enum (Icon),
  "iconUrl": string
}
فیلدها
onClick

object (OnClick)

کنش onclick .

name

string

نام این imageButton که برای دسترس‌پذیری استفاده می‌شود. اگر این نام مشخص نشده باشد، مقدار پیش‌فرض ارائه می‌شود.

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

enum (Icon)

نمادی که با enum مشخص شده است و به نمادی که Chat API ارائه کرده است اشاره می‌کند.

iconUrl

string

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

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

CardAction

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

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

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

string

برچسبی که قبلاً در گزینه منوِ کنش‌ها نمایش داده می‌شد.

onClick

object (OnClick)

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