Google Chat API को कॉन्फ़िगर करना

आपके बनाए गए हर Google Chat ऐप्लिकेशन के लिए, अपना Google Cloud प्रोजेक्ट होना ज़रूरी है. साथ ही, उस प्रोजेक्ट में Chat API चालू और कॉन्फ़िगर होना चाहिए.

उपयोगकर्ता की पुष्टि के साथ रीड-ओनली एपीआई कॉल करने के लिए, आपको सिर्फ़ एपीआई चालू करना और OAuth क्लाइंट बनाना होगा. जैसे, स्पेस और मैसेज की सूची पाना.

एपीआई कॉल बनाने, अपडेट करने, और मिटाने के लिए या इंटरैक्टिव Chat ऐप्लिकेशन को डिप्लॉय और टेस्ट करने के लिए, आपको Chat API को भी कॉन्फ़िगर करना होगा. इंटरैक्टिव Chat ऐप्लिकेशन, Google Workspace ऐड-ऑन के तौर पर बनाया जाता है. इससे Chat की सुविधाओं को बेहतर बनाया जा सकता है. Chat API की कॉन्फ़िगरेशन सेटिंग में, Chat ऐप्लिकेशन के बारे में पूरी जानकारी दी जाती है. इसमें डिसप्ले नेम, अवतार, डिप्लॉयमेंट एंडपॉइंट, और इंटरैक्टिव सुविधाएं शामिल हैं.

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

अपने चैट ऐप्लिकेशन के लिए डिसप्ले नेम, अवतार, और ब्यौरा चुनना

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

किसी चैट ऐप्लिकेशन को कॉन्फ़िगर करने से पहले, यह जानकारी तैयार करें:

फ़ील्ड ब्यौरा फ़ॉर्मैट
ऐप्लिकेशन का नाम Chat ऐप्लिकेशन का डिसप्ले नेम. ज़्यादा से ज़्यादा 25 अक्षर और अंक
अवतार का यूआरएल वह इमेज जो आपके चैट ऐप्लिकेशन के अवतार के तौर पर दिखती है. स्क्वेयर ग्राफ़िक्स इमेज (PNG या JPEG) पर ले जाने वाला एचटीटीपीएस यूआरएल. हमारा सुझाव है कि इमेज का साइज़ 256 x 256 पिक्सल या इससे ज़्यादा हो.
ब्यौरा Chat ऐप्लिकेशन के बारे में कम शब्दों में दी गई जानकारी. यह जानकारी तब दिखती है, जब उपयोगकर्ता Chat में ऐप्लिकेशन खोजते हैं. ज़्यादा से ज़्यादा 40 अक्षर और अंक
पूरी जानकारी ज़रूरी नहीं. चैट ऐप्लिकेशन क्या कर सकता है, इसकी जानकारी. यह जानकारी तब दिखती है, जब उपयोगकर्ता चैट ऐप्लिकेशन के साथ बातचीत शुरू करते हैं या किसी एजेंट के लिए सेशन का होम पेज खोलते हैं. फ़िलहाल, यह सुविधा सिर्फ़ Google Cloud Console का इस्तेमाल करके ऐप्लिकेशन कॉन्फ़िगरेशन को अपडेट करने पर काम करती है. यह Google Workspace ऐड-ऑन एपीआई के ज़रिए काम नहीं करती. ज़्यादा से ज़्यादा 250 वर्ण

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

उदाहरण के लिए, अगर spaces.create() तरीके को कॉल किया जाता है, तो Chat, स्पेस बनाने वाले व्यक्ति की जानकारी में Chat ऐप्लिकेशन का नाम शामिल करता है. जैसा कि इस इमेज में दिखाया गया है:

Google Chat ऐप्लिकेशन, किसी उपयोगकर्ता के लिए स्पेस बनाता है.
पहली इमेज. जब किसी उपयोगकर्ता की ओर से स्पेस बनाने के लिए, spaces.create() तरीके का इस्तेमाल किया जाता है, तब Chat में दिखने वाला एट्रिब्यूशन मैसेज.

Chat ऐप्लिकेशन से इंटरैक्ट करने के लिए, उपयोगकर्ता इस जानकारी को इन तरीकों से भी देखते या इस्तेमाल करते हैं:

  • किसी चैट ऐप्लिकेशन को स्पेस में जोड़ने या उसे मैसेज भेजने के लिए, उसे @mention करें.
  • Chat ऐप्लिकेशन को ढूंढें और उसे डायरेक्ट मैसेज भेजें. ऐप्लिकेशन मेन्यू में, डायरेक्ट मैसेज में Chat ऐप्लिकेशन का नाम और अवतार दिखता है.
  • लिखने के लिए बार से, उपयोगकर्ता Chat ऐप्लिकेशन ब्राउज़ कर सकते हैं. साथ ही, उनका नाम, अवतार, और ब्यौरा देख सकते हैं.

Google Cloud Console में अपना चैट ऐप्लिकेशन कॉन्फ़िगर करना

