Package google.apps.card.v1

الفهرس

الإجراء

إجراء يصف السلوك عند إرسال النموذج. على سبيل المثال، يمكنك استدعاء نص برمجي في "برمجة تطبيقات Google" للتعامل مع النموذج. في حال تم تشغيل الإجراء، يتم إرسال قيم النموذج إلى الخادم.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

الحقول
function

string

دالة مخصّصة يتم استدعاؤها عند النقر على العنصر الحاوي أو تنشيطه بأي طريقة أخرى.

للاطّلاع على مثال على الاستخدام، راجِع قراءة بيانات النموذج.
parameters[]

ActionParameter

قائمة مَعلمات الإجراءات
load_indicator

LoadIndicator

تحدّد مؤشر التحميل الذي يعرضه الإجراء أثناء تنفيذ طلب الإجراء.
persist_values

bool

تشير إلى ما إذا كانت قيم النموذج تظل محفوظة بعد تنفيذ الإجراء. تكون القيمة التلقائية false.

إذا كانت القيمة true، تظل قيم النموذج بعد تشغيل الإجراء. للسماح للمستخدم بإجراء تغييرات أثناء معالجة الإجراء، اضبط قيمة LoadIndicator على NONE. بالنسبة إلى رسائل البطاقات في تطبيقات Chat، يجب أيضًا ضبط ResponseType الإجراء على UPDATE_MESSAGE واستخدام card_id نفسه من البطاقة التي تحتوي على الإجراء.

في حال ضبط القيمة على false، يتم محو قيم النموذج عند بدء الإجراء. لمنع المستخدم من إجراء تغييرات أثناء معالجة الإجراء، اضبط قيمة LoadIndicator على SPINNER.
interaction

Interaction

اختيارية: مطلوبة عند فتح مربّع حوار.

الإجراء الذي يجب اتّخاذه استجابةً لتفاعل مع مستخدم، مثل نقر المستخدم على زر في رسالة بطاقة

في حال عدم تحديد ذلك، يستجيب التطبيق من خلال تنفيذ action، مثل فتح رابط أو تنفيذ دالة، كالمعتاد.

من خلال تحديد interaction، يمكن للتطبيق الاستجابة بطرق تفاعلية خاصة. على سبيل المثال، من خلال ضبط interaction على OPEN_DIALOG، يمكن للتطبيق فتح مربع حوار. عند تحديد هذه السمة، لا يظهر مؤشر التحميل. إذا تم تحديدها لإحدى الإضافات، تتم إزالة البطاقة بأكملها ولا يتم عرض أي شيء في التطبيق.

متاحة لتطبيقات Google Chat وغير متاحة لإضافات Google Workspace
required_widgets[]

string

اختيارية: املأ هذه القائمة بأسماء الأدوات التي يحتاجها هذا الإجراء لإرسال طلب صالح.

إذا لم تتضمّن الأدوات المدرَجة هنا قيمة عند استدعاء هذا الإجراء، سيتم إلغاء إرسال النموذج.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.
all_widgets_are_required

bool

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

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

ActionParameter

قائمة بمَعلمات السلسلة التي يجب توفيرها عند استدعاء طريقة الإجراء على سبيل المثال، فكِّر في ثلاثة أزرار تأجيل: التأجيل الآن أو التأجيل ليوم واحد أو التأجيل للأسبوع التالي. يمكنك استخدام action method = snooze()، مع تمرير نوع الغفوة ووقت الغفوة في قائمة مَعلمات السلسلة.

لمزيد من المعلومات، يُرجى الاطّلاع على CommonEventObject.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

الحقول
key

string

اسم المَعلمة لبرنامج الإجراءات النصي.
value

string

قيمة المَعلمة

التفاعل

اختيارية: مطلوبة عند فتح مربّع حوار.

الإجراء الذي يجب اتّخاذه استجابةً لتفاعل مع مستخدم، مثل نقر المستخدم على زر في رسالة بطاقة

في حال عدم تحديد ذلك، يستجيب التطبيق من خلال تنفيذ action، مثل فتح رابط أو تنفيذ دالة، كالمعتاد.

من خلال تحديد interaction، يمكن للتطبيق الاستجابة بطرق تفاعلية خاصة. على سبيل المثال، من خلال ضبط interaction على OPEN_DIALOG، يمكن للتطبيق فتح مربع حوار.

عند تحديد هذه السمة، لا يظهر مؤشر التحميل. إذا تم تحديدها لإحدى الإضافات، تتم إزالة البطاقة بأكملها ولا يتم عرض أي شيء في التطبيق.

متاحة لتطبيقات Google Chat وغير متاحة لإضافات Google Workspace

عمليات التعداد
INTERACTION_UNSPECIFIED القيمة التلقائية يتم تنفيذ action كالمعتاد.
OPEN_DIALOG

يفتح مربّع حوار، وهو واجهة مستندة إلى البطاقات ومقسّمة إلى نوافذ تستخدمها تطبيقات Chat للتفاعل مع المستخدمين.

لا تتوفّر إلا لتطبيقات Chat عند النقر على أزرار في رسائل البطاقات. إذا تم تحديدها لإحدى الإضافات، تتم إزالة البطاقة بأكملها ولا يتم عرض أي شيء في التطبيق.

متاحة لتطبيقات Google Chat وغير متاحة لإضافات Google Workspace

LoadIndicator

تحدّد مؤشر التحميل الذي يعرضه الإجراء أثناء تنفيذ طلب الإجراء.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

عمليات التعداد
SPINNER تعرِض هذه السمة عنصر تحميل دوّارًا للإشارة إلى أنّ المحتوى قيد التحميل.
NONE لا يتم عرض أي شيء.

BorderStyle

خيارات النمط لحدود البطاقة أو الأداة، بما في ذلك نوع الحد ولونه

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

الحقول
type

BorderType

نوع الحدّ
stroke_color

Color

الألوان التي سيتم استخدامها عندما يكون النوع BORDER_TYPE_STROKE

لضبط لون الحدّ، حدِّد قيمة للحقول red وgreen وblue. يجب أن تكون القيمة رقمًا عشريًا بين 0 و1 استنادًا إلى قيمة لون الأحمر والأخضر والأزرق، حيث يمثّل 0 (0/255) عدم توفّر اللون، ويمثّل 1 (255/255) الحد الأقصى لشدة اللون.

على سبيل المثال، يضبط ما يلي اللون على الأحمر بأقصى درجة سطوع:

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

الحقل alpha غير متاح للون الحد. يتم تجاهل هذا الحقل في حال تحديده.
corner_radius

int32

نصف قطر الزاوية للحدود

BorderType

تمثّل هذه السمة أنواع الحدود المطبَّقة على التطبيقات المصغّرة.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

عمليات التعداد
BORDER_TYPE_UNSPECIFIED لا تستخدِمها. غير محدد
NO_BORDER بلا حدود
STROKE القيمة التلقائية مخطّط

زرّ

زر يتضمّن نصًا أو رمزًا أو نصًا ورمزًا ويمكن للمستخدمين النقر عليه للاطّلاع على مثال في تطبيقات Google Chat، يُرجى الانتقال إلى إضافة زر.

لتحويل صورة إلى زر قابل للنقر، حدِّد Image (وليس ImageComponent) واضبط إجراء onClick.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

الحقول
text

string

النص المعروض داخل الزر.
icon

Icon

رمز معروض داخل الزر إذا تم ضبط كل من icon وtext، سيظهر الرمز قبل النص.
color

Color

اختيارية: لون الزر في حال ضبط هذا الخيار، سيتم ضبط الزر type على FILLED، وسيتم ضبط لون الحقلَين text وicon على لون متباين لتحسين مقروئية النص. على سبيل المثال، إذا تم ضبط لون الزر على الأزرق، سيتم ضبط أي نص أو رموز في الزر على الأبيض.

لضبط لون الزر، حدِّد قيمة للحقول red وgreen وblue. يجب أن تكون القيمة رقمًا عشريًا بين 0 و1 استنادًا إلى قيمة لون الأحمر والأخضر والأزرق، حيث يمثّل 0 (0/255) عدم توفّر اللون، ويمثّل 1 (255/255) الحد الأقصى لشدة اللون.

على سبيل المثال، يضبط ما يلي اللون على الأحمر بأقصى درجة سطوع:

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

الحقل alpha غير متاح للون الزر. يتم تجاهل هذا الحقل في حال تحديده.
on_click

OnClick

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

bool

إذا كانت القيمة true، يتم عرض الزر في حالة غير نشطة ولا يستجيب لإجراءات المستخدم.
alt_text

string

النص البديل المستخدَم لتسهيل الاستخدام

اضبط نصًا وصفيًا يتيح للمستخدمين معرفة وظيفة الزر. على سبيل المثال، إذا كان الزر يفتح ارتباطًا تشعبيًا، يمكنك كتابة ما يلي: "يفتح علامة تبويب جديدة في المتصفّح وينتقِل إلى مستندات المطوّرين في Google Chat على الرابط https://developers.google.com/workspace/chat".
type

Type

اختيارية: تمثّل هذه السمة نوع الزر. في حال عدم ضبط نوع الزر، سيتم ضبطه تلقائيًا على OUTLINED. في حال ضبط الحقل color، يتم فرض نوع الزر على FILLED ويتم تجاهل أي قيمة تم ضبطها لهذا الحقل.

النوع

