更新聯絡人的相片。
請為同一位使用者依序傳送 Mutate 要求,以避免延遲時間增加和失敗。
HTTP 要求
PATCH https://people.googleapis.com/v1/{resourceName=people/*}:updateContactPhoto
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
resourceName |
必要欄位。使用者資源名稱 |
要求主體
要求主體的資料會採用以下結構:
JSON 表示法 |
---|
{
"photoBytes": string,
"personFields": string,
"sources": [
enum ( |
欄位 | |
---|---|
photoBytes |
必要欄位。原始相片位元組 Base64 編碼的字串。 |
personFields |
選用設定。欄位遮罩,用於限制傳回使用者上的欄位。如要指定多個欄位,請用半形逗號分隔。如果不設定,預設為空白,這樣會略過 異動取得後取得的資料。以下為有效值:
|
sources[] |
選用設定。要傳回哪些來源類型的遮罩。如未設定,預設值為 |
回應主體
更新聯絡人相片的回應。
如果成功,回應主體即會包含具有以下結構的資料:
JSON 表示法 |
---|
{
"person": {
object ( |
欄位 | |
---|---|
person |
更新的使用者 (如果已在 UpdateContactPhotoRequest 中設定 personFields),否則將會取消設定。 |
授權範圍
需要下列 OAuth 範圍:
https://www.googleapis.com/auth/contacts
詳情請參閱授權指南。