Chat ऐप्लिकेशन की जानकारी मिलने के बाद, अपना Cloud प्रोजेक्ट खोलें और Chat API को कॉन्फ़िगर करें:

  1. Google Cloud console में, Chat API पेज पर जाएं और कॉन्फ़िगरेशन पेज पर क्लिक करें:

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

  2. ऐप्लिकेशन की जानकारी में जाकर, ऐप्लिकेशन का नाम, अवतार का यूआरएल, और ब्यौरा फ़ील्ड भरें.

  3. ज़रूरी नहीं: ज़्यादा जानकारी फ़ील्ड भरें.

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

  5. इंटरैक्टिव सुविधाएं में जाकर, यह कॉन्फ़िगर करें कि आपका चैट ऐप्लिकेशन, उपयोगकर्ता के इंटरैक्शन का जवाब दे या नहीं:

    इंटरैक्टिव Chat ऐप्लिकेशन बनाने के लिए, इंटरैक्टिव सुविधाएं चालू करें को चालू करें और ये काम करें:

    1. फ़ंक्शन में जाकर:
      • ज़रूरी नहीं: Chat ऐप्लिकेशन के साथ की गई सीधी बातचीत के होम टैब में होम पेज कार्ड दिखाने के लिए, ऐप्लिकेशन के होम पेज पर सहायता उपलब्ध कराएं को चुनें.
      • अपने Chat ऐप्लिकेशन को इंस्टॉल और इस्तेमाल करने के लिए, स्पेस और ग्रुप बातचीत में शामिल हों को चुनें. डिफ़ॉल्ट रूप से, उपयोगकर्ता Chat ऐप्लिकेशन को इंस्टॉल कर सकते हैं और उससे मैसेज पर बातचीत कर सकते हैं. इसके लिए, उपयोगकर्ता और Chat ऐप्लिकेशन के बीच एक स्पेस बनाया जाता है. उपयोगकर्ता, कई लोगों वाले स्पेस में भी Chat ऐप्लिकेशन को जोड़ सकते हैं और उससे इंटरैक्ट कर सकते हैं.
    2. कनेक्शन सेटिंग में जाकर, वह आर्किटेक्चर चुनें जिसका इस्तेमाल करके आपको Chat से इवेंट ऑब्जेक्ट पाने हैं:

      • एचटीटीपी सेवा का इस्तेमाल करने के लिए, एचटीटीपी एंडपॉइंट यूआरएल चुनें और यूआरएल डालें.
      • Google Apps Script प्रोजेक्ट का इस्तेमाल करने के लिए, Apps Script को चुनें और प्रोजेक्ट के लिए डिप्लॉयमेंट आईडी दें.
      • Dialogflow एजेंट का इस्तेमाल करने के लिए, Dialogflow को चुनें. इसके बाद, Dialogflow CX या Dialogflow ES को चुनें और एजेंट के संसाधन का नाम डालें.
      • Pub/Sub का इस्तेमाल करने के लिए, Cloud Pub/Sub को चुनें और विषय का नाम डालें.
    3. ज़रूरी नहीं: इवेंट ऑब्जेक्ट को खास एंडपॉइंट या फ़ंक्शन पर रूट करने के लिए, कनेक्शन सेटिंग > ट्रिगर पर जाएं. इसके बाद, यहां दिए गए Chat ट्रिगर के लिए, कॉलबैक एंडपॉइंट या फ़ंक्शन दें या उन्हें अपडेट करें:

      • ऐप्लिकेशन का होम पेज (अगर ऐप्लिकेशन के होम पेज पर जाने की सुविधा चालू है): कोई उपयोगकर्ता, Chat ऐप्लिकेशन के साथ सीधी बातचीत में होम टैब खोलता है.
      • स्पेस में जोड़ा गया: कोई उपयोगकर्ता, Chat ऐप्लिकेशन को किसी ग्रुप बातचीत या स्पेस में जोड़ता है या वन-टू-वन मैसेज के लिए Chat ऐप्लिकेशन इंस्टॉल करता है.
      • मैसेज: कोई उपयोगकर्ता, Chat ऐप्लिकेशन को मैसेज भेजता है. उदाहरण के लिए, कोई उपयोगकर्ता Chat ऐप्लिकेशन को डायरेक्ट मैसेज भेजता है या कई लोगों वाले स्पेस में Chat ऐप्लिकेशन को @टैग करता है.
      • स्पेस से हटाया गया: कोई उपयोगकर्ता, किसी स्पेस से Chat ऐप्लिकेशन को अनइंस्टॉल करता है या हटाता है.
      • ऐप्लिकेशन कमांड: उपयोगकर्ता, Chat ऐप्लिकेशन से क्विक कमांड, स्लैश कमांड या मैसेज ऐक्शन को ट्रिगर करता है.
    4. ज़रूरी नहीं: इंटरैक्टिव बनाने वाली अन्य सुविधाएं जोड़ें. जैसे, सेशन, स्टार्टर प्रॉम्प्ट, कमांड (क्विक कमांड, स्लैश कमांड, और मैसेज पर की जाने वाली कार्रवाइयां) या लिंक की झलक.

    5. किसके लिए उपलब्ध है सेक्शन में जाकर, इस Chat ऐप्लिकेशन को चुनिंदा लोगों और ग्रुप के लिए उपलब्ध कराएं को चुनें. इसके बाद, अपने Google Workspace संगठन में मौजूद लोगों या Google ग्रुप के ईमेल पते डालें:

      • ऐप्लिकेशन को खुद इंस्टॉल और टेस्ट करने के लिए, अपना ईमेल पता डालें.
      • किसी संगठन में काम करने वालों के लिए बनाए गए Chat ऐप्लिकेशन को, Marketplace पर पब्लिश किए बिना पूरी टीम या संगठन के साथ शेयर करने के लिए, एक या उससे ज़्यादा Google ग्रुप डालें. ग्रुप में सदस्यों की संख्या की कोई सीमा नहीं होती. अगर आपका ऐप्लिकेशन chat.app.* स्कोप का अनुरोध करता है, तो आपको एडमिन की मंज़ूरी के लिए, अब भी ऐप्लिकेशन को पब्लिश करना होगा.
      • अगर आपके एडमिन ने Marketplace से सिर्फ़ अनुमति वाली सूची में शामिल ऐप्लिकेशन इंस्टॉल करने की अनुमति दी है, तो Google Cloud Console इस फ़ील्ड को डेवलपमेंट के लिए, पांच उपयोगकर्ताओं के ईमेल पतों तक सीमित कर देता है. ग्रुप को ऐप्लिकेशन दिखने की सुविधा, एडमिन के ऐप्लिकेशन को अनुमति वाली सूची में जोड़ने के बाद ही लागू होती है.
  6. ज़रूरी नहीं: Google Cloud Logging का इस्तेमाल करने के लिए, लॉग में जाकर, लॉगिंग में गड़बड़ियों को लॉग करें चेकबॉक्स को चुनें. ज़्यादा जानकारी के लिए, Chat ऐप्लिकेशन के लिए गड़बड़ी के लॉग के बारे में क्वेरी करना लेख पढ़ें.

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

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

Google Cloud CLI का इस्तेमाल करके, अपने चैट ऐप्लिकेशन को कॉन्फ़िगर करना

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

gcloud beta workspace-add-ons chat-app-config कमांड ग्रुप में ये कमांड शामिल हैं:

  • describe: इससे कॉन्फ़िगरेशन दिखता है.
  • update: पहली बार किसी चैट ऐप्लिकेशन को कॉन्फ़िगर करता है या उसके कॉन्फ़िगरेशन में बदलाव करता है.

ये कमांड, Google Workspace ऐड-ऑन एपीआई में chatAppConfig रिसॉर्स का इस्तेमाल करते हैं.

