Package google.apps.card.v1

string

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

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

ActionParameter

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

LoadIndicator

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

bool

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

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

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

Interaction

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

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

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

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

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

string

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

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

bool

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

string

اسم المَعلمة لنص الإجراء

string

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

BorderType

نوع الحد

Color

الألوان المُستخدَمة عندما يكون النوع BORDER_TYPE_STROKE

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

على سبيل المثال، يضبط الرمز البرمجي التالي اللون على الأحمر بأعلى كثافة:

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

لا يتوفّر حقل alpha للون الخطوط. يتم تجاهل هذا الحقل في حال تحديده.

int32

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

string

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

Icon

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

Color

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

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

على سبيل المثال، يضبط الرمز البرمجي التالي اللون على الأحمر بأعلى كثافة:

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

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

OnClick

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

bool

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

string

النص البديل المستخدَم لتحسين إمكانية الاستخدام

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

Type

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

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

Button

صفيف من الأزرار

CardHeader

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

Section

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

DividerStyle

نمط الفاصل بين العنوان والأقسام والتذييل

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

string

اسم البطاقة تُستخدَم كمعرِّف للبطاقة في التنقّل بين البطاقات.

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

CardFixedFooter

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

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

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

DisplayStyle

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

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

CardHeader

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

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

string

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

OnClick

إجراء onClick الخاص ببنود العمل هذه.

Button

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

Button

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

string

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

string

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

ImageType

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

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

string

عنوان URL لبروتوكول HTTPS للصورة في عنوان البطاقة.

string

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

TextParagraph

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

ButtonList

تطبيق مصغّر لقائمة الأزرار

Image

أداة صورة

string

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

Widget

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

bool

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

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

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

int32

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

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

CollapseControl

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

CarouselCard

قائمة بالبطاقات المضمّنة في لوحة العرض الدوّارة

NestedWidget

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

NestedWidget

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

Icon

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

string

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

OnClick

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

bool

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

bool

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

string

النص البديل المستخدَم لتحسين إمكانية الاستخدام

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

Layout

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

Chip

صفيف من الشرائح

HorizontalAlignment

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

Button

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

Button

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

Column

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

HorizontalSizeStyle

تُحدِّد كيفية ملء عمود لعرض البطاقة.

HorizontalAlignment

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

VerticalAlignment

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

Widgets

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

TextParagraph

أداة TextParagraph.

Image

أداة Image.

DecoratedText

أداة DecoratedText.

ButtonList

أداة ButtonList.

TextInput

أداة TextInput.

SelectionInput

أداة SelectionInput.

DateTimePicker

أداة DateTimePicker.

ChipList

أداة ChipList. تتوفّر هذه الميزة لتطبيقات Google Chat ولا تتوفّر لإضافات Google Workspace.

string

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

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

string

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

DateTimePickerType

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

int64

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

حدِّد القيمة استنادًا إلى نوع أداة الاختيار (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).

int32

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

Action

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

Validation

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

Icon

تمّ إيقاف هذا العمود نهائيًا واستبداله بالعمود startIcon.

Icon

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

string

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

string

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

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

bool

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

ينطبق التغيير على text فقط، وليس على topLabel وbottomLabel.

string

النص الذي يظهر أسفل text يتم إغلاق المحتوى دائمًا.

OnClick

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

Button

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

SwitchControl

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

Icon

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

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

string

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

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

string

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

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

bool

عندما يكون true، يكون المفتاح مفعّلاً.

Action

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

ControlType

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

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

string

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

GridItem

العناصر المطلوب عرضها في الشبكة

BorderStyle

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

int32

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

OnClick

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

string

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

ImageComponent

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

string

عنوان عنصر الشبكة

string

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

GridItemLayout

التنسيق الذي سيتم استخدامه لعنصر الشبكة.

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

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

string

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

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

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

string

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

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

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

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

MaterialIcon

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

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

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

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

string

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

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

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

OnClick

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

string

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

string

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

string

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

ImageCropStyle

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

BorderStyle

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

ImageCropType

نوع المحصول

double

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

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

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

string

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

bool

ما إذا كان سيتم عرض الرمز ممتلئًا القيمة التلقائية هي خطأ.

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

int32

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

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

int32

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

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

Action

إذا تم تحديده، يتم بدء إجراء من خلال هذا onClick.

OpenLink

في حال تحديده، يؤدي هذا العنصر onClick إلى بدء إجراء فتح رابط.

Action

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

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

Card

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

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

OverflowMenu

يؤدي هذا الرمز onClick إلى فتح قائمة كاملة إذا تم تحديده. تتوفّر هذه الميزة لتطبيقات Google Chat ولا تتوفّر لإضافات Google Workspace.

string

عنوان URL المطلوب فتحه

OpenAs

كيفية فتح رابط

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

OnClose

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

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

OverflowMenuItem

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

Icon

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

string

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

OnClick

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

bool

ما إذا كان خيار القائمة غير مفعَّل القيمة التلقائية هي false.

string

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

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

string

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

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

SelectionType

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

SelectionItem

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

Action

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

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

int32

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

int32

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

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

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

Validation

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

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

Action

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

PlatformDataSource

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

CommonDataSource

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

HostAppDataSourceMarkup

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

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

string

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

string

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

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

bool

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

string

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

string

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

SuggestionItem

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

string

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

string

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

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

string

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

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

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

string

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

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

string

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

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

Type

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

Action

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

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

Suggestions

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

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

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

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

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

Action

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

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

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

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

Validation

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

string

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

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

string

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

int32

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

القيمة التلقائية هي 0، وفي هذه الحالة يتم عرض كل السياق. ويتم تجاهل القيم السلبية. تتوفّر هذه الميزة لتطبيقات Google Chat ولا تتوفّر لإضافات Google Workspace.

int32

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

InputType

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

HorizontalAlignment

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

TextParagraph

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

على سبيل المثال، ينشئ ملف JSON التالي نصًا بخط عريض:

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

Image

لعرض صورة

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

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

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

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

على سبيل المثال، ينشئ ملف 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"
        }
      }
    }
  ]
}

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

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

على سبيل المثال، ينشئ ملف 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

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

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

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

Divider

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

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

"divider": {
}

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

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

لتضمين أكثر من عمودَين أو لاستخدام الصفوف، استخدِم التطبيق المصغّر 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

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

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

ChipList

قائمة بشرائح

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

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

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