이 문서를 통해 Custom Search JSON API와 그 사용법을 익힐 수 있습니다.
시작하기 전에
프로그래밍 검색 엔진 만들기
API를 호출하면 사용자가 프로그래밍 검색 엔진의 기존 인스턴스에 대해 요청을 실행합니다. 따라서 API를 사용하기 전에 제어판에서 하나를 만들어야 합니다 . 튜토리얼을 따라 다양한 구성 옵션에 대해 자세히 알아보세요. 생성되면 개요 페이지의 기본 섹션에서 검색 엔진 ID를 확인할 수 있습니다. API에서 사용하는 cx 매개변수입니다.
API 키로 Google에 애플리케이션 식별
Custom Search JSON API를 사용하려면 API 키를 사용해야 합니다. API 키는 Google에 클라이언트를 식별하는 방법입니다.
API 키가 있으면 애플리케이션은 모든 요청 URL에 쿼리 매개변수 key=yourAPIKey를 추가할 수 있습니다. API 키는 URL에 포함하기에 안전하며 인코딩이 전혀 필요하지 않습니다.
API 개요
API 작업
Custom Search JSON API에서 호출할 수 있는 메서드는 하나뿐입니다.
| 작업 | 설명 | REST HTTP 매핑 |
|---|---|---|
| list | 프로그래밍 검색 엔진에서 요청된 검색 결과를 반환합니다. | GET |
API 데이터 모델
Custom Search JSON API에 대한 검색어의 결과는 다음 세 가지 유형의 데이터가 포함된 JSON 객체입니다.
- 요청된 검색 (및 관련 검색 요청)을 설명하는 메타데이터
- 프로그래밍 검색 엔진을 설명하는 메타데이터입니다.
- 검색 결과
자세한 내용은 REST 사용의 응답 데이터 섹션을 참고하세요.
데이터 모델은 OpenSearch 1.1 사양을 기반으로 합니다. Custom Search JSON API는 표준 OpenSearch 속성 외에도 두 개의 맞춤 속성과 두 개의 맞춤 쿼리 역할을 정의합니다.
- 맞춤 속성
cx: 프로그래밍 검색 엔진의 식별자입니다.safe: 반환된 결과를 필터링하기 위한 안전 검색 수준에 관한 설명입니다.
- 맞춤 쿼리 역할
nextPage: 쿼리를 사용하여 결과의 다음 논리 페이지에 액세스할 수 있음을 나타내는 역할입니다(있는 경우).previousPage: 쿼리를 사용하여 이전 논리적 결과 페이지에 액세스할 수 있음을 나타내는 역할입니다(있는 경우).
직접 해 보기
코드를 작성하지 않고 API를 둘러보면서 기능을 살펴보려면 'API 사용해 보기' 도구를 방문하세요.
매개변수에 관한 자세한 설명은 cse.list 참조를 참고하세요.
HTTP 요청을 통해 API를 사용하는 방법을 알아보려면 REST 사용으로 계속하세요.