Google Workspace की सदस्यता बनाएं

इस पेज पर, Google Workspace के किसी संसाधन की सदस्यता बनाने के लिए, Google Workspace Events API का इस्तेमाल करने का तरीका बताया गया है. Google Workspace की सदस्यता से, आपके ऐप्लिकेशन को Google Workspace इवेंट के बारे में जानकारी मिलती है. ये इवेंट, Google Workspace के किसी संसाधन में हुए बदलावों के बारे में बताते हैं. Google Workspace Events API किन संसाधनों और इवेंट टाइप के साथ काम करता है, यह जानने के लिए Google Workspace Events API की खास जानकारी देखें.

इस पेज पर, Google Workspace की सदस्यता लेने का तरीका बताया गया है:

  1. अपना एनवायरमेंट सेट अप करें.
  2. Google Cloud Pub/Sub टॉपिक बनाएं और उस पर सदस्यता लें. Google Workspace इवेंट पाने के लिए, इस विषय का इस्तेमाल एंडपॉइंट के तौर पर किया जाता है.
  3. Subscription संसाधन पर, Google Workspace Events API के create() तरीका को कॉल करें.
  4. Google Workspace की सदस्यता की जांच करें, ताकि यह पक्का किया जा सके कि आपके Pub/Sub विषय को वे इवेंट मिल रहे हैं जिनकी आपने सदस्यता ली है.
  5. इसके अलावा, अपने ऐप्लिकेशन के लिए किसी एंडपॉइंट पर इवेंट को पुश करने का तरीका कॉन्फ़िगर करें, ताकि आपका ऐप्लिकेशन इवेंट को प्रोसेस कर सके और ज़रूरत पड़ने पर कार्रवाई कर सके.

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

Apps Script

  • इस गाइड में Google Cloud CLI के निर्देशों का इस्तेमाल करने के लिए:
    1. Google Cloud सीएलआई इंस्टॉल करें.
    2. gcloud सीएलआई को शुरू करने के लिए, यह कोड चलाएं:
      3.   gcloud init
  • बिलिंग की सुविधा वाला Google Cloud प्रोजेक्ट. Chat की सदस्यताओं के लिए, आपको अपने Cloud प्रोजेक्ट में Chat API को भी चालू करना होगा. साथ ही, ऐप्लिकेशन का नाम, अवतार का यूआरएल, और ब्यौरा फ़ील्ड को कॉन्फ़िगर करना होगा. ज़्यादा जानकारी के लिए, Google Chat ऐप्लिकेशन बनाना लेख पढ़ें.
  • ऐप्लिकेशन के लिए कॉन्फ़िगर की गई OAuth सहमति स्क्रीन की मदद से, उपयोगकर्ता की पुष्टि करना ज़रूरी है. सहमति स्क्रीन को कॉन्फ़िगर करते समय, आपको सदस्यता के लिए हर इवेंट टाइप के साथ काम करने के लिए दायरा तय करना होगा. सहमति वाली स्क्रीन को कॉन्फ़िगर करने और ज़रूरी स्कोप की पहचान करने के लिए, स्कोप चुनें लेख पढ़ें.
  • Apps Script प्रोजेक्ट:
    • Apps Script के ज़रिए अपने-आप बनाए गए डिफ़ॉल्ट प्रोजेक्ट के बजाय, अपने Google Cloud प्रोजेक्ट का इस्तेमाल करें.
    • OAuth की सहमति वाली स्क्रीन को कॉन्फ़िगर करने के लिए जोड़े गए सभी स्कोप के लिए, आपको अपने Apps Script प्रोजेक्ट में appsscript.json फ़ाइल में भी स्कोप जोड़ने होंगे. उदाहरण के लिए: 
      • "oauthScopes": [
  "https://www.googleapis.com/auth/chat.messages.readonly"
]
    • Google Workspace Events बेहतर सेवा चालू करें.

Python

  • Python 3.6 या इसके बाद का वर्शन
  • pip पैकेज मैनेजमेंट टूल
  • Python के लिए Google की नई क्लाइंट लाइब्रेरी. इन्हें इंस्टॉल या अपडेट करने के लिए, अपने कमांड-लाइन इंटरफ़ेस में यह कमांड चलाएं: 
      pip3 install --upgrade google-api-python-client google-auth-oauthlib
  • इस गाइड में Google Cloud CLI के निर्देशों का इस्तेमाल करने के लिए:
    1. Google Cloud सीएलआई इंस्टॉल करें.
    2. gcloud सीएलआई को शुरू करने के लिए, यह कोड चलाएं:
      3.   gcloud init
  • बिलिंग की सुविधा वाला Google Cloud प्रोजेक्ट. Chat की सदस्यताओं के लिए, आपको अपने Cloud प्रोजेक्ट में Chat API को भी चालू करना होगा. साथ ही, ऐप्लिकेशन का नाम, अवतार का यूआरएल, और ब्यौरा फ़ील्ड को कॉन्फ़िगर करना होगा. ज़्यादा जानकारी के लिए, Google Chat ऐप्लिकेशन बनाना लेख पढ़ें.
  • ऐप्लिकेशन के लिए कॉन्फ़िगर की गई OAuth सहमति स्क्रीन की मदद से, उपयोगकर्ता की पुष्टि करना ज़रूरी है. सहमति स्क्रीन को कॉन्फ़िगर करते समय, आपको सदस्यता के लिए हर इवेंट टाइप के साथ काम करने के लिए दायरा तय करना होगा. सहमति वाली स्क्रीन को कॉन्फ़िगर करने और ज़रूरी स्कोप की पहचान करने के लिए, स्कोप चुनें लेख पढ़ें.

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

