REST를 사용하여 API 호출

이 문서에서는 Custom Search JSON API를 사용하는 방법을 설명합니다.

요청하기

REST(Representational State Transfer) 맞춤 검색 JSON API의 API는 기존 REST와 다소 다릅니다. API는 리소스에 대한 액세스 권한을 제공하는 대신 서비스에 대한 액세스 권한을 제공합니다. 따라서 API는 서비스 엔드포인트 역할을 하는 단일 URI를 제공합니다.

HTTP GET를 전송하여 특정 검색의 결과를 가져올 수 있습니다. 이 URI에 요청을 보냅니다. 검색 요청의 세부정보를 쿼리 매개변수를 추가할 수 있습니다. Custom Search JSON API URI의 형식은 다음과 같습니다.

https://www.googleapis.com/customsearch/v1?[parameters]

각 검색 요청에는 3개의 쿼리 [parameters]가 필요합니다.

  • API 키 - key 쿼리 매개변수를 사용하여 애플리케이션 식별.

  • 프로그래밍 검색 엔진 ID - cx를 사용하여 이 검색을 수행하는 데 사용할 프로그래밍 검색 엔진입니다. 검색엔진은 제어판에서 만들어야 합니다. 참고: 검색엔진 ID (cx)는 다른 형식 (예: 8ac1ab64606d234f1)일 수 있습니다.

  • 검색어 - q 쿼리 매개변수를 사용하여 검색 표현식을 지정합니다.

다른 모든 쿼리 매개변수는 선택사항입니다.

이것은 강의용 프로그래밍 검색 엔진 테스트:

GET https://www.googleapis.com/customsearch/v1?key=INSERT_YOUR_API_KEY&cx=017576662512468239146:omuauf_lfve&q=lectures
 드림

쿼리 매개변수

요청에 전달할 수 있는 매개변수에는 두 가지 유형이 있습니다.

  • API 관련 매개변수 - 검색 표현식, 결과 수, 언어 등
  • 표준 검색어 매개변수 - 요청의 기술적 측면을 정의합니다. API 키입니다.

모든 매개변수 값은 URL로 인코딩되어야 합니다.

API별 쿼리 매개변수

맞춤 검색 JSON API에 특별히 적용되고 검색 요청은 참조.

표준 쿼리 매개변수

모든 Custom Search JSON API 작업에 적용되는 쿼리 매개변수는 다음 페이지에 설명되어 있습니다. 시스템 매개변수.

응답 데이터

요청이 성공하면 서버에서 200 OK HTTP 상태 코드를 응답으로 반환합니다. JSON 형식의 응답 데이터를 가져올 수 있습니다 응답 데이터를 조회할 수 있습니다. 참조에서 찾을 수 있습니다.

응답 데이터는 세 가지 유형의 속성:

  • 요청된 검색 및 관련 검색 요청을 설명하는 메타데이터
  • 프로그래밍 검색 엔진을 설명하는 메타데이터
  • 검색 결과

각 속성에 대한 자세한 설명은 참조.

검색 요청 메타데이터

검색 메타데이터에는 다음이 포함됩니다.

  • url 속성: OpenSearch 템플릿 정보 이 요청에서 반환된 결과에 사용됩니다.
  • queries 속성: 객체입니다. 각 객체는 배열의 이름 또는 OpenSearch 쿼리 역할 또는 이 API로 정의된 두 가지 커스텀 역할 중 하나: previousPage 및 nextPage. 가능한 쿼리 역할 객체 포함: <ph type="x-smartling-placeholder">
      </ph>
    • request: 현재 집합의 쿼리를 설명하는 메타데이터 있습니다.
      • 이 역할은 응답에 항상 표시됩니다.
      • 항상 요소가 하나만 있는 배열입니다.
      • nextPage: 다음 쿼리에 사용할 쿼리를 설명하는 메타데이터 표시됩니다.
        • 현재 결과가 마지막 페이지인 경우 이 역할이 없습니다. 참고: 이 API는 처음 100개의 결과만 반환합니다.
        • 있는 경우 항상 요소가 하나만 있는 배열입니다.
    • previousPage: 다음에 사용할 쿼리를 설명하는 메타데이터 결과가 표시됩니다.
      • 현재 결과가 첫 페이지인 경우에는 표시되지 않습니다.
      • 있는 경우 항상 요소가 하나만 있는 배열입니다.

검색엔진 메타데이터

context 속성에는 검색엔진을 설명하는 메타데이터가 있습니다. 전체 목록을 확인할 수 있습니다. 여기에는 검색엔진의 이름과 해당 객체가 제공하는 모든 패싯 객체 검색 범위를 좁히는 것입니다.

검색 결과

items 배열에는 실제 검색 결과가 포함됩니다. 검색 결과에는 결과를 설명하는 URL, 제목 및 텍스트 스니펫이 포함됩니다. 포함 또한 리치 스니펫을 포함할 수 있습니다. (해당하는 경우)

검색결과에 promotions 속성이 있으면 프로모션 모음

JavaScript의 REST

다음 명령을 사용하여 JavaScript에서 REST를 사용하여 Custom Search JSON API를 호출할 수 있습니다. callback 쿼리 매개변수와 콜백 함수 이렇게 하면 코드를 작성하지 않고도 프로그래밍 검색 엔진 데이터를 표시하는 다양한 애플리케이션을 작성할 수 있습니다. 사용할 수 있습니다

다음 예에서는 이 방식을 사용하여 검색의 첫 페이지를 표시합니다. cars 쿼리 결과:

<html>
  <head>
    <title>Custom Search JSON API Example</title>
  </head>
  <body>
    <div id="content"></div>
    <script>
      function hndlr(response) {
      for (var i = 0; i < response.items.length; i++) {
        var item = response.items[i];
        // Make sure HTML in item.htmlTitle is escaped.
        document.getElementById("content").append(
          document.createElement("br"),
          document.createTextNode(item.htmlTitle)
        );
      }
    }
    </script>
    <script src="https://www.googleapis.com/customsearch/v1?key=YOUR-KEY&cx=017576662512468239146:omuauf_lfve&q=cars&callback=hndlr">
    </script>
  </body>
</html>