Pub/Sub की मदद से, फ़ायरवॉल से सुरक्षित Google Chat ऐप्लिकेशन बनाएं

इस पेज पर Pub/Sub का इस्तेमाल करके, Chat ऐप्लिकेशन बनाने का तरीका बताया गया है. Chat ऐप्लिकेशन के लिए इस तरह का आर्किटेक्चर तब काम आता है, जब आपके संगठन में फ़ायरवॉल हो. इससे Chat आपके Chat ऐप्लिकेशन पर मैसेज भेजने से रोक सकता है या Chat ऐप्लिकेशन Google Workspace इवेंट एपीआई का इस्तेमाल करता है. हालांकि, इस आर्किटेक्चर पर नीचे दी गई सीमाएं हैं. इसकी वजह यह है कि ये Chat ऐप्लिकेशन सिर्फ़ एसिंक्रोनस मैसेज भेज और पा सकते हैं:

  • मैसेज में डायलॉग का इस्तेमाल नहीं किया जा सकता. इसके बजाय, कार्ड मैसेज का इस्तेमाल करें.
  • सिंक्रोनस जवाब की मदद से, अलग-अलग कार्ड अपडेट नहीं किए जा सकते. इसके बजाय, patch तरीके को कॉल करके पूरे मैसेज को अपडेट करें.

नीचे दिया गया डायग्राम, Pub/Sub से बनाए गए चैट ऐप्लिकेशन का आर्किटेक्चर दिखाता है:

Pub/Sub के साथ लागू किए गए चैट ऐप्लिकेशन का आर्किटेक्चर.

पिछले डायग्राम में, Pub/Sub चैट ऐप्लिकेशन से इंटरैक्ट करने वाले उपयोगकर्ता को यह जानकारी दिखाई गई है:

  1. कोई उपयोगकर्ता Chat ऐप्लिकेशन को डायरेक्ट मैसेज या चैट स्पेस में मैसेज भेजता है. इसके अलावा, कोई इवेंट ऐसे चैट स्पेस में होता है जिसके लिए चैट ऐप्लिकेशन की सदस्यता चालू है.

  2. Chat, Pub/Sub के विषय पर मैसेज भेजता है.

  3. ऐप्लिकेशन सर्वर, जो क्लाउड या कंपनी की इमारत में बना सिस्टम होता है उसमें Chat ऐप्लिकेशन लॉजिक शामिल होता है. यह फ़ायरवॉल के ज़रिए मैसेज पाने के लिए, Pub/Sub विषय की सदस्यता लेता है.

  4. इसके अलावा, Chat ऐप्लिकेशन, Chat API को कॉल करके, एसिंक्रोनस तरीके से मैसेज पोस्ट कर सकता है या दूसरे काम कर सकता है.

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

Java

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

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

Pub/Sub सेट अप करना

  1. Pub/Sub के लिए एक ऐसा विषय बनाएं जिसमें Chat API मैसेज भेज सके. हमारा सुझाव है कि हर चैट ऐप्लिकेशन के लिए एक ही विषय का इस्तेमाल करें.

  2. इस सेवा खाते को Pub/Sub पब्लिशर की भूमिका असाइन करके, विषय के बारे में Chat को पब्लिश करने की अनुमति दें:

    chat-api-push@system.gserviceaccount.com
    
  3. Pub/Sub और Chat की मदद से अनुमति देने के लिए, Chat ऐप्लिकेशन के लिए एक सेवा खाता बनाएं. साथ ही, निजी कुंजी वाली फ़ाइल को अपनी वर्क डायरेक्ट्री में सेव करें.

  4. विषय के लिए पुल सदस्यता बनाएं.

  5. आपने पहले जो सेवा खाता बनाया था उसके लिए, सदस्यता के लिए Pub/Sub के सदस्य की भूमिका असाइन करें.

स्क्रिप्ट लिखें

