Package google.apps.card.v1

सूची

कार्रवाई

एक कार्रवाई है, जो फ़ॉर्म सबमिट किए जाने पर कार्रवाई की जानकारी देती है. उदाहरण के लिए, फ़ॉर्म मैनेज करने के लिए, Apps Script का इस्तेमाल किया जा सकता है.

फ़ील्ड
function

string

शामिल एलिमेंट पर क्लिक करने या सही तरीके से चालू होने पर, शुरू करने के लिए कस्टम फ़ंक्शन.

उदाहरण के लिए, इंटरैक्टिव कार्ड बनाना देखें.

parameters[]

ActionParameter

कार्रवाई पैरामीटर की सूची.

loadIndicator

LoadIndicator

यह लोडिंग इंंडिकेटर के बारे में बताती है, जो कार्रवाई को कॉल करते समय दिखाता है.

persistValues

bool

यह बताता है कि कार्रवाई के बाद फ़ॉर्म की वैल्यू बनी रहती हैं या नहीं. डिफ़ॉल्ट वैल्यू false है.

अगर true, कार्रवाई ट्रिगर होने के बाद भी फ़ॉर्म की वैल्यू बनी रहती हैं. कार्रवाइयों के लिए LoadIndicator.NONE का इस्तेमाल करते समय persist_values = true का सुझाव दिया जाता है, क्योंकि यह पक्का करता है कि फ़ॉर्म के बाद या बदलाव से जुड़ी कार्रवाइयों के बाद उपयोगकर्ता की ओर से किए गए कोई भी बदलाव सर्वर को ओवरराइट न किए जाएं.

अगर false, कार्रवाई ट्रिगर होती है, तो फ़ॉर्म वैल्यू मिटा दी जाती हैं. जब persist_values को false पर सेट किया जाता है, तो हमारा सुझाव है कि कार्ड सभी कार्रवाइयों के लिए, LoadIndicator.SPINNER का इस्तेमाल करे, क्योंकि यह यूज़र इंटरफ़ेस (यूआई) को लॉक कर देता है, ताकि कार्रवाई के दौरान उपयोगकर्ता कोई बदलाव न कर सके.

Chat ऐप्लिकेशन में यह सुविधा उपलब्ध नहीं है.

interaction

Interaction

ज़रूरी नहीं. डायलॉग खोलते समय ज़रूरी है.

किसी उपयोगकर्ता के साथ इंटरैक्शन के जवाब में क्या करना चाहिए, जैसे किसी उपयोगकर्ता का कार्ड मैसेज पर क्लिक करने वाला बटन.

तय न होने पर, ऐप्लिकेशन हमेशा की तरह action का इस्तेमाल करके जवाब देता है, जैसे कि किसी लिंक को खोलना या फ़ंक्शन चलाना.

interaction तय करके, ऐप्लिकेशन खास इंटरैक्टिव तरीकों से जवाब दे सकता है. उदाहरण के लिए, interaction को OPEN_DIALOG पर सेट करने पर, ऐप्लिकेशन डायलॉग खोल सकता है.

तय किए जाने पर, लोड होने वाला इंडिकेटर नहीं दिखेगा.

Chat ऐप्लिकेशन में काम करता है, लेकिन Google Workspace ऐड-ऑन पर नहीं. अगर किसी ऐड-ऑन के लिए तय किया जाता है, तो पूरा कार्ड हटा दिया जाता है और क्लाइंट को कुछ भी नहीं दिखाया जाता है.

कार्रवाई पैरामीटर

कार्रवाई का तरीका शुरू होने पर सप्लाई करने के लिए स्ट्रिंग पैरामीटर की सूची. उदाहरण के लिए, तीन स्नूज़ बटन दिखाएं: स्नूज़ करने के लिए स्नूज़ करें, 1 दिन बाद स्नूज़ करें, और अगले हफ़्ते स्नूज़ करें. आप स्ट्रिंग पैरामीटर की सूची में, स्नूज़ तरीके और स्नूज़ के समय को पास करने के लिए, कार्रवाई का तरीका = स्नूज़() का इस्तेमाल कर सकते हैं.

ज़्यादा जानने के लिए, CommonEventObject देखें.

फ़ील्ड
key

string

कार्रवाई स्क्रिप्ट के लिए पैरामीटर का नाम.

value

string

पैरामीटर की वैल्यू.

इंटरैक्शन

ज़रूरी नहीं. डायलॉग खोलते समय ज़रूरी है.

किसी उपयोगकर्ता के साथ इंटरैक्शन के जवाब में क्या करना चाहिए, जैसे किसी उपयोगकर्ता का कार्ड मैसेज पर क्लिक करने वाला बटन.

तय न होने पर, ऐप्लिकेशन हमेशा की तरह action का इस्तेमाल करके जवाब देता है, जैसे कि किसी लिंक को खोलना या फ़ंक्शन चलाना.

interaction तय करके, ऐप्लिकेशन खास इंटरैक्टिव तरीकों से जवाब दे सकता है. उदाहरण के लिए, interaction को OPEN_DIALOG पर सेट करने पर, ऐप्लिकेशन डायलॉग खोल सकता है.

तय किए जाने पर, लोड होने वाला इंडिकेटर नहीं दिखेगा.

Chat ऐप्लिकेशन में काम करता है, लेकिन Google Workspace ऐड-ऑन पर नहीं. अगर किसी ऐड-ऑन के लिए तय किया जाता है, तो पूरा कार्ड हटा दिया जाता है और क्लाइंट को कुछ भी नहीं दिखाया जाता है.

Enums
INTERACTION_UNSPECIFIED डिफ़ॉल्ट मान. action सामान्य तरीके से काम करता है.
OPEN_DIALOG

यह डायलॉग दिखाता है. यह विंडो पर आधारित, कार्ड पर आधारित एक इंटरफ़ेस है जिसका इस्तेमाल Chat ऐप्लिकेशन, उपयोगकर्ताओं से इंटरैक्ट करने के लिए करते हैं.

यह सुविधा सिर्फ़ Chat ऐप्लिकेशन में, कार्ड मैसेज पर मिले बटन पर क्लिक करने से मिलती है.

यह सुविधा Google Workspace ऐड-ऑन पर काम नहीं करती. अगर किसी ऐड-ऑन के लिए तय किया जाता है, तो पूरा कार्ड हटा दिया जाता है और क्लाइंट को कुछ भी नहीं दिखाया जाता है.

लोड Indicator

यह लोडिंग इंंडिकेटर के बारे में बताती है, जो कार्रवाई को कॉल करते समय दिखाता है.

Enums
SPINNER यह दिखाने के लिए स्पिनर दिखाता है कि सामग्री लोड हो रही है.
NONE कुछ नहीं दिखाया गया.

बॉर्डरस्टाइल

विजेट में आइटम पर लागू की गई बॉर्डर की पूरी शैली दिखाता है.

फ़ील्ड
type

BorderType

बॉर्डर का टाइप.

strokeColor

Color

टाइप BORDER_TYPE_STROKE होने पर इस्तेमाल किए जाने वाले रंग.

cornerRadius

int32

बॉर्डर के लिए कोने का दायरा.

बॉर्डरटाइप

विजेट पर लागू किए गए बॉर्डर के प्रकार दिखाता है.

Enums
BORDER_TYPE_UNSPECIFIED कोई मान दर्ज नहीं किया गया है.
NO_BORDER डिफ़ॉल्ट मान. कोई बॉर्डर नहीं.
STROKE आउटलाइन.

बटन

टेक्स्ट, आइकॉन या टेक्स्ट + आइकॉन बटन, जिस पर उपयोगकर्ता क्लिक कर सकते हैं.

किसी इमेज को क्लिक किया जा सकने वाला बटन बनाने के लिए, Image (ImageComponent नहीं) तय करें और onClick कार्रवाई सेट करें.

फ़ील्ड
text

string

बटन के अंदर दिखाया गया टेक्स्ट.

icon

Icon

आइकॉन की इमेज. अगर icon और text, दोनों सेट हैं, तो टेक्स्ट की जगह आइकॉन दिखता है.

आइकॉन और टेक्स्ट, दोनों के लिए सहायता जल्द ही उपलब्ध होगी.

color

Color

अगर इस नीति का सेट है, तो बटन के बैकग्राउंड में रंग का इस्तेमाल होता है. साथ ही, बैकग्राउंड के रंग में कंट्रास्ट को बनाए रखने के लिए, फ़ॉन्ट का रंग बदलता है. उदाहरण के लिए, नीला बैकग्राउंड सेट करने पर सफ़ेद टेक्स्ट दिखेगा.

अगर कुछ भी सेट नहीं किया गया है, तो इमेज के बैकग्राउंड का रंग सफ़ेद और फ़ॉन्ट का रंग नीला है.

