कोई एचटीटीपी Google Chat ऐप्लिकेशन बनाएं

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

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

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

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

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

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

मकसद

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

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

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

Google API का इस्तेमाल करने से पहले, आपको उन्हें Google Cloud प्रोजेक्ट में चालू करना होगा. एक ही Google Cloud प्रोजेक्ट में, एक या उससे ज़्यादा एपीआई चालू किए जा सकते हैं.

  • Google API Console में, Google Chat API, 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

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

    Cloud Run पर जाएं

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

  2. फ़ंक्शन लिखें पर क्लिक करें.

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

    1. सेवा का नाम फ़ील्ड में, addonchatapp डालें.
    2. देश/इलाका सूची में जाकर, कोई देश/इलाका चुनें.
    3. रनटाइम सूची में, Node.js का सबसे नया वर्शन चुनें.
    4. पुष्टि करें सेक्शन में जाकर, पुष्टि करना ज़रूरी है को चुनें.
    5. बनाएं पर क्लिक करें और Cloud Run को सेवा बनाने दें. कंसोल आपको सोर्स टैब पर रीडायरेक्ट करता है.

  4. सोर्स टैब में जाकर:

    1. एंट्री पॉइंट में, डिफ़ॉल्ट टेक्स्ट मिटाएं और avatarApp डालें.
    2. index.js के कॉन्टेंट की जगह यह कोड डालें:
    node/chat/avatar-app/index.js
    import { http } from '@google-cloud/functions-framework';

// The ID of the slash command "/about".
// You must use the same ID in the Google Chat API configuration.
const ABOUT_COMMAND_ID = 1;

/**
 * Handle requests from Google Workspace add on
 *
 * @param {Object} req Request sent by Google Chat
 * @param {Object} res Response to be sent back to Google Chat
 */
http('avatarApp', (req, res) => {
  const chatEvent = req.body.chat;
  let message;
  if (chatEvent.appCommandPayload) {
    message = handleAppCommand(chatEvent);
  } else {
    message = handleMessage(chatEvent);
  }
  res.send({ hostAppDataAction: { chatDataAction: { createMessageAction: {
    message: message
  }}}});
});

/**
 * Responds to an APP_COMMAND event in Google Chat.
 *
 * @param {Object} event the event object from Google Chat
 * @return the response message object.
 */
function handleAppCommand(event) {
  switch (event.appCommandPayload.appCommandMetadata.appCommandId) {
    case ABOUT_COMMAND_ID:
      return {
        text: 'The Avatar app replies to Google Chat messages.'
      };
  }
}

/**
 * Responds to a MESSAGE event in Google Chat.
 *
 * @param {Object} event the event object from Google Chat
 * @return the response message object.
 */
function handleMessage(event) {
  // Stores the Google Chat user as a variable.
  const chatUser = event.messagePayload.message.sender;
  const displayName = chatUser.displayName;
  const avatarUrl = chatUser.avatarUrl;
  return {
    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 }
        }]}]
      }
    }]
  };
}
    1. सेव करें और फिर से डिप्लॉय करें पर क्लिक करें.

Python

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

    Cloud Run पर जाएं

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

  2. फ़ंक्शन लिखें पर क्लिक करें.

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

    1. सेवा का नाम फ़ील्ड में, addonchatapp डालें.
    2. देश/इलाका सूची में जाकर, कोई देश/इलाका चुनें.
    3. रनटाइम सूची में, Python का सबसे नया वर्शन चुनें.
    4. पुष्टि करें सेक्शन में जाकर, पुष्टि करना ज़रूरी है को चुनें.
    5. बनाएं पर क्लिक करें और Cloud Run को सेवा बनाने दें. कंसोल आपको सोर्स टैब पर रीडायरेक्ट करता है.

  4. सोर्स टैब में जाकर:

    1. एंट्री पॉइंट में, डिफ़ॉल्ट टेक्स्ट मिटाएं और avatar_app डालें.
    2. main.py के कॉन्टेंट की जगह यह कोड डालें:
    python/chat/avatar-app/main.py
    from typing import Any, Mapping

import flask
import functions_framework

# The ID of the slash command "/about".
# You must use the same ID in the Google Chat API configuration.
ABOUT_COMMAND_ID = 1