इस सेक्शन में, Google Workspace की सदस्यता लेने से पहले, अपने एनवायरमेंट को सेट अप करने का तरीका बताया गया है.

Google Workspace Events API और Google Cloud Pub/Sub API को चालू करना

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

Google Cloud कंसोल

Google Cloud Console में, अपने ऐप्लिकेशन के लिए Google Cloud प्रोजेक्ट खोलें और Google Workspace Events API और Pub/Sub API को चालू करें:

एपीआई चालू करना

gcloud

  1. अपनी वर्किंग डायरेक्ट्री में, अपने Google खाते में साइन इन करें:

    gcloud auth login

  2. अपने ऐप्लिकेशन के लिए, प्रोजेक्ट को Cloud प्रोजेक्ट पर सेट करें:

    gcloud config set project PROJECT_ID

    अपने ऐप्लिकेशन के Cloud प्रोजेक्ट के लिए, PROJECT_ID की जगह प्रोजेक्ट आईडी डालें.

  3. Google Workspace Events API और Google Cloud Pub/Sub एपीआई को चालू करें:

    gcloud services enable pubsub.googleapis.com workspaceevents.googleapis.com

OAuth क्लाइंट आईडी के क्रेडेंशियल बनाना

OAuth क्लाइंट आईडी बनाने का तरीका जानने के लिए, अपना ऐप्लिकेशन टाइप चुनें:

वेब एेप्लिकेशन

  1. Google Cloud console में, मेन्यू > एपीआई और सेवाएं > क्रेडेंशियल पर जाएं.

    क्रेडेंशियल पर जाएं

  2. क्रेडेंशियल बनाएं > OAuth क्लाइंट आईडी पर क्लिक करें.
  3. ऐप्लिकेशन का टाइप > वेब ऐप्लिकेशन पर क्लिक करें.
  4. नाम फ़ील्ड में, क्रेडेंशियल के लिए कोई नाम टाइप करें. यह नाम सिर्फ़ Google Cloud Console में दिखता है.
  5. अपने ऐप्लिकेशन से जुड़े, अनुमति वाले यूआरआई जोड़ें:
    • क्लाइंट-साइड ऐप्लिकेशन (JavaScript)–अनुमति वाले JavaScript ऑरिजिन में जाकर, यूआरआई जोड़ें पर क्लिक करें. इसके बाद, ब्राउज़र के अनुरोधों के लिए इस्तेमाल करने के लिए कोई यूआरआई डालें. इससे उन डोमेन की पहचान होती है जिनसे आपका ऐप्लिकेशन, OAuth 2.0 सर्वर को एपीआई के अनुरोध भेज सकता है.
    • सर्वर-साइड ऐप्लिकेशन (Java, Python वगैरह)–अनुमति वाले रीडायरेक्ट यूआरआई में जाकर, यूआरआई जोड़ें पर क्लिक करें. इसके बाद, वह एंडपॉइंट यूआरआई डालें जिस पर OAuth 2.0 सर्वर रिस्पॉन्स भेज सकता है.
  6. बनाएं पर क्लिक करें. OAuth क्लाइंट बनने के बाद, आपको एक स्क्रीन दिखेगी. इसमें आपका नया क्लाइंट आईडी और क्लाइंट पासवर्ड दिखेगा.

    क्लाइंट आईडी नोट करें. क्लाइंट सीक्रेट का इस्तेमाल वेब ऐप्लिकेशन के लिए नहीं किया जाता.

  7. ठीक है पर क्लिक करें. नया क्रेडेंशियल, OAuth 2.0 क्लाइंट आईडी में दिखता है.

