Arama widget'ıyla arama arayüzü oluşturma

Arama widget'ı, web uygulamaları için özelleştirilebilir bir arama arayüzü sağlar. Widget'ı uygulamak için yalnızca az miktarda HTML ve JavaScript gerekir. Bu widget, özellikler ve sayfalara ayırma gibi yaygın arama özelliklerini etkinleştirir. Arayüzün bazı 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 için birkaç adım gerekir:

1. Bir arama uygulamasını yapılandırma
2. Uygulama için istemci kimliği oluşturma
3. Arama kutusu ve sonuçlar için HTML işaretlemesi ekleme
4. Sayfada widget'ı yükle
5. Widget'ı başlatma

Bir arama uygulamasını yapılandırma

Yönetici Konsolu'nda her arama arayüzü için tanımlanmış bir arama uygulaması olmalıdır. Arama uygulaması, sorgu için veri kaynakları, özellikler ve arama kalitesi ayarları gibi ek bilgiler sağlar.

Arama uygulaması oluşturmak için Özel arama deneyimi oluşturma bölümüne 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.

Proje yapılandırma

Projeyi yapılandırdığınızda:

• Web tarayıcısı istemci türünü seçin
• Uygulamanızın kaynak URI'sini sağlayın.
• Oluşturulan istemci kimliğini not edin. 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 sayfasına bakın.

HTML işaretlemesi ekleyin

Widget'ın çalışması için az miktarda HTML gerekir. Aşağıdakileri sağlamanız gerekir:

• Arama kutusu için input öğesi.
• Öneri pop-up'ının bağlanacağı öğe.
• Arama sonuçlarını içerecek öğe.
• (İsteğe bağlı) Özellik kontrollerini içerecek bir öğe sağlayın.

Aşağıdaki HTML snippet'i, bağlanacak öğelerin id özelliğiyle tanımlandığı bir arama widget'ına ilişkin HTML'yi gösterir:

<div id="search_bar">
  <div id="suggestions_anchor">
    <input type="text" id="search_input" placeholder="Search for...">
  </div>
</div>
<div id="facet_results"></div>
<div id="search_results"></div>

Widget'ı yükleyin

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:

<!-- Google API loader -->
<script src="https://apis.google.com/js/api.js?mods=enable_cloud_search_widget&onload=onLoad" async defer></script>

Komut dosyası etiketinde onload geri çağırması sağlamanız gerekir. Bu iş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.

/**
* Load the cloud search widget & auth libraries. Runs after
* the initial gapi bootstrap library is ready.
*/
function onLoad() {
  gapi.load('client:auth2:cloudsearch-widget', initializeApp)
}

initializeApp() işlevi, tüm modüller yüklendikten sonra çağrılır.

Widget'ı başlatma

Öncelikle, oluşturulan istemci kimliği 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. Daha sonra, 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:

/**
 * Initialize the app after loading the Google API client &
 * Cloud Search widget.
 */
function initializeApp() {
  // Load client ID & search app.
  loadConfiguration().then(function() {
    // Set API version to v1.
    gapi.config.update('cloudsearch.config/apiVersion', 'v1');

    // Build the result container and bind to DOM elements.
    var resultsContainer = new gapi.cloudsearch.widget.resultscontainer.Builder()
      .setSearchApplicationId(searchApplicationName)
      .setSearchResultsContainerElement(document.getElementById('search_results'))
      .setFacetResultsContainerElement(document.getElementById('facet_results'))
      .build();

    // Build the search box and bind to DOM elements.
    var searchBox = new gapi.cloudsearch.widget.searchbox.Builder()
      .setSearchApplicationId(searchApplicationName)
      .setInput(document.getElementById('search_input'))
      .setAnchor(document.getElementById('suggestions_anchor'))
      .setResultsContainer(resultsContainer)
      .build();
  }).then(function() {
    // Init API/oauth client w/client ID.
    return gapi.auth2.init({
        'clientId': clientId,
        'scope': 'https://www.googleapis.com/auth/cloud_search.query'
    });
  });
}

Yukarıdaki örnekte, şu şekilde tanımlanan yapılandırma için iki değişkene başvurulur:

/**
* Client ID from OAuth credentials.
*/
var clientId = "...apps.googleusercontent.com";

/**
* Full resource name of the search application, such as
* "searchapplications/<your-id>".
*/
var searchApplicationName = "searchapplications/...";

