Cloud Functions की मदद से, एचटीटीपी Google Chat ऐप्लिकेशन बनाना

इस पेज पर एचटीटीपी चैट ऐप्लिकेशन बनाने का तरीका बताया गया है. इस आर्किटेक्चर को लागू करने के कई तरीके हैं. Google Cloud पर, Cloud Functions, Cloud Run, और App Engine का इस्तेमाल किया जा सकता है. इस क्विकस्टार्ट में, एक ऐसा क्लाउड फ़ंक्शन लिखा और डिप्लॉय किया जा सकता है जिसका इस्तेमाल, Chat ऐप्लिकेशन किसी उपयोगकर्ता के मैसेज का जवाब देने के लिए करता है.

इस आर्किटेक्चर से, एचटीटीपी का इस्तेमाल करके Chat को Google Cloud या कंपनी की इमारत में बने सर्वर के साथ इंटिग्रेट करने के लिए कॉन्फ़िगर किया जा सकता है, जैसा कि यहां दिए गए डायग्राम में दिखाया गया है:

कंपनी की इमारत में मौजूद सर्वर पर, वेब सेवा का इस्तेमाल करने वाले Chat ऐप्लिकेशन का आर्किटेक्चर.

पिछले डायग्राम में, एचटीटीपी चैट ऐप्लिकेशन से इंटरैक्ट करने वाले उपयोगकर्ता के पास जानकारी का यह फ़्लो है:

  1. उपयोगकर्ता, Chat ऐप्लिकेशन को डायरेक्ट मैसेज या चैट स्पेस में मैसेज भेजता है.
  2. एचटीटीपी अनुरोध ऐसे वेब सर्वर पर भेजा जाता है जो क्लाउड या कंपनी की इमारत में मौजूद सिस्टम हो सकता है. इस सिस्टम में Chat ऐप्लिकेशन लॉजिक शामिल होता है.
  3. इसके अलावा, Chat ऐप्लिकेशन लॉजिक को Google Workspace की सेवाओं (जैसे, Calendar और Sheets), Google की अन्य सेवाओं, जैसे कि Maps, YouTube, और Vertex AI के साथ इंटिग्रेट किया जा सकता है. इसके अलावा, प्रोजेक्ट मैनेजमेंट सिस्टम या टिकट बेचने वाले टूल जैसी अन्य वेब सेवाओं के साथ भी इंटिग्रेट किया जा सकता है.
  4. वेब सर्वर, Chat में मौजूद Chat ऐप्लिकेशन सेवा को वापस एचटीटीपी रिस्पॉन्स भेजता है.
  5. उपयोगकर्ता को जवाब दे दिया जाता है.
  6. इसके अलावा, Chat ऐप्लिकेशन, Chat API को कॉल करके, एसिंक्रोनस तरीके से मैसेज पोस्ट कर सकता है या दूसरे काम कर सकता है.

इस आर्किटेक्चर से आपको अपने सिस्टम में पहले से मौजूद लाइब्रेरी और कॉम्पोनेंट का इस्तेमाल करने की सुविधा मिलती है, क्योंकि इन चैट ऐप्लिकेशन को अलग-अलग प्रोग्रामिंग भाषाओं का इस्तेमाल करके डिज़ाइन किया जा सकता है.

मकसद

  • अपना एनवायरमेंट सेट अप करें.
  • Cloud फ़ंक्शन बनाना और डिप्लॉय करना.
  • Chat में ऐप्लिकेशन पब्लिश करें.
  • ऐप्लिकेशन को टेस्ट करें.

ज़रूरी शर्तें

  • ऐसा Google Workspace खाता जिसके पास Google Workspace का इस्तेमाल करने वाले किसी ऐसे संगठन में Google Chat का ऐक्सेस हो जिसकी पुष्टि न हुई हो और Google Cloud फ़ंक्शन को शुरू करने की अनुमति दी गई हो.

एनवायरमेंट सेट अप करना

Google API का इस्तेमाल करने से पहले, आपको उन्हें Google Cloud प्रोजेक्ट में चालू करना होगा. किसी एक Google Cloud प्रोजेक्ट में, एक या उससे ज़्यादा एपीआई चालू किए जा सकते हैं.
  • Google Cloud Console में, Google Chat API, Cloud Build API, Cloud Functions API, Cloud Pub/Sub API, Cloud Logging API, Artifact Registry API, और Cloud Run API जैसी सुविधाएं चालू करें.

    एपीआई चालू करना

क्लाउड फ़ंक्शन बनाना और डिप्लॉय करना