اختيارية: تمثّل هذه السمة نوع الزر. في حال ضبط الحقل color، سيتم ضبط الحقل type تلقائيًا على FILLED.

متاحة لتطبيقات Google Chat وغير متاحة لإضافات Google Workspace

عمليات التعداد
TYPE_UNSPECIFIED لا تستخدِمها. غير محدد
OUTLINED الأزرار المحدَّدة الجوانب هي أزرار ذات أهمية متوسطة. وتتضمّن عادةً إجراءات مهمة، ولكنّها ليست الإجراء الأساسي في تطبيق Chat أو إضافة.
FILLED يحتوي الزر المعبأ على حاوية بلون خالص. ويُعدّ هذا الزر الأكثر تأثيرًا من الناحية المرئية، ويُنصح باستخدامه للإجراءات المهمة والرئيسية في تطبيق Chat أو إضافة.
FILLED_TONAL زر التعبئة اللونية هو حل وسط بديل بين الزرَّين المعبأ والمخطّط. تكون هذه الأزرار مفيدة في السياقات التي يتطلّب فيها الزر ذو الأولوية المنخفضة تركيزًا أكبر قليلاً مما يوفّره الزر ذو المخطّط التفصيلي.
BORDERLESS لا يحتوي الزر على حاوية غير مرئية في حالته التلقائية. يُستخدَم غالبًا للإجراءات ذات الأولوية الأدنى، خاصةً عند عرض خيارات متعدّدة.

ButtonList

قائمة بأزرار مرتبة أفقيًا للاطّلاع على مثال في تطبيقات Google Chat، يُرجى الانتقال إلى إضافة زر.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

الحقول
buttons[]

Button

مصفوفة من الأزرار

بطاقة

واجهة بطاقة معروضة في رسالة على Google Chat أو إضافة Google Workspace

تتيح البطاقات تخطيطًا محدّدًا وعناصر تفاعلية في واجهة المستخدم، مثل الأزرار والوسائط المتعددة، مثل الصور. استخدِم البطاقات لتقديم معلومات مفصّلة وجمع معلومات من المستخدمين وتوجيههم لاتّخاذ الخطوة التالية.

تصميم البطاقات ومعاينتها باستخدام "أداة إنشاء البطاقات"

فتح "أداة إنشاء البطاقات"

لمعرفة كيفية إنشاء البطاقات، يمكنك الاطّلاع على المستندات التالية:

ملاحظة: يمكنك إضافة ما يصل إلى 100 أداة لكل بطاقة. ويتم تجاهل أي أدوات تتجاوز هذا الحدّ. ينطبق هذا الحدّ على كلّ من رسائل البطاقات ومربّعات الحوار في تطبيقات Google Chat، وعلى البطاقات في إضافات Google Workspace.

مثال: رسالة بطاقة لتطبيق 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"
                             }
                           ]
                         }
                       }
                     }
                   ]
                 }
               }
             ]
           }
         ]
       }
    }
  ]
}
الحقول
header

CardHeader

تمثّل هذه السمة عنوان البطاقة. يحتوي العنوان عادةً على صورة في المقدّمة وعنوان. تظهر العناوين دائمًا في أعلى البطاقة.
sections[]

Section

تحتوي على مجموعة من التطبيقات المصغّرة. يحتوي كل قسم على عنوان اختياري خاص به. يتم فصل الأقسام بصريًا باستخدام فاصل خطي. للاطّلاع على مثال في تطبيقات Google Chat، راجِع تحديد قسم من بطاقة.
section_divider_style

DividerStyle

نمط الفاصل بين الرأس والأقسام والتذييل
card_actions[]

CardAction

إجراءات البطاقة تتم إضافة الإجراءات إلى قائمة شريط أدوات البطاقة.

متوفّرة لإضافات Google Workspace وغير متوفّرة لتطبيقات Google Chat

على سبيل المثال، ينشئ JSON التالي قائمة إجراءات بطاقة تتضمّن الخيارَين Settings وSend Feedback:

