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 implementare e abilitare funzionalità di ricerca comuni come facet e impaginazione. Tu puoi anche personalizzare parti dell'interfaccia con CSS e JavaScript.
Se hai bisogno di maggiore flessibilità rispetto a quella offerta dal widget, valuta l'utilizzo del l'API Query. Per informazioni sulla creazione di un'interfaccia di ricerca con l'API Query, Consulta la sezione 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 sezione Console di amministrazione Google. L'applicazione di ricerca fornisce ulteriori le informazioni per la query, come origini dati, facet e la qualità della ricerca.
Per creare un'applicazione di ricerca, consulta: Crea un'esperienza di ricerca personalizzata.
Genera un ID client per l'applicazione
Oltre alla procedura per Configura l'accesso all'API Google Cloud Search. devi generare un ID client per l'applicazione web.
Quando configuri il progetto:
- Seleziona il tipo di client Browser web.
- Fornisci l'URI di origine della tua app.
- Nota relativa all'ID client creato. Avrai bisogno dell'ID client per completa i passaggi successivi. Il client secret non è obbligatorio per widget.
Per ulteriori informazioni, vedi OAuth 2.0 per applicazione web lato client.
Aggiungere il markup HTML
Il widget richiede una piccola porzione di codice HTML per funzionare. Tu devono 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
elementi da associare sono identificati tramite il relativo attributo id
:
Carica il widget
Il widget viene caricato in modo dinamico tramite uno script di caricamento. Per includere
dal caricatore, utilizza il tag <script>
come mostrato di seguito:
Devi fornire un callback onload
nel tag script. La funzione viene chiamata
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 tutti i moduli sono stati
caricato.
Inizializzare il widget
Innanzitutto, inizializza la libreria client chiamando
gapi.client.init()
o gapi.auth2.init()
con l'ID cliente generato
e l'ambito https://www.googleapis.com/auth/cloud_search.query
. Quindi, utilizza
gapi.cloudsearch.widget.resultscontainer.Builder
e
gapi.cloudsearch.widget.searchbox.Builder
classi 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 la query. Puoi utilizzare la modalità 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 della
e accedere o uscire dagli utenti in base alle esigenze. Ad esempio,
di esempio osserva la classe isSignedIn
per monitorare le modifiche di accesso
utilizza GoogleAuth.signIn()
per avviare l'accesso da un pulsante
clic:
Per maggiori dettagli, vedi Accedi con Google.
Consentire l'accesso automatico degli utenti
Puoi semplificare ulteriormente l'esperienza di accesso pre-autorizzando il per conto degli utenti della tua organizzazione. Questa tecnica è è utile anche se utilizzi 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 le seguenti 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. Ciò si verifica dopo aver caricato i fogli di stile dell'applicazione, aumentando la priorità delle regole. Per fare in modo che i tuoi stili abbiano la precedenza su quelli predefiniti, Utilizzare i selettori predecessore per aumentare la specificità delle regole predefinite.
Ad esempio, la seguente regola non ha effetto se viene caricata in un ambiente
Tag link
o style
nel documento.
.cloudsearch_suggestion_container {
font-size: 14px;
}
Qualifica invece la regola con l'ID o la classe del container predecessore dichiarate nella pagina.
#suggestions_anchor .cloudsearch_suggestion_container {
font-size: 14px;
}
Per un elenco delle classi di supporto e degli esempi di codice HTML generati dal widget, vedi la sezione Riferimento per le classi CSS supportate.
Decora gli elementi con un adattatore
Per decorare un elemento prima del rendering, crea e reimposta un
che implementa uno dei metodi di decorazione come
decorateSuggestionElement
oppure decorateSearchResultElement.
Ad esempio, i seguenti adattatori aggiungono una classe personalizzata al suggerimento elementi dei risultati.
Per registrare l'adattatore durante l'inizializzazione del widget, usa setAdapter()
della rispettiva classe Builder
:
I decoratori possono modificare gli attributi dell'elemento contenitore, così come qualsiasi 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 il elementi in modo diretto, invece di decorare.
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 implementa
createSuggestionElement
,
createFacetResultElement
,
oppure createSearchResultElement
in modo reattivo.
I seguenti adattatori illustrano la creazione di suggerimenti personalizzati e risultati di ricerca
utilizzando i tag HTML <template>
.
Per registrare l'adattatore durante l'inizializzazione del widget, usa setAdapter()
della rispettiva classe Builder
:
Creazione di elementi facet personalizzati con createFacetResultElement
è soggetto a diverse restrizioni:
- Devi collegare la classe CSS
cloudsearch_facet_bucket_clickable
al su cui gli utenti fanno clic per attivare/disattivare un bucket. - Devi racchiudere ogni bucket in un elemento contenitore con il CSS
classe
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 di caselle di controllo.
Personalizza il comportamento di ricerca
Le impostazioni dell'applicazione di ricerca rappresentano il valore predefinito configurazione per un'interfaccia di ricerca e sono statici. Per implementare le creatività dinamiche, filtri o facet, ad esempio consentire agli utenti di attivare/disattivare le origini dati, puoi sostituisce le impostazioni dell'applicazione di ricerca intercettando la richiesta di ricerca con un adattatore.
Implementa un adattatore con
interceptSearchRequest
per modificare le richieste fatte
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
setAdapter()
quando crei l'elemento ResultsContainer
Il seguente codice HTML viene utilizzato per visualizzare una casella di selezione a cui applicare un filtro in base a fonti:
Il seguente codice rimane in ascolto della modifica, imposta la selezione e ed esegue nuovamente la query, se necessario.
Puoi anche intercettare la risposta di ricerca implementando
interceptSearchResponse
nell'adattatore.
Blocca la versione API
Per impostazione predefinita, il widget utilizza l'ultima versione stabile dell'API. Per bloccare
specifica una versione, imposta il parametro di configurazione cloudsearch.config/apiVersion
alla 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 valore
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 proteggere le applicazioni web, in particolare attacchi clickjacking.
Per ulteriori informazioni, vedi OWASP Guide Project.
Attiva debug
Utilizza interceptSearchRequest
per attivare il debug per il widget di ricerca. Ad esempio:
if (!request.requestOptions) {
// Make sure requestOptions is populated
request.requestOptions = {};
}
// Enable debugging
request.requestOptions.debugOptions = {enableDebugging: true}
return request;