Method: contactGroups.update

更新已驗證使用者擁有的現有聯絡人群組名稱。

更新的聯絡人群組名稱不得重複，而且不可重複。如果嘗試以重複的名稱建立群組，會傳回 HTTP 409 錯誤。

請為同一位使用者依序傳送 Mutate 要求，以避免延遲時間增加和失敗。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
contactGroup.resourceName

string

伺服器指派的聯絡人群組的資源名稱。ASCII 字串，格式為 contactGroups/{contactGroupId}。

要求主體

要求主體的資料會採用以下結構：

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

資源的 HTTP 實體標記。用於驗證網頁快取。
contactGroup.metadata

object (ContactGroupMetadata)

僅供輸出。聯絡人群組的中繼資料。
contactGroup.groupType

enum (GroupType)

僅供輸出。聯絡人群組類型。
contactGroup.name

string

由群組擁有者設定的聯絡人群組名稱，或是系統群組提供的名稱。

contactGroups.create 或 contactGroups.update 的使用者名稱專屬於使用者聯絡人群組。如果嘗試以重複的名稱建立群組，會傳回 HTTP 409 錯誤。
contactGroup.formattedName

string

僅供輸出。依據檢視者帳戶語言代碼或系統群組名稱的 Accept-Language HTTP 標頭語言代碼，完成翻譯和格式設定的名稱。擁有者設定的群組名稱會與名稱相同。
contactGroup.memberResourceNames[]

string

僅供輸出。聯絡人群組成員的聯絡人資源名稱清單。這個欄位只會在 GET 要求中填入，而且在 get 要求中傳回的成員數量只會像 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

詳情請參閱授權指南。