Builder

new Builder()

// Builds a search box.
function onload() {
  gapi.client.init({
    'apiKey': '<your api key>',
    'clientId': '<your client id>',
    // Add additional scopes if needed
    'scope': 'https://www.googleapis.com/auth/cloud_search.query',
    'hosted_domain': '<your G Suite domain>',
  });

  const searchBox = new gapi.cloudsearch.widget.searchbox.Builder()
    .setInput(document.getElementById('input'))
    .setAnchor(document.getElementById('input').parentElement)
    .build();
}
gapi.load('client:cloudsearch-widget', onload);

Build

build() gibt „SearchBox“ zurück

Ausgabe

non-null SearchBox 

setAdapter

setAdapter(adapter) gibt Builder zurück

Erforderlich. Mit diesem Adapter können Sie die Suche für Nutzer anpassen.

Ausgabe

non-null Builder dies

const adapter = {
 interceptSuggestRequest: function(request) {
    // Change the request
  }
}

builder.setAdapter(adapter).build();

setAnchor

setAnchor(anchor) gibt „Builder“ zurück

Erforderlich. Muss ein gültiges HTMLElement sein, das untergeordnete Knoten enthalten kann. Anker des Such-Overlays. Das Overlay wird als letztes untergeordnetes Element in „anchor“ hinzugefügt. Die Position des Overlays ist der untere Anker.

Verworfen

Verwenden Sie stattdessen „setAnchorElement“

Ausgabe

non-null Builder dies

setAnchorElement

setAnchorElement(anchorElement) gibt Builder zurück

Erforderlich. Muss ein gültiges HTMLElement sein, das untergeordnete Knoten enthalten kann. Anker des Such-Overlays. Das Overlay wird als letztes untergeordnetes Element in „anchor“ hinzugefügt. Die Position des Overlays ist der untere Anker.

Ausgabe

non-null Builder dies

setHints

setHints(hints) gibt Builder zurück

Optional: Die Hinweise im Suchfeld, wenn die Eingabe leer ist. Wenn die Eingabe leer ist, wird ein zufälliger Hinweis aus dem Array ausgewählt.

Ausgabe

non-null Builder dies

setInput

setInput(input) gibt Builder zurück

Erforderlich. Ein HTMLElement, in das der Nutzer die Suchanfrage eingibt. Muss <input> oder <textarea> sein

Verworfen

Verwenden Sie stattdessen „setInputElement“

Ausgabe

non-null Builder dies

setInputElement

setInputElement(inputElement) gibt Builder zurück

Erforderlich. Ein HTMLElement, in das der Nutzer die Suchanfrage eingibt. Muss <input> oder <textarea> sein

Ausgabe

non-null Builder dies

setResultsContainer

setResultsContainer(resultsContainer) gibt Builder zurück

Optional: Container zum Anzeigen von Suchergebnissen. Wenn diese Option festgelegt ist, werden die Ergebnisse im Suchergebniscontainer gerendert. Wenn nicht festgelegt, werden die Ergebnisse unter cloudsearch.google.com angezeigt.

Weitere Informationen

ResultsContainer

Ausgabe

non-null Builder dies

setSearchApplicationId

setSearchApplicationId(searchApplicationId) gibt Builder zurück

Optional: Legt die Suchanwendungs-ID fest, die für Anfragen verwendet werden soll. Muss das Präfix „searchapplications/“ haben.

Ausgabe

non-null Builder dies

setThrottleInterval

setThrottleInterval(throttleInterval) gibt Builder zurück

Optional: Das Drosselintervall in Millisekunden bei der Auslösung der Anfrage. Das Suchfeld sendet weniger als eine Anfrage alle throttleInterval-Millisekunden. Wenn „throttleInternal“ kleiner als 200 ist, wird der Wert vom Suchfeld ignoriert und stattdessen 200 als Intervall verwendet.

Ausgabe

non-null Builder dies