Mit dem Such-Widget steht Ihnen eine anpassbare Suchoberfläche für Webanwendungen zur Verfügung. Für das Widget wird nur wenig HTML- und JavaScript-Code benötigt, um gängige Suchfunktionen zu implementieren und zu aktivieren, z. B. Facetten und Paginierung. Sie können mit CSS und JavaScript auch Teile der Benutzeroberfläche anpassen.
Wenn Sie mehr Flexibilität benötigen als vom Widget angeboten, sollten Sie die Query API verwenden. Weitere Informationen zum Erstellen einer Suchoberfläche mit der Query API
Suchoberfläche erstellen
So erstellen Sie eine Suchoberfläche:
- Suchanwendung konfigurieren
- Client-ID für die Anwendung generieren
- Dem Suchfeld und den Suchergebnissen HTML-Markup hinzufügen
- Widget auf die Seite laden
- Widget initialisieren
Suchanwendung konfigurieren
Für jede Suchoberfläche muss in der Admin-Konsole eine Suchanwendung definiert werden. Die Suchanwendung enthält zusätzliche Informationen für die Abfrage, z. B. Datenquellen, Facetten und Einstellungen für die Suchqualität.
Informationen zum Erstellen einer Suchanwendung finden Sie im Hilfeartikel Benutzerdefinierte Suche erstellen.
Client-ID für die Anwendung generieren
Zusätzlich zu den Schritten in der Anleitung zum Konfigurieren des Zugriffs auf die Google Cloud Search API müssen Sie auch eine Client-ID für die Webanwendung generieren.
Bei der Konfiguration eines Projekts sollten Sie Folgendes tun:
- Wählen Sie als Clienttyp Webbrowser aus.
- Geben Sie den Origin-URI Ihrer App an.
- Notieren Sie sich die erstellte Client-ID. Sie benötigen diese für die nächsten Schritte. Der Clientschlüssel ist für das Widget nicht erforderlich.
HTML-Markup hinzufügen
Damit das Widget funktioniert, ist etwas HTML-Code erforderlich. Sie müssen Folgendes angeben:
- Ein
input
-Element für das Suchfeld. - Ein Element, um das Pop-up für Vorschläge zu verankern.
- Ein Element, in dem die Suchergebnisse enthalten sind.
- Optional: Ein Element, das die Steuerelemente für Facets enthält
Im folgenden Snippet sehen Sie den HTML-Code für ein Such-Widget, wobei die zu bindenden Elemente durch ihr id
-Attribut identifiziert werden:
Widget laden
Das Widget wird über ein Lader-Skript dynamisch geladen. Verwenden Sie das Tag <script>
folgendermaßen, um den Lader einzubinden:
Im Skript-Tag müssen Sie einen onload
-Funktionsaufruf bereitstellen. Die Funktion wird aufgerufen, wenn der Lader bereit ist. Fahren Sie dann mit dem Laden des Widgets fort, indem Sie gapi.load()
aufrufen. So werden der API-Client für Google Log-in und für Cloud Search geladen.
Die Funktion initializeApp()
wird aufgerufen, nachdem alle Module geladen wurden.
Widget initialisieren
Initialisieren Sie zuerst die Clientbibliothek, indem Sie gapi.client.init()
oder gapi.auth2.init()
mit Ihrer generierten Client-ID und dem Bereich https://www.googleapis.com/auth/cloud_search.query
aufrufen. Verwenden Sie als Nächstes die Klassen gapi.cloudsearch.widget.resultscontainer.Builder
und gapi.cloudsearch.widget.searchbox.Builder
, um das Widget zu konfigurieren und an Ihre HTML-Elemente zu binden.
Im folgenden Beispiel sehen Sie, wie das Widget initialisiert wird:
Im obigen Beispiel wird für die Konfiguration auf zwei Variablen verwiesen, die folgendermaßen definiert sind:
Anmeldung anpassen
Standardmäßig werden Nutzer vom Widget aufgefordert, sich anzumelden und die App zu autorisieren, sobald sie mit der Eingabe einer Abfrage beginnen. Mithilfe von Google Log-in für Websites können Sie Ihren Nutzern eine individuellere Anmeldung anbieten.
Nutzer direkt autorisieren
Verwenden Sie Über Google anmelden, um den Anmeldestatus eines Nutzers zu überwachen und diesen bei Bedarf an- oder abzumelden. Im folgenden Beispiel wird beispielsweise der Status isSignedIn
beobachtet, um Änderungen bei der Anmeldung zu überwachen. Die Anmeldung wird über die Methode GoogleAuth.signIn()
gestartet, wenn auf eine Schaltfläche geklickt wird:
Weitere Informationen finden Sie unter Über Google anmelden.
Nutzer automatisch anmelden
Sie können die Anmeldung weiter optimieren, indem Sie die Anwendung für die Nutzer in Ihrer Organisation vorab autorisieren. Diese Technik ist auch nützlich, wenn Sie Cloud Identity-Aware Proxy verwenden, um die Anwendung zu schützen.
Weitere Informationen finden Sie im Artikel Google Log-in mit IT-Apps verwenden.
Benutzeroberfläche anpassen
Sie können das Erscheinungsbild der Suchoberfläche durch eine Kombination verschiedener Vorgänge ändern:
- Stile mit CSS überschreiben
- Elemente mit einem Adapter dekorieren
- Benutzerdefinierte Elemente mit einem Adapter erstellen
Stile mit CSS überschreiben
Das Such-Widget hat ein eigenes CSS, um Vorschlags- und Ergebniselemente sowie die Steuerelemente für die Paginierung zu formatieren. Sie können diese Elemente nach Bedarf umgestalten.
Während des Ladevorgangs wird auch das Stylesheet des Such-Widgets dynamisch geladen. Dies geschieht nach dem Laden von Anwendungs-Stylesheets, wodurch die Priorität der Regeln erhöht wird. Wenn Sie dafür sorgen möchten, dass Ihre eigenen Stile Vorrang vor den Standardstilen haben, verwenden Sie Ancestor-Selektoren, um die Standardregeln spezifischer zu gestalten.
Die folgende Regel hat beispielsweise keine Auswirkungen, wenn sie in einen statischen link
- oder style
-Tag im Dokument geladen wird:
.cloudsearch_suggestion_container {
font-size: 14px;
}
Qualifizieren Sie die Regel stattdessen mit der ID oder der Klasse des auf der Seite deklarierten übergeordneten Containers.
#suggestions_anchor .cloudsearch_suggestion_container {
font-size: 14px;
}
Elemente mit einem Adapter dekorieren
Wenn Sie ein Element vor dem Rendern dekorieren möchten, erstellen und registrieren Sie einen Adapter, der eine der Dekorationsmethoden wie decorateSuggestionElement
oder decorateSearchResultElement.
implementiert.
Durch die folgenden Adapter werden den Elementen für Vorschläge und Ergebnisse beispielsweise eine benutzerdefinierte Klasse hinzugefügt.
Wenn Sie den Adapter bei der Initialisierung des Widgets registrieren möchten, verwenden Sie die Methode setAdapter()
der jeweiligen Builder
-Klasse:
Mit einem Decorator können die Attribute des Containerelements sowie alle untergeordneten Elemente geändert werden. Untergeordnete Elemente können während der Dekoration hinzugefügt oder entfernt werden. Wenn Sie jedoch strukturelle Änderungen an den Elementen vornehmen, sollten Sie die Elemente direkt erstellen, anstatt sie zu dekorieren.
Benutzerdefinierte Elemente mit einem Adapter erstellen
Wenn Sie ein benutzerdefiniertes Element für einen Vorschlag, einen Facettencontainer oder ein Suchergebnis erstellen möchten, erstellen und registrieren Sie einen Adapter, der createSuggestionElement
, createFacetResultElement
oder createSearchResultElement
implementiert.
Die folgenden Adapter veranschaulichen, wie benutzerdefinierte Vorschlags- und Suchergebniselemente mithilfe von <template>
-HTML-Tags erstellt werden.
Wenn Sie den Adapter bei der Initialisierung des Widgets registrieren möchten, verwenden Sie die Methode setAdapter()
der jeweiligen Builder
-Klasse:
Für das Erstellen benutzerdefinierter Facetten-Elemente mit createFacetResultElement
gibt es mehrere Einschränkungen:
- Die CSS-Klasse
cloudsearch_facet_bucket_clickable
muss an das Element angehängt werden, auf das Nutzer klicken, um zwischen Buckets durchzuwechseln. - Jeder Bucket muss sich in einem Element befinden. Verwenden Sie hierzu die CCS-Klasse
cloudsearch_facet_bucket_container
. - Buckets können nur in der Reihenfolge gerendert werden, die die Antwort vorgibt.
Im folgenden Snippet werden Facetten beispielsweise mithilfe von Links anstelle von Kästchen dargestellt.
Suchverhalten anpassen
Die Einstellungen der Suchanwendung stellen die Standardkonfiguration für eine Suchoberfläche dar und sind statisch. Wenn dynamische Filter oder Facetten implementiert werden sollen, z. B. um Nutzern den Wechsel zwischen Datenquellen zu ermöglichen, können Sie die Einstellungen der Suchanwendung überschreiben. Dazu fangen Sie die Suchanfrage mit einem Adapter ab.
Implementieren Sie einen Adapter mit der Methode interceptSearchRequest
, um Anfragen an die Such-API vor der Ausführung zu ändern.
Der folgende Adapter fängt beispielsweise Anforderungen ab, um Abfragen auf eine vom Nutzer ausgewählte Quelle zu beschränken:
Wenn Sie den Adapter bei der Initialisierung des Widgets registrieren möchten, verwenden Sie beim Erstellen des ResultsContainer
die Methode setAdapter()
.
Der folgende HTML-Code wird verwendet, um ein Auswahlfeld zum Filtern nach Quellen anzuzeigen:
Mit dem folgenden Code soll die Änderung erkannt, die Auswahl getroffen und die Abfrage falls nötig neu ausgeführt werden.
Sie können die Suchantwort auch abfangen, indem Sie interceptSearchResponse
im Adapter implementieren.
API-Version anpinnen
Standardmäßig verwendet das Widget die neueste stabile Version der API. Soll eine bestimmte Version verwendet werden, legen Sie den Konfigurationsparameter cloudsearch.config/apiVersion
auf die bevorzugte Version fest, bevor Sie das Widget initialisieren.
Wenn die API-Version nicht festgelegt oder auf einen ungültigen Wert gesetzt ist, wird standardmäßig „1.0“ verwendet.
Widgetversion anpinnen
Um unerwartete Änderungen an Suchoberflächen zu vermeiden, legen Sie den Konfigurationsparameter cloudsearch.config/clientVersion
wie unten gezeigt fest:
gapi.config.update('cloudsearch.config/clientVersion', 1.1);
Wenn die Widget-Version nicht festgelegt oder auf einen ungültigen Wert gesetzt ist, wird standardmäßig „1.0“ verwendet.
Suchoberfläche schützen
Die Suchergebnisse enthalten vertrauliche Informationen. Befolgen Sie die Best Practices, um Webanwendungen zu schützen, insbesondere vor Clickjacking-Angriffen.
Weitere Informationen vom Open Web Application Security Project
Debug aktivieren
Verwenden Sie interceptSearchRequest
, um die Fehlerbehebung für das Such-Widget zu aktivieren. Beispiel:
if (!request.requestOptions) {
// Make sure requestOptions is populated
request.requestOptions = {};
}
// Enable debugging
request.requestOptions.debugOptions = {enableDebugging: true}
return request;