既存の連絡先担当者のデータを更新します。非接触データは変更されません。更新した人物以外の連絡先データは無視されます。updateMask
に指定したすべてのフィールドが置き換えられます。
連絡先の更新に person.metadata.sources
が指定されていない場合、または連絡先ソースがない場合は、サーバーから 400 エラーが返されます。
person.metadata.sources.etag
が連絡先の ETag と異なる場合、サーバーは連絡先のデータが読み取られてから連絡先が変更されたことを示す "failedPrecondition"
エラーで 400 エラーを返します。クライアントは最新の人物を取得し、更新内容を最新の人物に統合する必要があります。
memberships
が更新され、そのユーザーの連絡先グループ メンバーシップが指定されていない場合、サーバーは 400 エラーを返します。
連絡先のソースのシングルトンであるフィールドに複数のフィールドが指定されていると、サーバーから 400 エラーが返されます。
- 伝記
- 誕生日
- 性別
- names
レイテンシとエラーの増加を避けるため、同じユーザーの変更リクエストを順次送信する必要があります。
HTTP リクエスト
PATCH https://people.googleapis.com/v1/{person.resourceName=people/*}:updateContact
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
person.resourceName |
サーバーによって割り当てられたユーザーのリソース名。 |
クエリ パラメータ
パラメータ | |
---|---|
updatePersonFields |
必須。人物のどのフィールドを更新するかを制限するフィールド マスク。複数のフィールドを指定する場合は、カンマで区切ります。更新されたすべてのフィールドが置き換えられます。指定できる値は次のとおりです。
|
personFields |
(省略可)フィールド マスク。各ユーザーに返されるフィールドを制限します。複数のフィールドを指定する場合は、カンマで区切ります。設定しない場合、デフォルトですべてのフィールドが使用されます。指定できる値は次のとおりです。
|
sources[] |
(省略可)返されるソースタイプのマスク。設定しない場合、デフォルトは |
リクエスト本文
リクエストの本文には Person
のインスタンスが含まれます。
レスポンスの本文
成功した場合、レスポンスの本文には Person
のインスタンスが含まれます。
認証スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/contacts
詳しくは、承認ガイドをご覧ください。