Java

  1. सीएलआई में, सेवा खाते के क्रेडेंशियल दें:

    export GOOGLE_APPLICATION_CREDENTIALS=SERVICE_ACCOUNT_FILE_PATH
    
  2. अपनी वर्किंग डायरेक्ट्री में, pom.xml नाम की एक फ़ाइल बनाएं.

  3. 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.pubsub</groupId>
    <artifactId>java-pubsub-app</artifactId>
    <version>0.1.0</version>
    
    <name>java-pubsub-app</name>
    
    <properties>
      <maven.compiler.target>11</maven.compiler.target>
      <maven.compiler.source>11</maven.compiler.source>
    </properties>
    
    <dependencyManagement>
      <dependencies>
        <dependency>
          <groupId>com.google.cloud</groupId>
          <artifactId>libraries-bom</artifactId>
          <version>26.26.0</version>
          <type>pom</type>
          <scope>import</scope>
        </dependency>
      </dependencies>
    </dependencyManagement>
    
    <dependencies>
      <dependency>
        <groupId>com.google.code.gson</groupId>
        <artifactId>gson</artifactId>
        <version>2.9.1</version>
      </dependency>
      <dependency>
        <groupId>com.google.api-client</groupId>
        <artifactId>google-api-client</artifactId>
        <version>1.32.1</version>
      </dependency>
      <dependency>
        <groupId>com.google.cloud</groupId>
        <artifactId>google-cloud-pubsub</artifactId>
      </dependency>
      <dependency>
        <groupId>com.fasterxml.jackson.core</groupId>
        <artifactId>jackson-databind</artifactId>
        <version>2.14.2</version>
      </dependency>
    </dependencies>
    
    <build>
      <pluginManagement>
        <plugins>
          <plugin>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.8.0</version>
          </plugin>
        </plugins>
      </pluginManagement>
    </build>
    </project>
    
  4. अपनी वर्किंग डायरेक्ट्री में, src/main/java डायरेक्ट्री स्ट्रक्चर बनाएं.

  5. src/main/java डायरेक्ट्री में, Main.java नाम की फ़ाइल बनाएं.

  6. Main.java में, यह कोड चिपकाएं:

    import com.fasterxml.jackson.databind.JsonNode;
    import com.fasterxml.jackson.databind.ObjectMapper;
    import com.fasterxml.jackson.databind.node.JsonNodeFactory;
    import com.fasterxml.jackson.databind.node.ObjectNode;
    import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
    import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
    import com.google.api.client.http.ByteArrayContent;
    import com.google.api.client.http.GenericUrl;
    import com.google.api.client.http.HttpContent;
    import com.google.api.client.http.HttpRequest;
    import com.google.api.client.http.HttpRequestFactory;
    import com.google.api.client.http.HttpTransport;
    import com.google.cloud.pubsub.v1.AckReplyConsumer;
    import com.google.cloud.pubsub.v1.MessageReceiver;
    import com.google.cloud.pubsub.v1.Subscriber;
    import com.google.pubsub.v1.PubsubMessage;
    import com.google.pubsub.v1.ProjectSubscriptionName;
    import java.io.FileInputStream;
    import java.util.Collections;
    
    public class Main {
    
      public static final String CREDENTIALS_PATH_ENV_PROPERTY = "GOOGLE_APPLICATION_CREDENTIALS";
    
      // Google Cloud Project ID
      public static final String PROJECT_ID = PROJECT_ID;
    
      // Cloud Pub/Sub Subscription ID
      public static final String SUBSCRIPTION_ID = SUBSCRIPTION_ID
    
      public static void main(String[] args) throws Exception {
        ProjectSubscriptionName subscriptionName =
            ProjectSubscriptionName.of(PROJECT_ID, SUBSCRIPTION_ID);
    
        // Instantiate app, which implements an asynchronous message receiver.
        EchoApp echoApp = new EchoApp();
    
        // Create a subscriber for <var>SUBSCRIPTION_ID</var> bound to the message receiver
        final Subscriber subscriber =
            Subscriber.newBuilder(subscriptionName, echoApp).build();
        System.out.println("Starting subscriber...");
        subscriber.startAsync();
    
        // Wait for termination
        subscriber.awaitTerminated();
      }
    }
    
    / **
    * A demo app which implements {@link MessageReceiver} to receive messages. It simply echoes the
    * incoming messages.
    */
    class EchoApp implements MessageReceiver {
    
      // Path to the private key JSON file of the service account to be used for posting response
      // messages to Google Chat.
      // In this demo, we are using the same service account for authorizing with Cloud Pub/Sub to
      // receive messages and authorizing with Google Chat to post messages. If you are using
      // different service accounts, please set the path to the private key JSON file of the service
      // account used to post messages to Google Chat here.
      private static final String SERVICE_ACCOUNT_KEY_PATH =
          System.getenv(Main.CREDENTIALS_PATH_ENV_PROPERTY);
    
      // Developer code for Google Chat API scope.
      private static final String GOOGLE_CHAT_API_SCOPE = "https://www.googleapis.com/auth/chat.bot";
    
      // Response URL Template with placeholders for space id.
      private static final String RESPONSE_URL_TEMPLATE =
          "https://chat.googleapis.com/v1/__SPACE_ID__/messages";
    
      // Response echo message template.
      private static final String RESPONSE_TEMPLATE = "You said: `__MESSAGE__`";
    
      private static final String ADDED_RESPONSE = "Thank you for adding me!";
    
      GoogleCredential credential;
      HttpTransport httpTransport;
      HttpRequestFactory requestFactory;
    
      EchoApp() throws Exception {
        credential =
            GoogleCredential.fromStream(new FileInputStream(SERVICE_ACCOUNT_KEY_PATH))
                .createScoped(Collections.singleton(GOOGLE_CHAT_API_SCOPE));
        httpTransport = GoogleNetHttpTransport.newTrustedTransport();
        requestFactory = httpTransport.createRequestFactory(credential);
      }
    
      // Called when a message is received by the subscriber.
      @Override
      public void receiveMessage(PubsubMessage pubsubMessage, AckReplyConsumer consumer) {
        System.out.println("Id : " + pubsubMessage.getMessageId());
        // handle incoming message, then ack/nack the received message
        try {
          ObjectMapper mapper = new ObjectMapper();
          JsonNode dataJson = mapper.readTree(pubsubMessage.getData().toStringUtf8());
          System.out.println("Data : " + dataJson.toString());
          handle(dataJson);
          consumer.ack();
        } catch (Exception e) {
          System.out.println(e);
          consumer.nack();
        }
      }
    
      public void handle(JsonNode eventJson) throws Exception {
        JsonNodeFactory jsonNodeFactory = new JsonNodeFactory(false);
        ObjectNode responseNode = jsonNodeFactory.objectNode();
    
        // Construct the response depending on the event received.
    
        String eventType = eventJson.get("type").asText();
        switch (eventType) {
          case "ADDED_TO_SPACE":
            responseNode.put("text", ADDED_RESPONSE);
            // An app can also be added to a space by @mentioning it in a message. In that case, we fall
            // through to the MESSAGE case and let the app respond. If the app was added using the
            // invite flow, we just post a thank you message in the space.
            if(!eventJson.has("message")) {
              break;
            }
          case "MESSAGE":
            responseNode.put("text",
                RESPONSE_TEMPLATE.replaceFirst(
                    "__MESSAGE__", eventJson.get("message").get("text").asText()));
            // In case of message, post the response in the same thread.
            ObjectNode threadNode = jsonNodeFactory.objectNode();
            threadNode.put("name", eventJson.get("message").get("thread").get("name").asText());
            responseNode.put("thread", threadNode);
            break;
          case "REMOVED_FROM_SPACE":
          default:
            // Do nothing
            return;
        }
    
        // Post the response to Google Chat.
    
        String URI =
            RESPONSE_URL_TEMPLATE.replaceFirst(
                "__SPACE_ID__", eventJson.get("space").get("name").asText());
        GenericUrl url = new GenericUrl(URI);
    
        HttpContent content =
            new ByteArrayContent("application/json", responseNode.toString().getBytes("UTF-8"));
        HttpRequest request = requestFactory.buildPostRequest(url, content);
        com.google.api.client.http.HttpResponse response = request.execute();
      }
    }
    

    इन्हें बदलें:

    • PROJECT_ID: Google Cloud प्रोजेक्ट आईडी.
    • SUBSCRIPTION_ID: पहले बनाई गई Pub/Sub सदस्यता का सदस्यता आईडी.

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

  1. Google Cloud Console में, मेन्यू > एपीआई और सेवाएं > चालू एपीआई और सेवाएं > Google Chat API > कॉन्फ़िगरेशन पर जाएं.

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

  2. Pub/Sub के लिए, Chat ऐप्लिकेशन को कॉन्फ़िगर करना:

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

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

स्क्रिप्ट चलाएं

सीएलआई में, अपनी वर्क डायरेक्ट्री पर स्विच करें और स्क्रिप्ट चलाएं:

Java

mvn compile exec:java -Dexec.mainClass=Main

कोड चलाने पर ऐप्लिकेशन, Pub/Sub विषय पर पब्लिश किए गए मैसेज सुनना शुरू कर देता है.

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

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

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

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

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

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

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

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

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

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

    संसाधन मैनेजर पर जाएं

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