Method: contactGroups.update

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

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

एक ही उपयोगकर्ता के लिए म्यूटेट अनुरोधों को क्रम से भेजा जाना चाहिए, ताकि इंतज़ार के समय में बढ़ोतरी और विफलताओं से बचा जा सके.

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

PUT https://people.googleapis.com/v1/{contactGroup.resourceName=contactGroups/*}

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

पाथ के पैरामीटर

पैरामीटर
contactGroup.resourceName

string

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

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

अनुरोध के मुख्य हिस्से में, इस तरह का डेटा शामिल होता है:

जेएसओएन के काेड में दिखाना
{
  "contactGroup": {
    "resourceName": string,
    "etag": string,
    "metadata": {
      "updateTime": string,
      "deleted": boolean
    },
    "groupType": enum (GroupType),
    "name": string,
    "formattedName": string,
    "memberResourceNames": [
      string
    ],
    "memberCount": integer,
    "clientData": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "updateGroupFields": string,
  "readGroupFields": string
}
फ़ील्ड
contactGroup.etag

string

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

contactGroup.metadata

object (ContactGroupMetadata)

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

contactGroup.groupType

enum (GroupType)

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

contactGroup.name

string

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

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

contactGroup.formattedName

string

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

contactGroup.memberResourceNames[]

string

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

contactGroup.memberCount

integer

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

contactGroup.clientData[]

object (GroupClientData)

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

updateGroupFields

string (FieldMask format)

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

  • clientData
  • नाम
readGroupFields

string (FieldMask format)

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

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

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

कामयाब रहने पर, जवाब के मुख्य हिस्से में ContactGroup का एक इंस्टेंस शामिल किया जाता है.

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

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

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

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