API Custom Search JSON: introduzione

Questo documento ti aiuterà ad acquisire familiarità con l'API JSON Custom Search e il suo utilizzo.

Prima di iniziare

Creare un Motore di ricerca programmabile

La chiamata all'utente dell'API invia le richieste a un'istanza esistente del Motore di ricerca programmabile. Pertanto, prima di utilizzare l'API, devi crearne una nel Pannello di controllo. Segui il tutorial per scoprire di più sulle varie opzioni di configurazione. Una volta creato, puoi trovare l'ID motore di ricerca nella sezione Informazioni di base della pagina Panoramica. Questo è il parametro cx utilizzato dall'API.

Identifica la tua applicazione su Google con la chiave API

L'API JSON di Ricerca personalizzata richiede l'utilizzo di una chiave API. Una chiave API è un modo per identificare il tuo client su Google.

Una volta che disponi di una chiave API, l'applicazione può aggiungere il parametro di ricerca key=yourAPIKey a tutti gli URL delle richieste. Puoi incorporare la chiave API negli URL in sicurezza, poiché non è necessaria alcuna codifica.

Panoramica dell'API

Operazioni API

Esiste un solo metodo per richiamare nell'API JSON Custom Search:

Operazione Descrizione Mapping HTTP REST
list Restituisce i risultati di ricerca richiesti da un Motore di ricerca programmabile. GET

Modello dei dati API

Il risultato di una query di ricerca inviata all'API JSON Custom Search è un oggetto JSON che include tre tipi di dati:

  • Metadati che descrivono la ricerca richiesta (e, possibilmente, le richieste di ricerca correlata)
  • Metadati che descrivono il Motore di ricerca programmabile
  • Risultati di ricerca

Per ulteriori dettagli, consulta la sezione Dati sulle risposte di Utilizzo di REST.

Il modello dei dati si basa sulla specifica OpenSearch 1.1. Oltre alle proprietà OpenSearch standard, l'API JSON Custom Search definisce due proprietà personalizzate e due ruoli query personalizzate:

  • Proprietà personalizzate
    • cx: l'identificatore del Motore di ricerca programmabile.
    • safe: una descrizione del livello di SafeSearch per filtrare i risultati restituiti.
  • Ruoli query personalizzati
    • nextPage: un ruolo che indica che la query può essere utilizzata per accedere alla pagina logica dei risultati successiva, se disponibile.
    • previousPage: un ruolo che indica che la query può essere utilizzata per accedere all'eventuale pagina logica precedente dei risultati.

Prova

Per sperimentare e vedere cosa può fare l'API, senza scrivere alcun codice, visita lo strumento "Prova questa API".

Per una descrizione completa dei parametri, consulta il riferimento cse.list.

Per scoprire come utilizzare l'API tramite richieste HTTP, consulta Utilizzo di REST.