Method: spaces.findGroupChats

यह फ़ंक्शन, spaceType == GROUP_CHAT वाले सभी स्पेस दिखाता है. इनमें ऐसे स्पेस शामिल हैं जिनमें सिर्फ़ कॉल करने वाला उपयोगकर्ता और FindGroupChatsRequest.memberships में बताए गए उपयोगकर्ता शामिल हैं. उदाहरण के लिए, ग्रुप चैट ढूंढना लेख पढ़ें.

अगर कॉल करने वाला उपयोगकर्ता, कुछ उपयोगकर्ताओं को ब्लॉक करता है या उसे कुछ उपयोगकर्ताओं ने ब्लॉक किया है और उपयोगकर्ताओं के पूरे सेट वाला कोई स्पेस नहीं मिलता है, तो यह तरीका ऐसे स्पेस दिखाता है जिनमें ब्लॉक किए गए या ब्लॉक करने वाले उपयोगकर्ता शामिल नहीं होते हैं.

उपयोगकर्ताओं के चुने गए सेट में, सिर्फ़ ऐसे लोग शामिल होने चाहिए जो ऐप्लिकेशन का इस्तेमाल नहीं करते. अगर किसी अनुरोध में ऐसे उपयोगकर्ता शामिल हैं जो इंसान नहीं हैं, तो उस अनुरोध के जवाब में कोई स्पेस नहीं दिखाया जाता.

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

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

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

GET https://chat.googleapis.com/v1/spaces:findGroupChats

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

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

पैरामीटर
user[]

string

कॉल करने वाले व्यक्ति के साथ ग्रुप चैट में शामिल सभी लोगों के संसाधन के नाम. अनुरोध में चैट ऐप्लिकेशन शामिल नहीं किए जा सकते.

एक अनुरोध में ज़्यादा से ज़्यादा 49 उपयोगकर्ताओं को शामिल किया जा सकता है.

फ़ॉर्मैट: users/{user}, जहां {user}, People API में मौजूद व्यक्ति के लिए id या Directory API में मौजूद उपयोगकर्ता के लिए id होता है. उदाहरण के लिए, कॉल करने वाले उपयोगकर्ता और दो अन्य उपयोगकर्ताओं के साथ की गई सभी ग्रुप चैट ढूंढने के लिए, People API के प्रोफ़ाइल आईडी 123456789 और 987654321 के साथ users/123456789 और users/987654321 का इस्तेमाल किया जा सकता है. इस ईमेल पते को {user} के लिए उपनाम के तौर पर भी इस्तेमाल किया जा सकता है. उदाहरण के लिए, users/example@gmail.com जहां example@gmail.com, Google Chat इस्तेमाल करने वाले व्यक्ति का ईमेल पता है.

pageSize

integer

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

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

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

नेगेटिव वैल्यू डालने पर, INVALID_ARGUMENT गड़बड़ी दिखती है.

pageToken

string

ज़रूरी नहीं. यह एक पेज टोकन है. इसे ग्रुप चैट ढूंढने के लिए, पिछले कॉल से मिला है. अगला पेज पाने के लिए, यह पैरामीटर दें.

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

spaceView

enum (SpaceView)

स्पेस को देखने का अनुरोध किया गया है. अगर इसे सेट नहीं किया जाता है, तो डिफ़ॉल्ट रूप से SPACE_VIEW_RESOURCE_NAME_ONLY पर सेट होता है. SPACE_VIEW_EXPANDED के बारे में बताने वाले अनुरोधों में, ऐसे स्कोप शामिल होने चाहिए जिनसे स्पेस का डेटा पढ़ा जा सके. उदाहरण के लिए, https://www.googleapis.com/auth/chat.spaces या https://www.googleapis.com/auth/chat.spaces.readonly.

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

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

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

जवाब में, ग्रुप चैट स्पेस शामिल होते हैं. इनमें कॉल करने वाला उपयोगकर्ता और अनुरोध करने वाले उपयोगकर्ता शामिल होते हैं.

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

JSON फ़ॉर्मैट में दिखाया गया है
{
  "spaces": [
    {
      object (Space)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
spaces[]

object (Space)

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

nextPageToken

string

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

अनुमति पाने के लिंक

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

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

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

SpaceView

यह व्यू बताता है कि Space संसाधन में किन फ़ील्ड की वैल्यू भरी जानी चाहिए. हमारा सुझाव है कि आप अपने कोड में कुछ और वैल्यू शामिल करें, ताकि आने वाले समय में रिलीज़ होने वाले वर्शन के साथ वह काम कर सके.

Enums
SPACE_VIEW_UNSPECIFIED डिफ़ॉल्ट / सेट नहीं की गई वैल्यू.
SPACE_VIEW_RESOURCE_NAME_ONLY इससे सिर्फ़ स्पेस के संसाधन का नाम भरता है.
SPACE_VIEW_EXPANDED स्पेस संसाधन के फ़ील्ड भरता है. ध्यान दें: permissionSettings फ़ील्ड में वैल्यू नहीं भरी जाएगी. SPACE_VIEW_EXPANDED के बारे में बताने वाले अनुरोधों में, ऐसे स्कोप शामिल होने चाहिए जिनसे स्पेस का डेटा पढ़ा जा सके. उदाहरण के लिए, https://www.googleapis.com/auth/chat.spaces या https://www.googleapis.com/auth/chat.spaces.readonly.