इस पेज का अनुवाद Cloud Translation API से किया गया है.

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

इस पेज पर Google Cloud Functions का इस्तेमाल करके चैट ऐप्लिकेशन बनाने और उसके साथ इंटरैक्ट करने का तरीका बताया गया है.

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

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

मकसद

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

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

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 चालू करें.

एपीआई को चालू करें

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

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

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

Node.js

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

क्लाउड फ़ंक्शन पर जाएं

पक्का करें कि आपने Chat ऐप्लिकेशन का प्रोजेक्ट चुना हो.
फ़ंक्शन बनाएं पर क्लिक करें.
'फ़ंक्शन बनाएं' पेज पर, अपना फ़ंक्शन सेट अप करें:
1. फ़ंक्शन का नाम में, "QuickStartChatApp" डालें.
2. ट्रिगर टाइप में एचटीटीपी चुनें.
3. पुष्टि करने की प्रक्रिया में, बिना अनुमति के न्योता भेजने की अनुमति दें चुनें.
  
  Google Workspace में पुष्टि करने के बारे में ज़्यादा जानकारी के लिए, Chat ऐप्लिकेशन और एपीआई अनुरोधों की पुष्टि करना और उन्हें अनुमति देना देखें.
4. सेव करें पर क्लिक करें.
5. आगे बढ़ें पर क्लिक करें.
रनटाइम में, Node.js 10 को चुनें.
सोर्स कोड में, इनलाइन एडिटर चुनें.
एंट्री पॉइंट में, डिफ़ॉल्ट टेक्स्ट मिटाएं और helloChat डालें.

index.js के कॉन्टेंट को इस कोड से बदलें:

नोड/avatar-bot/index.js

GitHub पर देखें

