Method: people.searchDirectoryPeople

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

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

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

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

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

पैरामीटर
query

string

ज़रूरी है. व्यक्ति के फ़ील्ड से मेल खाने वाली प्रीफ़िक्स क्वेरी. यह तय करने के लिए कि कौनसे फ़ील्ड को मैच करना है, ReadMask का इस्तेमाल नहीं करता.
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 से 500 के बीच की होती हैं. इनमें भी शामिल हैं. अगर यह वैल्यू सेट नहीं है या 0 पर सेट है, तो डिफ़ॉल्ट वैल्यू 100 होती है.
pageToken

string

ज़रूरी नहीं. पिछले जवाब nextPageToken से मिला पेज टोकन. बाद वाला पेज फिर से पाने के लिए यह विकल्प दें.

पेज में नंबर डालकर, [people.searchDirectoryPeople][google.people.v1.SearchDirectoryPeople] को दिए गए अन्य सभी पैरामीटर, पेज टोकन उपलब्ध कराने वाले पहले कॉल से मेल खाने चाहिए.

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

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

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

पुष्टि किए गए उपयोगकर्ता की डोमेन डायरेक्ट्री में मौजूद लोगों से मिले ऐसे अनुरोध का जवाब जो दी गई क्वेरी से मेल खाता हो.

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

जेएसओएन के काेड में दिखाना 
{
  "people": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
फ़ील्ड
people[]

object (Person)

डोमेन डायरेक्ट्री में मौजूद उन लोगों की सूची जो क्वेरी से मेल खाते हैं.
nextPageToken

string

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

integer

पेज पर नंबर न डाले बिना, सूची में मौजूद आइटम की कुल संख्या.

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

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

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

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