- Solicitud HTTP
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Alcances de la autorización
- SuggestResult
- QuerySuggestion
- PeopleSuggestion
- Pruébalo
Proporciona sugerencias para autocompletar la consulta.
Nota: Para que se ejecute esta API, se requiere una cuenta de usuario final estándar. Una cuenta de servicio no puede realizar solicitudes a la API de consulta directamente. Si quieres usar una cuenta de servicio para realizar consultas, configura la delegación de autoridad de todo el dominio de Google Workspace.
Solicitud HTTP
POST https://cloudsearch.googleapis.com/v1/query/suggest
La URL usa la sintaxis de la transcodificación gRPC.
Cuerpo de la solicitud
El cuerpo de la solicitud contiene datos con la siguiente estructura:
Representación JSON |
---|
{ "requestOptions": { object ( |
Campos | |
---|---|
requestOptions |
Opciones de solicitud, como la aplicación de búsqueda y la zona horaria del usuario. |
query |
Consulta parcial en la que se mostrarán las sugerencias de autocompletar. Por ejemplo, si la consulta es "sea", el servidor podría mostrar "season", "search", "seagull" etcétera. |
dataSourceRestrictions[] |
Las fuentes que se usarán para las sugerencias. Si no se especifica, las fuentes de datos se toman de la aplicación de búsqueda actual. NOTA: Las sugerencias solo se admiten para las siguientes fuentes:
|
Cuerpo de la respuesta
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
Respuesta de la API sugerida.
Representación JSON |
---|
{
"suggestResults": [
{
object ( |
Campos | |
---|---|
suggestResults[] |
Lista de sugerencias. |
Alcances de la autorización
Se necesita uno de los siguientes permisos de OAuth:
https://www.googleapis.com/auth/cloud_search.query
https://www.googleapis.com/auth/cloud_search
Para obtener más información, consulta la Guía de autorización.
SuggestResult
Un resultado de sugerencia.
Representación JSON |
---|
{ "suggestedQuery": string, "source": { object ( |
Campos | |
---|---|
suggestedQuery |
Búsqueda sugerida que se utilizará para la búsqueda, cuando el usuario haga clic en la sugerencia |
source |
Es la fuente de la sugerencia. |
Campo de unión suggestion . Contiene metadatos adicionales sobre la consulta sugerida. También indica el tipo de la consulta sugerida. Por ejemplo: si Sugerencias de personas está presente, indica que suggested_query es una sugerencia de persona. Las direcciones (suggestion ) solo pueden ser una de las siguientes opciones: |
|
querySuggestion |
Este campo estará presente si la consulta sugerida es el resultado de una palabra o frase. |
peopleSuggestion |
Esta opción está presente cuando la sugerencia indica una persona. Contiene más información sobre la persona, como su ID de correo electrónico, nombre, etc. |
QuerySuggestion
Por el momento, este campo no contiene nada y solo se usa como indicador de que el resultado sugerido fue la finalización de una frase.
PeopleSuggestion
Este campo contiene información sobre la persona sugerida.
Representación JSON |
---|
{
"person": {
object ( |
Campos | |
---|---|
person |
Persona sugerida Es posible que no se propaguen todos los campos del objeto de persona. |