Google Chat ऐप्लिकेशन को Google Workspace ऐड-ऑन में बदलना

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

बदलने पर, आपका Google Chat ऐप्लिकेशन, Google Workspace ऐड-ऑन फ़्रेमवर्क का इस्तेमाल कर सकता है. इससे Google Chat और Google Workspace में इंटिग्रेशन और सुविधाओं के लिए नए विकल्प खुल जाते हैं. उदाहरण के लिए, Google Workspace Marketplace के ज़रिए एक Google Workspace ऐड-ऑन डिस्ट्रिब्यूट किया जा सकता है. यह ऐड-ऑन, Chat ऐप्लिकेशन के साथ-साथ Gmail, Calendar, और Docs जैसे Google Workspace के होस्ट ऐप्लिकेशन की सुविधाओं को बेहतर बनाता है.

सीमाएं

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

पहला चरण: Google Chat ऐप्लिकेशन का मौजूदा कोड कॉपी करना

कन्वर्ज़न प्रोसेस के लिए, कोड में बदलाव करना ज़रूरी है. Google Chat ऐप्लिकेशन के लाइव वर्शन पर कोई असर न पड़े, इसके लिए अपने कोड की एक कॉपी बनाएं और उस पर काम करें.

Apps Script

  1. Google Chat ऐप्लिकेशन में मौजूद Google Apps Script प्रोजेक्ट खोलें.
  2. बाईं ओर, खास जानकारी पर क्लिक करें.
  3. दाईं ओर, कॉपी बनाएं पर क्लिक करें.
  4. बाईं ओर मौजूद, प्रोजेक्ट सेटिंग पर क्लिक करें.
  5. Google Cloud प्रोजेक्ट में जाकर, प्रोजेक्ट बदलें पर क्लिक करें.
  6. वही प्रोजेक्ट नंबर डालें जो आपके मौजूदा Google Chat ऐप्लिकेशन प्रोजेक्ट से जुड़ा है.
  7. प्रोजेक्ट सेट करें पर क्लिक करें.

HTTP

अपने मौजूदा कोड बेस की कॉपी बनाएं या उसे फ़ोर्क करें. इसके बाद, उसे नई सेवा के तौर पर डिप्लॉय करें. यह सेवा, आपके लाइव Google Chat ऐप्लिकेशन से अलग होगी.

अगर आपका ऐप्लिकेशन Google Cloud पर डिप्लॉय किया गया है और यह Google Cloud प्रोजेक्ट से जुड़ी सुविधाओं पर निर्भर करता है (उदाहरण के लिए, App Engine की डिफ़ॉल्ट पहचान), तो नए कोड को मौजूदा Google Chat ऐप्लिकेशन प्रोजेक्ट से जुड़ी सेवा पर डिप्लॉय किया जाना चाहिए.

दूसरा चरण: कॉपी किए गए कोड में बदलाव करना

Google Chat की सुविधाओं को बढ़ाने वाले Google Workspace ऐड-ऑन, अनुरोध और जवाब के लिए अलग-अलग स्ट्रक्चर का इस्तेमाल करते हैं. ऐसा, ऐड-ऑन के तौर पर उपलब्ध न होने वाले Chat ऐप्लिकेशन की तुलना में किया जाता है. अनुरोधों और जवाबों के लिए, आपको अपने कोड को अपडेट करना होगा. इसके लिए, Google Chat API के इंटरैक्शन इवेंट (Event) के बजाय, Google Workspace ऐड-ऑन के इवेंट ऑब्जेक्ट (EventObject) का इस्तेमाल करें. अपने कोड में बदलाव करने के लिए, कोड कन्वर्ज़न गाइड का इस्तेमाल करें.

तीसरा चरण: टेस्ट के लिए उपयोगकर्ताओं के लिए, Google Workspace ऐड-ऑन कॉन्फ़िगरेशन चालू करना

