REST Resource: contactGroups

संसाधन: संपर्क समूह

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

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

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

integer

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

object (GroupClientData)

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

संपर्क ग्रुप मेटाडेटा

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

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

string (Timestamp format)

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

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

boolean

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

ग्रुप किस तरह का है

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

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

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