Package google.apps.card.v1

الفهرس

الإجراء

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

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

الحقول
function

string

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

على سبيل المثال، الاستخدام، راجع قراءة بيانات النموذج.

parameters[]

ActionParameter

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

loadIndicator

LoadIndicator

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

persistValues

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".

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

نوع الحد

strokeColor

Color

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

cornerRadius

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

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

في حال ترك هذه السياسة بدون ضبط، تكون خلفية الصورة بيضاء ويكون لون الخط أزرق.

بالنسبة إلى اللون الأحمر والأخضر والأزرق، تكون قيمة كل حقل هي رقم float يمكنك التعبير عنه بأي من الطريقتين: كرقم بين 0 و255 مقسومًا على 255 (153/255)، أو كقيمة بين 0 و1 (0.6). يمثل الرقم 0 غياب لون ويمثل الرقم 1 أو 255/255 التواجد الكامل لهذا اللون على مقياس RGB.

يمكنك بشكل اختياري ضبط alpha، الذي يضبط مستوى الشفافية باستخدام هذه المعادلة:

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

بالنسبة إلى alpha، تتوافق القيمة 1 مع اللون الخالص، والقيمة 0 تتوافق مع لون شفاف تمامًا.

على سبيل المثال، يمثل اللون التالي لونًا أحمر نصف شفاف:

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
   "alpha": 0.5
}
onClick

OnClick

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

disabled

bool

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

altText

string

تمثّل هذه السمة النص البديل المستخدَم لتسهيل الاستخدام.

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

ButtonList

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

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

الحقول
buttons[]

Button

مجموعة من الأزرار.

البطاقة

واجهة بطاقة يتم عرضها في رسالة 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، راجِع المقالة تحديد قسم من بطاقة.

sectionDividerStyle

DividerStyle

نمط الفاصل بين الأقسام.

cardActions[]

CardAction

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

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

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