Google Chat ऐप्लिकेशन के लिए, Google Workspace ऐड-ऑन की सेटिंग कॉन्फ़िगर करने के लिए, Google Cloud Console का इस्तेमाल करें:

  1. Google Cloud Console में, Google Chat API के कॉन्फ़िगरेशन पेज पर जाएं.

    Google Chat API के कॉन्फ़िगरेशन पेज पर जाएं

  2. इंटरैक्टिव सुविधाएं में जाकर, इंटरैक्टिव सुविधाएं चालू करें को चालू करें.

  3. Google Workspace ऐड-ऑन में बदलें में जाकर, ऐड-ऑन में बदलें पर क्लिक करें.

  4. ऐड-ऑन कॉन्फ़िगरेशन सेटिंग चालू करें को चालू करें.

  5. दिखने की सेटिंग सेक्शन में, टेस्ट उपयोगकर्ताओं के ईमेल पते जोड़ें.

  6. अगर ज़रूरी हो, तो कनेक्शन सेटिंग को अपडेट करें. इसके लिए, दूसरे चरण में कॉपी किए गए और बदले गए Google Chat ऐप्लिकेशन के कोड का डिप्लॉयमेंट एंडपॉइंट यूआरएल या Apps Script डिप्लॉयमेंट आईडी डालें.

  7. सेव करें और टेस्ट करें पर क्लिक करें.

चौथा चरण: बदले गए ऐप्लिकेशन की जांच करना

तीसरे चरण में कॉन्फ़िगर किए गए टेस्ट उपयोगकर्ता खातों का इस्तेमाल करके, Google Workspace ऐड-ऑन की सुविधा की अच्छी तरह से जांच करें. सभी सुविधाओं और इंटरैक्शन की पुष्टि करें.

पांचवां चरण: सभी उपयोगकर्ताओं के लिए कन्वर्ज़न पूरा करना

पुष्टि करने के बाद कि बदला गया Google Workspace ऐड-ऑन सही तरीके से काम कर रहा है, इसे सभी उपयोगकर्ताओं के लिए उपलब्ध कराया जा सकता है.

  1. Google Cloud Console में, Google Chat API के कॉन्फ़िगरेशन पेज पर जाएं.

    Google Chat API के कॉन्फ़िगरेशन पेज पर जाएं

  2. इंटरैक्टिव सुविधाएं में जाकर, ऐड-ऑन में बदलें पर क्लिक करें. ऐसा करने पर, एक साइड पैनल खुलेगा.

  3. साइड पैनल में, ऐड-ऑन में बदलें पर क्लिक करें.

  4. अपना प्रोजेक्ट आईडी डालें और बदलें पर क्लिक करें.

Google Chat ऐप्लिकेशन अब Google Workspace ऐड-ऑन है. यह Google Chat की सुविधाओं को बढ़ाता है.

ज़रूरी नहीं: इस्तेमाल न किए गए Google Cloud संसाधनों को हटाएं या उन्हें खाली करें

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

कोड कन्वर्ज़न गाइड

इस सेक्शन में, Google Chat API इंटरैक्शन Event फ़ॉर्मैट और Google Workspace ऐड-ऑन EventObject फ़ॉर्मैट के बीच मैपिंग के बारे में बताया गया है.

मैपिंग का अनुरोध करना

यहां दी गई टेबल में बताया गया है कि Google Chat API Event में मौजूद फ़ील्ड, Google Workspace ऐड-ऑन EventObject में मौजूद फ़ील्ड से कैसे मैप होते हैं. यह जानकारी, ऐसे Chat ऐप्लिकेशन के लिए है जो ऐड-ऑन नहीं है.

ऐसा Chat ऐप्लिकेशन जो ऐड-ऑन नहीं है (Event फ़ील्ड) Google Workspace ऐड-ऑन EventObject फ़ील्ड नोट
action.actionMethodName लागू नहीं कार्ड इंटरैक्शन के लिए, commonEventObject.parameters में पैरामीटर के तौर पर तरीके का नाम पास किया जा सकता है. शुरुआती डायलॉग बॉक्स खोलना लेख पढ़ें.
action.parameters commonEventObject.parameters
appCommandMetadata chat.appCommandPayload.appCommandMetadata
common commonEventObject
configCompleteRedirectUrl
  • chat.appCommandPayload.configCompleteRedirectUri
  • chat.addedToSpacePayload.configCompleteRedirectUri
  • chat.messagePayload.configCompleteRedirectUri
 इवेंट टाइप के हिसाब से, अलग-अलग पेलोड में उपलब्ध है.