Android

  1. Google Cloud console में, मेन्यू > एपीआई और सेवाएं > क्रेडेंशियल पर जाएं.

    क्रेडेंशियल पर जाएं

  2. क्रेडेंशियल बनाएं > OAuth क्लाइंट आईडी पर क्लिक करें.
  3. ऐप्लिकेशन टाइप > Android पर क्लिक करें.
  4. "नाम" फ़ील्ड में, क्रेडेंशियल के लिए कोई नाम टाइप करें. यह नाम सिर्फ़ Google Cloud Console में दिखता है.
  5. "पैकेज का नाम" फ़ील्ड में, अपनी AndroidManifest.xml फ़ाइल से पैकेज का नाम डालें.
  6. "SHA-1 सर्टिफ़िकेट फ़िंगरप्रिंट" फ़ील्ड में, जनरेट किया गया SHA-1 सर्टिफ़िकेट फ़िंगरप्रिंट डालें.
  7. बनाएं पर क्लिक करें. OAuth क्लाइंट बनने के बाद, आपको एक स्क्रीन दिखेगी. इसमें आपका नया क्लाइंट आईडी दिखेगा.
  8. ठीक है पर क्लिक करें. नया क्रेडेंशियल, "OAuth 2.0 क्लाइंट आईडी" में दिखता है.

iOS

  1. Google Cloud console में, मेन्यू > एपीआई और सेवाएं > क्रेडेंशियल पर जाएं.

    क्रेडेंशियल पर जाएं

  2. क्रेडेंशियल बनाएं > OAuth क्लाइंट आईडी पर क्लिक करें.
  3. ऐप्लिकेशन टाइप > iOS पर क्लिक करें.
  4. "नाम" फ़ील्ड में, क्रेडेंशियल के लिए कोई नाम टाइप करें. यह नाम सिर्फ़ Google Cloud Console में दिखता है.
  5. "बंडल आईडी" फ़ील्ड में, ऐप्लिकेशन की Info.plist फ़ाइल में मौजूद बंडल आइडेंटिफ़ायर डालें.
  6. ज़रूरी नहीं: अगर आपका ऐप्लिकेशन Apple App Store में दिखता है, तो ऐप स्टोर आईडी डालें.
  7. ज़रूरी नहीं: "टीम आईडी" फ़ील्ड में, 10 वर्णों वाली वह यूनीक स्ट्रिंग डालें जो Apple ने जनरेट की है और आपकी टीम को असाइन की है.
  8. बनाएं पर क्लिक करें. OAuth क्लाइंट बनने के बाद, आपको एक स्क्रीन दिखेगी. इसमें आपका नया क्लाइंट आईडी और क्लाइंट पासवर्ड दिखेगा.
  9. ठीक है पर क्लिक करें. नया क्रेडेंशियल, "OAuth 2.0 क्लाइंट आईडी" में दिखता है.

Chrome ऐप्लिकेशन

  1. Google Cloud console में, मेन्यू > एपीआई और सेवाएं > क्रेडेंशियल पर जाएं.

    क्रेडेंशियल पर जाएं

  2. क्रेडेंशियल बनाएं > OAuth क्लाइंट आईडी पर क्लिक करें.
  3. ऐप्लिकेशन टाइप > Chrome ऐप्लिकेशन पर क्लिक करें.
  4. "नाम" फ़ील्ड में, क्रेडेंशियल के लिए कोई नाम टाइप करें. यह नाम सिर्फ़ Google Cloud Console में दिखता है.
  5. "ऐप्लिकेशन आईडी" फ़ील्ड में, अपने ऐप्लिकेशन की 32 वर्णों वाली यूनीक आईडी स्ट्रिंग डालें. आपको यह आईडी वैल्यू, अपने ऐप्लिकेशन के Chrome वेब स्टोर यूआरएल और Chrome वेब स्टोर के डेवलपर डैशबोर्ड में मिल सकती है.
  6. बनाएं पर क्लिक करें. OAuth क्लाइंट बनने के बाद, आपको एक स्क्रीन दिखेगी. इसमें आपका नया क्लाइंट आईडी और क्लाइंट पासवर्ड दिखेगा.
  7. ठीक है पर क्लिक करें. नया क्रेडेंशियल, "OAuth 2.0 क्लाइंट आईडी" में दिखता है.

डेस्कटॉप ऐप्लिकेशन

  1. Google Cloud console में, मेन्यू > एपीआई और सेवाएं > क्रेडेंशियल पर जाएं.

    क्रेडेंशियल पर जाएं

  2. क्रेडेंशियल बनाएं > OAuth क्लाइंट आईडी पर क्लिक करें.
  3. ऐप्लिकेशन का टाइप > डेस्कटॉप ऐप्लिकेशन पर क्लिक करें.
  4. नाम फ़ील्ड में, क्रेडेंशियल के लिए कोई नाम टाइप करें. यह नाम सिर्फ़ Google Cloud Console में दिखता है.
  5. बनाएं पर क्लिक करें. OAuth क्लाइंट बनाने के बाद, आपको एक स्क्रीन दिखेगी. इसमें आपका नया क्लाइंट आईडी और क्लाइंट पासवर्ड दिखेगा.
  6. ठीक है पर क्लिक करें. नया क्रेडेंशियल, OAuth 2.0 क्लाइंट आईडी में दिखता है.

