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

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

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

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

पिछले डायग्राम में, किसी एचटीटीपी के साथ इंटरैक्ट करते हुए एक उपयोगकर्ता को दिखाया गया है Chat ऐप्लिकेशन में नीचे दी गई जानकारी मौजूद होती है:

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

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

मकसद

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

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

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

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.

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

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

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

अपने Chat ऐप्लिकेशन के लिए फ़ंक्शन बनाने और उसे डिप्लॉय करने के लिए, इन चरणों को पूरा करें:

Node.js

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

    Cloud Functions पर जाएं

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

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

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

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

  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. Environment में, 2nd gen को चुनें.
    2. फ़ंक्शन के नाम में QuickStartChatApp डालें.
    3. क्षेत्र में जाकर, कोई देश/इलाका चुनें.
    4. 'पुष्टि करें' में जाकर, पुष्टि करना ज़रूरी है को चुनें.
    5. आगे बढ़ें पर क्लिक करें.
  4. रनटाइम में जाकर, Python का सबसे नया वर्शन चुनें.

  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. Environment में, 2nd gen को चुनें.
    2. फ़ंक्शन के नाम में QuickStartChatApp डालें.
    3. क्षेत्र में जाकर, कोई देश/इलाका चुनें.
    4. 'पुष्टि करें' में जाकर, पुष्टि करना ज़रूरी है को चुनें.
    5. आगे बढ़ें पर क्लिक करें.
  4. रनटाइम में, Java का सबसे नया वर्शन चुनें.

  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 को अपना फ़ंक्शन शुरू करने की अनुमति दें

Google Chat को अपना फ़ंक्शन शुरू करने की अनुमति देने के लिए, Google Chat जोड़ें सेवा खाते के लिए, Cloud Run Invoker की भूमिका होनी चाहिए.

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

    Cloud Run पर जाएं

  2. Cloud Run सेवाएं सूची में, पाने वालों के आगे दिए गए चेकबॉक्स को चुनें फ़ंक्शन का इस्तेमाल करना होगा. (फ़ंक्शन पर क्लिक न करें.)

  3. अनुमतियां पर क्लिक करें. अनुमतियां पैनल खुलेगा.

  4. प्रिंसिपल जोड़ें पर क्लिक करें.

  5. नए प्रिंसिपल में, chat@system.gserviceaccount.com डालें.

  6. भूमिका चुनें में, Cloud Run चुनें > Cloud Run Invoker.

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

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

Cloud Function डिप्लॉय होने के बाद, उसे Google Chat ऐप्लिकेशन:

  1. Google Cloud Console में, मेन्यू पर क्लिक करें &gt; Cloud के फ़ंक्शन.

    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. कनेक्शन सेटिंग में जाकर, ऐप्लिकेशन यूआरएल चुनें और Cloud फ़ंक्शन, बॉक्स में ट्रिगर हो जाएगा.
    6. पुष्टि करने वाली ऑडियंस में, ऐप्लिकेशन यूआरएल चुनें.
    7. किसको दिखे सेक्शन में जाकर, Google Chat ऐप्लिकेशन को कुछ चुनिंदा लोगों के लिए उपलब्ध कराएं और Groups पर क्लिक करें और अपना ईमेल पता डालें.
    8. लॉग में जाकर, लॉग करने में गड़बड़ियों को लॉग करें चुनें.
  7. सेव करें पर क्लिक करें.

Chat ऐप्लिकेशन अब जवाब पाने और जवाब देने के लिए तैयार है Google Chat पर मैसेज भेजने की सुविधा मिलती है.

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

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

  1. उस Google Workspace खाते का इस्तेमाल करके Google Chat खोलें जब आपने खुद को भरोसेमंद टेस्टर के तौर पर जोड़ा हो.

    Google Chat पर जाएं

  2. नई चैट पर क्लिक करें.
  3. एक या उससे ज़्यादा लोगों को जोड़ें फ़ील्ड में, अपने चैट ऐप्लिकेशन.
  4. नतीजों में से Chat ऐप्लिकेशन चुनें. सीधे तौर पर होने वाला मैसेज खुलता है.

  5. ऐप्लिकेशन के नए डायरेक्ट मैसेज में, Hello टाइप करें और enter.

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

चैट ऐप्लिकेशन, भेजने वाले का डिसप्ले नेम और अवतार दिखाने वाले कार्ड के साथ जवाब दे रहा है
इमेज

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

समस्या हल करें

जब Google Chat ऐप्लिकेशन या card कोई गड़बड़ी दिखाता है, Chat के इंटरफ़ेस पर, "कोई गड़बड़ी हुई" मैसेज दिखता है. या "आपका अनुरोध प्रोसेस नहीं किया जा सका." कभी-कभी Chat यूज़र इंटरफ़ेस (यूआई) गड़बड़ी का कोई मैसेज नहीं दिखाता है. हालांकि, Chat ऐप्लिकेशन या कार्ड से कोई अनचाहा नतीजा मिलता है; उदाहरण के लिए, कार्ड मैसेज शायद दिखाना चाहते हैं.

हालांकि, Chat के यूज़र इंटरफ़ेस (यूआई) में गड़बड़ी का मैसेज शायद न दिखे, गड़बड़ी ठीक करने में आपकी मदद करने के लिए, जानकारी देने वाले गड़बड़ी के मैसेज और लॉग डेटा उपलब्ध है जब चैट ऐप्लिकेशन के लिए गड़बड़ी लॉग करने की सेटिंग चालू हो. मदद के लिए, डीबग करने और गड़बड़ियां ठीक करने के लिए, देखें Google Chat से जुड़ी गड़बड़ियां हल करना और गड़बड़ियां ठीक करना.

व्यवस्थित करें

इसके लिए आपके Google Cloud खाते पर लगने वाले शुल्क से बचने के लिए तो हमारा सुझाव है कि आप Cloud प्रोजेक्ट शामिल है.

  1. Google Cloud Console में, संसाधन मैनेज करें पेज पर जाएं. क्लिक करें मेन्यू &gt; IAM और एडमिन &gt; संसाधन मैनेज करें पर क्लिक करें.

    रिसोर्स मैनेजर पर जाएं

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