dialogEventType
  • chat.appCommandPayload.dialogEventType
  • chat.buttonClickedPayload.dialogEventType
 इवेंट टाइप के हिसाब से, अलग-अलग पेलोड में उपलब्ध है.
eventTime chat.eventTime
isDialogEvent
  • chat.appCommandPayload.isDialogEvent
  • chat.buttonClickedPayload.isDialogEvent
 इवेंट टाइप के हिसाब से, अलग-अलग पेलोड में उपलब्ध है.
message
  • chat.messagePayload.message
  • chat.buttonClickedPayload.message
  • chat.appCommandPayload.message
 इवेंट टाइप के हिसाब से, अलग-अलग पेलोड में उपलब्ध है.
space
  • chat.messagePayload.space
  • chat.addedToSpacePayload.space
  • chat.removedFromSpacePayload.space
  • chat.buttonClickedPayload.space
  • chat.widgetUpdatedPayload.space
  • chat.appCommandPayload.space
thread
  • chat.messagePayload.message.thread
  • chat.buttonClickedPayload.message.thread
  • chat.appCommandPayload.message.thread
 इवेंट टाइप के हिसाब से, अलग-अलग पेलोड में उपलब्ध है.
threadKey
  • chat.messagePayload.message.thread.threadKey
  • chat.buttonClickedPayload.message.thread.threadKey
  • chat.appCommandPayload.message.threadKey
 इवेंट टाइप के हिसाब से, अलग-अलग पेलोड में उपलब्ध है.
token लागू नहीं पुष्टि करने की प्रोसेस अलग तरीके से की जाती है. इसके बारे में जानने के लिए, एचटीटीपी ऐप्लिकेशन के लिए पुष्टि का अनुरोध करना लेख पढ़ें.
type लागू नहीं इवेंट टाइप का पता ट्रिगर से लगाया जा सकता है.
user chat.user

इस्तेमाल के उदाहरण के हिसाब से मैपिंग का अनुरोध करना

यहां दी गई टेबल में, ऐड-ऑन के तौर पर उपलब्ध नहीं कराए गए चैट ऐप्लिकेशन और Google Chat की सुविधाओं को बढ़ाने वाले Google Workspace ऐड-ऑन के लिए, अनुरोध पेलोड के बीच के अंतर को दिखाया गया है. ये अंतर, इस्तेमाल के सामान्य उदाहरणों के लिए हैं.

इस्तेमाल का उदाहरण ऐसा Chat ऐप्लिकेशन जो ऐड-ऑन नहीं है (Event पेलोड) Google Workspace ऐड-ऑन EventObject पेलोड
ऐप्लिकेशन को स्पेस में जोड़ा गया 
{
  "type": "ADDED_TO_SPACE",
  "space": { ... }
}
 
{
  "chat": {
    "addedToSpacePayload": {
      "space": { ... }
    }
  }
}
स्पेस से ऐप्लिकेशन हटाएं 
{
  "type": "REMOVED_FROM_SPACE",
  "space": { ... }
}
 
{
  "chat": {
    "removedFromSpacePayload": {
      "space": { ... }
    }
  }
}
उपयोगकर्ता किसी ऐप्लिकेशन को @-टैग करता है 
{
  "type": "MESSAGE",
  "message": { ... },
  "space": { ... },
  "configCompleteRedirectUrl": "..."
}
 
{
  "chat": {
    "messagePayload": {
      "message": { ... },
      "space": { ... },
      "configCompleteRedirectUri": "..."
    }
  }
}
उपयोगकर्ता, स्पेस में ऐप्लिकेशन जोड़ने के लिए उसे @-टैग करता है आपको Google Chat से मिले इस अनुरोध को पूरा करना होगा:
{
  "type": "ADDED_TO_SPACE",
  "space": { ... },
  "message": { ... }
}
 आपको Google Chat से मिले दो अनुरोधों को पूरा करना होगा.

पहला अनुरोध:
{
  "chat": {
    "addedToSpacePayload": {
      "space": { ... },
      "interactionAdd": true
    }
  }
}

