REST Resource: contactGroups

रिसॉर्स: ContactGroup

एक संपर्क समूह.

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

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

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

string (Timestamp format)

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

आरएफ़सी3339 यूटीसी "ज़ुलु" में टाइमस्टैंप फ़ॉर्मैट, नैनोसेकंड रिज़ॉल्यूशन और ज़्यादा से ज़्यादा नौ फ़्रैक्शनल अंकों के साथ हो सकता है. उदाहरण: "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

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

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

string

क्लाइंट डेटा की क्लाइंट की ओर से बताई गई कुंजी.
value

string

क्लाइंट डेटा का क्लाइंट की ओर से तय किया गया मान.

तरीके

batchGet

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

create

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

delete

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

get

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

list

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

update

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