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 FacetResultValue Class
Stay organized with collections
Save and categorize content based on your preferences.
Class FacetResultValue Represents a facet value as part of search result.
FacetResultValue is defined in the module google.appengine.api.search.
Constructor
The constructor for class FacetResultValue is defined as follows:
class FacetResultValue(label, count, refinement)
Construct an instance of class FacetRefinement.
Arguments
- label
- Sets the label property
- count
- Sets the count property
- refinement
- Sets the refinement property
Result value
A new instance of class FacetResultValue.
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 FacetResultValue has the following properties:
- label
The label for this facet value. For an atom facet, the label is the facet's string value, For numeric facet values, it's a string representing the value range.
- count
The number of documents (in the current query results) that match this FacetResultValue.
- refinement_token
The FacetRefinement object for this FacetResultValue. Passing this object
or its string token to the next query will refine the result based on
this facet value.
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\u003e\u003ccode\u003eFacetResultValue\u003c/code\u003e represents a facet value within search results and is part of the \u003ccode\u003egoogle.appengine.api.search\u003c/code\u003e module, supported for first-generation runtimes.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eFacetResultValue\u003c/code\u003e constructor takes label, count, and refinement as arguments to create a new instance, raising \u003ccode\u003eTypeError\u003c/code\u003e or \u003ccode\u003eValueError\u003c/code\u003e for invalid inputs.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003elabel\u003c/code\u003e property of \u003ccode\u003eFacetResultValue\u003c/code\u003e represents the string value for atom facets or a string range for numeric facets.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ecount\u003c/code\u003e property indicates how many documents match the \u003ccode\u003eFacetResultValue\u003c/code\u003e in the current query results.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003erefinement_token\u003c/code\u003e property provides a \u003ccode\u003eFacetRefinement\u003c/code\u003e object to further refine future search queries based on the selected facet value.\u003c/p\u003e\n"]]],[],null,["# The FacetResultValue Class\n\nClass `FacetResultValue` Represents a facet value as part of search result.\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`FacetResultValue` is defined in the module `google.appengine.api.search`.\n\nConstructor\n-----------\n\nThe constructor for class `FacetResultValue` is defined as follows:\n\nclass FacetResultValue(label, count, refinement)\n\n: Construct an instance of class `FacetRefinement`.\n\n:\n\n Arguments\n\n label\n : Sets the label property\n\n count\n : Sets the count property\n\n refinement\n : Sets the refinement property\n\n Result value\n\n : A new instance of class `FacetResultValue`.\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 `FacetResultValue` has the following properties:\n\nlabel\n\n: The label for this facet value. For an atom facet, the label is the facet's string value, For numeric facet values, it's a string representing the value range.\n\ncount\n\n: The number of documents (in the current query results) that match this FacetResultValue.\n\nrefinement_token\n\n: The FacetRefinement object for this FacetResultValue. Passing this object\n or its string token to the next query will refine the result based on\n this facet value."]]
