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}"

यह क्वेरी 

event_types:"google.workspace.chat.message.v1.created" AND
  target_resource="//admin.googleapis.com/customers/my_customer"

सर्वर, अमान्य क्वेरी को 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

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