Method: people.updateContact

• HTTP リクエスト
• パスパラメータ
• クエリ パラメータ
• リクエストの本文
• レスポンスの本文
• 認可スコープ
• 試してみる

既存の連絡先の連絡先データを更新します。接触以外のデータは変更されません。更新するユーザーの連絡先以外のデータは無視されます。updateMask で指定されたすべてのフィールドが置換されます。

更新する連絡先に person.metadata.sources が指定されていない場合、または連絡先ソースがない場合、サーバーは 400 エラーを返します。

person.metadata.sources.etag が連絡先の etag と異なる場合、サーバーは 400 エラーを返します。これは、データが読み取られてから連絡先が変更されたことを示します。理由は "failedPrecondition" です。クライアントは最新の連絡先を取得し、更新内容を最新の連絡先に統合する必要があります。同じユーザーに対して連続して更新を行う場合は、エラーを回避するために updateContact レスポンスの etag を使用する必要があります。

memberships が更新されていて、連絡先に連絡先グループのメンバーシップが指定されていない場合、サーバーは 400 エラーを返します。

コンタクト ソースのシングルトンであるフィールドに複数のフィールドが指定されている場合、サーバーは 400 エラーを返します。

• 伝記
• 誕生日
• 性別
• 名前

レイテンシの増加と障害を回避するため、同じユーザーのミューテーション リクエストは順番に送信する必要があります。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
person.resourceName	string サーバーが割り当てた、ユーザーのリソース名。people/{person_id} 形式の ASCII 文字列。

クエリ パラメータ

パラメータ
updatePersonFields	string (FieldMask format) 必須。更新されるユーザーのフィールドを制限するフィールド マスク。複数のフィールドを指定する場合は、カンマで区切ります。更新されたフィールドはすべて置き換えられます。指定できる値は次のとおりです。 addresses 伝記 誕生日 calendarUrls clientData emailAddresses イベント externalIds 性別 imClients インタレスト locales 開催地 メンバーシップ miscKeywords 名前 ニックネーム 職業 組織 phoneNumbers リレーション sipAddresses URL ユーザー定義
personFields	string (FieldMask format) 省略可。各ユーザーのどのフィールドを返すかを制限するフィールド マスク。複数のフィールドを指定する場合は、カンマで区切ります。設定しない場合、デフォルトはすべてのフィールドになります。指定できる値は次のとおりです。 addresses ageRanges 伝記 誕生日 calendarUrls clientData coverPhotos emailAddresses イベント externalIds 性別 imClients インタレスト locales 開催地 メンバーシップ metadata miscKeywords 名前 ニックネーム 職業 組織 phoneNumbers 写真 リレーション sipAddresses skills URL ユーザー定義
sources[]	enum (ReadSourceType) 省略可。返されるソースタイプのマスク。設定しない場合、デフォルトは READ_SOURCE_TYPE_CONTACT と READ_SOURCE_TYPE_PROFILE です。

リクエストの本文

リクエストの本文には Person のインスタンスが含まれます。

レスポンスの本文

成功した場合、レスポンスの本文には Person のインスタンスが含まれます。

認可スコープ

次の OAuth スコープが必要です。

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

詳しくは、認可ガイドをご覧ください。