लाल, हरे, और नीले रंग के लिए, हर फ़ील्ड की वैल्यू एक float नंबर होती है जिसे दो में से किसी भी तरीके से दिखाया जा सकता है: 0 से 255 के बीच की संख्या को 255 (153/255) से भाग दें या फिर 0 और 1 (0.6) के बीच की वैल्यू के तौर पर बताएं. 0, किसी रंग की कमी और 1 या 255/255 का मतलब है कि आरजीबी स्केल पर उस रंग की पूरी मौजूदगी है.

विकल्प के तौर पर ऐल्फ़ा सेट करें, जो इस इक्वेशन का इस्तेमाल करके पारदर्शिता का लेवल सेट करता है:

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

अल्फ़ा के लिए, 1 का मान सॉलिड कलर से मेल खाता है और 0 का वैल्यू पूरी तरह से पारदर्शी कलर के साथ मेल खाता है.

उदाहरण के लिए, नीचे दिया गया रंग आधे पारदर्शी लाल को दिखाता है:

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

OnClick

बटन क्लिक होने पर की जाने वाली कार्रवाई, जैसे कोई हाइपरलिंक खोलना या कोई कस्टम फ़ंक्शन चलाना.

disabled

bool

अगर true इस्तेमाल नहीं करता है, तो इसका मतलब है कि यह बटन चालू नहीं है और उपयोगकर्ताओं की कार्रवाइयों के जवाब नहीं देता.

altText

string

सुलभता के लिए इस्तेमाल किया जाने वाला वैकल्पिक टेक्स्ट.

जानकारी देने वाला टेक्स्ट सेट करें, जिससे उपयोगकर्ता जान सकें कि बटन क्या करता है. उदाहरण के लिए, अगर कोई बटन हाइपरलिंक खोलता है, तो आप यह लिख सकते हैं: "नया ब्राउज़र टैब खोलता है और https://developers.google.com/chat" पर Google Chat डेवलपर दस्तावेज़ पर जाता है.

आइकॉन के सेट होने पर कोई असर नहीं होता है; इसके बजाय icon.alt_text का इस्तेमाल करें.

बटन की सूची

बटन की सूची को हॉरिज़ॉन्टल तौर पर लगाया गया है.

फ़ील्ड
buttons[]

Button

बटन की कैटगरी.

कार्ड

कार्ड में पहले से तय लेआउट, इंटरैक्टिव यूज़र इंटरफ़ेस (यूआई), जैसे कि बटन, और रिच मीडिया (जैसे कि इमेज) होते हैं. कार्ड का इस्तेमाल करके पूरी जानकारी दें, उपयोगकर्ताओं से जानकारी इकट्ठा करें, और अगला कदम उठाने में उपयोगकर्ताओं की मदद करें.

Google Chat में कार्ड कई जगहों पर दिखते हैं:

  • अलग से मैसेज के तौर पर.
  • टेक्स्ट मैसेज के साथ, मैसेज के ठीक नीचे.
  • डायलॉग के तौर पर.

नीचे दिया गया उदाहरण JSON, "संपर्क कार्ड" बनाता है, जिसमें ये चीज़ें मौजूद होती हैं:

  • संपर्क के नाम, पद का नाम, अवतार की तस्वीर वाला हेडर.
  • संपर्क जानकारी वाला सेक्शन, जिसमें फ़ॉर्मैट किया गया टेक्स्ट शामिल होता है.
  • ऐसे बटन जिन पर क्लिक करके उपयोगकर्ता, संपर्क को शेयर कर सकते हैं या कम या ज़्यादा जानकारी देख सकते हैं.

संपर्क कार्ड का उदाहरण

{
  "cardsV2": [
    {
      "cardId": "unique-card-id",
      "card": {
        "header": {
          "title": "Sasha",
          "subtitle": "Software Engineer",
          "imageUrl":
          "https://developers.google.com/chat/images/quickstart-app-avatar.png",
          "imageType": "CIRCLE",
          "imageAltText": "Avatar for Sasha",
        },
        "sections": [
          {
            "header": "Contact Info",
            "collapsible": true,
            "uncollapsibleWidgetsCount": 1,
            "widgets": [
              {
                "decoratedText": {
                  "startIcon": {
                    "knownIcon": "EMAIL",
                  },
                  "text": "sasha@example.com",
                }
              },
              {
                "decoratedText": {
                  "startIcon": {
                    "knownIcon": "PERSON",
                  },
                  "text": "<font color=\"#80e27e\">Online</font>",
                },
              },
              {
                "decoratedText": {
                  "startIcon": {
                    "knownIcon": "PHONE",
                  },
                  "text": "+1 (555) 555-1234",
                }
              },
              {
                "buttonList": {
                  "buttons": [
                    {
                      "text": "Share",
                      "onClick": {
                        "openLink": {
                          "url": "https://example.com/share",
                        }
                      }
                    },
                    {
                      "text": "Edit",
                      "onClick": {
                        "action": {
                          "function": "goToView",
                          "parameters": [
                            {
                              "key": "viewType",
                              "value": "EDIT",
                            }
                          ],
                        }
                      }
                    },
                  ],
                }
              },
            ],
          },
        ],
      },
    }
  ],
}
फ़ील्ड
header

CardHeader

कार्ड का हेडर. आम तौर पर, हेडर में मुख्य इमेज और शीर्षक होता है. हेडर, हमेशा कार्ड के सबसे ऊपर दिखते हैं.

sections[]

Section

विजेट का संग्रह होता है. हर सेक्शन का अपना वैकल्पिक हेडर होता है. सेक्शन को लाइन डिवाइडर से विज़ुअल तौर पर अलग किया जाता है.

cardActions[]

CardAction

कार्ड की कार्रवाइयां. ऐक्शन, कार्ड के टूलबार मेन्यू में जोड़े जाते हैं.

Chat ऐप्लिकेशन के कार्ड में कोई टूलबार नहीं होता, इसलिए Chat ऐप्लिकेशन में cardActions[] काम नहीं करता.

उदाहरण के लिए, नीचे दिया गया JSON, सेटिंग और सुझाव भेजने के विकल्प के साथ कार्ड कार्रवाई मेन्यू बनाता है:

"cardActions": [
  {
    "actionLabel": "Settings",
    "onClick": {
      "action": {
        "functionName": "goToView",
        "parameters": [
          {
            "key": "viewType",
            "value": "SETTING"
         }
        ],
        "loadIndicator": "LoadIndicator.SPINNER"
      }
    }
  },
  {
    "actionLabel": "Send Feedback",
    "onClick": {
      "openLink": {
        "url": "https://example.com/feedback"
      }
    }
  }
]
name

string

कार्ड का नाम. कार्ड नेविगेशन में कार्ड पहचानकर्ता के रूप में इस्तेमाल किया जाता है.

Chat ऐप्लिकेशन में कार्ड नेविगेशन की सुविधा काम नहीं करती. इसलिए, इस फ़ील्ड पर ध्यान नहीं दिया जाता.

fixedFooter

CardFixedFooter

तय किए गए फ़ुटर को इस कार्ड के निचले हिस्से में दिखाया गया है.

primaryButton या secondaryButton को तय किए बिना fixedFooter सेट करने पर गड़बड़ी होती है.

चैट ऐप्लिकेशन fixedFooter डायलॉग्स में काम करते हैं, लेकिन कार्ड मैसेज में नहीं.

displayStyle

DisplayStyle

Google Workspace ऐड-ऑन में, peekCardHeader की डिसप्ले प्रॉपर्टी सेट की जाती हैं.

Chat ऐप्लिकेशन में यह सुविधा उपलब्ध नहीं है.

peekCardHeader

CardHeader

प्रासंगिक कॉन्टेंट दिखाते समय, लुक कार्ड हेडर, प्लेसहोल्डर के तौर पर काम करता है. इससे उपयोगकर्ता, होम पेज के कार्ड और मिलते-जुलते कार्ड के बीच नेविगेट कर पाते हैं.

Chat ऐप्लिकेशन में यह सुविधा उपलब्ध नहीं है.

कार्ड पर की गई कार्रवाई

कार्ड से जुड़ी कार्रवाई, कार्ड से जुड़ी कार्रवाई होती है. उदाहरण के लिए, किसी इनवॉइस कार्ड में इनवॉइस मिटाने, ईमेल इनवॉइस या ब्राउज़र में इनवॉइस खोलने जैसी कार्रवाइयां शामिल हो सकती हैं.

Chat ऐप्लिकेशन में यह सुविधा उपलब्ध नहीं है.

फ़ील्ड
actionLabel

string

कार्रवाई मेन्यू आइटम के तौर पर दिखने वाला लेबल.

onClick

OnClick

इस कार्रवाई वाले आइटम के लिए onClick कार्रवाई.

कार्ड से जुड़ी समस्या हल करने वाला फ़ुटर

कार्ड के निचले हिस्से में दिखने वाला लगातार (स्टिकी) फ़ुटर.

