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
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.metadata
  • https://www.googleapis.com/auth/drive.metadata.readonly
  • https://www.googleapis.com/auth/drive.readonly

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