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

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

इस्तेमाल किए जा सकने वाले इवेंट टाइप, आपकी सदस्यता के टारगेट संसाधन पर निर्भर करते हैं. ज़्यादा जानकारी के लिए, 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} वैल्यू, Directory API का user.id फ़ील्ड है.
createTime

string (Timestamp format)

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

string (Timestamp format)

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

boolean

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

string

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

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

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

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

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

सदस्यता की समयसीमा खत्म होने से रोकने के लिए, उसकी समयसीमा बढ़ाने के लिए 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

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

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

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

ध्यान दें: Workspace Events API, क्रम से होने वाले इवेंट के फ़ायदे के लिए, क्रम तय करने वाली कुंजियों का इस्तेमाल करता है. अगर Cloud Pub/Sub विषय में, मैसेज के स्टोरेज की नीति को कॉन्फ़िगर करके, नज़दीकी Google 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 की सदस्यता को फिर से चालू करता है.