इस गाइड में बताया गया है कि Chat ऐप्लिकेशन की ओर से Google Chat API को ऐक्सेस करने के लिए, सेवा खाता कैसे सेट अप और इस्तेमाल करें. सबसे पहले इसमें सेवा खाता बनाने का तरीका बताया गया है. इसके बाद, इस स्क्रिप्ट में ऐसी स्क्रिप्ट लिखने का तरीका बताया गया है जो Chat API की मदद से पुष्टि करने और चैट स्पेस में मैसेज पोस्ट करने के लिए, सेवा खाते का इस्तेमाल करती है.
चैट ऐप्लिकेशन, Google Chat API को एसिंक्रोनस रूप से कॉल करते समय पुष्टि करने के लिए सेवा खातों का इस्तेमाल कर सकते हैं. इससे ये काम किए जा सकते हैं:
- Google Chat में
spaces.messages.create
का इस्तेमाल करके, इस नंबर पर मैसेज भेजें:- लंबे समय तक चलने वाले बैकग्राउंड जॉब के खत्म होने पर उपयोगकर्ताओं को सूचना दें.
- उपयोगकर्ताओं को सूचित करें कि सर्वर ऑफ़लाइन हो गया है.
- ग्राहक सहायता टीम से जुड़े किसी व्यक्ति को, ग्राहक के नए केस की जांच करने के लिए कहें.
spaces.messages.update
का इस्तेमाल करके, पहले भेजे गए मैसेज इसमें अपडेट करें:- जारी कार्रवाई की स्थिति बदलें.
- किसी टास्क को असाइन किए जाने की तारीख या उसे पूरा करने की तारीख अपडेट करें.
spaces.members.list
वाले स्पेस में उपयोगकर्ताओं को शामिल करें, ताकि:- देखें कि स्पेस में कौन है.
- यह पुष्टि करने के लिए कि स्पेस में टीम के सभी सदस्य शामिल हैं.
सेवा खाते से पुष्टि होने के बाद, किसी चैट स्पेस का डेटा पाने या उसमें कार्रवाइयां करने के लिए, उस स्पेस में चैट ऐप्लिकेशन की सदस्यता होनी चाहिए. उदाहरण के लिए, किसी स्पेस के सदस्यों को सूची में शामिल करने या स्पेस में मैसेज बनाने के लिए, यह ज़रूरी है कि Chat ऐप्लिकेशन खुद उस स्पेस का सदस्य हो.
अगर आपके Chat ऐप्लिकेशन को उपयोगकर्ता का डेटा ऐक्सेस करने या उसकी ओर से कार्रवाई करने की ज़रूरत है, तो उपयोगकर्ता के तौर पर पुष्टि करें.
अगर आप डोमेन एडमिन हैं, तो आपके पास किसी ऐप्लिकेशन के सेवा खाते को अपने उपयोगकर्ताओं का डेटा ऐक्सेस करने की अनुमति देने के लिए, पूरे डोमेन के लोगों को अपने-अपने अधिकार देने का अधिकार है. इसके लिए, हर उपयोगकर्ता से सहमति लेने की ज़रूरत नहीं होगी. पूरे डोमेन के लोगों को डेटा का ऐक्सेस देने की सुविधा कॉन्फ़िगर करने के बाद, किसी उपयोगकर्ता खाते की पहचान चुराने के लिए, अपने सेवा खाते का इस्तेमाल करके एपीआई कॉल किए जा सकते हैं. हालांकि, पुष्टि करने के लिए सेवा खाते का इस्तेमाल किया जाता है, लेकिन पूरे डोमेन के लोगों को डेटा का ऐक्सेस देने की सुविधा, किसी उपयोगकर्ता के नाम पर काम करती है. इसलिए, इसे उपयोगकर्ता की पुष्टि माना जाता है. ऐसे किसी भी फ़ंक्शन के लिए, पूरे डोमेन के लोगों को डेटा का ऐक्सेस दिया जा सकता है.
Chat ऐप्लिकेशन को पुष्टि करने की ज़रूरत कब पड़ती है और पुष्टि करने के लिए किस तरीके का इस्तेमाल किया जाता है, इस बारे में ज़्यादा जानने के लिए, Chat API की पुष्टि करने और अनुमति देने से जुड़ी खास जानकारी वाले सेक्शन में पुष्टि करने के ज़रूरी तरीके देखें.
ज़रूरी शर्तें
इस गाइड में दिए गए उदाहरण को इस्तेमाल करने के लिए, आपको इन ज़रूरी शर्तों को पूरा करना होगा:
- एक Google Workspace खाता, जिसमें Google Chat को ऐक्सेस किया जा सकता है.
- Google Cloud प्रोजेक्ट, जिसमें Chat API चालू हो. प्रोजेक्ट बनाने और एपीआई चालू करने के लिए, प्रोजेक्ट बनाना और एपीआई चालू करना देखें.
- पब्लिश किया गया कोई ऐसा Chat ऐप्लिकेशन, जिसमें चैट स्पेस में पैसे चुकाकर ली जाने वाली सदस्यता की सुविधा हो:
- चैट ऐप्लिकेशन बनाने और पब्लिश करने के लिए, Cloud Functions की मदद से Google Chat ऐप्लिकेशन बनाना देखें.
- चैट स्पेस में चैट ऐप्लिकेशन जोड़ने के लिए, Google Chat में स्पेस या बातचीत में ऐप्लिकेशन जोड़ना लेख पढ़ें.
इसके अलावा, आपको भाषा के हिसाब से इन ज़रूरी शर्तों को भी पूरा करना होगा:
Java
- JDK 1.7 या उसके बाद का वर्शन
- Maven पैकेज मैनेजमेंट टूल
शुरू किया गया Maven प्रोजेक्ट. नया प्रोजेक्ट शुरू करने के लिए, अपने कमांड-लाइन इंटरफ़ेस में नीचे दिए गए कमांड को चलाएं:
mvn archetype:generate -DgroupId=com.google.chat.app.authsample -DartifactId=auth-sample-app -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.4 -DinteractiveMode=false
Python
- Python 3.6 या इससे नया वर्शन
- pip पैकेज मैनेजमेंट टूल
Node.js
Apps Script
- आपके Google Cloud प्रोजेक्ट से कनेक्ट किया गया Apps Script प्रोजेक्ट. Apps Script प्रोजेक्ट को शुरू करने के लिए, Google Apps Script Chat ऐप्लिकेशन का क्विकस्टार्ट लेख देखें.
पहला चरण: Google Cloud Console में सेवा खाता बनाना
ऐसा सेवा खाता बनाएं जिसका इस्तेमाल आपका Chat ऐप्लिकेशन, Google API को ऐक्सेस करने के लिए कर सके.
सेवा खाता बनाना
सेवा खाता बनाने के लिए, यह तरीका अपनाएं:
Google Cloud कंसोल
- Google Cloud Console में, मेन्यू > IAM और एडमिन > सेवा खाते पर जाएं.
- सेवा खाता बनाएं पर क्लिक करें.
- सेवा खाते की जानकारी भरें. इसके बाद, बनाएं और जारी रखें पर क्लिक करें.
- ज़रूरी नहीं: Google Cloud प्रोजेक्ट के संसाधनों का ऐक्सेस देने के लिए, अपने सेवा खाते में भूमिकाएं असाइन करें. ज़्यादा जानकारी के लिए, संसाधनों का ऐक्सेस देना, उसमें बदलाव करना, और उसे वापस लेना लेख पढ़ें.
- जारी रखें पर क्लिक करें.
- ज़रूरी नहीं: ऐसे उपयोगकर्ताओं या ग्रुप के नाम डालें जो इस सेवा खाते की मदद से, कार्रवाइयों को मैनेज और कर सकें. ज़्यादा जानकारी के लिए, सेवा खाते के नाम पर काम करने को मैनेज करना लेख पढ़ें.
- हो गया पर क्लिक करें. सेवा खाते के ईमेल पते को नोट कर लें.
gcloud सीएलआई
- सेवा खाता बनाएं:
gcloud iam service-accounts create
SERVICE_ACCOUNT_NAME
\ --display-name="SERVICE_ACCOUNT_NAME
" - ज़रूरी नहीं: Google Cloud प्रोजेक्ट के संसाधनों का ऐक्सेस देने के लिए, अपने सेवा खाते में भूमिकाएं असाइन करें. ज़्यादा जानकारी के लिए, संसाधनों का ऐक्सेस देना, उसमें बदलाव करना, और उसे वापस लेना लेख पढ़ें.
सेवा खाता, सेवा खाते वाले पेज पर दिखता है. इसके बाद, सेवा खाते के लिए एक निजी पासकोड बनाएं.
निजी पासकोड बनाएं
सेवा खाते के लिए निजी पासकोड बनाने और डाउनलोड करने के लिए, यह तरीका अपनाएं:
- Google Cloud Console में, मेन्यू > IAM और एडमिन > सेवा खाते पर जाएं.
- सेवा खाता चुनें.
- बटन > कुंजी जोड़ें > नई कुंजी बनाएं पर क्लिक करें.
- JSON चुनें, फिर बनाएं पर क्लिक करें.
आपकी नई सार्वजनिक/निजी कुंजी का जोड़ा जनरेट करके, आपके कंप्यूटर पर नई फ़ाइल के तौर पर डाउनलोड किया जाता है. डाउनलोड की गई JSON फ़ाइल को अपनी मौजूदा डायरेक्ट्री में
credentials.json
के तौर पर सेव करें. यह फ़ाइल इस कुंजी की अकेली कॉपी है. अपनी कुंजी को सुरक्षित तरीके से सेव करने के बारे में जानकारी के लिए, सेवा खाता कुंजियां मैनेज करना देखें. - बंद करें पर क्लिक करें.
सेवा खातों के बारे में ज़्यादा जानकारी के लिए, Google Cloud IAM दस्तावेज़ में सेवा खाते देखें.
दूसरा चरण: Google क्लाइंट लाइब्रेरी और अन्य डिपेंडेंसी इंस्टॉल करना
प्रोजेक्ट के लिए ज़रूरी Google क्लाइंट लाइब्रेरी और अन्य डिपेंडेंसी इंस्टॉल करें.
Java
अपने Maven प्रोजेक्ट में Google क्लाइंट लाइब्रेरी और अन्य ज़रूरी डिपेंडेंसी जोड़ने के लिए, अपने प्रोजेक्ट की डायरेक्ट्री में मौजूद pom.xml
फ़ाइल में बदलाव करें और ये डिपेंडेंसी जोड़ें:
<dependencies>
<!-- ... existing dependencies ... -->
<dependency>
<groupId>com.google.apis</groupId>
<artifactId>google-api-services-chat</artifactId>
<version>v1-rev20230905-2.0.0</version>
</dependency>
<dependency>
<groupId>com.google.auth</groupId>
<artifactId>google-auth-library-oauth2-http</artifactId>
<version>1.19.0</version>
</dependency>
<dependency>
<groupId>com.google.code.gson</groupId>
<artifactId>gson</artifactId>
<version>2.10.1</version>
</dependency>
</dependencies>
Python
अगर आपने पहले से Python के लिए Google क्लाइंट लाइब्रेरी इंस्टॉल नहीं की है, तो अपने कमांड-लाइन इंटरफ़ेस में यह कमांड चलाएं:
pip3 install --upgrade google-api-python-client google-auth
Node.js
Google क्लाइंट लाइब्रेरी को अपने Node.js प्रोजेक्ट में जोड़ने के लिए, अपने प्रोजेक्ट की डायरेक्ट्री पर स्विच करें और अपने कमांड-लाइन इंटरफ़ेस में यहां दिया गया कमांड चलाएं:
npm install "@googleapis/chat"
Apps Script
यह नमूना Apps Script लाइब्रेरी के लिए OAuth2 का इस्तेमाल करता है, ताकि सेवा खाते की पुष्टि करने के लिए JWT टोकन जनरेट किया जा सके. अपने Apps Script प्रोजेक्ट में लाइब्रेरी जोड़ने के लिए:
- बाईं ओर, एडिटर पर क्लिक करें.
- बाईं ओर, लाइब्रेरी के बगल में, लाइब्रेरी जोड़ें पर क्लिक करें .
- स्क्रिप्ट आईडी
1B7FSrk5Zi6L1rSxxTDgDEUsPzlukDsi4KGuTMorsTQHhGBzBkMun4iDF
डालें. - लुक अप पर क्लिक करें. इसके बाद, जोड़ें पर क्लिक करें.
यह सैंपल, Google Chat API को कॉल करने के लिए, ऐडवांस चैट सेवा का इस्तेमाल करता है. अपने Apps Script प्रोजेक्ट के लिए, सेवा चालू करने के लिए:
- बाईं ओर, एडिटर पर क्लिक करें.
- बाईं ओर, सेवाएं के बगल में, सेवा जोड़ें पर क्लिक करें.
- Google Chat API चुनें.
- वर्शन में, v1 चुनें.
- जोड़ें पर क्लिक करें.
हमारी क्लाइंट लाइब्रेरी के साथ काम करने वाली किसी भी भाषा का इस्तेमाल किया जा सकता है.
तीसरा चरण: एक ऐसी स्क्रिप्ट लिखें जो Chat API से पुष्टि करने के लिए, सेवा खाते का इस्तेमाल करती हो
नीचे दिया गया कोड, सेवा खाते का इस्तेमाल करके Chat API की मदद से पुष्टि करता है. इसके बाद, चैट स्पेस में मैसेज पोस्ट करता है:
Java
- अपने प्रोजेक्ट की डायरेक्ट्री में,
src/main/java/com/google/chat/app/authsample/App.java
फ़ाइल खोलें. App.java
की सामग्री को इस कोड से बदलें:package com.google.chat.app.authsample; import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport; import com.google.api.client.http.HttpRequestInitializer; import com.google.api.client.json.gson.GsonFactory; import com.google.api.services.chat.v1.HangoutsChat; import com.google.api.services.chat.v1.model.Message; import com.google.auth.http.HttpCredentialsAdapter; import com.google.auth.oauth2.GoogleCredentials; /** * Authenticates with Chat API via service account credentials, * then creates a Chat message. */ public class App { // Specify required scopes. private static final String CHAT_SCOPE = "https://www.googleapis.com/auth/chat.bot"; // Specify service account details. private static final String PRIVATE_KEY_RESOURCE_URI = "/credentials.json"; public static void main( String[] args ) { try { // Run app. Message response = App.createChatMessage(); // Print details about the created message. System.out.println(response); } catch (Exception e) { e.printStackTrace(); } } private static Message createChatMessage() throws Exception { // Build the Chat API client and authenticate with the service account. GoogleCredentials credentials = GoogleCredentials.fromStream( App.class.getResourceAsStream(PRIVATE_KEY_RESOURCE_URI)) .createScoped(CHAT_SCOPE); HttpRequestInitializer requestInitializer = new HttpCredentialsAdapter(credentials); HangoutsChat chatService = new HangoutsChat.Builder( GoogleNetHttpTransport.newTrustedTransport(), GsonFactory.getDefaultInstance(), requestInitializer) .setApplicationName("auth-sample-app") .build(); // The space to create the message in. // // Replace SPACE_NAME with a space name. // Obtain the space name from the spaces resource of Chat API, // or from a space's URL. String spaceName = "spaces/SPACE_NAME"; // Create a Chat message. Message message = new Message().setText("Hello, world!"); return chatService.spaces().messages().create(spaceName, message).execute(); } }
कोड में,
SPACE_NAME
को स्पेस का नाम दें. यह नाम, Chat API मेंspaces.list
तरीके से या स्पेस के यूआरएल से लिया जा सकता है.अपने प्रोजेक्ट की डायरेक्ट्री में,
resources
नाम की एक नई सबडायरेक्ट्री बनाएं.पक्का करें कि आपके सेवा खाते के लिए, निजी पासकोड की फ़ाइल का नाम
credentials.json
हो. इसके बाद, उसेresources
सबडायरेक्ट्री में कॉपी करें.प्रोजेक्ट पैकेज में निजी कुंजी फ़ाइल को शामिल करने के लिए, Maven को कॉन्फ़िगर करने के लिए, अपने प्रोजेक्ट की डायरेक्ट्री में मौजूद
pom.xml
फ़ाइल में बदलाव करें और<build>
सेक्शन में यह कॉन्फ़िगरेशन जोड़ें:<build> <!-- ... existing configurations ... --> <resources> <resource> <directory>resources</directory> </resource> </resources> </build>
प्रोजेक्ट पैकेज में डिपेंडेंसी शामिल करने और अपने ऐप्लिकेशन की मुख्य क्लास को एक्ज़ीक्यूट करने के लिए Maven को कॉन्फ़िगर करें. इसके लिए, अपने प्रोजेक्ट की डायरेक्ट्री में
pom.xml
फ़ाइल में बदलाव करें और<plugins>
सेक्शन में यह कॉन्फ़िगरेशन जोड़ें:<plugins> <!-- ... existing configurations ... --> <plugin> <artifactId>maven-assembly-plugin</artifactId> <configuration> <archive> <manifest> <mainClass>com.google.chat.app.authsample.App</mainClass> </manifest> </archive> <descriptorRefs> <descriptorRef>jar-with-dependencies</descriptorRef> </descriptorRefs> </configuration> </plugin> </plugins>
Python
- अपनी वर्किंग डायरेक्ट्री में,
chat_app_auth.py
नाम की फ़ाइल बनाएं. chat_app_auth.py
में यह कोड शामिल करें:from apiclient.discovery import build from google.oauth2 import service_account # Specify required scopes. SCOPES = ['https://www.googleapis.com/auth/chat.bot'] # Specify service account details. CREDENTIALS = service_account.Credentials.from_service_account_file( 'credentials.json', scopes=SCOPES) # Build the URI and authenticate with the service account. chat = build('chat', 'v1', credentials=CREDENTIALS) # Create a Chat message. result = chat.spaces().messages().create( # The space to create the message in. # # Replace SPACE_NAME with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. parent='spaces/SPACE_NAME', # The message to create. body={'text': 'Hello, world!'} ).execute() # Prints details about the created message. print(result)
कोड में,
SPACE_NAME
को स्पेस का नाम दें. यह नाम, Chat API मेंspaces.list
तरीके से या स्पेस के यूआरएल से लिया जा सकता है. पक्का करें कि आपके सेवा खाते की निजी कुंजी फ़ाइल का नामcredentials.json
हो.
Node.js
- अपने प्रोजेक्ट की डायरेक्ट्री में,
chat_app_auth.js
नाम की फ़ाइल बनाएं. chat_app_auth.js
में यह कोड शामिल करें:const chat = require('@googleapis/chat'); async function createMessage() { const auth = new chat.auth.GoogleAuth({ // Specify service account details. keyFilename: 'credentials.json', // Specify required scopes. scopes: ['https://www.googleapis.com/auth/chat.bot'] }); const authClient = await auth.getClient(); // Create the Chat API client and authenticate with the service account. const chatClient = await chat.chat({ version: 'v1', auth: authClient }); // Create a Chat message. const result = await chatClient.spaces.messages.create({ // The space to create the message in. // // Replace SPACE_NAME with a space name. // Obtain the space name from the spaces resource of Chat API, // or from a space's URL. parent: 'spaces/SPACE_NAME', // The message to create. requestBody: { 'text': 'Hello, world!' } }); return result; } // Execute function then print details about the created message. createMessage().then(console.log);
कोड में,
SPACE_NAME
को स्पेस का नाम दें. यह नाम, Chat API मेंspaces.list
तरीके से या स्पेस के यूआरएल से लिया जा सकता है. पक्का करें कि आपके सेवा खाते की निजी कुंजी फ़ाइल का नामcredentials.json
हो.
Apps Script
Apps Script एडिटर में,
appsscript.json
फ़ाइल में बदलाव करें. साथ ही, सेवा खाते का OAuth टोकन पाने के लिए बाहरी अनुरोध करने के लिए, ज़रूरी OAuth स्कोप जोड़ें:"oauthScopes": [ "https://www.googleapis.com/auth/script.external_request" ]
नीचे दिए गए कोड को अपने Apps Script प्रोजेक्ट में
ChatAppAuth.gs
नाम की फ़ाइल में सेव करें:// Specify the contents of the file credentials.json. const CREDENTIALS = CREDENTIALS; const SCOPE = 'https://www.googleapis.com/auth/chat.bot'; // The space to create the message in. // // Replace SPACE_NAME with a space name. // Obtain the space name from the spaces resource of Chat API, // or from a space's URL. const PARENT = 'spaces/SPACE_NAME' /** * Authenticates with Chat API via app credentials, then posts a message. */ function createMessageWithAppCredentials() { try { const service = getService_(); if (!service.hasAccess()) { console.error(service.getLastError()); return; } // Specify the message to create. const message = {'text': 'Hello world!'}; // Call Chat API with a service account to create a message. const result = Chat.Spaces.Messages.create( message, PARENT, {}, // Authenticate with the service account token. {'Authorization': 'Bearer ' + service.getAccessToken()}); // Log details about the created message. console.log(result); } catch (err) { // TODO (developer) - Handle exception. console.log('Failed to create message with error %s', err.message); } } /** * Configures the OAuth library to authenticate with the service account. */ function getService_() { return OAuth2.createService(CREDENTIALS.client_email) .setTokenUrl('https://oauth2.googleapis.com/token') .setPrivateKey(CREDENTIALS.private_key) .setIssuer(CREDENTIALS.client_email) .setSubject(CREDENTIALS.client_email) .setScope(SCOPE) .setPropertyStore(PropertiesService.getScriptProperties()); }
कोड में,
CREDENTIALS
कोcredentials.json
फ़ाइल के कॉन्टेंट से बदल दें.कोड में,
SPACE_NAME
को स्पेस का नाम दें. यह नाम, Chat API मेंspaces.list
तरीके से या स्पेस के यूआरएल से लिया जा सकता है.
चौथा चरण: पूरा उदाहरण चलाएं
अपनी वर्किंग डायरेक्ट्री में, सैंपल बनाएं और चलाएं:
Java
mvn compile assembly:single
java -jar target/auth-sample-app-1.0-SNAPSHOT-jar-with-dependencies.jar
Python
python3 chat_app_auth.py
Node.js
node chat_app_auth.js
Apps Script
Apps Script एडिटर में ChatAppAuth.gs
फ़ाइल खोलें और
Run पर क्लिक करें.
आपकी स्क्रिप्ट, Chat API को पुष्टि करने के लिए एक अनुरोध भेजती है. यह अनुरोध, चैट स्पेस में Chat ऐप्लिकेशन के तौर पर मैसेज पोस्ट करके जवाब देता है.
उदाहरण के तौर पर दी गई समस्या को हल करना
इस सेक्शन में, उन आम समस्याओं के बारे में बताया गया है जो इस सैंपल को चलाने की कोशिश करते समय आ सकती हैं.
आपको इस ऐप्लिकेशन का इस्तेमाल करने की अनुमति नहीं है
स्क्रिप्ट चलाते समय, आपको गड़बड़ी का यह मैसेज मिल सकता है:
<HttpError 403 when requesting https://chat.googleapis.com/v1/spaces/{space}/messages?alt=json returned "You are not permitted to use this app". Details: "You are not permitted to use this app">
गड़बड़ी के इस मैसेज का मतलब है कि Chat ऐप्लिकेशन को, बताए गए चैट स्पेस में चैट मैसेज बनाने की अनुमति नहीं है.
गड़बड़ी को ठीक करने के लिए, स्क्रिप्ट में दिए गए चैट ऐप्लिकेशन को चैट स्पेस में जोड़ें.
मिलते-जुलते विषय
यह जानने के लिए कि Chat API, और क्या-क्या कर सकता है, Chat API का रेफ़रंस दस्तावेज़ पढ़ें.