Method: spaces.members.list

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

पुष्टि करने के लिए, इन तरीकों का इस्तेमाल किया जा सकता है:

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

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

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

पाथ पैरामीटर

पैरामीटर
parent

string

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

फ़ॉर्मैट: spaces/{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

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