기본 요건

이 문서에서는 첫 번째 클라이언트 애플리케이션을 작성하기 전에 수행해야 하는 작업을 설명합니다.

Google 계정 만들기

이 API를 사용하려면 Google 계정이 필요합니다. 계정에 특정 속성에 관해 적절한 Search Console 권한이 있어야 해당 속성에서 메서드를 호출할 수 있습니다. 예를 들어 searchAnalytics.query를 실행하려면 해당 속성에 대한 읽기 권한이 필요합니다.

Google Search Console 사용해 보기

이 API 문서에서는 사용자가 Google Search Console을 사용했으며 웹 프로그래밍 개념과 웹 데이터 형식에 익숙하다고 가정합니다.

Google Search Console을 사용해 본 적이 없다면 코딩을 시작하기 전에 사용자 인터페이스를 사용해 보세요. 각 API는 Search Console의 보고서 기능을 나타냅니다. 수신한 데이터를 파악하려면 API를 사용하기 전에 상응하는 보고서에 대한 설명서를 읽어야 합니다.

클라이언트의 프로젝트 및 사용자 인증 정보 만들기

Google Search Console에 요청을 보내려면 먼저 Google에 클라이언트에 관해 알리고 API에 대한 액세스를 활성화해야 합니다. Google API 콘솔을 사용하여 설정 및 API 액세스 정보의 이름이 지정된 프로젝트를 만들고 애플리케이션을 등록하면 됩니다.

Testing Tools API를 제외한 모든 Search Console API에는 OAuth2 사용자 인증 정보가 필요합니다. Python 및 자바 빠른 시작 가이드에서는 프로젝트를 만들고 클라이언트의 사용자 인증 정보를 얻는 방법을 자세히 설명합니다.

REST 기본사항 이해하기

API를 호출하는 방법에는 2가지가 있습니다.

클라이언트 라이브러리를 사용하지 않으려는 경우에는 REST의 기본사항을 이해해야 합니다.

REST 기본사항

REST는 데이터 요청 및 수정에 대한 간편하고 일관성 있는 접근 방식을 제공하는 소프트웨어 아키텍처 스타일입니다.

REST는 'Representational State Transfer'의 줄임말로, Google API의 맥락에서 REST는 HTTP 동사를 사용하여 Google이 저장한 데이터 표현을 검색 및 수정하는 방법을 의미합니다.

RESTful 시스템에서는 리소스가 데이터 저장소에 저장되고, 클라이언트는 서버에서 특정 작업(리소스 생성, 검색, 업데이트, 삭제 등)을 수행하라는 요청을 전송하며, 서버는 작업을 수행하고 응답을 전송합니다. 이 응답은 지정된 리소스 표현의 형식을 취하는 경우가 많습니다.

Google의 RESTful API에서는 클라이언트가 POST, GET, PUT, DELETE 등의 HTTP 동사를 사용하여 작업을 지정합니다. 리소스를 다음과 같은 형식의 고유한 URI로 지정합니다.

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

모든 API 리소스에는 HTTP에서 액세스할 수 있는 고유 URI가 있으므로 REST는 데이터 캐싱을 지원하며 웹의 분산형 인프라와의 연동성이 뛰어납니다.

HTTP 1.1 표준 문서의 메서드 정의를 확인하면 유용합니다. 문서에 GET, POST, PUT, DELETE의 사양이 포함되어 있습니다.

Google Search Console API의 REST

Google Search Console API 작업은 REST HTTP 동사에 직접 매핑됩니다.

대부분의 Google Search Console API URI 형식은 다음과 같습니다.

VERB https://www.googleapis.com/webmasters/v3/resourcePath?parameters

각 메서드에 사용되는 URI 및 동사 전체 집합은 Google Search Console API 참조 개요에 나와 있습니다.

JSON 기본사항 이해하기

Google Search Console API는 JSON 형식으로 데이터를 반환합니다.

JSON(JavaScript Object Notation)은 특정 언어에 의존하지 않는 일반적인 데이터 형식으로, 임의의 데이터 구조를 간단한 텍스트로 표현할 수 있습니다. 자세한 내용은 json.org를 참조하세요.