Klasse "FacetRefinement"
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Die Klasse FacetRefinement wird verwendet, um Suchergebnisse basierend auf einem Attributwert einzugrenzen.
Es wird empfohlen, den Attributsuchfilter mit seinem Tokenstring zu verwenden. Jedes FacetResult hat ein Token, das anstelle dieser Klasse akzeptiert werden kann. Wenn Sie FacetRefinement manuell bereitstellen möchten, können Sie eine Instanz dieser Klasse an SearchOptions übergeben.
FacetRefinement ist im Modul google.appengine.api.search definiert.
Konstruktor
Der Konstruktor für die Klasse FacetRefinement ist so definiert:
class FacetRefinement(name, value=None, facet_range=None)
Konstruieren Sie eine Instanz der Klasse FacetRefinement.
HINWEIS: Es sollte entweder der Wert oder der facet_range festgelegt werden, aber nicht beides.
Argumente
- name
Legt die Namens-Property fest.
- Wert
Legt die Wert-Property fest.
- facet_range
Legt die Property "facet_range" fest.
Ergebniswert
Eine neue Instanz der Klasse FacetRefinement.
Ausnahmen
- TypeError
Wenn einer der Parameter ungültige Typen aufweist oder ein unbekanntes Attribut übergeben wird.
- ValueError
Wenn einer der Parameter ungültige Werte hat.
Eigenschaften
Eine Instanz der Klasse FacetRefinement hat die folgenden Attribute:
- name
Name des Attributsuchfilters.
- Wert
Stringwert des Attributsuchfilters.
- Bereich
Numerischer Bereich des Attributsuchfilters.
Instanzmethoden
Instanzen der Klasse FacetRefinement haben die folgenden Methoden:
- ToTokenString()
Wandelt diesen Suchfilter in einen Tokenstring um, der sicher in HTML verwendet werden kann. Das Format dieses Strings kann sich ändern.
-
Ergebniswert
Tokenstring, der für diesen Attributsuchfilter sicher in HTML verwendet werden kann.
- FromTokenString()
Bei dieser statischen Methode wird ein Tokenstring in ein FacetRefinement-Objekt umgewandelt. Speichern Sie Tokenstrings nicht in verschiedenen API-Versionen, da der Schlüssel inkompatibel sein könnte.
-
Argumente
- token_string
Mit der Methode "ToTokenString" erstellter oder von einem Suchergebnis zurückgegebener Tokenstring.
Ergebniswert
Ein "FacetRefinement"-Objekt.
Ausnahmen
- ValueError
Wenn der token_string ungültig ist.
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-09-04 (UTC).
[[["Leicht verständlich","easyToUnderstand","thumb-up"],["Mein Problem wurde gelöst","solvedMyProblem","thumb-up"],["Sonstiges","otherUp","thumb-up"]],[["Schwer verständlich","hardToUnderstand","thumb-down"],["Informationen oder Beispielcode falsch","incorrectInformationOrSampleCode","thumb-down"],["Benötigte Informationen/Beispiele nicht gefunden","missingTheInformationSamplesINeed","thumb-down"],["Problem mit der Übersetzung","translationIssue","thumb-down"],["Sonstiges","otherDown","thumb-down"]],["Zuletzt aktualisiert: 2025-09-04 (UTC)."],[[["\u003cp\u003eThe \u003ccode\u003eFacetRefinement\u003c/code\u003e class is used to refine search results based on a specific facet value.\u003c/p\u003e\n"],["\u003cp\u003eWhile manual \u003ccode\u003eFacetRefinement\u003c/code\u003e is possible, using the token string from \u003ccode\u003eFacetResult\u003c/code\u003e is the recommended approach.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eFacetRefinement\u003c/code\u003e constructor accepts a name, a value, or a \u003ccode\u003efacet_range\u003c/code\u003e, but only one of the value or facet_range can be specified.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eFacetRefinement\u003c/code\u003e instances have \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003evalue\u003c/code\u003e, and \u003ccode\u003erange\u003c/code\u003e properties that define the refinement.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eFacetRefinement\u003c/code\u003e objects can be converted to token strings using \u003ccode\u003eToTokenString()\u003c/code\u003e and can be created from a token string using the \u003ccode\u003eFromTokenString()\u003c/code\u003e method.\u003c/p\u003e\n"]]],[],null,["# The FacetRefinement Class\n\nClass `FacetRefinement` is used to narrow search results based on a facet value.\n\nThe recommended way to use facet refinement is to use its token string. Each FacetResult will\nhave a token that is acceptable instead of this class. To provide manual FacetRefinement, an\ninstance of this class can be passed to SearchOptions.\n| This API is supported for first-generation runtimes and can be used when [upgrading to corresponding second-generation runtimes](/appengine/docs/standard/\n| python3\n|\n| /services/access). If you are updating to the App Engine Python 3 runtime, refer to the [migration guide](/appengine/migration-center/standard/migrate-to-second-gen/python-differences) to learn about your migration options for legacy bundled services.\n\n`FacetRefinement` is defined in the module `google.appengine.api.search`.\n\nConstructor\n-----------\n\nThe constructor for class `FacetRefinement` is defined as follows:\n\nclass FacetRefinement(name, value=None, facet_range=None)\n\n: Construct an instance of class `FacetRefinement`.\n\n NOTE: Either the value or the facet_range should be set but not both.\n\n:\n\n Arguments\n\n name\n\n : Sets the name property\n\n value\n\n : Sets the value property\n\n facet_range\n\n : Sets the facet_range property\n\n Result value\n\n : A new instance of class `FacetRefinement`.\n\n Exceptions\n\n TypeError\n\n : If any of the parameters have invalid types, or an unknown\n attribute is passed.\n\n ValueError\n\n : If any of the parameters have invalid values.\n\n \u003cbr /\u003e\n\n\u003cbr /\u003e\n\nProperties\n----------\n\nAn instance of class `FacetRefinement` has the following properties:\n\nname\n\n: name of the facet refinement.\n\nvalue\n\n: string value of the facet refinement.\n\nrange\n\n: numeric range of the facet refinement.\n\nInstance Methods\n----------------\n\nInstances of class `FacetRefinement` have the following methods:\n\nToTokenString()\n\n: Converts this refinement to a token string safe to be used in HTML. The format of this string may change.\n\n: Result value\n\n : A token string safe to be used in HTML for this facet refinement.\n\nFromTokenString()\n\n: This static method converts a token string to a FacetRefinement object. Do not store token strings between different versions of API as key could\n be incompatible.\n\n: Arguments\n\n token_string\n\n : A token string created by ToTokenString method or returned\n by a search result.\n\n Result value\n\n : A FacetRefinement object.\n\n Exceptions\n\n ValueError\n\n : If the token_string is invalid."]]