primaryButton या secondaryButton को तय किए बिना fixedFooter सेट करने पर गड़बड़ी होती है.

चैट ऐप्लिकेशन fixedFooter डायलॉग्स में काम करते हैं, लेकिन कार्ड मैसेज में नहीं.

फ़ील्ड
primaryButton

Button

तय फ़ुटर का मुख्य बटन. बटन एक टेक्स्ट बटन होना चाहिए, जिसमें टेक्स्ट और रंग सेट होना चाहिए.

secondaryButton

Button

तय फ़ुटर का दूसरा बटन. बटन एक टेक्स्ट बटन होना चाहिए, जिसमें टेक्स्ट और रंग सेट होना चाहिए. अगर secondaryButton सेट है, तो primaryButton सेट होना चाहिए.

कार्ड हैडर

कार्ड हेडर की जानकारी.

फ़ील्ड
title

string

ज़रूरी है. कार्ड हेडर का शीर्षक. हेडर की ऊंचाई तय होती है: शीर्षक और सबटाइटल, दोनों की जानकारी एक लाइन में मौजूद होती है. अगर सिर्फ़ शीर्षक की जानकारी दी गई है, तो उस पर दोनों पंक्तियां दिखाई देंगी.

subtitle

string

कार्ड हेडर का उपशीर्षक. अगर बताया गया हो, तो title के नीचे अपनी लाइन में दिखता है.

imageType

ImageType

इमेज को काटने के लिए इस्तेमाल किया गया आकार.

imageUrl

string

कार्ड हेडर में इमेज का एचटीटीपीएस यूआरएल.

imageAltText

string

इस इमेज का वैकल्पिक टेक्स्ट, जिसे सुलभता के लिए इस्तेमाल किया जाता है.

डिसप्ले स्टाइल

Google Workspace ऐड-ऑन में, यह तय किया जाता है कि कार्ड कैसे दिखाया जाता है.

Chat ऐप्लिकेशन में यह सुविधा उपलब्ध नहीं है.

Enums
DISPLAY_STYLE_UNSPECIFIED इस्तेमाल न करें.
PEEK कार्ड का हेडर साइडबार के निचले हिस्से में दिखता है. इसमें स्टैक के मौजूदा टॉप कार्ड का कुछ हिस्सा दिखता है. हेडर पर क्लिक करने से कार्ड, कार्ड स्टैक में दिखने लगता है. अगर कार्ड में कोई हेडर नहीं है, तो जनरेट किए गए हेडर का इस्तेमाल किया जाता है.
REPLACE डिफ़ॉल्ट मान. कार्ड स्टैक में सबसे ऊपर के कार्ड के व्यू को बदलकर कार्ड दिखाया जाता है.

सेक्शन

सेक्शन में विजेट का ऐसा कलेक्शन होता है जो वर्टिकल तौर पर उसी क्रम में रेंडर किया जाता है जिस क्रम में उन्हें बताया गया होता है.

फ़ील्ड
header

string

सेक्शन के सबसे ऊपर दिखने वाला टेक्स्ट. आसान एचटीएमएल फ़ॉर्मैट वाले टेक्स्ट के साथ काम करता है.

widgets[]

Widget

सभी विजेट. कम से कम एक विजेट होना चाहिए.

collapsible

bool

यह बताता है कि यह सेक्शन छोटा किया जा सकता है या नहीं.

छोटे किए जा सकने वाले सेक्शन कुछ या सभी विजेट छिपा देते हैं. हालांकि, उपयोगकर्ता ज़्यादा दिखाएं पर क्लिक करके, छिपे हुए विजेट दिखाने के लिए सेक्शन को बड़ा कर सकते हैं. उपयोगकर्ता कम दिखाएं पर क्लिक करके विजेट को फिर से छिपा सकते हैं.

यह तय करने के लिए कि कौनसे विजेट छिपे हैं, uncollapsibleWidgetsCount बताएं.

uncollapsibleWidgetsCount

int32

छोटे किए जा सकने वाले विजेट की संख्या, जो सेक्शन को छोटा करने के बाद भी दिखती है.

उदाहरण के लिए, जब किसी सेक्शन में पांच विजेट होते हैं और uncollapsibleWidgetsCount 2 पर सेट होती है, तो पहले दो विजेट हमेशा दिखाए जाते हैं और आखिरी तीन विजेट डिफ़ॉल्ट रूप से छोटे किए जाते हैं. uncollapsibleWidgetsCount को सिर्फ़ तब ध्यान में रखा जाता है, जब collapsible, true हो.

तारीख और समय चुनने वाला टूल

इसकी मदद से, उपयोगकर्ता कोई तारीख, समय या तारीख और समय, दोनों तय कर सकते हैं.

यह नीति, उपयोगकर्ताओं से टेक्स्ट डालने की सुविधा देती है. हालांकि, इसमें इंटरैक्टिव तारीख और समय चुनने का विकल्प होता है, जिससे उपयोगकर्ताओं को सही फ़ॉर्मैट वाली तारीखें और समय डालने में मदद मिलती है. अगर उपयोगकर्ता कोई तारीख या समय गलत डालते हैं, तो विजेट एक गड़बड़ी दिखाता है जो उपयोगकर्ताओं को सही फ़ॉर्मैट डालने का संकेत देती है.

Chat ऐप्लिकेशन में यह सुविधा उपलब्ध नहीं है. जल्द ही Chat ऐप्लिकेशन में सहायता की सुविधा उपलब्ध होगी.

फ़ील्ड
name

string

वह नाम जिससे तारीख और समय चुनने वाले टूल की पहचान, फ़ॉर्म इनपुट इवेंट में की जाती है.

फ़ॉर्म इनपुट के साथ काम करने के बारे में ज़्यादा जानने के लिए, फ़ॉर्म डेटा पाना देखें.

label

string

वह टेक्स्ट जो उपयोगकर्ताओं को तारीख, समय या तारीख और समय डालने का संकेत देता है.

वह टेक्स्ट डालें जिससे उपयोगकर्ता को वह जानकारी डालने में मदद मिलती है जो आपके ऐप्लिकेशन के लिए ज़रूरी है. उदाहरण के लिए, अगर उपयोगकर्ता कोई अपॉइंटमेंट सेट कर रहे हैं, तो "अपॉइंटमेंट की तारीख" या "अपॉइंटमेंट की तारीख और समय" जैसे लेबल का इस्तेमाल किया जा सकता है.

type

DateTimePickerType

तारीख और समय, इनपुट के साथ किस तरह का समय देता है.

valueMsEpoch

int64

उपयोगकर्ता इनपुट या पिछले उपयोगकर्ता इनपुट से पहले डिफ़ॉल्ट मान के रूप में दिखाया गया मान, जिसे मिलीसेकंड में दिखाया जाता है (समय).

DATE_AND_TIME टाइप के लिए, epoch वैल्यू का इस्तेमाल किया जाता है.

DATE_ONLY टाइप के लिए, epoch टाइम का ही इस्तेमाल किया जाता है.

TIME_ONLY टाइप के लिए, epoch टाइम का इस्तेमाल किया जाता है. उदाहरण के लिए, सुबह 3:00 बजे का समय दिखाने के लिए, epoch टाइम को 3 * 60 * 60 * 1000 पर सेट करें.

timezoneOffsetDate

int32

यूटीसी से समय क्षेत्र ऑफ़सेट दिखाने वाली संख्या, मिनट में. अगर यह नीति सेट की गई है, तो दिए गए समय क्षेत्र के हिसाब से value_ms_epoch दिखेगी. अगर यह सेट नहीं है, तो क्लाइंट-साइड पर उपयोगकर्ता की समय क्षेत्र सेटिंग का इस्तेमाल किया जाता है.

onChangeAction

Action

तब ट्रिगर होता है, जब उपयोगकर्ता तारीख पिकर इंटरफ़ेस में सेव करें या मिटाएं पर क्लिक करता है.

तारीख और समय चुनने की सुविधा

तारीख और समय, इनपुट के साथ किस तरह का समय देता है.

Enums
DATE_AND_TIME उपयोगकर्ता तारीख और समय चुन सकता है.
DATE_ONLY उपयोगकर्ता सिर्फ़ तारीख चुन सकता है.
TIME_ONLY उपयोगकर्ता सिर्फ़ एक समय चुन सकता है.

सजावटी टेक्स्ट

विजेट, जिसमें टेक्स्ट से ऊपर या नीचे लेबल जैसे वैकल्पिक सजावट होती है. यह टेक्स्ट के सामने मौजूद आइकॉन, चुनने के लिए विजेट या टेक्स्ट के बाद बटन भी दिखाता है.

फ़ील्ड
icon
(deprecated)

Icon

startIcon के पक्ष में रोक दिया गया.

startIcon

Icon

टेक्स्ट के सामने दिखाया गया आइकॉन.

topLabel

string

