Python 2.7 has reached end of support
and will be
deprecated
on January 31, 2026. After deprecation, you won't be able to deploy Python 2.7
applications, even if your organization previously used an organization policy to
re-enable deployments of legacy runtimes. Your existing Python
2.7 applications will continue to run and receive traffic after their
deprecation date. We recommend that
you
migrate to the latest supported version of Python.
The FacetRefinement Class
Stay organized with collections
Save and categorize content based on your preferences.
Class FacetRefinement is used to narrow search results based on a facet value.
The recommended way to use facet refinement is to use its token string. Each FacetResult will
have a token that is acceptable instead of this class. To provide manual FacetRefinement, an
instance of this class can be passed to SearchOptions.
FacetRefinement is defined in the module google.appengine.api.search.
Constructor
The constructor for class FacetRefinement is defined as follows:
class FacetRefinement(name, value=None, facet_range=None)
Construct an instance of class FacetRefinement.
NOTE: Either the value or the facet_range should be set but not both.
Arguments
- name
Sets the name property
- value
Sets the value property
- facet_range
Sets the facet_range property
Result value
A new instance of class FacetRefinement.
Exceptions
- TypeError
If any of the parameters have invalid types, or an unknown
attribute is passed.
- ValueError
If any of the parameters have invalid values.
Properties
An instance of class FacetRefinement has the following properties:
- name
name of the facet refinement.
- value
string value of the facet refinement.
- range
numeric range of the facet refinement.
Instance Methods
Instances of class FacetRefinement have the following methods:
- ToTokenString()
Converts this refinement to a token string safe to be used in HTML. The format of this string may change.
-
Result value
A token string safe to be used in HTML for this facet refinement.
- FromTokenString()
This static method converts a token string to a FacetRefinement object. Do not store token strings between different versions of API as key could
be incompatible.
-
Arguments
- token_string
A token string created by ToTokenString method or returned
by a search result.
Result value
A FacetRefinement object.
Exceptions
- ValueError
If the token_string is invalid.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-29 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-29 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."]]