/**
 * Google Cloud Function that responds to messages sent from a
 * Hangouts Chat room.
 *
 * @param {Object} req Request sent from Hangouts 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 Hangouts 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 {
    cardsV2: [{
      cardId: 'avatarCard',
      card: {
        name: 'Avatar Card',
        header: cardHeader,
        sections: [avatarSection],
      }
    }],
  };
}

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

Python

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

क्लाउड फ़ंक्शन पर जाएं

पक्का करें कि आपने Chat ऐप्लिकेशन का प्रोजेक्ट चुना हो.
फ़ंक्शन बनाएं पर क्लिक करें.
'फ़ंक्शन बनाएं' पेज पर, अपना फ़ंक्शन सेट अप करें:
1. फ़ंक्शन का नाम में, "QuickStartChatApp" डालें.
2. ट्रिगर टाइप में एचटीटीपी चुनें.
3. पुष्टि करने की प्रक्रिया में, बिना अनुमति के न्योता भेजने की अनुमति दें चुनें.
  
  Google Workspace में पुष्टि करने के बारे में ज़्यादा जानकारी के लिए, Chat ऐप्लिकेशन और एपीआई अनुरोधों की पुष्टि करना और उन्हें अनुमति देना देखें.
4. सेव करें पर क्लिक करें.
5. आगे बढ़ें पर क्लिक करें.
रनटाइम में, Python 3.10 चुनें.
सोर्स कोड में, इनलाइन एडिटर चुनें.
एंट्री पॉइंट में, डिफ़ॉल्ट टेक्स्ट मिटाएं और hello_chat डालें.

main.py के कॉन्टेंट को इस कोड से बदलें:

अगीन/अवतार-बॉट/main.py

GitHub पर देखें

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):
    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 = {
        "cardsV2": [
            {
                "cardId": "avatarCard",
                "card": {
                    "name": "Avatar Card",
                    "header": header,
                    "sections": [avatar_section],
                },
            }
        ]
    }

    return cards

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

Java

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

क्लाउड फ़ंक्शन पर जाएं

पक्का करें कि आपने Chat ऐप्लिकेशन का प्रोजेक्ट चुना हो.
फ़ंक्शन बनाएं पर क्लिक करें.
'फ़ंक्शन बनाएं' पेज पर, अपना फ़ंक्शन सेट अप करें:
1. फ़ंक्शन का नाम में, "QuickStartChatApp" डालें.
2. ट्रिगर टाइप में एचटीटीपी चुनें.
3. पुष्टि करने की प्रक्रिया में, बिना अनुमति के न्योता भेजने की अनुमति दें चुनें.
  
  Google Workspace में पुष्टि करने के बारे में ज़्यादा जानकारी के लिए, Chat ऐप्लिकेशन और एपीआई अनुरोधों की पुष्टि करना और उन्हें अनुमति देना देखें.
4. सेव करें पर क्लिक करें.
5. आगे बढ़ें पर क्लिक करें.
रनटाइम में, Java 11 चुनें.
सोर्स कोड में, इनलाइन एडिटर चुनें.
एंट्री पॉइंट में, डिफ़ॉल्ट टेक्स्ट मिटाएं और HelloChat डालें.
src/main/java/com/example/Example.java का नाम बदलकर src/main/java/HelloChat.java करें.

HelloChat.java के कॉन्टेंट को इस कोड से बदलें:

java/avatar-bot/src/main/java/HelloChat.java

GitHub पर देखें

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.setCardsV2(List.of(cardWithId));

    return message;
  }
}

pom.xml के कॉन्टेंट को इस कोड से बदलें:

java/avatar-bot/pom.xml

GitHub पर देखें

<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>

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

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

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

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

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

क्लाउड फ़ंक्शन पर जाएं

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

ऐप्लिकेशन, Google Chat पर मैसेज पाने और उनका जवाब देने के लिए तैयार है.

Chat ऐप्लिकेशन की जांच करना

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

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

ऐप्लिकेशन में आपके डिसप्ले नेम और अवतार फ़ोटो के साथ एक कार्ड दिखता है.

अगले चरण

अपने चैट ऐप्लिकेशन की समस्या हल करने और डीबग करने के लिए, ये पेज देखें:

Chat ऐप्लिकेशन बनाने के दौरान, आपको ऐप्लिकेशन के गड़बड़ी के लॉग पढ़कर उसे डीबग करना पड़ सकता है. लॉग पढ़ने के लिए, Google Cloud Console में, लॉग एक्सप्लोरर पर जाएं.
समस्या हल करना.

Chat ऐप्लिकेशन में ज़्यादा सुविधाएं जोड़ने के लिए, इन गाइड को देखें:

इंटरैक्टिव कार्ड बनाएं — कार्ड के मैसेज, तय किए गए लेआउट, बटन जैसे इंटरैक्टिव यूज़र इंटरफ़ेस (यूआई) एलिमेंट, और इमेज जैसे रिच मीडिया के साथ काम करते हैं. कार्ड से भेजे गए मैसेज का इस्तेमाल करके ज़्यादा जानकारी दें, उपयोगकर्ताओं से जानकारी इकट्ठा करें, और अगला कदम उठाने में उपयोगकर्ताओं की मदद करें.
स्लैश स्लैश कमांड — स्लैश कमांड की मदद से, /helpपर बने स्लैश कमांड (/) से शुरू होने वाले कुछ निर्देशों को लिखकर, रजिस्टर किया जा सकता है. साथ ही, आपके ऐप्लिकेशन में विज्ञापन दिखाए जा सकते हैं.
डायलॉग लॉन्च करें — डायलॉग विंडो की तरह होते हैं, कार्ड पर आधारित इंटरफ़ेस होते हैं जिन्हें आपका ऐप्लिकेशन उपयोगकर्ता से इंटरैक्ट करने के लिए खोल सकता है. एक से ज़्यादा कार्ड को एक साथ क्रम में रखा जा सकता है. इससे उपयोगकर्ताओं को कई चरणों वाली प्रोसेस पूरी करने में मदद मिलती है, जैसे कि फ़ॉर्म डेटा भरना.

Google Chat API के बारे में ज़्यादा जानने के लिए, रेफ़रंस दस्तावेज़ देखें.