- एचटीटीपी अनुरोध
- क्वेरी पैरामीटर
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- अनुमति के दायरे
- इसे आज़माएं!
useAdminAccess
को true
पर सेट करें.
एचटीटीपी अनुरोध
GET https://chat.googleapis.com/v1/spaces:search
यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.
क्वेरी पैरामीटर
पैरामीटर | |
---|---|
useAdminAccess |
कॉल करने वाले उपयोगकर्ता के पास, Google Workspace एडमिन होना चाहिए. साथ ही, उसके पास चैट और स्पेस में होने वाली बातचीत को मैनेज करने का खास अधिकार होना चाहिए.
फ़िलहाल, यह तरीका सिर्फ़ एडमिन ऐक्सेस के साथ काम करता है. इसलिए, इस फ़ील्ड के लिए सिर्फ़ |
pageSize |
दिखाए जाने वाले स्पेस की ज़्यादा से ज़्यादा संख्या. सेवा इस वैल्यू से कम वैल्यू दिखा सकती है. अगर कोई स्पेस तय नहीं किया गया है, तो ज़्यादा से ज़्यादा 100 स्पेस दिए जा सकते हैं. वैल्यू ज़्यादा से ज़्यादा 1,000 हो सकती है. अगर आपने 1,000 से ज़्यादा की वैल्यू इस्तेमाल की है, तो वह अपने-आप 1000 में बदल जाती है. |
pageToken |
पिछले सर्च स्पेस कॉल से मिला टोकन. बाद वाले पेज को वापस पाने के लिए, यह पैरामीटर दें. पेजों को क्रम में लगाते समय, दिए गए अन्य सभी पैरामीटर, उस कॉल से मेल खाने चाहिए जो पेज टोकन दिया गया था. दूसरे पैरामीटर में अलग-अलग वैल्यू पास करने पर, अनचाहे नतीजे मिल सकते हैं. |
query |
ज़रूरी है. खोज क्वेरी. इन पैरामीटर का इस्तेमाल करके खोज की जा सकती है: -
अलग-अलग फ़ील्ड में, सिर्फ़ इसी फ़ील्ड में, उदाहरण के तौर पर दी गई क्वेरी मान्य हैं:
|
orderBy |
ज़रूरी नहीं. स्पेस की सूची किस क्रम में दिखती है. इन एट्रिब्यूट को क्रम में लगाया जा सकता है:
ऑर्डर करने की मान्य ऑपरेशन वैल्यू ये हैं:
इस्तेमाल किए जा सकने वाले सिंटैक्स ये हैं:
|
अनुरोध का मुख्य भाग
अनुरोध का मुख्य हिस्सा खाली होना चाहिए.
जवाब का मुख्य भाग
खोज के स्पेस के अनुरोध से जुड़े स्पेस की सूची बनाकर जवाब दें.
अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.
जेएसओएन के काेड में दिखाना |
---|
{
"spaces": [
{
object ( |
फ़ील्ड | |
---|---|
spaces[] |
अनुरोध किए गए स्पेस का पेज. |
nextPageToken |
अगला पेज वापस पाने के लिए इस्तेमाल किया जा सकने वाला टोकन. अगर यह फ़ील्ड खाली है, तो इसके बाद कोई पेज नहीं दिखेगा. |
totalSize |
सभी पेजों में मौजूद क्वेरी से मेल खाने वाले स्पेस की कुल संख्या. अगर नतीजे में 10,000 से ज़्यादा स्पेस मिलते हैं, तो यह एक अनुमानित वैल्यू होती है. |
अनुमति के दायरे
इनमें से किसी एक OAuth दायरों की ज़रूरत होती है:
https://www.googleapis.com/auth/chat.admin.spaces
https://www.googleapis.com/auth/chat.admin.spaces.readonly
ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.