Method: spaces.members.list

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

इन तरह के authentication के साथ काम करता है:

  • ऐप्लिकेशन की पुष्टि, अनुमति के इन स्कोप में से किसी एक के साथ की गई हो:

  • उपयोगकर्ता की पुष्टि के लिए, अनुमति के इन स्कोप में से किसी एक का इस्तेमाल करें:

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.import (सिर्फ़ इंपोर्ट मोड वाले स्पेस)
    • उपयोगकर्ता की पुष्टि करने से, एडमिन को एडमिन के अधिकार मिलते हैं. ऐसा तब होता है, जब एडमिन खाता पुष्टि करता है, useAdminAccess true होता है, और इनमें से किसी एक अनुमति के दायरे का इस्तेमाल किया जाता है:
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships

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

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.app.memberships
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

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