Method: people.updateContact

既存の連絡先担当者の連絡先データを更新します。非接触型データは変更されません。更新するユーザーの連絡先以外のデータは無視されます。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

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

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