टीवी और सीमित इनपुट डिवाइस

  1. Google Cloud console में, मेन्यू > एपीआई और सेवाएं > क्रेडेंशियल पर जाएं.

    क्रेडेंशियल पर जाएं

  2. क्रेडेंशियल बनाएं > OAuth क्लाइंट आईडी पर क्लिक करें.
  3. ऐप्लिकेशन टाइप > टीवी और सीमित इनपुट डिवाइस पर क्लिक करें.
  4. "नाम" फ़ील्ड में, क्रेडेंशियल के लिए कोई नाम टाइप करें. यह नाम सिर्फ़ Google Cloud Console में दिखता है.
  5. बनाएं पर क्लिक करें. OAuth क्लाइंट बनाने के बाद, आपको एक स्क्रीन दिखेगी. इसमें आपका नया क्लाइंट आईडी और क्लाइंट पासवर्ड दिखेगा.
  6. ठीक है पर क्लिक करें. नया क्रेडेंशियल, "OAuth 2.0 क्लाइंट आईडी" में दिखता है.

Universal Windows Platform (यूडब्ल्यूपी)

  1. Google Cloud console में, मेन्यू > एपीआई और सेवाएं > क्रेडेंशियल पर जाएं.

    क्रेडेंशियल पर जाएं

  2. क्रेडेंशियल बनाएं > OAuth क्लाइंट आईडी पर क्लिक करें.
  3. ऐप्लिकेशन टाइप > Universal Windows Platform (यूडब्ल्यूपी) पर क्लिक करें.
  4. "नाम" फ़ील्ड में, क्रेडेंशियल के लिए कोई नाम टाइप करें. यह नाम सिर्फ़ Google Cloud Console में दिखता है.
  5. "स्टोर आईडी" फ़ील्ड में, अपने ऐप्लिकेशन का यूनीक Microsoft Store आईडी डालें. यह 12 वर्णों का होना चाहिए. यह आईडी, आपके ऐप्लिकेशन के Microsoft Store यूआरएल और Partner Center में देखा जा सकता है.
  6. बनाएं पर क्लिक करें. OAuth क्लाइंट बनने के बाद, आपको एक स्क्रीन दिखेगी. इसमें आपका नया क्लाइंट आईडी और क्लाइंट पासवर्ड दिखेगा.
  7. ठीक है पर क्लिक करें. नया क्रेडेंशियल, "OAuth 2.0 क्लाइंट आईडी" में दिखता है.

क्लाइंट सीक्रेट की JSON फ़ाइल डाउनलोड करना

क्लाइंट सीक्रेट फ़ाइल, OAuth क्लाइंट आईडी के क्रेडेंशियल का JSON वर्शन होती है. आपका ऐप्लिकेशन, क्रेडेंशियल देते समय इसका रेफ़रंस दे सकता है.

  1. Google Cloud console में, मेन्यू > एपीआई और सेवाएं > क्रेडेंशियल पर जाएं.

    क्रेडेंशियल पर जाएं

  2. OAuth 2.0 क्लाइंट आईडी में जाकर, अपने बनाए गए क्लाइंट आईडी पर क्लिक करें.

  3. JSON फ़ाइल डाउनलोड करें पर क्लिक करें.

  4. फ़ाइल को client_secrets.json के तौर पर सेव करें.

Pub/Sub का कोई विषय बनाना और उसकी सदस्यता लेना

इस सेक्शन में, Pub/Sub का विषय और उस विषय के लिए सदस्यता बनाई जाती है. आपका Pub/Sub विषय, सूचना एंडपॉइंट के तौर पर काम करता है. यहां आपकी Google Workspace सदस्यता को इवेंट मिलते हैं.

Pub/Sub विषय बनाने और उन्हें मैनेज करने के बारे में ज़्यादा जानने के लिए, Pub/Sub के दस्तावेज़ देखें.

Pub/Sub विषय बनाने और उसकी सदस्यता लेने के लिए:

