REST Resource: contactGroups

संसाधन: ContactGroup

संपर्क ग्रुप.

जेएसओएन के काेड में दिखाना 
{
  "resourceName": string,
  "etag": string,
  "metadata": {
    object (ContactGroupMetadata)
  },
  "groupType": enum (GroupType),
  "name": string,
  "formattedName": string,
  "memberResourceNames": [
    string
  ],
  "memberCount": integer,
  "clientData": [
    {
      object (GroupClientData)
    }
  ]
}
फ़ील्ड
resourceName

string

संपर्क ग्रुप के लिए संसाधन का नाम, जिसे सर्वर असाइन करता है. contactGroups/{contactGroupId} के तौर पर ASCII स्ट्रिंग.
etag

string

संसाधन का एचटीटीपी इकाई टैग. इसका इस्तेमाल, वेब कैश मेमोरी की पुष्टि करने के लिए किया जाता है.
metadata

object (ContactGroupMetadata)

सिर्फ़ आउटपुट के लिए. संपर्क ग्रुप के बारे में मेटाडेटा.
groupType

enum (GroupType)

सिर्फ़ आउटपुट के लिए. संपर्क ग्रुप का टाइप.
name

string

संपर्क ग्रुप का नाम, जिसे ग्रुप के मालिक ने सेट किया है या सिस्टम ग्रुप के लिए सिस्टम से मिला नाम.

contactGroups.create या contactGroups.update के लिए, उपयोगकर्ताओं के संपर्क ग्रुप का नाम यूनीक होना चाहिए. डुप्लीकेट नाम से ग्रुप बनाने की कोशिश करने पर एचटीटीपी 409 गड़बड़ी दिखेगी.
formattedName

string

सिर्फ़ आउटपुट के लिए. नाम का अनुवाद और उसे दर्शक के खाते की स्थान-भाषा या सिस्टम ग्रुप के नामों के लिए, Accept-Language एचटीटीपी हेडर स्थान-भाषा के हिसाब से फ़ॉर्मैट किया गया हो. मालिक की ओर से सेट किए गए ग्रुप के नाम और नाम एक जैसे होते हैं.
memberResourceNames[]

string

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

integer

सिर्फ़ आउटपुट के लिए. ग्रुप में मौजूद संपर्कों की कुल संख्या. इस बात से कोई फ़र्क़ नहीं पड़ता कि अनुरोध में ज़्यादा से ज़्यादा कितने सदस्य हैं.
clientData[]

object (GroupClientData)

ग्रुप के क्लाइंट का डेटा.

ContactGroupMetadata

किसी संपर्क ग्रुप के बारे में मेटाडेटा.

जेएसओएन के काेड में दिखाना 
{
  "updateTime": string,
  "deleted": boolean
}
फ़ील्ड
updateTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. ग्रुप को आखिरी बार अपडेट किए जाने का समय.

RFC3339 यूटीसी "ज़ुलु" फ़ॉर्मैट में एक टाइमस्टैंप, जिसमें नैनोसेकंड का रिज़ॉल्यूशन और नौ फ़्रैक्शनल अंक हो सकते हैं. उदाहरण: "2014-10-02T15:01:23Z" और "2014-10-02T15:01:23.045123456Z".
deleted

boolean

सिर्फ़ आउटपुट के लिए. अगर संपर्क ग्रुप का संसाधन मिटा दिया गया है, तो वैल्यू 'सही' होगी. सिर्फ़ contactGroups.list के उन अनुरोधों के लिए भरा जाता है जिनमें सिंक टोकन शामिल है.

GroupType

संपर्क ग्रुप का टाइप.

Enums
GROUP_TYPE_UNSPECIFIED नहीं बताया गया है
USER_CONTACT_GROUP उपयोगकर्ता तय संपर्क समूह.
SYSTEM_CONTACT_GROUP सिस्टम की ओर से तय किया गया संपर्क ग्रुप.

GroupClientData

आर्बिट्रेरी क्लाइंट डेटा, जिसे क्लाइंट से भरा जाता है. डुप्लीकेट कुंजियों और मानों की अनुमति है.

जेएसओएन के काेड में दिखाना 
{
  "key": string,
  "value": string
}
फ़ील्ड
key

string

क्लाइंट डेटा के लिए तय की गई कुंजी.
value

string

क्लाइंट डेटा के लिए तय की गई वैल्यू.

तरीके

batchGet

 संपर्क समूह के संसाधन नामों की सूची बनाकर, पुष्टि किए गए उपयोगकर्ता के मालिकाना हक वाले संपर्क समूहों की सूची पाएं.

create

 पुष्टि किए गए उपयोगकर्ता के मालिकाना हक वाला नया संपर्क ग्रुप बनाएं.

delete

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

get

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

list

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

update

 पुष्टि किए गए उपयोगकर्ता के मालिकाना हक वाले मौजूदा संपर्क ग्रुप का नाम अपडेट करें.