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
  • names
  • प्रचलित नाम
  • व्यवसाय
  • organizations
  • phoneNumbers
  • फ़ोटोज
  • संबंध
  • sipAddresses
  • कौशल
  • urls
  • 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 पर उपलब्ध है.

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

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

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

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

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

जेएसओएन के काेड में दिखाना 
{
  "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

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