text के ऊपर दिखने वाला टेक्स्ट. हमेशा काट-छांट करें.

सामान्य फ़ॉर्मैटिंग की सुविधा काम करती है. फ़ॉर्मैटिंग की जानकारी के लिए, टेक्स्ट फ़ॉर्मैटिंग देखें.

text

string

ज़रूरी है. प्राइमरी टेक्स्ट.

सामान्य फ़ॉर्मैटिंग की सुविधा काम करती है. फ़ॉर्मैटिंग की जानकारी के लिए, टेक्स्ट फ़ॉर्मैटिंग देखें.

wrapText

bool

टेक्स्ट रैप करने की सेटिंग. अगर true है, तो टेक्स्ट रैप होता है और कई लाइनों में दिखता है. ऐसा न करने पर, टेक्स्ट को छोटा कर दिया जाता है.

यह सिर्फ़ text पर लागू होता है. topLabel और bottomLabel पर लागू नहीं होता.

bottomLabel

string

text के नीचे दिखने वाला टेक्स्ट. हमेशा काट-छांट करें.

सामान्य फ़ॉर्मैटिंग की सुविधा काम करती है. फ़ॉर्मैटिंग की जानकारी के लिए, टेक्स्ट फ़ॉर्मैटिंग देखें.

onClick

OnClick

जब उपयोगकर्ता topLabel या bottomLabel पर क्लिक करते हैं, तो यह कार्रवाई ट्रिगर होती है.

यूनियन फ़ील्ड control. decoratedText विजेट में टेक्स्ट के दाईं ओर दिखने वाला बटन, स्विच, चेकबॉक्स या इमेज. control इनमें से सिर्फ़ एक हो सकता है:
button

Button

कोई कार्रवाई ट्रिगर करने के लिए क्लिक किया जा सकने वाला बटन.

switchControl

SwitchControl

स्विच विजेट की स्थिति बदलने और कार्रवाई ट्रिगर करने के लिए उस पर क्लिक किया जा सकता है. फ़िलहाल, यह डायलॉग में काम करता है. कार्ड मैसेज की सुविधा जल्द ही उपलब्ध होगी.

endIcon

Icon

टेक्स्ट के बाद एक आइकॉन दिखता है.

स्टैंडर्ड और कस्टम आइकॉन के साथ काम करता है.

SwitchControl

decoratedText विजेट के अंदर टॉगल-स्टाइल स्विच या चेकबॉक्स.

सिर्फ़ decoratedText विजेट पर काम करता है.

फ़िलहाल, यह डायलॉग में काम करता है. कार्ड मैसेज की सुविधा जल्द ही उपलब्ध होगी.

फ़ील्ड
name

string

वह नाम जिससे स्विच विजेट की पहचान फ़ॉर्म इनपुट इवेंट में की जाती है.

फ़ॉर्म इनपुट के साथ काम करने के बारे में ज़्यादा जानने के लिए, फ़ॉर्म डेटा पाना देखें.

value

string

किसी उपयोगकर्ता की डाली गई वैल्यू, फ़ॉर्म इनपुट इवेंट के हिस्से के तौर पर मिलती है.

फ़ॉर्म इनपुट के साथ काम करने के बारे में ज़्यादा जानने के लिए, फ़ॉर्म डेटा पाना देखें.

selected

bool

true होने पर, स्विच चुना जाता है.

onChangeAction

Action

स्विच की स्थिति बदलने पर की जाने वाली कार्रवाई, जैसे कि कौनसा फ़ंक्शन चलाना है.

controlType

ControlType

यूज़र इंटरफ़ेस में स्विच कैसा दिखता है.

कंट्रोल टाइप

यूज़र इंटरफ़ेस में स्विच कैसा दिखता है.

Enums
SWITCH टॉगल-स्टाइल स्विच.
CHECKBOX CHECK_BOX के पक्ष में रोक दिया गया.
CHECK_BOX एक चेकबॉक्स.

डिवाइडर

विजेट के बीच में मौजूद डिवाइडर को हॉरिज़ॉन्टल लाइन में दिखाता है.

उदाहरण के लिए, यह JSON एक डिवाइडर बनाता है:

"divider": {
}

ऑटोकंप्लीट रिस्पॉन्स

ऑटोकंप्लीट की सुविधा से जुड़े कंटेनर को मिलने वाला रिस्पॉन्स, जिसमें टेक्स्ट फ़ील्ड के लिए, अपने-आप पूरे होने वाले आइटम दिखाने के लिए ज़रूरी एलिमेंट शामिल होते हैं. उदाहरण के लिए:

{
  "autoComplete": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}
फ़ील्ड
autoComplete

Suggestions

schema

string

यह एक नो-ऑप स्कीमा फ़ील्ड है, जो सिंटैक्स की जांच के लिए मार्कअप में मौजूद हो सकता है.

Grid

यह आइटम के ग्रिड को दिखाता है.

ग्रिड की मदद से, कॉलम और आइटम की किसी भी संख्या का इस्तेमाल किया जा सकता है. पंक्तियों की संख्या, आइटम की संख्या को कॉलम से भाग देकर तय की जाती है. ग्रिड में 10 आइटम और 2 कॉलम होते हैं. इसमें 5 पंक्तियां होती हैं. ग्रिड में 11 आइटम और दो कॉलम होते हैं. इसमें 6 पंक्तियां होती हैं.

फ़िलहाल, यह डायलॉग में काम करता है. कार्ड मैसेज की सुविधा जल्द ही उपलब्ध होगी.

उदाहरण के लिए, यह JSON एक आइटम के साथ दो कॉलम ग्रिड बनाता है:

"grid": {
  "title": "A fine collection of items",
  "numColumns": 2,
  "borderStyle": {
    "type": "STROKE",
    "cornerRadius": 4.0
  },
  "items": [
    "image": {
      "imageUri": "https://www.example.com/image.png",
      "cropStyle": {
        "type": "SQUARE"
      },
      "borderStyle": {
        "type": "STROKE"
      }
    },
    "title": "An item",
    "textAlignment": "CENTER"
  ],
  "onClick": {
    "openLink": {
      "url":"https://www.example.com"
    }
  }
}
फ़ील्ड
title

string

ग्रिड हेडर में दिखने वाला टेक्स्ट.

items[]

GridItem

ग्रिड में दिखाने के लिए आइटम.

borderStyle

BorderStyle

बॉर्डर के हर स्टाइल पर लागू करने के लिए बॉर्डर का स्टाइल.

columnCount

int32

ग्रिड में दिखाने के लिए कॉलम की संख्या. अगर डिफ़ॉल्ट फ़ील्ड का इस्तेमाल नहीं किया गया है, तो डिफ़ॉल्ट वैल्यू का इस्तेमाल किया जाता है. वहीं, ग्रिड के दिखने की जगह (डायलॉग बनाम साथी) के आधार पर, डिफ़ॉल्ट वैल्यू अलग-अलग होती है.

onClick

OnClick

इस कॉलबैक का हर ग्रिड आइटम के लिए फिर से इस्तेमाल किया जाता है. हालांकि, आइटम के आइडेंटिफ़ायर और कॉलबैक के पैरामीटर में जोड़े गए आइटम की सूची के साथ, इस कॉलबैक का फिर से इस्तेमाल किया जाता है.

ग्रिडआइटम

यह ग्रिड लेआउट में सिर्फ़ एक आइटम दिखाता है.

फ़ील्ड
id

string

इस ग्रिड आइटम के लिए उपयोगकर्ता की ओर से तय किया गया पहचानकर्ता. यह आइडेंटिफ़ायर, पैरंट ग्रिड के ऑनक्लिक कॉलबैक पैरामीटर में दिखता है.

image

ImageComponent

ग्रिड आइटम में दिखने वाली इमेज.

title

string

ग्रिड आइटम का शीर्षक.

subtitle

string

ग्रिड आइटम का उपशीर्षक.

layout

GridItemLayout

ग्रिड आइटम के लिए इस्तेमाल किया जाने वाला लेआउट.

ग्रिडआइटम लेआउट

यह ग्रिड आइटम के लिए उपलब्ध कई लेआउट विकल्पों को दिखाता है.

Enums
GRID_ITEM_LAYOUT_UNSPECIFIED कोई लेआउट नहीं बताया गया.
TEXT_BELOW शीर्षक और सबटाइटल, ग्रिड आइटम की इमेज के नीचे दिखते हैं.
TEXT_ABOVE शीर्षक और सबटाइटल, ग्रिड आइटम की इमेज के ऊपर दिखते हैं.

आइकॉन

कार्ड पर विजेट में एक आइकॉन दिखता है.

स्टैंडर्ड और कस्टम आइकॉन के साथ काम करता है.

फ़ील्ड
altText

string