दूसरा अनुरोध:
{
  "chat": {
    "messagePayload": {
      "message": { ... },
      "space": { ... }
    }
  }
}
स्लैश कमांड 
{
  "type": "MESSAGE",
  "message": { "slashCommand": { ... } },
  "space": { ... }
}
 
{
  "chat": {
    "appCommandPayload": {
      "message": { ... },
      "space": { ... },
      "appCommandMetadata": { ... }
    }
  }
}
स्पेस में कोई ऐप्लिकेशन जोड़ने के लिए स्लैश कमांड आपको Google Chat से मिले इस अनुरोध को पूरा करना होगा:
{
  "type": "ADDED_TO_SPACE",
  "space": { ... },
  "message": { "slashCommand": { ... } }
}
 आपको Google Chat से मिले दो अनुरोधों को पूरा करना होगा.

पहला अनुरोध:
{
  "chat": {
    "addedToSpacePayload": {
      "space": { ... },
      "interactionAdd": true
    }
  }
}

दूसरा अनुरोध:
{
  "chat": {
    "appCommandPayload": {
      "message": { ... },
      "space": { ... },
      "appCommandMetadata": { ... }
    }
  }
}
उपयोगकर्ता, कार्ड या डायलॉग पर मौजूद किसी बटन पर क्लिक करता है 
{
  "type": "CARD_CLICKED",
  "common": { ... },
  "space": { ... },
  "message": { ... },
  "isDialogEvent": "...",
  "dialogEventType": "..."
}

डायलॉग इवेंट के लिए, common.formInputs में विजेट की वैल्यू शामिल होती हैं. Google Apps Script का उदाहरण:

{
  "type": "CARD_CLICKED",
  "common": {
   "formInputs": {
    "contactName": {
      "": { "stringInputs": { "value": ["Kai 0"] }}
    }
  }
  },
  "space": { ... },
  "message": { ... },
  "isDialogEvent": true,
  "dialogEventType": "..."
}
 
{
  "commonEventObject": { ... },
  "chat": {
    "buttonClickedPayload": {
      "message": { ... },
      "space": { ... },
      "isDialogEvent": "...",
      "dialogEventType": "..."
    }
  }
}

डायलॉग इवेंट के लिए, commonEventObject.formInputs में विजेट की वैल्यू शामिल होती हैं. Google Apps Script का उदाहरण:

{
  "commonEventObject": {
     "formInputs": {
      "contactName": {
        "stringInputs": {
          "value": ["Kai 0"]
        }
      }
    }
  },
  "chat": {
    "buttonClickedPayload": {
      "message": { ... },
      "space": { ... },
      "isDialogEvent": "true",
      "dialogEventType": "..."
    }
  }
}
उपयोगकर्ता, ऐप्लिकेशन के होम कार्ड में जानकारी सबमिट करता है 
{
  "type": "SUBMIT_FORM",
  "common": { ... },
  "space": { ... },
  "message": { ... },
  "isDialogEvent": "...",
  "dialogEventType": "..."
}
 
{
  "commonEventObject": { ... },
  "chat": {
    "buttonClickedPayload": {
      "message": { ... },
      "space": { ... },
      "isDialogEvent": "...",
      "dialogEventType": "SUBMIT_DIALOG"
    }
  }
}
उपयोगकर्ता, क्विक कमांड का इस्तेमाल करके ऐप्लिकेशन के कमांड को चालू करता है 
{
  "type": "APP_COMMAND",
  "space": { ... },
  "isDialogEvent": "...",
  "dialogEventType": "..."
}
 
{
  "chat": {
    "appCommandPayload": {
      "message": { ... },
      "space": { ... },
      "appCommandMetadata": { ... }
    }
  }
}
लिंक पूर्वावलोकन 
{
  "type": "MESSAGE",
  "message": {
    "matchedUrl": "..."
  },
  "space": { ... }
}
 
{
  "chat": {
    "messagePayload": {
      "message": {
        "matchedUrl": "..."
      },
      "space": { ... }
    }
  }
}
जब उपयोगकर्ता, कार्ड मैसेज या डायलॉग बॉक्स में मौजूद किसी विजेट को अपडेट करता है 
{
  "type": "WIDGET_UPDATED",
  "space": { ... },
  "common": { ... }
}
 
