इस पेज पर, एचटीटीपी सेवा का इस्तेमाल करके, Google Workspace का ऐसा ऐड-ऑन बनाने का तरीका बताया गया है जो Google Chat में काम करता है.
इस क्विकस्टार्ट में, Google Cloud सेवाओं का इस्तेमाल करके एचटीटीपी सेवा बनाने का तरीका बताया गया है. Chat ऐप्लिकेशन बनाने के लिए, आपको Cloud Run फ़ंक्शन लिखना और डिप्लॉय करना होगा. Chat ऐप्लिकेशन, इस फ़ंक्शन का इस्तेमाल करके उपयोगकर्ता के मैसेज का जवाब देता है.
एचटीटीपी आर्किटेक्चर की मदद से, Chat को Google Cloud या किसी ऑन-प्रिमाइसेस सर्वर के साथ इंटिग्रेट करने के लिए, एचटीटीपी का इस्तेमाल किया जाता है. इसे इस डायग्राम में दिखाया गया है:
ऊपर दिए गए डायग्राम में, एचटीटीपी चैट ऐप्लिकेशन का इस्तेमाल करने वाले व्यक्ति के लिए, जानकारी का फ़्लो इस तरह होता है:
- कोई उपयोगकर्ता, Chat ऐप्लिकेशन को Chat में मैसेज भेजता है. यह मैसेज, डायरेक्ट मैसेज या Chat स्पेस में भेजा जाता है.
- एचटीटीपी अनुरोध, वेब सर्वर को भेजा जाता है. यह वेब सर्वर, क्लाउड या ऑन-प्रिमाइसेस सिस्टम होता है. इसमें Chat ऐप्लिकेशन का लॉजिक होता है.
- Chat ऐप्लिकेशन के लॉजिक को Google Workspace की सेवाओं (जैसे, Calendar और Sheets), Google की अन्य सेवाओं (जैसे, Maps, YouTube, और Vertex AI) या अन्य वेब सेवाओं (जैसे, प्रोजेक्ट मैनेजमेंट सिस्टम या टिकट सिस्टम) के साथ इंटिग्रेट किया जा सकता है. हालांकि, ऐसा करना ज़रूरी नहीं है.
- वेब सर्वर, Chat ऐप्लिकेशन की सेवा को एचटीटीपी रिस्पॉन्स वापस भेजता है.
- जवाब, उपयोगकर्ता को भेजा जाता है.
- Chat ऐप्लिकेशन, Chat API को कॉल करके मैसेज पोस्ट कर सकता है या अन्य कार्रवाइयाँ कर सकता है. हालाँकि, ऐसा करना ज़रूरी नहीं है.
इस आर्किटेक्चर की मदद से, सिस्टम में पहले से मौजूद लाइब्रेरी और कॉम्पोनेंट का इस्तेमाल किया जा सकता है. ऐसा इसलिए, क्योंकि इन चैट ऐप्लिकेशन को अलग-अलग प्रोग्रामिंग भाषाओं का इस्तेमाल करके डिज़ाइन किया जा सकता है.
मकसद
- अपना एनवायरमेंट सेट अप करें.
- Cloud Run फ़ंक्शन बनाएं और उसे डिप्लॉय करें.
- Chat ऐप्लिकेशन के लिए, Google Workspace ऐड-ऑन कॉन्फ़िगर करें.
- ऐप्लिकेशन को टेस्ट करें.
ज़रूरी शर्तें
- आपके पास Business या Enterprise वर्शन वाला Google Workspace खाता होना चाहिए. साथ ही, आपके पास Google Chat को ऐक्सेस करने की अनुमति होनी चाहिए.
- बिलिंग की सुविधा वाला Google Cloud प्रोजेक्ट. यह देखने के लिए कि किसी मौजूदा प्रोजेक्ट के लिए बिलिंग की सुविधा चालू है या नहीं, अपने प्रोजेक्ट के बिलिंग स्टेटस की पुष्टि करें लेख पढ़ें. प्रोजेक्ट बनाने और बिलिंग सेट अप करने के लिए, Google Cloud प्रोजेक्ट बनाना लेख पढ़ें.
एनवायरमेंट सेट अप करना
Google API का इस्तेमाल करने से पहले, आपको उन्हें Google Cloud प्रोजेक्ट में चालू करना होगा. एक ही Google Cloud प्रोजेक्ट में, एक या उससे ज़्यादा एपीआई चालू किए जा सकते हैं.Google Cloud console में, Cloud Build API, Cloud Functions API, Cloud Pub/Sub API, Cloud Logging API, Artifact Registry API, और Cloud Run API चालू करें.
Cloud Run फ़ंक्शन बनाना और उसे डिप्लॉय करना
Cloud Run फ़ंक्शन बनाएं और उसे डिप्लॉय करें. यह फ़ंक्शन, मैसेज भेजने वाले व्यक्ति के डिसप्ले नेम और अवतार इमेज के साथ Chat कार्ड जनरेट करता है. जब Chat ऐप्लिकेशन को कोई मैसेज मिलता है, तो वह फ़ंक्शन को चालू करता है और कार्ड के साथ जवाब देता है.
Chat ऐप्लिकेशन के लिए फ़ंक्शन बनाने और उसे डिप्लॉय करने के लिए, यह तरीका अपनाएं:
Node.js
Google Cloud Console में, Cloud Run पेज पर जाएं:
पक्का करें कि आपने Chat ऐप्लिकेशन के लिए प्रोजेक्ट चुना हो.
फ़ंक्शन लिखें पर क्लिक करें.
सेवा बनाएं पेज पर जाकर, अपना फ़ंक्शन सेट अप करें:
- सेवा का नाम फ़ील्ड में,
addonchatapp
डालें. - देश/इलाका सूची में जाकर, कोई देश/इलाका चुनें.
- रनटाइम सूची में, Node.js का सबसे नया वर्शन चुनें.
- पुष्टि करें सेक्शन में जाकर, पुष्टि करना ज़रूरी है को चुनें.
- बनाएं पर क्लिक करें. इसके बाद, Cloud Run को सेवा बनाने दें. कंसोल आपको सोर्स टैब पर रीडायरेक्ट करता है.
- सेवा का नाम फ़ील्ड में,
सोर्स टैब में जाकर:
- एंट्री पॉइंट में, डिफ़ॉल्ट टेक्स्ट मिटाएं और
avatarApp
डालें. index.js
के कॉन्टेंट की जगह यह कोड डालें:
/** * Google Cloud Run function that responds to messages sent from a * Google Chat space. * * @param {Object} req Request sent from Google Chat space * @param {Object} res Response to send back */ import { http } from '@google-cloud/functions-framework'; http('avatarApp', (req, res) => { if (req.method === 'GET' || !req.body.chat) { return res.send('Hello! This function is meant to be used ' + 'in a Google Chat Space.'); } // Stores the Google Chat event as a variable. const chatMessage = req.body.chat.messagePayload.message; // Replies with the sender's avatar in a card. const displayName = chatMessage.sender.displayName; const avatarUrl = chatMessage.sender.avatarUrl; res.send({ hostAppDataAction: { chatDataAction: { createMessageAction: { message: { text: 'Here\'s your avatar', cardsV2: [{ cardId: 'avatarCard', card: { name: 'Avatar Card', header: { title: `Hello ${displayName}!`, }, sections: [{ widgets: [{ textParagraph: { text: 'Your avatar picture: ' } }, { image: { imageUrl: avatarUrl } }] }] } }] }}}}}); });
package.json
के कॉन्टेंट की जगह यह कोड डालें:
{ "name": "avatar-app", "version": "1.0.0", "description": "Google Chat Avatar App", "main": "index.js", "type": "module", "scripts": { "start": "node index.js" }, "dependencies": { "@google-cloud/functions-framework": "^3.0.0" } }
- सेव करें और फिर से डिप्लॉय करें पर क्लिक करें.
- एंट्री पॉइंट में, डिफ़ॉल्ट टेक्स्ट मिटाएं और
Python
Google Cloud Console में, Cloud Run पेज पर जाएं:
पक्का करें कि आपने Chat ऐप्लिकेशन के लिए प्रोजेक्ट चुना हो.
फ़ंक्शन लिखें पर क्लिक करें.
सेवा बनाएं पेज पर जाकर, अपना फ़ंक्शन सेट अप करें:
- सेवा का नाम फ़ील्ड में,
addonchatapp
डालें. - देश/इलाका सूची में जाकर, कोई देश/इलाका चुनें.
- रनटाइम सूची में, Python का सबसे नया वर्शन चुनें.
- पुष्टि करें सेक्शन में जाकर, पुष्टि करना ज़रूरी है को चुनें.
- बनाएं पर क्लिक करें. इसके बाद, Cloud Run को सेवा बनाने दें. कंसोल आपको सोर्स टैब पर रीडायरेक्ट करता है.
- सेवा का नाम फ़ील्ड में,
सोर्स टैब में जाकर:
- एंट्री पॉइंट में, डिफ़ॉल्ट टेक्स्ट मिटाएं और
avatar_app
डालें. main.py
के कॉन्टेंट की जगह यह कोड डालें:
from typing import Any, Mapping import flask import functions_framework @functions_framework.http def avatar_app(req: flask.Request) -> Mapping[str, Any]: """Google Cloud Run Function that handles requests from Google Chat Args: flask.Request: the request Returns: Mapping[str, Any]: the response """ if req.method == "GET": return "Hello! This function must be called from Google Chat." request_json = req.get_json(silent=True) # Stores the Google Chat event as a variable. chat_message = request_json["chat"]["messagePayload"]["message"] # Replies with the sender's avatar in a card. display_name = chat_message["sender"]["displayName"] avatar_url = chat_message["sender"]["avatarUrl"] return { "hostAppDataAction": { "chatDataAction": { "createMessageAction": { "message": { "text": "Here's your avatar", "cardsV2": [{ "cardId": "avatarCard", "card": { "name": "Avatar Card", "header": { "title": f"Hello {display_name}!" }, "sections": [{ "widgets": [{ "textParagraph": { "text": "Your avatar picture:" } }, { "image": { "imageUrl": avatar_url } }] }] } }] }}}}}
- सेव करें और फिर से डिप्लॉय करें पर क्लिक करें.
- एंट्री पॉइंट में, डिफ़ॉल्ट टेक्स्ट मिटाएं और
Java
Google Cloud Console में, Cloud Run पेज पर जाएं:
पक्का करें कि आपने Chat ऐप्लिकेशन के लिए प्रोजेक्ट चुना हो.
फ़ंक्शन लिखें पर क्लिक करें.
सेवा बनाएं पेज पर जाकर, अपना फ़ंक्शन सेट अप करें:
- सेवा का नाम फ़ील्ड में,
addonchatapp
डालें. - देश/इलाका सूची में जाकर, कोई देश/इलाका चुनें.
- रनटाइम सूची में, Java का सबसे नया वर्शन चुनें.
- पुष्टि करें सेक्शन में जाकर, पुष्टि करना ज़रूरी है को चुनें.
- बनाएं पर क्लिक करें. इसके बाद, Cloud Run को सेवा बनाने दें. कंसोल आपको सोर्स टैब पर रीडायरेक्ट करता है.
- सेवा का नाम फ़ील्ड में,
सोर्स टैब में जाकर:
- एंट्री पॉइंट में, डिफ़ॉल्ट टेक्स्ट मिटाएं और
AvatarApp
डालें. - डिफ़ॉल्ट Java फ़ाइल का नाम बदलकर
src/main/java/gcfv2/AvatarApp.java
करें. AvatarApp.java
के कॉन्टेंट की जगह यह कोड डालें:
import java.util.List; import com.google.api.services.chat.v1.model.CardWithId; import com.google.api.services.chat.v1.model.GoogleAppsCardV1Card; import com.google.api.services.chat.v1.model.GoogleAppsCardV1CardHeader; import com.google.api.services.chat.v1.model.GoogleAppsCardV1Image; import com.google.api.services.chat.v1.model.GoogleAppsCardV1Section; import com.google.api.services.chat.v1.model.GoogleAppsCardV1TextParagraph; import com.google.api.services.chat.v1.model.GoogleAppsCardV1Widget; import com.google.api.services.chat.v1.model.Message; import com.google.cloud.functions.HttpFunction; import com.google.cloud.functions.HttpRequest; import com.google.cloud.functions.HttpResponse; import com.google.gson.Gson; import com.google.gson.JsonObject; public class AvatarApp implements HttpFunction { private static final Gson gson = new Gson(); @Override public void service(HttpRequest request, HttpResponse response) throws Exception { JsonObject body = gson.fromJson(request.getReader(), JsonObject.class); if (request.getMethod().equals("GET") || !body.has("chat")) { response.getWriter().write("Hello! This function is meant to be used " + "in a Google Chat Space.."); return; } // Stores the Google Chat event as a variable. JsonObject chatMessage = body.getAsJsonObject("chat") .getAsJsonObject("messagePayload").getAsJsonObject("message"); // Replies with the sender's avatar in a card. String displayName = chatMessage.getAsJsonObject("sender").get("displayName").getAsString(); String avatarUrl = chatMessage.getAsJsonObject("sender").get("avatarUrl").getAsString(); Message message = createMessage(displayName, avatarUrl); JsonObject createMessageAction = new JsonObject(); createMessageAction.add("message", gson.fromJson(gson.toJson(message), JsonObject.class)); JsonObject chatDataAction = new JsonObject(); chatDataAction.add("createMessageAction", createMessageAction); JsonObject hostAppDataAction = new JsonObject(); hostAppDataAction.add("chatDataAction", chatDataAction); JsonObject dataActions = new JsonObject(); dataActions.add("hostAppDataAction", hostAppDataAction); response.getWriter().write(gson.toJson(dataActions)); } Message createMessage(String displayName, String avatarUrl) { GoogleAppsCardV1CardHeader cardHeader = new GoogleAppsCardV1CardHeader(); cardHeader.setTitle(String.format("Hello %s!", displayName)); GoogleAppsCardV1TextParagraph textParagraph = new GoogleAppsCardV1TextParagraph(); textParagraph.setText("Your avatar picture: "); GoogleAppsCardV1Widget avatarWidget = new GoogleAppsCardV1Widget(); avatarWidget.setTextParagraph(textParagraph); GoogleAppsCardV1Image image = new GoogleAppsCardV1Image(); image.setImageUrl(avatarUrl); GoogleAppsCardV1Widget avatarImageWidget = new GoogleAppsCardV1Widget(); avatarImageWidget.setImage(image); GoogleAppsCardV1Section section = new GoogleAppsCardV1Section(); section.setWidgets(List.of(avatarWidget, avatarImageWidget)); GoogleAppsCardV1Card card = new GoogleAppsCardV1Card(); card.setName("Avatar Card"); card.setHeader(cardHeader); card.setSections(List.of(section)); CardWithId cardWithId = new CardWithId(); cardWithId.setCardId("avatarCard"); cardWithId.setCard(card); Message message = new Message(); message.setText("Here's your avatar"); message.setCardsV2(List.of(cardWithId)); return message; } }
- एंट्री पॉइंट में, डिफ़ॉल्ट टेक्स्ट मिटाएं और
pom.xml
के कॉन्टेंट की जगह यह कोड डालें:<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.google.chat</groupId> <artifactId>avatar-app</artifactId> <version>1.0-SNAPSHOT</version> <properties> <maven.compiler.target>17</maven.compiler.target> <maven.compiler.source>17</maven.compiler.source> </properties> <dependencies> <dependency> <groupId>com.google.cloud.functions</groupId> <artifactId>functions-framework-api</artifactId> <version>1.0.4</version> </dependency> <!-- https://mvnrepository.com/artifact/com.google.code.gson/gson --> <dependency> <groupId>com.google.code.gson</groupId> <artifactId>gson</artifactId> <version>2.9.1</version> </dependency> <!-- https://mvnrepository.com/artifact/com.google.apis/google-api-services-chat --> <dependency> <groupId>com.google.apis</groupId> <artifactId>google-api-services-chat</artifactId> <version>v1-rev20230115-2.0.0</version> </dependency> </dependencies> <!-- Required for Java functions in the inline editor --> <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-compiler-plugin</artifactId> <version>3.8.1</version> <configuration> <excludes> <exclude>.google/</exclude> </excludes> </configuration> </plugin> </plugins> </build> </project>
- सेव करें और फिर से डिप्लॉय करें पर क्लिक करें.
इससे Cloud Run सेवा की जानकारी वाला पेज खुलता है. फ़ंक्शन के डिप्लॉय होने का इंतज़ार करें.
ऐड-ऑन कॉन्फ़िगर करना
Cloud Run फ़ंक्शन को डिप्लॉय करने के बाद, ऐड-ऑन बनाने और Google Chat ऐप्लिकेशन को डिप्लॉय करने के लिए, यह तरीका अपनाएं:
Google Cloud Console में, Cloud Run पेज पर जाएं:
पक्का करें कि आपने Cloud Run को जिस प्रोजेक्ट के लिए चालू किया है वह चुना गया हो.
फ़ंक्शन की सूची में, addonchatapp पर क्लिक करें.
सेवा की जानकारी पेज पर, फ़ंक्शन का यूआरएल कॉपी करें. यूआरएल
run.app
पर खत्म होता है.Google Cloud के खोज फ़ील्ड में, "Google Chat API" खोजें. इसके बाद, Google Chat API पर क्लिक करें और फिर मैनेज करें पर क्लिक करें.
कॉन्फ़िगरेशन पर क्लिक करें और Google Chat ऐप्लिकेशन सेट अप करें:
- ऐप्लिकेशन का नाम में,
Add-on Chat app
डालें. - अवतार यूआरएल में,
https://developers.google.com/workspace/add-ons/images/quickstart-app-avatar.png
डालें. - ब्यौरा में,
Add-on Chat app
डालें. - सुविधाएं में जाकर, स्पेस और ग्रुप बातचीत में शामिल हों को चुनें.
- कनेक्शन सेटिंग में जाकर, एचटीटीपी एंडपॉइंट यूआरएल चुनें.
- सेवा खाते का ईमेल पता कॉपी करें. आपको इस ईमेल की ज़रूरत तब पड़ती है, जब आपको अपने ऐड-ऑन को फ़ंक्शन शुरू करने की अनुमति देनी होती है.
- ट्रिगर में जाकर, सभी ट्रिगर के लिए एक सामान्य एचटीटीपी एंडपॉइंट यूआरएल का इस्तेमाल करें को चुनें. इसके बाद, Cloud Run फ़ंक्शन ट्रिगर के लिए यूआरएल को बॉक्स में चिपकाएं.
- दिखने की सेटिंग में जाकर, इस Google Chat ऐप्लिकेशन को अपने डोमेन के कुछ लोगों और ग्रुप के लिए उपलब्ध कराएं को चुनें. इसके बाद, अपना ईमेल पता डालें.
- लॉग में जाकर, लॉगिंग में गड़बड़ियों को लॉग करें चुनें.
- ऐप्लिकेशन का नाम में,
सेव करें पर क्लिक करें.
इसके बाद, Chat ऐप्लिकेशन को Cloud Run फ़ंक्शन शुरू करने की अनुमति दें.
Google Chat को आपके फ़ंक्शन को शुरू करने की अनुमति देना
Google Workspace ऐड-ऑन को आपके फ़ंक्शन को चालू करने की अनुमति देने के लिए, Google Workspace ऐड-ऑन सेवा खाते को Cloud Run Service Invoker की भूमिका असाइन करें.
Google Cloud Console में, Cloud Run पेज पर जाएं:
Cloud Run सेवाओं की सूची में, डेटा पाने वाले फ़ंक्शन के बगल में मौजूद चेकबॉक्स को चुनें. (फ़ंक्शन पर क्लिक न करें.)
अनुमतियां पर क्लिक करें. अनुमतियां पैनल खुलता है.
प्रिंसिपल जोड़ें पर क्लिक करें.
नए मुख्य खातों में, Google Workspace ऐड-ऑन के उस सेवा खाते का ईमेल पता डालें जो आपके Chat ऐप्लिकेशन से जुड़ा है.
सेवा खाते का ईमेल पता, Chat API के कॉन्फ़िगरेशन पेज पर मौजूद होता है. इसके लिए, कनेक्शन सेटिंग > एचटीटीपी एंडपॉइंट यूआरएल > सेवा खाते का ईमेल पर जाएं:
भूमिका चुनें में जाकर, Cloud Run > Cloud Run Service Invoker को चुनें.
सेव करें पर क्लिक करें.
Chat ऐप्लिकेशन, Chat पर मैसेज पाने और उनका जवाब देने के लिए तैयार है.
Chat ऐप्लिकेशन को टेस्ट करना
Chat ऐप्लिकेशन को आज़माने के लिए, Chat ऐप्लिकेशन में डायरेक्ट मैसेज स्पेस खोलें और कोई मैसेज भेजें:
Google Workspace खाते का इस्तेमाल करके Google Chat खोलें. आपने इसी खाते से, भरोसेमंद टेस्टर के तौर पर खुद को जोड़ा था.
- नई चैट पर क्लिक करें.
- एक या उससे ज़्यादा लोगों को जोड़ें फ़ील्ड में, अपने Chat ऐप्लिकेशन का नाम डालें.
नतीजों में से अपना Chat ऐप्लिकेशन चुनें. एक डायरेक्ट मैसेज खुलता है.
- ऐप्लिकेशन को भेजे गए नए डायरेक्ट मैसेज में,
Hello
टाइप करें औरenter
दबाएं.
Chat ऐप्लिकेशन के मैसेज में एक कार्ड होता है. इसमें मैसेज भेजने वाले व्यक्ति का नाम और अवतार इमेज दिखती है. इसे इस इमेज में दिखाया गया है:
भरोसेमंद टेस्टर जोड़ने और इंटरैक्टिव सुविधाओं की टेस्टिंग के बारे में ज़्यादा जानने के लिए, Google Chat ऐप्लिकेशन के लिए इंटरैक्टिव सुविधाओं की टेस्टिंग करना लेख पढ़ें.
समस्या हल करें
जब कोई Google Chat ऐप्लिकेशन या कार्ड कोई गड़बड़ी दिखाता है, तो Chat इंटरफ़ेस पर एक मैसेज दिखता है. इसमें लिखा होता है कि "कोई गड़बड़ी हुई." या "आपका अनुरोध प्रोसेस नहीं किया जा सका." कभी-कभी Chat के यूज़र इंटरफ़ेस (यूआई) में कोई गड़बड़ी का मैसेज नहीं दिखता है, लेकिन Chat ऐप्लिकेशन या कार्ड से कोई अनचाहा नतीजा मिलता है. उदाहरण के लिए, ऐसा हो सकता है कि कार्ड मैसेज न दिखे.
ऐसा हो सकता है कि Chat के यूज़र इंटरफ़ेस (यूआई) में गड़बड़ी का मैसेज न दिखे. हालांकि, Chat ऐप्लिकेशन के लिए गड़बड़ी के लॉगिंग की सुविधा चालू होने पर, गड़बड़ियों को ठीक करने में आपकी मदद करने के लिए, गड़बड़ी के बारे में जानकारी देने वाले मैसेज और लॉग डेटा उपलब्ध होता है. गड़बड़ियों को देखने, डीबग करने, और ठीक करने के बारे में मदद पाने के लिए, Google Chat से जुड़ी गड़बड़ियों को ठीक करना लेख पढ़ें.
व्यवस्थित करें
इस ट्यूटोरियल में इस्तेमाल किए गए संसाधनों के लिए, अपने Google Cloud खाते से शुल्क न लिए जाने से बचने के लिए, हमारा सुझाव है कि आप Cloud प्रोजेक्ट मिटा दें.
- Google Cloud Console में, संसाधन मैनेज करें पेज पर जाएं. मेन्यू > IAM और एडमिन > संसाधन मैनेज करें पर क्लिक करें.
- प्रोजेक्ट की सूची में, वह प्रोजेक्ट चुनें जिसे आपको मिटाना है. इसके बाद, मिटाएं पर क्लिक करें.
- डायलॉग बॉक्स में, प्रोजेक्ट आईडी टाइप करें. इसके बाद, प्रोजेक्ट मिटाने के लिए बंद करें पर क्लिक करें.