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

نام کارت.

هدر کارت

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

string

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

subtitle

string

عنوان فرعی سربرگ کارت.

imageStyle

enum ( ImageStyle )

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

imageUrl

string

آدرس اینترنتی (URL) تصویر در هدر کارت.

سبک تصویر

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

بخش

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

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

string

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

widgets[]

object ( 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 )

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

پایان میدان‌های ناسازگار.

متنپاراگراف

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

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

string

تصویر

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

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

string

آدرس اینترنتی (URL) تصویر.

onClick

object ( OnClick )

عمل onclick .

aspectRatio

number

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

آن‌کلیک

یک عمل onclick (مثلاً باز کردن یک لینک).

نمایش JSON 
{

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

object ( FormAction )

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

پایان میدان‌های ناسازگار.

فرم اکشن

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

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

string

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

parameters[]

object ( ActionParameter )

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

پارامتر عمل

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

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

string

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

value

string

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

مقدار کلیدی

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

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

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

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

string

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

content

string

متن محتوا. متن قالب‌بندی‌شده پشتیبانی می‌شود و همیشه مورد نیاز است. برای اطلاعات بیشتر در مورد قالب‌بندی متن، به «قالب‌بندی متن در برنامه‌های چت گوگل» و «قالب‌بندی متن در افزونه‌های فضای کاری گوگل» مراجعه کنید.

contentMultiline

boolean

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

bottomLabel

string

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

onClick

object ( OnClick )

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

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

enum ( Icon )

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

iconUrl

string

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

پایان میدان‌های ناسازگار.
یک ویجت کنترل. شما می‌توانید 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

دکمه

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

نمایش JSON 
{

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

object ( TextButton )

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

imageButton

object ( ImageButton )

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

پایان میدان‌های ناسازگار.

دکمه متنی

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

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

string

متن دکمه.

onClick

object ( OnClick )

عمل onclick دکمه.

دکمه تصویر

یک دکمه تصویری با قابلیت onclick )

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

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

object ( OnClick )

عمل onclick .

name

string

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

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

enum ( Icon )

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

iconUrl

string

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

پایان میدان‌های ناسازگار.

کارت اکشن

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

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

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

string

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

onClick

object ( OnClick )

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