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

تمثّل عنوان URL للصورة في عنوان البطاقة.

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

صورة

تمثّل هذه السمة صورة يحدّدها عنوان URL ويمكن أن تتضمّن إجراء onclick.

تمثيل JSON
{
  "imageUrl": string,
  "onClick": {
    object (OnClick)
  },
  "aspectRatio": number
}
الحقول
imageUrl

string

عنوان URL للصورة

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

الرمز المحدّد بواسطة عنوان 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 إجراء.

نهاية الحقول المتنافية

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 أو عنوان URL. في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ:
icon

enum (Icon)

الرمز المحدّد بواسطة enum الذي يشير إلى رمز توفّره Chat API.

iconUrl

string

الرمز المحدّد بواسطة عنوان URL

نهاية الحقول المتنافية

CardAction

إجراء البطاقة هو الإجراء المرتبط بالبطاقة. بالنسبة إلى بطاقة الفاتورة، يكون الإجراء النموذجي هو: حذف الفاتورة أو إرسال الفاتورة عبر البريد الإلكتروني أو فتح الفاتورة في المتصفّح.

غير متاح في تطبيقات Google Chat

تمثيل JSON
{
  "actionLabel": string,
  "onClick": {
    object (OnClick)
  }
}
الحقول
actionLabel

string

كان يتم عرض التصنيف في عنصر قائمة الإجراءات.

onClick

object (OnClick)

الإجراء onclick لبند العمل هذا.