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

इस पेज पर, Google Workspace Events API का इस्तेमाल करके, Google Workspace संसाधन की सदस्यता बनाने का तरीका बताया गया है. 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. Google Workspace Events API के create तरीके को Subscription संसाधन पर कॉल करें.
  4. Google Workspace की सदस्यता की जांच करें. इससे यह पुष्टि की जा सकेगी कि आपके Pub/Sub विषय को वे इवेंट मिल रहे हैं जिनके लिए आपने सदस्यता ली है.
  5. इसके अलावा, यह भी कॉन्फ़िगर किया जा सकता है कि आपके ऐप्लिकेशन के लिए, इवेंट को किसी एंडपॉइंट पर कैसे पुश किया जाए, ताकि आपका ऐप्लिकेशन इवेंट को प्रोसेस कर सके और ज़रूरत पड़ने पर कार्रवाई कर सके.

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

Apps Script

  • इस गाइड में Google Cloud CLI के निर्देशों का इस्तेमाल करने के लिए:
    1. Google Cloud CLI इंस्टॉल करें.
    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 CLI इंस्टॉल करें.
    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

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

  3. Google Workspace Events API और Google Cloud Pub/Sub API चालू करें:

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

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

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

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

  1. Google Cloud console में, मेन्यू > > क्लाइंट पर जाएं.

    क्लाइंट पर जाएं

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

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

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

Android

  1. Google Cloud console में, मेन्यू > > क्लाइंट पर जाएं.

    क्लाइंट पर जाएं

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

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

iOS

  1. Google Cloud console में, मेन्यू > > क्लाइंट पर जाएं.

    क्लाइंट पर जाएं

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

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

Chrome ऐप्लिकेशन

  1. Google Cloud console में, मेन्यू > > क्लाइंट पर जाएं.

    क्लाइंट पर जाएं

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

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

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

  1. Google Cloud console में, मेन्यू > > क्लाइंट पर जाएं.

    क्लाइंट पर जाएं

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

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

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

  1. Google Cloud console में, मेन्यू > > क्लाइंट पर जाएं.

    क्लाइंट पर जाएं

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

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

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

  1. Google Cloud console में, मेन्यू > > क्लाइंट पर जाएं.

    क्लाइंट पर जाएं

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

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

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

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

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

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

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

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

  4. फ़ाइल को credentials.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-api-push@system.gserviceaccount.com.
      2. डेवलपर प्रीव्यू: Drive इवेंट के लिए, drive-api-event-push@system.gserviceaccount.com.
      3. 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 का इस्तेमाल करें.
      • डेवलपर के लिए झलक: Drive से इवेंट पाने के लिए, drive-api-event-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 इस्तेमाल करने वालों की पहचान करना और उन्हें तय करना लेख पढ़ें.

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

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

इस प्रोग्राम में शामिल होने पर, आपको कुछ सुविधाओं का ऐक्सेस पहले ही मिल जाता है.
टारगेट संसाधन फ़ॉर्मैट सीमाएं (अगर लागू हों)
फ़ाइल //drive.googleapis.com/files/FILE

यहां FILE, Drive API files संसाधन के संसाधन नाम में मौजूद आईडी है. आईडी को फ़ाइल के यूआरएल से या files.list तरीके का इस्तेमाल करके पाया जा सकता है.

सदस्यता को अनुमति देने वाले उपयोगकर्ता के पास, सदस्यता से जुड़ी फ़ाइल पर अनुमति होनी चाहिए. यह अनुमति, सदस्यता लेने के इवेंट के हिसाब से होनी चाहिए.
शेयर की गई ड्राइव //drive.googleapis.com/drives/DRIVE

यहां DRIVE, Drive API drives संसाधन के संसाधन नाम में मौजूद आईडी है. आपको आईडी, Drive के यूआरएल से मिल सकता है. इसके अलावा, drives.list तरीके का इस्तेमाल करके भी आईडी पाया जा सकता है.

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

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 की सदस्यता बनाना

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

  • 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: Pub/Sub विषय का पूरा नाम, जिसे आपने Cloud प्रोजेक्ट में बनाया है. इसे 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('credentials.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: Pub/Sub विषय का पूरा नाम, जिसे आपने Cloud प्रोजेक्ट में बनाया है. इसे 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/PROJECT_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 के दस्तावेज़ देखें.