이 문서는 Custom Search JSON API 및 사용법을 익히는 데 도움이 됩니다.
시작하기 전에
프로그래밍 검색 엔진 만들기
사용자는 API를 호출하여 프로그래밍 검색 엔진의 기존 인스턴스에 요청을 보냅니다.
따라서 API를 사용하기 전에 제어판에서 API를 만들어야 합니다. 다양한 구성 옵션에 대한 자세한 내용은 튜토리얼을 참조하세요.
검색엔진 ID를 만든 후 개요 페이지의 기본 섹션에서
확인할 수 있습니다. API에서 사용하는 cx 매개변수입니다.
API 키로 Google에 애플리케이션 식별
Custom Search JSON API를 사용하려면 API 키를 사용해야 합니다. API 키는 Google에서 클라이언트를 식별하는 방법입니다.
- 프로그래밍 검색 엔진 (무료 버전) 사용자: 키 가져오기
API 키가 있으면 애플리케이션에서 쿼리 매개변수 key=yourAPIKey을 모든 요청 URL에 추가할 수 있습니다. 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 사용으로 이동하세요.