{
  "commonEventObject": { ... },
  "chat": {
    "widgetUpdatedPayload": {
      "space": { ... }
    }
  }
}

इस्तेमाल के उदाहरण के हिसाब से रिस्पॉन्स मैपिंग

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

इस्तेमाल का उदाहरण ऐसा Chat ऐप्लिकेशन जो ऐड-ऑन नहीं है (Message जवाब) Google Workspace ऐड-ऑन Chat ऐक्शन का जवाब
बुलाए गए स्पेस में मैसेज बनाना 
{
  "actionResponse": {
    "type": "NEW_MESSAGE"
  },
  "text": "..."
}

actionResponse ज़रूरी नहीं है. ज़्यादा जानने के लिए, स्लैश कमांड का जवाब देना लेख पढ़ें.

 
{
  "hostAppDataAction": {
    "chatDataAction": {
      "createMessageAction": {
        "message": {
          "text": "..."
         }
       }
    }
  }
}

ज़्यादा जानने के लिए, मैसेज से जवाब देना लेख पढ़ें.
किसी मैसेज को अपडेट करना 
{
 "actionResponse": {
  "type": "UPDATE_MESSAGE"
  },
 "text": "..."
}

ज़्यादा जानने के लिए, मैसेज अपडेट करना लेख पढ़ें.

 
{
  "hostAppDataAction": {
    "chatDataAction": {
      "updateMessageAction": {
        "message": {
          "text": "..."
         }
       }
    }
  }
}

ज़्यादा जानने के लिए, मैसेज अपडेट करना लेख पढ़ें.
लिंक पूर्वावलोकन 
{
  "actionResponse": {
    "type": "UPDATE_USER_MESSAGE_CARDS"
  },
  "cardsV2": [{ ... }]
}

ज़्यादा जानने के लिए, लिंक की झलक देखना लेख पढ़ें.

 
{
  "hostAppDataAction": {
    "chatDataAction": {
      "updateInlinePreviewAction": {
        "cardsV2": [{ ... }]
      }
    }
  }
}

ज़्यादा जानने के लिए, लिंक की झलक देखना लेख पढ़ें.
शुरुआती डायलॉग बॉक्स खोलना 
{
  "actionResponse": {
    "type": "DIALOG",
    "dialogAction": {
      "dialog": {
        "body": { /* Card object */ }
      }
    }
  }
}

ज़्यादा जानने के लिए, इंटरैक्टिव डायलॉग बॉक्स खोलना लेख पढ़ें.

 
{
  "action": {
    "navigations": [{
      "pushCard": { /* Card object */ }
     }]
   }
}
पुश किए गए कार्ड में, onClick कार्रवाइयों वाले विजेट शामिल हो सकते हैं. एचटीटीपी Google Workspace ऐड-ऑन के लिए, फ़ंक्शन एंडपॉइंट को कॉल करने के लिए इन कार्रवाइयों को कॉन्फ़िगर करें: 
{
  "onClick": {
    "action": {
      "function": "https://...",
      "parameters": [{
        "key": "clickedButton",
        "value": "submit"
      }]
    }
  }
}

ज़्यादा जानने के लिए, इंटरैक्टिव डायलॉग बॉक्स खोलना लेख पढ़ें.
डायलॉग बॉक्स बंद करना 
{
  "actionResponse": {
    "type": "DIALOG",
    "dialogAction": {
      "actionStatus": {
        "userFacingMessage": "..."
      }
    }
  }
}

ज़्यादा जानने के लिए, डायलॉग बॉक्स बंद करना लेख पढ़ें.

 
{
  "action": {
    "navigations": [{
      "endNavigation": "CLOSE_DIALOG"
    }],
    "notification": { "text": "..."}
  }
}

ज़्यादा जानने के लिए, डायलॉग बॉक्स बंद करना लेख पढ़ें.
किसी बाहरी सिस्टम से कनेक्ट करना (अनुरोध कॉन्फ़िगरेशन) 
{
  "actionResponse": {
    "type": "REQUEST_CONFIG",
    "url": "..."
  }
}

