Method: people.updateContact

更新現有聯絡人的聯絡人資料。系統不會修改任何非聯絡人資料。系統會忽略使用者的任何非聯絡人資料更新。在 updateMask 中指定的所有欄位都會被取代。

如未指定要更新聯絡人的 person.metadata.sources,或沒有聯絡人來源,伺服器會傳回 400 錯誤。

如果 person.metadata.sources.etag 與聯絡人的 etag 不同,伺服器會傳回 400 錯誤,原因為 "failedPrecondition",這表示聯絡人在讀取資料後已變更。客戶應知會最新人員,並將最新資訊合併到最新人員。

如果更新 memberships,且未針對使用者指定聯絡人群組成員,則伺服器會傳回 400 錯誤。

如果聯絡人來源的單例模式指定多個欄位,伺服器會傳回 400 錯誤:

  • 傳記
  • 生日
  • 性別
  • names

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

HTTP 要求

PATCH https://people.googleapis.com/v1/{person.resourceName=people/*}:updateContact

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

路徑參數

參數
person.resourceName

string

使用者的資源名稱,由伺服器指派。people/{person_id} 格式的 ASCII 字串。

查詢參數

參數
updatePersonFields

string (FieldMask format)

必要欄位。欄位遮罩可限制使用者要更新哪些欄位。如要指定多個欄位,請用半形逗號分隔。系統將取代所有更新後的欄位。以下為有效值:

  • addresses
  • 傳記
  • 生日
  • calendarUrls
  • clientData
  • emailAddresses
  • 活動
  • externalIds
  • 性別
  • imClients
  • 興趣
  • locales
  • 地點
  • 會籍
  • miscKeywords
  • names
  • 暱稱
  • 職業
  • organizations
  • phoneNumbers
  • 關係
  • sipAddresses
  • urls
  • userDefined
personFields

string (FieldMask format)

選用設定。欄位遮罩,用於限制傳回每個人上的欄位。如要指定多個欄位,請用半形逗號分隔。如果沒有設定,則預設為所有欄位。以下為有效值:

  • addresses
  • ageRanges
  • 傳記
  • 生日
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • 活動
  • externalIds
  • 性別
  • imClients
  • 興趣
  • locales
  • 地點
  • 會籍
  • 中繼資料
  • miscKeywords
  • names
  • 暱稱
  • 職業
  • organizations
  • phoneNumbers
  • 相片
  • 關係
  • sipAddresses
  • skills
  • urls
  • userDefined
sources[]

enum (ReadSourceType)

選用設定。要傳回哪些來源類型的遮罩。如未設定,預設值為 READ_SOURCE_TYPE_CONTACTREAD_SOURCE_TYPE_PROFILE

要求主體

要求主體包含 Person 的例項。

回應主體

如果成功,回應主體會包含 Person 的執行例項。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱授權指南