"cardActions": [
  {
    "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.

fixedFooter

CardFixedFooter

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

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

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

displayStyle

DisplayStyle

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

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

peekCardHeader

CardHeader

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

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

CardAction

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

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

الحقول
actionLabel

string

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

onClick

OnClick

الإجراء onClick لعنصر العمل هذا

CardFixedFooter

تذييل دائم (مثبت) يظهر في أسفل البطاقة.

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

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

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

الحقول
primaryButton

Button

الزر الأساسي للتذييل الثابت. يجب أن يكون الزر زرًا نصيًا به نص وألوان محددة.

secondaryButton

Button

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

CardHeader

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

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

الحقول
title

string

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

subtitle

string

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

imageType

ImageType

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

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

imageUrl

string

عنوان URL الذي يستخدم HTTPS للصورة في عنوان البطاقة.

imageAltText

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 وفي حال ضبطها، لن يتم عرض أي مُقسّم بين الأقسام.

القسم

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

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

الحقول
header

string

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

widgets[]

Widget

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

collapsible

bool

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

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

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

uncollapsibleWidgetsCount

int32

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

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

الأعمدة

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

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

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

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

لتضمين أكثر من عمودَين، أو لاستخدام صفوف، استخدِم التطبيق المصغّر Grid.

متاحة لتطبيقات Google Chat وإضافات Google Workspace. الأعمدة الخاصة بإضافات Google Workspace في "معاينة المطوِّر".

الحقول
columnItems[]

Column

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

العمود

عمود.

متاحة لتطبيقات Google Chat وإضافات Google Workspace. الأعمدة الخاصة بإضافات Google Workspace في "معاينة المطوِّر".

الحقول
horizontalSizeStyle

HorizontalSizeStyle

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

horizontalAlignment

HorizontalAlignment

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

verticalAlignment

VerticalAlignment

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

widgets[]

Widgets

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

HorizontalSizeStyle

تحدِّد هذه السمة آلية ملء العمود لعرض البطاقة. يعتمد عرض كل عمود على كلٍّ من HorizontalSizeStyle وعرض التطبيقات المصغّرة ضمن العمود.

متاحة لتطبيقات Google Chat وإضافات Google Workspace. الأعمدة الخاصة بإضافات Google Workspace في "معاينة المطوِّر".

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

VerticalAlignment

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

متاحة لتطبيقات Google Chat وإضافات Google Workspace. الأعمدة الخاصة بإضافات Google Workspace في "معاينة المطوِّر".

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

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

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

متاحة لتطبيقات Google Chat وإضافات Google Workspace. الأعمدة الخاصة بإضافات Google Workspace في "معاينة المطوِّر".

الحقول

حقل الاتحاد data

يمكن أن يكون الحقل "data" واحدًا فقط مما يلي:

textParagraph

TextParagraph

أداة TextParagraph.

image

Image

أداة Image.

decoratedText

DecoratedText

أداة DecoratedText.

buttonList

ButtonList

أداة ButtonList.

textInput

TextInput

أداة TextInput.

selectionInput

SelectionInput

أداة SelectionInput.

dateTimePicker

DateTimePicker

أداة DateTimePicker.

DateTimePicker

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

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

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

الحقول
name

string

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

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

label

string

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

type

DateTimePickerType

ما إذا كان التطبيق المصغّر يسمح بإدخال تاريخ أو وقت أو تاريخ ووقت

valueMsEpoch

int64

القيمة التلقائية المعروضة في التطبيق المصغّر بالمللي ثانية منذ وقت حقبة يونكس.

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

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

int32

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

onChangeAction

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".

startIcon

Icon

الرمز المعروض أمام النص

topLabel

string

النص الذي يظهر أعلى text. يتم اقتطاع دائمًا

text

string

مطلوبة. تمثّل هذه السمة النص الأساسي.

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

wrapText

bool

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

ينطبق هذا الإعداد على text فقط، وليس على topLabel وbottomLabel.

bottomLabel

string

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

onClick

OnClick

يتم تشغيل هذا الإجراء عندما ينقر المستخدمون على topLabel أو bottomLabel.

حقل الاتحاد control زر أو مفتاح أو مربّع اختيار أو صورة تظهر على الجانب الأيسر من النص في تطبيق "decoratedText" المصغّر يمكن أن يكون الحقل "control" واحدًا فقط مما يلي:
button

Button

زر يمكن للمستخدم النقر عليه لتشغيل إجراء ما.

switchControl

SwitchControl

تطبيق مصغّر للتبديل يمكن للمستخدم النقر عليه لتغيير حالته وتفعيل أحد الإجراءات

endIcon

Icon

رمز يظهر بعد النص

إتاحة استخدام رموز مدمجة ومخصّصة

SwitchControl

إما مفتاح تبديل بنمط التبديل أو مربّع اختيار داخل تطبيق decoratedText المصغّر

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

هذه الميزة متاحة فقط في تطبيق decoratedText المصغّر.

الحقول
name

string

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

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

value

string

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

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

selected

bool

عند true، يتم اختيار مفتاح التبديل.

onChangeAction

Action

الإجراء الذي يتم تنفيذه عند تغيير حالة التبديل، مثل الوظيفة المطلوب تشغيلها.

controlType

ControlType

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

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

ControlType

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

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

عمليات التعداد
SWITCH مفتاح تبديل بنمط التبديل
CHECKBOX تم إيقافها لصالح "CHECK_BOX".
CHECK_BOX مربّع اختيار

فاصل

لا يشتمل هذا النوع على أي حقول.

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

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

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

"divider": {}

EndNavigation

إجراء تدفق مربع الحوار.

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

الحقول
action

Action

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

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

الإجراء

أنواع إجراءات العرض التي يجريها العميل لإنهاء مسار مربّع الحوار.

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

عمليات التعداد
ACTION_UNSPECIFIED لم يتم تحديد الإجراء.
CLOSE_DIALOG إغلاق مسار مربّع الحوار
CLOSE_DIALOG_AND_EXECUTE أغلِق مسار مربّع الحوار وأعِد تحميل البطاقة التي تؤدّي إلى فتح مسار مربّع الحوار.

GetAutocompletionResponse

استجابة للحصول على حاوية الإكمال التلقائي، والتي تتضمّن العناصر اللازمة لعرض عناصر الإكمال التلقائي لحقل النص

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

{
  "autoComplete": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}
الحقول
autoComplete

Suggestions

schema

string

هذا حقل مخطط بيئة تشغيل قد يكون موجودًا في الترميز للتحقق من بناء الجملة.

معرّف الإصدار العالمي (GRid)

لعرض شبكة تحتوي على مجموعة من العناصر. يمكن أن تتضمن العناصر نصًا أو صورًا فقط. للأعمدة المتجاوبة، أو لتضمين أكثر من نص أو صور، استخدم 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

العناصر التي سيتم عرضها في الشبكة.

borderStyle

BorderStyle

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

columnCount

int32

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

onClick

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.

الحقول
altText

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 للرمز.

imageType

ImageType

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

حقل الاتحاد icons الرمز المعروض في التطبيق المصغّر على البطاقة يمكن أن يكون الحقل "icons" واحدًا فقط مما يلي:
knownIcon

string

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

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

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

iconUrl

string

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

مثال:

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

وتتضمّن أنواع الملفات المتاحة .png و.jpg.

materialIcon

MaterialIcon

اعرض أحد رموز Material من Google.

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

"materialIcon": {
  "name": "check_box"
}

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

صورة

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

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

الحقول
imageUrl

string

تمثّل هذه السمة عنوان URL الذي يستخدم HTTPS الذي يستضيف الصورة.

مثال:

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

OnClick

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

altText

string

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

ImageComponent

يمثل صورة.

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

الحقول
imageUri

string

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

altText

string

تصنيف تسهيل الاستخدام للصورة

cropStyle

ImageCropStyle

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

borderStyle

BorderStyle

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

ImageCropStyle

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

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

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

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

ImageCropType

نوع الاقتصاص

aspectRatio

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.

LinkPreview

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

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

على سبيل المثال، يعرض ملف JSON التالي عنوانًا فريدًا لمعاينة الرابط وشريحته الذكية، بالإضافة إلى بطاقة معاينة تحتوي على عنوان ووصف نصي:

{
  "action": {
    "linkPreview": {
      "title": "Smart chip title",
      "linkPreviewTitle": "Link preview title",
      "previewCard": {
        "header": {
          "title": "Preview card header",
        },
        "sections": [
          {
            "widgets": [
              {
                "textParagraph": {
                  "text": "Description of the link."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

يعرض المثال معاينة الرابط التالي:

مثال لمعاينة الرابط

الحقول
previewCard

Card

بطاقة تعرض معلومات عن رابط من خدمة تابعة لجهة خارجية

title

string

العنوان الذي يتم عرضه في الشريحة الذكية لمعاينة الرابط. في حال ترك هذه السياسة بدون ضبط، ستعرض الشريحة الذكية عنوان preview_card.

linkPreviewTitle

string

العنوان الذي يتم عرضه في معاينة الرابط. وفي حال ترك السياسة بدون ضبط، ستعرض معاينة الرابط عنوان preview_card.

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 Fonts (رموز الخطوط) من Google وعدِّل الإعدادات ضمن Customize (تخصيص).

weight

int32

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

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

grade

int32

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

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

إجراء بطاقة يتلاعب بحزمة البطاقات

مثال:

1) أضف بطاقة جديدة إلى الحزمة (انتقل إلى الأمام). بالنسبة إلى التطبيقات في Chat، لا تتوفّر هذه الميزة إلا في الصفحة الرئيسية للتطبيق.

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

 navigations : {
    pushCard : CARD
  }

2) تحديث البطاقة أعلى الحزمة (في هذه الحالة، إجراء التحديث).

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

  navigations : {
    popCard : true,
  }, {
    pushCard : CARD
  }

3) الرجوع خطوة واحدة بدون تحديث:

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

  navigations : {
    popCard : true,
  }

4) الرجوع عدة خطوات وتعديل تلك البطاقة.

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

  navigations : {
    popCard : true,
  }, ... {
    pushCard : CARD
  }

5) الرجوع عدّة خطوات إلى CARD_NAME محدّد:

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

  navigations : {
    popToCardName : CARD_NAME,
  }, {
    pushCard : CARD
  }

6) الرجوع إلى الجذر وتعديل تلك البطاقة.

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

  navigations : {
    popToRoot : true
  }, {
    pushCard : CARD
  }

7) انتقل إلى البطاقة المحددة وانقلها أيضًا.

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

navigations : { popToCardName : CARD_NAME }, { popCard : true, }

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

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

  navigations : {
    updateCard : CARD
  }
الحقول

حقل الاتحاد navigate_action

يمكن أن يكون الحقل "navigate_action" واحدًا فقط مما يلي:

popToRoot

bool

يؤدي تكديس البطاقات إلى إيقاف جميع البطاقات باستثناء بطاقة الجذر.

pop

bool

حزمة البطاقات تنبثق بطاقة واحدة.

popToCard

string

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

pushCard

Card

يضع حزمة بطاقات بطاقة على حزمة البطاقات.

updateCard

Card

تعمل حزمة البطاقات على تعديل البطاقة العلوية ببطاقة جديدة وتحافظ على قيم حقول النماذج المعبأة. وبالنسبة إلى الحقل غير المكافئ، يتم إسقاط القيمة.

endNavigation

EndNavigation

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

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

إشعار

إجراء بطاقة يعرض إشعارًا في التطبيق المضيف.

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

الحقول
text

string

نص عادي للعرض للإشعار، بدون علامات HTML.

OnClick

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

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

الحقول

حقل الاتحاد data

يمكن أن يكون الحقل "data" واحدًا فقط مما يلي:

action

Action

في حال تحديد ذلك، سيتم تنفيذ إجراء من خلال عنصر onClick هذا.

openDynamicLinkAction

Action

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

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

card

Card

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

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

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 يفتح الرابط كتراكب، مثل نافذة منبثقة.

RenderActions

هي مجموعة من تعليمات العرض التي تطلب من بطاقة تنفيذ إجراء أو تطلب من تطبيق المضيف أو تطبيق Chat تنفيذ إجراء خاص بالتطبيق.

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

الحقول
action

Action

hostAppAction

HostAppActionMarkup

الإجراءات التي تتم من خلال تطبيقات مضيفين فردية

schema

string

هذا حقل مخطط بيئة تشغيل قد يكون موجودًا في الترميز للتحقق من بناء الجملة.

الإجراء

الحقول
navigations[]

Navigation

عرض البطاقات المعروضة أو فرقها أو تعديلها

notification

Notification

عرض إشعار للمستخدم النهائي

linkPreview

LinkPreview

يمكنك عرض معاينة رابط للمستخدم النهائي.

SelectionInput

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

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

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

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

الحقول
name

string

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

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

label

string

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

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

type

SelectionType

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

items[]

SelectionItem

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

onChangeAction

Action

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

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

multiSelectMaxSelectedItems

int32

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

multiSelectMinQueryLength

int32

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

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

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

متاحة لتطبيقات Google Chat ولا تتوفّر في "إضافات Google Workspace". يمكن أن يكون الحقل "multi_select_data_source" واحدًا فقط مما يلي:

externalDataSource

Action

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

platformDataSource

PlatformDataSource

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

PlatformDataSource

بالنسبة إلى التطبيق المصغّر "SelectionInput" الذي يستخدم قائمة اختيار متعدّد، وهو مصدر بيانات من Google Workspace. يُستخدَم لتعبئة العناصر في قائمة تحديد متعدد.

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

الحقول
حقل الاتحاد data_source مصدر البيانات. يمكن أن يكون الحقل "data_source" واحدًا فقط مما يلي:
commonDataSource

CommonDataSource

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

hostAppDataSource

HostAppDataSourceMarkup

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

CommonDataSource

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

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

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

SelectionItem

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

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

الحقول
text

string

النص الذي يحدد العنصر أو يصفه للمستخدمين.

value

string

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

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

selected

bool

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

startIconUri

string

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

bottomText

string

بالنسبة إلى قوائم التحديد المتعدد، هو وصف نصي أو تصنيف يتم عرضه أسفل حقل text للعنصر.

SelectionType

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

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

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

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

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

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

  • البيانات الثابتة: يتم تحديد العناصر على أنّها عناصر SelectionItem في التطبيق المصغّر. ما يصل إلى 100 سلعة.
  • بيانات Google Workspace: تتم تعبئة العناصر باستخدام بيانات من Google Workspace، مثلاً مستخدمو Google Workspace أو مساحات Google Chat.
  • البيانات الخارجية: تتم تعبئة العناصر من مصدر بيانات خارجي خارج Google Workspace.

للحصول على أمثلة حول كيفية تنفيذ قوائم التحديد المتعدد، راجع إضافة قائمة تحديد متعدد.

متاحة لتطبيقات Google Chat وإضافات Google Workspace. تتوفّر ميزة "الاختيار المتعدّد" لإضافات Google Workspace في "معاينة المطوِّر".

SubmitFormResponse

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

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

{
  "renderActions": {
    "action": {
      "notification": {
        "text": "Email address is added: salam.heba@example.com"
      }
    },
    "hostAppAction": {
      "gmailAction": {
        "openCreatedDraftAction": {
          "draftId": "msg-a:r-79766936926021702",
          "threadServerPermId": "thread-f:15700999851086004"
        }
      }
    }
  }
}
الحقول
renderActions

RenderActions

هو مجموعة من تعليمات العرض التي تطلب من البطاقة تنفيذ إجراء و/أو تطلب من تطبيق المضيف الإضافي تنفيذ إجراء خاص بالتطبيق.

stateChanged

bool

ما إذا كانت حالة البطاقات قد تغيّرت والبيانات في البطاقات الحالية قديمة أم لا.

schema

string

هذا حقل مخطط بيئة تشغيل قد يكون موجودًا في الترميز للتحقق من بناء الجملة.

اقتراحات

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

على سبيل المثال، قد يقترح حقل إدخال النص للغة البرمجة 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

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

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

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

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

الحقول
name

string

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

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

label

string

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

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

تكون هذه السمة مطلوبة في حال عدم تحديد السمة hintText. وبخلاف ذلك، يكون اختياريًا.

hintText

string

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

تكون هذه السمة مطلوبة في حال عدم تحديد السمة label. وبخلاف ذلك، يكون اختياريًا.

value

string

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

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

type

Type

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

onChangeAction

Action

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

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

initialSuggestions

Suggestions

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

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

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

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

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

autoCompleteAction

Action

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

وفي حال عدم تحديدها، يتم إعداد الاقتراحات من قِبل initialSuggestions ويعالجها العميل.

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

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

placeholderText

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

النص الذي يظهر في التطبيق المصغّر

تطبيق مصغّر

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

الأداة هي كائن مركب يمكن أن يمثل أحد النصوص والصور والأزرار وأنواع أخرى من الكائنات.

الحقول
horizontalAlignment

HorizontalAlignment

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

حقل الاتحاد data يمكن أن تحتوي الأداة على عنصر واحد فقط من العناصر التالية. يمكنك استخدام حقول تطبيقات مصغّرة متعددة لعرض المزيد من العناصر. يمكن أن يكون الحقل "data" واحدًا فقط مما يلي:
textParagraph

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

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

ButtonList

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

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

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

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

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

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

HorizontalAlignment

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

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

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

ImageType

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

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

عمليات التعداد
SQUARE القيمة التلقائية. يتم تطبيق قناع مربّع على الصورة. على سبيل المثال، تصبح صورة بتنسيق 4×3 3×3.
CIRCLE يتم تطبيق قناع دائري على الصورة. على سبيل المثال، تصبح صورة بحجم 4×3 دائرة بقطر 3.