ज़्यादा जानने के लिए, किसी बाहरी सिस्टम से कनेक्ट करना (ऐसे Chat ऐप्लिकेशन जो ऐड-ऑन नहीं हैं) लेख पढ़ें.

 
{
  "basic_authorization_prompt": {
    "authorization_url": "...",
    "resource": "..."
  }
}

ज़्यादा जानने के लिए, Chat ऐप्लिकेशन को अन्य सेवाओं और टूल से कनेक्ट करना लेख पढ़ें.
इंटरैक्टिव विजेट पर ऑटोकंप्लीट वाले आइटम 
{
  "actionResponse": {
    "type": "UPDATE_WIDGET",
    "updatedWidget": {
      "suggestions": {
        "items": ["..."]
      },
      "widget": "widget_id"
    }
  }
}

ज़्यादा जानने के लिए, एक से ज़्यादा विकल्प चुनने वाला मेन्यू जोड़ना लेख पढ़ें.

 
{
  "action": {
    "modifyOperations": [{
      "updateWidget": {
        "widgetId": "widget_id",
        "selectionInputWidgetSuggestions": {
          "suggestions": ["..."]
        }
      }
    }]
  }
}

ज़्यादा जानने के लिए, कार्ड पर उपयोगकर्ताओं के डाले गए फ़ॉर्म डेटा को पढ़ना लेख पढ़ें.

कन्वर्ज़न से पहले बनाए गए मैसेज पर कार्ड इंटरैक्शन मैनेज करना

जब किसी ऐसे एचटीटीपी Chat ऐप्लिकेशन को Google Workspace ऐड-ऑन में बदला जाता है जो ऐड-ऑन नहीं है, तो कन्वर्ज़न से पहले बनाए गए मैसेज पर कार्ड इंटरैक्शन के लिए खास हैंडलिंग की ज़रूरत होती है. ऐड-ऑन, कार्ड के action.function के लिए पूरे एचटीटीपी यूआरएल का इस्तेमाल करते हैं. वहीं, ऐड-ऑन नहीं होने वाले Chat ऐप्लिकेशन, फ़ंक्शन के नाम का इस्तेमाल करते हैं. यहां दी गई टेबल में, इन अंतरों के बारे में खास जानकारी दी गई है.

ऐसा चैट ऐप्लिकेशन जो ऐड-ऑन नहीं है Google Workspace का ऐड-ऑन, जो Google Chat की सुविधाओं को बढ़ाता है
कॉन्फ़िगरेशन Google Cloud Console में, सभी इवेंट के लिए एक ही एंडपॉइंट कॉन्फ़िगर किया जाता है. कार्ड इंटरैक्शन लागू करते समय, कार्ड के action में सिर्फ़ उस फ़ंक्शन का नाम होता है जिसे लागू करना है. कार्ड क्लिक इवेंट के लिए, सामान्य एचटीटीपी एंडपॉइंट को कॉल किया जाता है.

ज़्यादा जानने के लिए, इंटरैक्टिव डायलॉग बॉक्स खोलना लेख पढ़ें.



{
  "onClick": {
    "action": {
      "function": "submit"
    }
  }
}
 Google Cloud Console में, हर इवेंट के लिए एंडपॉइंट कॉन्फ़िगर किए जा सकते हैं. हालांकि, इसमें कार्ड पर क्लिक करने से जुड़े इवेंट शामिल नहीं होते. कार्ड इंटरैक्शन लागू करते समय, कार्ड के action में, एचटीटीपी एंडपॉइंट का पूरा यूआरएल होना चाहिए, ताकि उसे चालू किया जा सके. हर बटन के लिए एक यूनीक एचटीटीपी एंडपॉइंट सेट किया जा सकता है. इसके अलावा, एक कॉमन एंडपॉइंट का इस्तेमाल करके, action.parameters में कार्रवाई को पैरामीटर के तौर पर पास किया जा सकता है.

ज़्यादा जानने के लिए, इंटरैक्टिव डायलॉग बॉक्स खोलना लेख पढ़ें.



{
  "onClick": {
    "action": {
      "function": "https://...",
      "parameters": [{
        "key": "method",
        "value": "submit"
      }]
    }
  }
}

