REST Resource: subscriptions

संसाधन: सदस्यता

Google Workspace संसाधन के बारे में इवेंट पाने के लिए सदस्यता. सदस्यताओं के बारे में ज़्यादा जानने के लिए, Google Workspace Events API की खास जानकारी देखें.

JSON के काेड में दिखाना 
{
  "name": string,
  "uid": string,
  "targetResource": string,
  "eventTypes": [
    string
  ],
  "payloadOptions": {
    object (PayloadOptions)
  },
  "notificationEndpoint": {
    object (NotificationEndpoint)
  },
  "state": enum (State),
  "suspensionReason": enum (ErrorType),
  "authority": string,
  "createTime": string,
  "updateTime": string,
  "reconciling": boolean,
  "etag": string,

  // Union field expiration can be only one of the following:
  "expireTime": string,
  "ttl": string
  // End of list of possible types for union field expiration.
}
फ़ील्ड
name

string

ज़रूरी नहीं. इम्यूटेबल. आइडेंटिफ़ायर. सदस्यता के संसाधन का नाम.

फ़ॉर्मैट: subscriptions/{subscription}
uid

string

सिर्फ़ आउटपुट के लिए. सदस्यता के लिए, सिस्टम से असाइन किया गया यूनीक आइडेंटिफ़ायर.
targetResource

string

ज़रूरी है. इम्यूटेबल. वह Google Workspace संसाधन, जिसे इवेंट के लिए मॉनिटर किया जाता है. इसे संसाधन के पूरे नाम के तौर पर फ़ॉर्मैट किया जाता है. टारगेट के संसाधनों और उनके साथ काम करने वाले इवेंट के बारे में जानने के लिए, Google Workspace के साथ काम करने वाले इवेंट लेख पढ़ें.

कोई उपयोगकर्ता आपके ऐप्लिकेशन को, दिए गए टारगेट संसाधन के लिए सिर्फ़ एक सदस्यता बनाने की अनुमति दे सकता है. अगर आपका ऐप्लिकेशन इन उपयोगकर्ताओं के क्रेडेंशियल का इस्तेमाल करके, दूसरी सदस्यता बनाने की कोशिश करता है, तो अनुरोध ALREADY_EXISTS गड़बड़ी दिखाता है.
eventTypes[]

string

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

इस्तेमाल किए जा सकने वाले इवेंट के टाइप, आपकी सदस्यता के टारगेट संसाधन के हिसाब से तय होते हैं. ज़्यादा जानकारी के लिए, Google Workspace के साथ काम करने वाले इवेंट देखें.

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

अगर आपने किसी ऐसे इवेंट टाइप के बारे में बताया है जो टारगेट रिसॉर्स के लिए मौजूद नहीं है, तो अनुरोध एक एचटीटीपी 400 Bad Request स्टेटस कोड दिखाता है.
payloadOptions

object (PayloadOptions)

ज़रूरी नहीं. इवेंट पेलोड में कौनसा डेटा शामिल करना है, इसके विकल्प. यह सुविधा सिर्फ़ Google Chat इवेंट के लिए काम करती है.
notificationEndpoint

object (NotificationEndpoint)

ज़रूरी है. इम्यूटेबल. वह एंडपॉइंट जहां सदस्यता से इवेंट डिलीवर किए जाते हैं, जैसे कि Pub/Sub विषय.
state

enum (State)

सिर्फ़ आउटपुट के लिए. सदस्यता की स्थिति. यह नीति तय करती है कि सदस्यता में, इवेंट की जानकारी जोड़ी जा सकती है या नहीं. साथ ही, उन्हें सूचना एंडपॉइंट पर भेजा जा सकता है या नहीं.
suspensionReason

enum (ErrorType)

सिर्फ़ आउटपुट के लिए. ऐसी गड़बड़ी जिसकी वजह से सदस्यता निलंबित कर दी गई.

सदस्यता को फिर से चालू करने के लिए, गड़बड़ी को ठीक करें और subscriptions.reactivate तरीके को कॉल करें.
authority

string

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

फ़ॉर्मैट: users/{user}

Google Workspace के उपयोगकर्ताओं के लिए, {user} की वैल्यू, डायरेक्ट्री एपीआई में मौजूद user.id फ़ील्ड है.
createTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. सदस्यता बनाए जाने का समय.
updateTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. सदस्यता को पिछली बार अपडेट किए जाने का समय.
reconciling

boolean

सिर्फ़ आउटपुट के लिए. अगर true, सदस्यता को अपडेट किया जा रहा है.
etag

string

ज़रूरी नहीं. इस चेकसम की गणना सर्वर के ज़रिए अन्य फ़ील्ड के मान के आधार पर की जाती है और इसे अपडेट के अनुरोधों पर भेजा जा सकता है, ताकि यह पक्का किया जा सके कि आगे बढ़ने से पहले क्लाइंट के पास अप-टू-डेट मान है.

यूनियन फ़ील्ड expiration. सदस्यता खत्म होने का समय.

खत्म होने में लगने वाला ज़्यादा से ज़्यादा समय, इस बात पर निर्भर करता है कि आपकी सदस्यता में, इवेंट पेलोड में संसाधन का डेटा शामिल है या नहीं (PayloadOptions फ़ील्ड में बताया गया है):

  • अगर पेलोड, संसाधन का डेटा मिटा देते हैं, तो सात दिन तक का समय लग सकता है.
  • अगर पेलोड में संसाधन डेटा शामिल है, तो 4 घंटे तक का हो सकता है. अगर आपका Google Workspace संगठन, पूरे डोमेन के लोगों को डेटा का ऐक्सेस दें के ज़रिए, संसाधन का ऐक्सेस देता है, तो आपके पास सदस्यता की समयसीमा खत्म होने की तारीख को 24 घंटे तक बढ़ाने का विकल्प होता है.

