キタックCGソリューションセンター

自分で触りたいWeb担のためのTips集

GoogleのCustom Search JSON API を使ってサイト内検索を実装【準備編】

2022年04月14日(木)

PV 100

実装者向けの記事です。

Googleが発行する「Custom Search JSON API」は、Googleの検索エンジンを使ってWebサイト内に独自の検索システムを作るためのAPIです。
「Custom Search JSON API」で検索システムを作る方法、今回は「準備編」です。

Custom Search JSON API は、Googleが提供しているサービスです。Googleの検索エンジンを自分のサイトに仕込み、サイト内検索を作れてしまう、素敵なサービスです

利用するためには、いくつか登録と設定が必要です。

コードを書く前段階の準備として、「API key」と「検索エンジンID」というのが必要になるのですが、今回はその取得方法を解説します。

準備その1:Google Cloud Platform

APIの有効化

Googleが提供するAPI群は、「Google Cloud Platform」で一元管理されます。
例えば「Maps JavaScript API」では、Googleマップを制御するためのAPIが提供されています。

Google Cloud Platformのアカウントを作成したら、必要なAPIを「有効化」しましょう。

今回の場合は、「Custom Search API」を有効にします。

API keyの取得

「API key」というものが必要です。APIを利用させてもらうための鍵です。

Google Cloud Platform のメニューから、「APIとサービス」>「認証情報」と進みます。

「認証情報」画面で、上の「+認証情報を作成」>「APIキー」と進みます。

名前や制限など設定項目を入力し、うまくAPIキーを作成できると、一覧で確認できます。

該当のAPIキーを保存しておきましょう。APIキーは後にコードを実装する際に利用します。

準備その2: Custom Search Engine改め「プログラム可能な検索エンジン」

「Custom Search API」とは別に、Programmable Search Engine(プログラム可能な検索エンジン)として、Googleが提供しているプラットフォームがあります。「カスタム検索エンジン」とも呼ばれます。

用途や使用量に応じて無料、有料があります。

サービスのバリエーションはこちらから確認できます。

表中の「JSON API」のところが今回のケースに当たります。(2022年4月現在)

Programmable Search Engine のページに行き、カスタム検索エンジンを作成しましょう。

「追加」という青いボタンで、新たな検索エンジンが作成できます。

上記のような作成画面で、必要な設定項目を入力し、検索エンジンを作成しましょう。
基本的には一つのサイトにつき一つのカスタム検索エンジンです。

うまく作成できたら、以下のような画面から「検索エンジンID」が取得できます。これを保存しておきましょう。検索エンジンIDも、後にコードを実装する際に利用します。

準備OK。あとはコードを書く

API key検索エンジンID。この2つが用意できたので、準備編は終了です。

あとはいよいよコードを書くのですが、続きは次回。

Share プリーズ
書き手は私

よろしければどうかご感想を!

※コメントは、サイト管理者による承認後、ページに表示されます。

あたたかい感想を書く

メールアドレスが公開されることはありません。

CAPTCHA


キタックCGSCコアメンバー

  • 樋口大輔
  • 小林将太
  • ちゃんまき
  • 高橋どらみ
  • 高橋皓一
  • 笠井
  • 石本
  • 佐藤サバ美
  • 佐久間尭