शुरू करने से पहले

  1. gcloud सीएलआई इंस्टॉल करें. अगर आपने gcloud सीएलआई को पहले इंस्टॉल किया था, तो पक्का करें कि आपके पास इसका नया वर्शन हो. इसके लिए, gcloud components update चलाएं.
  2. अपने उपयोगकर्ता खाते से gcloud सीएलआई में साइन इन करें. इन निर्देशों का इस्तेमाल, सेवा खातों के लिए नहीं किया जा सकता.

    gcloud auth login
  3. अपने Chat ऐप्लिकेशन के क्लाउड प्रोजेक्ट को gcloud सीएलआई के डिफ़ॉल्ट प्रोजेक्ट के तौर पर सेट करें. प्रोजेक्ट आईडी का इस्तेमाल करें, क्योंकि कमांड में प्रोजेक्ट नंबर स्वीकार नहीं किया जाता.

    gcloud config set project PROJECT_ID

    इसके अलावा, हर निर्देश में --project फ़्लैग जोड़ें.

  4. Cloud प्रोजेक्ट में Google Workspace ऐड-ऑन एपीआई चालू करें:

    gcloud services enable gsuiteaddons.googleapis.com
  5. पक्का करें कि आपके पास क्लाउड प्रोजेक्ट पर, पहचान और ऐक्सेस मैनेजमेंट (आईएएम) की ये भूमिकाएं हों:

    • कॉन्फ़िगरेशन देखने और अपडेट करने के लिए, Google Workspace ऐड-ऑन डेवलपर (roles/gsuiteaddons.developer) या सिर्फ़ देखने के लिए, Google Workspace ऐड-ऑन रीडर (roles/gsuiteaddons.reader). इन भूमिकाओं में वे अनुमतियां शामिल होती हैं जो ज़रूरी शर्तें और पुष्टि में दी गई हैं.
    • Service Usage Consumer (roles/serviceusage.serviceUsageConsumer). gcloud सीएलआई, अपने अनुरोधों के लिए क्लाउड प्रोजेक्ट को कोटा प्रोजेक्ट के तौर पर इस्तेमाल करता है. इसके लिए, serviceusage.services.use अनुमति की ज़रूरत होती है.

    मालिक और एडिटर की भूमिकाओं में ये सभी अनुमतियां शामिल होती हैं. चैट ऐप्लिकेशन के मालिक और चैट ऐप्लिकेशन के दर्शक की भूमिकाएं, Google Cloud Console में कॉन्फ़िगरेशन पेज का ऐक्सेस देती हैं. हालांकि, ये भूमिकाएं काफ़ी नहीं हैं.

कॉन्फ़िगरेशन देखना

अपने Chat ऐप्लिकेशन का कॉन्फ़िगरेशन देखने के लिए, describe कमांड चलाएं:

gcloud beta workspace-add-ons chat-app-config describe

आउटपुट कुछ ऐसा दिखता है:

avatarUri: https://www.gstatic.com/dynamite/images/quickstart-app-avatar.png
description: Helps manage tasks and schedules
displayName: Cymbal Assistant
errorLoggingEnabled: true
interactiveFeatureConfig:
  allowlistedTestingPrincipals:
  - user@example.com
  appCommands:
  - command: /help
    commandId: 1
    commandType: SLASH_COMMAND
    description: Show available commands
  connectionConfig:
    httpEndpointConfig:
      commonUrl: https://example.com/chat
  supportsMultiuserSpaces: true
  urlPatterns:
  - hostPattern: example.com
    pathPrefix: tasks/
name: projects/123456789012/chatAppConfig
state: ACTIVE

अगर Cloud प्रोजेक्ट में अब तक कोई Chat ऐप्लिकेशन नहीं है, तो कमांड काम करता है और कॉन्फ़िगरेशन का सिर्फ़ name फ़ील्ड प्रिंट करता है:

name: projects/123456789012/chatAppConfig

आउटपुट बदलने के लिए, इनमें से कोई एक फ़्लैग जोड़ें:

  • --format=json: कॉन्फ़िगरेशन को JSON फ़ॉर्मैट में प्रिंट करता है.
  • --view=basic: इंटरैक्टिव सुविधा की सेटिंग (interactiveFeatureConfig) को छोड़ देता है.
  • --format="value(displayName)": सिर्फ़ डिसप्ले नेम प्रिंट करता है. अगर Cloud प्रोजेक्ट में अब तक कोई Chat ऐप्लिकेशन नहीं है, तो खाली लाइन प्रिंट करता है. कॉन्फ़िगर किए गए चैट ऐप्लिकेशन का हमेशा एक डिसप्ले नेम होता है. इसलिए, किसी स्क्रिप्ट में इस फ़्लैग का इस्तेमाल करके यह पता लगाया जा सकता है कि कोई चैट ऐप्लिकेशन मौजूद है या नहीं.

कॉन्फ़िगरेशन अपडेट करना

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

किसी क्लाउड प्रोजेक्ट के लिए पहली बार कमांड चलाने पर, आपको कम से कम एक डिसप्ले नेम और ब्यौरा देना होगा. जब तक स्थिति को बंद पर सेट नहीं किया जाता, तब तक कमांड पूरा होते ही Chat ऐप्लिकेशन चालू हो जाता है. इसके बाद, टेस्टर के तौर पर शामिल किए गए लोग, इसे ढूंढकर इस्तेमाल कर सकते हैं.

फ़्लैग इस्तेमाल करना

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

gcloud beta workspace-add-ons chat-app-config update \
    --display-name="Quickstart App" \
    --description="Quickstart app" \
    --avatar-uri=https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png \
    --http-endpoint-url=HTTP_ENDPOINT_URL \
    --supports-multiuser-spaces \
    --add-allowlisted-testing-principals=USER_EMAIL \
    --error-logging-enabled

इनकी जगह ये डालें:

  • HTTP_ENDPOINT_URL: एचटीटीपीएस यूआरएल, जिसे Chat से इवेंट ऑब्जेक्ट मिलते हैं.
  • USER_EMAIL: आपके Google Workspace संगठन में मौजूद किसी व्यक्ति या ग्रुप का ईमेल पता. इस व्यक्ति या ग्रुप के पास Chat ऐप्लिकेशन को इंस्टॉल और टेस्ट करने की अनुमति होनी चाहिए. जैसे, आपका ईमेल पता.

यह कमांड, अपडेट किए गए कॉन्फ़िगरेशन को प्रिंट करता है.

यहां दी गई टेबल में, Google Cloud Console में Chat API के कॉन्फ़िगरेशन पेज पर मौजूद सेटिंग के फ़्लैग की सूची दी गई है. हर फ़्लैग के बारे में जानकारी के लिए, update कमांड रेफ़रंस देखें.