Google Cloud कंसोल

  1. Google Cloud Console में, Pub/Sub पेज पर जाएं:

    Google Cloud Pub/Sub पर जाएं

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

  2. विषय बनाएं पर क्लिक करें और ये काम करें:

    1. अपने विषय के लिए कोई नाम डालें, जैसे कि workspace-events-topic.
    2. डिफ़ॉल्ट सदस्यता जोड़ें को चुना रहने दें. Pub/Sub, इस डिफ़ॉल्ट सदस्यता को आपके विषय के नाम के जैसे नाम देता है, जैसे कि workspace-events-topic-sub.
    3. ज़रूरी नहीं: अपने विषय के लिए, अन्य प्रॉपर्टी अपडेट करें या कॉन्फ़िगर करें.

  3. बनाएं पर क्लिक करें. आपके विषय का पूरा नाम, projects/PROJECT_ID/topics/TOPIC_ID के तौर पर फ़ॉर्मैट किया गया है. इस पूरे नाम का इस्तेमाल, अगले चरण में किया जाता है.

  4. अपने विषय पर Pub/Sub मैसेज पब्लिश करने का ऐक्सेस दें:

    1. अपने विषय के पेज पर, साइड पैनल में जाएं और अनुमतियां टैब खोलें.
    2. प्रिंसिपल जोड़ें पर क्लिक करें.
    3. प्रिंसिपल जोड़ें फ़ील्ड में, उस Google Workspace ऐप्लिकेशन के लिए सेवा खाता जोड़ें जो आपकी सदस्यता में इवेंट डिलीवर करता है:
      1. Chat इवेंट के लिए, chat-api-push@system.gserviceaccount.com.
      2. Meet इवेंट के लिए, meet-api-event-push@system.gserviceaccount.com.
    4. भूमिकाएं असाइन करें मेन्यू में, Pub/Sub Publisher चुनें.
    5. सेव करें पर क्लिक करें. आपके विषय के लिए अनुमतियां अपडेट होने में कुछ मिनट लग सकते हैं.

gcloud

  1. अपने Cloud प्रोजेक्ट में, यह कमांड चलाकर कोई विषय बनाएं:

    gcloud pubsub topics create TOPIC_ID

    TOPIC_ID को अपने विषय के लिए किसी यूनीक आईडी से बदलें, जैसे कि workspace-events-topic.

    आउटपुट में, विषय का पूरा नाम दिखता है. इसे projects/PROJECT_ID/topics/TOPIC_ID के तौर पर फ़ॉर्मैट किया जाता है. नाम नोट करें और पक्का करें कि PROJECT_ID की वैल्यू, आपके ऐप्लिकेशन के लिए Cloud प्रोजेक्ट आईडी हो. अगले चरण में, विषय के नाम का इस्तेमाल किया जाता है. साथ ही, बाद में Google Workspace की सदस्यता बनाने के लिए भी इसका इस्तेमाल किया जाता है.

  2. अपने विषय पर मैसेज पब्लिश करने का ऐक्सेस दें:

    gcloud pubsub topics add-iam-policy-binding TOPIC_NAME --member='serviceAccount:GOOGLE_WORKSPACE_APPLICATION' --role='roles/pubsub.publisher'

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

    • TOPIC_NAME: विषय का पूरा नाम, जो पिछले चरण का आउटपुट है. इसे projects/PROJECT_ID/topics/TOPIC_ID के तौर पर फ़ॉर्मैट किया गया है.

    • GOOGLE_WORKSPACE_APPLICATION: वह Google Workspace ऐप्लिकेशन जिसे आपकी सदस्यता में इवेंट डिलीवर करने होंगे:

      • Chat से इवेंट पाने के लिए, chat-api-push@system.gserviceaccount.com का इस्तेमाल करें.
      • Meet से इवेंट पाने के लिए, meet-api-event-push@system.gserviceaccount.com का इस्तेमाल करें.

    आपके विषय की अनुमतियों को अपडेट होने में कुछ मिनट लग सकते हैं.

  3. विषय के लिए Pub/Sub सदस्यता बनाएं:

     gcloud pubsub subscriptions create SUBSCRIPTION_NAME --topic=TOPIC_NAME

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

    • SUBSCRIPTION_NAME: आपकी सदस्यता का नाम, जैसे कि workspace-events-subscription.
    • TOPIC_NAME: आपके उस विषय का नाम जिसे आपने पिछले चरण में बनाया था.

Google Workspace के किसी संसाधन की सदस्यता लेना

इस सेक्शन में, उस Google Workspace संसाधन की सदस्यता ली जाती है जिसे आपको इवेंट के लिए मॉनिटर करना है.

टारगेट किए गए संसाधन को चुनना और उसकी पहचान करना

Google Workspace की सदस्यता में, टारगेट संसाधन वह Google Workspace संसाधन होता है जिसे इवेंट के लिए मॉनिटर किया जाता है. टारगेट संसाधन को सदस्यता के targetResource फ़ील्ड में दिखाया जाता है. इसे संसाधन के पूरे नाम का इस्तेमाल करके फ़ॉर्मैट किया जाता है. उदाहरण के लिए, Google Chat के किसी स्पेस (spaces/AAAABBBBBBB) को मॉनिटर करने वाली सदस्यता के लिए, targetResource की वैल्यू //chat.googleapis.com/spaces/AAAABBBBBBB है.

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

Chat के लिए टारगेट रिसॉर्स की पहचान करना

टारगेट किया गया संसाधन फ़ॉर्मैट सीमाएं
स्पेस

//chat.googleapis.com/spaces/SPACE

