Questo documento ti aiuterà a familiarizzare con l'API Custom Search JSON e il suo utilizzo.
Prima di iniziare
Creare un Motore di ricerca programmabile
Chiamando l'API, l'utente invia richieste a un'istanza esistente di
Programmable Search Engine. Pertanto, prima di utilizzare l'API, devi crearne uno nel pannello di controllo . Segui
il tutorial per scoprire di più sulle
diverse opzioni di configurazione. Una volta creato, puoi trovare l'ID del motore di ricerca nella sezione Di base della pagina Panoramica. Questo è il parametro cx
utilizzato dall'API.
Identificare l'applicazione su Google con la chiave API
L'API Custom Search JSON richiede l'utilizzo di una chiave API. Una chiave API è un modo per identificare il tuo client per Google.
Una volta ottenuta una chiave API, la tua applicazione può aggiungere il parametro di query
key=yourAPIKey a tutti gli URL delle richieste. La chiave API è sicura per l'incorporamento negli URL e non richiede alcuna codifica.
Panoramica dell'API
Operazioni API
Nell'API Custom Search JSON è disponibile un solo metodo di chiamata:
| Operazione | Descrizione | Mapping HTTP REST |
|---|---|---|
| list | Restituisce i risultati di ricerca richiesti da un Motore di ricerca programmabile. | GET |
Modello di dati API
Il risultato di una query di ricerca all'API Custom Search JSON è un oggetto JSON che include tre tipi di dati:
- Metadati che descrivono la ricerca richiesta (e, possibilmente, le richieste di ricerca correlate)
- Metadati che descrivono il Motore di ricerca programmabile
- Risultati di ricerca
Per ulteriori dettagli, consulta la sezione Dati di risposta di Utilizzo di REST.
Il modello di dati si basa sulla specifica OpenSearch 1.1. Oltre alle proprietà OpenSearch standard, l'API Custom Search JSON definisce due proprietà personalizzate e due ruoli di query personalizzati:
- Proprietà personalizzate
cx: l'identificatore del Motore di ricerca programmabile.safe: una descrizione del livello di ricerca sicura per filtrare i risultati restituiti.
- Ruoli di query personalizzati
nextPage: un ruolo che indica che la query può essere utilizzata per accedere alla pagina logica successiva dei risultati, se presente.previousPage: un ruolo che indica che la query può essere utilizzata per accedere alla pagina logica precedente dei risultati, se presente.
Prova
Per provare e vedere cosa può fare l'API, senza scrivere codice, visita lo strumento "Prova questa API".
Per una descrizione completa dei parametri, visita la pagina di riferimento cse.list.
Per scoprire come utilizzare l'API tramite richieste HTTP, vai a Utilizzo di REST.