Method: contactGroups.get

संपर्क समूह संसाधन नाम तय करके प्रमाणित उपयोगकर्ता के मालिकाना हक वाला एक खास संपर्क समूह पाएं.

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

GET https://people.googleapis.com/v1/{resourceName=contactGroups/*}

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

पाथ के पैरामीटर

पैरामीटर
resourceName

string

ज़रूरी है. संपर्क ग्रुप को दिए जाने वाले संसाधन का नाम.

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

पैरामीटर
maxMembers

integer

ज़रूरी नहीं. यह बताता है कि ज़्यादा से ज़्यादा कितने सदस्य लौट सकते हैं. अगर इस नीति को सेट नहीं किया जाता है, तो यह डिफ़ॉल्ट रूप से 0 पर सेट होती है. इससे सदस्यों की संख्या शून्य होगी.
groupFields

string (FieldMask format)

ज़रूरी नहीं. फ़ील्ड मास्क, ताकि यह तय किया जा सके कि ग्रुप के कौनसे फ़ील्ड दिखाए जाएं. अगर यह नीति सेट नहीं है या 'खाली है' पर सेट है, तो डिफ़ॉल्ट तौर पर metadata, groupType, memberCount, और name सेट होता है. मान्य फ़ील्ड हैं:

  • clientData
  • groupType
  • memberCount
  • मेटाडेटा
  • नाम

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

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

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

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

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

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

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

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