계속하려면 기본 요건의 단계를 완료하고 프로젝트의 비즈니스 프로필 API 액세스가 승인되어야 합니다.
API 사용 설정
Google API 콘솔에서 사용 설정해야 하는 비즈니스 프로필과 연결된 8개의 API는 다음과 같습니다.
- Google My Business API
- My Business Account Management API
- My Business Lodging API
- My Business Place Actions API
- My Business Notifications API
- My Business Verifications API
- My Business Business Information API
- My Business Q&A API
API 사용 설정
모든 기본 요건을 완료하고 API 액세스 권한을 부여받았지만 제공된 바로가기를 사용할 수 없는 경우 다음 단계에 따라 수동으로 API를 사용 설정할 수 있습니다.
프로젝트에 API를 사용 설정하려면 다음 단계를 따르세요.
- Google API 콘솔에서 API 라이브러리를 엽니다. 메시지가 표시되면 프로젝트를 선택하거나 새로운 프로젝트를 만듭니다. API 라이브러리에는 사용 가능한 모든 API가 제품군 및 인기도별로 분류되어 있습니다.
- 사용 설정하려는 API가 목록에 없는 경우 검색을 사용하여 찾습니다.
- 사용 설정하려는 API를 선택한 다음 사용 설정 버튼을 클릭합니다.
- 메시지가 표시되면 결제를 사용 설정합니다.
- 메시지가 표시되면 API의 서비스 약관에 동의합니다.
Google Workspace 사용자인 경우 Google Workspace 조직의 계정에 대해 Google 비즈니스 프로필이 사용 설정되어 있는지 확인하세요. Google Workspace 조직의 계정에서 Google 비즈니스 프로필이 사용 중지된 경우 GBP API를 사용할 때 'error 403 - PERMISSION DENIED' 메시지가 표시됩니다.
OAuth 2.0 클라이언트 ID 요청
앱에서 비공개 보호 데이터에 액세스하므로 OAuth 2.0 클라이언트 ID가 필요합니다. 이를 통해 앱에서 앱 사용자를 대신하여 조직의 위치 데이터에 액세스할 수 있도록 승인을 요청할 수 있습니다.
애플리케이션에서는 비공개 사용자 데이터에 액세스하는 모든 Business Profile API 요청과 함께 OAuth 2.0 토큰을 전송해야 합니다.
아직 그렇게 하지 않은 경우 Google API 콘솔의 '사용자 인증 정보' 섹션으로 이동하여 사용자 인증 정보 만들기 > OAuth 클라이언트 ID를 클릭하여 OAuth 2.0 사용자 인증 정보를 만듭니다. 사용자 인증 정보를 만들고 나면 사용자 인증 정보 페이지에 클라이언트 ID가 표시됩니다. 클라이언트 비밀번호, 리디렉션 URI, 자바스크립트 원본 주소, 이메일 주소 등 자세한 내용을 보려면 클라이언트 ID를 클릭하세요.
REST 기본사항 알아보기
API를 호출하는 방법에는 2가지가 있습니다.
- HTTP 요청을 보낸 후 응답 파싱
- 클라이언트 라이브러리 사용
클라이언트 라이브러리를 사용하지 않으려면 REST의 기본사항을 알아야 합니다.
REST는 편리하고 일관된 데이터 요청 및 수정 방법을 제공하는 소프트웨어 아키텍처 스타일입니다.
REST는 'Representational State Transfer'의 줄임말로, Google API의 경우 HTTP 동사를 사용하여 Google이 저장한 데이터 표현을 검색 및 수정하는 방법을 의미합니다.
RESTful 시스템은 리소스를 데이터 저장소에 저장합니다. 클라이언트에서 서버에 리소스 생성, 검색, 업데이트 또는 삭제와 같은 특정 작업을 실행하도록 요청을 전송하면 서버에서 요청된 작업을 실행하고 응답을 전송합니다. 이 응답은 보통 지정된 리소스의 형태로 표현됩니다.
Google의 RESTful API에서는 클라이언트가 HTTP 동사(예: GET, POST, PUT 또는 DELETE)로
작업을 지정합니다. 클라이언트가
다음과 같은 형태의 전역에서 고유한 Uniform Resource Identifier(URI)로 리소스를 지정합니다.
https://apiName.googleapis.com/apiVersion/resourcePath?parameters
모든 API 리소스에는 HTTP로 액세스할 수 있는 고유 URI가 있으므로 REST는 데이터 캐싱을 지원하고, 웹의 분산형 인프라와 연동할 수 있도록 최적화됩니다.
HTTP 1.1
표준 문서의 메서드 정의가 도움이 될 수
있습니다. 이 문서에는 GET, POST, PUT, DELETE 사양이 포함되어
있습니다.
Business Profile API의 REST
Business Profile API 작업은 REST HTTP 동사에 직접 매핑됩니다.
다음 URI에 Business Profile API의 구체적인 형식이 표시되어 있습니다.
https://apiName.googleapis.com/apiVersion/resourcePath?parameters
API에서 지원되는 각 작업에 사용되는 전체 URI 집합은 Business Profile API 참조 문서에 요약되어 있습니다.
리소스 경로는 엔드포인트에 따라 다릅니다.
예를 들어 계정의 리소스 경로는 다음 예와 같이 표시됩니다.
accounts/accountId
위치의 리소스 경로는 다음과 같은 형식으로 표시됩니다.
locations/locationId
JSON 기본사항 알아보기
Business Profile API는 JSON 형식으로 데이터를 반환합니다.
자바스크립트 객체 표기법(JSON)은 임의의 데이터 구조를 간단한 텍스트로 표현하는 언어 독립적인 일반 데이터 형식입니다. 자세한 내용은 json.org를 참고하세요.
간단한 HTTP 요청 만들기
OAuth 2.0 플레이그라운드를 사용하여 Business Profile API를 실험할 수 있습니다. Business Profile API는 공개 API가 아니므로 플레이그라운드에서 사용하려면 몇 가지 추가 단계가 필요합니다. 계속하려면 웹 애플리케이션의 클라이언트 ID가 필요합니다.
- Google API 콘솔로 이동하여 프로젝트를 엽니다. 웹 애플리케이션용 OAuth 클라이언트 ID가 없는 경우 다음 방법을 따라 만듭니다.
- 사용자 인증 정보 만들기 드롭다운 목록에서 OAuth 클라이언트 ID를 선택합니다.
- 애플리케이션 유형으로 웹 애플리케이션을 클릭합니다.
아래의 주소를 유효한 리디렉션 URI로 추가합니다.
https://developers.google.com/oauthplayground
- 만들기를 클릭합니다.
- 클라이언트 ID를 클립보드에 복사합니다.
- OAuth 2.0 플레이그라운드로 이동합니다.
- 톱니바퀴 아이콘을 클릭하여 구성 옵션을 열고 다음과 같이 변경합니다.
- OAuth 흐름을 클라이언트 측으로 설정합니다.
- 자체 OAuth 사용자 인증 정보 사용을 선택합니다.
- OAuth 클라이언트 ID를 붙여넣습니다.
- 구성 옵션을 닫습니다.
'1단계 - API 선택 및 승인'에서 내 범위 입력 필드에 다음의 Business Profile API 범위를 붙여넣습니다.
https://www.googleapis.com/auth/business.manage
- API 승인을 클릭합니다.
- 메시지가 표시되면 수락을 클릭합니다.
-
'2단계 - API 요청 구성'에서 다음 URI를 요청 URI 필드에 붙여넣습니다.
https://mybusinessaccountmanagement.googleapis.com/v1/accounts
- 요청 보내기를 클릭합니다. 응답에
200 OK상태가 표시됩니다.
다양한 유형의 요청을 수행하는 방법에 대한 자세한 내용은 Business Profile API 참조를 참고하세요.
클라이언트 라이브러리
Business Profile API 클라이언트 라이브러리는 Business Profile API의 기능을 지원합니다. HTTP 전송, 오류 처리, 인증, JSON 파싱 등 모든 Google API에 공통된 기능을 제공합니다.
클라이언트 라이브러리를 다운로드하려면 라이브러리를 참고하세요.