Method: spaces.search

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

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

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

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

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

यह टोकन, searchSpaces को कॉल करने पर मिलता है. अगला पेज पाने के लिए, यह पैरामीटर दें.

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

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

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

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

जवाब में, खोज के लिए स्पेस के अनुरोध से जुड़े स्पेस की सूची शामिल होती है.

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

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

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