Method: spaces.members.list

यह विकल्प, स्पेस में पैसे चुकाकर ली जाने वाली सदस्यताओं की सूची दिखाता है. उदाहरण के लिए, स्पेस में उपयोगकर्ताओं और Google Chat ऐप्लिकेशन की सूची बनाना देखें. ऐप्लिकेशन की पुष्टि करने पर, पैसे चुकाकर ली जाने वाली सदस्यताओं की सूची में, उन स्पेस की सदस्यताओं की सूची शामिल होती है जिनका ऐक्सेस Chat ऐप्लिकेशन के पास है. हालांकि, इसमें Chat ऐप्लिकेशन की सदस्यताएं शामिल नहीं हैं. उपयोगकर्ता की पुष्टि के साथ सदस्यताओं की सूची बनाने पर, उन स्पेस की सदस्यताओं की सूची बनती है जिनका ऐक्सेस पुष्टि किए गए उपयोगकर्ता के पास है.

पुष्टि करना ज़रूरी है. ऐप्लिकेशन की पुष्टि और उपयोगकर्ता की पुष्टि करने की सुविधा काम करती है.

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

GET https://chat.googleapis.com/v1/{parent=spaces/*}/members

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

पाथ पैरामीटर

पैरामीटर
parent

string

ज़रूरी है. स्पेस का संसाधन नाम, जिसके लिए सदस्यता की सूची फ़ेच करनी है.

फ़ॉर्मैट: स्पेस/{space}

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

पैरामीटर
pageSize

integer

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

अगर जानकारी नहीं दी जाती है, तो ज़्यादा से ज़्यादा 100 सदस्यताएं दिखाई जा सकती हैं.

ज़्यादा से ज़्यादा वैल्यू 1,000 है. अगर 1,000 से ज़्यादा वैल्यू का इस्तेमाल किया जाता है, तो वह अपने-आप 1,000 में बदल जाता है.

नेगेटिव वैल्यू से INVALID_ARGUMENT गड़बड़ी मिलती है.
pageToken

string

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

पेजों पर नंबर डालते समय, दिए गए अन्य सभी पैरामीटर, पेज टोकन देने वाले कॉल से मैच होने चाहिए. दूसरे पैरामीटर के लिए अलग-अलग वैल्यू पास करने पर, अनचाहे नतीजे मिल सकते हैं.
filter

string

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

सदस्य की भूमिका (role) और टाइप (member.type) के हिसाब से, पैसे चुकाकर ली जाने वाली सदस्यताओं को फ़िल्टर किया जा सकता है.

भूमिका के हिसाब से फ़िल्टर करने के लिए, role को ROLE_MEMBER या ROLE_MANAGER पर सेट करें.

टाइप के हिसाब से फ़िल्टर करने के लिए, member.type को HUMAN या BOT पर सेट करें. डेवलपर की झलक: != ऑपरेटर का इस्तेमाल करके भी member.type को फ़िल्टर किया जा सकता है.

भूमिका और टाइप, दोनों के हिसाब से फ़िल्टर करने के लिए, AND ऑपरेटर का इस्तेमाल करें. किसी भी भूमिका या टाइप के हिसाब से फ़िल्टर करने के लिए, OR ऑपरेटर का इस्तेमाल करें.

useAdminAccess को 'सही है' पर सेट करने पर, member.type = "HUMAN" या member.type != "BOT" में से किसी एक को चुनना ज़रूरी है. अन्य मेंबर टाइप फ़िल्टर अस्वीकार कर दिए जाएंगे.

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

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

member.type != "BOT"

ये क्वेरी अमान्य हैं:

member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

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

boolean

ज़रूरी नहीं. जब true, दूसरी तरह की सदस्यताओं के साथ-साथ, Google Group से जुड़ी सदस्यताएं भी दिखाता है. अगर filter सेट है, तो Google Group की ऐसी सदस्यताएं नहीं दिखाई जाती हैं जो फ़िल्टर करने की शर्तों से मेल नहीं खातीं.
showInvited

boolean

ज़रूरी नहीं. जब true, अन्य तरह की सदस्यताओं के साथ-साथ, invited सदस्यों से जुड़ी सदस्यताएं भी दिखाता है. अगर कोई फ़िल्टर सेट किया जाता है, तो फ़िल्टर करने की शर्तों से मेल न खाने वाली invited सदस्यताएं नहीं दिखाई जाती हैं.

फ़िलहाल, उपयोगकर्ता की पुष्टि ज़रूरी है.
useAdminAccess

boolean

true के साथ, यह तरीका उपयोगकर्ता के Google Workspace एडमिन के खास अधिकारों का इस्तेमाल करके चलता है.

कॉल करने वाला उपयोगकर्ता, Google Workspace एडमिन होना चाहिए. उसके पास, चैट और स्पेस में होने वाली बातचीत को मैनेज करने का अधिकार होना चाहिए.

chat.admin.memberships.readonly या chat.admin.memberships OAuth 2.0 स्कोप की ज़रूरत होती है.

एडमिन ऐक्सेस का इस्तेमाल करते समय, स्पेस में ऐप्लिकेशन की पैसे चुकाकर ली जाने वाली सदस्यताओं की लिस्टिंग नहीं की जा सकती.

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

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

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

स्पेस की सदस्यताओं की सूची का जवाब दें.

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

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

object (Membership)

बिना क्रम वाली सूची. अनुरोध किए गए (या पहले) पेज पर मौजूद सदस्यताओं की सूची.
nextPageToken

string

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

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

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

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

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