Este documento lo ayudará a familiarizarse con la API de Custom Search JSON y su uso.
Antes de comenzar
Crea un Motor de Búsqueda Programable
Cuando llama al usuario de la API, emite solicitudes contra una instancia existente de Programmable Search Engine.
Por lo tanto, antes de usar la API, debes crear una en el Panel de control. Sigue el instructivo para obtener más información sobre las diferentes opciones de configuración.
Una vez creado, puedes encontrar el ID del motor de búsqueda en la sección Básico de la página Descripción general. Este es el parámetro cx que usa la API.
Identifica tu aplicación ante Google con la clave de API
La API de Custom Search JSON requiere el uso de una clave de API. Una clave de API es una forma de identificar a tu cliente para Google.
- Usuarios de Motor de Búsqueda Programable (edición gratuita): Obtenga una clave
Una vez que tienes una clave de API, tu aplicación puede agregar el parámetro de consulta key=yourAPIKey a todas las URLs de solicitud. La clave de API se incorpora de manera segura en URLs, por lo que no necesita codificación.
Descripción general de la API
Operaciones de API
Solo hay un método para invocar en la API de Custom Search JSON:
| Operación | Descripción | Asignación HTTP de REST |
|---|---|---|
| list | Muestra los resultados de la búsqueda solicitados de un Motor de Búsqueda Programable. | GET |
Modelo de datos de la API
El resultado de una búsqueda a la API de Custom Search JSON es un objeto JSON que incluye tres tipos de datos:
- Metadatos que describen la búsqueda solicitada (y, posiblemente, las solicitudes de búsquedas relacionadas)
- Metadatos que describen el Motor de Búsqueda Programable
- Resultados de la búsqueda
Consulta la sección Datos de respuesta de Cómo usar REST para obtener más detalles.
El modelo de datos se basa en la especificación de OpenSearch 1.1. Además de las propiedades estándares de OpenSearch, la API de Custom Search JSON define dos propiedades personalizadas y dos roles de consulta personalizados:
- Propiedades personalizadas
cx: Es el identificador del Motor de Búsqueda Programable.safe: Es una descripción del nivel de búsqueda segura para filtrar los resultados que se muestran.
- Roles de consulta personalizados
nextPage: Es una función que indica que la consulta se puede usar para acceder a la siguiente página lógica de resultados, si corresponde.previousPage: Es una función que indica que la consulta se puede usar para acceder a la página lógica anterior de resultados, si corresponde.
Probar
Para explorar y ver lo que puede hacer la API sin escribir ningún código, visita la herramienta"Prueba esta API".
Para obtener una descripción completa de los parámetros, visita la referencia de cse.list.
Para obtener información sobre cómo usar la API a través de solicitudes HTTP, consulta Cómo usar REST.