Oturum açma deneyimini özelleştirme

Widget varsayılan olarak, sorgu yazmaya başladıklarında kullanıcılardan oturum açmalarını ve uygulamayı yetkilendirmelerini ister. Kullanıcılara daha özel bir oturum açma deneyimi sunmak için Web Siteleri İçin Google ile Oturum Açma'yı kullanabilirsiniz.

Kullanıcıları doğrudan yetkilendirin

Kullanıcının oturum açma durumunu izlemek ve gerektiğinde kullanıcıların oturum açmak veya oturumlarını kapatmak için Google ile Oturum Açma'yı kullanın. Örneğin, aşağıdaki örnekte, oturum açma değişikliklerini izlemek için isSignedIn durumu gözlemlenmekte ve oturum açma işlemini bir düğme tıklamasıyla başlatmak için GoogleAuth.signIn() yöntemi kullanılmaktadır:

// Handle sign-in/sign-out.
let auth = gapi.auth2.getAuthInstance();

// Watch for sign in status changes to update the UI appropriately.
let onSignInChanged = (isSignedIn) => {
  // Update UI to switch between signed in/out states
  // ...
}
auth.isSignedIn.listen(onSignInChanged);
onSignInChanged(auth.isSignedIn.get()); // Trigger with current status.

// Connect sign-in/sign-out buttons.
document.getElementById("sign-in").onclick = function(e) {
  auth.signIn();
};
document.getElementById("sign-out").onclick = function(e) {
  auth.signOut();
};

Daha fazla bilgi için Google ile oturum açma başlıklı makaleyi inceleyin.

Kullanıcıların otomatik olarak oturum açmasını sağlayın

Uygulamayı kuruluşunuzdaki kullanıcılar adına önceden yetkilendirerek oturum açma deneyimini daha da kolaylaştırabilirsiniz. Bu teknik, uygulamayı korumak için Cloud Identity Aware Proxy kullanıldığında da faydalıdır.

Daha fazla bilgi için Google ile Oturum Açma'yı BT Uygulamalarıyla kullanma başlıklı makaleye göz atın.

Arayüzü özelleştirme

Arama arayüzünün görünümünü bir teknik kombinasyonu kullanarak değiştirebilirsiniz:

• Stilleri CSS ile geçersiz kılma
• Öğeleri adaptörle süsleyin
• Adaptörle özel öğeler oluşturma

Stilleri CSS ile geçersiz kılma

Arama widget'ı, stil önerisi ve sonuç öğelerinin yanı sıra sayfalara ayırma denetimleri için kendi CSS'si ile birlikte gelir. Bu öğeleri gerektiği gibi yeniden biçimlendirebilirsiniz.

Arama widget'ı, yükleme sırasında varsayılan stil sayfasını dinamik bir şekilde yükler. Bu durum, uygulama stil sayfaları yüklendikten sonra gerçekleşir ve kuralların önceliğini artırır. Kendi stillerinizin varsayılan stillere göre öncelikli olmasını sağlamak için varsayılan kuralların belirliliğini artırmak amacıyla üst öğe seçicileri kullanın.

Örneğin, aşağıdaki kuralın dokümandaki statik bir link veya style etiketine yüklenmesi durumunda hiçbir etkisi olmaz.

.cloudsearch_suggestion_container {
  font-size: 14px;
}

Bunun yerine, sayfada belirtilen üst kapsayıcının kimliği veya sınıfıyla kuralı niteleyin.

#suggestions_anchor .cloudsearch_suggestion_container {
  font-size: 14px;
}

Destek sınıflarının listesi ve widget tarafından oluşturulan örnek HTML için Desteklenen CSS sınıfları referansına bakın.

Öğeleri adaptörle süsleyin

Bir öğeyi oluşturma işleminden önce süslemek için decorateSuggestionElement veya decorateSearchResultElement. gibi dekorasyon yöntemlerinden birini uygulayan bir adaptör oluşturup yeniden düzenleyin.

Örneğin, aşağıdaki bağdaştırıcılar öneri ve sonuç öğelerine özel bir sınıf ekler.

/**
 * Search box adapter that decorates suggestion elements by
 * adding a custom CSS class.
 */
