संसाधन: सदस्यता
Google Workspace के किसी संसाधन के बारे में इवेंट पाने के लिए सदस्यता. सदस्यताओं के बारे में ज़्यादा जानने के लिए, Google Workspace Events API की खास जानकारी देखें.
JSON के काेड में दिखाना |
---|
{ "name": string, "uid": string, "targetResource": string, "eventTypes": [ string ], "payloadOptions": { object ( |
फ़ील्ड | |
---|---|
name |
आइडेंटिफ़ायर. सदस्यता के संसाधन का नाम. फ़ॉर्मैट: |
uid |
सिर्फ़ आउटपुट के लिए. सदस्यता के लिए, सिस्टम से असाइन किया गया यूनीक आइडेंटिफ़ायर. |
targetResource |
ज़रूरी है. इम्यूटेबल. वह Google Workspace संसाधन, जिसे इवेंट के लिए मॉनिटर किया जाता है. इसे संसाधन के पूरे नाम के तौर पर फ़ॉर्मैट किया जाता है. टारगेट के संसाधनों और उनके साथ काम करने वाले इवेंट के बारे में जानने के लिए, Google Workspace के साथ काम करने वाले इवेंट लेख पढ़ें. कोई उपयोगकर्ता, आपके ऐप्लिकेशन को किसी टारगेट किए गए संसाधन के लिए सिर्फ़ एक सदस्यता बनाने की अनुमति दे सकता है. अगर आपका ऐप्लिकेशन इन उपयोगकर्ताओं के क्रेडेंशियल का इस्तेमाल करके, दूसरी सदस्यता बनाने की कोशिश करता है, तो अनुरोध |
eventTypes[] |
ज़रूरी है. बिना क्रम वाली सूची. सदस्यता बनाने के लिए इनपुट. ऐसा न करने पर, सिर्फ़ आउटपुट के लिए. टारगेट किए गए संसाधन के बारे में एक या उससे ज़्यादा तरह के इवेंट पाने के लिए. CloudEvents स्पेसिफ़िकेशन के मुताबिक फ़ॉर्मैट किया गया. इस्तेमाल किए जा सकने वाले इवेंट टाइप, आपकी सदस्यता के टारगेट संसाधन पर निर्भर करते हैं. ज़्यादा जानकारी के लिए, Google Workspace के ऐसे इवेंट जिनमें यह सुविधा काम करती है लेख पढ़ें. डिफ़ॉल्ट रूप से, आपको अपनी सदस्यता के लाइफ़साइकल के बारे में भी इवेंट मिलते हैं. आपको इस फ़ील्ड के लिए, लाइफ़साइकल इवेंट की जानकारी देने की ज़रूरत नहीं है. अगर आपने टारगेट किए गए रिसॉर्स के लिए कोई ऐसा इवेंट टाइप तय किया है जो मौजूद नहीं है, तो अनुरोध में एचटीटीपी |
payloadOptions |
ज़रूरी नहीं. इवेंट पेलोड में कौनसा डेटा शामिल करना है, इसके बारे में विकल्प. सिर्फ़ Google Chat इवेंट के लिए काम करता है. |
notificationEndpoint |
ज़रूरी है. इम्यूटेबल. वह एंडपॉइंट जहां सदस्यता, इवेंट डिलीवर करती है. जैसे, Pub/Sub विषय. |
state |
सिर्फ़ आउटपुट के लिए. सदस्यता की स्थिति. यह नीति तय करती है कि सदस्यता में, इवेंट की जानकारी जोड़ी जा सकती है या नहीं. साथ ही, सदस्यता को सूचना एंडपॉइंट पर भेजा जा सकता है या नहीं. |
suspensionReason |
सिर्फ़ आउटपुट के लिए. ऐसी गड़बड़ी जिसकी वजह से सदस्यता निलंबित कर दी गई. सदस्यता को फिर से चालू करने के लिए, गड़बड़ी को ठीक करें और |
authority |
सिर्फ़ आउटपुट के लिए. वह उपयोगकर्ता जिसने सदस्यता बनाने की अनुमति दी है. फ़ॉर्मैट: Google Workspace के उपयोगकर्ताओं के लिए, |
createTime |
सिर्फ़ आउटपुट के लिए. सदस्यता बनाए जाने का समय. |
updateTime |
सिर्फ़ आउटपुट के लिए. सदस्यता को पिछली बार अपडेट किए जाने की तारीख. |
reconciling |
सिर्फ़ आउटपुट के लिए. अगर |
etag |
ज़रूरी नहीं. इस चेकसम का हिसाब, सर्वर अन्य फ़ील्ड की वैल्यू के आधार पर लगाता है. साथ ही, अपडेट के अनुरोधों पर इसे भेजा जा सकता है, ताकि आगे बढ़ने से पहले यह पक्का किया जा सके कि क्लाइंट के पास अप-टू-डेट वैल्यू है. |
यूनियन फ़ील्ड खत्म होने में लगने वाला ज़्यादा से ज़्यादा समय, इस बात पर निर्भर करता है कि आपकी सदस्यता में, इवेंट पेलोड में संसाधन का डेटा शामिल है या नहीं (
सदस्यता खत्म होने पर, उसे अपने-आप मिटा दिया जाता है. सदस्यता की समयसीमा खत्म होने से सदस्यता की समयसीमा खत्म होने से रोकने के लिए, उसकी समयसीमा बढ़ाने के लिए |
|
expireTime |
डिफ़ॉल्ट वैल्यू खाली नहीं है. सदस्यता खत्म होने का समय, यूटीसी में. इनपुट में जो भी इस्तेमाल किया गया हो, आउटपुट में हमेशा यह दिखता है. |
ttl |
सिर्फ़ इनपुट के लिए. सदस्यता के लिए टाइम-टू-लाइव (टीटीएल) या अवधि. अगर कोई वैल्यू सबमिट नहीं की गई है या इसे |
PayloadOptions
इवेंट पेलोड में कौनसा डेटा शामिल करना है, इसके विकल्प. यह सुविधा सिर्फ़ Google Chat इवेंट के लिए काम करती है.
JSON के काेड में दिखाना |
---|
{ "includeResource": boolean, "fieldMask": string } |
फ़ील्ड | |
---|---|
includeResource |
ज़रूरी नहीं. इवेंट पेलोड में, बदले गए संसाधन का डेटा शामिल है या नहीं. उदाहरण के लिए, किसी ऐसे इवेंट के लिए जहां Google Chat मैसेज बनाया गया था, क्या पेलोड में |
fieldMask |
ज़रूरी नहीं. अगर अगर आपने ऐसा फ़ील्ड तय किया है जो संसाधन के लिए मौजूद नहीं है, तो सिस्टम उस फ़ील्ड को अनदेखा कर देता है. |
NotificationEndpoint
वह एंडपॉइंट जहां सदस्यता, इवेंट डिलीवर करती है.
JSON के काेड में दिखाना |
---|
{ // Union field |
फ़ील्ड | |
---|---|
यूनियन फ़ील्ड
|
|
pubsubTopic |
इम्यूटेबल. Cloud Pub/Sub का वह विषय जिसे सदस्यता के लिए इवेंट मिलते हैं. फ़ॉर्मैट: आपको उसी Google Cloud प्रोजेक्ट में विषय बनाना होगा जिसमें आपने यह सदस्यता बनाई है. जब विषय को इवेंट मिलते हैं, तो इवेंट को Cloud Pub/Sub मैसेज के तौर पर कोड में बदल दिया जाता है. ज़्यादा जानकारी के लिए, CloudEvents के लिए Google Cloud Pub/Sub प्रोटोकॉल बाइंडिंग देखें. |
स्थिति
सदस्यता की संभावित स्थितियां.
Enums | |
---|---|
STATE_UNSPECIFIED |
डिफ़ॉल्ट मान. इस वैल्यू का इस्तेमाल नहीं किया जाता. |
ACTIVE |
सदस्यता चालू है और वह अपने सूचना एंडपॉइंट पर इवेंट पा सकती है और उन्हें डिलीवर कर सकती है. |
SUSPENDED |
किसी गड़बड़ी की वजह से, सदस्यता को इवेंट नहीं मिल पा रहे हैं. गड़बड़ी की पहचान करने के लिए, फ़ील्ड देखें. |
DELETED |
सदस्यता मिटा दी जाती है. |
ErrorType
सदस्यता से जुड़ी संभावित गड़बड़ियां.
Enums | |
---|---|
ERROR_TYPE_UNSPECIFIED |
डिफ़ॉल्ट मान. इस वैल्यू का इस्तेमाल नहीं किया जाता. |
USER_SCOPE_REVOKED |
अनुमति देने वाले उपयोगकर्ता ने एक या एक से ज़्यादा OAuth स्कोप को रद्द कर दिया है. Google Workspace के लिए अनुमति देने के बारे में ज़्यादा जानने के लिए, OAuth की सहमति वाली स्क्रीन को कॉन्फ़िगर करना लेख पढ़ें. |
RESOURCE_DELETED |
सदस्यता के लिए टारगेट किया गया रिसॉर्स अब मौजूद नहीं है. |
USER_AUTHORIZATION_FAILURE |
जिस उपयोगकर्ता ने सदस्यता बनाने की अनुमति दी थी उसके पास अब सदस्यता के टारगेट संसाधन का ऐक्सेस नहीं है. |
ENDPOINT_PERMISSION_DENIED |
Google Workspace ऐप्लिकेशन के पास, आपकी सदस्यता के सूचना एंडपॉइंट पर इवेंट डिलीवर करने का ऐक्सेस नहीं है. |
ENDPOINT_NOT_FOUND |
सदस्यता का सूचना एंडपॉइंट मौजूद नहीं है या उस Google Cloud प्रोजेक्ट में एंडपॉइंट नहीं मिला है जहां आपने सदस्यता बनाई थी. |
ENDPOINT_RESOURCE_EXHAUSTED |
सदस्यता के सूचना एंडपॉइंट को इवेंट नहीं मिले, क्योंकि कोटा कम है या दर सीमित है. |
OTHER |
कोई ऐसी गड़बड़ी हुई जिसकी पहचान नहीं की जा सकी. |
तरीके |
|
---|---|
|
Google Workspace की सदस्यता बनाता है. |
|
Google Workspace की सदस्यता मिटाता है. |
|
Google Workspace की सदस्यता के बारे में जानकारी पाता है. |
|
Google Workspace की सदस्यताओं की सूची दिखाता है. |
|
Google Workspace की सदस्यता को अपडेट या रिन्यू करता है. |
|
निलंबित की गई Google Workspace की सदस्यता को फिर से चालू करता है. |