ज़रूरी नहीं. सुलभता के लिए इस्तेमाल किए गए आइकॉन की जानकारी. अगर इसे तय न किया गया हो, तो डिफ़ॉल्ट वैल्यू दी जाती है. सबसे सही तरीका यह होगा कि आपको काम की जानकारी देनी चाहिए. उदाहरण के लिए, अगर कोई आइकॉन किसी उपयोगकर्ता के खाते का पोर्ट्रेट दिखाता है, तो आप उसे "उपयोगकर्ता के खाते का पोर्ट्रेट" के तौर पर दिखा सकते हैं.

अगर आइकॉन Button में दिखता है, तो यह ऑल्ट टेक्स्ट ज़रूरी होता है. साथ ही, यह बटन के वैकल्पिक टेक्स्ट को ओवरराइट कर देता है. इसलिए, आपको बटन के लिए वैकल्पिक टेक्स्ट लिखना चाहिए: जानकारी देने वाला टेक्स्ट सेट करें, ताकि उपयोगकर्ता समझ सकें कि बटन क्या करता है. उदाहरण के लिए, अगर कोई बटन हाइपरलिंक खोलता है, तो आप यह लिख सकते हैं: "नया ब्राउज़र टैब खोलता है और https://developers.google.com/chat" पर Google Chat डेवलपर दस्तावेज़ पर जाता है.

imageType

ImageType

इमेज क्रॉप करने के लिए इस स्टाइल का इस्तेमाल किया जा सकता है. कुछ मामलों में, CIRCLE क्रॉप लागू करने से इमेज, स्टैंडर्ड आइकॉन से बड़ी हो जाती है.

यूनियन फ़ील्ड icons. कार्ड पर मौजूद विजेट में दिखाया गया आइकॉन. icons इनमें से सिर्फ़ एक हो सकता है:
knownIcon

string

Google Workspace से मिले स्टैंडर्ड आइकॉन में से कोई एक दिखाएं.

उदाहरण के लिए, हवाई जहाज़ का आइकॉन दिखाने के लिए, AIRPLANE की जानकारी दें. बस के लिए, BUS बताएं.

काम करने वाले आइकॉन की पूरी सूची देखने के लिए, स्टैंडर्ड आइकॉन देखें.

iconUrl

string

एचटीटीपीएस यूआरएल पर होस्ट किया गया कस्टम आइकॉन दिखाएं.

उदाहरण के लिए:

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

.png और .jpg फ़ाइल टाइप का इस्तेमाल किया जा सकता है.

इमेज

ऐसी इमेज जिसे यूआरएल के ज़रिए तय किया गया हो और जिसमें onClick कार्रवाई की जा सकती हो.

फ़ील्ड
imageUrl

string

इमेज को होस्ट करने वाला https यूआरएल.

उदाहरण के लिए:

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

OnClick

जब कोई उपयोगकर्ता इमेज पर क्लिक करता है, तो क्लिक करने पर यह कार्रवाई ट्रिगर होती है.

altText

string

इस इमेज का वैकल्पिक टेक्स्ट, इसका इस्तेमाल सुलभता के लिए किया जाता है.

इमेज कॉम्पोनेंट

इमेज दिखाता है.

फ़ील्ड
imageUri

string

इमेज का यूआरएल.

altText

string

इमेज के लिए सुलभता का लेबल.

cropStyle

ImageCropStyle

इमेज लागू करने के लिए क्रॉप स्टाइल.

borderStyle

BorderStyle

इमेज पर लागू करने के लिए बॉर्डर का स्टाइल.

इमेज क्रॉपस्टाइल

इमेज में लागू की गई क्रॉप स्टाइल को दिखाता है.

उदाहरण के लिए, यहां आसपेक्ट रेशियो (चौड़ाई-ऊंचाई का अनुपात) को 16:9 तक लागू करने का तरीका बताया गया है:

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}
फ़ील्ड
type

ImageCropType

क्रॉप टाइप.

aspectRatio

double

अगर आसपेक्ट रेशियो RECTANGLE_CUSTOM है, तो आसपेक्ट रेशियो (चौड़ाई-ऊंचाई का अनुपात) इस्तेमाल किया जाएगा.

उदाहरण के लिए, यहां आसपेक्ट रेशियो (चौड़ाई-ऊंचाई का अनुपात) को 16:9 तक लागू करने का तरीका बताया गया है:

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

ImageCropType

इमेज में लागू की गई क्रॉप स्टाइल को दिखाता है.

Enums
IMAGE_CROP_TYPE_UNSPECIFIED कोई मान दर्ज नहीं किया गया है. इस्तेमाल न करें.
SQUARE डिफ़ॉल्ट मान. स्क्वेयर क्रॉप लागू करता है.
CIRCLE गोल क्रॉप का इस्तेमाल किया जाता है.
RECTANGLE_CUSTOM कस्टम आसपेक्ट रेशियो (चौड़ाई-ऊंचाई का अनुपात) वाली आयताकार क्रॉप लागू की जाती है. कस्टम आसपेक्ट रेशियो (चौड़ाई-ऊंचाई का अनुपात) को aspectRatio पर सेट करें.
RECTANGLE_4_3 4:3 के आसपेक्ट रेशियो (चौड़ाई-ऊंचाई का अनुपात) वाली आयताकार क्रॉप लागू करें.

कार्ड के स्टैक में हेर-फेर करने वाली कार्ड कार्रवाई. उदाहरण के लिए:

1) स्टैक में नया कार्ड जोड़ें (आगे की ओर नेविगेट करें).

 navigations : {
    pushCard : CARD
  }

2) स्टैक के ऊपर (अपडेट होने पर) कार्ड अपडेट करें.

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

3) अपडेट किए बिना एक चरण पीछे जाएं.

  navigations : {
    popCard : true,
  }

4) एक से ज़्यादा चरणों पर वापस जाएं और उस कार्ड को अपडेट करें.

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

5) तय किए गए CARD_NAME पर एक से ज़्यादा चरण वापस जाएं.

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

6) रूट पर वापस जाएं और उस कार्ड को अपडेट करें.

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

7) बताए गए कार्ड पर पॉप भी करें और उस कार्ड को भी पॉप करें.

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

8) सबसे बेहतर कार्ड की जगह नया कार्ड जोड़ें.

  navigations : {
    updateCard : CARD
  }
फ़ील्ड

यूनियन फ़ील्ड navigate_action.

navigate_action इनमें से सिर्फ़ एक हो सकता है:

popToRoot

bool

कार्ड स्टैक, रूट कार्ड को छोड़कर सभी कार्ड को बंद कर देता है.

pop

bool

कार्ड स्टैक से एक कार्ड बंद होता है.

popToCard

string

कार्ड स्टैक, दिए गए कार्ड के नाम के साथ बताए गए कार्ड के ऊपर के सभी कार्ड को पॉप करता है.

pushCard

Card

कार्ड स्टैक, कार्ड स्टैक में कार्ड को पुश करता है.

updateCard

Card

कार्ड स्टैक, नए कार्ड के साथ टॉप कार्ड को अपडेट करता है और भरे हुए फ़ील्ड फ़ील्ड की वैल्यू को सुरक्षित रखता है. किसी गैर-बराबर फ़ील्ड के लिए, मान छोड़ दिया जाता है.

सूचना

कार्ड ऐक्शन, जो होस्ट ऐप्लिकेशन में सूचना दिखाता है.

फ़ील्ड
text

string

सूचना के लिए दिखने वाला टेक्स्ट, जिसमें एचटीएमएल टैग शामिल न हों.

ऑनक्लिक

इससे पता चलता है कि उपयोगकर्ता, कार्ड जैसे किसी इंटरैक्टिव एलिमेंट पर क्लिक करने पर कैसे जवाब देते हैं, जैसे कि कोई बटन.

फ़ील्ड

यूनियन फ़ील्ड data.

data इनमें से सिर्फ़ एक हो सकता है:

action

Action

अगर बताया गया हो, तो इस onClick कार्रवाई को ट्रिगर करता है.

openDynamicLinkAction

Action

जब कार्रवाई के लिए कोई लिंक खोलना ज़रूरी हो, तो ऐड-ऑन इस कार्रवाई को ट्रिगर करता है. यह ऊपर दिए गए open_link से अलग है, क्योंकि लिंक पाने के लिए, इसे सर्वर से बात करनी होती है. इसलिए, लिंक खोलने पर की जाने वाली कार्रवाई का जवाब मिलने से पहले, वेब क्लाइंट को कुछ तैयारी करनी होगी.

card

Card

अगर बताया गया हो, तो एक नए कार्ड पर क्लिक करने के बाद, कार्ड स्टैक में पुश किया जाता है.

Google Workspace ऐड-ऑन का इस्तेमाल किया जा सकता है, लेकिन Chat के साथ काम नहीं करता.

चालू करें

OnClick कार्रवाई से खुलने वाला लिंक बंद होने पर क्लाइंट क्या करता है.

