Method: people.listDirectoryPeople

पुष्टि किए गए उपयोगकर्ता की डोमेन डायरेक्ट्री में, डोमेन प्रोफ़ाइलों और डोमेन संपर्कों की सूची दिखाता है.

syncToken की वैल्यू तय करने पर, पिछले सिंक के बाद मिटाए गए संसाधनों को व्यक्ति के तौर पर दिखाया जाएगा. साथ ही, PersonMetadata.deleted की वैल्यू 'सही' पर सेट होगी.

pageToken या syncToken तय होने पर, दूसरे सभी अनुरोध पैरामीटर, पहले कॉल से मैच होने चाहिए.

सिंक करने के अनुरोधों के लिए, डेटा को लिखने में कुछ मिनट लग सकते हैं. इंक्रीमेंटल सिंक, डेटा को लिखने के बाद पढ़ने के उदाहरणों के लिए नहीं हैं.

डायरेक्ट्री में बदलाव करने वाले लोगों की सूची देखें पर जाकर, इसका इस्तेमाल करने का उदाहरण देखें.

एचटीटीपी अनुरोध

GET https://people.googleapis.com/v1/people:listDirectoryPeople

यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

क्वेरी पैरामीटर

पैरामीटर
readMask

string (FieldMask format)

ज़रूरी है. फ़ील्ड मास्क, जो यह तय करता है कि हर व्यक्ति के कौनसे फ़ील्ड दिखाए जाएं. एक से ज़्यादा फ़ील्ड तय करने के लिए, उन्हें कॉमा लगाकर अलग करें. मान्य मान हैं:

  • पते
  • ageRanges
  • जीवनियां
  • जन्मदिन
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • इवेंट
  • externalIds
  • लिंग
  • imClients
  • रुचियां
  • locales
  • जगहें
  • की पैसे चुकाकर ली जाने वाली सदस्यताएं
  • मेटाडेटा
  • miscKeywords
  • नाम
  • निकनेम
  • पेशे
  • संगठन
  • phoneNumbers
  • फ़ोटो
  • संबंध
  • sipAddresses
  • कौशल
  • यूआरएल
  • userDefined
sources[]

enum (DirectorySourceType)

ज़रूरी है. लौटाए जाने वाले डायरेक्ट्री सोर्स.
mergeSources[]

enum (DirectoryMergeSourceType)

ज़रूरी नहीं. डायरेक्ट्री सोर्स में मर्ज किया जाने वाला अतिरिक्त डेटा. हालांकि, ऐसा तब होता है, जब उन्हें पुष्टि की गई जॉइन की, जैसे कि ईमेल पते या फ़ोन नंबर से कनेक्ट किया गया हो.
pageSize

integer

ज़रूरी नहीं. जवाब में कितने लोगों को शामिल करना है. मान्य वैल्यू 1 से 1, 000 के बीच होनी चाहिए. अगर यह वैल्यू सेट नहीं की गई है या 0 पर सेट है, तो यह डिफ़ॉल्ट रूप से 100 पर सेट हो जाएगी.
pageToken

string

ज़रूरी नहीं. पेज टोकन, जो पिछले जवाब nextPageToken से मिला है. अगला पेज देखने के लिए, यह डालें.

पेजेशन करते समय, people.listDirectoryPeople को दिए गए सभी अन्य पैरामीटर, पेज टोकन देने वाले पहले कॉल से मेल खाने चाहिए.
requestSyncToken

boolean

ज़रूरी नहीं. क्या रिस्पॉन्स में nextSyncToken दिखना चाहिए. इसे अनुरोध syncToken पर सेट करके, पिछले अनुरोध के बाद हुए बदलावों को पाने के लिए इस्तेमाल किया जा सकता है.

सिंक करने के व्यवहार के बारे में ज़्यादा जानकारी के लिए, people.listDirectoryPeople पर जाएं.
syncToken

string

ज़रूरी नहीं. सिंक करने के लिए मिला टोकन, जो पिछले रिस्पॉन्स से मिला था nextSyncToken पिछली बार किए गए अनुरोध के बाद बदले गए संसाधनों को वापस पाने के लिए, यह टोकन दें.

सिंक करते समय, people.listDirectoryPeople को दिए गए सभी अन्य पैरामीटर, सिंक टोकन देने वाले पहले कॉल से मेल खाने चाहिए.

सिंक करने के व्यवहार के बारे में ज़्यादा जानकारी के लिए, people.listDirectoryPeople पर जाएं.

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

पुष्टि किए गए उपयोगकर्ता की डोमेन डायरेक्ट्री के लिए किए गए अनुरोध का जवाब.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

JSON के काेड में दिखाना 
{
  "people": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string
}
फ़ील्ड
people[]

object (Person)

डोमेन डायरेक्ट्री में मौजूद लोगों की सूची.
nextPageToken

string

एक टोकन, जिसे अगला पेज फिर से पाने के लिए pageToken के तौर पर भेजा जा सकता है. अगर इस फ़ील्ड को छोड़ा जाता है, तो इसके बाद कोई पेज नहीं दिखेगा.
nextSyncToken

string

एक टोकन, जिसे syncToken के तौर पर भेजा जा सकता है, ताकि पिछले अनुरोध के बाद हुए बदलावों को फिर से वापस पाया जा सके. सिंक टोकन दिखाने के लिए, अनुरोध में requestSyncToken को सेट करना ज़रूरी है.

अनुमति के दायरे

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

  • https://www.googleapis.com/auth/directory.readonly

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