Cards v2

{
  "header": {
    object (CardHeader)
  },
  "sections": [
    {
      object (Section)
    }
  ],
  "sectionDividerStyle": enum (DividerStyle),
  "cardActions": [
    {
      object (CardAction)
    }
  ],
  "name": string,
  "fixedFooter": {
    object (CardFixedFooter)
  },
  "displayStyle": enum (DisplayStyle),
  "peekCardHeader": {
    object (CardHeader)
  }
}

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.

{
  "title": string,
  "subtitle": string,
  "imageType": enum (ImageType),
  "imageUrl": string,
  "imageAltText": string
}

string

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

string

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

enum (ImageType)

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

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

string

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

string

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

{
  "header": string,
  "widgets": [
    {
      object (Widget)
    }
  ],
  "collapsible": boolean,
  "uncollapsibleWidgetsCount": integer
}

string

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

object (Widget)

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

boolean

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

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

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

integer

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

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

{
  "horizontalAlignment": enum (HorizontalAlignment),

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "decoratedText": {
    object (DecoratedText)
  },
  "buttonList": {
    object (ButtonList)
  },
  "textInput": {
    object (TextInput)
  },
  "selectionInput": {
    object (SelectionInput)
  },
  "dateTimePicker": {
    object (DateTimePicker)
  },
  "divider": {
    object (Divider)
  },
  "grid": {
    object (Grid)
  },
  "columns": {
    object (Columns)
  }
  // End of list of possible types for union field data.
}

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,
        "alpha": 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"
          }
        }
      ]
    }
  ]
}

{
  "text": string
}

string

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

{
  "imageUrl": string,
  "onClick": {
    object (OnClick)
  },
  "altText": string
}

string

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

مثال:

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

object (OnClick)

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

string

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

{

  // Union field data can be only one of the following:
  "action": {
    object (Action)
  },
  "openLink": {
    object (OpenLink)
  },
  "openDynamicLinkAction": {
    object (Action)
  },
  "card": {
    object (Card)
  }
  // End of list of possible types for union field data.
}

object (Action)

وفي حال تحديدها، سيتم تنفيذ إجراء بواسطة onClick.

object (OpenLink)

في حال تحديد هذا الخيار، سيؤدي هذا onClick إلى تفعيل إجراء رابط مفتوح.

object (Action)

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

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

object (Card)

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

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

{
  "function": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ],
  "loadIndicator": enum (LoadIndicator),
  "persistValues": boolean,
  "interaction": enum (Interaction)
}

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

{
  "key": string,
  "value": string
}

string

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

string

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

{
  "url": string,
  "openAs": enum (OpenAs),
  "onClose": enum (OnClose)
}

string

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

enum (OpenAs)

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

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

enum (OnClose)

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

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

{
  "icon": {
    object (Icon)
  },
  "startIcon": {
    object (Icon)
  },
  "topLabel": string,
  "text": string,
  "wrapText": boolean,
  "bottomLabel": string,
  "onClick": {
    object (OnClick)
  },

  // Union field control can be only one of the following:
  "button": {
    object (Button)
  },
  "switchControl": {
    object (SwitchControl)
  },
  "endIcon": {
    object (Icon)
  }
  // End of list of possible types for union field control.
}

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)

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

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

{
  "altText": string,
  "imageType": enum (ImageType),

  // Union field icons can be only one of the following:
  "knownIcon": string,
  "iconUrl": string,
  "materialIcon": {
    object (MaterialIcon)
  }
  // End of list of possible types for union field icons.
}

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)

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

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

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

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

{
  "name": string,
  "fill": boolean,
  "weight": integer,
  "grade": integer
}

string

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

boolean

ما إذا كان يتم عرض الرمز على أنّه معبأ أم لا. وتكون القيمة التلقائية "خطأ".

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

integer

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

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

integer

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

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

{
  "text": string,
  "icon": {
    object (Icon)
  },
  "color": {
    object (Color)
  },
  "onClick": {
    object (OnClick)
  },
  "disabled": boolean,
  "altText": string
}

string

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

object (Icon)

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

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

object (OnClick)

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

boolean

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

string

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

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

{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}

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

{
  "name": string,
  "value": string,
  "selected": boolean,
  "onChangeAction": {
    object (Action)
  },
  "controlType": enum (ControlType)
}

string

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

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

string

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

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

boolean

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

object (Action)

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

enum (ControlType)

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

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

{
  "buttons": [
    {
      object (Button)
    }
  ]
}

object (Button)

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

{
  "name": string,
  "label": string,
  "hintText": string,
  "value": string,
  "type": enum (Type),
  "onChangeAction": {
    object (Action)
  },
  "initialSuggestions": {
    object (Suggestions)
  },
  "autoCompleteAction": {
    object (Action)
  },
  "placeholderText": string
}

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.

string

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

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

Action

Navigation

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

