Google Workspace Events API का इस्तेमाल करके इवेंट की सदस्यता लेना

इस पेज पर, Google Workspace Events API के बारे में खास जानकारी दी गई है. साथ ही, इसका तरीका भी बताया गया है इस एपीआई का इस्तेमाल करके, Google Workspace के सभी इवेंट की सदस्यता ली जा सकती है.

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

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

अपने ऐप्लिकेशन को Google Workspace के इवेंट की जानकारी पाने के लिए, Google Workspace की सदस्यताएं बनाने के लिए Google Workspace Events API संसाधन.

इलस्ट्रेशन में दिखाया गया है कि Google Workspace Events API से इवेंट कैसे डिलीवर होते हैं.
पहली इमेज. उदाहरण के लिए, Google Workspace Event API, चैट ऐप्लिकेशन.

यहां दिए गए उदाहरण में बताया गया है कि Google Workspace Events API कैसे डिलीवर करता है सदस्यता का इस्तेमाल करके, Google Chat ऐप्लिकेशन के इवेंट:

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

अहम शब्दावली

में उपयोग किए जाने वाले सामान्य शब्दों की सूची नीचे दी गई है Google Workspace इवेंट एपीआई:

Google Workspace इवेंट

Google Workspace संसाधन में बदलाव. इवेंट को CloudEvents इसके बारे में जानकारी दी जाती है. इसके अलावा, यह कोई सदस्यता इवेंट भी हो सकता है या लाइफ़साइकल इवेंट:

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

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

टारगेट संसाधन
Google Workspace का वह संसाधन जिसकी आपको निगरानी करनी है. यह संसाधन, इसके targetResource फ़ील्ड में दिखाया जाता है Google Workspace की सदस्यता. हर सदस्यता में सिर्फ़ एक संसाधन की निगरानी करें. जानें कि Google Workspace के कौनसे संसाधन Google Workspace Events API पर मौजूद सहायता के लिए यहां देखें Google Workspace के साथ काम करने वाले इवेंट.
इवेंट के टाइप
आप किस तरह के बदलावों के बारे में सूचना पाना चाहती हैं टारगेट संसाधन. उदाहरण के लिए, यदि आपने Google Chat स्पेस. आपके पास यह चुनने का विकल्प होता है कि आपको किन इवेंट से जुड़े इवेंट देखने हैं स्पेस और इसके चाइल्ड रिसॉर्स के लिए, जैसे कि पैसे चुकाकर ली जाने वाली सदस्यताएं और मैसेज.
सूचना एंडपॉइंट
वह एंडपॉइंट जहां Google Workspace की सदस्यता में मिलने वाले इवेंट. कॉन्टेंट बनाने Google Workspace Events API, Google Cloud Pub/Sub के विषयों के साथ इस तरह काम करता है: सूचना एंडपॉइंट. Google Cloud Pub/Sub का इस्तेमाल करने के बारे में ज़्यादा जानने के लिए, देखें Google Cloud Pub/Sub का दस्तावेज़.
पेलोड के विकल्प
वह इवेंट डेटा जो आप बदले गए संसाधनों के बारे में पाना चाहते हैं.

Google Workspace के साथ काम करने वाले इवेंट

आपके ऐप्लिकेशन को कौनसे इवेंट मिल सकते हैं, यह इस बात पर निर्भर करता है कि आपकी सदस्यता. इस टेबल में, हर इवेंट के लिए इस्तेमाल किए जा सकने वाले हर इवेंट की जानकारी दी गई है टारगेट संसाधन भी उपलब्ध नहीं हैं.

टारगेट संसाधन इस्तेमाल किए जा सकने वाले इवेंट
Google Chat स्पेस
  • मैसेज
  • सदस्यताएं
  • प्रतिक्रियाएं
  • स्पेस
Google Chat का इस्तेमाल करने वाले लोग
  • सदस्यताएं
Google Meet की मीटिंग के लिए स्पेस
  • कॉन्फ़्रेंस
  • हिस्सा लेने वाले लोगों के सेशन
  • रिकॉर्डिंग
  • ट्रांसक्रिप्ट की सुविधा
Google Meet के उपयोगकर्ता
  • कॉन्फ़्रेंस
  • हिस्सा लेने वाले लोगों के सेशन
  • रिकॉर्डिंग
  • ट्रांसक्रिप्ट की सुविधा

ज़्यादा जानने के लिए, नीचे दी गई गाइड देखें:

Google Workspace के इवेंट का स्ट्रक्चर

Google Workspace के इवेंट, CloudEvents के बाद होंगे खास जानकारी, जो इवेंट डेटा की जानकारी देने का इंडस्ट्री स्टैंडर्ड तरीका है. Google Workspace इवेंट में ये शामिल हैं:

नीचे दिए गए सेक्शन में, Google Workspace के इवेंट.

CloudEvent एट्रिब्यूट