"card_actions": [
  {
    "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
display_style

DisplayStyle

في إضافات Google Workspace، يتم ضبط خصائص العرض الخاصة بـ peekCardHeader.

متوفّرة لإضافات Google Workspace وغير متوفّرة لتطبيقات Google Chat
peek_card_header

CardHeader

عند عرض محتوى سياقي، يعمل عنوان بطاقة المعاينة كعنصر نائب حتى يتمكّن المستخدم من التنقّل للأمام بين بطاقات الصفحة الرئيسية والبطاقات السياقية.

متوفّرة لإضافات Google Workspace وغير متوفّرة لتطبيقات Google Chat

CardAction

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

متوفّرة لإضافات Google Workspace وغير متوفّرة لتطبيقات Google Chat

الحقول
action_label

string

التصنيف الذي يظهر كعنصر في قائمة الإجراءات.
on_click

OnClick

تمثّل هذه السمة الإجراء onClick لبند العمل هذا.

CardFixedFooter

تذييل ثابت يظهر في أسفل البطاقة

يؤدي ضبط fixedFooter بدون تحديد primaryButton أو secondaryButton إلى حدوث خطأ.

بالنسبة إلى تطبيقات Chat، يمكنك استخدام تذييلات ثابتة في مربّعات الحوار، ولكن ليس في رسائل البطاقات. للاطّلاع على مثال في تطبيقات Google Chat، يمكنك الانتقال إلى إضافة تذييل ثابت.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

الحقول
primary_button

Button

الزر الأساسي في التذييل الثابت يجب أن يكون الزر زر نص مع ضبط النص واللون.
secondary_button

Button

الزر الثانوي في التذييل الثابت يجب أن يكون الزر زر نص مع ضبط النص واللون. في حال ضبط secondaryButton، يجب أيضًا ضبط primaryButton.

CardHeader

تمثّل هذه السمة عنوان البطاقة. للاطّلاع على مثال في تطبيقات Google Chat، يُرجى الاطّلاع على إضافة عنوان.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

الحقول
title

string

مطلوب. تمثّل هذه السمة عنوان رأس البطاقة. يبلغ ارتفاع العنوان قيمة ثابتة: إذا تم تحديد كل من العنوان والعنوان الفرعي، سيشغل كل منهما سطرًا واحدًا. إذا تم تحديد العنوان فقط، سيشغل كلا السطرين.
subtitle

string

تمثّل هذه السمة العنوان الفرعي لعنوان البطاقة. إذا تم تحديدها، ستظهر في سطر منفصل أسفل title.
image_type

ImageType

الشكل المستخدَم لاقتصاص الصورة

متاحة لتطبيقات Google Chat وإضافات Google Workspace.
image_url

string

عنوان HTTPS URL الخاص بالصورة في عنوان البطاقة
image_alt_text

string

النص البديل لهذه الصورة المستخدَم لتسهيل الاستخدام

DisplayStyle

في إضافات Google Workspace، تحدّد هذه السمة طريقة عرض البطاقة.

متوفّرة لإضافات Google Workspace وغير متوفّرة لتطبيقات Google Chat

عمليات التعداد
DISPLAY_STYLE_UNSPECIFIED لا تستخدِمها. غير محدد
PEEK يظهر عنوان البطاقة في أسفل الشريط الجانبي، ويغطي جزئيًا البطاقة العلوية الحالية في الحزمة. يؤدي النقر على العنوان إلى إظهار البطاقة في حزمة البطاقات. إذا لم تتضمّن البطاقة عنوانًا، سيتم استخدام عنوان من إنشاء النظام بدلاً من ذلك.
REPLACE القيمة التلقائية يتم عرض البطاقة من خلال استبدال طريقة عرض البطاقة العلوية في حزمة البطاقات.

DividerStyle

تمثّل هذه السمة نمط فاصل البطاقة. تُستخدَم حاليًا فقط للفواصل بين أقسام البطاقات.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

عمليات التعداد
DIVIDER_STYLE_UNSPECIFIED لا تستخدِمها. غير محدد
SOLID_DIVIDER الخيار التلقائي عرض مقسّم ثابت
NO_DIVIDER في حال ضبط هذا الخيار، لن يتم عرض أي فاصل. يزيل هذا النمط الفاصل من التصميم تمامًا. والنتيجة مماثلة لعدم إضافة فاصل على الإطلاق.

NestedWidget

قائمة بعناصر واجهة المستخدم التي يمكن عرضها في تخطيط يحتوي على عناصر أخرى، مثل CarouselCard. متاحة لتطبيقات Google Chat وغير متاحة لإضافات Google Workspace

الحقول

حقل الدمج data

يمكن أن تكون data إحدى القيم التالية فقط:
text_paragraph

TextParagraph

أداة فقرة نصية
button_list

ButtonList

عنصر واجهة مستخدم لقائمة أزرار
image

Image

أداة صورة

القسم

يحتوي القسم على مجموعة من التطبيقات المصغّرة التي يتم عرضها عموديًا بالترتيب المحدّد.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

الحقول
header

string

النص الذي يظهر في أعلى القسم يتوافق مع النصوص المنسَّقة بتنسيق HTML البسيط. لمزيد من المعلومات حول تنسيق النص، يُرجى الاطّلاع على تنسيق النص في تطبيقات Google Chat وتنسيق النص في إضافات Google Workspace.
widgets[]

Widget

جميع الأدوات في القسم يجب أن تحتوي على تطبيق مصغّر واحد على الأقل.
collapsible

bool

يشير إلى ما إذا كان هذا القسم قابلاً للتصغير.

تخفي الأقسام القابلة للتصغير بعض الأدوات أو كلها، ولكن يمكن للمستخدمين توسيع القسم للكشف عن الأدوات المخفية من خلال النقر على عرض المزيد. يمكن للمستخدمين إخفاء التطبيقات المصغّرة مرة أخرى من خلال النقر على عرض أقل.

لتحديد التطبيقات المصغّرة المخفية، حدِّد uncollapsibleWidgetsCount.
uncollapsible_widgets_count

int32

عدد الأدوات غير القابلة للتصغير التي تظل مرئية حتى عند تصغير أحد الأقسام

على سبيل المثال، عندما يحتوي قسم على 5 أدوات ويكون uncollapsibleWidgetsCount مضبوطًا على 2، يتم عرض أول أداتَين دائمًا ويتم تصغير آخر 3 أدوات تلقائيًا. يتم أخذ uncollapsibleWidgetsCount في الاعتبار فقط عندما تكون قيمة collapsible هي true.
collapse_control

CollapseControl

اختيارية: تحديد زر توسيع القسم وتصغيره لن يظهر هذا الزر إلا إذا كان القسم قابلاً للتصغير. في حال عدم ضبط هذا الحقل، يتم استخدام الزر التلقائي.

تعمل لوحة العرض الدوّارة، المعروفة أيضًا باسم شريط التمرير، على تدوير وعرض قائمة من الأدوات في شكل عرض شرائح، مع أزرار للتنقّل إلى الأداة السابقة أو التالية.

على سبيل المثال، هذا تمثيل JSON للوحة عرض دوّارة تحتوي على ثلاث أدوات فقرات نصية.

{
  "carouselCards": [
    {
      "widgets": [
        {
          "textParagraph": {
            "text": "First text paragraph in carousel",
          }
        }
      ]
    },
    {
      "widgets": [
        {
          "textParagraph": {
            "text": "Second text paragraph in carousel",
          }
        }
      ]
    },
    {
      "widgets": [
        {
          "textParagraph": {
            "text": "Third text paragraph in carousel",
          }
        }
      ]
    }
  ]
}

متاحة لتطبيقات Google Chat وغير متاحة لإضافات Google Workspace

الحقول
carousel_cards[]

CarouselCard

تمثّل هذه السمة قائمة بالبطاقات المُدرَجة في لوحة العرض الدوّارة.

CarouselCard

بطاقة يمكن عرضها كعنصر في لوحة عرض دوّارة متاحة لتطبيقات Google Chat وغير متاحة لإضافات Google Workspace

الحقول
widgets[]

NestedWidget

تمثّل هذه السمة قائمة بالتطبيقات المصغّرة المعروضة في بطاقة لوحة العرض الدوّارة. يتم عرض التطبيقات المصغّرة بالترتيب الذي تم تحديده.
footer_widgets[]

NestedWidget

قائمة بالتطبيقات المصغّرة المعروضة في أسفل بطاقة لوحة العرض الدوّارة يتم عرض التطبيقات المصغّرة بالترتيب الذي تم تحديده.

شريحة

شريحة نصية أو رمز أو شريحة نصية ورمز يمكن للمستخدمين النقر عليها

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

الحقول
icon

Icon

صورة الرمز إذا تم ضبط كل من icon وtext، سيظهر الرمز قبل النص.
label

string

النص المعروض داخل الشريحة
on_click

OnClick

اختيارية: الإجراء الذي سيتم تنفيذه عندما ينقر المستخدم على الشريحة، مثل فتح رابط تشعّبي أو تنفيذ دالة مخصّصة
enabled
(deprecated)

bool

تُستخدَم لتحديد ما إذا كانت الشريحة في حالة نشطة وتستجيب لإجراءات المستخدم. القيمة التلقائية هي true. تمّ الإيقاف. يمكنك استخدام disabled كبديل.
disabled

bool

تُستخدَم لتحديد ما إذا كانت الشريحة في حالة غير نشطة وتتجاهل إجراءات المستخدم. القيمة التلقائية هي false.
alt_text

string

النص البديل المستخدَم لتسهيل الاستخدام

اضبط نصًا وصفيًا يتيح للمستخدمين معرفة وظيفة الشريحة. على سبيل المثال، إذا كانت الشريحة تفتح ارتباطًا تشعبيًا، اكتب: "يفتح علامة تبويب جديدة في المتصفّح وينتقِل إلى مستندات المطوّرين في Google Chat على الرابط https://developers.google.com/workspace/chat".

ChipList

قائمة بالرقائق مرتّبة أفقيًا، ويمكن إما التمرير أفقيًا أو الانتقال إلى السطر التالي.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

الحقول
layout

Layout

تخطيط قائمة الشرائح المحدّد
chips[]

Chip

مجموعة من الشرائح.

التنسيق

تنسيق قائمة الشرائح

عمليات التعداد
LAYOUT_UNSPECIFIED لا تستخدِمها. غير محدد
WRAPPED القيمة التلقائية تلتفّ قائمة الشرائح إلى السطر التالي إذا لم تتوفّر مساحة أفقية كافية.
HORIZONTAL_SCROLLABLE يتم تمرير الشرائح أفقيًا إذا لم تتسع في المساحة المتاحة.

CollapseControl

تمثّل عنصر تحكّم للتوسيع والتصغير.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

الحقول
horizontal_alignment

HorizontalAlignment

المحاذاة الأفقية لزرَي التوسيع والتصغير
expand_button

Button

اختيارية: حدِّد زرًا قابلاً للتخصيص لتوسيع القسم. يجب ضبط الحقلَين expand_button وcollapse_button. لن يتم تفعيل مجموعة حقول واحدة فقط. في حال عدم ضبط هذا الحقل، يتم استخدام الزر التلقائي.
collapse_button

Button

اختيارية: حدِّد زرًا قابلاً للتخصيص لتصغير القسم. يجب ضبط الحقلَين expand_button وcollapse_button. لن يتم تفعيل مجموعة حقول واحدة فقط. في حال عدم ضبط هذا الحقل، يتم استخدام الزر التلقائي.

الأعمدة

تعرض الأداة Columns ما يصل إلى عمودَين في بطاقة أو مربّع حوار. يمكنك إضافة أدوات إلى كل عمود، وتظهر الأدوات بالترتيب الذي تم تحديده. للاطّلاع على مثال في تطبيقات Google Chat، راجِع عرض البطاقات ومربّعات الحوار في أعمدة.

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

يتم عرض الأعمدة جنبًا إلى جنب. يمكنك تخصيص عرض كل عمود باستخدام الحقل HorizontalSizeStyle. إذا كان عرض شاشة المستخدم ضيقًا جدًا، سيتم التفاف العمود الثاني أسفل العمود الأول:

  • على الويب، يتم التفاف العمود الثاني إذا كان عرض الشاشة أقل من أو يساوي 480 بكسل.
  • على أجهزة iOS، يتم التفاف العمود الثاني إذا كان عرض الشاشة أقل من أو يساوي 300 نقطة.
  • على أجهزة Android، يتم التفاف العمود الثاني إذا كان عرض الشاشة أقل من 320 وحدة بكسل مستقلة الكثافة أو يساويها.

لتضمين أكثر من عمودَين أو لاستخدام الصفوف، استخدِم أداة Grid.

متاحة لتطبيقات Google Chat وإضافات Google Workspace. تشمل واجهات المستخدم للإضافات التي تتوافق مع الأعمدة ما يلي:

  • مربّع الحوار الذي يظهر عندما يفتح المستخدمون الإضافة من مسودة رسالة إلكترونية
  • مربّع الحوار الذي يظهر عندما يفتح المستخدمون الإضافة من قائمة إضافة مرفق في حدث "تقويم Google"
الحقول
column_items[]

Column

مصفوفة من الأعمدة يمكنك تضمين ما يصل إلى عمودَين في بطاقة أو مربّع حوار.

العمود

عمود

إضافات Google Workspace وتطبيقات Chat

الحقول
horizontal_size_style

HorizontalSizeStyle

تحدّد هذه السمة كيفية ملء العمود لعرض البطاقة.
horizontal_alignment

HorizontalAlignment

تحدّد ما إذا كانت العناصر تتراصف إلى يسار العمود أو يمينه أو وسطه.
vertical_alignment

VerticalAlignment

تحدّد ما إذا كانت الأدوات تتوافق مع أعلى العمود أو أسفله أو وسطه.
widgets[]

Widgets

مجموعة من التطبيقات المصغّرة المضمّنة في عمود تظهر التطبيقات المصغّرة بالترتيب الذي تم تحديده.

HorizontalSizeStyle

تحدّد هذه السمة كيفية ملء العمود لعرض البطاقة. يعتمد عرض كل عمود على كلّ من HorizontalSizeStyle وعرض الأدوات داخل العمود.

إضافات Google Workspace وتطبيقات Chat

عمليات التعداد
HORIZONTAL_SIZE_STYLE_UNSPECIFIED لا تستخدِمها. غير محدد
FILL_AVAILABLE_SPACE القيمة التلقائية يملأ العمود المساحة المتاحة، بما يصل إلى% 70 من عرض البطاقة. إذا تم ضبط كلا العمودين على FILL_AVAILABLE_SPACE، سيملأ كل عمود% 50 من المساحة.
FILL_MINIMUM_SPACE يملأ العمود أقل مساحة ممكنة ولا يزيد عن% 30 من عرض البطاقة.

VerticalAlignment

تحدّد ما إذا كانت الأدوات تتوافق مع أعلى العمود أو أسفله أو وسطه.

إضافات Google Workspace وتطبيقات Chat

عمليات التعداد
VERTICAL_ALIGNMENT_UNSPECIFIED لا تستخدِمها. غير محدد
CENTER القيمة التلقائية تتم محاذاة التطبيقات المصغّرة إلى وسط العمود.
TOP تتم محاذاة التطبيقات المصغّرة مع أعلى العمود.
BOTTOM تتم محاذاة التطبيقات المصغّرة إلى أسفل العمود.

التطبيقات المصغَّرة

الأدوات المصغّرة المتوافقة التي يمكنك تضمينها في عمود

إضافات Google Workspace وتطبيقات Chat

الحقول

حقل الدمج data

يمكن أن تكون data إحدى القيم التالية فقط:
text_paragraph

TextParagraph

التطبيق المصغَّر TextParagraph.
image

Image

التطبيق المصغَّر Image.
decorated_text

DecoratedText

التطبيق المصغَّر DecoratedText.
button_list

ButtonList

التطبيق المصغَّر ButtonList.
text_input

TextInput

التطبيق المصغَّر TextInput.
selection_input

SelectionInput

التطبيق المصغَّر SelectionInput.
date_time_picker

DateTimePicker

التطبيق المصغَّر DateTimePicker.
chip_list

ChipList

التطبيق المصغَّر ChipList.

DateTimePicker

تتيح للمستخدمين إدخال تاريخ أو وقت أو كليهما. يتيح التحقّق من صحة عمليات إرسال النماذج. عند ضبط Action.all_widgets_are_required على true أو تحديد هذه الأداة في Action.required_widgets، يتم حظر إجراء الإرسال ما لم يتم تحديد قيمة. للاطّلاع على مثال في تطبيقات Google Chat، يُرجى الانتقال إلى السماح للمستخدم باختيار تاريخ ووقت.

يمكن للمستخدمين إدخال نص أو استخدام أداة الاختيار لتحديد التواريخ والأوقات. إذا أدخل المستخدمون تاريخًا أو وقتًا غير صالحَين، ستعرض أداة الاختيار خطأ يطلب من المستخدمين إدخال المعلومات بشكل صحيح.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

الحقول
name

string

الاسم الذي يتم من خلاله تحديد DateTimePicker في حدث إدخال نموذج.

لمزيد من التفاصيل حول استخدام إدخالات النماذج، يُرجى الاطّلاع على تلقّي بيانات النماذج.
label

string

النص الذي يطلب من المستخدمين إدخال تاريخ أو وقت أو تاريخ ووقت على سبيل المثال، إذا كان المستخدمون يحدّدون موعدًا، استخدِم تصنيفًا مثل Appointment date أو Appointment date and time.
type

DateTimePickerType

تحدّد هذه السمة ما إذا كانت الأداة تتيح إدخال تاريخ أو وقت أو كليهما.
value_ms_epoch

int64

القيمة التلقائية المعروضة في الأداة، بالملّي ثانية منذ وقت بدء حساب الفترة في نظام Unix

حدِّد القيمة استنادًا إلى نوع أداة الاختيار (DateTimePickerType):

  • ‫DATE_AND_TIME: تاريخ ووقت التقويم بالتوقيت العالمي المتفق عليه على سبيل المثال، لتمثيل 1 يناير 2023 في الساعة 12:00 ظهرًا حسب التوقيت العالمي المتفق عليه، استخدِم 1672574400000.
  • ‫DATE_ONLY: هو تاريخ تقويمي في الساعة 00:00:00 بالتوقيت العالمي المتفق عليه. على سبيل المثال، لتمثيل 1 يناير 2023، استخدِم 1672531200000.
  • ‫TIME_ONLY: وقت بالتوقيت العالمي المتفق عليه على سبيل المثال، لتمثيل الساعة 12:00 ظهرًا، استخدِم 43200000 (أو 12 * 60 * 60 * 1000).
timezone_offset_date

int32

الرقم الذي يمثّل معادلة المنطقة الزمنية من التوقيت العالمي المنسّق، بالدقائق في حال ضبطها، يتم عرض value_ms_epoch في المنطقة الزمنية المحدّدة. في حال عدم ضبطها، تكون القيمة التلقائية هي إعداد المنطقة الزمنية للمستخدم.
on_change_action

Action

يتم تشغيله عندما ينقر المستخدم على حفظ أو محو من واجهة DateTimePicker.

DateTimePickerType

تمثّل هذه السمة تنسيق التاريخ والوقت في التطبيق المصغّر DateTimePicker. يحدّد ما إذا كان يمكن للمستخدمين إدخال تاريخ أو وقت أو كليهما.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

عمليات التعداد
DATE_AND_TIME يُدخل المستخدمون تاريخًا ووقتًا.
DATE_ONLY يُدخل المستخدمون تاريخًا.
TIME_ONLY يُدخل المستخدمون وقتًا.

DecoratedText

أداة تعرض نصًا مع زخارف اختيارية، مثل تصنيف أعلى النص أو أسفله، أو رمز أمام النص، أو أداة اختيار، أو زر بعد النص. للاطّلاع على مثال في تطبيقات Google Chat، يُرجى الانتقال إلى عرض نص باستخدام نص مزخرف.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

الحقول
icon
(deprecated)

Icon

تم إيقافها نهائيًا واستبدالها بـ startIcon.
start_icon

Icon

الأيقونة المعروضة أمام النص
start_icon_vertical_alignment

VerticalAlignment

اختيارية: المحاذاة العمودية لرمز البدء في حال عدم ضبط هذه السمة، سيتم توسيط الرمز عموديًا.

متاحة لتطبيقات Google Chat وغير متاحة لإضافات Google Workspace
top_label

string

النص الذي يظهر فوق text يتم اقتطاعها دائمًا.
top_label_text

TextParagraph

TextParagraph يعادل top_label. يتم اقتطاعها دائمًا. يسمح بتنسيق أكثر تعقيدًا من top_label.

متاحة لتطبيقات Google Chat وغير متاحة لإضافات Google Workspace
text

string

مطلوب. النص الأساسي

يتيح التنسيق البسيط. لمزيد من المعلومات حول تنسيق النص، يُرجى الاطّلاع على تنسيق النص في تطبيقات Google Chat وتنسيق النص في إضافات Google Workspace.
content_text

TextParagraph

TextParagraph يعادل text. يسمح بتنسيق أكثر تعقيدًا من text.

متاحة لتطبيقات Google Chat وغير متاحة لإضافات Google Workspace
wrap_text

bool

إعداد التفاف النص إذا كانت القيمة true، يتم التفاف النص وعرضه على عدة أسطر. وإلا سيتم اقتطاع النص.

ينطبق ذلك على text فقط، وليس على topLabel وbottomLabel.
bottom_label

string

النص الذي يظهر أسفل text التفاف دائمًا
bottom_label_text

TextParagraph

TextParagraph تعادل bottom_label. التفاف دائمًا يسمح بتنسيق أكثر تعقيدًا من bottom_label.

متاحة لتطبيقات Google Chat وغير متاحة لإضافات Google Workspace
on_click

OnClick

يتم تشغيل هذا الإجراء عندما ينقر المستخدمون على topLabel أو bottomLabel.
حقل الدمج control زر أو مفتاح تبديل أو مربّع اختيار أو صورة تظهر على يسار النص في أداة decoratedText. يمكن أن تكون control إحدى القيم التالية فقط:
button

Button

زر يمكن للمستخدم النقر عليه لتنفيذ إجراء.
switch_control

SwitchControl

أداة تبديل يمكن للمستخدم النقر عليها لتغيير حالتها وتنفيذ إجراء.
end_icon

Icon

رمز معروض بعد النص

يتيح استخدام الرموز المضمّنة والمخصّصة.

عنصر تحكم التبديل

إما مفتاح تبديل أو مربّع اختيار داخل أداة decoratedText.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

تتوفّر هذه الميزة في أداة decoratedText فقط.

الحقول
name

string

الاسم الذي يتم من خلاله تحديد أداة التبديل في حدث إدخال نموذج.

لمزيد من التفاصيل حول استخدام إدخالات النماذج، يُرجى الاطّلاع على تلقّي بيانات النماذج.
value

string

القيمة التي أدخلها المستخدم، ويتم عرضها كجزء من حدث إدخال نموذج.

لمزيد من التفاصيل حول استخدام إدخالات النماذج، يُرجى الاطّلاع على تلقّي بيانات النماذج.
selected

bool

عندما تكون القيمة true، يتم اختيار مفتاح التبديل.
on_change_action

Action

الإجراء الذي سيتم تنفيذه عند تغيير حالة مفتاح التبديل، مثل الدالة التي سيتم تشغيلها
control_type

ControlType

طريقة ظهور مفتاح التبديل في واجهة المستخدم

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

ControlType

طريقة ظهور مفتاح التبديل في واجهة المستخدم

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

عمليات التعداد
SWITCH مفتاح تبديل بنمط زر الإيقاف/التشغيل
CHECKBOX تم إيقافها نهائيًا واستبدالها بـ CHECK_BOX.
CHECK_BOX مربّع اختيار

حاجز

لا يتضمّن هذا النوع أي حقول.

تعرض هذه السمة فاصلاً بين التطبيقات المصغّرة على شكل خط أفقي. للاطّلاع على مثال في تطبيقات Google Chat، يمكنك الانتقال إلى إضافة فاصل أفقي بين التطبيقات المصغّرة.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

على سبيل المثال، ينشئ ملف JSON التالي مقسّمًا:

"divider": {}

شبكة

تعرِض هذه السمة شبكة تحتوي على مجموعة من العناصر. يمكن أن تتضمّن العناصر نصًا أو صورًا فقط. بالنسبة إلى الأعمدة السريعة الاستجابة أو لتضمين أكثر من نص أو صور، استخدِم Columns. للاطّلاع على مثال في تطبيقات Google Chat، يمكنك الانتقال إلى عرض شبكة تتضمّن مجموعة من العناصر.

يمكن أن تحتوي الشبكة على أي عدد من الأعمدة والعناصر. يتم تحديد عدد الصفوف من خلال تقسيم عدد العناصر على عدد الأعمدة. تحتوي الشبكة التي تضم 10 عناصر وعمودَين على 5 صفوف. تحتوي الشبكة التي تضم 11 عنصرًا وعمودَين على 6 صفوف.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

على سبيل المثال، ينشئ ملف JSON التالي شبكة من عمودَين تحتوي على عنصر واحد:

"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"
    }
  }
}
الحقول
title

