অনুসন্ধান উইজেট দিয়ে একটি অনুসন্ধান ইন্টারফেস তৈরি করুন

The search widget provides a customizable search interface for web applications. It requires minimal HTML and JavaScript to implement and supports common features like facets and pagination. You can also customize the interface with CSS and JavaScript.

যদি আপনার আরও নমনীয়তার প্রয়োজন হয়, তাহলে কোয়েরি এপিআই (Query API) ব্যবহার করুন। কোয়েরি এপিআই (Query API) ব্যবহার করে একটি সার্চ ইন্টারফেস তৈরি করা দেখুন।

একটি অনুসন্ধান ইন্টারফেস তৈরি করুন

সার্চ ইন্টারফেস তৈরি করার জন্য এই ধাপগুলো অনুসরণ করতে হবে:

  1. একটি সার্চ অ্যাপ্লিকেশন কনফিগার করুন।
  2. অ্যাপ্লিকেশনটির জন্য একটি ক্লায়েন্ট আইডি তৈরি করুন।
  3. সার্চ বক্স এবং ফলাফলের জন্য HTML মার্কআপ যোগ করুন।
  4. পৃষ্ঠায় উইজেটটি লোড করুন।
  5. উইজেটটি প্রারম্ভিক করুন।

একটি অনুসন্ধান অ্যাপ্লিকেশন কনফিগার করুন

প্রতিটি সার্চ ইন্টারফেসের জন্য অ্যাডমিন কনসোলে একটি সার্চ অ্যাপ্লিকেশন সংজ্ঞায়িত করা প্রয়োজন। অ্যাপ্লিকেশনটি কোয়েরি সেটিংস প্রদান করে, যেমন ডেটা সোর্স, ফ্যাসেট এবং সার্চ কোয়ালিটি প্যারামিটার।

একটি সার্চ অ্যাপ্লিকেশন তৈরি করতে, ‘একটি কাস্টম সার্চ অভিজ্ঞতা তৈরি করুন’ দেখুন।

অ্যাপ্লিকেশনটির জন্য একটি ক্লায়েন্ট আইডি তৈরি করুন।

ক্লাউড সার্চ এপিআই-তে অ্যাক্সেস কনফিগার করার ধাপগুলোর পাশাপাশি, আপনার ওয়েব অ্যাপ্লিকেশনের জন্য একটি ক্লায়েন্ট আইডি তৈরি করুন।

একটি প্রকল্প কনফিগার করুন

প্রকল্পটি কনফিগার করার সময়:

  • ওয়েব ব্রাউজার ক্লায়েন্টের ধরন নির্বাচন করুন।
  • আপনার অ্যাপের অরিজিন ইউআরআই প্রদান করুন।
  • ক্লায়েন্ট আইডিটি নোট করুন। উইজেটটির জন্য কোনো ক্লায়েন্ট সিক্রেটের প্রয়োজন নেই।

আরও তথ্যের জন্য, ক্লায়েন্ট-সাইড ওয়েব অ্যাপ্লিকেশনের জন্য OAuth 2.0 দেখুন।

এইচটিএমএল মার্কআপ যোগ করুন

উইজেটটির জন্য এই HTML উপাদানগুলো প্রয়োজন:

  • সার্চ বক্সের জন্য একটি input এলিমেন্ট।
  • সাজেশন ডায়ালগটিকে স্থির রাখার জন্য একটি এলিমেন্ট।
  • অনুসন্ধানের ফলাফলের জন্য একটি উপাদান।
  • (ঐচ্ছিক) ফেসেট নিয়ন্ত্রণের জন্য একটি উপাদান।

এই কোড স্নিপেটটি তাদের id অ্যাট্রিবিউট দ্বারা চিহ্নিত এলিমেন্টগুলো দেখায়:

serving/widget/public/with_css/index.html
<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>

উইজেটটি লোড করুন

<script> ট্যাগ ব্যবহার করে লোডারটি অন্তর্ভুক্ত করুন:

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

