संसाधन: सदस्यता
जेएसओएन के काेड में दिखाना |
---|
{ "name": string, "uid": string, "targetResource": string, "eventTypes": [ string ], "payloadOptions": { object ( |
फ़ील्ड | |
---|---|
name |
ज़रूरी नहीं. इम्यूटेबल. आइडेंटिफ़ायर. सदस्यता के संसाधन का नाम. फ़ॉर्मैट: |
uid |
सिर्फ़ आउटपुट के लिए. सदस्यता के लिए सिस्टम से असाइन किया गया यूनीक आइडेंटिफ़ायर. |
targetResource |
ज़रूरी है. इम्यूटेबल. Google Workspace का वह संसाधन जिसे इवेंट के लिए मॉनिटर किया जाता है. यह संसाधन के पूरे नाम के तौर पर फ़ॉर्मैट किया जाता है. टारगेट किए गए संसाधनों और उनके साथ काम करने वाले इवेंट के बारे में जानने के लिए, इस्तेमाल किए जा सकने वाले Google Workspace इवेंट लेख पढ़ें. कोई उपयोगकर्ता आपके ऐप्लिकेशन को, सिर्फ़ किसी टारगेट संसाधन के लिए एक सदस्यता बनाने की अनुमति दे सकता है. अगर आपका ऐप्लिकेशन, एक ही उपयोगकर्ता के क्रेडेंशियल का इस्तेमाल करके दूसरी सदस्यता बनाने की कोशिश करता है, तो अनुरोध करने पर |
eventTypes[] |
ज़रूरी है. इम्यूटेबल. बिना क्रम वाली सूची. सदस्यता बनाने के लिए इनपुट. अगर ऐसा नहीं है, तो सिर्फ़ आउटपुट के लिए है. टारगेट संसाधन के बारे में पाने के लिए एक या उससे ज़्यादा तरह के इवेंट. CloudEvent स्पेसिफ़िकेशन के मुताबिक फ़ॉर्मैट किए गए. इस्तेमाल किए जा सकने वाले इवेंट के टाइप, आपकी सदस्यता के टारगेट संसाधन पर निर्भर करते हैं. ज़्यादा जानकारी के लिए, Google Workspace के साथ काम करने वाले इवेंट देखें. डिफ़ॉल्ट रूप से, आपको अपनी सदस्यता की लाइफ़साइकल से जुड़े इवेंट भी मिलते हैं. इस फ़ील्ड के लिए, आपको लाइफ़साइकल इवेंट तय करने की ज़रूरत नहीं है. अगर किसी ऐसे इवेंट टाइप के बारे में बताया जाता है जो टारगेट रिसॉर्स के लिए मौजूद नहीं है, तो अनुरोध एक एचटीटीपी |
payloadOptions |
ज़रूरी नहीं. इवेंट पेलोड में कौनसा डेटा शामिल किया जाए, इसके बारे में विकल्प. यह सुविधा सिर्फ़ Google Chat इवेंट के लिए काम करती है. |
notificationEndpoint |
ज़रूरी है. इम्यूटेबल. वह एंडपॉइंट जहां सदस्यता से इवेंट डिलीवर किए जाते हैं, जैसे कि Pub/Sub विषय. |
state |
सिर्फ़ आउटपुट के लिए. सदस्यता की स्थिति. इससे यह तय होता है कि सदस्यता, इवेंट पा सकती है या नहीं. साथ ही, यह उन्हें सूचना के एंडपॉइंट पर डिलीवर करती है या नहीं. |
suspensionReason |
सिर्फ़ आउटपुट के लिए. वह गड़बड़ी जिसकी वजह से सदस्यता निलंबित हो गई. सदस्यता को फिर से चालू करने के लिए, गड़बड़ी को ठीक करें और |
authority |
सिर्फ़ आउटपुट के लिए. वह उपयोगकर्ता जिसने सदस्यता बनाने की अनुमति दी थी. फ़ॉर्मैट: Google Workspace के उपयोगकर्ताओं के लिए, डायरेक्ट्री एपीआई में मौजूद |
createTime |
सिर्फ़ आउटपुट के लिए. सदस्यता बनाए जाने का समय. |
updateTime |
सिर्फ़ आउटपुट के लिए. सदस्यता को पिछली बार अपडेट किए जाने का समय. |
reconciling |
सिर्फ़ आउटपुट के लिए. अगर |
etag |
ज़रूरी नहीं. इस चेकसम का हिसाब, अन्य फ़ील्ड की वैल्यू के आधार पर सर्वर करता है. इसे अपडेट के अनुरोधों पर भेजा जा सकता है, ताकि आगे बढ़ने से पहले यह पक्का किया जा सके कि क्लाइंट के पास अप-टू-डेट वैल्यू है. |
यूनियन फ़ील्ड खत्म होने की ज़्यादा से ज़्यादा समयसीमा, इस बात पर निर्भर करती है कि आपकी सदस्यता में, इवेंट पेलोड में संसाधन डेटा शामिल है या नहीं (
सदस्यता की समयसीमा खत्म होने के बाद, वह अपने-आप मिट जाती है. आपको किसी सदस्यता की समयसीमा खत्म होने से रोकने के लिए, |
|
expireTime |
डिफ़ॉल्ट फ़ील्ड खाली नहीं है. सदस्यता खत्म होने के बाद का टाइमस्टैंप, यूटीसी में. आउटपुट पर हमेशा दिखाया जाता है, इससे कोई फ़र्क़ नहीं पड़ता कि इनपुट में क्या इस्तेमाल किया गया है. |
ttl |
सिर्फ़ इनपुट. सदस्यता के लिए टाइम-टू-लाइव (TTL) या अवधि. अगर यह जानकारी नहीं है या |
PayloadOptions
इवेंट पेलोड में कौनसा डेटा शामिल किया जाए, इसके बारे में विकल्प. यह सुविधा सिर्फ़ Google Chat इवेंट के लिए काम करती है.
जेएसओएन के काेड में दिखाना |
---|
{ "includeResource": boolean, "fieldMask": string } |
फ़ील्ड | |
---|---|
includeResource |
ज़रूरी नहीं. इवेंट पेलोड में उस संसाधन का डेटा शामिल है या नहीं जिसमें बदलाव किया गया है. उदाहरण के लिए, किसी ऐसे इवेंट के लिए जहां Google Chat मैसेज बनाया गया था, क्या पेलोड में |
fieldMask |
ज़रूरी नहीं. अगर अगर कोई ऐसा फ़ील्ड चुना जाता है जो संसाधन के लिए मौजूद नहीं है, तो सिस्टम उस फ़ील्ड को अनदेखा कर देता है. |
NotificationEndpoint
वह एंडपॉइंट जहां सदस्यता, इवेंट डिलीवर करती है.
जेएसओएन के काेड में दिखाना |
---|
{ // Union field |
फ़ील्ड | |
---|---|
यूनियन फ़ील्ड
|
|
pubsubTopic |
इम्यूटेबल. Cloud Pub/Sub विषय, जिसे सदस्यता के लिए इवेंट मिलते हैं. फ़ॉर्मैट: आपको उसी Google Cloud प्रोजेक्ट में विषय बनाना होगा जिसमें आपने यह सदस्यता बनाई है. जब विषय को इवेंट मिलते हैं, तो इवेंट को Cloud Pub/Sub मैसेज के तौर पर कोड में बदल दिया जाता है. ज़्यादा जानकारी के लिए, CloudEvent के लिए 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 सदस्यता को फिर से चालू करता है. |