FacetRefinement 類別的用途為根據 Facet 值縮小搜尋結果。
修正 facet 的推薦方法為使用其憑證字串。每個 FacetResult 皆有一個可接受的憑證，而非類別。若要提供手動的 FacetRefinement，可以將此類別的執行個體傳送至 SearchOptions。
FacetRefinement 應在 google.appengine.api.search 模組中定義。
建構函式
FacetRefinement 類別的建構函式定義如下：
類別 FacetRefinement(name, value=None, facet_range=None)
建構
FacetRefinement類別的例項。附註：value 或 facet_range 皆須設置，但不能兩者同時設置。
引數
- name
設置 name 的屬性。
- value
設置 value 的屬性
- facet_range
設置 facet_range 的屬性
結果值
FacetRefinement類別的新例項。
例外狀況
- TypeError
若任何參數包含無效的類型或傳送了未知的屬性，則傳回此例外。
- ValueError
若任何參數包含無效的值，則傳回此例外。
屬性
FacetRefinement 類別的執行個體具有下列屬性：
- name
facet 修正的名稱。
- value
facet 修正的字串值。
- range
facet 修正的數值範圍。
實例方法
FacetRefinement 類別的例項有以下方法：
- ToTokenString()
將此修轉換為用於 HTML 的憑證字串安全。這些次串的格式可能會改變。
-
結果值
憑證字串安全用於在 HTML 中修改 facet。
- FromTokenString()
此靜態方法將憑證字串轉換為 FacetRefinement 物件。請不要在不同版本的 API 之間儲存憑證字串，因為鍵可能不相容。
-
引數
- token_string
由 ToTokenString 方法建立或由搜尋結果傳回的憑證字串。
結果值
FacetRefinement 物件。
例外狀況
- ValueError
若 token_string 無效。