laravel google custom search engine

#Laravel Google 맞춤 검색 엔진 Laravel 패키지를 사용하면 Google 맞춤 검색 엔진 API에서 무료 및 유료 버전으로 Google 맞춤 검색 결과를 얻을 수 있습니다.

약력

Swiftype가 무료 플랜을 종료하면서 너무 많은 코딩을 하지 않고도 대안을 찾기 시작했지만 성공하지 못했습니다. 내가 찾은 최고는 Spatie의 Google CSE 유료 버전용 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/ config/app.php에 Facade용 별칭을 추가합니다.

 ' 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. 맞춤 검색 API 헤드라인 오른쪽에 있는 '활성화' 아이콘을 클릭하세요.
7. '라이브러리' 섹션 아래 왼쪽 메뉴에서 '자격 증명'을 클릭하세요.
8. '자격 증명 만들기'를 클릭하고 'API 키'를 선택하세요.
9. API 키가 표시되므로 여기에 복사하여 붙여넣으세요.

구성 값 저장

config/laravelGoogleCustomSearchEngine.php에 검색 엔진 ID와 API ID를 저장하세요.

용법

간단한 사용법

객체를 생성하고 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 비즈니스 분야의 독립적인 수석 ​​소프트웨어 컨설턴트입니다.