Il widget di ricerca offre un'interfaccia di ricerca personalizzabile per le applicazioni web. Il widget richiede solo una piccola quantità di HTML e JavaScript per l'implementazione e attiva funzionalità di ricerca comuni come facet e impaginazione. Puoi anche personalizzare parti dell'interfaccia con CSS e JavaScript.
Se hai bisogno di maggiore flessibilità rispetto a quella offerta dal widget, valuta la possibilità di utilizzare l'API Query. Per informazioni sulla creazione di un'interfaccia di ricerca con l'API Query, consulta Creazione di un'interfaccia di ricerca con l'API Query.
Crea un'interfaccia di ricerca
La creazione dell'interfaccia di ricerca richiede diversi passaggi:
- Configura un'applicazione di ricerca
- Genera un ID client per l'applicazione
- Aggiungi il markup HTML per la casella di ricerca e i risultati
- Carica il widget nella pagina
- Inizializzare il widget
Configura un'applicazione di ricerca
Ogni interfaccia di ricerca deve avere un'applicazione di ricerca definita nella Console di amministrazione. L'applicazione di ricerca fornisce informazioni aggiuntive per la query, come origini dati, facet e impostazioni della qualità della ricerca.
Per creare un'applicazione di ricerca, consulta Creare un'esperienza di ricerca personalizzata.
Genera un ID client per l'applicazione
Oltre ai passaggi descritti in Configurare l'accesso all'API Google Cloud Search, devi anche generare un ID client per l'applicazione web.
Quando configuri il progetto:
- Seleziona il tipo di client Browser web.
- Fornisci l'URI di origine dell'app.
- Nota relativa all'ID client creato. Avrai bisogno dell'ID client per completare i passaggi successivi. Il client secret non è richiesto per il widget.
Per maggiori informazioni, consulta OAuth 2.0 per applicazione web lato client.
Aggiungere il markup HTML
Il widget richiede una piccola porzione di HTML per funzionare. Devi fornire:
- Un elemento
input
per la casella di ricerca. - Un elemento a cui ancorare il popup di suggerimento.
- Un elemento che contenga i risultati di ricerca.
- (Facoltativo) Fornisci un elemento che contenga i controlli dei facet.
Il seguente snippet HTML mostra il codice HTML di un widget di ricerca, in cui gli
elementi da associare sono identificati dal relativo attributo id
:
Carica il widget
Il widget viene caricato in modo dinamico tramite uno script di caricamento. Per includere
il caricatore, utilizza il tag <script>
come mostrato di seguito:
Devi fornire un callback onload
nel tag script. La funzione viene richiamata
quando il caricatore è pronto. Quando il caricatore è pronto, continua a caricare il widget chiamando gapi.load()
per caricare il client API, Accedi con Google e i moduli Cloud Search.
La funzione initializeApp()
viene richiamata dopo che sono stati caricati tutti i moduli.
Inizializzare il widget
Per prima cosa, inizializza la libreria client chiamando
gapi.client.init()
o gapi.auth2.init()
con l'ID client generato
e l'ambito https://www.googleapis.com/auth/cloud_search.query
. Dopodiché, utilizza le classi gapi.cloudsearch.widget.resultscontainer.Builder
e gapi.cloudsearch.widget.searchbox.Builder
per configurare il widget e associarlo agli elementi HTML.
Il seguente esempio mostra come inizializzare il widget:
L'esempio precedente fa riferimento a due variabili per la configurazione definita come:
Personalizzare l'esperienza di accesso
Per impostazione predefinita, il widget richiede agli utenti di accedere e autorizzare l'app nel momento in cui iniziano a digitare una query. Puoi utilizzare Accedi con Google per i siti web per offrire agli utenti un'esperienza di accesso più personalizzata.
Autorizza gli utenti direttamente
Utilizza la funzionalità Accedi con Google per monitorare lo stato di accesso
dell'utente e di eseguire l'accesso o la disconnessione degli utenti in base alle necessità. Ad esempio, l'esempio seguente osserva lo stato isSignedIn
per monitorare le modifiche dell'accesso e utilizza il metodo GoogleAuth.signIn()
per avviare l'accesso da un clic su un pulsante:
Per maggiori dettagli, vedi Accedi con Google.
Consentire l'accesso automatico degli utenti
Puoi semplificare ulteriormente l'esperienza di accesso pre-autorizzando l'applicazione per conto degli utenti della tua organizzazione. Questa tecnica è utile anche se si utilizza Cloud Identity Aware Proxy per proteggere l'applicazione.
Per ulteriori informazioni, consulta l'articolo su come utilizzare Accedi con Google con app IT.
Personalizzare l'interfaccia
Puoi modificare l'aspetto dell'interfaccia di ricerca tramite una combinazione di tecniche:
- Eseguire l'override degli stili con CSS
- Decora gli elementi con un adattatore
- Creare elementi personalizzati con un adattatore
Eseguire l'override degli stili con CSS
Il widget Ricerca è dotato di un proprio CSS per lo stile dei suggerimenti e degli elementi dei risultati, nonché i controlli di impaginazione. Puoi modificare lo stile di questi elementi in base alle tue esigenze.
Durante il caricamento, il widget di ricerca carica in modo dinamico il foglio di stile predefinito. Questo accade dopo aver caricato i fogli di stile dell'applicazione, aumentando la priorità delle regole. Per garantire che i tuoi stili abbiano la precedenza su quelli predefiniti, utilizza i selettori predecessore per aumentare la specificità delle regole predefinite.
Ad esempio, la seguente regola non ha effetto se viene caricata in un tag link
o style
statico nel documento.
.cloudsearch_suggestion_container {
font-size: 14px;
}
Qualifica invece la regola con l'ID o la classe del container predecessore dichiarato nella pagina.
#suggestions_anchor .cloudsearch_suggestion_container {
font-size: 14px;
}
Per un elenco delle classi di supporto e dell'HTML di esempio generato dal widget, consulta la sezione di riferimento Classi CSS supportate.
Decora gli elementi con un adattatore
Per decorare un elemento prima del rendering, crea e reimposta un
adattatore che implementa uno dei metodi di decorazione come
decorateSuggestionElement
o decorateSearchResultElement.
Ad esempio, i seguenti adattatori aggiungono una classe personalizzata agli elementi suggerimento e risultato.
Per registrare l'adattatore durante l'inizializzazione del widget, usa il metodo setAdapter()
della rispettiva classe Builder
:
I decoratori possono modificare gli attributi dell'elemento contenitore e di eventuali elementi secondari. Gli elementi secondari possono essere aggiunti o rimossi durante la decorazione. Tuttavia, se apporti modifiche strutturali agli elementi, valuta la possibilità di creare direttamente gli elementi anziché decorarli.
Creare elementi personalizzati con un adattatore
Per creare un elemento personalizzato per un suggerimento, un contenitore di facet o un risultato di ricerca,
crea e registra un adattatore che implementi
createSuggestionElement
,
createFacetResultElement
o createSearchResultElement
in modo reattivo.
I seguenti adattatori illustrano la creazione di elementi di suggerimenti e risultati di ricerca personalizzati utilizzando i tag <template>
HTML.
Per registrare l'adattatore durante l'inizializzazione del widget, usa il metodo setAdapter()
della rispettiva classe Builder
:
La creazione di elementi facet personalizzati con createFacetResultElement
è soggetta a diverse limitazioni:
- Devi collegare la classe CSS
cloudsearch_facet_bucket_clickable
all'elemento su cui gli utenti fanno clic per attivare/disattivare un bucket. - Devi racchiudere ogni bucket in un elemento contenitore con la classe CSS
cloudsearch_facet_bucket_container
. - Non puoi eseguire il rendering dei bucket in un ordine diverso da quello in cui appaiono nella risposta.
Ad esempio, il seguente snippet esegue il rendering dei facet utilizzando i link anziché le caselle di controllo.
Personalizza il comportamento di ricerca
Le impostazioni dell'applicazione di ricerca rappresentano la configurazione predefinita di un'interfaccia di ricerca e sono statiche. Per implementare filtri o facet dinamici, ad esempio consentire agli utenti di attivare/disattivare le origini dati, puoi eseguire l'override delle impostazioni dell'applicazione di ricerca intercettando la richiesta di ricerca con un adattatore.
Implementa un adattatore con il metodo interceptSearchRequest
per modificare le richieste inviate all'API Search prima dell'esecuzione.
Ad esempio, il seguente adattatore intercetta le richieste per limitare le query a un'origine selezionata dall'utente:
Per registrare l'adattatore durante l'inizializzazione del widget, usa il metodo setAdapter()
durante la creazione dell'elemento ResultsContainer
.
Il seguente codice HTML viene utilizzato per visualizzare una casella di selezione per filtrare in base alle origini:
Il seguente codice rimane in ascolto della modifica, imposta la selezione ed esegue nuovamente la query, se necessario.
Puoi anche intercettare la risposta della ricerca implementando
interceptSearchResponse
nell'adattatore.
Blocca la versione API
Per impostazione predefinita, il widget utilizza l'ultima versione stabile dell'API. Per bloccare una
versione specifica, imposta il parametro di configurazione cloudsearch.config/apiVersion
sulla versione preferita prima di inizializzare il widget.
Se non viene configurata o viene impostata un valore non valido, la versione dell'API sarà 1.0 per impostazione predefinita.
Fissa la versione del widget
Per evitare modifiche impreviste alle interfacce di ricerca, imposta il parametro di configurazione cloudsearch.config/clientVersion
come mostrato:
gapi.config.update('cloudsearch.config/clientVersion', 1.1);
Se non viene configurata o viene impostata un valore non valido, la versione del widget sarà 1.0 per impostazione predefinita.
Proteggi l'interfaccia di ricerca
I risultati di ricerca contengono informazioni molto sensibili. Segui le best practice per la protezione delle applicazioni web, in particolare contro gli attacchi clickjacking.
Per ulteriori informazioni, vedi OWASP Guide Project.
Attiva debug
Utilizza interceptSearchRequest
per attivare il debug per il widget Ricerca. Ad esempio:
if (!request.requestOptions) {
// Make sure requestOptions is populated
request.requestOptions = {};
}
// Enable debugging
request.requestOptions.debugOptions = {enableDebugging: true}
return request;