string

النص الذي يظهر في عنوان الجدول
items[]

GridItem

تمثّل هذه السمة العناصر المطلوب عرضها في الشبكة.
border_style

BorderStyle

نمط الحدود الذي سيتم تطبيقه على كل عنصر من عناصر الشبكة
column_count

int32

عدد الأعمدة المطلوب عرضها في الشبكة يتم استخدام قيمة تلقائية إذا لم يتم تحديد هذا الحقل، وتختلف هذه القيمة التلقائية حسب مكان عرض الشبكة (مربّع الحوار مقابل الإعلان المرافق).
on_click

OnClick

تتم إعادة استخدام دالة معاودة الاتصال هذه من خلال كل عنصر من عناصر الشبكة، ولكن مع إضافة معرّف العنصر وفهرسه في قائمة العناصر إلى مَعلمات دالة معاودة الاتصال.

GridItem

تمثّل هذه السمة عنصرًا في تصميم شبكي. يمكن أن تحتوي العناصر على نص أو صورة أو كليهما.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

الحقول
id

string

معرّف يحدّده المستخدم لعنصر الشبكة هذا. يتم عرض هذا المعرّف في مَعلمات معاودة الاتصال onClick للشبكة الرئيسية.
image

ImageComponent

الصورة التي تظهر في عنصر الشبكة
title

