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