Method: people.batchUpdateContacts

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

レイテンシとエラーの増加を避けるため、同じユーザーの変更リクエストを順次送信する必要があります。

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
  • 予定
  • externalId
  • 性別
  • imClients
  • 関心
  • locales
  • 場所
  • メンバーシップ
  • その他のキーワード
  • names
  • ニックネーム
  • 職業
  • organizations
  • phoneNumbers
  • リレーション
  • SipAddress
  • URL
  • ユーザー定義
readMask

string (FieldMask format)

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

  • addresses
  • ageRanges
  • 伝記
  • 誕生日
  • calendarUrls
  • clientData
  • カバー写真
  • emailAddresses
  • 予定
  • externalId
  • 性別
  • imClients
  • 関心
  • locales
  • 場所
  • メンバーシップ
  • metadata
  • その他のキーワード
  • names
  • ニックネーム
  • 職業
  • organizations
  • phoneNumbers
  • 写真
  • リレーション
  • SipAddress
  • skills
  • URL
  • ユーザー定義
sources[]

enum (ReadSourceType)

(省略可)返されるソースタイプのマスク。設定しない場合、デフォルトは READ_SOURCE_TYPE_CONTACTREAD_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

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