Card

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

Card

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

{
  "items": [
    {
      object (SuggestionItem)
    }
  ]
}

object (SuggestionItem)

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

{

  // Union field content can be only one of the following:
  "text": string
  // End of list of possible types for union field content.
}

string

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

{
  "name": string,
  "label": string,
  "type": enum (SelectionType),
  "items": [
    {
      object (SelectionItem)
    }
  ],
  "onChangeAction": {
    object (Action)
  },
  "multiSelectMaxSelectedItems": integer,
  "multiSelectMinQueryLength": integer,

  // Union field multi_select_data_source can be only one of the following:
  "externalDataSource": {
    object (Action)
  },
  "platformDataSource": {
    object (PlatformDataSource)
  }
  // End of list of possible types for union field multi_select_data_source.
}

string

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

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

string

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

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

enum (SelectionType)

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

object (SelectionItem)

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

object (Action)

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

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

integer

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

integer

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

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

object (Action)

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

object (PlatformDataSource)

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

{
  "text": string,
  "value": string,
  "selected": boolean,
  "startIconUri": string,
  "bottomText": string
}

string

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

string

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

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

boolean

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

string

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

string

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

{

  // Union field data_source can be only one of the following:
  "commonDataSource": enum (CommonDataSource),
  "hostAppDataSource": {
    object (HostAppDataSourceMarkup)
  }
  // End of list of possible types for union field data_source.
}

enum (CommonDataSource)

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

object (HostAppDataSourceMarkup)

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

{

  // Union field data_source can be only one of the following:
  "chatDataSource": {
    object (ChatClientDataSourceMarkup)
  }
  // End of list of possible types for union field data_source.
}

object (ChatClientDataSourceMarkup)

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

{

  // Union field source can be only one of the following:
  "spaceDataSource": {
    object (SpaceDataSource)
  }
  // End of list of possible types for union field source.
}

object (SpaceDataSource)

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

{
  "defaultToCurrentSpace": boolean
}

boolean

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

{
  "name": string,
  "label": string,
  "type": enum (DateTimePickerType),
  "valueMsEpoch": string,
  "timezoneOffsetDate": integer,
  "onChangeAction": {
    object (Action)
  }
}

string

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

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

string

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

enum (DateTimePickerType)

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

string (int64 format)

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

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

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

integer

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

object (Action)

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

{
  "title": string,
  "items": [
    {
      object (GridItem)
    }
  ],
  "borderStyle": {
    object (BorderStyle)
  },
  "columnCount": integer,
  "onClick": {
    object (OnClick)
  }
}

string

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

object (GridItem)

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

object (BorderStyle)

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

integer

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

object (OnClick)

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

{
  "id": string,
  "image": {
    object (ImageComponent)
  },
  "title": string,
  "subtitle": string,
  "layout": enum (GridItemLayout)
}

string

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

object (ImageComponent)

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

string

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

string

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

enum (GridItemLayout)

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

{
  "imageUri": string,
  "altText": string,
  "cropStyle": {
    object (ImageCropStyle)
  },
  "borderStyle": {
    object (BorderStyle)
  }
}

string

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

string

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

object (ImageCropStyle)

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

object (BorderStyle)

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

{
  "type": enum (ImageCropType),
  "aspectRatio": number
}

enum (ImageCropType)

نوع الاقتصاص

number

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

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

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

{
  "type": enum (BorderType),
  "strokeColor": {
    object (Color)
  },
  "cornerRadius": integer
}

enum (BorderType)

نوع الحد

object (Color)

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

integer

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

{
  "columnItems": [
    {
      object (Column)
    }
  ]
}

object (Column)

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

{
  "horizontalSizeStyle": enum (HorizontalSizeStyle),
  "horizontalAlignment": enum (HorizontalAlignment),
  "verticalAlignment": enum (VerticalAlignment),
  "widgets": [
    {
      object (Widgets)
    }
  ]
}

enum (HorizontalSizeStyle)

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

enum (HorizontalAlignment)

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

enum (VerticalAlignment)

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

object (Widgets)

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

{

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "decoratedText": {
    object (DecoratedText)
  },
  "buttonList": {
    object (ButtonList)
  },
  "textInput": {
    object (TextInput)
  },
  "selectionInput": {
    object (SelectionInput)
  },
  "dateTimePicker": {
    object (DateTimePicker)
  }
  // End of list of possible types for union field data.
}

object (TextParagraph)

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

object (Image)

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

object (DecoratedText)

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

object (ButtonList)

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

object (TextInput)

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

object (SelectionInput)

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

object (DateTimePicker)

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

{
  "actionLabel": string,
  "onClick": {
    object (OnClick)
  }
}

string

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

object (OnClick)

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

{
  "primaryButton": {
    object (Button)
  },
  "secondaryButton": {
    object (Button)
  }
}

object (Button)

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

object (Button)

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