function SearchBoxAdapter() {}
SearchBoxAdapter.prototype.decorateSuggestionElement = function(element) {
  element.classList.add('my-suggestion');
}

/**
 * Results container adapter that decorates suggestion elements by
 * adding a custom CSS class.
 */
function ResultsContainerAdapter() {}
ResultsContainerAdapter.prototype.decorateSearchResultElement = function(element) {
  element.classList.add('my-result');
}

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:

// Build the result container and bind to DOM elements.
var resultsContainer = new gapi.cloudsearch.widget.resultscontainer.Builder()
  .setAdapter(new ResultsContainerAdapter())
  // ...
  .build();

// Build the search box and bind to DOM elements.
var searchBox = new gapi.cloudsearch.widget.searchbox.Builder()
  .setAdapter(new SearchBoxAdapter())
  // ...
  .build();

Dekoratörler, kapsayıcı öğenin özelliklerini ve alt öğeleri değiştirebilir. Dekorasyon sırasında alt öğeler eklenebilir veya kaldırılabilir. Ancak öğelerde yapısal değişiklikler yapıyorsanız süslemek yerine öğeleri doğrudan oluşturmayı düşünün.

Adaptörle özel öğeler oluşturma

Bir öneri, özellik kapsayıcısı veya arama sonucu için özel öğe oluşturmak isterseniz createSuggestionElement, createFacetResultElement veya createSearchResultElement kodunu tekrar tekrar uygulayan bir bağdaştırıcı oluşturup kaydedin.

Aşağıdaki bağdaştırıcılarda, HTML <template> etiketleri kullanılarak özel öneri ve arama sonuçları öğelerinin oluşturulması gösterilmektedir.

/**
 * Search box adapter that overrides creation of suggestion elements.
 */
function SearchBoxAdapter() {}
SearchBoxAdapter.prototype.createSuggestionElement = function(suggestion) {
  let template = document.querySelector('#suggestion_template');
  let fragment = document.importNode(template.content, true);
  fragment.querySelector('.suggested_query').textContent = suggestion.suggestedQuery;
  return fragment.firstElementChild;
}

/**
 * Results container adapter that overrides creation of result elements.
 */
function ResultsContainerAdapter() {}
ResultsContainerAdapter.prototype.createSearchResultElement = function(result) {
  let template = document.querySelector('#result_template');
  let fragment = document.importNode(template.content, true);
  fragment.querySelector('.title').textContent = result.title;
  fragment.querySelector('.title').href = result.url;
  let snippetText = result.snippet != null ?
    result.snippet.snippet : '';
  fragment.querySelector('.query_snippet').innerHTML = snippetText;
  return fragment.firstElementChild;
}

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:

// Build the result container and bind to DOM elements.
var resultsContainer = new gapi.cloudsearch.widget.resultscontainer.Builder()
  .setAdapter(new ResultsContainerAdapter())
  // ...
  .build();

// Build the search box and bind to DOM elements.
var searchBox = new gapi.cloudsearch.widget.searchbox.Builder()
  .setAdapter(new SearchBoxAdapter())
  // ...
  .build();

createFacetResultElement ile özel özellik öğeleri oluşturmak çeşitli kısıtlamalara tabidir:

• cloudsearch_facet_bucket_clickable CSS sınıfını, kullanıcıların 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ı öğe içinde sarmalamanız gerekir.
• Paketleri yanıtta göründüklerinden farklı bir sırada oluşturamazsınız.

Örneğin, aşağıdaki snippet, onay kutuları yerine bağlantılar kullanarak façetaları oluşturur.

/**
 * Results container adapter that intercepts requests to dynamically
 * change which sources are enabled based on user selection.
 */
function ResultsContainerAdapter() {
  this.selectedSource = null;
}

ResultsContainerAdapter.prototype.createFacetResultElement = function(result) {
  // container for the facet
  var container = document.createElement('div');

  // Add a label describing the facet (operator/property)
  var label = document.createElement('div')
  label.classList.add('facet_label');
  label.textContent = result.operatorName;
  container.appendChild(label);

  // Add each bucket
  for(var i in result.buckets) {
    var bucket = document.createElement('div');
    bucket.classList.add('cloudsearch_facet_bucket_container');

    // Extract & render value from structured value
    // Note: implementation of renderValue() not shown
    var bucketValue = this.renderValue(result.buckets[i].value)
    var link = document.createElement('a');
    link.classList.add('cloudsearch_facet_bucket_clickable');
    link.textContent = bucketValue;
    bucket.appendChild(link);
    container.appendChild(bucket);
  }
  return container;
}