ऐसा क्लाउड फ़ंक्शन बनाएं और डिप्लॉय करें जो भेजने वाले के डिसप्ले नेम और अवतार इमेज के साथ चैट कार्ड जनरेट करता हो. जब Chat ऐप्लिकेशन को मैसेज मिलता है, तो वह फ़ंक्शन चलाता है और कार्ड से जवाब देता है.

अपने Chat ऐप्लिकेशन के लिए फ़ंक्शन बनाने और डिप्लॉय करने के लिए, यह तरीका अपनाएं:

Node.js

  1. Google Cloud Console में, Cloud Functions पेज पर जाएं:

    Cloud Functions पर जाएं

    पक्का करें कि आपके Chat ऐप्लिकेशन का प्रोजेक्ट चुना गया हो.

  2. फ़ंक्शन बनाएं पर क्लिक करें.

  3. 'फ़ंक्शन बनाएं' पेज पर, अपना फ़ंक्शन सेट अप करें:

    1. एनवायरमेंट में, 2nd gen चुनें.
    2. फ़ंक्शन का नाम में, QuickStartChatApp डालें.
    3. क्षेत्र में, कोई इलाका चुनें.
    4. 'पुष्टि करना' में जाकर, उन बातचीत को अनुमति दें जिनकी पुष्टि नहीं की गई है को चुनें.
    5. आगे बढ़ें पर क्लिक करें.
  4. रनटाइम में, Node.js 20 चुनें.

  5. सोर्स कोड में, इनलाइन एडिटर चुनें.

  6. एंट्री पॉइंट में, डिफ़ॉल्ट टेक्स्ट मिटाएं और helloChat डालें.

  7. index.js के कॉन्टेंट को नीचे दिए गए कोड से बदलें:

    node/avatar-app/index.js
    /**
     * Google Cloud Function that responds to messages sent from a
     * Google Chat room.
     *
     * @param {Object} req Request sent from Google Chat room
     * @param {Object} res Response to send back
     */
    exports.helloChat = function helloChat(req, res) {
      if (req.method === 'GET' || !req.body.message) {
        res.send('Hello! This function is meant to be used in a Google Chat ' +
          'Room.');
      }
    
      const sender = req.body.message.sender.displayName;
      const image = req.body.message.sender.avatarUrl;
    
      const data = createMessage(sender, image);
    
      res.send(data);
    };
    
    /**
     * Creates a card with two widgets.
     * @param {string} displayName the sender's display name
     * @param {string} imageUrl the URL for the sender's avatar
     * @return {Object} a card with the user's avatar.
     */
    function createMessage(displayName, imageUrl) {
      const cardHeader = {
        title: `Hello ${displayName}!`,
      };
    
      const avatarWidget = {
        textParagraph: {text: 'Your avatar picture: '},
      };
    
      const avatarImageWidget = {
        image: {imageUrl},
      };
    
      const avatarSection = {
        widgets: [
          avatarWidget,
          avatarImageWidget,
        ],
      };
    
      return {
        text: 'Here\'s your avatar',
        cardsV2: [{
          cardId: 'avatarCard',
          card: {
            name: 'Avatar Card',
            header: cardHeader,
            sections: [avatarSection],
          }
        }],
      };
    }

  8. डिप्लॉय करें पर क्लिक करें.

