क्या आपके पास पांच मिनट हैं? एक छोटे से सर्वे में हिस्सा लेकर, Google Chat डेवलपर दस्तावेज़ को बेहतर बनाने में हमारी मदद करें.

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

Switch to English

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

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

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

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

मकसद

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

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

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

Google Cloud प्रोजेक्ट.
पक्का करें कि आपने अपने 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 को चालू करें.

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

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

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

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

Node.js

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

Cloud Functions पर जाएं

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

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

node/avatar-app/index.js

GitHub पर देखें

/**
 * 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],
      }
    }],
  };
}

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

Python

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

Cloud Functions पर जाएं

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

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

python/avatar-app/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) -> 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

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

Java

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

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-app/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.setText("Here's your avatar");
    message.setCardsV2(List.of(cardWithId));

    return message;
  }
}

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

java/avatar-app/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>

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

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

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

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

Google Cloud Console में, मेन्यू > Cloud Functions पर क्लिक करें.

Cloud Functions पर जाएं

पक्का करें कि आपने जिस प्रोजेक्ट के लिए Cloud Functions चालू किया है उसे चुना गया हो.
फ़ंक्शन की सूची में, QuickStartChatApp पर क्लिक करें.
फ़ंक्शन की ज़्यादा जानकारी वाले पेज पर, ट्रिगर करें पर क्लिक करें.
ट्रिगर यूआरएल में जाकर, यूआरएल कॉपी करें.
"Google Chat API" खोजें और Google Chat API पर क्लिक करें. इसके बाद, मैनेज करें पर क्लिक करें.

Chat API पर जाएं
कॉन्फ़िगरेशन पर क्लिक करें और 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 पर मैसेज पाने और उनका जवाब देने के लिए तैयार है.

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

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

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

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

त्रुटियों का समस्या निवारण करना

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

मिलते-जुलते विषय

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

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

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