Arama widget'ı, web uygulamaları için özelleştirilebilir arama arayüzü sunar. Widget, özellikler ve sayfalandırma gibi yaygın arama özelliklerini uygulamak ve etkinleştirmek için sadece az miktarda HTML ve JavaScript gerektirir. Ayrıca arayüzün bölümlerini CSS ve JavaScript ile de özelleştirebilirsiniz.
Widget'ın sunduğundan daha fazla esnekliğe ihtiyacınız varsa Query API'yi kullanabilirsiniz. Query API ile arama arayüzü oluşturma hakkında bilgi için Query API ile arama arayüzü oluşturma bölümüne bakın.
Arama arayüzü oluşturma
Arama arayüzünü oluşturmak birkaç adım gerektirir:
- Bir arama uygulamasını yapılandırın
- Uygulama için istemci kimliği oluşturma
- Arama kutusu ve sonuçlar için HTML işaretlemesi ekleme
- Widget'ı sayfaya yükleyin
- Widget'ı başlatma
Bir arama uygulamasını yapılandırın
Her arama arayüzünün Yönetici Konsolu'nda tanımlanmış bir arama uygulaması olması gerekir. Arama uygulaması, sorgu için veri kaynakları, özellikler ve arama kalitesi ayarları gibi ek bilgiler sağlar.
Bir arama uygulaması oluşturmak için Özel arama deneyimi oluşturma başlıklı makaleye bakın.
Uygulama için istemci kimliği oluşturma
Google Cloud Search API'ye erişimi yapılandırma bölümündeki adımlara ek olarak, web uygulaması için bir istemci kimliği de oluşturmanız gerekir.
Projeyi yapılandırdığınızda:
- Web tarayıcısı istemci türünü seçin.
- Uygulamanızın kaynak URI'sını sağlayın.
- Oluşturulan istemci kimliğinin notu. Sonraki adımları tamamlamak için istemci kimliğine ihtiyacınız olacak. Widget için istemci gizli anahtarı gerekli değildir.
Daha fazla bilgi için İstemci Tarafı Web Uygulaması için OAuth 2.0 bölümüne bakın.
HTML işaretlemesi ekleme
Widget'ın çalışması için az miktarda HTML gerekir. Aşağıdakileri sağlamanız gerekir:
- Arama kutusu için bir
input
öğesi. - Öneri pop-up'ının sabitleneceği bir öğe.
- Arama sonuçlarını içeren bir öğe.
- (İsteğe bağlı) Özellik denetimlerini içerecek bir öğe sağlayın.
Aşağıdaki HTML snippet'i bir arama widget'ının HTML'sini gösterir. Bu widget, bağlanacak öğeler id
özelliğiyle tanımlanır:
Widget'ı yükleme
Widget, bir yükleyici komut dosyası aracılığıyla dinamik olarak yüklenir. Yükleyiciyi dahil etmek için <script>
etiketini aşağıda gösterildiği gibi kullanın:
Komut dosyası etiketinde onload
geri çağırması sağlamanız gerekir. İşlev, yükleyici hazır
olduğunda çağrılır. Yükleyici hazır olduğunda API istemcisi, Google ile Oturum Açma ve Cloud Search modüllerini yüklemek için gapi.load()
yöntemini çağırarak widget'ı yüklemeye devam edin.
Tüm modüller yüklendikten sonra initializeApp()
işlevi çağrılır.
Widget'ı başlatma
Öncelikle, oluşturulan istemci kimliğiniz ve https://www.googleapis.com/auth/cloud_search.query
kapsamıyla gapi.client.init()
veya gapi.auth2.init()
yöntemini çağırarak istemci kitaplığını başlatın. Ardından, widget'ı yapılandırmak ve HTML öğelerinize bağlamak için gapi.cloudsearch.widget.resultscontainer.Builder
ve gapi.cloudsearch.widget.searchbox.Builder
sınıflarını kullanın.
Aşağıdaki örnekte widget'ın nasıl başlatılacağı gösterilmektedir:
Yukarıdaki örnekte, yapılandırma için şu şekilde tanımlanan iki değişkene referansta bulunulmuştur:
Oturum açma deneyimini özelleştirme
Widget, varsayılan olarak kullanıcılardan oturum açmalarını ve sorgu yazmaya başladıklarında uygulamayı yetkilendirmelerini ister. Kullanıcılara daha özel bir oturum açma deneyimi sunmak için Web Siteleri için Google ile Oturum Açma özelliğini kullanabilirsiniz.
Kullanıcıları doğrudan yetkilendirin
Kullanıcının oturum açma durumunu izlemek ve gerektiğinde oturum açmak veya oturumu kapatmak için Google ile oturum açma özelliğini kullanın. Örneğin, aşağıdaki örnekte oturum açma değişikliklerini izlemek için isSignedIn
durumu görülmektedir ve bir düğme tıklamasından oturum açma işlemi başlatmak için GoogleAuth.signIn()
yöntemi kullanılmaktadır:
Ayrıntılı bilgi için Google ile oturum açma başlıklı makaleyi inceleyin.
Kullanıcıların otomatik olarak oturum açmasını sağlama
Uygulamayı kuruluşunuzdaki kullanıcılar adına önceden yetkilendirerek oturum açma deneyimini daha da basitleştirebilirsiniz. Bu teknik, uygulamayı korumak için Cloud Identity Aware Proxy kullanılıyorsa de yararlıdır.
Daha fazla bilgi için Google ile Oturum Açma özelliğini BT Uygulamalarıyla Kullanma başlıklı makaleye göz atın.
Arayüzü özelleştirme
Çeşitli teknikler kullanarak arama arayüzünün görünümünü değiştirebilirsiniz:
- Stilleri CSS ile geçersiz kılma
- Öğeleri bir adaptörle süsleyin
- Bağdaştırıcı kullanarak özel öğeler oluşturma
Stilleri CSS ile geçersiz kılma
Arama widget'ında, öneri ve sonuç öğelerinin stilini belirlemek için kendi CSS'sinin yanı sıra sayfalara ayırma denetimleri bulunur. Bu öğeleri gerektiği gibi yeniden biçimlendirebilirsiniz.
Yükleme sırasında, arama widget'ı varsayılan stil sayfasını dinamik olarak yükler. Bu durum, uygulama stil sayfaları yüklendikten sonra ortaya çıkar ve kuralların önceliği artar. Kendi stillerinizin varsayılan stillere göre öncelikli olmasını sağlamak için varsayılan kuralların belirginliğini artırmak amacıyla üst öğe seçicileri kullanın.
Örneğin, aşağıdaki kuralın dokümandaki statik link
veya style
etiketine yüklenmesi durumunda herhangi bir etkisi olmaz.
.cloudsearch_suggestion_container {
font-size: 14px;
}
Bunun yerine, kuralı sayfada belirtilen üst kapsayıcının kimliği veya sınıfıyla niteleyin.
#suggestions_anchor .cloudsearch_suggestion_container {
font-size: 14px;
}
Widget tarafından oluşturulan destek sınıflarının ve örnek HTML'nin listesi için Desteklenen CSS sınıfları referansına bakın.
Öğeleri bir adaptörle süsleyin
Bir öğeyi oluşturmadan önce süslemek için decorateSuggestionElement
veya decorateSearchResultElement.
gibi dekorasyon yöntemlerinden birini uygulayan bir bağdaştırıcı oluşturun ve yeniden kullanın.
Örneğin, aşağıdaki bağdaştırıcılar öneri ve sonuç öğelerine bir özel sınıf ekler.
Widget'ı başlatırken bağdaştırıcıyı kaydetmek için ilgili Builder
sınıfının setAdapter()
yöntemini kullanın:
Süslemeler, kapsayıcı öğenin özelliklerini ve alt öğeleri değiştirebilir. Süsleme sırasında alt öğeler eklenebilir veya kaldırılabilir. Ancak öğelerde yapısal değişiklikler yapıyorsanız öğeleri süslemek yerine doğrudan oluşturmayı düşünün.
Bağdaştırıcı kullanarak özel öğeler oluşturma
Bir öneri, façeta kapsayıcısı veya arama sonucu için özel öğe oluşturmak istiyorsanız createSuggestionElement
, createFacetResultElement
veya createSearchResultElement
uygulamalarını arka arkaya uygulayan bir bağdaştırıcı oluşturup kaydedin.
Aşağıdaki bağdaştırıcılar, HTML <template>
etiketleri kullanılarak özel öneri ve arama sonucu öğelerinin oluşturulmasını göstermektedir.
Widget'ı başlatırken bağdaştırıcıyı kaydetmek için ilgili Builder
sınıfının setAdapter()
yöntemini kullanın:
createFacetResultElement
ile özel façeta öğeleri oluşturmak çeşitli kısıtlamalara tabidir:
cloudsearch_facet_bucket_clickable
CSS sınıfını, kullanıcıların bir paketi açıp kapatmak için tıkladığı öğeye eklemeniz gerekir.- Her paketi
cloudsearch_facet_bucket_container
CSS sınıfıyla bir kapsayıcı öğenin içine sarmalamanız gerekir. - Paketleri yanıtta göründüklerinden farklı bir sırada görüntüleyemezsiniz.
Örneğin, aşağıdaki snippet, özellikleri onay kutuları yerine bağlantılar kullanarak oluşturur.
Arama davranışını özelleştirin
Arama uygulaması ayarları, bir arama arayüzünün varsayılan yapılandırmasını temsil eder ve statiktir. Kullanıcıların veri kaynaklarını açıp kapatmalarına izin vermek gibi dinamik filtreler veya özellikler uygulamak için arama isteğini bir bağdaştırıcıyla engelleyerek arama uygulaması ayarlarını geçersiz kılabilirsiniz.
Yürütmeden önce search API'ye yapılan istekleri değiştirmek için interceptSearchRequest
yöntemiyle bir bağdaştırıcı uygulayın.
Örneğin, aşağıdaki bağdaştırıcı, sorguları kullanıcı tarafından seçilen bir kaynakla kısıtlamak için yapılan isteklere müdahale eder:
Widget'ı başlatırken bağdaştırıcıyı kaydetmek için ResultsContainer
aracını oluştururken setAdapter()
yöntemini kullanın.
Aşağıdaki HTML, kaynaklara göre filtreleme yapmak için bir seçim kutusu görüntülemek için kullanılır:
Aşağıdaki kod değişikliği dinler, seçimi ayarlar ve gerekirse sorguyu yeniden yürütür.
Ayrıca bağdaştırıcıya interceptSearchResponse
uygulayarak arama yanıtına müdahale edebilirsiniz.
API sürümünü sabitleme
Varsayılan olarak widget, API'nin en son kararlı sürümünü kullanır. Belirli bir sürümü kilitlemek için widget'ı başlatmadan önce cloudsearch.config/apiVersion
yapılandırma parametresini tercih edilen sürüme ayarlayın.
API sürümü ayarlanmazsa veya geçersiz bir değere ayarlanırsa varsayılan olarak 1.0 olur.
Widget sürümünü sabitleme
Arama arayüzlerinde beklenmeyen değişiklikler olmasını önlemek için cloudsearch.config/clientVersion
yapılandırma parametresini aşağıda gösterildiği gibi ayarlayın:
gapi.config.update('cloudsearch.config/clientVersion', 1.1);
Ayarlanmazsa veya geçersiz bir değere ayarlanırsa widget sürümü varsayılan olarak 1.0 olur.
Arama arayüzünün güvenliğini sağlama
Arama sonuçları son derece hassas bilgiler içeriyor. Özellikle tıklama korsanlığı saldırılarına karşı web uygulamalarının güvenliğini sağlamaya yönelik en iyi uygulamaları takip edin.
Daha fazla bilgi için OWASP Kılavuzu Projesi'ne bakın
Hata ayıklamayı etkinleştir
Arama widget'ında hata ayıklamayı etkinleştirmek için interceptSearchRequest
aracını kullanın. Örneğin:
if (!request.requestOptions) {
// Make sure requestOptions is populated
request.requestOptions = {};
}
// Enable debugging
request.requestOptions.debugOptions = {enableDebugging: true}
return request;