यहां SPACE, Chat API space रिसॉर्स के संसाधन के नाम में मौजूद आईडी है. स्पेस का आईडी, स्पेस के यूआरएल से या spaces.list() तरीके का इस्तेमाल करके पाया जा सकता है.

 सदस्यता की अनुमति देने वाले Chat उपयोगकर्ता के पास, अपने Google Workspace या Google खाते से स्पेस में शामिल होने की अनुमति होनी चाहिए.
किसी उपयोगकर्ता के लिए सभी स्पेस

//chat.googleapis.com/spaces/-

 सदस्यता में सिर्फ़ उन स्पेसेज़ के इवेंट शामिल होते हैं जिनमें उपयोगकर्ता, अपने Google Workspace या Google खाते से सदस्य है.
उपयोगकर्ता

//cloudidentity.googleapis.com/users/USER

यहां USER, Chat API user रिसॉर्स के संसाधन के नाम में मौजूद आईडी है. ज़्यादा जानकारी के लिए, Google Chat के उपयोगकर्ताओं की पहचान करना और उनके बारे में जानकारी देना देखें.

सदस्यता को सिर्फ़ उस उपयोगकर्ता के इवेंट मिलते हैं जिसने सदस्यता के लिए अनुमति दी है. कोई उपयोगकर्ता, अन्य उपयोगकर्ताओं की ओर से सदस्यता लेने की अनुमति नहीं दे सकता.

Meet के लिए टारगेट किए गए संसाधन की पहचान करना

टारगेट किया गया संसाधन फ़ॉर्मैट सीमाएं (अगर लागू हों)
मीटिंग स्पेस //meet.googleapis.com/spaces/SPACE

यहां SPACE, Meet REST API space रिसॉर्स के संसाधन के नाम में मौजूद आईडी है. ज़्यादा जानकारी के लिए, Meet, मीटिंग स्पेस की पहचान कैसे करता है लेख पढ़ें.
उपयोगकर्ता //cloudidentity.googleapis.com/users/USER

यहां USER, Meet REST API participant रिसॉर्स के signedinUser.user फ़ील्ड में मौजूद आईडी है. ज़्यादा जानकारी के लिए, मीटिंग में हिस्सा लेने वाले लोगों के साथ काम करना लेख पढ़ें.

सदस्यता को मीटिंग स्पेस के बारे में इवेंट मिलते हैं, जहां उपयोगकर्ता इनमें से कोई एक है:

  • मीटिंग स्पेस का मालिक.
  • मीटिंग स्पेस से जुड़े Google Calendar इवेंट का आयोजक.

Google Workspace की सदस्यता लेना

सदस्यता बनाने के लिए, Subscription संसाधन बनाने के लिए, Google Workspace Events API के subscriptions.create() तरीके का इस्तेमाल किया जाता है. आपको इन फ़ील्ड की जानकारी देनी होती है:

  • targetResource: वह Google Workspace जिसकी पहचान आपने पिछले सेक्शन में की थी. इसे संसाधन के पूरे नाम का इस्तेमाल करके फ़ॉर्मैट किया गया है.
  • eventTypes: एक या उससे ज़्यादा इवेंट टाइप का कलेक्शन, जिनके बारे में आपको संसाधन के बारे में जानकारी चाहिए. उदाहरण के लिए, अगर आपके ऐप्लिकेशन को सिर्फ़ Chat स्पेस में पोस्ट किए गए नए मैसेज के बारे में जानकारी चाहिए, तो आपका ऐप्लिकेशन सिर्फ़ मैसेज से जुड़े इवेंट की सदस्यता ले सकता है.
  • notificationEndpoint: सूचना का वह एंडपॉइंट जहां आपकी Google Workspace सदस्यता, इवेंट डिलीवर करती है. आपने पिछले सेक्शन में बनाए गए Pub/Sub विषय का इस्तेमाल किया है.
  • payloadOptions: इवेंट पेलोड में कितना रिसॉर्स डेटा शामिल करना है, यह तय करने के विकल्प. इस कॉन्फ़िगरेशन से, आपकी सदस्यता की समयसीमा पर असर पड़ता है. ज़्यादा जानने के लिए, इवेंट का डेटा लेख पढ़ें.

Google Workspace की सदस्यता बनाने के लिए:

