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 से ज़्यादा की वैल्यू इस्तेमाल की है, तो वह अपने-आप 1000 में बदल जाती है.
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, 'spacehistoryState', और '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

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

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

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

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

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

जेएसओएन के काेड में दिखाना 
{
  "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

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