Method: people.searchContacts

पुष्टि किए गए उपयोगकर्ता के ग्रुप किए गए संपर्कों के उन संपर्कों की सूची देता है जो खोज क्वेरी से मेल खाते हैं. क्वेरी, किसी संपर्क के names, nickNames, emailAddresses, phoneNumbers, और organizations फ़ील्ड से मैच हो रही है. यह फ़ील्ड CONTACT सोर्स के है.

अहम जानकारी: खोज करने से पहले, क्लाइंट को कैश मेमोरी को अपडेट करने के लिए, खाली क्वेरी के साथ वॉर्मअप का अनुरोध भेजना चाहिए. https://developers.google.com/people/v1/contacts#search_the_users_contacts पर जाएं

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

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

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

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

पैरामीटर
query

string

ज़रूरी है. अनुरोध के लिए सादे टेक्स्ट वाली क्वेरी. क्वेरी का इस्तेमाल किसी व्यक्ति पर फ़ील्ड के उपसर्ग वाक्यांशों से मिलान करने के लिए किया जाता है. उदाहरण के लिए, "foo name" नाम वाला व्यक्ति, "f", "fo", "foo", "foo n", "nam" वगैरह जैसी क्वेरी से मैच करता है, लेकिन "oo n" से नहीं.
pageSize

integer

ज़रूरी नहीं. दिखाए जाने वाले नतीजों की संख्या. अगर फ़ील्ड की वैल्यू सेट नहीं है, तो यह वैल्यू डिफ़ॉल्ट रूप से 10 होती है या 0 पर सेट होती है. 30 से ज़्यादा वैल्यू को 30 तक सीमित किया जाएगा.
readMask

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 होती है.

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

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

जवाब का मुख्य हिस्सा

कामयाब रहने पर, जवाब के मुख्य हिस्से में SearchResponse का एक इंस्टेंस शामिल किया जाता है.

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

इनमें से किसी एक OAuth दायरों की ज़रूरत होती है:

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

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