Class FacetRefinement digunakan untuk mempersempit hasil penelusuran berdasarkan nilai faset.
Cara yang direkomendasikan untuk menggunakan penajaman faset adalah dengan menggunakan string tokennya. Setiap FacetResult akan memiliki token yang dapat diterima, bukan class ini. Untuk menyediakan FacetRefinement manual, instance class ini dapat diteruskan ke SearchOptions.
FacetRefinement ditentukan dalam modul google.appengine.api.search.
Konstruktor
Konstruktor untuk class FacetRefinement ditentukan sebagai berikut:
class FacetRefinement(name, value=None, facet_range=None)
Buat instance class
FacetRefinement.CATATAN: Nilai atau facet_range harus ditetapkan tetapi tidak keduanya.
Argumen
- name
Menetapkan properti nama
- value
Menetapkan properti nilai
- facet_range
Menetapkan properti facet_range
Nilai hasil
Instance baru dari class
FacetRefinement.
Pengecualian
- TypeError
Jika salah satu parameter memiliki jenis yang tidak valid, atau atribut yang tidak diketahui diteruskan.
- ValueError
Jika salah satu parameter memiliki nilai yang tidak valid.
Properti
Instance class FacetRefinement memiliki properti berikut:
- name
nama dari penajaman faset.
- value
nilai string dari penajaman faset.
- range
rentang numerik dari penajaman faset.
Metode Instance
Instance class FacetRefinement memiliki metode berikut:
- ToTokenString()
Mengonversi penajaman ini menjadi string token yang aman digunakan dalam HTML. Format string ini dapat berubah.
-
Nilai hasil
String token yang aman digunakan dalam HTML untuk penajaman faset ini.
- FromTokenString()
Metode statis ini mengonversi string token menjadi objek FacetRefinement. Jangan menyimpan string token di antara versi API yang berbeda karena kunci mungkin tidak kompatibel.
-
Argumen
- token_string
String token yang dibuat oleh metode ToTokenString atau yang ditampilkan oleh hasil penelusuran.
Nilai hasil
Objek FacetRefinement.
Pengecualian
- ValueError
Jika token_string tidak valid.