API Reference

Search Console API는 다음 서비스를 제공합니다.

  • 검색 애널리틱스: 사이트의 트래픽 데이터를 쿼리합니다.
  • 사이트맵 - 모든 사이트맵을 나열하고, 특정 사이트맵에 관한 정보를 요청하고, Google에 사이트맵을 제출합니다.
  • 사이트: Search Console 계정에서 속성을 나열/추가/삭제합니다.
  • URL 검사: Google 색인의 페이지 상태를 검사합니다 (Search Console의 URL 검사와 같음).

검색 분석

검색 애널리틱스 리소스에 대해 자세히 알아보려면 리소스 표현 페이지를 참고하세요.

메서드 HTTP 요청 설명
별도의 명시가 없는 한 https://www.googleapis.com/webmasters/v3의 상대 URI입니다.
query POST  /sites/siteUrl/searchAnalytics/query

정의한 필터 및 매개변수를 사용하여 검색 트래픽 데이터를 쿼리합니다. 이 메서드는 정의된 행 키 (측정기준)에 따라 그룹화된 0개 이상의 행을 반환합니다. 1일 이상의 기간을 정의해야 합니다.

날짜가 측정기준 중 하나인 경우 데이터가 없는 날짜는 결과 목록에서 생략됩니다. 데이터가 있는 날짜를 알아보려면 원하는 기간에 대해 날짜별로 그룹화한 필터 없이 쿼리를 실행하세요.

결과는 클릭수를 기준으로 내림차순으로 정렬됩니다. 두 행의 클릭수가 동일하면 임의의 방식으로 정렬됩니다.

이 메서드를 호출하는 방법은 Python 샘플을 참조하세요.

JSON POST 예시: 
POST https://www.googleapis.com/webmasters/v3/sites/https%3A%2F%2Fwww.example.com%2F/searchAnalytics/query
{
  "startDate": "2015-04-01",
  "endDate": "2015-05-01",
  "dimensions": ["country","device"]
}

사이트맵

사이트맵 리소스에 대한 자세한 내용은 리소스 표현 페이지를 참조하세요.

메서드 HTTP 요청 설명
별도의 명시가 없는 한 https://www.googleapis.com/webmasters/v3의 상대 URI입니다.
삭제 DELETE  /sites/siteUrl/sitemaps/feedpath 이 사이트에서 사이트맵을 삭제합니다.
get GET  /sites/siteUrl/sitemaps/feedpath 특정 사이트맵에 관한 정보를 검색합니다.
list GET  /sites/siteUrl/sitemaps 이 사이트에 제출되었거나 사이트맵 색인 파일에 포함된 사이트맵 항목을 나열합니다 (요청에 sitemapIndex가 지정된 경우).
제출 PUT  /sites/siteUrl/sitemaps/feedpath 사이트의 사이트맵을 제출합니다.

사이트 도구

Sites 리소스에 대해 자세히 알아보려면 리소스 표현 페이지를 참고하세요.

메서드 HTTP 요청 설명
별도의 명시가 없는 한 https://www.googleapis.com/webmasters/v3의 상대 URI입니다.
추가 PUT  /sites/siteUrl Search Console의 사용자 사이트 집합에 사이트를 추가합니다.
삭제 DELETE  /sites/siteUrl 사용자의 Search Console 사이트 집합에서 사이트를 삭제합니다.
get GET  /sites/siteUrl 특정 사이트에 관한 정보를 검색합니다.
list GET  /sites 사용자의 Search Console 사이트를 나열합니다.

URL 검사

URL 검사 리소스에 대한 자세한 내용은 리소스 표현 페이지를 참고하세요.

메서드 HTTP 요청 설명
https://searchconsole.googleapis.com/v1 기준 URI
index.inspect POST /urlInspection/index:inspect

Google 색인에 제공된 URL에 관한 정보입니다.

JSON POST 예시: 
POST https://searchconsole.googleapis.com/v1/urlInspection/index:inspect
{
  "inspectionUrl": "https://www.example.com/mypage",
  "siteUrl": "https://www.example.com/",
  "languageCode": "en-US"}