Method: people.batchUpdateContacts

一連の連絡先を更新し、更新された連絡先の PersonResponses にリソース名のマップを返します。

レイテンシの増加や失敗を避けるため、同じユーザーに対する DoFn リクエストは順次送信する必要があります。

HTTP リクエスト

POST https://people.googleapis.com/v1/people:batchUpdateContacts

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

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "contacts": {
    string: {
      object (Person)
    },
    ...
  },
  "updateMask": string,
  "readMask": string,
  "sources": [
    enum (ReadSourceType)
  ]
}
フィールド
contacts

map (key: string, value: object (Person))

必須。リソース名と更新される個人データのマップ。1 回のリクエストで最大 200 件の連絡先を含めることができます。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
updateMask

string (FieldMask format)

必須。更新されるユーザーのフィールドを制限するフィールド マスク。複数のフィールドを指定する場合は、フィールドをカンマで区切ります。個々のユーザーに対して、指定したすべてのフィールドが置き換えられます。空白のままにした場合は消去されます。指定できる値は次のとおりです。

  • addresses
  • 伝記
  • 誕生日
  • calendarUrls
  • clientData
  • emailAddresses
  • イベント
  • externalIds
  • 性別
  • imClients
  • インタレスト
  • locales
  • 開催地
  • メンバーシップ
  • miscKeywords
  • 名前
  • ニックネーム
  • 職業
  • 組織
  • phoneNumbers
  • 関係
  • sipAddresses
  • URL
  • userDefined
readMask

string (FieldMask format)

必須。各ユーザーのどのフィールドが返されるかを制限するフィールド マスク。複数のフィールドを指定する場合は、フィールドをカンマで区切ります。読み取りマスクが空の場合、変更後 get はスキップされ、レスポンスでデータは返されません。指定できる値は次のとおりです。

  • addresses
  • ageRanges
  • 伝記
  • 誕生日
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • イベント
  • externalIds
  • 性別
  • imClients
  • インタレスト
  • locales
  • 開催地
  • メンバーシップ
  • メタデータ
  • miscKeywords
  • 名前
  • ニックネーム
  • 職業
  • 組織
  • phoneNumbers
  • 写真
  • 関係
  • sipAddresses
  • skills
  • URL
  • userDefined
sources[]

enum (ReadSourceType)

省略可。返されるソースタイプのマスク。設定しない場合のデフォルトは READ_SOURCE_TYPE_CONTACT と READ_SOURCE_TYPE_PROFILE です。

レスポンスの本文

成功しなかった場合は、各連絡先に対応するエラーのリストである BatchUpdateContactsErrorDetails を返します。

複数の連絡先を更新するリクエストに対するレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "updateResult": {
    string: {
      object (PersonResponse)
    },
    ...
  }
}
フィールド
updateResult

map (key: string, value: object (PersonResponse))

リソース名と更新された連絡先のマップ（リクエスト readMask が空の場合を除く）。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

認可スコープ

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

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

詳細については、承認ガイドをご覧ください。