सदस्यता खत्म होने पर, उसे अपने-आप मिटा दिया जाता है. आपको सदस्यता खत्म होने से एक घंटे पहले, notification_endpoint तक के लाइफ़साइकल इवेंट मिलते हैं. ज़्यादा जानकारी के लिए, लाइफ़साइकल इवेंट पाना और उनके जवाब देना देखें.

सदस्यता की समयसीमा खत्म होने से रोकने के लिए, UpdateSubscription तरीके का इस्तेमाल करके उसकी समयसीमा खत्म होने की तारीख बढ़ाई जा सकती है. ज़्यादा जानकारी के लिए, सदस्यता अपडेट या रिन्यू करना देखें. expiration इनमें से सिर्फ़ एक हो सकता है:
expireTime

string (Timestamp format)

डिफ़ॉल्ट वैल्यू खाली नहीं है. सदस्यता खत्म होने पर यूटीसी में टाइमस्टैंप. यह हमेशा आउटपुट पर दिखाया जाता है, चाहे इनपुट में किसी भी तरह का इस्तेमाल किया गया हो.
ttl

string (Duration format)

सिर्फ़ इनपुट. सदस्यता के लिए टाइम-टू-लाइव (टीटीएल) या अवधि. अगर तय नहीं है या 0 पर सेट है, तो ज़्यादा से ज़्यादा संभावित अवधि का इस्तेमाल करता है.

PayloadOptions

इवेंट पेलोड में कौनसा डेटा शामिल करना है, इसके विकल्प. यह सुविधा सिर्फ़ Google Chat इवेंट के लिए काम करती है.

JSON के काेड में दिखाना 
{
  "includeResource": boolean,
  "fieldMask": string
}
फ़ील्ड
includeResource

boolean

ज़रूरी नहीं. इवेंट पेलोड में, बदले गए संसाधन का डेटा शामिल है या नहीं. उदाहरण के लिए, अगर किसी इवेंट में Google Chat पर मैसेज बनाया गया है, तो उसके पेलोड में Message संसाधन का डेटा शामिल होगा या नहीं. गलत होने पर, इवेंट पेलोड में सिर्फ़ बदले गए संसाधन का नाम शामिल होता है.
fieldMask

string (FieldMask format)

ज़रूरी नहीं. अगर includeResource को true पर सेट किया गया है, तो इवेंट पेलोड में शामिल किए जाने वाले फ़ील्ड की सूची. फ़ील्ड को कॉमा लगाकर अलग करें. जैसे, Google Chat मैसेज भेजने वाले व्यक्ति को शामिल करने और समय की जानकारी जोड़ने के लिए, message.sender,message.createTime डालें. अगर इसे छोड़ा जाता है, तो पेलोड में संसाधन के सभी फ़ील्ड शामिल होते हैं.

अगर किसी ऐसे फ़ील्ड का इस्तेमाल किया जाता है जो संसाधन के लिए मौजूद नहीं है, तो सिस्टम उस फ़ील्ड को अनदेखा कर देता है.

NotificationEndpoint

वह एंडपॉइंट जहां सदस्यता, इवेंट डिलीवर करती है.

JSON के काेड में दिखाना 
{

  // Union field endpoint can be only one of the following:
  "pubsubTopic": string
  // End of list of possible types for union field endpoint.
}
फ़ील्ड

यूनियन फ़ील्ड endpoint.

endpoint इनमें से सिर्फ़ एक हो सकता है:
pubsubTopic

string

इम्यूटेबल. Cloud Pub/Sub विषय, जिसमें सदस्यता के इवेंट मिलते हैं.

फ़ॉर्मैट: projects/{project}/topics/{topic}

आपको यह विषय उसी Google Cloud प्रोजेक्ट में बनाना होगा जिस पर आपने यह सदस्यता बनाई है.

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

स्थिति

सदस्यता के लिए संभावित स्थितियां.

Enums
STATE_UNSPECIFIED डिफ़ॉल्ट मान. इस वैल्यू का इस्तेमाल नहीं किया गया है.
ACTIVE सदस्यता चालू है. साथ ही, यह सूचना एंडपॉइंट पर इवेंट पा सकती है और उन्हें डिलीवर कर सकती है.
SUSPENDED किसी गड़बड़ी की वजह से, सदस्यता में इवेंट की जानकारी नहीं मिल पा रही है. गड़बड़ी का पता लगाने के लिए, suspensionReason फ़ील्ड देखें.
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 कोई ऐसी गड़बड़ी हुई जिसकी पहचान नहीं की जा सकी.

तरीके

create

 यह Google Workspace की सदस्यता बनाता है.

delete

 इससे Google Workspace की सदस्यता मिट जाएगी.

get

 Google Workspace की सदस्यता के बारे में ज़्यादा जानकारी देता है.

list

 यह Google Workspace की सदस्यताओं की सूची उपलब्ध कराता है.

patch

 Google Workspace की सदस्यता को अपडेट या रिन्यू करता है.

reactivate

 Google Workspace की निलंबित सदस्यता को फिर से चालू करेगा.