@functions_framework.http
def avatar_app(req: flask.Request) -> Mapping[str, Any]:
  """Handle requests from Google Workspace add on

  Args:
    flask.Request req: the request sent by Google Chat

  Returns:
    Mapping[str, Any]: the response to be sent back to Google Chat
  """
  chat_event = req.get_json(silent=True)["chat"]
  if chat_event and "appCommandPayload" in chat_event:
    message = handle_app_command(chat_event)
  else:
    message = handle_message(chat_event)
  return { "hostAppDataAction": { "chatDataAction": { "createMessageAction": {
      "message": message
  }}}}

def handle_app_command(event: Mapping[str, Any]) -> Mapping[str, Any]:
  """Responds to an APP_COMMAND event in Google Chat.

  Args:
    Mapping[str, Any] event: the event object from Google Chat

  Returns:
    Mapping[str, Any]: the response message object.
  """
  if event["appCommandPayload"]["appCommandMetadata"]["appCommandId"] == ABOUT_COMMAND_ID:
    return {
      "text": "The Avatar app replies to Google Chat messages.",
    }
  return {}

def handle_message(event: Mapping[str, Any]) -> Mapping[str, Any]:
  """Responds to a MESSAGE event in Google Chat.

  Args:
    Mapping[str, Any] event: the event object from Google Chat

  Returns:
    Mapping[str, Any]: the response message object.
  """
  # Stores the Google Chat user as a variable.
  chat_user = event["messagePayload"]["message"]["sender"]
  display_name = chat_user.get("displayName", "")
  avatar_url = chat_user.get("avatarUrl", "")
  return {
    "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 }},
        ]}]
      }
    }]
  }
    1. सेव करें और फिर से डिप्लॉय करें पर क्लिक करें.

Java

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

    Cloud Run पर जाएं

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

  2. फ़ंक्शन लिखें पर क्लिक करें.

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

    1. सेवा का नाम फ़ील्ड में, addonchatapp डालें.
    2. देश/इलाका सूची में जाकर, कोई देश/इलाका चुनें.
    3. रनटाइम सूची में, Java का सबसे नया वर्शन चुनें.
    4. पुष्टि करें सेक्शन में जाकर, पुष्टि करना ज़रूरी है को चुनें.
    5. बनाएं पर क्लिक करें और Cloud Run को सेवा बनाने दें. कंसोल आपको सोर्स टैब पर रीडायरेक्ट करता है.

  4. सोर्स टैब में जाकर:

    1. एंट्री पॉइंट में, डिफ़ॉल्ट टेक्स्ट मिटाएं और App डालें.
    2. डिफ़ॉल्ट Java फ़ाइल का नाम बदलकर src/main/java/com/google/chat/avatar/App.java करें.
    3. App.java के कॉन्टेंट की जगह यह कोड डालें:
    java/chat/avatar-app/src/main/java/com/google/chat/avatar/App.java
    package com.google.chat.avatar;

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 App implements HttpFunction {
  // The ID of the slash command "/about".
  // You must use the same ID in the Google Chat API configuration.
  private static final int ABOUT_COMMAND_ID = 1;

  private static final Gson gson = new Gson();

  /**
   * Handle requests from Google Workspace add on
   * 
   * @param request the request sent by Google Chat
   * @param response the response to be sent back to Google Chat
   */
  @Override
  public void service(HttpRequest request, HttpResponse response) throws Exception {
    JsonObject event = gson.fromJson(request.getReader(), JsonObject.class);
    JsonObject chatEvent = event.getAsJsonObject("chat");
    Message message;
    if (chatEvent.has("appCommandPayload")) {
      message = handleAppCommand(chatEvent);
    } else {
      message = handleMessage(chatEvent);
    }
    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));
  }

  /**
   * Handles an APP_COMMAND event in Google Chat.
   *
   * @param event the event object from Google Chat
   * @return the response message object.
   */
  private Message handleAppCommand(JsonObject event) throws Exception {
    switch (event.getAsJsonObject("appCommandPayload")
      .getAsJsonObject("appCommandMetadata").get("appCommandId").getAsInt()) {
      case ABOUT_COMMAND_ID:
        return new Message()
          .setText("The Avatar app replies to Google Chat messages.");
      default:
        return null;
    }
  }

  /**
   * Handles a MESSAGE event in Google Chat.
   *
   * @param event the event object from Google Chat
   * @return the response message object.
   */
  private Message handleMessage(JsonObject event) throws Exception {
    // Stores the Google Chat user as a variable.
    JsonObject chatUser = event.getAsJsonObject("messagePayload").getAsJsonObject("message").getAsJsonObject("sender");
    String displayName = chatUser.has("displayName") ? chatUser.get("displayName").getAsString() : "";
    String avatarUrl = chatUser.has("avatarUrl") ? chatUser.get("avatarUrl").getAsString() : "";
    return new Message()
      .setText("Here's your avatar")
      .setCardsV2(List.of(new CardWithId()
        .setCardId("avatarCard")
        .setCard(new GoogleAppsCardV1Card()
          .setName("Avatar Card")
          .setHeader(new GoogleAppsCardV1CardHeader()
            .setTitle(String.format("Hello %s!", displayName)))
          .setSections(List.of(new GoogleAppsCardV1Section().setWidgets(List.of(
            new GoogleAppsCardV1Widget().setTextParagraph(new GoogleAppsCardV1TextParagraph()
              .setText("Your avatar picture:")),
            new GoogleAppsCardV1Widget()
              .setImage(new GoogleAppsCardV1Image().setImageUrl(avatarUrl)))))))));
  }
}

  5. pom.xml के कॉन्टेंट की जगह यह कोड डालें:

    java/chat/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>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.1.4</version>
    </dependency>
    <dependency>
      <groupId>com.google.code.gson</groupId>
      <artifactId>gson</artifactId>
      <version>2.9.1</version>
    </dependency>
    <dependency>
      <groupId>com.google.apis</groupId>
      <artifactId>google-api-services-chat</artifactId>
      <version>v1-rev20230115-2.0.0</version>
    </dependency>
  </dependencies>

  <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>
    1. सेव करें और फिर से डिप्लॉय करें पर क्लिक करें.