Google Cloud Console में सेटिंग झंडे
ऐप्लिकेशन का नाम --display-name
अवतार का यूआरएल --avatar-uri को किसी ऐसी इमेज के एचटीटीपीएस यूआरएल से बदलें जो अवतार की ज़रूरी शर्तों को पूरा करती हो या डिफ़ॉल्ट अवतार का इस्तेमाल करने के लिए, --clear-avatar-uri का इस्तेमाल करें
ब्यौरा --description
ऐप्लिकेशन की स्थिति --state=active या --state=disabled
मार्कअप सिंटैक्स --markup-syntax=markdown या --markup-syntax=chat
स्पेस और ग्रुप बातचीत में शामिल होना --supports-multiuser-spaces या --no-supports-multiuser-spaces
कनेक्शन की सेटिंग इनमें से कोई एक:
  • एचटीटीपी एंडपॉइंट यूआरएल: --http-endpoint-url
  • Apps Script: --apps-script-deployment-id
  • Cloud Pub/Sub: --pubsub-topic, जिसमें उसी क्लाउड प्रोजेक्ट में एक विषय हो. इसका फ़ॉर्मैट projects/PROJECT_ID/topics/TOPIC_ID होना चाहिए
  • Dialogflow: --dialogflow-edition=es या --dialogflow-edition=cx, जिसमें --dialogflow-agent को एजेंट या एनवायरमेंट के संसाधन के नाम पर सेट किया गया हो, जैसे कि projects/PROJECT_ID/locations/LOCATION/agents/AGENT_ID
किसको दिखे --add-allowlisted-testing-principals, --remove-allowlisted-testing-principals, और --clear-allowlisted-testing-principals
गड़बड़ियों को Logging में लॉग करें --error-logging-enabled या --no-error-logging-enabled

कमांड, लिंक की झलक, और हर ट्रिगर के लिए अलग-अलग एंडपॉइंट में फ़्लैग नहीं होते. इन्हें कॉन्फ़िगर करने के लिए, कॉन्फ़िगरेशन फ़ाइल का इस्तेमाल करें.

उदाहरण के लिए, अन्य सेटिंग में बदलाव किए बिना चैट ऐप्लिकेशन को बंद करने के लिए, यह कमांड चलाएं. इसे फिर से चालू करने के लिए, --state=active का इस्तेमाल करें.

gcloud beta workspace-add-ons chat-app-config update --state=disabled

कॉन्फ़िगरेशन फ़ाइल का इस्तेमाल करना

कॉन्फ़िगरेशन को किसी फ़ाइल में सेव रखने या ऐसी सेटिंग कॉन्फ़िगर करने के लिए जिनमें फ़्लैग नहीं हैं, update कमांड में YAML या JSON फ़ाइल पास करें. फ़ाइल, chatAppConfig रिसॉर्स के फ़ील्ड का इस्तेमाल करती है. ये वही फ़ील्ड हैं जिन्हें describe कमांड प्रिंट करता है.

  1. ऐसी फ़ाइल बनाएं जिसमें अपडेट की जाने वाली सेटिंग शामिल हों. उदाहरण के लिए, chat_app_config.yaml नाम की एक फ़ाइल बनाएं, जिसमें यह कॉन्टेंट हो:

    displayName: Cymbal Assistant
    description: Helps manage tasks and schedules
    avatarUri: https://www.gstatic.com/dynamite/images/quickstart-app-avatar.png
    state: ACTIVE
    errorLoggingEnabled: true
    interactiveFeatureConfig:
      supportsMultiuserSpaces: true
      connectionConfig:
        httpEndpointConfig:
          commonUrl: https://example.com/chat
      appCommands:
      - commandId: 1
        commandType: SLASH_COMMAND
        command: /help
        description: Show available commands
      urlPatterns:
      - hostPattern: example.com
        pathPrefix: tasks/
      allowlistedTestingPrincipals:
      - USER_EMAIL
    

    USER_EMAIL की जगह, अपने Google Workspace संगठन के किसी व्यक्ति या ग्रुप का ईमेल पता डालें. यह व्यक्ति या ग्रुप, Chat ऐप्लिकेशन को इंस्टॉल और टेस्ट कर सकता है.

  2. --config-file फ़्लैग के साथ update कमांड चलाएं:

    gcloud beta workspace-add-ons chat-app-config update \
        --config-file=chat_app_config.yaml

किसी Chat ऐप्लिकेशन के मौजूदा कॉन्फ़िगरेशन से शुरुआत करने के लिए, describe कमांड के आउटपुट को किसी फ़ाइल में सेव करें:

gcloud beta workspace-add-ons chat-app-config describe > chat_app_config.yaml

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

update कमांड, फ़ाइल में मौजूद name फ़ील्ड को अनदेखा करता है. यह हमेशा उस Cloud प्रोजेक्ट को अपडेट करता है जिसे आपने gcloud सीएलआई में सेट किया है. इसलिए, किसी दूसरे Cloud प्रोजेक्ट में Chat ऐप्लिकेशन को कॉन्फ़िगर करने के लिए, उसी फ़ाइल का इस्तेमाल किया जा सकता है.

कमांड आपके बदलावों को कैसे लागू करता है

  • सिर्फ़ वे सेटिंग बदलती हैं जिन्हें आपने चुना है. फ़्लैग के साथ, कमांड आपके पास किए गए फ़्लैग की सेटिंग बदल देता है. कॉन्फ़िगरेशन फ़ाइल की मदद से, यह फ़ाइल में मौजूद फ़ील्ड बदलता है. इसलिए, फ़ाइल में पूरा कॉन्फ़िगरेशन शामिल करने की ज़रूरत नहीं होती. कनेक्शन की सेटिंग एक अपवाद है: सेट किया गया कनेक्शन टाइप, मौजूदा कनेक्शन टाइप की जगह ले लेता है. साथ ही, सेट किया गया Dialogflow वर्शन, पूरे Dialogflow कॉन्फ़िगरेशन की जगह ले लेता है.
  • सूचियों को पूरी तरह से बदल दिया जाता है. अगर फ़ाइल में appCommands, urlPatterns या allowlistedTestingPrincipals फ़ील्ड है, तो फ़ाइल में मौजूद सूची, मौजूदा सूची की जगह ले लेती है. अलग-अलग टेस्टर को जोड़ने या हटाने के लिए, --add-allowlisted-testing-principals और --remove-allowlisted-testing-principals फ़्लैग का इस्तेमाल करें.
  • खाली वैल्यू से सेटिंग मिट जाती है. उदाहरण के लिए, ऐसी फ़ाइल जिसमें interactiveFeatureConfig के तहत urlPatterns: [] शामिल है, लिंक की झलक दिखाने वाले सभी यूआरएल पैटर्न हटा देती है.
  • अगर कोई निर्देश पूरा नहीं होता है, तो उससे कोई बदलाव नहीं होता. अगर कोई वैल्यू मान्य नहीं है, तो कमांड गड़बड़ी को प्रिंट करता है और कॉन्फ़िगरेशन को पहले जैसा ही छोड़ देता है.
  • अनुरोधों की संख्या सीमित है. एपीआई, हर क्लाउड प्रोजेक्ट और हर संगठन के लिए, हर मिनट रीड और अपडेट के अनुरोधों की संख्या को सीमित करता है. हर update कमांड, अपडेट करने का एक अनुरोध भेजता है. अगर फ़्लैग का इस्तेमाल करके टेस्टर जोड़े या हटाए जाते हैं, तो यह कमांड, डेटा फ़ेच करने का अनुरोध भी भेजता है. कई सेटिंग बदलने के लिए, हर सेटिंग के लिए अलग-अलग निर्देश चलाने के बजाय, उन्हें एक ही निर्देश या एक ही फ़ाइल में पास करें.

