Suchoberfläche mit dem Such-Widget erstellen

Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

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.

/**
* Load the cloud search widget & auth libraries. Runs after
* the initial gapi bootstrap library is ready.
*/
function onLoad() {
  gapi.load('client:auth2:cloudsearch-widget', initializeApp)
}

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:

/**
 * Initialize the app after loading the Google API client &
 * Cloud Search widget.
 */
function initializeApp() {
  // Load client ID & search app.
  loadConfiguration().then(function() {
    // Set API version to v1.
    gapi.config.update('cloudsearch.config/apiVersion', 'v1');

    // Build the result container and bind to DOM elements.
    var resultsContainer = new gapi.cloudsearch.widget.resultscontainer.Builder()
      .setSearchApplicationId(searchApplicationName)
      .setSearchResultsContainerElement(document.getElementById('search_results'))
      .setFacetResultsContainerElement(document.getElementById('facet_results'))
      .build();

    // Build the search box and bind to DOM elements.
    var searchBox = new gapi.cloudsearch.widget.searchbox.Builder()
      .setSearchApplicationId(searchApplicationName)
      .setInput(document.getElementById('search_input'))
      .setAnchor(document.getElementById('suggestions_anchor'))
      .setResultsContainer(resultsContainer)
      .build();
  }).then(function() {
    // Init API/oauth client w/client ID.
    return gapi.auth2.init({
        'clientId': clientId,
        'scope': 'https://www.googleapis.com/auth/cloud_search.query'
    });
  });
}

Im obigen Beispiel wird für die Konfiguration auf zwei Variablen verwiesen, die folgendermaßen definiert sind:

/**
* Client ID from OAuth credentials.
*/
var clientId = "...apps.googleusercontent.com";

/**
* Full resource name of the search application, such as
* "searchapplications/".
*/
var searchApplicationName = "searchapplications/...";

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:

// Handle sign-in/sign-out.
let auth = gapi.auth2.getAuthInstance();

// Watch for sign in status changes to update the UI appropriately.
let onSignInChanged = (isSignedIn) => {
  // Update UI to switch between signed in/out states
  // ...
}
auth.isSignedIn.listen(onSignInChanged);
onSignInChanged(auth.isSignedIn.get()); // Trigger with current status.

// Connect sign-in/sign-out buttons.
document.getElementById("sign-in").onclick = function(e) {
  auth.signIn();
};
document.getElementById("sign-out").onclick = function(e) {
  auth.signOut();
};

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;
}

Weitere Informationen zu den unterstützen CSS-Klassen und Beispiel-HTML, die vom Widget erstellt wurden

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.

/**
 * Search box adapter that decorates suggestion elements by
 * adding a custom CSS class.
 */
function SearchBoxAdapter() {}
SearchBoxAdapter.prototype.decorateSuggestionElement = function(element) {
  element.classList.add('my-suggestion');
}

/**
 * Results container adapter that decorates suggestion elements by
 * adding a custom CSS class.
 */
function ResultsContainerAdapter() {}
ResultsContainerAdapter.prototype.decorateSearchResultElement = function(element) {
  element.classList.add('my-result');
}

Wenn Sie den Adapter bei der Initialisierung des Widgets registrieren möchten, verwenden Sie die Methode setAdapter() der jeweiligen Builder-Klasse:

// Build the result container and bind to DOM elements.
var resultsContainer = new gapi.cloudsearch.widget.resultscontainer.Builder()
  .setAdapter(new ResultsContainerAdapter())
  // ...
  .build();

// Build the search box and bind to DOM elements.
var searchBox = new gapi.cloudsearch.widget.searchbox.Builder()
  .setAdapter(new SearchBoxAdapter())
  // ...
  .build();

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