// Renders a value for user display
ResultsContainerAdapter.prototype.renderValue = function(value) {
  // ...
}

Arama davranışını özelleştirin

Arama uygulaması ayarları, bir arama arayüzü için varsayılan yapılandırmayı temsil eder ve statiktir. Kullanıcıların veri kaynaklarını değiştirmelerine izin vermek gibi dinamik filtreler veya özellikler uygulamak için arama isteğine bir bağdaştırıcı ile müdahale ederek 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ıtlama isteklerine müdahale eder:

/**
 * Results container adapter that intercepts requests to dynamically
 * change which sources are enabled based on user selection.
 */
function ResultsContainerAdapter() {
  this.selectedSource = null;
}
ResultsContainerAdapter.prototype.interceptSearchRequest = function(request) {
  if (!this.selectedSource || this.selectedSource == 'ALL') {
    // Everything selected, fall back to sources defined in the search
    // application.
    request.dataSourceRestrictions = null;
  } else {
    // Restrict to a single selected source.
    request.dataSourceRestrictions = [
      {
        source: {
          predefinedSource: this.selectedSource
        }
      }
    ];
  }
  return request;
}

Widget'ı başlatırken bağdaştırıcıyı kaydetmek için ResultsContainer oluştururken setAdapter() yöntemini kullanın

var resultsContainerAdapter = new ResultsContainerAdapter();
// Build the result container and bind to DOM elements.
var resultsContainer = new gapi.cloudsearch.widget.resultscontainer.Builder()
  .setAdapter(resultsContainerAdapter)
  // ...
  .build();

Aşağıdaki HTML, kaynaklara göre filtrelemeye yönelik bir seçim kutusu görüntülemek için kullanılır:

<div>
  <span>Source</span>
  <select id="sources">
    <option value="ALL">All</option>
    <option value="GOOGLE_GMAIL">Gmail</option>
    <option value="GOOGLE_DRIVE">Drive</option>
    <option value="GOOGLE_SITES">Sites</option>
    <option value="GOOGLE_GROUPS">Groups</option>
    <option value="GOOGLE_CALENDAR">Calendar</option>
    <option value="GOOGLE_KEEP">Keep</option>
  </select>
</div>

Aşağıdaki kod değişikliği izler, seçimi ayarlar ve gerekirse sorguyu yeniden yürütür.

// Handle source selection
document.getElementById('sources').onchange = (e) => {
  resultsContainerAdapter.selectedSource = e.target.value;
  let request = resultsContainer.getCurrentRequest();
  if (request.query) {
    // Re-execute if there's a valid query. The source selection
    // will be applied in the interceptor.
    resultsContainer.resetState();
    resultsContainer.executeRequest(request);
  }
}

Ayrıca bağdaştırıcıda interceptSearchResponse uygulayarak arama yanıtına müdahale edebilirsiniz.

API sürümünü sabitleyin

Widget varsayılan olarak 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.

gapi.config.update('cloudsearch.config/apiVersion', 'v1');

Ayarlanmadan bırakılırsa veya geçersiz bir değere ayarlanırsa API sürümü varsayılan olarak 1.0 olur.

Widget sürümünü sabitleme

Arama arayüzlerinde beklenmedik değişiklikler önlemek için cloudsearch.config/clientVersion yapılandırma parametresini gösterildiği gibi ayarlayın:

gapi.config.update('cloudsearch.config/clientVersion', 1.1);

Ayarlanmadan bırakılırsa 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ğlayın

Arama sonuçları son derece hassas bilgiler içeriyor. Web uygulamalarını güvenli hale getirmek için özellikle tıklama korsanlığı saldırılarına karşı en iyi uygulamaları takip edin.

Daha fazla bilgi için OWASP Rehber Projesi'ne bakın.

Hata ayıklamayı etkinleştir

Arama widget'ında hata ayıklamayı açmak için interceptSearchRequest bağlantısını kullanın. Örneğin:

  if (!request.requestOptions) {
  // Make sure requestOptions is populated
  request.requestOptions = {};
  }
  // Enable debugging
  request.requestOptions.debugOptions = {enableDebugging: true}

  return request;