検索要素コールバックのその他の例

このページでは、検索要素のコールバックの使用例をいくつか紹介します。これらは、カスタム検索要素 API ドキュメントのコールバック セクションにある例を補完するものです。

検索開始コールバックの例

検索開始コールバックは、検索に使用される前にクエリを変更できます。プログラム可能検索エンジンは、クエリに事前に決定された用語を含めるように構成できますが、このコールバックは、コールバック関数で使用可能な情報に基づいてクエリを変更できます。

次の search starting コールバックは、各クエリに現在の曜日を追加します。

検索開始コールバックの例
<script async
  src="https://cse.google.com/cse.js?cx=000888210889775888983:g9ckaktfipe"></script>
 
const mySearchStartingCallback = (gname, query) => {
  const dayOfWeek = new Date().getDay();
  console.log(dayOfWeek);
  var days = {
        "0": "Sunday",
        "1": "Monday",
        "2": "Tuesday",
        "3": "Wednesday",
        "4": "Thursday",
        "5": "Friday",
        "6": "Saturday"
    };

    return query + ' ' + days[dayOfWeek];
};
// Install the callback.
window.__gcse || (window.__gcse = {});
  window.__gcse.searchCallbacks = {
    image: {
      starting: mySearchStartingCallback,
    },
    web: {
      starting: mySearchStartingCallback,
    },
};

HTML に次の要素を含めます。

<div class="gcse-searchbox"></div>
<div class="gcse-searchresults"></div>
「最近の検索」リンクを表示する

この例では、検索開始コールバックを使用して、最近の検索機能を実装する方法を示します。

この機能は、検索がトリガーされたときにユーザークエリをキャプチャし、ブラウザにローカルに保存します。これらのクエリはクリック可能なアイテムとして表示されるため、ユーザーは以前の検索をすばやく繰り返すことができ、ユーザビリティが向上し、入力の繰り返しが減ります。

<script async
  src="https://cse.google.com/cse.js?cx=000888210889775888983:g9ckaktfipe"></script>

ユーザーの同意確認によって保護された localStorage に最近の検索を保存するヘルパー関数を定義します。

      // For this demo, consent is assumed to be granted.
        // In production, integrate this with your site's Consent Management Platform (CMP).
        window.__hasStorageConsent = true;

        function hasStorageConsent() {
          return window.__hasStorageConsent === true;
        }

        function saveRecentSearch(query) {
          if (!query || !hasStorageConsent()) return;

          let searches = [];
          try {
            searches = JSON.parse(localStorage.getItem("recentSearches")) || [];
          } catch (e) {
            console.warn("Invalid localStorage data, resetting:", e);
            // searches remains [] to overwrite the corrupted data
          }

          searches = searches.filter(item => item !== query);
          searches.unshift(query);
          searches = searches.slice(0, 5);

          try {
            localStorage.setItem("recentSearches", JSON.stringify(searches));
          } catch (e) {
            console.warn("Unable to access localStorage:", e);
          }
        }

検索開始コールバックを登録します。コールバックは、cse.js を読み込む前にグローバル __gcse オブジェクトに登録する必要があります。

      // Install the callback.
        window.__gcse || (window.__gcse = {});
        window.__gcse.searchCallbacks = {
          web: {
            starting: function (gname, query) {
              saveRecentSearch(query);
              renderRecentSearches();
              return query; // continue normal search
            },
          },
        };

最近の検索をクリック可能な項目としてレンダリングする関数を定義し、ページの読み込み時に初期化します。

      function renderRecentSearches() {
        const container = document.getElementById("recent-searches");
        if (!container) return;
        if (!hasStorageConsent()) {
          container.innerHTML = "";
          try {
            localStorage.removeItem("recentSearches");
          } catch(e) {}
          return;
        }
        let searches = [];
        try {
          searches = JSON.parse(localStorage.getItem("recentSearches")) || [];
        } catch (e) {
          console.warn("Unable to access localStorage:", e);
        }
        container.innerHTML = "";
        searches.forEach(q => {
          const item = document.createElement("button");
          item.type = "button";
          item.textContent = q;
          item.onclick = () => {
            const input = document.querySelector("input.gsc-input");
            const button = document.querySelector("button.gsc-search-button");
            if (input) input.value = q;
            if (button) button.click();
          };
          container.appendChild(item);
        });
      }

      window.addEventListener("DOMContentLoaded", function () {
        renderRecentSearches();
      });

HTML に次の要素を含めます。

      
        <style>
          #recent-searches button {
            display: inline-block;
            margin-right: 8px;
            margin-top: 4px;
            padding: 2px 8px;
            background-color: #f1f3f4;
            border: 1px solid #dadce0;
            border-radius: 4px;
            cursor: pointer;
            font-size: 13px;
          }
        </style>
        <div class="gcse-search"></div>
        <div id="recent-searches"></div>

制限事項

  • データはブラウザ（localStorage）にのみ保存され、ユーザーの同意が必要です。
  • デバイスやユーザー間で共有されません。
  • ブラウザ ストレージがクリアされるとクリアされます。
  • このページ以外で行われた検索はトラッキングされません。

