La classe FacetRefinement
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
La classe FacetRefinement est utilisée pour affiner les résultats de la recherche en fonction d'une valeur d'attribut.
La méthode recommandée pour utiliser le raffinement d'attribut consiste à utiliser sa chaîne de jeton. Chaque FacetResult aura un jeton acceptable à la place de cette classe. Pour fournir FacetRefinement manuellement, une instance de cette classe peut être transmise à SearchOptions.
La classe FacetRefinement est définie dans le module google.appengine.api.search.
Constructeur
Le constructeur de la classe FacetRefinement est défini comme suit :
classe FacetRefinement (nom, valeur = None, facet_range = None)
Construire une instance de la classe FacetRefinement.
Remarque : La valeur ou la facet_range doit être définie, mais pas les deux.
Arguments
- name
Définit la propriété du nom
- value
Définit la propriété value
- facet_range
Définit la propriété facet_range
Result value
Nouvelle instance de la classe FacetRefinement.
Exceptions
- TypeError
Si l'un des paramètres contient un type non valide ou si un attribut inconnu est transmis.
- ValueError
Si l'un des paramètres possède des valeurs non valides.
Propriétés
Une instance de la classe FacetRefinement possède les propriétés suivantes :
- name
nom du raffinement de l'attribut.
- value
valeur de chaîne du raffinement de l'attribut.
- range
plage numérique du raffinement de l'attribut.
Méthodes des instances
Les instances de la classe FacetRefinement utilisent les méthodes suivantes :
- ToTokenString()
Convertit ce raffinement en chaîne de jeton pouvant être utilisée en HTML. Le format de cette chaîne peut changer.
-
Result value
Une chaîne de jeton sécurisée à utiliser en HTML pour ce raffinement d'attribut.
- FromTokenString()
Cette méthode statique convertit une chaîne de jeton en objet FacetRefinement. Ne stockez pas de chaînes de jeton entre différentes versions de l'API, car la clé pourrait être incompatible.
-
Arguments
- token_string
Chaîne de jeton créée par la méthode ToTokenString ou renvoyée par un résultat de recherche.
Result value
Un objet FacetRefinement.
Exceptions
- ValueError
Si token_string n'est pas valide.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/09/04 (UTC).
[[["Facile à comprendre","easyToUnderstand","thumb-up"],["J'ai pu résoudre mon problème","solvedMyProblem","thumb-up"],["Autre","otherUp","thumb-up"]],[["Difficile à comprendre","hardToUnderstand","thumb-down"],["Informations ou exemple de code incorrects","incorrectInformationOrSampleCode","thumb-down"],["Il n'y a pas l'information/les exemples dont j'ai besoin","missingTheInformationSamplesINeed","thumb-down"],["Problème de traduction","translationIssue","thumb-down"],["Autre","otherDown","thumb-down"]],["Dernière mise à jour le 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."]]