इससे, Cloud Run सेवा की ज़्यादा जानकारी वाला पेज खुलता है. फ़ंक्शन के डिप्लॉय होने का इंतज़ार करें.

Chat ऐप्लिकेशन को कॉन्फ़िगर करना

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

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

    Cloud Run पर जाएं

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

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

  3. सेवा की जानकारी पेज पर, फ़ंक्शन का यूआरएल कॉपी करें. यूआरएल run.app पर खत्म होता है.

  4. Google Cloud के खोज फ़ील्ड में, "Google Chat API" खोजें. इसके बाद, Google Chat API पर क्लिक करें और फिर मैनेज करें पर क्लिक करें.

    Chat API पर जाएं

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

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

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

  7. कनेक्शन की सेटिंग में जाकर, सेवा खाते का ईमेल कॉपी करें. अपने Chat ऐप्लिकेशन को फ़ंक्शन शुरू करने की अनुमति देते समय, आपको इस ईमेल की ज़रूरत होगी.

इसके बाद, Chat ऐप्लिकेशन को Cloud Run फ़ंक्शन शुरू करने की अनुमति दें.

Google Chat को आपके फ़ंक्शन को शुरू करने की अनुमति देना

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

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

    Cloud Run पर जाएं

  2. Cloud Run सेवाओं की सूची में, डेटा पाने वाले फ़ंक्शन के बगल में मौजूद चेकबॉक्स को चुनें. (फ़ंक्शन पर क्लिक न करें.)

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

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

  5. नए मुख्य खाते में, Chat ऐप्लिकेशन से जुड़े सेवा खाते का ईमेल पता डालें.

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

    Chat API कॉन्फ़िगरेशन पर जाएं

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

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

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

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

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

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

    Google Chat पर जाएं

  2. नई चैट पर क्लिक करें.
  3. एक या उससे ज़्यादा लोगों को जोड़ें फ़ील्ड में, अपने Chat ऐप्लिकेशन का नाम टाइप करें.

  4. नतीजों में से अपना Chat ऐप्लिकेशन चुनें. एक डायरेक्ट मैसेज खुलता है.

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

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

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

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

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

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

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

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

इस ट्यूटोरियल में इस्तेमाल किए गए संसाधनों के लिए, अपने Google Cloud खाते से शुल्क न लिए जाने के लिए, हमारा सुझाव है कि आप Cloud प्रोजेक्ट को मिटा दें.

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

    Resource Manager पर जाएं

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

ऐसे चैट ऐप्लिकेशन जो ऐड-ऑन नहीं हैं: एचटीटीपी Google Chat ऐप्लिकेशन बनाना

