SearchResponse
Stay organized with collections
Save and categorize content based on your preferences.
The response to a search request for the authenticated user, given a query.
SearchResult
A result of a search query.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-08-06 UTC."],[[["\u003cp\u003eThis documentation details the response to a search request, providing the structure of the returned data in JSON format.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes a list of search results, with each result containing information about a matched person.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eSearchResult\u003c/code\u003e object within the response provides access to the detailed \u003ccode\u003ePerson\u003c/code\u003e object, which contains further information about the individual.\u003c/p\u003e\n"]]],["The core content defines the structure of a search response. A search request returns a JSON object containing an array of `results`. Each `result` is a `SearchResult` object, which in turn contains a `person` object. The `results` array holds the matched people found from the search query, with each person represented by their respective object. The schema is described using JSON.\n"],null,["# SearchResponse\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [SearchResult](#SearchResult)\n - [JSON representation](#SearchResult.SCHEMA_REPRESENTATION)\n\nThe response to a search request for the authenticated user, given a query.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------|\n| ``` { \"results\": [ { object (/people/api/rest/v1/SearchResponse#SearchResult) } ] } ``` |\n\n| Fields ||\n|-------------|----------------------------------------------------------------------------------------------------------|\n| `results[]` | `object (`[SearchResult](/people/api/rest/v1/SearchResponse#SearchResult)`)` The results of the request. |\n\nSearchResult\n------------\n\nA result of a search query.\n\n| JSON representation |\n|----------------------------------------------------------------------|\n| ``` { \"person\": { object (/people/api/rest/v1/people#Person) } } ``` |\n\n| Fields ||\n|----------|------------------------------------------------------------------------------|\n| `person` | `object (`[Person](/people/api/rest/v1/people#Person)`)` The matched Person. |"]]
