Method: contactGroups.list

पुष्टि किए गए उपयोगकर्ता के मालिकाना हक वाले सभी संपर्क ग्रुप की सूची बनाएं. संपर्क ग्रुप के सदस्यों की जानकारी अपने-आप नहीं भरती है.

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

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

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

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

पैरामीटर
pageToken

string

ज़रूरी नहीं. contactGroups.list को किए गए पिछले कॉल से NextPageToken की वैल्यू मिलती है. संसाधनों के अगले पेज का अनुरोध करता है.
pageSize

integer

ज़रूरी नहीं. लौटाए जाने वाले संसाधनों की ज़्यादा से ज़्यादा संख्या. मान्य वैल्यू 1 से 1, 000 के बीच की होनी चाहिए. इसमें दोनों शामिल हैं. अगर यह नीति सेट नहीं है या 0 पर सेट है, तो डिफ़ॉल्ट वैल्यू 30 होती है.
syncToken

string

ज़रूरी नहीं. यह सिंक टोकन, contactgroups.list पर किए गए पिछले कॉल पर मिलता है. सिंक टोकन बनाए जाने के बाद से बदले गए संसाधन ही दिखाए जाएंगे.
groupFields

string (FieldMask format)

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

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

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

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

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

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

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

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

object (ContactGroup)

संपर्क ग्रुप की सूची. संपर्क ग्रुप के सदस्यों की जानकारी अपने-आप नहीं भरती है.
totalItems

integer

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

string

यह टोकन, नतीजों का अगला पेज पाने के लिए इस्तेमाल किया जा सकता है.
nextSyncToken

string

वह टोकन जिसका इस्तेमाल, आखिरी अनुरोध के बाद किए गए बदलावों को वापस पाने के लिए किया जा सकता है.

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

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

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

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