Method: subscriptions.list

Google Workspace की सदस्यताओं की सूची दिखाता है. इस तरीके का इस्तेमाल करने का तरीका जानने के लिए, Google Workspace की सदस्यताओं की सूची देखना लेख पढ़ें.

एचटीटीपी अनुरोध

GET https://workspaceevents.googleapis.com/v1/subscriptions

यूआरएल में gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल किया गया है.

क्वेरी पैरामीटर

पैरामीटर
pageSize

integer

ज़रूरी नहीं. वापस लाने के लिए सदस्यताओं की ज़्यादा से ज़्यादा संख्या. हो सकता है कि सेवा इस वैल्यू से कम नतीजे दिखाए.

अगर इसकी वैल्यू नहीं दी गई है या इसे 0 पर सेट किया गया है, तो ज़्यादा से ज़्यादा 50 सदस्यताएं दिखाई जाती हैं.

ज़्यादा से ज़्यादा वैल्यू 100 हो सकती है. अगर आपने 100 से ज़्यादा वैल्यू दी है, तो सिस्टम सिर्फ़ 100 सदस्यताएं दिखाएगा.
pageToken

string

ज़रूरी नहीं. पेज टोकन, जो सूची की सदस्यताओं के पिछले कॉल से मिला है. अगला पेज देखने के लिए, यह पैरामीटर दें.

पेजेशन करते समय, फ़िल्टर की वैल्यू उस कॉल से मेल खानी चाहिए जिसने पेज टोकन दिया है. कोई दूसरी वैल्यू देने पर, अनचाहे नतीजे मिल सकते हैं.
filter

string

ज़रूरी है. क्वेरी फ़िल्टर.

सदस्यताओं को इवेंट टाइप (event_types) और टारगेट किए गए संसाधन (target_resource) के हिसाब से फ़िल्टर किया जा सकता है.

आपको अपनी क्वेरी में कम से कम एक इवेंट टाइप बताना होगा. एक से ज़्यादा इवेंट टाइप को फ़िल्टर करने के लिए, OR ऑपरेटर का इस्तेमाल करें.

इवेंट टाइप और टारगेट किए गए रिसॉर्स, दोनों के हिसाब से फ़िल्टर करने के लिए, AND ऑपरेटर का इस्तेमाल करें. साथ ही, //chat.googleapis.com/spaces/{space} जैसे रिसॉर्स का पूरा नाम बताएं.

उदाहरण के लिए, ये क्वेरी मान्य हैं:

event_types:"google.workspace.chat.membership.v1.updated" OR
  event_types:"google.workspace.chat.message.v1.created"

event_types:"google.workspace.chat.message.v1.created" AND
  target_resource="//chat.googleapis.com/spaces/{space}"

( event_types:"google.workspace.chat.membership.v1.updated" OR
  event_types:"google.workspace.chat.message.v1.created" ) AND
  target_resource="//chat.googleapis.com/spaces/{space}"

सर्वर, अमान्य क्वेरी को INVALID_ARGUMENT गड़बड़ी के साथ अस्वीकार कर देता है.

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

SubscriptionsService.ListSubscriptions के लिए जवाब का मैसेज.

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

JSON के काेड में दिखाना 
{
  "subscriptions": [
    {
      object (Subscription)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
subscriptions[]

object (Subscription)

सदस्यताओं की सूची.
nextPageToken

string

एक टोकन, जिसे अगले पेज को फिर से पाने के लिए pageToken के तौर पर भेजा जा सकता है. अगर इस फ़ील्ड को छोड़ा जाता है, तो इसके बाद कोई पेज नहीं दिखेगा.

अनुमति के दायरे

इसके लिए, OAuth के इनमें से किसी एक स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/meetings.space.created
  • https://www.googleapis.com/auth/meetings.space.readonly

ज़्यादा जानकारी के लिए, अनुमति से जुड़ी गाइड देखें.