string

تمثّل هذه السمة عنوان العنصر في الشبكة.
subtitle

string

العنوان الفرعي لعنصر الشبكة
layout

GridItemLayout

تنسيق العنصر في الشبكة

GridItemLayout

تمثّل هذه السمة خيارات التنسيق المختلفة المتاحة لعنصر في شبكة.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

عمليات التعداد
GRID_ITEM_LAYOUT_UNSPECIFIED لا تستخدِمها. غير محدد
TEXT_BELOW يظهر العنوان والعنوان الفرعي أسفل صورة عنصر الشبكة.
TEXT_ABOVE يظهر العنوان والعنوان الفرعي فوق صورة عنصر الشبكة.

رمز

رمز معروض في أداة على بطاقة للاطّلاع على مثال في تطبيقات Google Chat، يُرجى الانتقال إلى إضافة رمز.

يتيح استخدام الرموز المضمّنة والمخصّصة.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

الحقول
alt_text

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 الخاص بالرمز.
image_type

ImageType

نمط الاقتصاص المُطبَّق على الصورة. في بعض الحالات، يؤدي تطبيق CIRCLE اقتصاص إلى عرض الصورة بحجم أكبر من الرمز المضمّن.
حقل الدمج icons الرمز المعروض في الأداة على البطاقة يمكن أن تكون icons إحدى القيم التالية فقط:
known_icon

string

عرض إحدى الأيقونات المضمّنة التي توفّرها Google Workspace

على سبيل المثال، لعرض رمز طائرة، حدِّد AIRPLANE. بالنسبة إلى الحافلة، حدِّد BUS.

للحصول على قائمة كاملة بالرموز المتوافقة، راجِع الرموز المضمّنة.
icon_url

string

عرض رمز مخصّص مستضاف على عنوان URL يستخدم HTTPS

على سبيل المثال:

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

تشمل أنواع الملفات المتوافقة .png و.jpg.
material_icon

MaterialIcon

عرض أحد رموز Google Material

على سبيل المثال، لعرض رمز مربّع اختيار، استخدِم

"material_icon": {
  "name": "check_box"
}

متاحة لتطبيقات Google Chat وغير متاحة لإضافات Google Workspace

صورة

صورة يحدّدها عنوان URL ويمكن أن تتضمّن إجراء onClick. للاطّلاع على مثال، يُرجى الانتقال إلى إضافة صورة.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

الحقول
image_url

string

عنوان URL الخاص ببروتوكول HTTPS الذي يستضيف الصورة

على سبيل المثال:

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

OnClick

عندما ينقر المستخدم على الصورة، يؤدي النقر إلى تشغيل هذا الإجراء.
alt_text

string

النص البديل لهذه الصورة المستخدَم لتسهيل الاستخدام

ImageComponent

تمثّل هذه السمة صورة.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

الحقول
image_uri

string

عنوان URL الخاص بالصورة
alt_text

string

تمثّل هذه السمة التصنيف المخصّص لتسهيل استخدام الصورة.
crop_style

ImageCropStyle

نمط الاقتصاص الذي سيتم تطبيقه على الصورة.
border_style

BorderStyle

نمط الحدود المطلوب تطبيقه على الصورة.

ImageCropStyle

تمثّل هذه السمة نمط الاقتصاص الذي تم تطبيقه على صورة.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

على سبيل المثال، إليك كيفية تطبيق نسبة عرض إلى ارتفاع 16:9:

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}
الحقول
type

ImageCropType

نوع المحصول
aspect_ratio

double

نسبة العرض إلى الارتفاع التي سيتم استخدامها إذا كان نوع الاقتصاص هو RECTANGLE_CUSTOM

على سبيل المثال، إليك كيفية تطبيق نسبة عرض إلى ارتفاع 16:9:

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

ImageCropType

تمثّل هذه السمة نمط الاقتصاص الذي تم تطبيقه على صورة.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

عمليات التعداد
IMAGE_CROP_TYPE_UNSPECIFIED لا تستخدِمها. غير محدد
SQUARE القيمة التلقائية تطبيق اقتصاص مربّع
CIRCLE تطبيق اقتصاص دائري
RECTANGLE_CUSTOM تطبيق اقتصاص مستطيل بنسبة عرض إلى ارتفاع مخصّصة اضبط نسبة العرض إلى الارتفاع المخصّصة باستخدام aspectRatio.
RECTANGLE_4_3 تطبيق اقتصاص مستطيل بنسبة عرض إلى ارتفاع 4:3

MaterialIcon

رمز Google Material، الذي يتضمّن أكثر من 2500 خيار

على سبيل المثال، لعرض رمز مربّع الاختيار مع وزن ودرجة مخصّصَين، اكتب ما يلي:

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

متاحة لتطبيقات Google Chat وغير متاحة لإضافات Google Workspace

الحقول
name

string

اسم الرمز المحدّد في Google Material Icon، مثل check_box يتم تجاهل أي أسماء غير صالحة واستبدالها بسلسلة فارغة، ما يؤدي إلى تعذُّر عرض الرمز.
fill

bool

تحديد ما إذا كان الرمز سيظهر ممتلئًا القيمة التلقائية هي "خطأ".

لمعاينة إعدادات الرموز المختلفة، انتقِل إلى رموز خطوط Google واضبط الإعدادات ضمن تخصيص.
weight

int32

كثافة خط الرمز اختَر من بين {100, 200, 300, 400, 500, 600, 700}. إذا لم يتم تحديدها، تكون القيمة التلقائية 400. في حال تحديد أي قيمة أخرى، يتم استخدام القيمة التلقائية.

لمعاينة إعدادات الرموز المختلفة، انتقِل إلى رموز خطوط Google واضبط الإعدادات ضمن تخصيص.
grade

int32

يؤثر الوزن والدرجة في سُمك الرمز. تكون التعديلات على الدرجة أكثر تفصيلاً من التعديلات على الوزن، كما أنّها تؤثر بشكل بسيط على حجم الرمز. اختَر من بين القيم {-25, 0, 200}. في حال عدم توفّرها، تكون القيمة التلقائية 0. في حال تحديد أي قيمة أخرى، يتم استخدام القيمة التلقائية.

لمعاينة إعدادات الرموز المختلفة، انتقِل إلى رموز خطوط Google واضبط الإعدادات ضمن تخصيص.

OnClick

تمثّل هذه السمة كيفية الردّ عندما ينقر المستخدمون على عنصر تفاعلي في بطاقة، مثل زر.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

الحقول

حقل الدمج data

يمكن أن تكون data إحدى القيم التالية فقط:
action

Action

في حال تحديدها، يتم تشغيل إجراء من خلال onClick.
card

Card

يتم إرسال بطاقة جديدة إلى حزمة البطاقات بعد النقر عليها إذا تم تحديد ذلك.