Google Workspace ऐड-ऑन के तौर पर काम न करने वाला Chat ऐप्लिकेशन बनाने के लिए, Cloud Run फ़ंक्शन को डिप्लॉय करने, फ़ंक्शन को कॉल करने की अनुमतियां देने, और ऐड-ऑन के तौर पर काम न करने वाले Chat ऐप्लिकेशन को कॉन्फ़िगर करने के लिए, यह तरीका अपनाएं.

किसी ऐसे Chat ऐप्लिकेशन के लिए Cloud Run फ़ंक्शन बनाना और उसे डिप्लॉय करना जो ऐड-ऑन नहीं है

Node.js

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

    Cloud Run पर जाएं

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

  2. फ़ंक्शन लिखें पर क्लिक करें.

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

    1. सेवा का नाम फ़ील्ड में, quickstartchatapp डालें.
    2. देश/इलाका सूची में जाकर, कोई देश/इलाका चुनें.
    3. रनटाइम सूची में, Node.js का सबसे नया वर्शन चुनें.
    4. पुष्टि करें सेक्शन में जाकर, पुष्टि करना ज़रूरी है को चुनें.
    5. बनाएं पर क्लिक करें और Cloud Run को सेवा बनाने दें. कंसोल आपको सोर्स टैब पर रीडायरेक्ट करता है.

  4. सोर्स टैब में जाकर:

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

    2. index.js के कॉन्टेंट की जगह यह कोड डालें:

      node/avatar-app/index.js
      const functions = require('@google-cloud/functions-framework');

// Command IDs (configure these in Google Chat API)
const ABOUT_COMMAND_ID = 1; // ID for the "/about" slash command
const HELP_COMMAND_ID = 2; // ID for the "Help" quick command

/**
 * Google Cloud Function that handles HTTP requests from Google Chat.
 *
 * @param {Object} req - The HTTP request object sent from Google Chat.
 * @param {Object} res - The HTTP response object.
 */
functions.http('avatarApp', (req, res) => {
  const event = req.body;

  if (event.appCommandMetadata) {
    handleAppCommands(event, res);
  } else {
    handleRegularMessage(event, res);
  }
});

/**
 * Handles slash and quick commands.
 *
 * @param {Object} event - The Google Chat event.
 * @param {Object} res - The HTTP response object.
 */
function handleAppCommands(event, res) {
  const {appCommandId, appCommandType} = event.appCommandMetadata;

  switch (appCommandId) {
    case ABOUT_COMMAND_ID:
      return res.send({
        privateMessageViewer: event.user,
        text: 'The Avatar app replies to Google Chat messages.'
      });
    case HELP_COMMAND_ID:
      return res.send({
        privateMessageViewer: event.user,
        text: 'The Avatar app replies to Google Chat messages.'
      });
  }
}

/**
 * Handles regular messages (not commands).
 *
 * @param {Object} event - The Google Chat event.
 * @param {Object} res - The HTTP response object.
 */
function handleRegularMessage(event, res) {
  const messageData = createMessage(event.user);
  res.send(messageData);
}

/**
 * Creates a card message with the user's avatar.
 *
 * @param {Object} user - The user who sent the message.
 * @param {string} user.displayName - The user's display name.
 * @param {string} user.avatarUrl - The URL of the user's avatar.
 * @return {Object} - The card message object.
 */
function createMessage({displayName, avatarUrl}) {
  return {
    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}},
          ],
        }],
      },
    }],
  };
}

    3. सेव करें और फिर से डिप्लॉय करें पर क्लिक करें.

Python

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

    Cloud Run पर जाएं

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

  2. फ़ंक्शन लिखें पर क्लिक करें.

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

    1. सेवा का नाम फ़ील्ड में, quickstartchatapp डालें.
    2. देश/इलाका सूची में जाकर, कोई देश/इलाका चुनें.
    3. रनटाइम सूची में, Python का सबसे नया वर्शन चुनें.
    4. पुष्टि करें सेक्शन में जाकर, पुष्टि करना ज़रूरी है को चुनें.
    5. बनाएं पर क्लिक करें और Cloud Run को सेवा बनाने दें. कंसोल आपको सोर्स टैब पर रीडायरेक्ट करता है.

  4. सोर्स टैब में जाकर:

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

    2. main.py के कॉन्टेंट की जगह यह कोड डालें:

      python/avatar-app/main.py
      from typing import Any, Mapping

import flask
import functions_framework