Python

  1. Google Cloud Console में, Cloud Functions पेज पर जाएं:

    Cloud Functions पर जाएं

    पक्का करें कि आपके Chat ऐप्लिकेशन का प्रोजेक्ट चुना गया हो.

  2. फ़ंक्शन बनाएं पर क्लिक करें.

  3. 'फ़ंक्शन बनाएं' पेज पर, अपना फ़ंक्शन सेट अप करें:

    1. फ़ंक्शन का नाम में, QuickStartChatApp डालें.
    2. ट्रिगर टाइप में, एचटीटीपी चुनें.
    3. 'पुष्टि करना' में जाकर, उन बातचीत को अनुमति दें जिनकी पुष्टि नहीं की गई है को चुनें.
    4. सेव करें पर क्लिक करें.
    5. आगे बढ़ें पर क्लिक करें.
  4. रनटाइम में, Python 3.10 चुनें.

  5. सोर्स कोड में, इनलाइन एडिटर चुनें.

  6. एंट्री पॉइंट में, डिफ़ॉल्ट टेक्स्ट मिटाएं और hello_chat डालें.

  7. main.py के कॉन्टेंट को नीचे दिए गए कोड से बदलें:

    python/avatar-app/main.py
    from typing import Any, Mapping
    
    import flask
    import functions_framework
    
    
    # Google Cloud Function that responds to messages sent in
    # Google Chat.
    #
    # @param {Object} req Request sent from Google Chat.
    # @param {Object} res Response to send back.
    @functions_framework.http
    def hello_chat(req: flask.Request) -> Mapping[str, Any]:
      if req.method == "GET":
        return "Hello! This function must be called from Google Chat."
    
      request_json = req.get_json(silent=True)
    
      display_name = request_json["message"]["sender"]["displayName"]
      avatar = request_json["message"]["sender"]["avatarUrl"]
    
      response = create_message(name=display_name, image_url=avatar)
    
      return response
    
    
    # Creates a card with two widgets.
    # @param {string} name the sender's display name.
    # @param {string} image_url the URL for the sender's avatar.
    # @return {Object} a card with the user's avatar.
    def create_message(name: str, image_url: str) -> Mapping[str, Any]:
      avatar_image_widget = {"image": {"imageUrl": image_url}}
      avatar_text_widget = {"textParagraph": {"text": "Your avatar picture:"}}
      avatar_section = {"widgets": [avatar_text_widget, avatar_image_widget]}
    
      header = {"title": f"Hello {name}!"}
    
      cards = {
          "text": "Here's your avatar",
          "cardsV2": [
              {
                  "cardId": "avatarCard",
                  "card": {
                      "name": "Avatar Card",
                      "header": header,
                      "sections": [avatar_section],
                  },
              }
          ]
      }
    
      return cards

  8. डिप्लॉय करें पर क्लिक करें.

Java

  1. Google Cloud Console में, Cloud Functions पेज पर जाएं:

    Cloud Functions पर जाएं

    पक्का करें कि आपके Chat ऐप्लिकेशन का प्रोजेक्ट चुना गया हो.

  2. फ़ंक्शन बनाएं पर क्लिक करें.

  3. 'फ़ंक्शन बनाएं' पेज पर, अपना फ़ंक्शन सेट अप करें:

    1. फ़ंक्शन का नाम में, QuickStartChatApp डालें.
    2. ट्रिगर टाइप में, एचटीटीपी चुनें.
    3. 'पुष्टि करना' में जाकर, उन बातचीत को अनुमति दें जिनकी पुष्टि नहीं की गई है को चुनें.
    4. सेव करें पर क्लिक करें.
    5. आगे बढ़ें पर क्लिक करें.
  4. रनटाइम में, Java 11 चुनें.

  5. सोर्स कोड में, इनलाइन एडिटर चुनें.

  6. एंट्री पॉइंट में, डिफ़ॉल्ट टेक्स्ट मिटाएं और HelloChat डालें.

  7. src/main/java/com/example/Example.java का नाम बदलकर src/main/java/HelloChat.java करें.

  8. HelloChat.java के कॉन्टेंट को नीचे दिए गए कोड से बदलें:

    java/avatar-app/src/main/java/HelloChat.java
    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;
    import java.util.List;
    
    public class HelloChat 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("message")) {
          response.getWriter().write("Hello! This function must be called from Google Chat.");
          return;
        }
    
        JsonObject sender = body.getAsJsonObject("message").getAsJsonObject("sender");
        String displayName = sender.has("displayName") ? sender.get("displayName").getAsString() : "";
        String avatarUrl = sender.has("avatarUrl") ? sender.get("avatarUrl").getAsString() : "";
        Message message = createMessage(displayName, avatarUrl);
    
        response.getWriter().write(gson.toJson(message));
      }
    
      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("previewLink");
        cardWithId.setCard(card);
    
        Message message = new Message();
        message.setText("Here's your avatar");
        message.setCardsV2(List.of(cardWithId));
    
        return message;
      }
    }

  9. pom.xml के कॉन्टेंट को नीचे दिए गए कोड से बदलें:

    java/avatar-app/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>cloudfunctions</groupId>
      <artifactId>http-function</artifactId>
      <version>1.0-SNAPSHOT</version>
    
      <properties>
        <maven.compiler.target>11</maven.compiler.target>
        <maven.compiler.source>11</maven.compiler.source>
      </properties>
    
      <dependencies>
        <dependency>
          <groupId>com.google.cloud.functions</groupId>
          <artifactId>functions-framework-api</artifactId>
          <version>1.0.1</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 11 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>

  10. डिप्लॉय करें पर क्लिक करें.

ऐसा करने पर, Cloud Functions की जानकारी वाला पेज खुलेगा. इसके बाद, आपको दो फ़ंक्शन दिखेंगे: पहला, बिल्ड के लिए और दूसरा सेवा के लिए. जब प्रोग्रेस के दोनों इंडिकेटर गायब हो जाते हैं और उनकी जगह सही का निशान दिखने लगता है, तब आपका फ़ंक्शन डिप्लॉय हो जाता है और तैयार हो जाता है.

