Method: spaces.search

उपयोगकर्ता की खोज के आधार पर स्पेस की सूची दिखाता है. उपयोगकर्ता की पुष्टि ज़रूरी है. उपयोगकर्ता, Google Workspace संगठन का एडमिन होना चाहिए. अनुरोध में, useAdminAccess को true पर सेट करें.

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

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

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

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

पैरामीटर
useAdminAccess

boolean

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

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

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

फ़िलहाल, इस तरीके से सिर्फ़ एडमिन ऐक्सेस काम करता है. इसलिए, इस फ़ील्ड के लिए सिर्फ़ true को स्वीकार किया जाता है.
pageSize

integer

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

अगर कोई वैल्यू न दी गई हो, तो ज़्यादा से ज़्यादा 100 स्पेस लौटाए जाते हैं.

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

string

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

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

string

ज़रूरी है. एक खोज क्वेरी.

इन पैरामीटर का इस्तेमाल करके, जानकारी खोजी जा सकती है:

  • createTime
  • customer
  • displayName
  • externalUserAllowed
  • lastActiveTime
  • spaceHistoryState
  • spaceType

createTime और lastActiveTime, RFC-3339 फ़ॉर्मैट में टाइमस्टैंप स्वीकार करते हैं. साथ ही, तुलना करने वाले इन ऑपरेटर का इस्तेमाल किया जा सकता है: =, <, >, <=, >=.

customer ज़रूरी है. इसका इस्तेमाल यह बताने के लिए किया जाता है कि किस ग्राहक से स्पेस फ़ेच करने हैं. सिर्फ़ customers/my_customer वैल्यू इस्तेमाल की जा सकती है.

displayName सिर्फ़ HAS (:) ऑपरेटर को स्वीकार करता है. मैच किए जाने वाले टेक्स्ट को सबसे पहले, टोकन में टोकन के तौर पर टोकन किया जाता है. हर टोकन, स्पेस के displayName में कहीं भी सबस्ट्रिंग के तौर पर, केस-इनसेंसिटिव (बड़े और छोटे अक्षरों में अंतर) के तौर पर प्रीफ़िक्स का इस्तेमाल करता है. उदाहरण के लिए, Fun Eve, Fun event या The evening was fun से मेल खाता है, लेकिन notFun event या even से नहीं.

externalUserAllowed, true या false को स्वीकार करता है.

spaceHistoryState सिर्फ़ space संसाधन के historyState फ़ील्ड से वैल्यू स्वीकार करता है.

spaceType ज़रूरी है और सिर्फ़ SPACE मान्य मान है.

अलग-अलग फ़ील्ड में, सिर्फ़ AND ऑपरेटर काम करते हैं. spaceType = "SPACE" AND displayName:"Hello" सही उदाहरण है और spaceType = "SPACE" OR displayName:"Hello" अमान्य उदाहरण है.

इसी फ़ील्ड में, spaceType पर AND या OR ऑपरेटर काम नहीं करते. displayName, 'space इतिहासState', और 'externalUserAllowed' सिर्फ़ OR ऑपरेटर के साथ काम किया जा सकता है. lastActiveTime और createTime, AND और OR, दोनों ऑपरेटर के साथ काम करते हैं. AND का इस्तेमाल सिर्फ़ किसी इंटरवल को दिखाने के लिए किया जा सकता है, जैसे कि lastActiveTime < "2022-01-01T00:00:00+00:00" AND lastActiveTime > "2023-01-01T00:00:00+00:00".

उदाहरण के तौर पर, यहां दी गई क्वेरी मान्य हैं:

customer = "customers/my_customer" AND spaceType = "SPACE"

customer = "customers/my_customer" AND spaceType = "SPACE" AND
displayName:"Hello World"

customer = "customers/my_customer" AND spaceType = "SPACE" AND
(lastActiveTime < "2020-01-01T00:00:00+00:00" OR lastActiveTime >
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND spaceType = "SPACE" AND
(displayName:"Hello World" OR displayName:"Fun event") AND
(lastActiveTime > "2020-01-01T00:00:00+00:00" AND lastActiveTime <
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND spaceType = "SPACE" AND
(createTime > "2019-01-01T00:00:00+00:00" AND createTime <
"2020-01-01T00:00:00+00:00") AND (externalUserAllowed = "true") AND
(spaceHistoryState = "HISTORY_ON" OR spaceHistoryState = "HISTORY_OFF")
orderBy

string

ज़रूरी नहीं. स्पेस की सूची को क्रम से लगाने का तरीका.

इसके हिसाब से क्रम में लगाने के लिए, ये एट्रिब्यूट इस्तेमाल किए जा सकते हैं:

  • membershipCount.joined_direct_human_user_count — स्पेस में सीधे तौर पर शामिल हुए, उपयोगकर्ताओं की संख्या दिखाता है.
  • lastActiveTime — इससे यह पता चलता है कि इस स्पेस में किसी विषय के लिए, ज़रूरी शर्तें पूरी करने वाले आखिरी आइटम को कब जोड़ा गया था.
  • createTime — स्पेस बनाने का समय दिखाता है.

ऑर्डर करने के मान्य ऑपरेशन मान ये हैं:

  • बढ़ते क्रम में लगाने के लिए ASC. डिफ़ॉल्ट मान.

  • घटते क्रम में लगाने के लिए, DESC.

इस्तेमाल किए जा सकने वाले सिंटैक्स हैं:

  • membershipCount.joined_direct_human_user_count DESC
  • membershipCount.joined_direct_human_user_count ASC
  • lastActiveTime DESC
  • lastActiveTime ASC
  • createTime DESC
  • createTime ASC

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

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

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

खोज स्पेस के अनुरोध से जुड़े स्पेस की सूची की मदद से जवाब दें.

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

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

object (Space)

अनुरोध किए गए स्पेस का पेज.
nextPageToken

string

एक टोकन, जिसका इस्तेमाल अगले पेज को फिर से पाने के लिए किया जा सकता है. अगर यह फ़ील्ड खाली है, तो इसके बाद कोई पेज नहीं होता.
totalSize

integer

सभी पेजों पर, क्वेरी से मैच करने वाले स्पेस की कुल संख्या. अगर नतीजे में 10,000 से ज़्यादा स्पेस हैं, तो यह एक अनुमानित वैल्यू होती है.

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

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

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly

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