सीमाएं

  • कमांड सिर्फ़ उन चैट ऐप्लिकेशन के साथ काम करते हैं जिन्हें Google Workspace ऐड-ऑन के तौर पर बनाया गया है.
  • इन कमांड का इस्तेमाल, सेवा खातों या सेवा खाते के नाम पर काम करने वाले खातों के लिए नहीं किया जा सकता. आपको उपयोगकर्ता खाते से gcloud सीएलआई में साइन इन करना होगा.
  • किसी क्लाउड प्रोजेक्ट में एक चैट ऐप्लिकेशन कॉन्फ़िगरेशन होता है. कमांड की मदद से इसे मिटाया नहीं जा सकता. लोगों को Chat ऐप्लिकेशन का इस्तेमाल करने से रोकने के लिए, इसकी स्थिति को 'बंद है' पर सेट करें या Cloud प्रोजेक्ट को मिटाएं.
  • अपडेट, लाइव Chat ऐप्लिकेशन पर लागू होता है. कमांड में ड्राफ़्ट या ड्राय-रन मोड नहीं होता.
  • अगर कोई चैट ऐप्लिकेशन, Google Workspace Marketplace में पब्लिश हो चुका है या उसकी समीक्षा की जा रही है, तो कमांड की मदद से उसके डिसप्ले नेम, अवतार, ब्यौरे, कमांड या लिंक की झलक दिखाने वाले यूआरएल पैटर्न में बदलाव नहीं किया जा सकता.
  • कमांड, chatAppConfig संसाधन में मौजूद सेटिंग के साथ काम करते हैं. अगर आपको ऐसी सेटिंग कॉन्फ़िगर करनी है जो संसाधन में शामिल नहीं है, तो Google Cloud Console का इस्तेमाल करें.

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

अगर कोई निर्देश काम नहीं करता है, तो गड़बड़ी के मैसेज में मौजूद टेक्स्ट को इस टेबल में ढूंढें. अगर मैसेज की शुरुआत INVALID_ARGUMENT जैसे स्टेटस से होती है, तो इसका मतलब है कि Google Workspace ऐड-ऑन एपीआई ने अनुरोध को अस्वीकार कर दिया है. साथ ही, स्टेटस के बाद मौजूद टेक्स्ट में समस्या के बारे में बताया गया है.

गड़बड़ी के मैसेज में ये शब्द शामिल हैं वजह समाधान
Invalid choice: 'chat-app-config' या Invalid choice: 'workspace-add-ons' कमांड में beta शामिल नहीं है या gcloud सीएलआई के आपके वर्शन में कमांड शामिल नहीं हैं. कमांड की शुरुआत gcloud beta workspace-add-ons chat-app-config से करें. अगर गड़बड़ी बनी रहती है, तो gcloud सीएलआई को नए वर्शन में अपडेट करें.
PROJECT ID प्रोजेक्ट को किसी प्रोजेक्ट नंबर पर सेट किया गया हो. प्रोजेक्ट को प्रोजेक्ट आईडी पर सेट करें.
Failed to parse value(s) in protobuf कॉन्फ़िगरेशन फ़ाइल में एक ऐसा फ़ील्ड है जिसे gcloud सीएलआई नहीं पहचानता. गड़बड़ी के मैसेज में फ़ील्ड का नाम होता है. फ़ील्ड के नाम की तुलना, describe कमांड के आउटपुट से करें. अगर फ़ील्ड नया है, तो gcloud सीएलआई को नए वर्शन में अपडेट करें.
does not have permission to access projects instance एपीआई ने अनुरोध अस्वीकार कर दिया. इस मैसेज के बाद दिए गए टेक्स्ट में, इसकी वजह बताई गई है. उदाहरण के लिए:
  • आपके खाते के पास ज़रूरी आईएएम भूमिकाएं नहीं हैं. अगर टेक्स्ट में Caller does not have required permission to use project शामिल है, तो इसका मतलब है कि सेवा उपयोग के उपभोक्ता की भूमिका असाइन नहीं की गई है.
  • Google Workspace ऐड-ऑन एपीआई, क्लाउड प्रोजेक्ट में चालू नहीं है.
  • आपने सेवा खाते से साइन इन किया है.
शुरू करने से पहले सेक्शन में जाकर, ज़रूरी शर्तें देखें.
INVALID_ARGUMENT कोई वैल्यू अमान्य है. उदाहरण के लिए, डिसप्ले नेम में 3 से 25 वर्ण होने चाहिए. साथ ही, ब्यौरे में 1 से 40 वर्ण होने चाहिए. अगर मैसेज में not found or deleted है, तो प्रोजेक्ट आईडी सही नहीं है. गड़बड़ी के मैसेज में बताई गई वैल्यू को ठीक करें और कमांड को फिर से चलाएं.
FAILED_PRECONDITION चैट ऐप्लिकेशन, अनुरोध की अनुमति नहीं देता. उदाहरण के लिए, इसे Google Workspace ऐड-ऑन के तौर पर नहीं बनाया गया है या इसे Google Workspace Marketplace में पब्लिश किया गया है और इसकी सेटिंग नहीं बदली जा सकती. गड़बड़ी के मैसेज में दिए गए निर्देशों का पालन करें. अगर आपको किसी ऐसे Chat ऐप्लिकेशन को कॉन्फ़िगर करना है जो Google Workspace ऐड-ऑन नहीं है, तो Google Cloud Console का इस्तेमाल करें या उसे Google Workspace ऐड-ऑन में बदलें.
RESOURCE_EXHAUSTED या 429 एपीआई को कम समय में, क्लाउड प्रोजेक्ट या आपके संगठन के लिए बहुत ज़्यादा अनुरोध मिले हैं. कुछ मिनट इंतज़ार करें और फिर से कमांड चलाएं.

Google Workspace ऐड-ऑन एपीआई का इस्तेमाल करके, अपने चैट ऐप्लिकेशन को कॉन्फ़िगर करना

Google Cloud Console में अपने चैट ऐप्लिकेशन को मैन्युअल तरीके से कॉन्फ़िगर करने के बजाय, Google Workspace ऐड-ऑन के तौर पर बनाए गए चैट ऐप्लिकेशन के कॉन्फ़िगरेशन को प्रोग्राम के हिसाब से पढ़ा और अपडेट किया जा सकता है. इसके लिए, Google Workspace add-ons API में chatAppConfig संसाधन का इस्तेमाल करें.

