一連の連絡先を更新し、更新された連絡先の PersonResponses にリソース名のマップを返します。
レイテンシやエラーの増加を避けるため、同じユーザーに対する変更リクエストは順番に送信する必要があります。
HTTP リクエスト
POST https://people.googleapis.com/v1/people:batchUpdateContacts
この URL は gRPC Transcoding 構文を使用します。
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
---|
{ "contacts": { string: { object ( |
フィールド | |
---|---|
contacts |
必須。更新する個人データへのリソース名のマップ。1 回のリクエストで最大 200 件の連絡先を指定できます。
|
updateMask |
必須。人物のどのフィールドを更新するかを制限するフィールド マスク。複数のフィールドを指定する場合は、フィールドをカンマで区切ります。指定したすべてのフィールドが置き換えられるか、各人物について空のままにするとクリアされます。指定できる値は次のとおりです。
|
readMask |
必須。各人物のどのフィールドが返されるかを制限するフィールド マスク。複数のフィールドを指定する場合は、フィールドをカンマで区切ります。読み取りマスクが空の場合、post-mut-get はスキップされ、レスポンスでデータは返されません。指定できる値は次のとおりです。
|
sources[] |
省略可。返すソースタイプのマスク。設定しない場合、デフォルトは |
レスポンスの本文
失敗した場合は、各連絡先に対応するエラーのリストである BatchUpdateContactsErrorDetails
を返します。
連絡先のバッチを更新するリクエストに対するレスポンス。
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{
"updateResult": {
string: {
object ( |
フィールド | |
---|---|
updateResult |
更新された連絡先へのリソース名のマップ(リクエスト
|
承認スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/contacts
詳しくは、承認ガイドをご覧ください。