BatchUpdateContactsErrorDetails
Stay organized with collections
Save and categorize content based on your preferences.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-08-06 UTC.
[null,null,["Last updated 2024-08-06 UTC."],[[["\u003cp\u003eThe \u003ccode\u003econtactErrors\u003c/code\u003e field provides error details when the \u003ccode\u003epeople.batchUpdateContacts\u003c/code\u003e action fails, helping identify problematic contacts.\u003c/p\u003e\n"],["\u003cp\u003eIt's structured as a map with contact resource names/IDs as keys and Status objects (containing error details) as values.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful contact updates are not included in this field; only failed updates have entries.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003egoogle.rpc.Status.details\u003c/code\u003e within the Status object lists specific errors encountered for each contact.\u003c/p\u003e\n"]]],["The `contactErrors` field, a map, details why batch contact updates fail. The map's key is the contact's resource name/ID from the update request. The value, a `Status` object, explains the error for that contact. If a contact ID is absent from `contactErrors`, its update was successful. `google.rpc.Status.details` provides a list of errors per contact. Each value is formated as `\"key\": value`.\n"],null,["# BatchUpdateContactsErrorDetails\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n\nMessage to record error details when the request fails in the people.batchUpdateContacts action.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------|\n| ``` { \"contactErrors\": { string: { object (/people/api/rest/v1/Status) }, ... } } ``` |\n\n| Fields ||\n|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `contactErrors` | `map (key: string, value: object (`[Status](/people/api/rest/v1/Status)`))` Provides details for the client to identify the contact(s) that caused the batch update to fail. If a contact id does not appear, then the update of that contact would have been successful. In the map below: - The key is the resource name / contact id in [BatchUpdateContactsRequest.contacts](/people/api/rest/v1/people/batchUpdateContacts#body.request_body.FIELDS.contacts). - The value is a Status. [google.rpc.Status.details](/people/api/rest/v1/Status#FIELDS.details) will contain the list of errors for the contact. An object containing a list of `\"key\": value` pairs. Example: `{ \"name\": \"wrench\", \"mass\": \"1.3kg\", \"count\": \"3\" }`. |"]]