लागू करना, क्लाइंट प्लैटफ़ॉर्म की क्षमताओं पर निर्भर करता है. उदाहरण के लिए, कोई वेब ब्राउज़र, पॉप-अप विंडो में किसी लिंक को OnClose हैंडलर के साथ खोल सकता है.

अगर OnOpen और OnClose दोनों हैंडलर सेट हैं और क्लाइंट प्लैटफ़ॉर्म दोनों वैल्यू के साथ काम नहीं कर सकता, तो OnClose को प्राथमिकता दी जाती है.

Google Workspace ऐड-ऑन का इस्तेमाल किया जा सकता है, लेकिन Chat के साथ काम नहीं करता.

Enums
NOTHING डिफ़ॉल्ट मान. कार्ड फिर से लोड नहीं होता है. कुछ नहीं होता है.
RELOAD

चाइल्ड विंडो बंद होने के बाद, कार्ड को फिर से लोड करता है.

OpenAs.OVERLAY के साथ इस्तेमाल किए जाने पर, चाइल्ड विंडो मोडल डायलॉग के तौर पर काम करती है और चाइल्ड विंडो के बंद होने तक पैरंट कार्ड को ब्लॉक किया जाता है.

OpenAss

जब ऑनक्लिक एक लिंक खोलता है, तो क्लाइंट या तो उसे फ़ुल साइज़ विंडो (अगर क्लाइंट ने इस्तेमाल किया गया फ़्रेम है) या ओवरले (जैसे कि पॉप-अप) के तौर पर खोला हो. लागू करना, क्लाइंट प्लैटफ़ॉर्म की क्षमताओं पर निर्भर करता है. साथ ही, क्लाइंट के साथ काम न करने पर, चुनी गई वैल्यू को अनदेखा किया जा सकता है. FULL_SIZE सभी क्लाइंट के साथ काम करता है.

Google Workspace ऐड-ऑन का इस्तेमाल किया जा सकता है, लेकिन Chat के साथ काम नहीं करता.

Enums
FULL_SIZE लिंक, फ़ुल साइज़ विंडो के तौर पर खुलता है. अगर क्लाइंट इस फ़्रेम का इस्तेमाल करता है.
OVERLAY यह लिंक, ओवरले के तौर पर खुलता है, जैसे कि पॉप-अप.

रेंडर करने से जुड़ी कार्रवाइयां

रेंडर करने के लिए निर्देशों का सेट, जो कार्ड को कोई कार्रवाई करने का निर्देश देता है और/या ऐड-ऑन होस्ट ऐप्लिकेशन को ऐप्लिकेशन के हिसाब से कार्रवाई करने के लिए कहता है.

फ़ील्ड
action

Action

hostAppAction

HostAppActionMarkup

अलग-अलग होस्ट ऐप्लिकेशन से मैनेज की जाने वाली कार्रवाइयां.

schema

string

यह एक नो-ऑप स्कीमा फ़ील्ड है, जो सिंटैक्स की जांच के लिए मार्कअप में मौजूद हो सकता है.

कार्रवाई

फ़ील्ड
navigations[]

Navigation

दिखाए गए कार्ड पुश करें, पॉप करें या अपडेट करें.

notification

Notification

असली उपयोगकर्ता को सूचना दिखाएं.

चुने गए इनपुट

एक विजेट जो उपयोगकर्ताओं के लिए एक विकल्प के तौर पर यूज़र इंटरफ़ेस (यूआई) आइटम बनाता है. उदाहरण के लिए, ड्रॉपडाउन मेन्यू या चेक लिस्ट.

Chat ऐप्लिकेशन, फ़ॉर्म इनपुट इवेंट के दौरान डाले गए टेक्स्ट की वैल्यू प्रोसेस कर सकते हैं. फ़ॉर्म इनपुट के साथ काम करने के बारे में ज़्यादा जानने के लिए, फ़ॉर्म डेटा पाना देखें.

अगर आपको उन उपयोगकर्ताओं से डेटा इकट्ठा करना है जो आपके सेट किए गए विकल्पों से मेल खाते हैं, तो कोई विकल्प चुनें. उपयोगकर्ताओं से ऐब्स्ट्रैक्ट डेटा इकट्ठा करने के लिए, टेक्स्ट इनपुट विजेट का इस्तेमाल करें.

सिर्फ़ डायलॉग में काम करता है. कार्ड मैसेज की सुविधा जल्द ही उपलब्ध होगी.

फ़ील्ड
name

string

वह नाम जिससे चुने गए इनपुट को फ़ॉर्म इनपुट इवेंट में पहचाना गया है.

फ़ॉर्म इनपुट के साथ काम करने के बारे में ज़्यादा जानने के लिए, फ़ॉर्म डेटा पाना देखें.

label

string

यूज़र इंटरफ़ेस में, चुने गए इनपुट फ़ील्ड के ऊपर दिखने वाला टेक्स्ट.

वह टेक्स्ट डालें जिससे उपयोगकर्ता को वह जानकारी डालने में मदद मिलती है जो आपके ऐप्लिकेशन के लिए ज़रूरी है. उदाहरण के लिए, अगर उपयोगकर्ता ड्रॉप-डाउन मेन्यू से काम के टिकट की ज़रूरत के बारे में बता रहे हैं, तो हो सकता है कि लेबल "ज़रूरी" या "तुरंत चुनें."

type

SelectionType

उपयोगकर्ताओं को कोई विकल्प दिखने का तरीका. अलग-अलग विकल्पों के लिए अलग-अलग तरह के इंटरैक्शन काम करते हैं. उदाहरण के लिए, उपयोगकर्ता कई चेक बॉक्स चालू कर सकते हैं, लेकिन ड्रॉपडाउन मेन्यू से सिर्फ़ एक मान चुन सकते हैं.

चुने गए हर इनपुट में, एक तरह का डेटा चुनने की सुविधा होती है. उदाहरण के लिए, चेक बॉक्स और स्विच को एक साथ नहीं जोड़ा जा सकता.

items[]

SelectionItem

चुने गए आइटम की कैटगरी. उदाहरण के लिए, चुने गए सभी चेक बॉक्स.

onChangeAction

Action

जानकारी देने पर, चुने गए विकल्प में बदलाव होने पर फ़ॉर्म सबमिट कर दिया जाता है. अगर इसके बारे में नहीं बताया गया है, तो आपको फ़ॉर्म सबमिट करने वाले एक अलग बटन का इस्तेमाल करना होगा.

फ़ॉर्म इनपुट के साथ काम करने के बारे में ज़्यादा जानने के लिए, फ़ॉर्म डेटा पाना देखें.

चुने गए सामान

चुनने के लिए इस्तेमाल किए जाने वाले इनपुट में, चुनने लायक आइटम, जैसे कि चेक बॉक्स या स्विच.

फ़ील्ड
text

string

उपयोगकर्ताओं को दिखाया गया टेक्स्ट.

value

string

इस आइटम से जुड़ी वैल्यू. क्लाइंट को इसका इस्तेमाल फ़ॉर्म इनपुट वैल्यू के तौर पर करना चाहिए.

फ़ॉर्म इनपुट के साथ काम करने के बारे में ज़्यादा जानने के लिए, फ़ॉर्म डेटा पाना देखें.

selected

bool

true होने पर, एक से ज़्यादा आइटम चुने गए हों. अगर रेडियो बटन और ड्रॉपडाउन मेन्यू में एक से ज़्यादा आइटम चुने गए हैं, तो सबसे पहले चुने गए आइटम को अनदेखा किया जाता है और उसके बाद आइटम को नज़रअंदाज़ किया जाता है.

चुने गए का प्रकार

उपयोगकर्ताओं को कोई विकल्प दिखने का तरीका. अलग-अलग विकल्पों के लिए अलग-अलग तरह के इंटरैक्शन काम करते हैं. उदाहरण के लिए, उपयोगकर्ता कई चेक बॉक्स चालू कर सकते हैं, लेकिन ड्रॉपडाउन मेन्यू से सिर्फ़ एक मान चुन सकते हैं.

चुने गए हर इनपुट में, एक तरह का डेटा चुनने की सुविधा होती है. उदाहरण के लिए, चेक बॉक्स और स्विच को एक साथ नहीं जोड़ा जा सकता.

फ़िलहाल, यह डायलॉग में काम करता है. कार्ड मैसेज की सुविधा जल्द ही उपलब्ध होगी.

Enums
CHECK_BOX

चेकबॉक्स का सेट. उपयोगकर्ता हर चुने गए इनपुट के लिए एक से ज़्यादा चेक बॉक्स चुन सकते हैं.

फ़िलहाल, यह डायलॉग में काम करता है. कार्ड मैसेज की सुविधा जल्द ही उपलब्ध होगी.

RADIO_BUTTON

रेडियो बटन का एक सेट. उपयोगकर्ता हर इनपुट के लिए एक रेडियो बटन चुन सकते हैं.

