- एचटीटीपी अनुरोध
- क्वेरी पैरामीटर
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- अनुमति के दायरे
- इसे आज़माएं!
पुष्टि किए गए उपयोगकर्ता की डोमेन डायरेक्ट्री में डोमेन प्रोफ़ाइलों और डोमेन संपर्कों की सूची उपलब्ध कराता है.
के बारे में बताने पर, पिछले सिंक के बाद से मिटाए गए संसाधन, उस व्यक्ति के तौर पर दिखाए जाएंगे जिसका syncToken
'सही' पर सेट है.PersonMetadata.deleted
या pageToken
के बारे में बताने पर, दूसरे सभी अनुरोध पैरामीटर, पहली कॉल से मेल खाने चाहिए.syncToken
सिंक के अनुरोधों को लागू होने में कुछ मिनट लग सकते हैं. इंक्रीमेंटल सिंक, 'लिखने के बाद पढ़ने' वाले इस्तेमाल के उदाहरणों के लिए नहीं बनाए गए हैं.
बदलाव करने वाले लोगों की डायरेक्ट्री की सूची बनाएं में, इसके इस्तेमाल का उदाहरण देखें.
एचटीटीपी अनुरोध
GET https://people.googleapis.com/v1/people:listDirectoryPeople
यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.
क्वेरी पैरामीटर
पैरामीटर | |
---|---|
readMask |
ज़रूरी है. फ़ील्ड मास्क, ताकि यह तय किया जा सके कि हर व्यक्ति को किन फ़ील्ड को लौटाया जा सकता है. एक से ज़्यादा फ़ील्ड को कॉमा लगाकर अलग करके, उन्हें तय किया जा सकता है. मान्य मान हैं:
|
sources[] |
ज़रूरी है. दिए जाने वाले डायरेक्ट्री के सोर्स. |
mergeSources[] |
ज़रूरी नहीं. अगर पुष्टि की गई जॉइन की, जैसे कि ईमेल पते या फ़ोन नंबर की मदद से कनेक्ट किया गया है, तो डायरेक्ट्री सोर्स में मर्ज किया जाने वाला अतिरिक्त डेटा. |
pageSize |
ज़रूरी नहीं. जवाब में शामिल किए जाने वाले लोगों की संख्या. मान्य वैल्यू 1 से 1, 000 के बीच की होनी चाहिए. इसमें दोनों शामिल हैं. अगर यह वैल्यू सेट नहीं है या 0 पर सेट है, तो डिफ़ॉल्ट वैल्यू 100 होती है. |
pageToken |
ज़रूरी नहीं. पिछले जवाब पेजों को क्रम में लगाते समय, |
requestSyncToken |
ज़रूरी नहीं. जवाब में सिंक के व्यवहार के बारे में ज़्यादा जानकारी |
syncToken |
ज़रूरी नहीं. पिछले जवाब से मिला सिंक टोकन सिंक करते समय, सिंक के व्यवहार के बारे में ज़्यादा जानकारी |
अनुरोध का मुख्य भाग
अनुरोध का मुख्य हिस्सा खाली होना चाहिए.
जवाब का मुख्य भाग
पुष्टि किए गए उपयोगकर्ता की डोमेन डायरेक्ट्री के लिए किए गए अनुरोध का जवाब.
अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.
जेएसओएन के काेड में दिखाना |
---|
{
"people": [
{
object ( |
फ़ील्ड | |
---|---|
people[] |
डोमेन डायरेक्ट्री में मौजूद लोगों की सूची. |
nextPageToken |
एक टोकन, जिसे अगला पेज वापस पाने के लिए |
nextSyncToken |
ऐसा टोकन जिसे पिछले अनुरोध के बाद किए गए बदलावों को वापस पाने के लिए, |
अनुमति के दायरे
नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:
https://www.googleapis.com/auth/directory.readonly
ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.