متوفّرة لإضافات Google Workspace وغير متوفّرة لتطبيقات Google Chat
overflow_menu

OverflowMenu

في حال تحديدها، تفتح هذه السمة onClick قائمة كاملة.

OnClose

يتم تنفيذ هذا الإجراء عندما يتم إغلاق رابط تم فتحه من خلال إجراء OnClick.

تعتمد عملية التنفيذ على إمكانات النظام الأساسي للعميل. على سبيل المثال، قد يفتح متصفّح ويب رابطًا في نافذة منبثقة باستخدام معالج OnClose.

في حال ضبط كل من معالجَي OnOpen وOnClose، وتعذّر على منصة العميل إتاحة كلتا القيمتَين، تكون الأولوية لمعالج OnClose.

متوفّرة لإضافات Google Workspace وغير متوفّرة لتطبيقات Google Chat

عمليات التعداد
NOTHING القيمة التلقائية لا تتم إعادة تحميل البطاقة، ولا يحدث أي شيء.
RELOAD

تعيد تحميل البطاقة بعد إغلاق النافذة الفرعية.

في حال استخدامها مع OpenAs.OVERLAY، تعمل النافذة الفرعية كمربّع حوار مشروط ويتم حظر البطاقة الرئيسية إلى أن يتم إغلاق النافذة الفرعية.

OpenAs

عندما يفتح إجراء OnClick رابطًا، يمكن للعميل إما فتحه كنافذة بالحجم الكامل (إذا كان هذا هو الإطار الذي يستخدمه العميل)، أو كطبقة متراكبة (مثل نافذة منبثقة). يعتمد التنفيذ على إمكانات النظام الأساسي للعميل، وقد يتم تجاهل القيمة المحدّدة إذا كان العميل لا يتيحها. تتوافق FULL_SIZE مع جميع البرامج.

متوفّرة لإضافات Google Workspace وغير متوفّرة لتطبيقات Google Chat

عمليات التعداد
FULL_SIZE يتم فتح الرابط كنافذة بالحجم الكامل (إذا كان هذا هو الإطار الذي يستخدمه العميل).
OVERLAY يتم فتح الرابط كتراكب، مثل نافذة منبثقة.

OverflowMenu

أداة تعرض قائمة منبثقة تتضمّن إجراءً واحدًا أو أكثر يمكن للمستخدمين تنفيذه. على سبيل المثال، عرض إجراءات غير أساسية في بطاقة يمكنك استخدام هذه الأداة عندما لا تتناسب الإجراءات مع المساحة المتاحة. لاستخدام هذه السمة، حدِّد التطبيق المصغّر في الإجراء OnClick للتطبيقات المصغّرة التي تتوافق معها. على سبيل المثال، في Button.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

الحقول
items[]

OverflowMenuItem

مطلوب. قائمة خيارات القائمة

OverflowMenuItem

خيار يمكن للمستخدمين استخدامه في قائمة الخيارات الكاملة

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

الحقول
start_icon

Icon

الأيقونة المعروضة أمام النص
text

string

مطلوب. النص الذي يحدّد السلعة أو يصفها للمستخدمين
on_click

OnClick

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

bool

تحديد ما إذا كان خيار القائمة غير مفعَّل. القيمة التلقائية هي "خطأ".

SelectionInput

تطبيق مصغّر ينشئ عنصرًا واحدًا أو أكثر من عناصر واجهة المستخدِم التي يمكن للمستخدمين اختيارها. تتيح التحقّق من صحة عمليات إرسال النماذج لقوائم dropdown وmultiselect فقط. عند ضبط Action.all_widgets_are_required على true أو تحديد هذه الأداة في Action.required_widgets، يتم حظر إجراء الإرسال ما لم يتم تحديد قيمة. على سبيل المثال، قائمة منسدلة أو مربّعات اختيار. يمكنك استخدام هذه الأداة لجمع البيانات التي يمكن توقّعها أو تعدادها. للاطّلاع على مثال في تطبيقات Google Chat، يمكنك الانتقال إلى إضافة عناصر واجهة مستخدم قابلة للتحديد.

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

لجمع بيانات غير محدّدة أو مجرّدة من المستخدمين، استخدِم أداة TextInput.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

الحقول
name

string

مطلوب. الاسم الذي يحدّد إدخال التحديد في حدث إدخال نموذج.

لمزيد من التفاصيل حول استخدام إدخالات النماذج، يُرجى الاطّلاع على تلقّي بيانات النماذج.
label

string

النص الذي يظهر فوق حقل إدخال الاختيار في واجهة المستخدم

حدِّد النص الذي يساعد المستخدم في إدخال المعلومات التي يحتاجها تطبيقك. على سبيل المثال، إذا كان المستخدمون يختارون مدى إلحاح طلب عمل من قائمة منسدلة، قد يكون التصنيف "مدى الإلحاح" أو "اختيار مدى الإلحاح".
type

SelectionType

نوع العناصر التي يتم عرضها للمستخدمين في أداة SelectionInput تتيح أنواع التحديد أنواعًا مختلفة من التفاعلات. على سبيل المثال، يمكن للمستخدمين اختيار مربّع اختيار واحد أو أكثر، ولكن يمكنهم اختيار قيمة واحدة فقط من قائمة منسدلة.
items[]

SelectionItem

مصفوفة من العناصر القابلة للاختيار على سبيل المثال، مصفوفة من أزرار الاختيار أو مربّعات الاختيار. يمكن أن يتضمّن ما يصل إلى 100 عنصر.
on_change_action

Action

في حال تحديدها، يتم إرسال النموذج عند تغيير الاختيار. في حال عدم تحديد ذلك، يجب تحديد زرّ منفصل لإرسال النموذج.

لمزيد من التفاصيل حول استخدام إدخالات النماذج، يُرجى الاطّلاع على تلقّي بيانات النماذج.
multi_select_max_selected_items

int32

بالنسبة إلى القوائم المتعددة الاختيارات، الحد الأقصى لعدد العناصر التي يمكن للمستخدم اختيارها. الحد الأدنى للقيمة هو سلعة واحدة. إذا لم يتم تحديد عدد، يكون العدد التلقائي 3 عناصر.
multi_select_min_query_length

int32

بالنسبة إلى قوائم الاختيار المتعدد، يمثّل هذا الحقل عدد أحرف النص التي يُدخلها المستخدم قبل أن تعرض القائمة عناصر الاختيار المقترَحة.

في حال عدم ضبطها، تستخدم قائمة الاختيار المتعدد القيم التلقائية التالية:

  • إذا كانت القائمة تستخدم مصفوفة ثابتة من عناصر SelectionInput، يتم ضبط القيمة التلقائية على 0 حرف وتتم تعبئة العناصر من المصفوفة على الفور.
  • إذا كانت القائمة تستخدم مصدر بيانات ديناميكيًا (multi_select_data_source)، سيتم تلقائيًا استخدام 3 أحرف قبل طلب البحث من مصدر البيانات لعرض العناصر المقترَحة.

حقل الدمج multi_select_data_source بالنسبة إلى قائمة اختيار متعدّد، مصدر بيانات يملأ عناصر الاختيار بشكل ديناميكي.

متاحة لتطبيقات Google Chat وغير متاحة لإضافات Google Workspace يمكن أن تكون multi_select_data_source إحدى القيم التالية فقط:
external_data_source

Action

مصدر بيانات خارجي، مثل قاعدة بيانات ارتباطية
platform_data_source

PlatformDataSource

مصدر بيانات من Google Workspace

PlatformDataSource

بالنسبة إلى أداة SelectionInput تستخدم قائمة اختيار متعدّد، يجب توفير مصدر بيانات من Google Workspace. تُستخدَم لتعبئة العناصر في قائمة اختيار متعدّد.

متاحة لتطبيقات Google Chat وغير متاحة لإضافات Google Workspace

الحقول
حقل الدمج data_source مصدر البيانات يمكن أن تكون data_source إحدى القيم التالية فقط:
common_data_source

CommonDataSource

مصدر بيانات تشترك فيه جميع تطبيقات Google Workspace، مثل المستخدمين في مؤسسة Google Workspace
host_app_data_source

HostAppDataSourceMarkup

مصدر بيانات خاص بتطبيق مضيف في Google Workspace، مثل المساحات في Google Chat

يتوافق هذا الحقل مع Google API Client Libraries، ولكنّه غير متاح في Cloud Client Libraries. لمزيد من المعلومات، يُرجى الاطّلاع على تثبيت مكتبات البرامج.

CommonDataSource

مصدر بيانات تتم مشاركته بين جميع تطبيقات Google Workspace

متاحة لتطبيقات Google Chat وغير متاحة لإضافات Google Workspace

عمليات التعداد
UNKNOWN القيمة التلقائية لا تستخدِمها.
USER مستخدمو Google Workspace يمكن للمستخدم عرض واختيار المستخدمين من مؤسسة Google Workspace فقط.

SelectionItem

عنصر يمكن للمستخدمين اختياره في حقل إدخال اختيار، مثل مربّع اختيار أو مفتاح تحكّم. يمكن أن يتضمّن ما يصل إلى 100 عنصر.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

الحقول
text

string

النص الذي يحدّد السلعة أو يصفها للمستخدمين
value

string

تمثّل هذه السمة القيمة المرتبطة بهذا العنصر. على العميل استخدام هذا المعرّف كقيمة إدخال في النموذج.

