Method: contactGroups.update

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

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

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

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

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

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

पाथ पैरामीटर

पैरामीटर
contactGroup.resourceName

string

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

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

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

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

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