फ़िलहाल, यह डायलॉग में काम करता है. कार्ड मैसेज की सुविधा जल्द ही उपलब्ध होगी.

SWITCH

स्विच का सेट. उपयोगकर्ता हर चुने गए इनपुट के लिए एक साथ कई स्विच चालू कर सकते हैं.

फ़िलहाल, यह डायलॉग में काम करता है. कार्ड मैसेज की सुविधा जल्द ही उपलब्ध होगी.

DROPDOWN

ड्रॉपडाउन मेन्यू. उपयोगकर्ता हर चुने गए इनपुट के लिए एक ड्रॉपडाउन मेन्यू आइटम चुन सकते हैं.

फ़िलहाल, यह डायलॉग में काम करता है. कार्ड मैसेज की सुविधा जल्द ही उपलब्ध होगी.

सबमिट फ़ॉर्म का जवाब दें

फ़ॉर्म को अपने-आप पूरा होने वाले कंटेनर के अलावा, किसी और फ़ॉर्म के जवाब में सबमिट किया जाता है. इसमें वे कार्रवाइयां शामिल होती हैं जो कार्ड को करनी चाहिए और/या ऐड-ऑन होस्ट ऐप्लिकेशन को करनी चाहिए, और कार्ड की स्थिति बदली गई है या नहीं. उदाहरण के लिए:

{
  "renderActions": {
    "action": {
      "notification": {
        "text": "Email address is added: salam.heba@example.com"
      }
    },
    "hostAppAction": {
      "gmailAction": {
        "openCreatedDraftAction": {
          "draftId": "msg-a:r-79766936926021702",
          "threadServerPermId": "thread-f:15700999851086004"
        }
      }
    }
  }
}
फ़ील्ड
renderActions

RenderActions

रेंडर करने के लिए निर्देशों का सेट, जो कार्ड को कार्रवाई करने के लिए कहता है और/या ऐड-ऑन होस्ट ऐप्लिकेशन को ऐप्लिकेशन के हिसाब से कार्रवाई करने के लिए कहता है.

stateChanged

bool

कार्ड की स्थिति बदल गई है या मौजूदा कार्ड का डेटा पुराना है.

schema

string

यह एक नो-ऑप स्कीमा फ़ील्ड है, जो सिंटैक्स की जांच के लिए मार्कअप में मौजूद हो सकता है.

Suggestions

सुझाई गई वैल्यू, जिन्हें उपयोगकर्ता डाल सकते हैं. ये वैल्यू तब दिखती हैं, जब उपयोगकर्ता टेक्स्ट इनपुट फ़ील्ड में क्लिक करते हैं. उपयोगकर्ता टाइप करते ही, सुझाई गई वैल्यू डाइनैमिक तौर पर फ़िल्टर हो जाती हैं, ताकि उपयोगकर्ता के टाइप किए गए टेक्स्ट से मैच हो सके.

उदाहरण के लिए, प्रोग्रामिंग भाषा के लिए टेक्स्ट इनपुट फ़ील्ड, Java, JavaScript, Python, और C++ का सुझाव दे सकता है. जब उपयोगकर्ता "Jav" टाइप करना शुरू करते हैं, तो सुझावों की सूची सिर्फ़ Java और JavaScript दिखाने के लिए फ़िल्टर होती है.

सुझाई गई वैल्यू का इस्तेमाल करके, उपयोगकर्ताओं को ऐसी वैल्यू डाली जा सकती हैं जो आपके ऐप्लिकेशन के लिए सही हों. JavaScript का संदर्भ देते समय, कुछ उपयोगकर्ता "JavaScript" और अन्य "java स्क्रिप्ट" डाल सकते हैं. "JavaScript" का सुझाव देने से यह मानक हो सकता है कि उपयोगकर्ता आपके ऐप्लिकेशन से कैसे इंटरैक्ट करते हैं.

तय होने पर, TextInput.type हमेशा SINGLE_LINE होता है, भले ही वह MULTIPLE_LINE पर सेट हो.

फ़ील्ड
items[]

SuggestionItem

टेक्स्ट इनपुट फ़ील्ड में, अपने-आप पूरा होने वाले सुझावों की सूची.

सुझाव आइटम

एक सुझाई गई वैल्यू, जिसे उपयोगकर्ता टेक्स्ट इनपुट फ़ील्ड में डाल सकते हैं.

फ़ील्ड
text

string

टेक्स्ट इनपुट फ़ील्ड के लिए, सुझाए गए इनपुट की वैल्यू. यह ठीक वैसा ही है जैसा उपयोगकर्ता खुद डालते हैं.

टेक्स्ट इनपुट

वह फ़ील्ड जिसमें उपयोगकर्ता टेक्स्ट डाल सकते हैं. सुझाव और ऑन-चेंज ऐक्शन का इस्तेमाल करता है.

Chat ऐप्लिकेशन, फ़ॉर्म इनपुट इवेंट के दौरान डाले गए टेक्स्ट की वैल्यू प्रोसेस कर सकते हैं. फ़ॉर्म इनपुट के साथ काम करने के बारे में ज़्यादा जानने के लिए, फ़ॉर्म डेटा पाना देखें.

उपयोगकर्ताओं से ऐब्स्ट्रैक्ट डेटा इकट्ठा करने के लिए, टेक्स्ट इनपुट का इस्तेमाल करें. उपयोगकर्ताओं का तय डेटा इकट्ठा करने के लिए, इसके बजाय चुने गए इनपुट विजेट का इस्तेमाल करें.

सिर्फ़ डायलॉग में काम करता है. कार्ड मैसेज की सुविधा जल्द ही उपलब्ध होगी.

फ़ील्ड
name

string

वह नाम जिससे फ़ॉर्म इनपुट इवेंट में टेक्स्ट इनपुट की पहचान की गई है.

फ़ॉर्म इनपुट के साथ काम करने के बारे में ज़्यादा जानने के लिए, फ़ॉर्म डेटा पाना देखें.

label

string

यूज़र इंटरफ़ेस में, टेक्स्ट इनपुट फ़ील्ड के ऊपर दिखने वाला टेक्स्ट.

वह टेक्स्ट डालें जिससे उपयोगकर्ता को वह जानकारी डालने में मदद मिलती है जो आपके ऐप्लिकेशन के लिए ज़रूरी है. उदाहरण के लिए, अगर आप किसी का नाम पूछ रहे हैं, लेकिन उसे खास तौर पर आपका उपनाम चाहिए, तो "नाम" के बजाय "उपनाम" लिखें.

अगर hintText बताया नहीं गया है, तो ज़रूरी है. या फिर, ज़रूरी नहीं.

hintText

string

टेक्स्ट इनपुट फ़ील्ड में दिखने वाला टेक्स्ट, जिसका इस्तेमाल करके उपयोगकर्ताओं को किसी खास वैल्यू को डालने के लिए कहा जाता है. उपयोगकर्ताओं के टाइप करने के बाद यह टेक्स्ट नहीं दिखेगा.

अगर label बताया नहीं गया है, तो ज़रूरी है. या फिर, ज़रूरी नहीं.

value

string

किसी उपयोगकर्ता की डाली गई वैल्यू, फ़ॉर्म इनपुट इवेंट के हिस्से के तौर पर मिलती है.

फ़ॉर्म इनपुट के साथ काम करने के बारे में ज़्यादा जानने के लिए, फ़ॉर्म डेटा पाना देखें.

type

Type

यूज़र इंटरफ़ेस में टेक्स्ट इनपुट फ़ील्ड कैसा दिखता है. उदाहरण के लिए, फ़ील्ड एक फ़ील्ड वाला है या कई लाइन का है.

onChangeAction

Action

टेक्स्ट इनपुट फ़ील्ड में बदलाव होने पर क्या करें.

बदलावों के उदाहरणों में, उपयोगकर्ता को फ़ील्ड में जोड़ना या टेक्स्ट मिटाना शामिल है.

कस्टम फ़ंक्शन चलाने या Google Chat में डायलॉग खोलने जैसी कार्रवाइयों के उदाहरण हैं.

initialSuggestions

Suggestions

सुझाई गई वैल्यू, जिन्हें उपयोगकर्ता डाल सकते हैं. ये वैल्यू तब दिखती हैं, जब उपयोगकर्ता टेक्स्ट इनपुट फ़ील्ड में क्लिक करते हैं. उपयोगकर्ता टाइप करते ही, सुझाई गई वैल्यू डाइनैमिक तौर पर फ़िल्टर हो जाती हैं, ताकि उपयोगकर्ता के टाइप किए गए टेक्स्ट से मैच हो सके.

उदाहरण के लिए, प्रोग्रामिंग भाषा के लिए टेक्स्ट इनपुट फ़ील्ड, Java, JavaScript, Python, और C++ का सुझाव दे सकता है. जब उपयोगकर्ता "Jav" टाइप करना शुरू करते हैं, तो सुझावों की सूची सिर्फ़ Java और JavaScript दिखाने के लिए फ़िल्टर होती है.

