laravel google custom search engine

#Laravel Google Custom Search Engine Laravel パッケージは、無料版と有料版の両方で、Google Custom Search Engine API から Google Custom Search の結果を取得します。

略歴

Swiftype が無料プランを終了したため、私はコーディングをあまりせずに代替案を探し始めましたが、うまくいきませんでした。私が見つけた最良のものは、Google CSE 有料版用の Spatie の Google 検索パッケージでした。そこで、同様の方法で、ただし Google CSE バージョンとは独立したパッケージを研究開発しました。

開発者向けのコーヒー

このプロジェクトが気に入ったら、リフレッシュするためにコーヒーを買ってきてください。 :) https://ko-fi.com/A067ES5

インストール

1/ Composer でインストールする

composer require jan-drda/laravel-google-custom-search-engine

2/ サービスプロバイダーをconfig/app.phpに追加します。

 ' providers ' => [
    ' ... ' ,
    ' JanDrdaLaravelGoogleCustomSearchEngineLaravelGoogleCustomSearchEngineProvider '
];

3/ Facade のエイリアスを config/app.php に追加します

 ' aliases ' => [
	...
	' GoogleCseSearch ' => ' JanDrdaLaravelGoogleCustomSearchEngineFacadesLaravelGoogleCustomSearchEngineProvider ' ,
	...
]

4/ 設定ファイルを公開する

php artisan vendor:publish --provider= " JanDrdaLaravelGoogleCustomSearchEngineLaravelGoogleCustomSearchEngineProvider " 

構成

カスタム検索エンジンの作成

1. https://cse.google.com/cse/ でエンジンを作成した場合は、[設定] をクリックすると ID が表示されます。
2. https://cse.google.com/cse/setup/basic?cx=search_engine_id のような URL を確認してください。cx= の後の文字列が検索エンジン ID です。

!!注意 ！！カスタム検索エンジンのスタイルを変更すると、ID が変更される可能性があります

API キーを取得する

1. https://console.developers.google.com にアクセスしてください。
2. GoogleAPIロゴの右側にあるメニューをクリックし、「プロジェクトの作成」をクリックします。
3. 新しいプロジェクトの名前を入力します - それはあなた次第ですが、「Google CSE」を使用することもできます
4. プロジェクトが作成されるまで待ちます - インジケーターは右上隅のベルアイコンの周りの色の円です。
5. API リストが表示されます - 「Google Custom Search API」を検索してクリックします
6. Custom Search API の見出しの右側にある [有効にする] アイコンをクリックします。
7. 左側のメニューの「ライブラリ」セクションの下にある「認証情報」をクリックします。
8. 「認証情報の作成」をクリックし、「API キー」を選択します。
9. API キーが表示されるので、ここにコピーして貼り付けます

設定値を保存する

検索エンジン ID と API ID を config/laravelGoogleCustomSearchEngine.php に保存します。

使用法

簡単な使い方

オブジェクトを作成し、関数 getResults を呼び出して最初の 10 件の結果を取得します

 $ fulltext = new LaravelGoogleCustomSearchEngine (); // initialize
$ results = $ fulltext -> getResults ( ' some phrase ' ); // get first 10 results for query 'some phrase' 

名前空間をマップすることを忘れないでください。そうすれば、サンプルコントローラーは次のようになります（最小限の方法で）

これはコントローラー名の単なる例です。好きなものを使用できます。これは主に Laravel 初心者向けのお知らせです

 namespace App  Http  Controllers ;

use App  Http  Controllers  Controller ;
use JanDrda  LaravelGoogleCustomSearchEngine  LaravelGoogleCustomSearchEngine ;

class GoogleSearchController extends Controller
{

  public function index (){
    $ fulltext = new LaravelGoogleCustomSearchEngine (); // initialize
    $ results = $ fulltext -> getResults ( ' some phrase ' ); // get first 10 results for query 'some phrase' 
  }
}

合計レコードや検索時間などの検索に関する情報も取得できます。

 $ fulltext = new LaravelGoogleCustomSearchEngine (); // initialize
$ results = $ fulltext -> getResults ( ' some phrase ' ); // get first 10 results for query 'some phrase' 
$ info = $ fulltext -> getSearchInformation (); // get search information

高度な使用法

Google でサポートされている任意のパラメータを使用できます。パラメータのリストはここにあります: https://developers.google.com/custom-search/json-api/v1/reference/cse/list#parameters

たとえば、次の 10 件の結果を取得したい場合

 $ parameters = array (
    ' start ' => 10 // start from the 10 th results,
    ' num ' => 10 // number of results to get, 10 is maximum and also default value
)

$ fulltext = new LaravelGoogleCustomSearchEngine (); // initialize
$ results = $ fulltext -> getResults ( ' some phrase ' , $ parameters ); // get second 10 results for query 'some phrase'

他の情報を含む生の結果を Google から取得することもできます。応答変数の完全なリストは、https://developers.google.com/custom-search/json-api/v1/reference/cse/list#response で入手できます。

 $ fulltext = new LaravelGoogleCustomSearchEngine (); // initialize
$ results = $ fulltext -> getResults ( ' some phrase ' ); // get first 10 results for query 'some phrase'
$ rawResults = $ fulltext -> getRawResults (); // get complete response from Google

結果の数を取得する場合のみ使用します

 $ fulltext = new LaravelGoogleCustomSearchEngine (); // initialize
$ results =  $ fulltext -> getResults ( ' some phrase ' ); // get first 10 results for query 'some phrase'
$ noOfResults = $ fulltext -> getTotalNumberOfResults (); // get total number of results (it can be less than 10)

より多くのエンジンやより多くの API キーがある場合は、次の関数で構成変数をオーバーライドできます。

 $ fulltext = new LaravelGoogleCustomSearchEngine (); // initialize

$ fulltext -> setEngineId ( ' someEngineId ' ); // sets the engine ID
$ fulltext -> setApiKey ( ' someApiId ' ); // sets the API key

$ results =  $ fulltext -> getResults ( ' some phrase ' ); // get first 10 results for query 'some phrase' 

ドキュメント

重要なドキュメントは Github Wiki にあります。現在開発中です。

ライセンス

このパッケージは、MIT ライセンスに基づいてライセンス供与されたオープンソース ソフトウェアです

について

私は 1997 年からチェコ共和国に在住し、IT ビジネスに携わる独立したシニア ソフトウェア コンサルタントです。