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

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

Apps Script

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

Python

  • Python 3.6 या इससे नया वर्शन
  • पीआईपी पैकेज मैनेजमेंट टूल
  • Python के लिए, Google की नई क्लाइंट लाइब्रेरी. इन्हें इंस्टॉल या अपडेट करने के लिए, इन्हें चलाएं कमांड:
      pip3 install --upgrade google-api-python-client google-auth-oauthlib
      
    अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है
  • 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. अपने ऐप्लिकेशन के लिए क्लाउड प्रोजेक्ट पर अपना प्रोजेक्ट सेट करें:

    gcloud config set project PROJECT_ID
    

    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 क्लाइंट की बनाई गई स्क्रीन दिखेगी. इसमें आपका नया क्लाइंट आईडी और क्लाइंट सीक्रेट दिखेगा.

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

  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 Client-ID" में दिखता है.

iOS

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

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

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

Chrome ऐप्लिकेशन

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

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

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

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

  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 Client-ID" में दिखता है.

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

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

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

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

क्लाइंट की सीक्रेट 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 प्रोजेक्ट आईडी है आपके ऐप्लिकेशन के लिए. अगले चरण में, विषय के नाम का इस्तेमाल करके, बाद में सदस्यता लेने की ज़रूरत नहीं है.

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

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

  • targetResource: Google Workspace, जिसकी पहचान आपने पिछला सेक्शन, जिसे इसके पूरे संसाधन नाम का इस्तेमाल करके फ़ॉर्मैट किया गया है.
  • eventTypes: एक या उससे ज़्यादा तरह के इवेंट का कलेक्शन, जिनके बारे में आपको सूचना चाहिए संसाधन. उदाहरण के लिए, अगर आपके ऐप्लिकेशन को सिर्फ़ नए मैसेज के बारे में जानकारी होनी चाहिए आपने चैट स्पेस में पोस्ट किया है, तो आपके ऐप्लिकेशन में सिर्फ़ इवेंट की सदस्यता ली जा सकती है बनाए गए मैसेज के बारे में जानकारी.
  • 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 का संसाधन जिसकी आपने सदस्यता ली है, जिसे इसके पूरे संसाधन नाम के तौर पर फ़ॉर्मैट किया गया हो. इसके लिए उदाहरण के लिए, स्पेस आईडी का इस्तेमाल करके Google Chat पर मौजूद किसी स्पेस की सदस्यता लेने के लिए AAAABBBB, //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 जोड़ें फ़ील्ड में बदलाव करें और बदले गए संसाधन के लिए कम से कम एक फ़ील्ड तय करें. सिर्फ़ सहायता के लिए, चैट से जुड़े संसाधनों की सदस्यता संसाधन डेटा.
      • 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 का संसाधन जिसकी आपने सदस्यता ली है, जिसे इसके पूरे संसाधन नाम के तौर पर फ़ॉर्मैट किया गया हो. इसके लिए उदाहरण के लिए, स्पेस आईडी का इस्तेमाल करके Google Chat पर मौजूद किसी स्पेस की सदस्यता लेने के लिए AAAABBBB, //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 जोड़ें फ़ील्ड में बदलाव करें और बदले गए संसाधन के लिए कम से कम एक फ़ील्ड तय करें. सिर्फ़ सहायता के लिए, चैट से जुड़े संसाधनों की सदस्यता संसाधन डेटा.
      • 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 की सदस्यता. उदाहरण के लिए, यदि आपने नए सदस्यों की चैट स्पेस में मैसेज पोस्ट करें, स्पेस में मैसेज पोस्ट करें.

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

    Pub/Sub पर जाएं

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

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

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

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

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

gcloud

  1. अपने Google Workspace की सदस्यता. उदाहरण के लिए, यदि आपने नए सदस्यों की चैट स्पेस में मैसेज पोस्ट करें, स्पेस में मैसेज पोस्ट करें.

  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 देखें दस्तावेज़ में दिया गया है.