# Command IDs (configure these in Google Chat API)
ABOUT_COMMAND_ID = 1  # ID for the "/about" slash command
HELP_COMMAND_ID = 2  # ID for the "Help" quick command


@functions_framework.http
def avatar_app(req: flask.Request) -> Mapping[str, Any]:
    """Google Cloud Function that handles HTTP requests from Google Chat.

    Args:
        flask.Request: the request

    Returns:
        Mapping[str, Any]: the response
    """
    event = req.get_json(silent=True)

    if event and "appCommandMetadata" in event:
        return handle_app_commands(event)
    else:
        return handle_regular_message(event)


def handle_app_commands(event: Mapping[str, Any]) -> Mapping[str, Any]:
    """Handles slash and quick commands.

    Args:
        Mapping[str, Any] event: The Google Chat event.

    Returns:
        Mapping[str, Any]: the response
    """
    app_command_id = event["appCommandMetadata"]["appCommandId"]

    if app_command_id == ABOUT_COMMAND_ID:
        return {
            "privateMessageViewer": event["user"],
            "text": "The Avatar app replies to Google Chat messages.",
        }
    elif app_command_id == HELP_COMMAND_ID:
        return {
            "privateMessageViewer": event["user"],
            "text": "The Avatar app replies to Google Chat messages.",
        }
    return {}




def handle_regular_message(event: Mapping[str, Any]) -> Mapping[str, Any]:
    """Handles regular messages (not commands).

    Args:
        Mapping[str, Any] event: The Google Chat event.

    Returns:
        Mapping[str, Any]: the response
    """

    if not event or "user" not in event:
        return "Invalid request."

    message_data = create_message(event["user"])
    return message_data


def create_message(user: Mapping[str, Any]) -> Mapping[str, Any]:
    """Creates a card message with the user's avatar.

    Args:
        Mapping[str, Any] user: The user who sent the message.

    Returns:
        Mapping[str, Any]: a card with the user's avatar.
    """
    display_name = user.get("displayName", "")
    avatar_url = user.get("avatarUrl", "")

    return {
        "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}},
                            ]
                        }
                    ],
                },
            }
        ],
    }

    3. सेव करें और फिर से डिप्लॉय करें पर क्लिक करें.

