Method: spaces.search

यह Google Workspace संगठन में मौजूद स्पेस की सूची दिखाता है. उदाहरण के लिए, स्पेस खोजना और उन्हें मैनेज करना लेख पढ़ें.

useAdminAccess को false पर सेट करने पर, नतीजे सिर्फ़ उन स्पेस में दिखते हैं जिनमें कॉल करने वाला व्यक्ति शामिल है. एडमिन के अधिकारों के साथ खोजने के लिए, useAdminAccess को true पर सेट करें. useAdminAccess को false पर सेट करने की सुविधा, डेवलपर के लिए झलक के तौर पर उपलब्ध है.

इन तरह के पुष्टि करने के तरीके काम करते हैं:

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

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 स्कोप की ज़रूरत होती है.

useAdminAccess को false पर सेट करने की सुविधा, डेवलपर के लिए झलक के तौर पर उपलब्ध है.

pageSize

integer

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

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

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

string

यह टोकन, search spaces API को किए गए पिछले कॉल से मिला है. अगला पेज पाने के लिए, यह पैरामीटर दें.

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

string

ज़रूरी है. सर्च क्वेरी.

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

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

जब useAdminAccess को false पर सेट किया जाता है, तब:

  • displayName
  • externalUserAllowed

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

useAdminAccess को true पर सेट करने पर, customer एट्रिब्यूट की वैल्यू देना ज़रूरी है. इसका इस्तेमाल यह बताने के लिए किया जाता है कि किस ग्राहक के स्पेस से डेटा फ़ेच करना है. customers/my_customer ही इस्तेमाल की जा सकने वाली वैल्यू है.

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

externalUserAllowed, true या false में से किसी एक को स्वीकार करता है.

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

useAdminAccess को true पर सेट करने पर, 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".

useAdminAccess को true पर सेट करने पर, क्वेरी के ये उदाहरण मान्य होते हैं:

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")

useAdminAccess को false पर सेट करने पर, क्वेरी के ये उदाहरण मान्य होते हैं:

displayName:"Hello World"

(displayName:"Hello" OR displayName:"Fun")

(externalUserAllowed = "true") // Returns an empty response.

(externalUserAllowed = "true" AND displayName:"Hello")
orderBy

string

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

इन एट्रिब्यूट के हिसाब से ऑर्डर किया जा सकता है:

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

जब useAdminAccess की वैल्यू false होती है, तब ऑर्डर करने के लिए सिर्फ़ createTime और relevance का इस्तेमाल किया जा सकता है. एडमिन के अलावा अन्य उपयोगकर्ताओं की खोजों में, इन फ़ील्ड के लिए सिर्फ़ DESC का इस्तेमाल किया जा सकता है.

ऑर्डर करने की कार्रवाई के लिए मान्य वैल्यू ये हैं:

  • ASC का इस्तेमाल बढ़ते क्रम के लिए किया जाता है. डिफ़ॉल्ट मान.

  • घटते क्रम के लिए, DESC.

useAdminAccess को true पर सेट करने पर, इन सिंटैक्स का इस्तेमाल किया जा सकता है:

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

जब useAdminAccess को false पर सेट किया जाता है, तब:

  • createTime DESC
  • relevance DESC

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

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

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

जवाब में, खोजे गए स्पेस से जुड़े स्पेस की सूची.

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

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

object (Space)

इस्तेमाल पर रोक लगा दी गई है: इसके बजाय, कृपया नए results फ़ील्ड का इस्तेमाल करें. अनुरोध किए गए स्पेस का पेज. इस फ़ील्ड में वैल्यू सिर्फ़ तब भरी जाएगी, जब useAdminAccess को true पर सेट किया गया हो. साथ ही, इसे नए results फ़ील्ड के लिए बंद कर दिया गया हो.
nextPageToken

string

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

integer

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

object (SearchSpaceResult)

सिर्फ़ आउटपुट के लिए.

क्वेरी से मेल खाने वाले खोज नतीजों की सूची.

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

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

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

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

SearchSpaceResult

स्पेस में की गई खोज का एक नतीजा.

JSON के काेड में दिखाना 
{
  "space": {
    object (Space)
  }
}
फ़ील्ड
space

object (Space)

सिर्फ़ आउटपुट के लिए. मिलता-जुलता स्पेस.