Cards v1

کارت

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

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

object ( CardHeader )

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

sections[]

object ( Section )

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

card Actions[]

object ( CardAction )

اقدامات این کارت.

name

string

نام کارت.

سربرگ کارت

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

string

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

subtitle

string

زیرنویس هدر کارت.

image Style

enum ( ImageStyle )

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

image Url

string

URL تصویر در هدر کارت.

ImageStyle

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

بخش

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

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

string

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

widgets[]

object ( WidgetMarkup )

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

ویجت مارکاپ

ویجت یک عنصر رابط کاربری است که متن و تصاویر را ارائه می دهد.

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

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "keyValue": {
    object (KeyValue)
  }
  // End of list of possible types for union field data.
}
فیلدها
buttons[]

object ( Button )

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

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

object ( TextParagraph )

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

image

object ( Image )

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

key Value

object ( KeyValue )

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

متن پاراگراف

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

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

string

تصویر

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

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

string

آدرس تصویر.

on Click

object ( OnClick )

عمل onclick .

aspect Ratio

number

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

OnClick

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

نمایندگی JSON 
{

  // Union field data can be only one of the following:
  "action": {
    object (FormAction)
  },
  "openLink": {
    object (OpenLink)
  }
  // End of list of possible types for union field data.
}
فیلدها

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

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

action

object ( FormAction )

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

FormAction

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

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

string

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

parameters[]

object ( ActionParameter )

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

ActionParameter

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

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

string

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

value

string

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

KeyValue

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

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

  // Union field icons can be only one of the following:
  "icon": enum (Icon),
  "iconUrl": string
  // End of list of possible types for union field icons.

  // Union field control can be only one of the following:
  "button": {
    object (Button)
  }
  // End of list of possible types for union field control.
}
فیلدها
top Label

string

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

content

string

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

content Multiline

boolean

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

bottom Label

string

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

on Click

object ( OnClick )

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

icons فیلد اتحادیه حداقل یکی از نمادها، top_label و bottom_label باید تعریف شود. icons فقط می توانند یکی از موارد زیر باشند:
icon

enum ( Icon )

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

icon Url

string

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

control میدان اتحادیه ویجت کنترلی می توانید button یا switch_widget تنظیم کنید، اما نه هر دو را. control فقط می تواند یکی از موارد زیر باشد:
button

object ( Button )

دکمه ای که می توان روی آن کلیک کرد تا یک عمل فعال شود.

نماد

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

Enums
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

دکمه

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

نمایندگی JSON 
{

  // Union field type can be only one of the following:
  "textButton": {
    object (TextButton)
  },
  "imageButton": {
    object (ImageButton)
  }
  // End of list of possible types for union field type.
}
فیلدها

type فیلد اتحادیه

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

text Button

object ( TextButton )

یک دکمه با متن و عمل onclick .

image Button

object ( ImageButton )

یک دکمه با عکس و عمل onclick .

دکمه متن

یک دکمه با متن و عمل onclick .

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

string

متن دکمه.

on Click

object ( OnClick )

عمل onclick دکمه.

دکمه تصویر

یک دکمه تصویر با یک عمل onclick .

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

  // Union field icons can be only one of the following:
  "icon": enum (Icon),
  "iconUrl": string
  // End of list of possible types for union field icons.
}
فیلدها
on Click

object ( OnClick )

عمل onclick .

name

string

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

icons فیلد اتحادیه نماد را می توان با یک enum Icon یا یک URL مشخص کرد. icons فقط می توانند یکی از موارد زیر باشند:
icon

enum ( Icon )

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

icon Url

string

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

CardAction

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

توسط برنامه‌های چت Google پشتیبانی نمی‌شود.

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

string

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

on Click

object ( OnClick )

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