FacetRefinement クラス

FacetRefinement クラスは、ファセット値に基づいて検索結果を絞り込むために使用します。

ファセット絞り込みの使用方法として推奨されるのは、トークン文字列を使用する方法です。各 FacetResult は、このクラスではなく、許容可能なトークンを持ちます。手動の FacetRefinement を提供するために、このクラスのインスタンスを SearchOptions に渡すことができます。

FacetRefinementgoogle.appengine.api.search モジュールで定義されています。

コンストラクタ

FacetRefinement クラスのコンストラクタは、次のように定義されます:

class FacetRefinement(name, value=None, facet_range=None)

FacetRefinement クラスのインスタンスを生成します。

注: 値または facet_range のどちらかを指定します。両方は指定しないでください。

引数

name

name プロパティを設定します。

value

value プロパティを設定します。

facet_range

facet_range プロパティを設定します。

結果値

FacetRefinement クラスの新しいインスタンス。

例外

TypeError

いずれかのパラメータが無効なタイプであるか、不明な属性が渡された場合。

ValueError

いずれかのパラメータに無効な値がある場合

プロパティ

FacetRefinement クラスのインスタンスには次のプロパティがあります:

name

ファセット絞り込みの名前。

value

ファセット絞り込みの文字列値。

range

ファセット絞り込みの数値範囲。

インスタンス メソッド

FacetRefinement クラスのインスタンスには次のメソッドがあります:

ToTokenString()

この絞り込みを、HTML でも安全に使用できるトークン文字列に変換します。この文字列の形式は変更されることがあります。

結果値

HTML でも安全に使用できる、このファセット絞り込みのトークン文字列。

FromTokenString()

この静的メソッドは、トークン文字列を FacetRefinement オブジェクトに変換します。キーに互換性がない場合があるため、異なるバージョンの API の間ではトークン文字列を保存しないでください。

引数

token_string

ToTokenString メソッドによって作成される、または返されるトークン文字列。

結果値

FacetRefinement オブジェクト。

例外

ValueError

token_string が無効である場合。

このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...

Python 2 の App Engine スタンダード環境