Method: people.getBatchGet

यह अनुरोध किए गए संसाधन नामों की सूची बनाकर, खास लोगों की सूची के बारे में जानकारी देता है. पुष्टि किए गए उपयोगकर्ता की जानकारी देने के लिए, people/me का इस्तेमाल करें.

अगर 'personFields' तय नहीं है, तो अनुरोध 400 गड़बड़ी वाला मैसेज दिखाता है.

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

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

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

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

पैरामीटर
resourceNames[]

string

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

resourceNames=<name1>&resourceNames=<name2>&...

  • पुष्टि किए गए उपयोगकर्ता के बारे में जानकारी पाने के लिए, people/me बताएं.
  • किसी Google खाते के बारे में जानकारी पाने के लिए, people/{account_id} बताएं.
  • किसी संपर्क के बारे में जानकारी पाने के लिए, संसाधन का वह नाम बताएं जिससे संपर्क की पहचान, people.connections.list से मिले संपर्क के तौर पर होती है.

संसाधन के नाम ज़्यादा से ज़्यादा 200 हो सकते हैं.

requestMask
(deprecated)

object (RequestMask)

रोक दी गई (कृपया इसके बजाय personFields का इस्तेमाल करें)

व्यक्ति फ़ील्ड के सबसेट के नतीजों को सीमित करने के लिए मास्क.

personFields

string (FieldMask format)

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

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

enum (ReadSourceType)

ज़रूरी नहीं. इस बात का मास्क कि किस तरह के सोर्स को दिखाया जाए. अगर यह नीति सेट नहीं है, तो डिफ़ॉल्ट वैल्यू READ_SOURCE_TYPE_CONTACT और READ_SOURCE_TYPE_PROFILE होती है.

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

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

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

संसाधन के नाम के हिसाब से लोगों की सूची पाने के अनुरोध का जवाब.

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

जेएसओएन के काेड में दिखाना
{
  "responses": [
    {
      object (PersonResponse)
    }
  ]
}
फ़ील्ड
responses[]

object (PersonResponse)

अनुरोध किए गए हर संसाधन के नाम के लिए रिस्पॉन्स.

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

सार्वजनिक डेटा ऐक्सेस करने के लिए, अनुमति की ज़रूरत नहीं है. निजी डेटा के लिए, इनमें से कोई एक OAuth स्कोप ज़रूरी है:

  • https://www.googleapis.com/auth/contacts
  • https://www.googleapis.com/auth/contacts.readonly
  • https://www.googleapis.com/auth/contacts.other.readonly
  • https://www.googleapis.com/auth/directory.readonly
  • https://www.googleapis.com/auth/profile.agerange.read
  • https://www.googleapis.com/auth/profile.emails.read
  • https://www.googleapis.com/auth/profile.language.read
  • https://www.googleapis.com/auth/user.addresses.read
  • https://www.googleapis.com/auth/user.birthday.read
  • https://www.googleapis.com/auth/user.emails.read
  • https://www.googleapis.com/auth/user.gender.read
  • https://www.googleapis.com/auth/user.organization.read
  • https://www.googleapis.com/auth/user.phonenumbers.read
  • https://www.googleapis.com/auth/userinfo.email
  • https://www.googleapis.com/auth/userinfo.profile
  • https://www.googleapis.com/auth/profile.language.read

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