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
  • नाम
  • निकनेम
  • व्यवसाय
  • संगठन
  • phoneNumbers
  • फ़ोटो
  • संबंध
  • sipAddresses
  • कौशल
  • यूआरएल
  • userDefined
sources[]

enum (DirectorySourceType)

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

enum (DirectoryMergeSourceType)

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

integer

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

string

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

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

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

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

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

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

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

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

object (Person)

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

string

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

integer

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

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

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

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

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