Cards v2

object (CardHeader)

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

object (Section)

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

enum (DividerStyle)

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

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

string

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

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

object (CardFixedFooter)

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

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

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

enum (DisplayStyle)

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

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

object (CardHeader)

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

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

string

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

string

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

enum (ImageType)

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

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

string

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

string

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

string

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

object (Widget)

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

boolean

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

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

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

integer

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

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

object (CollapseControl)

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

enum (HorizontalAlignment)

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

object (TextParagraph)

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

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

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

object (Image)

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

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

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

object (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"
  }
}

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

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

object (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
    }
  ]
}

object (DateTimePicker)

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

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

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

object (Divider)

عرض مُقسّم خط أفقي بين الأدوات.

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

"divider": {
}

object (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"
    }
  }
}

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

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

string

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

integer

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

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

string

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

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

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

object (OnClick)

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

string

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

object (Action)

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

object (OpenLink)

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

object (Action)

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

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

object (Card)

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

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

object (OverflowMenu)

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

string

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

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

object (ActionParameter)

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

enum (LoadIndicator)

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

boolean

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

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

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

enum (Interaction)

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

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

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

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

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

string

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

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

boolean

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

string

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

string

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

string

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

enum (OpenAs)

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

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

enum (OnClose)

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

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

object (OverflowMenuItem)

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

object (Icon)

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

string

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

object (OnClick)

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

boolean

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

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

enum (ImageType)

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

string

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

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

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

string

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

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

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

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

object (MaterialIcon)

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

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

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

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

string

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

boolean

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

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

integer

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

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

integer

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

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

object (Icon)

تمّ إيقافه نهائيًا وحلّ محلّه startIcon.

object (Icon)

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

string

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

string

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

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

boolean

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

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

string

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

object (OnClick)

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

object (Button)

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

object (SwitchControl)

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

object (Icon)

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

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

string

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

object (Icon)

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

object (Color)

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

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

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

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

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

object (OnClick)

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

boolean

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

string

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

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

enum (Type)

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

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

number

مقدار اللون الأحمر في اللون كقيمة في النطاق [0, 1]

number

مقدار اللون الأخضر في اللون كقيمة في الفاصل [0, 1].

number

مقدار اللون الأزرق في اللون كقيمة في النطاق [0, 1]

number

جزء هذا اللون الذي يجب تطبيقه على البكسل. أي أن لون البكسل النهائي يتم تحديده من خلال المعادلة:

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

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

string

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

لمعرفة تفاصيل عن التعامل مع إدخالات النماذج، راجِع تلقي بيانات النموذج.

string

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

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

boolean

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

object (Action)

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

enum (ControlType)

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

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

object (Button)

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

string

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

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

string

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

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

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

string

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

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

string

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

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

enum (Type)

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

object (Action)

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

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

object (Suggestions)

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

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

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

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

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

object (Action)

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

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

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

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

object (Validation)

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

string

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

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

Action

Navigation

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

Card

تدفع حزمة البطاقات بطاقة إلى حزمة البطاقات.

Card

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

object (SuggestionItem)

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

string

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

integer

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

enum (InputType)

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

string

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

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

string

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

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

enum (SelectionType)

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

object (SelectionItem)

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

object (Action)

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

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

integer

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

integer

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

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

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

object (Validation)

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

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

object (Action)

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

object (PlatformDataSource)

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

string

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

string

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

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

boolean

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

string

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

string

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

enum (CommonDataSource)

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

object (HostAppDataSourceMarkup)

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

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

object (ChatClientDataSourceMarkup)

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

object (SpaceDataSource)

مساحات Google Chat التي يكون المستخدم عضوًا فيها

boolean

في حال ضبط السياسة على true، تختار قائمة الاختيار المتعدد مساحة Google Chat الحالية كعنصر تلقائيًا.

string

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

لمعرفة تفاصيل عن التعامل مع إدخالات النماذج، راجِع تلقي بيانات النموذج.

string

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

enum (DateTimePickerType)

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

string (int64 format)

القيمة التلقائية المعروضة في التطبيق المصغّر، بالمللي ثانية منذ وقت بداية حقبة 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).

integer

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

object (Action)

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

object (Validation)

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

string

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

object (GridItem)

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

object (BorderStyle)

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

integer

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

object (OnClick)

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

string

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

object (ImageComponent)

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

string

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

string

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

enum (GridItemLayout)

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

string

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

string

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

object (ImageCropStyle)

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

object (BorderStyle)

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

enum (ImageCropType)

نوع الاقتصاص

number

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

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

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

enum (BorderType)

نوع الحد

object (Color)

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

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

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

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

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

integer

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

object (Column)

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

enum (HorizontalSizeStyle)

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

enum (HorizontalAlignment)

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

enum (VerticalAlignment)

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

object (Widgets)

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

object (TextParagraph)

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

object (Image)

Image تطبيق مصغّر.

object (DecoratedText)

DecoratedText تطبيق مصغّر.

object (ButtonList)

ButtonList تطبيق مصغّر.

object (TextInput)

TextInput تطبيق مصغّر.

object (SelectionInput)

SelectionInput تطبيق مصغّر.

object (DateTimePicker)

DateTimePicker تطبيق مصغّر.

object (ChipList)

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

enum (Layout)

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

object (Chip)

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

object (Icon)

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

string

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

object (OnClick)

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

boolean

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

boolean

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

string

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

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

enum (HorizontalAlignment)

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

object (Button)

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

object (Button)

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

string

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

object (OnClick)

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

object (Button)

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

object (Button)

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