A classe FacetRefinement
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
A classe FacetRefinement é usada para restringir os resultados da pesquisa com base em um valor de atributo.
A maneira recomendada de usar o refinamento de atributo é usar a respectiva string de token. Cada FacetResult terá um token aceitável em vez dessa classe. Para fornecer FacetRefinement manual, uma instância dessa classe pode ser transmitida para SearchOptions.
FacetRefinement é definido no módulo google.appengine.api.search.
Construtor
O construtor da classe FacetRefinement é definido da seguinte maneira:
classe FacetRefinement(name, value=None, facet_range=None)
Crie uma instância da classe FacetRefinement.
OBSERVAÇÃO: o valor ou o facet_range precisam ser definidos, mas não os dois.
Argumentos
- name
Define a propriedade "name"
- value
Define a propriedade "value"
- facet_range
Define a propriedade "facet_range"
Valor do resultado
Uma nova instância da classe FacetRefinement.
Exceções
- TypeError
Se algum dos parâmetros tiver tipos inválidos ou um atributo desconhecido for passado.
- ValueError
Se algum dos parâmetros tiver valores inválidos.
Propriedades
Uma instância da classe FacetRefinement tem as seguintes propriedades:
- name
Nome do refinamento do atributo.
- value
Valor da string do refinamento do atributo.
- Intervalo
Intervalo numérico do refinamento do atributo.
Métodos de instância
As instâncias de classe FacetRefinement têm os seguintes métodos:
- ToTokenString()
Converte este refinamento em uma string de token seguro para ser usada em HTML.
-
Valor do resultado
Uma string de token segura para ser usada em HTML neste refinamento de atributo.
- FromTokenString()
Este método estático converte uma string de token em um objeto FacetRefinement. Não armazene strings de token entre diferentes versões da API, porque a chave pode ser incompatível.
-
Argumentos
- token_string
Uma string de token criada pelo método ToTokenString ou retornada por um resultado de pesquisa.
Valor do resultado
Um objeto FacetRefinement.
Exceções
- ValueError
Se o token_string é inválido.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-09-04 UTC.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Informações incorretas ou exemplo de código","incorrectInformationOrSampleCode","thumb-down"],["Não contém as informações/amostras de que eu preciso","missingTheInformationSamplesINeed","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 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."]]