Google Workspace के इवेंट में ये ज़रूरी चीज़ें शामिल होती हैं CloudEvent एट्रिब्यूट:

एट्रिब्यूट ब्यौरा उदाहरण

datacontenttype

इवेंट में पास किया गया डेटा किस तरह का है.

application/json

id

CloudEvent के लिए आइडेंटिफ़ायर.

spaces/AAAABBBBBBB/spaceEvents/ABCDEFGHIJKLMNO

source

इवेंट का सोर्स. Google Workspace इवेंट के लिए, यह सदस्यता का पूरा संसाधन नाम है. //workspaceevents.googleapis.com/subscriptions/chat-spaces-abcdefg

specversion

इस इवेंट के लिए, इस्तेमाल किया गया CloudEvent की खास बातों का वर्शन.

1.0

subject

Google Workspace का वह संसाधन जिसमें इवेंट हुआ है.

//chat.googleapis.com/spaces/AAAABBBBBBB

time

आरएफ़सी 3339 फ़ॉर्मैट में, इवेंट के समय का टाइमस्टैंप.

2023-09-07T21:37:36.260127Z

type

Google Workspace इवेंट किस तरह का है.

google.workspace.chat.message.v1.created

इवेंट का डेटा

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

उदाहरण के लिए, अगर आपने किसी चैट स्पेस की सदस्यता ली है, तो स्पेस में नए मैसेज के बारे में इवेंट पा सकता है. इस बारे में इवेंट के लिए नया मैसेज दिख रहा है, तो इवेंट डेटा में Chat के साथ एक पेलोड मौजूद है spaces.message संसाधन बनाया गया.

सदस्यता बनाते समय, यह तय किया जा सकता है कि संसाधन के कितने डेटा का इस्तेमाल किया जा सकता है आपके ऐप्लिकेशन को मिलने वाले इवेंट में ये शामिल होते हैं:

  • संसाधन डेटा शामिल करना: इसमें, बदले गए कॉन्टेंट के कुछ या सभी फ़ील्ड शामिल होते हैं संसाधन. अगर आपने संसाधन का डेटा शामिल करने का विकल्प चुना है, तो आपकी सदस्यता अवधि 4 घंटे या 24 घंटे तक सीमित होती है, अगर आप पूरे डोमेन के लिए ऐक्सेस देना.
  • संसाधन का डेटा शामिल न करना: इसमें सिर्फ़ बदले गए संसाधन का नाम होता है संसाधन. आपकी सदस्यता की अवधि 7 दिनों तक की है. इसके बारे में जानकारी पाने के लिए इवेंट में शामिल हों, तो संसाधन के नाम का इस्तेमाल करके संसाधन से क्वेरी की जा सकती है.

इवेंट डेटा के ये विकल्प payloadOptions में दिखाए गए हैं आपकी सदस्यता वाले फ़ील्ड में.

Google Cloud Pub/Sub मैसेज के तौर पर इवेंट

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

नीचे दिए गए उदाहरण में, Google Cloud Pub/Sub मैसेज दिखाया गया है. इसमें यह शामिल है चैट स्पेस में अपडेट किए गए मैसेज के बारे में जानकारी:

 {
    "message":
    {
        "attributes":
        {
            "ce-datacontenttype": "application/json",
            "ce-id": "spaces/SPACE_ID/spaceEvents/SPACE_EVENT_ID",
            "ce-source": "//workspaceevents.googleapis.com/subscriptions/SUBSCRIPTION_ID",
            "ce-specversion": "1.0",
            "ce-subject": "//chat.googleapis.com/spaces/SPACE_ID",
            "ce-time": "2023-09-07T21:37:53.274191Z",
            "ce-type": "google.workspace.chat.message.v1.updated"
        },
        "data": "EVENT_DATA",
        "messageId": "PUBSUB_MESSAGE_ID",
        "orderingKey": "//workspaceevents.googleapis.com/subscriptions/SUBSCRIPTION_ID",
        "publishTime": "2023-09-07T21:37:53.713Z"
    }
}

इन फ़ील्ड को नोट करें:

  • attributes: CloudEvent के लिए एट्रिब्यूट, जिनमें ये शामिल हैं इवेंट प्रकार. इस मामले में, यह इवेंट स्पेस.
  • data: अपडेट किए गए इवेंट की जानकारी के साथ इवेंट डेटा spaces.message संसाधन, जिसे Base64 कोड में बदली गई स्ट्रिंग के तौर पर फ़ॉर्मैट किया गया है.
  • messageId: Google Cloud Pub/Sub मैसेज के लिए आइडेंटिफ़ायर.

Google Cloud Pub/Sub में, Cloud Events कैसे तय किया जाता है, इस बारे में ज़्यादा जानने के लिए मैसेज के लिए, CloudEvents के लिए Google Cloud Pub/Sub प्रोटोकॉल बाइंडिंग देखें.