API環境準備とAPIキーの取得 (CSE/Googleカスタム検索エンジンAPI)
Googleカスタム検索エンジン(CSE)をAPIから利用するには大きく2つの前提が必要になります。
APIの利用登録とAPIサービスでCSEが有効になっていることと、CSEの作成が済んでいる事です。
地味に分かりにくいこの手順を順を追ってご紹介します。
ここでは「APIの利用登録とAPIサービスでCSEが有効」の部分についてご紹介します。
本投稿は以下コンテンツの1記事になります。一連の流れは以下からご確認下さい。
私(本検証)は既にGoogleアカウントの取得と、
GoogleAPIコンソールへのアクセスの設定は済んでいますので、
途中、ログイン・登録等を促す画面が表示された場合は画面の指示に従ってください。
APIの利用とCSEサービス有効化・環境準備 (CSE/Googleカスタム検索エンジンAPI)
Google Cloud Platform(API)にログインしてGoogle Custom Search APIの有効化を行います。
まずは、以下URLにアクセスします。
https://console.developers.google.com/apis/dashboard
適宜、Googleアカウントへのログイン、
規約に同意などを手順に沿って行ってください。
GoogleAPIs(Google Cloud Platform)が表示されます。
利用規約に同意が表示された場合、一読し、同意して進みます。
GoogleAPIs(Google Cloud Platform)のダッシュボードが開いたら、
プロジェクトの作成・選択を行います。「プロジェクトの選択」をクリックします。
プロジェクトの選択ポップアップが表示されますので、
右上の「新しいプロジェクト」をクリックして作成するか、
下部の一覧から作成済みプロジェクトをクリックして選択します。
プロジェクトの選択が完了したら、APIの有効化を行います。
今回は「Googleカスタム検索エンジンAPI(CSE API)」の利用が目的です。
「APIとサービスの有効化」をクリックします。
APIライブラリが表示されます。
スクロールして目的のAPIを探すか、検索します。
「Googleカスタム検索エンジンAPI(CSE API)」は、
「Custom Search API」として表示されています。
クリックして選択します。
詳細画面が表示されますので「有効にする」をクリックします。
画面がダッシュボードに戻り、しばらく有効化プログレス表示になります。
作成が終了すると以下のような画面になります。
まず「認証情報」の作成から、APIキーを作成します。
※以下、上記とは別アカウントのキャプチャになります。
既に認証情報が作成されている場合は、一覧に以下のように表示されます。
編集する場合は「名前」をクリックするか、鉛筆アイコンをクリックします。
新しくAPIキー(認証情報)を作成するには、
プルダウンから「APIキー」を選択します。
APIキーの作成では、APIキーの名前を入力するだけで作成できます。
必要に応じて「キーの制限」を指定することで、
このAPIキーの利用に制限を設けることができます。
APIキーは基本的にプログラムからAPIを利用する場合に使用します。
JavaScriptなどから利用する場合、APIキーはJavaScript内に埋め込んで利用されますので、
基本「公開」されることになります。
他人がそのAPIキーを利用してAPIの呼び出しを行うと、
自分のAPI使用量に他人の使用分が加算されて、1日の使用制限などに影響がでます。
場合によっては、請求を受ける事にもなりますので、
本番運用時にはこの「キーの制限」で自分のサイトドメインなどに制限することは必須です。
一覧に表示されている認証情報から、
APIで利用するものを決めてプログラム側で表示されているキーを利用します。
例えば、以下で利用しているAPIキーは以下の様なものになります。(一部変えていますので動きません)
AIzaSyAyvzyT3Zfi2621AY1dZq3mjDxinjDM31w
「Googleカスタム検索エンジンAPI」をプログラムから呼び出す場合には、
この「APIキー」だけではなく「CX」パラメータと呼ばれる「検索エンジンID」が必要になります。
次は、カスタム検索エンジンの作成手順になります。
既に作成済みの場合には、
以下手順で「検索エンジンID(CX)」の取得手順をご確認下さい。
本サイトで公開しているツールについては、
十分にテストは行っておりますが個人で作成している為、
潜在的なバグがないとは言い切れません。
その為、ツールを用いた結果については十分検証の上ご利用ください。
当サイトおよび、管理人は如何なる損害もその責を負いません。
当サイト内のコンテンツおよび画像において、
出典・引用の外部著作権者の明記がないものは、
すべて管理人による著作物です。
当サイトでご紹介しておりますコンテンツの著作権の放棄は致しません。
サイト内コンテンツを引用される際にはご連絡は不要です。
ただし、出典元として当サイト(個別記事)へのリンクをお願いいたします。
申し訳ございませんが、無断転載、複製をお断りさせて頂いております。
コンテンツを有益であると感じていただけましたら非常に光栄です。
ありがとうございます。
公開日:
最終更新日:2019/06/20