Este documento te ayudará a familiarizarte con la API de Custom Search JSON y su uso.
Antes de comenzar
Crea un Motor de Búsqueda Programable
Cuando llama a la API, el usuario emite solicitudes en una instancia existente del Motor de Búsqueda Programable. Por lo tanto, antes de usar la API, debes crear una en el Panel de control . Sigue el tutorial para obtener más información sobre las diferentes opciones de configuración. Una vez que se cree, podrás 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 tu cliente ante Google.
Una vez que tengas una clave de API, tu aplicación podrá agregar el parámetro de búsqueda key=yourAPIKey a todas las URLs de solicitud. La clave de API se puede incorporar de forma segura en las URLs, ya que no necesita codificación.
Descripción general de la API
Operaciones de la API
Solo hay un método para invocar en la API de Custom Search JSON:
| Operación | Descripción | Asignación de HTTP de REST |
|---|---|---|
| list | Devuelve 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 en la API de Custom Search JSON es un objeto JSON que incluye tres tipos de datos:
- Son los metadatos que describen la búsqueda solicitada (y, posiblemente, las solicitudes de búsqueda relacionadas).
- Son los metadatos que describen el Motor de Búsqueda Programable.
- Resultados de la búsqueda
Consulta la sección Datos de respuesta en Uso de 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ándar 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 SafeSearch para filtrar los resultados devueltos.
- Roles de búsqueda personalizados
nextPage: Es un rol que indica que la búsqueda se puede usar para acceder a la siguiente página lógica de resultados, si existe.previousPage: Es un rol que indica que la búsqueda se puede usar para acceder a la página lógica anterior de resultados, si existe.
Probar
Para explorar y ver qué puede hacer la API sin escribir ningún código, visita la herramienta"Probar 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, continúa con Uso de REST.