একটি onload কলব্যাক প্রদান করুন। লোডার প্রস্তুত হলে, এপিআই ক্লায়েন্ট, গুগল সাইন-ইন এবং ক্লাউড সার্চ মডিউলগুলো লোড করার জন্য gapi.load() কল করুন।

serving/widget/public/with_css/app.js
/**
* 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)
}

উইজেটটি প্রারম্ভিক করুন

আপনার ক্লায়েন্ট আইডি এবং https://www.googleapis.com/auth/cloud_search.query স্কোপ ব্যবহার করে gapi.client.init() অথবা gapi.auth2.init() এর মাধ্যমে ক্লায়েন্ট লাইব্রেরিটি ইনিশিয়ালাইজ করুন। উইজেটটি কনফিগার এবং বাইন্ড করতে বিল্ডার ক্লাসগুলো ব্যবহার করুন।

প্রারম্ভিকীকরণের উদাহরণ:

serving/widget/public/with_css/app.js
/**
 * 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'
    });
  });
}

কনফিগারেশন ভেরিয়েবল:

serving/widget/public/with_css/app.js
/**
* 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/...";

সাইন-ইন অভিজ্ঞতা কাস্টমাইজ করুন

ব্যবহারকারীরা টাইপ করা শুরু করলে উইজেটটি তাদের সাইন ইন করতে বলে। আপনার প্রয়োজন অনুযায়ী অভিজ্ঞতা পেতে আপনি ওয়েবসাইটের জন্য গুগল সাইন-ইন ব্যবহার করতে পারেন।

ব্যবহারকারীদের সরাসরি অনুমোদন দিন

সাইন-ইন অবস্থা নিরীক্ষণ ও পরিচালনা করতে 'সাইন ইন উইথ গুগল' ব্যবহার করুন। এই উদাহরণে একটি বাটন ক্লিকে GoogleAuth.signIn() ব্যবহার করা হয়েছে:

serving/widget/public/with_signin/app.js
// 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();
};

স্বয়ংক্রিয়ভাবে সাইন ইন করা ব্যবহারকারীরা

সাইন-ইন প্রক্রিয়া সহজ করার জন্য আপনার প্রতিষ্ঠানের ব্যবহারকারীদের জন্য অ্যাপ্লিকেশনটি আগে থেকে অনুমোদন করুন। এটি ক্লাউড আইডেন্টিটি অ্যাওয়্যার প্রক্সি-এর সাথেও কার্যকর। আইটি অ্যাপের সাথে গুগল সাইন-ইন ব্যবহার দেখুন।

ইন্টারফেসটি কাস্টমাইজ করুন

আপনি নিম্নলিখিত উপায়ে উইজেটটির চেহারা পরিবর্তন করতে পারেন:

  • CSS দিয়ে স্টাইল ওভাররাইড করা।
  • অ্যাডাপ্টারের সাহায্যে উপাদানসমূহ সাজানো।
  • অ্যাডাপ্টার ব্যবহার করে কাস্টম এলিমেন্ট তৈরি করা।

CSS দিয়ে স্টাইলগুলো ওভাররাইড করুন

উইজেটটির নিজস্ব CSS রয়েছে। এটিকে ওভাররাইড করতে, স্পেসিফিসিটি বাড়ানোর জন্য অ্যানসেস্টর সিলেক্টর ব্যবহার করুন:

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

সমর্থিত CSS ক্লাসগুলোর রেফারেন্স দেখুন।

অ্যাডাপ্টার দিয়ে উপাদানগুলো সাজান।

রেন্ডার করার আগে এলিমেন্টগুলো পরিবর্তন করার জন্য একটি অ্যাডাপ্টার তৈরি ও রেজিস্টার করুন। এই উদাহরণটি একটি কাস্টম CSS ক্লাস যোগ করে:

serving/widget/public/with_decorated_element/app.js
/**
 * 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');
}

প্রারম্ভিকীকরণের সময় অ্যাডাপ্টারটি নিবন্ধন করুন:

serving/widget/public/with_decorated_element/app.js
// 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();

একটি অ্যাডাপ্টার দিয়ে কাস্টম উপাদান তৈরি করুন

কাস্টম UI কম্পোনেন্ট তৈরি করতে createSuggestionElement , createFacetResultElement , অথবা createSearchResultElement ইমপ্লিমেন্ট করুন। এই উদাহরণটিতে HTML <template> ট্যাগ ব্যবহার করা হয়েছে:

serving/widget/public/with_custom_element/app.js
/**
 * 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;
}

অ্যাডাপ্টারটি নিবন্ধন করুন:

serving/widget/public/with_custom_element/app.js
// 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();

কাস্টম ফেসেট এলিমেন্টগুলোকে অবশ্যই এই নিয়মগুলো অনুসরণ করতে হবে:

  • ক্লিকযোগ্য এলিমেন্টগুলোর সাথে cloudsearch_facet_bucket_clickable সংযুক্ত করুন।
  • প্রতিটি বাকেটকে একটি cloudsearch_facet_bucket_container এর মধ্যে রাখুন।
  • প্রতিক্রিয়া থেকে বাকেট ক্রম বজায় রাখুন।

উদাহরণস্বরূপ, নিম্নলিখিত কোড স্নিপেটটি চেক বক্সের পরিবর্তে লিঙ্ক ব্যবহার করে ফেসেটগুলো রেন্ডার করে।

serving/widget/public/with_custom_facet/app.js
/**
 * 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) {
  // ...
}

অনুসন্ধানের আচরণ কাস্টমাইজ করুন

একটি অ্যাডাপ্টারের সাহায্যে অনুরোধগুলি ইন্টারসেপ্ট করে সার্চ অ্যাপ্লিকেশনের সেটিংস ওভাররাইড করুন। অনুরোধগুলি কার্যকর করার আগে পরিবর্তন করতে interceptSearchRequest প্রয়োগ করুন। এই উদাহরণটি কোয়েরিগুলিকে একটি নির্বাচিত উৎসে সীমাবদ্ধ করে:

serving/widget/public/with_request_interceptor/app.js
/**
 * 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;
}

অ্যাডাপ্টারটি নিবন্ধন করুন:

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

উৎস অনুযায়ী ফিল্টার করার জন্য একটি সিলেক্ট বক্স প্রদর্শন করতে নিম্নলিখিত HTML ব্যবহার করা হয়:

serving/widget/public/with_request_interceptor/index.html
<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>

নিম্নলিখিত কোডটি পরিবর্তনটি পর্যবেক্ষণ করে, নির্বাচনটি সেট করে এবং প্রয়োজনে কোয়েরিটি পুনরায় কার্যকর করে।

serving/widget/public/with_request_interceptor/app.js
// 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);
  }
}

আপনি অ্যাডাপ্টারে interceptSearchResponse প্রয়োগ করে সার্চ রেসপন্সটি ইন্টারসেপ্ট করতে পারেন।

পিন সংস্করণ

  • এপিআই সংস্করণ : শুরু করার আগে cloudsearch.config/apiVersion সেট করুন।
  • উইজেট সংস্করণ : gapi.config.update('cloudsearch.config/clientVersion', 1.1) ব্যবহার করুন।

সেট না করা থাকলে উভয়েরই ডিফল্ট মান ১.০ হয়।

উদাহরণস্বরূপ, উইজেটটিকে সংস্করণ ১.১-এ পিন করতে:

serving/widget/public/basic/app.js
gapi.config.update('cloudsearch.config/apiVersion', 'v1');

অনুসন্ধান ইন্টারফেস সুরক্ষিত করুন

ওয়েব অ্যাপ্লিকেশনের জন্য নিরাপত্তার সর্বোত্তম অনুশীলনগুলো অনুসরণ করুন, বিশেষ করে ক্লিকজ্যাকিং প্রতিরোধ করতে।

ডিবাগিং সক্ষম করুন

ডিবাগিং সক্ষম করতে interceptSearchRequest ব্যবহার করুন:

if (!request.requestOptions) {
  request.requestOptions = {};
}
request.requestOptions.debugOptions = {enableDebugging: true};
return request;