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

यह टोकन, स्पेस खोजने के पिछले कॉल से मिला है. अगला पेज पाने के लिए, यह पैरामीटर उपलब्ध कराएं.

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

string

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

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

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

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

  • displayName
  • externalUserAllowed
  • spaceType

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 फ़ील्ड की वैल्यू का इस्तेमाल किया जा सकता है.

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" AND spaceType = "SPACE"

(displayName:"Hello" OR displayName:"Fun") AND spaceType = "SPACE"

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

(externalUserAllowed = "true" AND displayName:"Hello" AND spaceType =
"SPACE")
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)

सिर्फ़ आउटपुट के लिए. मैच किया गया स्पेस.