chatAppConfig एक सिंगलटन रिसॉर्स है, जो हर क्लाउड प्रोजेक्ट के लिए हमेशा मौजूद रहता है. पहली बार कॉन्फ़िगरेशन सेव करने से पहले, संसाधन में कोई कॉन्फ़िगरेशन नहीं होता. अगर पहली बार सेव करने से पहले संसाधन को पढ़ा जाता है, तो GetChatAppConfig भी यही दिखाता है. संसाधन पहले से मौजूद है, इसलिए आपको इसे अलग से बनाने की ज़रूरत नहीं है. शुरुआती कॉन्फ़िगरेशन को सेव करने और मौजूदा कॉन्फ़िगरेशन को अपडेट करने, दोनों के लिए UpdateChatAppConfig का इस्तेमाल करें.

ज़रूरी शर्तें और पुष्टि करना

GetChatAppConfig या UpdateChatAppConfig को कॉल करने से पहले, इन ज़रूरी शर्तों को पूरा करें:

  1. अपने क्लाउड प्रोजेक्ट में, Google Workspace Add-ons API (gsuiteaddons.googleapis.com) को चालू करें. अगर आपको Google Cloud Console में चैट ऐप्लिकेशन का कॉन्फ़िगरेशन देखना है या उसे अपडेट करना है, तो Google Chat API (chat.googleapis.com) को चालू किया जा सकता है. इसके अलावा, Chat API को कॉल करने के लिए भी इसे चालू किया जा सकता है.
  2. OAuth 2.0 क्रेडेंशियल का इस्तेमाल करके, इंसान के तौर पर अपनी पहचान की पुष्टि करें. इसमें https://www.googleapis.com/auth/cloud-platform स्कोप शामिल है. chatAppConfig के तरीकों के लिए, सेवा खाते की पुष्टि करने की सुविधा उपलब्ध नहीं है.
  3. पक्का करें कि जिस उपयोगकर्ता की पुष्टि की गई है उसके पास टारगेट क्लाउड प्रोजेक्ट के लिए, पहचान और ऐक्सेस मैनेजमेंट (आईएएम) की ज़रूरी अनुमतियां हों:
    • कॉन्फ़िगरेशन (GetChatAppConfig) को पढ़ने के लिए, gsuiteaddons.chatAppConfigs.get और chat.bots.get.
    • कॉन्फ़िगरेशन (UpdateChatAppConfig) को अपडेट करने के लिए, gsuiteaddons.chatAppConfigs.update, chat.bots.update, और chat.bots.get.
  4. अगर क्लाइंट लाइब्रेरी का इस्तेमाल किया जाता है, तो अपनी भाषा के लिए Google Workspace ऐड-ऑन एपीआई क्लाइंट लाइब्रेरी का नया वर्शन इंस्टॉल करें. क्लाइंट लाइब्रेरी की सूची देखने के लिए, Google Workspace ऐड-ऑन एपीआई का संदर्भ देखें.

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

किसी चैट ऐप्लिकेशन को पहली बार कॉन्फ़िगर करने या मौजूदा कॉन्फ़िगरेशन को अपडेट करने के लिए, अपने Cloud प्रोजेक्ट के सिंगलटन chatAppConfig रिसॉर्स को PATCH अनुरोध (UpdateChatAppConfig) भेजें:

  • किसी क्लाउड प्रोजेक्ट को पहली बार सेव करने के लिए, chatAppConfig, displayName (3 से 25 वर्ण), और description (1 से 40 वर्ण) की ज़रूरत होती है. अगर पहली बार सेव करते समय interactiveFeatureConfig को शामिल नहीं किया जाता है, तो Chat ऐप्लिकेशन को इंटरैक्टिव नहीं के तौर पर कॉन्फ़िगर किया जाता है.
  • इसके बाद के अपडेट के लिए, वैकल्पिक updateMask क्वेरी पैरामीटर का इस्तेमाल करें. इससे, अपडेट किए जाने वाले फ़ील्ड को कॉमा लगाकर अलग किए गए तरीके से बताया जा सकता है. इसके अलावा, दिए गए सभी फ़ील्ड को अपडेट करने के लिए, updateMask को छोड़ा जा सकता है. दोहराए गए फ़ील्ड (appCommands, urlPatterns या allowlistedTestingPrincipals) को अपडेट करने पर, पूरी सूची बदल जाती है.
PATCH https://gsuiteaddons.googleapis.com/v1/projects/PROJECT_NUMBER/chatAppConfig?updateMask=displayName,description,avatarUri,state,errorLoggingEnabled,markupSyntax,interactiveFeatureConfig
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/json

{
  "name": "projects/PROJECT_NUMBER/chatAppConfig",
  "displayName": "Cymbal Assistant",
  "description": "Helps manage tasks and schedules",
  "avatarUri": "https://www.gstatic.com/dynamite/images/quickstart-app-avatar.png",
  "state": "ACTIVE",
  "errorLoggingEnabled": true,
  "markupSyntax": "MARKUP_SYNTAX_MARKDOWN",
  "interactiveFeatureConfig": {
    "supportsMultiuserSpaces": false,
    "connectionConfig": {
      "httpEndpointConfig": {
        "commonUrl": "https://example.com/chat"
      }
    },
    "appCommands": [
      {
        "commandType": "SLASH_COMMAND",
        "commandId": 1,
        "command": "/help",
        "description": "Show available commands",
        "dialogEnabled": false
      }
    ],
    "urlPatterns": [
      {
        "hostPattern": "example.com",
        "pathPrefix": "tasks/"
      }
    ],
    "allowlistedTestingPrincipals": [
      "USER_EMAIL"
    ]
  }
}

अनुरोध के यूआरएल, हेडर, और मुख्य हिस्से में इन्हें बदलें:

  • PROJECT_NUMBER: आपके चैट ऐप्लिकेशन को होस्ट करने वाले Cloud प्रोजेक्ट का नंबर.
  • ACCESS_TOKEN: उपयोगकर्ता का OAuth 2.0 ऐक्सेस टोकन, जिसे https://www.googleapis.com/auth/cloud-platform स्कोप के साथ अनुमति दी गई है.
  • USER_EMAIL: आपके Google Workspace संगठन का कोई ईमेल पता या Google ग्रुप, जिसे चैट ऐप्लिकेशन की टेस्टिंग के लिए अनुमति वाली सूची में शामिल करना है. उदाहरण के लिए, आपका ईमेल पता.
  • अनुरोध के मुख्य हिस्से में मौजूद कॉन्फ़िगरेशन फ़ील्ड के उदाहरण (जैसे, displayName, description, avatarUri, और interactiveFeatureConfig. इनमें आपके एंडपॉइंट कॉन्फ़िगरेशन, कमांड, लिंक की झलक दिखाने वाले यूआरएल पैटर्न, और टेस्टिंग प्रिंसिपल शामिल हैं) को अपने Chat ऐप्लिकेशन की वैल्यू के साथ बदलें. इस्तेमाल किए जा सकने वाले सभी फ़ील्ड और एंडपॉइंट के विकल्पों के बारे में जानने के लिए, projects.chatAppConfig REST रेफ़रंस और projects.chatAppConfig.patch देखें.

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