لمزيد من التفاصيل حول استخدام إدخالات النماذج، يُرجى الاطّلاع على تلقّي بيانات النماذج.
selected

bool

تُستخدَم لتحديد ما إذا كان العنصر محدَّدًا تلقائيًا. إذا كان عنصر الإدخال المحدد يقبل قيمة واحدة فقط (مثل أزرار الاختيار أو القائمة المنسدلة)، اضبط هذا الحقل لعنصر واحد فقط.
bottom_text

string

بالنسبة إلى قوائم الاختيار المتعدد، وصف نصي أو تصنيف يظهر أسفل حقل text للعنصر
حقل الدمج start_icon بالنسبة إلى قوائم الاختيار المتعدد، عنوان URL للرمز المعروض بجانب الحقل text الخاص بالعنصر. يتوافق مع ملفات PNG وJPEG. يجب أن يكون عنوان URL تابعًا لـ HTTPS. مثلاً: https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png. يمكن أن تكون start_icon إحدى القيم التالية فقط:
start_icon_uri

string

SelectionType

تنسيق العناصر التي يمكن للمستخدمين اختيارها تتيح الخيارات المختلفة أنواعًا مختلفة من التفاعلات. على سبيل المثال، يمكن للمستخدمين وضع علامة في مربّعات اختيار متعدّدة، ولكن يمكنهم اختيار عنصر واحد فقط من قائمة منسدلة.

يتيح كل حقل إدخال اختيار نوعًا واحدًا من الاختيارات. على سبيل المثال، لا يمكن الجمع بين مربّعات الاختيار وأزرار التبديل.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

عمليات التعداد
CHECK_BOX مجموعة من مربّعات الاختيار يمكن للمستخدمين وضع علامة في مربّع اختيار واحد أو أكثر.
RADIO_BUTTON مجموعة من أزرار الاختيار يمكن للمستخدمين تحديد زر اختيار واحد.
SWITCH مجموعة من مفاتيح الإضاءة يمكن للمستخدمين تفعيل مفتاح تحكّم واحد أو أكثر.
DROPDOWN قائمة منسدلة يمكن للمستخدمين اختيار عنصر واحد من القائمة.
MULTI_SELECT

قائمة تتضمّن مربّع نص يمكن للمستخدمين كتابة كلمة واحدة أو أكثر واختيارها. بالنسبة إلى إضافات Google Workspace، يجب ملء العناصر باستخدام مصفوفة ثابتة من عناصر SelectionItem.

بالنسبة إلى تطبيقات Google Chat، يمكنك أيضًا ملء العناصر باستخدام مصدر بيانات ديناميكي واقتراح العناصر تلقائيًا أثناء كتابة المستخدمين في القائمة. على سبيل المثال، يمكن للمستخدمين البدء في كتابة اسم مساحة Google Chat، وستقترح الأداة المساحة تلقائيًا. لملء عناصر قائمة اختيار متعدّد بشكل ديناميكي، استخدِم أحد أنواع مصادر البيانات التالية:

  • بيانات Google Workspace: تتم تعبئة العناصر باستخدام بيانات من Google Workspace، مثل مستخدمي Google Workspace أو مساحات Google Chat.
  • البيانات الخارجية: يتم ملء العناصر من مصدر بيانات خارجي خارج Google Workspace.

للاطّلاع على أمثلة حول كيفية تنفيذ قوائم اختيار متعدّد لتطبيقات Chat، يُرجى الاطّلاع على إضافة قائمة اختيار متعدّد.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

اقتراحات

القيم المقترَحة التي يمكن للمستخدمين إدخالها تظهر هذه القيم عندما ينقر المستخدمون داخل حقل إدخال النص. أثناء الكتابة، تتم فلترة القيم المقترَحة بشكل ديناميكي لتتطابق مع ما كتبه المستخدمون.

على سبيل المثال، قد يقترح حقل إدخال نص للغة برمجة Java وJavaScript وPython وC++. وعندما يبدأ المستخدمون في كتابة Jav، يتم فلترة قائمة الاقتراحات لعرض Java وJavaScript.

تساعد القيم المقترَحة في توجيه المستخدمين لإدخال قيم يمكن لتطبيقك فهمها. عند الإشارة إلى JavaScript، قد يُدخل بعض المستخدمين javascript والبعض الآخر java script. يمكن أن يؤدي اقتراح JavaScript إلى توحيد طريقة تفاعل المستخدمين مع تطبيقك.

عند تحديدها، تكون قيمة TextInput.type دائمًا SINGLE_LINE، حتى إذا تم ضبطها على MULTIPLE_LINE.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

الحقول
items[]

SuggestionItem

قائمة بالاقتراحات المستخدَمة في اقتراحات الإكمال التلقائي في حقول إدخال النص

SuggestionItem

قيمة مقترَحة يمكن للمستخدمين إدخالها في حقل إدخال نصي

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

الحقول

حقل الدمج content

يمكن أن تكون content إحدى القيم التالية فقط:
text

string

قيمة الإدخال المقترَح في حقل إدخال نصي وهذا يعادل ما يدخله المستخدمون بأنفسهم.

TextInput

حقل يمكن للمستخدمين إدخال نص فيه يتيح الاقتراحات والإجراءات عند التغيير. يتيح التحقّق من صحة عمليات إرسال النماذج. عند ضبط Action.all_widgets_are_required على true أو تحديد هذه الأداة في Action.required_widgets، يتم حظر إجراء الإرسال ما لم يتم إدخال قيمة. للاطّلاع على مثال في تطبيقات Google Chat، راجِع إضافة حقل يمكن للمستخدم إدخال نص فيه.

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

عندما تحتاج إلى جمع بيانات غير محدّدة أو مجرّدة من المستخدمين، استخدِم حقل إدخال نصي. لجمع بيانات محدّدة أو مُعدَّدة من المستخدمين، استخدِم أداة SelectionInput.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

الحقول
name

string

الاسم الذي يتم من خلاله تحديد إدخال النص في حدث إدخال نموذج.

لمزيد من التفاصيل حول استخدام إدخالات النماذج، يُرجى الاطّلاع على تلقّي بيانات النماذج.
label

string

النص الذي يظهر فوق حقل إدخال النص في واجهة المستخدم

حدِّد النص الذي يساعد المستخدم في إدخال المعلومات التي يحتاجها تطبيقك. على سبيل المثال، إذا كنت تسأل عن اسم شخص ما، ولكنك تحتاج تحديدًا إلى اسم عائلته، فاكتب surname بدلاً من name.

مطلوبة إذا لم يتم تحديد hintText. في الحالات الأخرى، يكون الأمر اختياريًا.
hint_text

string

النص الذي يظهر أسفل حقل إدخال النص والمخصّص لمساعدة المستخدمين من خلال مطالبتهم بإدخال قيمة معيّنة يظهر هذا النص دائمًا.

مطلوبة إذا لم يتم تحديد label. في الحالات الأخرى، يكون الأمر اختياريًا.
value

string

القيمة التي أدخلها المستخدم، ويتم عرضها كجزء من حدث إدخال نموذج.

لمزيد من التفاصيل حول استخدام إدخالات النماذج، يُرجى الاطّلاع على تلقّي بيانات النماذج.
type

Type

طريقة ظهور حقل إدخال النص في واجهة المستخدم على سبيل المثال، ما إذا كان الحقل سطرًا واحدًا أو عدة أسطر.
on_change_action

Action

الإجراء الذي يجب اتّخاذه عند حدوث تغيير في حقل إدخال النص على سبيل المثال، إضافة مستخدم إلى الحقل أو حذف نص.

تشمل أمثلة الإجراءات التي يمكن اتّخاذها تنفيذ وظيفة مخصّصة أو فتح مربّع حوار في Google Chat.
initial_suggestions

Suggestions

القيم المقترَحة التي يمكن للمستخدمين إدخالها تظهر هذه القيم عندما ينقر المستخدمون داخل حقل إدخال النص. أثناء الكتابة، تتم فلترة القيم المقترَحة بشكل ديناميكي لتتطابق مع ما كتبه المستخدمون.

على سبيل المثال، قد يقترح حقل إدخال نصي للغة برمجة Java وJavaScript وPython وC++. وعندما يبدأ المستخدمون في كتابة Jav، يتم فلترة قائمة الاقتراحات لعرض Java وJavaScript فقط.

تساعد القيم المقترَحة في توجيه المستخدمين لإدخال قيم يمكن لتطبيقك فهمها. عند الإشارة إلى JavaScript، قد يُدخل بعض المستخدمين javascript والبعض الآخر java script. يمكن أن يؤدي اقتراح JavaScript إلى توحيد طريقة تفاعل المستخدمين مع تطبيقك.

عند تحديدها، تكون قيمة TextInput.type دائمًا SINGLE_LINE، حتى إذا تم ضبطها على MULTIPLE_LINE.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.
auto_complete_action

Action

اختيارية: تحديد الإجراء الذي يجب اتّخاذه عندما يقدّم حقل إدخال النص اقتراحات للمستخدمين الذين يتفاعلون معه

إذا لم يتم تحديدها، يتم ضبط الاقتراحات من خلال initialSuggestions ويتم معالجتها من خلال العميل.

إذا تم تحديد ذلك، يتّخذ التطبيق الإجراء المحدّد هنا، مثل تنفيذ دالة مخصّصة.

