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, '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

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