यह पक्का करने के लिए कि कन्वर्ज़न से पहले बनाए गए मैसेज के लिए कार्ड इंटरैक्शन काम कर रहे हैं, Google Chat API के कॉन्फ़िगरेशन पेज पर कार्ड इंटरैक्शन यूआरएल कॉन्फ़िगर करें.

इस यूआरएल का इस्तेमाल सिर्फ़ उन मैसेज पर इंटरैक्शन के लिए किया जाता है जिन्हें आपने ऐप्लिकेशन को बदलने से पहले बनाया था. जब कोई उपयोगकर्ता इनमें से किसी मैसेज के साथ इंटरैक्ट करता है, तो ओरिजनल action.function वैल्यू को __action_method_name__ नाम के पैरामीटर के तौर पर पास किया जाता है.

उदाहरण: कार्ड पर क्लिक किया गया

अगर आपने कार्ड इंटरैक्शन यूआरएल को https://.../card-interaction-handler के तौर पर कॉन्फ़िगर किया है और कोई उपयोगकर्ता, पुराने मैसेज में मौजूद किसी कार्ड पर क्लिक करता है, तो ये कार्रवाइयां होंगी:

{
  "onClick": {
    "action": {
     "function": "submit"
    }
  }
}

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

{
  "commonEventObject": {
    "parameters": {
      "__action_method_name__": "submit"
    }
  },
  "chat": {
    "buttonClickedPayload": { ... }
  }
}

उदाहरण: एक से ज़्यादा विकल्प चुनने की सुविधा वाला मेन्यू

अगर कोई उपयोगकर्ता, बाहरी डेटा सोर्स वाले मल्टी-सिलेक्ट मेन्यू के साथ इंटरैक्ट करता है, तो:

{
  "selectionInput": {
    "name": "contacts",
    "type": "MULTI_SELECT",
    "externalDataSource": {
      "function": "getContacts"
    }
  }
}

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

{
  "commonEventObject": {
    "parameters": {
      "__action_method_name__": "getContacts",
    }
  },
  "chat": {
    "widgetUpdatedPayload": { ... }
  }
}

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

Chat की सुविधाओं को बढ़ाने वाले, Google Workspace के एचटीटीपी ऐड-ऑन के अनुरोधों की पुष्टि करना

HTTP पर आधारित Google Chat ऐप्लिकेशन को Google Workspace ऐड-ऑन में बदलते समय, यह पुष्टि करने के लॉजिक को अपडेट करना होगा कि अनुरोध Google से मिले हैं.

अनुरोध की पुष्टि करने के तरीके में ये मुख्य अंतर हैं:

ऐप का प्रकार टारगेट ऑडियंस सेवा खाते का ईमेल पता
ऐसा चैट ऐप्लिकेशन जो ऐड-ऑन नहीं है प्रोजेक्ट नंबर chat@system.gserviceaccount.com
Google Chat की सुविधाओं को बढ़ाने वाला Google Workspace ऐड-ऑन सिर्फ़ एचटीटीपी एंडपॉइंट हर प्रोजेक्ट के लिए सेवा खाते का ईमेल पता

Google Workspace ऐड-ऑन के लिए यूनीक सेवा खाते का ईमेल पता, Google Cloud Console में Google Chat API कॉन्फ़िगरेशन पेज पर Google Workspace ऐड-ऑन में बदलें सेक्शन में जाकर देखा जा सकता है.

अपग्रेड किए गए Google Workspace ऐड-ऑन में अनुरोधों की पुष्टि करने के लिए:

  1. Cloud Run फ़ंक्शन का इस्तेमाल करने पर, ऐड-ऑन के हिसाब से बनाए गए सेवा खाते को roles/cloudfunctions.invoker भूमिका असाइन करें. आईएएम की मदद से ऐक्सेस की अनुमति देना लेख पढ़ें.
  2. Google Workspace ऐड-ऑन सेवा खाते के ईमेल पते का इस्तेमाल करके, टोकन की पुष्टि करने के लिए कोड को अपडेट करें. इससे, Bearer टोकन के हस्ताक्षर की पुष्टि की जा सकेगी. Google से मिले अनुरोधों की पुष्टि करना लेख पढ़ें.