Apps Script

  1. अपने Apps Script प्रोजेक्ट में, createSubscription नाम की एक नई स्क्रिप्ट फ़ाइल बनाएं और नीचे दिया गया कोड जोड़ें:

    function createSubscription() {
  // The Google Workspace resource to monitor for events.
  const targetResource = 'TARGET_RESOURCE';

  // The types of events to receive.
  const eventTypes = [EVENT_TYPES];

  // The endpoint to deliver events to, such as a Google Cloud Pub/Sub topic.
  const pubsubTopic = 'TOPIC_NAME';

  // Whether to include resource data or not.
  const resourceData = RESOURCE_DATA;

  // Call the Workspace Events API using the advanced service.
  const response = WorkspaceEvents.Subscriptions.create({
    targetResource: targetResource,
    eventTypes: eventTypes,
    notificationEndpoint: {
      pubsubTopic: pubsubTopic,
    },
    payloadOptions: {
      includeResource: resourceData
    }
  });
  console.log(response);
}

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

    • TARGET_RESOURCE: वह Google Workspace संसाधन जिसकी सदस्यता ली जा रही है. इसे संसाधन के पूरे नाम के तौर पर फ़ॉर्मैट किया गया है. उदाहरण के लिए, AAAABBBB आईडी वाले Google Chat स्पेस की सदस्यता लेने के लिए, //chat.googleapis.com/spaces/AAAABBBB का इस्तेमाल करें.
    • EVENT_TYPES: एक या एक से ज़्यादा इवेंट टाइप, जिनकी आपको टारगेट किए गए संसाधन में सदस्यता लेनी है. 'google.workspace.chat.message.v1.created' जैसी स्ट्रिंग के ऐरे के तौर पर फ़ॉर्मैट करें.
    • TOPIC_NAME: आपके Cloud प्रोजेक्ट में बनाए गए Pub/Sub टॉपिक का पूरा नाम. इसे projects/PROJECT_ID/topics/TOPIC_ID के तौर पर फ़ॉर्मैट किया गया है.

    • RESOURCE_DATA: यह एक बूलियन है, जो यह बताता है कि सदस्यता में, पेलोड में संसाधन डेटा शामिल है या नहीं:

      • True: इसमें संसाधन का पूरा डेटा शामिल होता है. कौनसे फ़ील्ड शामिल किए जाएं, यह तय करने के लिए fieldMask फ़ील्ड जोड़ें. साथ ही, बदले गए संसाधन के लिए कम से कम एक फ़ील्ड तय करें. सिर्फ़ Chat के रिसॉर्स की सदस्यताएं, रिसॉर्स डेटा को शामिल करने के साथ काम करती हैं.
      • False: इसमें रिसॉर्स डेटा शामिल नहीं होता.

  2. Google Workspace की सदस्यता बनाने के लिए, अपने Apps Script प्रोजेक्ट में createSubscription फ़ंक्शन चलाएं.

Python

  1. अपनी वर्किंग डायरेक्ट्री में, create_subscription.py नाम की फ़ाइल बनाएं और यह कोड जोड़ें:

    """Create subscription."""

from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build

# Specify required scopes.
SCOPES = [SCOPES]

# Authenticate with Google Workspace and get user authentication.
flow = InstalledAppFlow.from_client_secrets_file('client_secrets.json', SCOPES)
CREDENTIALS = flow.run_local_server()

# The Google Workspace resource to monitor for events.
TARGET_RESOURCE = 'TARGET_RESOURCE'

# The types of events to receive.
EVENT_TYPES = [EVENT_TYPES]

# The endpoint to deliver events to, such as a Google Cloud Pub/Sub topic.
TOPIC = 'TOPIC_NAME'

# Call the Workspace Events API using the service endpoint.
service = build(
    'workspaceevents',
    'v1',
    credentials=CREDENTIALS,
)

BODY = {
    'target_resource': TARGET_RESOURCE,
    'event_types': EVENT_TYPES,
    'notification_endpoint': {'pubsub_topic': TOPIC},
    'payload_options': {'include_resource': RESOURCE_DATA},
}
response = service.subscriptions().create(body=BODY).execute()
print(response)

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

    • SCOPES: एक या उससे ज़्यादा OAuth स्कोप, जो सदस्यता के लिए हर इवेंट टाइप के साथ काम करते हैं. स्ट्रिंग के ऐरे के तौर पर फ़ॉर्मैट किया गया. एक से ज़्यादा स्कोप की सूची बनाने के लिए, उन्हें कॉमा लगाकर अलग करें. उदाहरण के लिए, 'https://www.googleapis.com/auth/chat.spaces.readonly', 'https://www.googleapis.com/auth/chat.memberships.readonly'.
    • TARGET_RESOURCE: वह Google Workspace संसाधन जिसकी सदस्यता ली जा रही है. इसे संसाधन के पूरे नाम के तौर पर फ़ॉर्मैट किया गया है. उदाहरण के लिए, AAAABBBB आईडी वाले Google Chat स्पेस की सदस्यता लेने के लिए, //chat.googleapis.com/spaces/AAAABBBB का इस्तेमाल करें.
    • EVENT_TYPES: एक या एक से ज़्यादा इवेंट टाइप, जिनकी आपको टारगेट किए गए संसाधन में सदस्यता लेनी है. 'google.workspace.chat.message.v1.created' जैसी स्ट्रिंग के ऐरे के तौर पर फ़ॉर्मैट करें.
    • TOPIC_NAME: आपके Cloud प्रोजेक्ट में बनाए गए Pub/Sub टॉपिक का पूरा नाम. इसे projects/PROJECT_ID/topics/TOPIC_ID के तौर पर फ़ॉर्मैट किया गया है.

    • RESOURCE_DATA: यह एक बूलियन है, जो यह बताता है कि सदस्यता में, पेलोड में संसाधन डेटा शामिल है या नहीं:

      • True: इसमें संसाधन का पूरा डेटा शामिल होता है. कौनसे फ़ील्ड शामिल किए जाएं, यह तय करने के लिए fieldMask फ़ील्ड जोड़ें. साथ ही, बदले गए संसाधन के लिए कम से कम एक फ़ील्ड तय करें. सिर्फ़ Chat के रिसॉर्स की सदस्यताएं, रिसॉर्स डेटा को शामिल करने के साथ काम करती हैं.
      • False: इसमें रिसॉर्स डेटा शामिल नहीं होता.

  2. Google Workspace की सदस्यता बनाने के लिए, अपने टर्मिनल में यह कमांड चलाएं:

    python3 create_subscription.py

