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 के लिए जवाब.

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

जेएसओएन के काेड में दिखाना 
{
  "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

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