Java

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

    Cloud Run पर जाएं

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

  2. फ़ंक्शन लिखें पर क्लिक करें.

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

    1. सेवा का नाम फ़ील्ड में, quickstartchatapp डालें.
    2. देश/इलाका सूची में जाकर, कोई देश/इलाका चुनें.
    3. रनटाइम सूची में, Java का सबसे नया वर्शन चुनें.
    4. पुष्टि करें सेक्शन में जाकर, पुष्टि करना ज़रूरी है को चुनें.
    5. बनाएं पर क्लिक करें और Cloud Run को सेवा बनाने दें. कंसोल आपको सोर्स टैब पर रीडायरेक्ट करता है.

  4. सोर्स टैब में जाकर:

    1. एंट्री पॉइंट में, डिफ़ॉल्ट टेक्स्ट मिटाएं और App डालें.
    2. src/main/java/com/example/Example.java का नाम बदलकर src/main/java/AvatarApp.java कर दें.

    3. AvatarApp.java के कॉन्टेंट की जगह यह कोड डालें:

      java/avatar-app/src/main/java/AvatarApp.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.api.services.chat.v1.model.User;
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 AvatarApp implements HttpFunction {
  private static final Gson gson = new Gson();

  // Command IDs (configure these in Google Chat API)
  private static final int ABOUT_COMMAND_ID = 1; // ID for the "/about" slash command
  private static final int HELP_COMMAND_ID = 2; // ID for the "Help" quick command

  @Override
  public void service(HttpRequest request, HttpResponse response) throws Exception {
    JsonObject event = gson.fromJson(request.getReader(), JsonObject.class);

    if (event.has("appCommandMetadata")) {
      handleAppCommands(event, response);
    } else {
      handleRegularMessage(event, response);
    }
  }

  /**
   * Handles slash and quick commands.
   *
   * @param event    The Google Chat event.
   * @param response The HTTP response object.
   */
  private void handleAppCommands(JsonObject event, HttpResponse response) throws Exception {
    int appCommandId = event.getAsJsonObject("appCommandMetadata").get("appCommandId").getAsInt();

    switch (appCommandId) {
      case ABOUT_COMMAND_ID:
        Message aboutMessage = new Message();
        aboutMessage.setText("The Avatar app replies to Google Chat messages.");
        aboutMessage.setPrivateMessageViewer(new User()
            .setName(event.getAsJsonObject("user").get("name").getAsString()));
        response.getWriter().write(gson.toJson(aboutMessage));
        return;
      case HELP_COMMAND_ID:
        Message helpMessage = new Message();
        helpMessage.setText("The Avatar app replies to Google Chat messages.");
        helpMessage.setPrivateMessageViewer(new User()
            .setName(event.getAsJsonObject("user").get("name").getAsString()));
        response.getWriter().write(gson.toJson(helpMessage));
        return;
    }
  }

  /**
   * Handles regular messages (not commands).
   *
   * @param event    The Google Chat event.
   * @param response The HTTP response object.
   */
  private void handleRegularMessage(JsonObject event, HttpResponse response) throws Exception {

    if (!event.has("user")) {
      response.getWriter().write("Invalid request.");
      return;
    }

    JsonObject user = event.getAsJsonObject("user");
    String displayName = user.has("displayName") ? user.get("displayName").getAsString() : "";
    String avatarUrl = user.has("avatarUrl") ? user.get("avatarUrl").getAsString() : "";
    Message message = createMessage(displayName, avatarUrl);
    response.getWriter().write(gson.toJson(message));
  }

  /**
   * Creates a card message with the user's avatar.
   *
   * @param displayName The user's display name.
   * @param avatarUrl   The URL of the user's avatar.
   * @return The card message object.
   */
  private Message createMessage(String displayName, String avatarUrl) {
    return new Message()
        .setText("Here's your avatar")
        .setCardsV2(List.of(new CardWithId()
            .setCardId("avatarCard")
            .setCard(new GoogleAppsCardV1Card()
                .setName("Avatar Card")
                .setHeader(new GoogleAppsCardV1CardHeader()
                    .setTitle(String.format("Hello %s!", displayName)))
                .setSections(List.of(new GoogleAppsCardV1Section().setWidgets(List.of(
                    new GoogleAppsCardV1Widget()
                        .setTextParagraph(new GoogleAppsCardV1TextParagraph()
                            .setText("Your avatar picture:")),
                    new GoogleAppsCardV1Widget()
                        .setImage(new GoogleAppsCardV1Image().setImageUrl(avatarUrl)))))))));
  }
}

    4. 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/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>gcfv2</groupId>
  <artifactId>avatar-app</artifactId>
  <version>0.0.1</version>
  <name>Avatar App</name>

  <properties>
    <maven.compiler.release>21</maven.compiler.release>
  </properties>

  <dependencies>
    <dependency>
      <groupId>com.google.cloud.functions</groupId>
      <artifactId>functions-framework-api</artifactId>
      <version>1.1.4</version>
    </dependency>

    <!-- https://mvnrepository.com/artifact/com.google.code.gson/gson -->
    <dependency>
      <groupId>com.google.code.gson</groupId>
      <artifactId>gson</artifactId>
      <version>2.12.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-rev20250116-2.0.0</version>
    </dependency>

  </dependencies>

</project>

    5. सेव करें और फिर से डिप्लॉय करें पर क्लिक करें.

Google Chat को आपके फ़ंक्शन को शुरू करने की अनुमति देना

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

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

    Cloud Run पर जाएं

  2. Cloud Run सेवाओं की सूची में, डेटा पाने वाले फ़ंक्शन के बगल में मौजूद चेकबॉक्स को चुनें. (फ़ंक्शन पर क्लिक न करें.)

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

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

  5. नए मुख्य खाते में, chat@system.gserviceaccount.com डालें.

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

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

ऐसे Chat ऐप्लिकेशन को कॉन्फ़िगर करना जो ऐड-ऑन नहीं है

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

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

    Cloud Run पर जाएं

    पक्का करें कि आपने Cloud Run के लिए वही प्रोजेक्ट चुना हो.

  2. सेवाओं की सूची में, quickstartchatapp पर क्लिक करें.

  3. सेवा की जानकारी पेज पर, फ़ंक्शन का यूआरएल कॉपी करें.

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

    Chat API पर जाएं

  5. कॉन्फ़िगरेशन पर क्लिक करें और ऐसे Chat ऐप्लिकेशन को सेट अप करें जो ऐड-ऑन नहीं है:

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

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