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
  • मेटाडेटा
  • नाम

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

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

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

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

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

JSON के काेड में दिखाना 
{
  "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

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