सुझाई गई वैल्यू का इस्तेमाल करके, उपयोगकर्ताओं को ऐसी वैल्यू डाली जा सकती हैं जो आपके ऐप्लिकेशन के लिए सही हों. JavaScript का संदर्भ देते समय, कुछ उपयोगकर्ता "JavaScript" और अन्य "java स्क्रिप्ट" डाल सकते हैं. "JavaScript" का सुझाव देने से यह मानक हो सकता है कि उपयोगकर्ता आपके ऐप्लिकेशन से कैसे इंटरैक्ट करते हैं.

तय होने पर, TextInput.type हमेशा SINGLE_LINE होता है, भले ही वह MULTIPLE_LINE पर सेट हो.

autoCompleteAction

Action

ज़रूरी नहीं. बताएं कि जब टेक्स्ट इनपुट फ़ील्ड, उन उपयोगकर्ताओं को सुझाव दे जो इसके साथ इंटरैक्ट करते हैं, तो क्या करें.

अगर कोई वैल्यू तय नहीं की गई है, तो इसे initialSuggestions सेट करते हैं और क्लाइंट इन्हें प्रोसेस करता है.

अगर बताया गया हो, तो ऐप्लिकेशन यहां बताई गई कार्रवाई करता है, जैसे कि कस्टम फ़ंक्शन चलाना.

Google Workspace ऐड-ऑन का इस्तेमाल किया जा सकता है, लेकिन Chat के साथ काम नहीं करता. जल्द ही Chat ऐप्लिकेशन में सहायता की सुविधा उपलब्ध होगी.

टाइप

यूज़र इंटरफ़ेस में टेक्स्ट इनपुट फ़ील्ड कैसा दिखता है. उदाहरण के लिए, चाहे यह एक लाइन वाला इनपुट फ़ील्ड हो या एक से ज़्यादा लाइन वाला इनपुट.

अगर initialSuggestions तय किया गया हो, तो type हमेशा SINGLE_LINE होता है, भले ही वह MULTIPLE_LINE पर सेट हो.

Enums
SINGLE_LINE टेक्स्ट इनपुट फ़ील्ड की ऊंचाई तय होती है.
MULTIPLE_LINE टेक्स्ट इनपुट फ़ील्ड की ऊंचाई तय होती है.

टेक्स्टपैराग्राफ़

टेक्स्ट का एक पैराग्राफ़, जो फ़ॉर्मैटिंग के साथ काम करता है. ज़्यादा जानकारी के लिए, टेक्स्ट फ़ॉर्मैटिंग देखें.

फ़ील्ड
text

string

विजेट में दिखाया जाने वाला टेक्स्ट.

विजेट

हर कार्ड में विजेट होते हैं.

विजेट एक कंपोज़िट ऑब्जेक्ट होता है, जो किसी एक टेक्स्ट, इमेज, बटन, और दूसरे ऑब्जेक्ट को दिखा सकता है.

फ़ील्ड
यूनियन फ़ील्ड data. विजेट में इनमें से सिर्फ़ एक आइटम हो सकता है. ज़्यादा आइटम दिखाने के लिए, आप एक से ज़्यादा विजेट फ़ील्ड का इस्तेमाल कर सकते हैं. data इनमें से सिर्फ़ एक हो सकता है:
textParagraph

TextParagraph

टेक्स्ट का पैराग्राफ़ दिखाता है. आसान एचटीएमएल फ़ॉर्मैट वाले टेक्स्ट के साथ काम करता है.

उदाहरण के लिए, यह JSON बोल्ड टेक्स्ट बनाता है:

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

Image

कोई इमेज दिखाता है.

उदाहरण के लिए, नीचे दिया गया JSON वैकल्पिक टेक्स्ट वाली इमेज बनाता है:

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

DecoratedText

सजाया गया टेक्स्ट आइटम दिखाता है.

उदाहरण के लिए, यहां दिया गया JSON, ईमेल पते दिखाने वाला सजावटी टेक्स्ट विजेट बनाता है:

"decoratedText": {
  "icon": {
    "knownIcon": "EMAIL"
  },
  "topLabel": "Email Address",
  "text": "sasha@example.com",
  "bottomLabel": "This is a new Email address!",
  "switchWidget": {
    "name": "has_send_welcome_email_to_sasha",
    "selected": false,
    "controlType": "ControlType.CHECKBOX"
  }
}
buttonList

ButtonList

बटन की सूची.

उदाहरण के लिए, यह JSON दो बटन बनाता है. पहला है नीले रंग का टेक्स्ट बटन और दूसरा, इमेज बटन जो लिंक को खोलता है:

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

TextInput

एक टेक्स्ट बॉक्स दिखाता है, जिसमें उपयोगकर्ता टाइप कर सकते हैं.

फ़िलहाल, यह डायलॉग में काम करता है. कार्ड मैसेज की सुविधा जल्द ही उपलब्ध होगी.

उदाहरण के लिए, यहां दिया गया JSON, ईमेल पते के लिए टेक्स्ट इनपुट बनाता है:

"textInput": {
  "name": "mailing_address",
  "label": "Mailing Address"
}

दूसरे उदाहरण के तौर पर, नीचे दिया गया JSON, स्टैटिक सुझावों वाली प्रोग्रामिंग भाषा के लिए टेक्स्ट इनपुट बनाता है:

"textInput": {
  "name": "preferred_programing_language",
  "label": "Preferred Language",
  "initialSuggestions": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}
selectionInput

SelectionInput

इसमें सेलेक्शन कंट्रोल दिखता है, जिससे उपयोगकर्ता आइटम चुन सकते हैं. चेकबॉक्स में रेडियो, बटन, स्विच या ड्रॉपडाउन मेन्यू चुने जा सकते हैं.

फ़िलहाल, यह डायलॉग में काम करता है. कार्ड मैसेज की सुविधा जल्द ही उपलब्ध होगी.

उदाहरण के लिए, नीचे दिया गया JSON, ड्रॉपडाउन मेन्यू बनाता है. इसकी मदद से, उपयोगकर्ता कोई साइज़ चुन सकते हैं:

"selectionInput": {
  "name": "size",
  "label": "Size"
  "type": "SelectionType.DROPDOWN",
  "items": [
    {
      "text": "S",
      "value": "small",
      "selected": false
    },
    {
      "text": "M",
      "value": "medium",
      "selected": true
    },
    {
      "text": "L",
      "value": "large",
      "selected": false
    },
    {
      "text": "XL",
      "value": "extra_large",
      "selected": false
    }
  ]
}
dateTimePicker

DateTimePicker

तारीख, समय या तारीख और समय के लिए, चुने गए/इनपुट विजेट को दिखाता है.

Chat ऐप्लिकेशन में यह सुविधा उपलब्ध नहीं है. जल्द ही Chat ऐप्लिकेशन के लिए सहायता उपलब्ध होगी.

उदाहरण के लिए, नीचे दिया गया JSON, अपॉइंटमेंट शेड्यूल करने के लिए, तारीख और समय का पिकर बनाता है:

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

Divider

विजेट के बीच हॉरिज़ॉन्टल लाइन डिवाइडर दिखाता है.

उदाहरण के लिए, यह JSON एक डिवाइडर बनाता है:

"divider": {
}
grid

Grid

यह आइटम के ग्रिड को दिखाता है.

ग्रिड की मदद से, कॉलम और आइटम की किसी भी संख्या का इस्तेमाल किया जा सकता है. लाइनों के नंबर की संख्या को आइटम की ऊपरी सीमाओं से कॉलम की संख्या से भाग देकर तय किया जाता है. ग्रिड में 10 आइटम और 2 कॉलम होते हैं. इसमें 5 पंक्तियां होती हैं. ग्रिड में 11 आइटम और दो कॉलम होते हैं. इसमें 6 पंक्तियां होती हैं.

फ़िलहाल, यह डायलॉग में काम करता है. कार्ड मैसेज की सुविधा जल्द ही उपलब्ध होगी.

उदाहरण के लिए, यह JSON एक आइटम के साथ दो कॉलम ग्रिड बनाता है:

"grid": {
  "title": "A fine collection of items",
  "numColumns": 2,
  "borderStyle": {
    "type": "STROKE",
    "cornerRadius": 4.0
  },
  "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"
    }
  }
}

इमेज टाइप

इमेज को काटने के लिए इस्तेमाल किया गया आकार.

Enums
SQUARE डिफ़ॉल्ट मान. इमेज पर स्क्वेयर मास्क लागू करता है. उदाहरण के लिए, 4x3 की इमेज 3x3 में बदल जाती है.
CIRCLE इमेज में एक गोलाकार मास्क लागू किया जाता है. उदाहरण के लिए, किसी 4x3 इमेज का सर्कल बन जाता है, जिसका व्यास 3 हो.