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

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