結果レンダリング コールバックの例

結果レンダリング コールバックは、結果が入力された後にページを変更する場合に適しています。これは、結果のレンダリングをコールバックに完全に任せる必要なく、結果の表示を簡単に変更できるように設計されています。

次の例は、結果を操作しない結果レンダリング コールバックの 2 つのアプリケーションを示しています。

最後の結果ページを特定する

この results rendered コールバックは、結果の最後のページが表示されていることを検知し、ユーザーが最後に到達したことを知らせるアラートを表示します。

<script async
  src="https://cse.google.com/cse.js?cx=000888210889775888983:y9tkcjel090"></script>
 
myWebResultsRenderedCallback = function(){
    var searchresults= document.getElementsByClassName("gsc-cursor-page");
    var index= document.getElementsByClassName("gsc-cursor-current-page");
    if(index.item(0).innerHTML == searchresults.length){
       alert("This is the last results page");
    }
};

コールバックをインストールする 

window.__gcse || (window.__gcse = {});
window.__gcse.searchCallbacks = {
  web: {
      // Since the callback is in the global namespace, we can refer to it by name,
      // 'myWebResultsRenderedCallback', or by reference, myWebResultsRenderedCallback.
      rendered: myWebResultsRenderedCallback,
  },
};

HTML に次の要素を含めます。

<div class="gcse-searchbox"></div>
<div class="gcse-searchresults"></div>
「カーソル」リンクのフォントサイズを大きくしました

この results rendered コールバック デモでは、結果のページを選択する「カーソル」番号のフォントサイズを大きくします。

デフォルトのフォントサイズは 12 ピクセルです。ここでは、20 ピクセルに増やしています。

<script async
  src="https://cse.google.com/cse.js?cx=000888210889775888983:y9tkcjel090"></script>
 
myWebResultsRenderedCallback = function(){
   document.getElementsByClassName("gsc-cursor")[0].style.fontSize = '20px';
};

コールバックをインストールする 

window.__gcse || (window.__gcse = {});
window.__gcse.searchCallbacks = {
  web: {
      // Since the callback is in the global namespace, we can refer to it by name,
      // 'myWebResultsRenderedCallback', or by reference, myWebResultsRenderedCallback.
      rendered: myWebResultsRenderedCallback,
  },
};

HTML に次の要素を含めます。

<div class="gcse-searchbox"></div>
<div class="gcse-searchresults"></div>
「カーソル」ラベルに文字を使用

この results rendered コールバックは、「カーソル」のページリンクを数字から文字に変更します。

<script async
  src="https://cse.google.com/cse.js?cx=000888210889775888983:y9tkcjel090"></script>
 
myWebResultsRenderedCallback = function(){
    var arr = document.getElementsByClassName('gsc-cursor-page');
    var alp = ['A','B','C','D','E','F','G','H','I','J','K','L',
      'M','N','O','p','Q','R','S','T','U','V','W','X','Y','Z'];
    for (var i = 0; i &lt arr.length; i++) {
        arr[i].innerHTML = alp[i];
    }
};

コールバックをインストールする 

window.__gcse || (window.__gcse = {});
window.__gcse.searchCallbacks = {
  web: {
      // Since the callback is in the global namespace, we can refer to it by name,
      // 'myWebResultsRenderedCallback', or by reference, myWebResultsRenderedCallback.
      rendered: myWebResultsRenderedCallback,
  },
};

HTML に次の要素を含めます。

<div class="gcse-searchbox"></div>
<div class="gcse-searchresults"></div>

結果準備完了コールバックの例

背景色を交互に表示する

このコールバックは、明るい背景と暗い背景を交互に使用して結果をフォーマットします。

<script async
      src="https://cse.google.com/cse.js?cx=000888210889775888983:y9tkcjel090"></script>

注: このコードは JavaScript/ES6 で記述されています。ほとんどのブラウザで実行できますが、Internet Explorer やその他の古いブラウザでは JavaScript/ES5 に変換する必要があります。

barredResultsRenderedCallback = function(gname, query, promoElts, resultElts){
  const colors = ['Gainsboro', 'FloralWhite'];
  let colorSelector = 0;
  for (const result of resultElts) {
    result.style.backgroundColor = colors[colorSelector];
    colorSelector = (colorSelector + 1) % colors.length;
  }
};
window.__gcse || (window.__gcse = {});
window.__gcse.searchCallbacks = {
  web: {
    rendered: barredResultsRenderedCallback,
  },
};

HTML に次の要素を含めます。

<div class="gcse-searchbox"></div>
<div class="gcse-searchresults"></div>

ワードクラウド

results ready コールバックの明らかな用途は、results rendered コールバックを使用して HTML を調整するだけでは実現が難しい形式で検索結果を表示することです。結果準備完了コールバックは、空の div で始まります。検索要素 API ドキュメントの例では、コールバックを使用して非常にシンプルなバージョンの結果をレンダリングする方法を示しました。別の例では、結果準備完了コールバックから結果データを保持し、結果レンダリング完了コールバックに渡して、標準の結果表示を装飾する方法を示しました。

