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