FactFinder Suchparameter
Wann immer Daten über eine URL an FactFinder übergeben werden, ist es wichtig, dass das Encoding korrekt eingestellt ist. Ist dies nicht der Fall, so werden Sonderzeichen und Umlaute falsch verarbeitet. Das Standard-URL-Encoding für FactFinder ist UTF-8. Im Folgenden sind die möglichen Suchparameter aufgelistet:
Basis Parameter
Name | Beschreibung |
---|---|
query* (query) | Der Suchbegriff gibt an, nach welchem Begriff in der FactFinder Datenbank gesucht werden soll. |
channel* (path) | Falls Ihre Suchumgebung mehrere Channels umfasst, müssen Sie über diesen Parameter angeben, welchen Sie durchsuchen wollen. Ist kein Channel explizit angegeben, so wird der erste Channel in der Channel-Liste verwendet. |
page (query) | Falls ein Suchergebnis viele Ergebnisse beinhaltet, werden diese in Seiten unterteilt. So wird die zu übertragende Menge kleingehalten. Hierüber können Sie angeben, welche Seite zurückgegeben werden soll, die Zählung beginnt bei 1. |
hitsPerPage (query) | Sie können im FactFinder Management Interface definieren, wie viele Ergebnisse per Standard auf einer Seite zurückgeliefert werden sollen. Möchten Sie eine andere Anzahl anzeigen, können Sie dies mit diesem Parameter einstellen. |
sort (query) | Per Standard wird das Ergebnis nach Relevanz sortiert zurückgegeben, soll es anders sortiert werden, kann dies hierüber eingestellt werden. Es ist auch möglich mehrere Sortierungen zu verwenden, diese werden der Reihe nach angewendet. Benutzen Sie |
filter (query) | Filter für den kompletten Feldwert; ein Filter kann mehrere Werte haben, die Werte können mit den folgenden Zeichen getrennt werden (sie sind in der 'und' = 'oder' = der Filterwert kann mit dem Präfix Beispiel: Wenn der Filtername gleich '*' ist, wird der Filter auf jedes beliebige Feld angewendet; Beispiel: Beachten Sie, dass Filterwerte für Kategoriepfadfilter URL-kodiert sein müssen, so dass ein "100%"-Kategoriepfadfilterwert "100%25" sein würde. Er wird ein zweites Mal kodiert, wenn er über 'GET' verwendet wird. Swagger führt diese zweite Kodierung automatisch durch, so dass die URL '100%2525' enthält. Numerische Filter verwenden die standardmäßige mathematische Intervallnotation, aber nur Intervalle, die auf der linken Seite geschlossen und auf der rechten Seite offen sind, sind als Eingabe zulässig. Es sind also nur Intervalle der Form [a,b), [a,) oder [a,] zulässig. Eckige Klammern bedeuten, dass der entsprechende Randwert eingeschlossen ist, runde Klammern bedeuten, dass der Randwert selbst nicht eingeschlossen ist. Für Werte vom Typ Datum kann die gleiche Notation wie numerische Filter, also wie für die Filter für die Typen Ganzzahl und Dezimalzahl, verwendet werden: Das Format des Datums kann entweder ISO-8601 mit Zeitzone (yyyy-MM-dd'T'HH:mm:ssZZ), ein Unix-Timestamp in Millisekunden oder das für das Feld definierte Format sein. |
substringFilter (query) | Filter für einen Substring des Feldwertes; ein Filter kann mehrere Werte haben, die Werte können mit den folgenden Zeichen getrennt werden (sie sind in der 'und' = 'oder' = der Filterwert kann mit dem Präfix Beispiel: |
searchField (query) | Im Normalfall durchsucht FactFinder alle als durchsuchbar definierten Felder. Es ist jedoch auch möglich, nur in einem bestimmten Feld zu suchen. |
articleNumberSearch (query) | Gibt an, ob der Suchbegriff als Artikelnummer interpretiert werden soll. Standardwert: |
sid (query) | Die Session-ID |
userInput (query) | Verwenden Sie diesen Parameter, um die Zeichen zu senden, die der Shop-Benutzer eingegeben hat, bis die Suchanfrage ausgelöst wurde. |
queryFromSuggest (query) | Dieser Parameter gibt an, dass die FactFinder-Abfrage durch eine Auswahl aus der Vorschlagsliste ausgelöst wurde. In diesem Fall senden Sie den Parameter mit dem Wert true . |
*Pflicht-Parameter
Parameter bei der Steuerung des Such-Ablaufs
Name | Beschreibung |
---|---|
useSearch (query) | Wenn Standardwert: |
useAsn (query) | Steuert die Erzeugung der ASN. |
useFoundWords (query) | FactFinder ist in der Lage zu den gefundenen Datensätzen die Wörter zurückzuliefern, die zum Fund des Datensatzes geführt haben. Die Ermittlung dieser Wörter kostet Rechenzeit. Daher ist diese per Default deaktiviert. |
useCampaigns (query) | Falls Sie verhindern wollen, dass der Kampagnen-Manager überprüft, ob für diese Suchanfrage eine Kampagne vorliegt, verwenden Sie diesen Parameter. Nähere Informationen zum Kampagnen-Manager finden Sie in dessen Dokumentation. |
idsOnly (query) | In der Rückgabe erhalten Sie normalerweise alle Feldinformationen der gefundenen Produkte. Sollten Sie nur die IDs benötigen, können Sie die Übertragung der Feldinhalte deaktivieren und so Bandbreite sparen. |
useCache (query) | Steuert die Verwendung des Such-Ergebnis-Caches. |
cacheIrrelevant (query) | Parameter als für den Cache irrelevant markieren. |
usePersonalization (query) | Erlaubt das Aktivieren/Deaktivieren der Personalisierung der Anfragen. |
useSemanticEnhancer (query) | Erlaubt das Aktivieren/Deaktivieren der semantischen Anreicherung der Anfragen.
|
useAso (query) | Erlaubt das Aktivieren/Deaktivieren der automatischen Such-Optimierung.
|
maxCountVariants (query) | Die maximale Anzahl der Varianten, die für jeden Datensatz zurückgegeben werden können. |
advisorStatus (query) | Zur Angabe der aktuellen Kampagnen-ID und des Antwortpfades; Format: |
useDeduplication (query) | Wenn Standardwert: |
deduplicationField (query) | Gibt an, auf welchem Feld Varianten dedupliziert werden sollen. |
Sonstige Parameter
Beschreibung | URL-Parameter | |
---|---|---|
Rückgabeversion | Um den Umstieg auf neue Versionen zu erleichtern, besitzt FactFinder versionierte Rückgabe-APIs. Damit können zB neuere FactFinder Versionen mit älterem Integrationscode betrieben werden, so dass dieser bei Bedarf zeitversetzt aktualisiert werden könnte. | Die gewünschte Rückgabeversion, wird über den Parameter In der FactFinder Version 7.2 können die Werte Beachten Sie, dass per Anwendungskonfiguration eine Standard-Version definiert wird, im Normalfall müssen Sie daher diesen Parameter nicht setzen. |
Anwendungsnamen verbergen | Die zurückgelieferten Suchparameter-URLs fangen im Normalfall mit dem Namen der FactFinder Serverapplikation an. Dies kann jedoch deaktiviert werden. Dies ist z. B. bei Installationen mit Lastverteilung sinnvoll, bei denen die unterschiedlichen FactFinder-Applikationen unterschiedliche Namen tragen. Das kann aber auch in „normalen“ Einsatzszenarien verwendet werden, um Übertragungsvolumen zu sparen. | Wenn Sie |
Beschreibung von Logfiles | Manchmal ist es sinnvoll, Logfiles eine Beschreibung hinzuzufügen. Etwa, wenn nur bestimmte Suchanfragen ausgewertet werden sollen. Eine derartige Beschreibung kann dann beispielsweise in der Logfileanalyse eingesehen werden. Der Wert darf nur Buchstaben und Ziffern enthalten. | Der hierfür notwendige zusätzliche Parameter hat den Namen |