次の結果準備完了コールバックは、検索結果が結果のリストである必要がないことを示しています。検索結果の通常の表示が、結果のタイトルとコンテンツに含まれる単語のワードクラウドに置き換えられます。結果のリストがユーザーにとって中間ステップにすぎない場合、このようなコールバックを使用すると、その段階をバイパスして、結果を使用してユーザーが求めるレポートを表示できます。

検索結果のコンテンツからワードクラウドを作成する
<script async
      src="https://cse.google.com/cse.js?cx=000888210889775888983:y9tkcjel090"></script>
<style>
  #container {
    width: 100%;
    height: 4.5in;
    margin: 0;
    padding: 0;
  }
</style>
<script src="https://cdn.anychart.com/releases/v8/js/anychart-base.min.js"></script>
<script src="https://cdn.anychart.com/releases/v8/js/anychart-tag-cloud.min.js"></script>

注: このコードは JavaScript/ES6 で記述されています。ほとんどのブラウザで実行できますが、Internet Explorer やその他の古いブラウザでは JavaScript/ES5 に変換する必要があります。

const resultsReadyWordCloudCallback = function(
        name, q, promos, results, resultsDiv) {
    const stopWords = new Set()
      .add('a')
      .add('A')
      .add('an')
      .add('An')
      .add('and')
      .add('And')
      .add('the')
      .add('The');

    const words = {};
    const splitter = /["“”,\?\s\.\[\]\{\};:\-\(\)\/!@#\$%\^&*=\+\*]+/;
    if (results) {
        for (const {contentNoFormatting, titleNoFormatting} of results) {
            const wordArray = (contentNoFormatting + ' ' + titleNoFormatting)
              .split(splitter)
              .map(w => w.toLowerCase());
            for (const w of wordArray) {
                if (w && !stopWords.has(w)) {
                    words[w] = (words[w] + 1) || 1;
                }
            }
        }
    }
    const dataForChart = [];
    for (const key in words) {
        const val = words[key];
        dataForChart.push({
            'x': key,
            'value': val,
        });
    }

    const container = document.createElement('div');
    resultsDiv.appendChild(container);
    container.id = 'container';
    // create a tag (word) cloud chart
    const chart = anychart.tagCloud(dataForChart);
    // set a chart title
    chart.title(`Words for query: "${q}"`)
    // set an array of angles at which the words will be laid out
    chart.angles([0, 45, 90, 135])
    // display the word cloud chart
    chart.container(container);
    chart.draw();
    return true; // Don't display normal search results.
};
window.__gcse || (window.__gcse = {});
window.__gcse.searchCallbacks = {
    web: {
        ready: resultsReadyWordCloudCallback,
    },
};

HTML に次の要素を含めます。

<div class="gcse-searchbox"></div>
<div class="gcse-searchresults"></div>

2 つの部分からなるコールバックの例

結果準備完了コールバックと結果レンダリング完了コールバックを組み合わせて使用すると、前者から後者に情報を渡すことができます。たとえば、結果オブジェクトの配列内の情報は、結果準備完了コールバックでは使用できますが、結果レンダリング完了コールバックでは使用できません。この情報を結果準備完了コールバックの一部として配列に保存することで、結果レンダリング完了コールバックからアクセスできるようになります。

たとえば、画像検索結果がクリックされたときに表示されるプレビュー パネルをバイパスできます。2 つの部分からなるコールバックを使用すると、画像検索結果で画像をクリックしたときに画像プレビューが表示されるのではなく、対応するウェブサイトに直接リンクできます。

画像プレビューをバイパス
<script async
  src="https://cse.google.com/cse.js?cx=000888210889775888983:g9ckaktfipe"></script>
 
const makeTwoPartCallback = () => {
  let urls;
  const readyCallback = (name, q, promos, results, resultsDiv) => {
    urls = [];
    for (const result of results) {
      urls.push(result['contextUrl']);
    }
  };
  const renderedCallback = (name, q, promos, results) => {
    const removeEventListeners = element => {
      const clone = element.cloneNode(true);
      element.parentNode.replaceChild(clone, element);
      return clone;
    };
    for (let i = 0; i < results.length; ++i) {
      const element = removeEventListeners(results[i]);
      element.addEventListener('click', () => window.location.href = urls[i]);
    }
  };
  return {readyCallback, renderedCallback};
};
const {
  readyCallback: imageResultsReadyCallback,
  renderedCallback: imageResultsRenderedCallback,
} = makeTwoPartCallback();
window.__gcse || (window.__gcse = {});
window.__gcse.searchCallbacks = {
  image: {
    ready: imageResultsReadyCallback,
    rendered: imageResultsRenderedCallback,
  },
};

HTML に次の要素を含めます。

<div class="gcse-searchbox"></div>
<div class="gcse-searchresults"></div>