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. ज़रूरी नहीं: ज़्यादा जानकारी फ़ील्ड भरें. यह फ़ील्ड, Google Workspace डेवलपर के लिए झलक Program के तहत उपलब्ध है.

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

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

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

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

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

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

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)

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 में जाकर या Google Workspace add-ons API में 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 ऐड-ऑन में बदलना लेख पढ़ें.