किसी Cloud प्रोजेक्ट के लिए, Chat ऐप्लिकेशन के मौजूदा कॉन्फ़िगरेशन को पढ़ने के लिए, GetChatAppConfig को कॉल करें. view क्वेरी पैरामीटर (ChatAppConfigView) को पास किया जा सकता है. हालांकि, ऐसा करना ज़रूरी नहीं है:

  • BASIC (डिफ़ॉल्ट): interactiveFeatureConfig के बिना बुनियादी मेटाडेटा दिखाता है.
  • FULL: यह सभी कॉन्फ़िगरेशन फ़ील्ड दिखाता है. इनमें interactiveFeatureConfig भी शामिल है.

अगर Cloud प्रोजेक्ट के लिए, Chat ऐप्लिकेशन का कॉन्फ़िगरेशन अब तक सेव नहीं किया गया है, तो यह तरीका एक खाली ChatAppConfig ऑब्जेक्ट दिखाता है.

HTTP

GET https://gsuiteaddons.googleapis.com/v1/projects/PROJECT_NUMBER/chatAppConfig?view=FULL
Authorization: Bearer ACCESS_TOKEN

Node.js

const {GSuiteAddOnsClient} = require('@google-cloud/gsuiteaddons').v1;

const client = new GSuiteAddOnsClient();

async function getChatAppConfig() {
  const [response] = await client.getChatAppConfig({
    name: 'projects/PROJECT_NUMBER/chatAppConfig',
    view: 'FULL',
  });
  console.log(JSON.stringify(response, null, 2));
}

getChatAppConfig();

Python

from google.cloud import gsuiteaddons_v1

client = gsuiteaddons_v1.GSuiteAddOnsClient()

request = gsuiteaddons_v1.GetChatAppConfigRequest(
    name="projects/PROJECT_NUMBER/chatAppConfig",
    view=gsuiteaddons_v1.GetChatAppConfigRequest.ChatAppConfigView.FULL,
)
response = client.get_chat_app_config(request=request)
print(response)

इस्तेमाल करने की सीमाएं

chatAppConfig तरीकों के लिए, हर प्रोजेक्ट के हिसाब से कोटा तय होता है. अगर आपने कोटा से ज़्यादा अनुरोध किए हैं, तो अनुरोध पूरा नहीं होगा और आपको 429: Too many requests एचटीटीपी स्टेटस कोड दिखेगा. कोटे की सीमाओं के बारे में जानने के लिए, Google Workspace ऐड-ऑन एपीआई के इस्तेमाल की सीमाएं देखें.

गड़बड़ियां ठीक करना

अगर chatAppConfig अनुरोध पूरा नहीं हो पाता है, तो गड़बड़ी के जवाब में एचटीटीपी स्टेटस कोड और message फ़ील्ड देखें. यहां दी गई टेबल में, आम तौर पर होने वाली गड़बड़ियों, उनकी वजहों, और उन्हें ठीक करने के तरीके की जानकारी दी गई है.

HTTP स्‍थिति कोड आम वजहें रिज़ॉल्यूशन
400: Bad Request (INVALID_ARGUMENT)
  • updateMask में ऐसा फ़ील्ड है जो मौजूद नहीं है या जिसे अपडेट नहीं किया जा सकता.
  • फ़ील्ड की कोई वैल्यू मौजूद नहीं है या अमान्य है. उदाहरण के लिए, interactiveFeatureConfig में connectionConfig शामिल नहीं है.
अमान्य फ़ील्ड के लिए, message फ़ील्ड देखें और अनुरोध को ठीक करें. इस्तेमाल किए जा सकने वाले फ़ील्ड और वैल्यू के बारे में जानने के लिए, projects.chatAppConfig रेफ़रंस देखें.
400: Bad Request (FAILED_PRECONDITION)
  • चैट ऐप्लिकेशन को Google Workspace ऐड-ऑन के तौर पर नहीं बनाया गया है.
  • इस फ़ील्ड में बदलाव नहीं किया जा सकता, क्योंकि चैट ऐप्लिकेशन को Google Workspace Marketplace पर पब्लिश किया गया है.
  • नई वैल्यू, Chat ऐप्लिकेशन के मौजूदा कॉन्फ़िगरेशन के साथ काम नहीं करती.
  • चैट ऐप्लिकेशन को Google Workspace ऐड-ऑन में बदलें या इसे Google Cloud Console में कॉन्फ़िगर करें.
  • पब्लिश की गई लिस्टिंग को अपडेट करने के लिए, message फ़ील्ड में दिए गए निर्देशों का पालन करें.
  • विरोधी सेटिंग के लिए message फ़ील्ड की जांच करें. साथ ही, एक ही अनुरोध में दोनों सेटिंग अपडेट करें या पहले मौजूदा सेटिंग बदलें.
403: Forbidden (PERMISSION_DENIED)
  • पुष्टि किए गए उपयोगकर्ता के पास, Cloud प्रोजेक्ट पर ज़रूरी आईएएम अनुमतियां नहीं हैं.
  • अनुरोध की पुष्टि, उपयोगकर्ता खाते के बजाय सेवा खाते से की गई है.
  • उपयोगकर्ता को ज़रूरी शर्तें और पुष्टि में दी गई अनुमतियां दें.
  • https://www.googleapis.com/auth/cloud-platform स्कोप की मदद से, इंसान के तौर पर पुष्टि करें.
404: Not Found (NOT_FOUND) संसाधन के नाम में मौजूद क्लाउड प्रोजेक्ट मौजूद नहीं है या पुष्टि किया गया उपयोगकर्ता उसे ऐक्सेस नहीं कर सकता. देखें कि संसाधन के नाम में, projects/PROJECT_NUMBER/chatAppConfig फ़ॉर्मैट में सही प्रोजेक्ट नंबर का इस्तेमाल किया गया हो. साथ ही, उपयोगकर्ता के पास क्लाउड प्रोजेक्ट का ऐक्सेस हो.
429: Too Many Requests (RESOURCE_EXHAUSTED) हर प्रोजेक्ट के लिए तय किया गया कोटा खत्म हो गया है. थोड़ा इंतज़ार करें और बाद में फिर से कोशिश करें. सीमाओं के बारे में जानने के लिए, इस्तेमाल करने की सीमाएं देखें.