Google Workspace Events API, लंबे समय तक चलने वाले ऑपरेशन के पूरा होने की जानकारी दिखाता है. इसमें, आपके बनाए गए Subscription रिसॉर्स का इंस्टेंस शामिल होता है.

Google Workspace की सदस्यता की जांच करना

यह जांचने के लिए कि आपको Google Workspace इवेंट मिल रहे हैं या नहीं, आपके पास इवेंट को ट्रिगर करने और Pub/Sub सदस्यता में मैसेज खींचने का विकल्प है.

Google Workspace की सदस्यता की जांच करने के लिए:

Google Cloud कंसोल

  1. Google Workspace की सदस्यता के टारगेट संसाधन में, एक या उससे ज़्यादा तरह के इवेंट ट्रिगर करें. उदाहरण के लिए, अगर आपने Chat स्पेस में नए मैसेज पाने की सदस्यता ली है, तो स्पेस में कोई मैसेज पोस्ट करें.

  2. Google Cloud Console में, Pub/Sub पेज पर जाएं:

    Pub/Sub पर जाएं

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

  3. Pub/Sub मेन्यू में, सदस्यताएं पर क्लिक करें.

  4. टेबल में, अपने विषय के लिए Pub/Sub सदस्यता ढूंढें और सदस्यता के नाम पर क्लिक करें.

  5. मैसेज टैब पर क्लिक करें.

  6. खींचें पर क्लिक करें. किसी इवेंट को Pub/Sub मैसेज जनरेट करने में कुछ मिनट लग सकते हैं.

gcloud

  1. Google Workspace की सदस्यता के टारगेट रिसॉर्स में, एक या उससे ज़्यादा तरह के इवेंट ट्रिगर करें. उदाहरण के लिए, अगर आपने Chat स्पेस में नए मैसेज पाने की सदस्यता ली है, तो स्पेस में कोई मैसेज पोस्ट करें.

  2. यह कमांड चलाएं:

    gcloud pubsub subscriptions pull PUBSUB_SUBSCRIPTION_NAME --format=json --limit=MESSAGE_COUNT --auto-ack

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

    • PUBSUB_SUBSCRIPTION_NAME: आपकी Pub/Sub सदस्यता का पूरा नाम, जिसे projects/SUBSCRIPTION_ID/subscriptions/SUBSCRIPTION_ID के तौर पर फ़ॉर्मैट किया गया है.
    • MESSAGE_COUNT: Pub/Sub के ज़्यादा से ज़्यादा कितने मैसेज आपको खींचने हैं.

    किसी इवेंट को Pub/Sub मैसेज जनरेट करने में कुछ मिनट लग सकते हैं.

आपके ट्रिगर किए गए हर Google Workspace इवेंट के लिए, आपकी Pub/Sub सदस्यता में एक मैसेज भेजा जाता है. ज़्यादा जानकारी के लिए, Google Cloud Pub/Sub मैसेज के तौर पर इवेंट पाना देखें.

कॉन्फ़िगर करें कि आपके ऐप्लिकेशन को इवेंट कैसे मिलते हैं

आपने जो Pub/Sub सदस्यता बनाई है वह पुल-आधारित है. Pub/Sub सदस्यता की जांच करने के बाद, डिलीवरी टाइप को अपडेट किया जा सकता है. इससे, आपके ऐप्लिकेशन को इवेंट मिलने का तरीका बदल जाएगा. उदाहरण के लिए, Pub/Sub सदस्यता को पुश डिलीवरी टाइप के तौर पर कॉन्फ़िगर किया जा सकता है, ताकि आपके ऐप्लिकेशन को सीधे ऐप्लिकेशन एंडपॉइंट पर इवेंट मिल सकें.

Pub/Sub सदस्यता को कॉन्फ़िगर करने के बारे में जानने के लिए, Pub/Sub का दस्तावेज़ देखें.