متوفّرة لإضافات Google Workspace وغير متوفّرة لتطبيقات Google Chat
validation

Validation

تحديد التحقّق من صحة تنسيق الإدخال المطلوب لحقل النص هذا

متاحة لتطبيقات Google Chat وإضافات Google Workspace.
placeholder_text

string

النص الذي يظهر في حقل إدخال النص عندما يكون الحقل فارغًا استخدِم هذا النص لحثّ المستخدمين على إدخال قيمة. مثلاً: Enter a number from 0 to 100

متاحة لتطبيقات Google Chat وغير متاحة لإضافات Google Workspace

النوع

طريقة ظهور حقل إدخال النص في واجهة المستخدم على سبيل المثال، ما إذا كان حقل إدخال بسطر واحد أو حقل إدخال متعدد الأسطر. في حال تحديد initialSuggestions، تكون قيمة type دائمًا SINGLE_LINE، حتى إذا تم ضبطها على MULTIPLE_LINE.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

عمليات التعداد
SINGLE_LINE يبلغ الارتفاع الثابت لحقل إدخال النص سطرًا واحدًا.
MULTIPLE_LINE يحتوي حقل إدخال النص على ارتفاع ثابت لعدة أسطر.

TextParagraph

فقرة نصية تتيح التنسيق للاطّلاع على مثال في تطبيقات Google Chat، يُرجى الرجوع إلى إضافة فقرة من النص المنسَّق. لمزيد من المعلومات حول تنسيق النص، يُرجى الاطّلاع على تنسيق النص في تطبيقات Google Chat وتنسيق النص في إضافات Google Workspace.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

الحقول
text

string

النص الذي يظهر في الأداة
max_lines

int32

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

القيمة التلقائية هي 0، وفي هذه الحالة يتم عرض كل السياق. يتم تجاهل القيم السلبية.
text_syntax

TextSyntax

بنية النص في حال عدم ضبط هذه السمة، سيتم عرض النص بتنسيق HTML.

متاحة لتطبيقات Google Chat وغير متاحة لإضافات Google Workspace

TextSyntax

بنية الجملة التي يجب استخدامها لتنسيق النص

متاحة لتطبيقات Google Chat وغير متاحة لإضافات Google Workspace

عمليات التعداد
TEXT_SYNTAX_UNSPECIFIED يتم عرض النص بتنسيق HTML إذا لم يتم تحديد تنسيق آخر.
HTML يتم عرض النص بتنسيق HTML. هذه هي القيمة الافتراضية.
MARKDOWN يتم عرض النص بتنسيق Markdown.

التحقّق من الصحة

تمثّل هذه السمة البيانات اللازمة للتحقّق من صحة العنصر المرتبط بها.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

الحقول
character_limit

int32

تحديد الحد الأقصى لعدد الأحرف في أدوات إدخال النص يُرجى العِلم أنّ هذا الخيار يُستخدم فقط لإدخال النص ويتم تجاهله بالنسبة إلى التطبيقات المصغّرة الأخرى.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.
input_type

InputType

حدِّد نوع أدوات الإدخال.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

InputType

نوع أداة الإدخال.

عمليات التعداد
INPUT_TYPE_UNSPECIFIED نوع غير محدَّد لا تستخدم هذه السمة.
TEXT نص عادي يقبل جميع الأحرف
INTEGER قيمة عدد صحيح
FLOAT قيمة عائمة
EMAIL عنوان بريد إلكتروني
EMOJI_PICKER إيموجي تم اختياره من أداة اختيار الإيموجي التي يوفّرها النظام

أداة

تتألف كل بطاقة من تطبيقات مصغّرة.

التطبيق المصغّر هو كائن مركّب يمكنه تمثيل أحد أنواع الكائنات، مثل النصوص والصور والأزرار وغيرها.

الحقول
horizontal_alignment

HorizontalAlignment

تحدّد ما إذا كانت العناصر تتراصف إلى يسار العمود أو يمينه أو وسطه.
حقل الدمج data يمكن أن تحتوي الأداة على عنصر واحد فقط من العناصر التالية. يمكنك استخدام حقول تطبيقات مصغّرة متعددة لعرض المزيد من العناصر. يمكن أن تكون data إحدى القيم التالية فقط:
text_paragraph

TextParagraph

تعرض فقرة نصية. يتوافق مع النصوص المنسَّقة بتنسيق HTML البسيط. لمزيد من المعلومات حول تنسيق النص، يُرجى الاطّلاع على تنسيق النص في تطبيقات Google Chat وتنسيق النص في إضافات Google Workspace.

على سبيل المثال، ينشئ ملف JSON التالي نصًا غامقًا:

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

Image

تعرض هذه السمة صورة.

على سبيل المثال، ينشئ ملف JSON التالي صورة مع نص بديل:

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

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"
  }
}
button_list

ButtonList

قائمة بالأزرار

على سبيل المثال، ينشئ رمز JSON التالي زرّين. الأول هو زر نصي أزرق والثاني هو زر صورة يفتح رابطًا:

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

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"
      }
    ]
  }
}
selection_input

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
    }
  ]
}
date_time_picker

DateTimePicker

تعرض هذه السمة أداة تتيح للمستخدمين إدخال تاريخ أو وقت أو تاريخ ووقت.

على سبيل المثال، ينشئ ملف JSON التالي أداة اختيار التاريخ والوقت لجدولة موعد:

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

Divider

تعرِض هذه السمة خطًا أفقيًا يفصل بين التطبيقات المصغّرة.

على سبيل المثال، ينشئ ملف JSON التالي مقسّمًا:

"divider": {
}
grid

Grid

تعرِض هذه السمة شبكة تحتوي على مجموعة من العناصر.

يمكن أن تحتوي الشبكة على أي عدد من الأعمدة والعناصر. يتم تحديد عدد الصفوف من خلال الحدود العليا لعدد العناصر مقسومًا على عدد الأعمدة. تحتوي الشبكة التي تضم 10 عناصر وعمودَين على 5 صفوف. تحتوي الشبكة التي تضم 11 عنصرًا وعمودَين على 6 صفوف.

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

على سبيل المثال، ينشئ ملف JSON التالي شبكة من عمودَين تحتوي على عنصر واحد:

"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

Columns

تعرِض ما يصل إلى عمودَين.

لتضمين أكثر من عمودَين أو لاستخدام الصفوف، استخدِم أداة Grid.

على سبيل المثال، ينشئ ملف JSON التالي عمودَين يحتوي كل منهما على فقرات نصية:

"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"
          }
        }
      ]
    }
  ]
}
carousel

Carousel

تحتوي لوحة العرض الدوّارة على مجموعة من التطبيقات المصغّرة المتداخلة. على سبيل المثال، هذا تمثيل JSON للوحة عرض دوّارة تحتوي على فقرتَين نصيتَين.

{
  "widgets": [
    {
      "textParagraph": {
        "text": "First text paragraph in the carousel."
      }
    },
    {
      "textParagraph": {
        "text": "Second text paragraph in the carousel."
      }
    }
  ]
}
chip_list

ChipList

قائمة بالشرائح

على سبيل المثال، ينشئ ملف JSON التالي شريحتَين. الأول عبارة عن شريحة نصية والثاني عبارة عن شريحة أيقونة تفتح رابطًا:

"chipList": {
  "chips": [
    {
      "text": "Edit",
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}

HorizontalAlignment

تحدّد ما إذا كانت العناصر تتراصف إلى يسار العمود أو يمينه أو وسطه.

متاحة لتطبيقات Google Chat وغير متاحة لإضافات Google Workspace

عمليات التعداد
HORIZONTAL_ALIGNMENT_UNSPECIFIED لا تستخدِمها. غير محدد
START القيمة التلقائية تتم محاذاة التطبيقات المصغّرة مع موضع البداية للعمود. بالنسبة إلى التنسيقات من اليسار إلى اليمين، تتم المحاذاة إلى اليسار. بالنسبة إلى التنسيقات من اليمين إلى اليسار، تتم المحاذاة إلى اليمين.
CENTER تتم محاذاة التطبيقات المصغّرة إلى منتصف العمود.
END تتم محاذاة التطبيقات المصغّرة مع موضع نهاية العمود. بالنسبة إلى التنسيقات من اليسار إلى اليمين، تتم محاذاة التطبيقات المصغّرة إلى اليسار. بالنسبة إلى التنسيقات من اليمين إلى اليسار، تتم محاذاة الأدوات المصغّرة إلى اليسار.

ImageType

الشكل المستخدَم لاقتصاص الصورة

متاحة لتطبيقات Google Chat وإضافات Google Workspace.

عمليات التعداد
SQUARE القيمة التلقائية تطبيق قناع مربّع على الصورة على سبيل المثال، تتحوّل صورة بنسبة عرض إلى ارتفاع 4:3 إلى 3:3.
CIRCLE تطبيق قناع دائري على الصورة على سبيل المثال، تصبح الصورة ذات نسبة العرض إلى الارتفاع 4x3 دائرة بقطر 3.

VerticalAlignment

تمثّل هذه السمة المحاذاة العمودية.

عمليات التعداد
VERTICAL_ALIGNMENT_UNSPECIFIED نوع غير محدَّد لا تستخدم هذه السمة.
TOP المحاذاة إلى الموضع العلوي
MIDDLE المحاذاة إلى الموضع الأوسط
BOTTOM المحاذاة إلى الموضع السفلي