ऐप्लिकेशन को Google Chat पर पब्लिश करें

Cloud फ़ंक्शन के डिप्लॉय होने के बाद, इसे Google Chat ऐप्लिकेशन में बदलने के लिए यह तरीका अपनाएं:

  1. Google Cloud Console में, मेन्यू > क्लाउड फ़ंक्शन पर क्लिक करें.

    Cloud Functions पर जाएं

    पक्का करें कि आपने जिस प्रोजेक्ट के लिए Cloud Functions चालू किया है उसे चुना गया हो.

  2. फ़ंक्शन की सूची में, QuickStartChatApp पर क्लिक करें.

  3. फ़ंक्शन की जानकारी वाले पेज पर, ट्रिगर पर क्लिक करें.

  4. ट्रिगर यूआरएल में जाकर, यूआरएल कॉपी करें.

  5. "Google Chat API" खोजें और Google Chat API पर क्लिक करें. इसके बाद, मैनेज करें पर क्लिक करें.

    Chat API पर जाएं

  6. कॉन्फ़िगरेशन पर क्लिक करें और Google Chat ऐप्लिकेशन को सेट अप करें:

    1. ऐप्लिकेशन का नाम में, Quickstart App डालें.
    2. अवतार के यूआरएल में, https://developers.google.com/chat/images/quickstart-app-avatar.png डालें.
    3. जानकारी में Quickstart app डालें.
    4. सुविधा में, 1:1 मैसेज पाएं और स्पेस और ग्रुप बातचीत में शामिल हों चुनें.
    5. कनेक्शन सेटिंग में जाकर, ऐप्लिकेशन यूआरएल चुनें. इसके बाद, क्लाउड फ़ंक्शन ट्रिगर के यूआरएल को बॉक्स में चिपकाएं.
    6. किसको दिखे में जाकर, अपने डोमेन में इस Google Chat ऐप्लिकेशन को कुछ खास लोगों और ग्रुप के लिए उपलब्ध कराएं को चुनें और अपना ईमेल पता डालें.
    7. लॉग में जाकर, लॉगिंग में गड़बड़ियों को लॉग करें चुनें.
  7. सेव करें पर क्लिक करें.

Chat ऐप्लिकेशन से Chat पर मैसेज पाए जा सकते हैं. साथ ही, मैसेज का जवाब भी दिया जा सकता है.

अपने Chat ऐप्लिकेशन को टेस्ट करें

अपने Chat ऐप्लिकेशन को टेस्ट करने के लिए, ऐप्लिकेशन को डायरेक्ट मैसेज भेजें:

  1. Google Chat खोलें.
  2. ऐप्लिकेशन पर डायरेक्ट मैसेज भेजने के लिए, चैट शुरू करें पर क्लिक करें. इसके बाद, जो विंडो दिखेगी उसमें, ऐप्लिकेशन ढूंढें पर क्लिक करें.
  3. ऐप्लिकेशन ढूंढें डायलॉग में, Quickstart App खोजें.
  4. ऐप्लिकेशन में कोई डायरेक्ट मैसेज खोलने के लिए, Quickstart ऐप्लिकेशन ढूंढें और जोड़ें > Chat पर क्लिक करें.
  5. डायरेक्ट मैसेज में, Hello टाइप करें और enter दबाएं.

Chat ऐप्लिकेशन के जवाब में एक कार्ड मैसेज होता है, जिसमें ईमेल भेजने वाले का नाम और अवतार इमेज दिखती है, जैसा कि इस इमेज में दिखाया गया है:

जवाब देने वाला Chat ऐप्लिकेशन एक कार्ड की मदद से जवाब देता है, जिसमें मैसेज भेजने वाले के डिसप्ले नेम और अवतार की इमेज होती है

भरोसेमंद टेस्टर जोड़ने और इंटरैक्टिव सुविधाओं को टेस्ट करने के बारे में ज़्यादा जानने के लिए, Google Chat ऐप्लिकेशन के लिए इंटरैक्टिव सुविधाओं की जांच करना लेख पढ़ें.

गड़बड़ियां ठीक करने का तरीका

Chat ऐप्लिकेशन से जुड़ी समस्या को हल करने और उसे डीबग करने के लिए, Google Chat ऐप्लिकेशन से जुड़ी गड़बड़ियों को हल करना और उन्हें ठीक करना लेख पढ़ें.