Google Workspace के मौजूदा ऐड-ऑन के लिए ध्यान देने वाली बातें

Google Workspace के अन्य ऐप्लिकेशन की सुविधाओं को बेहतर बनाने वाले Google Workspace ऐड-ऑन की तुलना में, चैट ऐप्लिकेशन को अलग कॉन्फ़िगरेशन की ज़रूरत होती है. अगर आपका ऐड-ऑन, Google Workspace के अन्य ऐप्लिकेशन के साथ काम करता है, तो चैट ऐप्लिकेशन को कॉन्फ़िगर करने के लिए इन ज़रूरी शर्तों को ध्यान में रखें:

  • यह ज़रूरी है कि व्यक्ति और Google Workspace एडमिन, दोनों ही Marketplace से आपका ऐड-ऑन इंस्टॉल कर सकें. Marketplace SDK में, इंस्टॉल करने की इन सेटिंग को कॉन्फ़िगर किया जाता है.
  • चैट ऐप्लिकेशन, उस नाम और लोगो का इस्तेमाल नहीं करते जिसे आपने मेनिफ़ेस्ट के addons.common ऑब्जेक्ट में, Google Workspace के अन्य ऐप्लिकेशन के लिए कॉन्फ़िगर किया है.
  • Google Workspace Marketplace पर पब्लिश किए गए ऐड-ऑन के लिए, Google Chat API के कॉन्फ़िगरेशन की सेटिंग में किए गए किसी भी बदलाव का ड्राफ़्ट सेव नहीं किया जा सकता. Chat API की कॉन्फ़िगरेशन सेटिंग को अपडेट और सेव करने के बाद, अपडेट किया गया Chat ऐप्लिकेशन सभी मौजूदा उपयोगकर्ताओं के लिए तुरंत उपलब्ध हो जाता है. Marketplace पर अपनी लिस्टिंग को अपडेट करने के लिए, कोई भी बदलाव सबमिट करने से पहले, एक ड्राफ़्ट बनाएं.
  • अगर आपने Apps Script का इस्तेमाल करके ऐड-ऑन बनाया है, तो:
  • अगर आपने एचटीटीपी सेवा का इस्तेमाल करके अपना ऐड-ऑन बनाया है, तो Google Workspace ऐड-ऑन एपीआई का इस्तेमाल करके बनाए गए projects.deployments मेनिफ़ेस्ट में, चैट ऐप्लिकेशन के कॉन्फ़िगरेशन की कोई भी जानकारी शामिल न करें. Google Workspace Marketplace SDK में बताए गए एचटीटीपी डिप्लॉयमेंट का इस्तेमाल, सिर्फ़ Google Workspace के अन्य ऐप्लिकेशन के लिए किया जाता है. इसके बजाय, Google Cloud Console में जाकर, gcloud सीएलआई की मदद से या Google Workspace ऐड-ऑन एपीआई में chatAppConfig रिसॉर्स का इस्तेमाल करके, अपने चैट ऐप्लिकेशन को कॉन्फ़िगर करें.

अन्य लोगों को Chat API को कॉन्फ़िगर करने की अनुमति देना

चैट ऐप्लिकेशन के कॉन्फ़िगरेशन पेज का ऐक्सेस कुछ उपयोगकर्ताओं को दिया जा सकता है. इसके लिए, उन्हें चैट ऐप्लिकेशन के मालिक या चैट ऐप्लिकेशन के दर्शक की Google Cloud Identity Access Management (IAM) भूमिका देनी होगी. इन भूमिकाओं वाले उपयोगकर्ता, एपीआई और सेवाएं डैशबोर्ड का इस्तेमाल करके, चैट ऐप्लिकेशन के कॉन्फ़िगरेशन पेज पर नहीं जा सकते. हालांकि, वे चैट ऐप्लिकेशन के होस्ट क्लाउड प्रोजेक्ट के लिए, Google Cloud Console पर जाकर कॉन्फ़िगरेशन पेज को ऐक्सेस कर सकते हैं. इसके लिए, यह तरीका अपनाएं:

https://console.developers.google.com/apis/api/chat.googleapis.com/hangouts-chat?project=PROJECT_ID

जहां PROJECT_ID, Chat ऐप्लिकेशन को होस्ट करने वाले Google Cloud प्रोजेक्ट का आईडी है.

ऐड-ऑन के तौर पर काम न करने वाले चैट ऐप्लिकेशन: Google Chat API को कॉन्फ़िगर करें

अगर आपके पास कोई ऐसा Chat ऐप्लिकेशन है जो Google Workspace ऐड-ऑन नहीं है, तो आपका कॉन्फ़िगरेशन, हर इवेंट के ट्रिगर के बजाय, इंटरैक्शन के सभी इवेंट के लिए एक ही एंडपॉइंट का इस्तेमाल करता है:

  1. Google Cloud console में, Chat API के कॉन्फ़िगरेशन पेज पर जाएं:

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

  2. इंटरैक्टिव सुविधाएं में जाकर, इंटरैक्टिव सुविधाएं चालू करें को चालू करें.

  3. इस Chat ऐप्लिकेशन को Google Workspace ऐड-ऑन के तौर पर बनाएं से सही का निशान हटाएं. एक डायलॉग बॉक्स खुलेगा, जिसमें आपसे पुष्टि करने के लिए कहा जाएगा. डायलॉग बॉक्स में, बंद करें पर क्लिक करें.

  4. Functionality में जाकर, ज़रूरत के हिसाब से Support App Home या स्पेस और ग्रुप बातचीत में शामिल हों को चुनें.

  5. कनेक्शन सेटिंग में जाकर, अपने चैट ऐप्लिकेशन के लिए कोई एक एंडपॉइंट तय करें. जैसे, एचटीटीपी एंडपॉइंट यूआरएल, Apps Script डिप्लॉयमेंट आईडी, Cloud Pub/Sub विषय का नाम या Dialogflow.

  6. कमांड, स्टार्टर प्रॉम्प्ट, लिंक की झलक, किसको दिखे, और लॉग को कॉन्फ़िगर करें. इसके बाद, सेव करें पर क्लिक करें. ये ज़रूरी नहीं हैं.

अगर आपको किसी ऐसे Chat ऐप्लिकेशन को Google Workspace ऐड-ऑन में अपग्रेड करना है जो ऐड-ऑन नहीं है, तो Google Chat ऐप्लिकेशन को Google Workspace ऐड-ऑन में बदलना लेख पढ़ें.