Google API 검색 및 선택

1. 시작하기 전에

이 Codelab에서는 Google API를 검색하고 선택하는 방법과 API 측정항목을 보는 방법을 알아봅니다.

기본 요건

  • Google Cloud 콘솔을 탐색할 수 있어야 합니다.

학습할 내용

필요한 항목

2. Cloud 콘솔에서 API 액세스

  1. Cloud 콘솔에서 5854836f11d5d97b.png 탐색 메뉴 > API 및 서비스 > 사용 설정된 API 및 서비스를 선택합니다.

Cloud 콘솔의 탐색 메뉴

  1. API 및 서비스 대시보드에서 + API 및 서비스 사용 설정을 클릭하여 사용 가능한 API를 확인합니다.

API 및 서비스 사용 설정 옵션이 표시된 API 및 서비스 대시보드

API 및 서비스 페이지에서 다양한 방법으로 API를 검색할 수 있습니다. API 이름을 알고 있다면 페이지 상단의 API 및 서비스 검색 필드에 입력하면 됩니다. 페이지 측면의 필터를 사용하여 카테고리별로 API를 필터링할 수도 있습니다.

API 및 서비스 검색 필드의 검색 결과로 표시되는 API 목록입니다.

  1. 카테고리 메뉴에서 머신러닝을 선택하여 머신러닝 API만 표시합니다.

카테고리별로 필터링된 API로, 머신러닝 API만 표시됩니다.

  1. 머신러닝 API에서 Cloud Natural Language API를 선택하여 이 API에 관한 세부정보를 확인합니다.
  2. 사용 설정을 클릭하여 적절한 프로젝트에서 이 API를 사용 설정합니다.

사용 설정 및 이 API 사용해 보기 버튼이 표시된 Cloud Natural Language API 창

API를 사용 설정하면 API의 개요 페이지가 표시됩니다. 최근에 API를 사용 설정했기 때문에 정보가 거의 없는 이 API의 사용량 측정항목이 표시됩니다.

선택한 API의 개요 페이지에 API의 측정항목이 표시됩니다.

향후 Codelab에서 사용자 인증 정보를 만드는 방법을 자세히 알아볼 수 있습니다. 지금 궁금하다면 사용자 인증 정보 만들기를 클릭한 후 표시되는 질문에 답변하세요.

  1. 관리를 클릭하여 이전 단계의 개요로 돌아갑니다.

Cloud Natural Language API 개요 페이지

  1. API를 사용해 보려면 (사용 설정하기 전이라도) API 사용해 보기를 클릭합니다.

그러면 일반적으로 API 문서의 페이지로 이동합니다. 하지만 일부 API는 다양한 메서드가 있어 API를 바로 사용해 볼 수 없습니다. Cloud Natural Language API의 경우가 이에 해당합니다.

Cloud Natural Language API 참조 페이지

  1. analyzeEntitites 메서드를 선택합니다.

API 메서드에 관한 세부정보와 API 사용해 보기 창이 있는 웹페이지가 표시됩니다.

analyzeEntitites 메서드의 세부정보와 'Try this API' 창이 표시된 페이지

  1. 샘플 쿼리를 사용해 보려면 다음 매개변수를 사용하여 요청 본문 필드에 document 객체를 추가하세요. + 아이콘을 클릭하여 필드 옵션을 펼칩니다.
  2. content: 필드에 분석할 텍스트를 입력합니다.

이 예시에서는 Michelangelo Caravaggio, Italian painter, is known for 'The Calling of Saint Matthew'.을 사용합니다.

  1. type: 필드에서 PLAIN_TEXT을 선택합니다.

요청 본문은 다음과 같이 표시됩니다.

요청 본문 매개변수를 보여주는 요청 본문 창

각 매개변수에 대한 자세한 내용은 문서를 참고하세요.

  1. Google OAuth 2.0 체크박스를 선택 해제한 다음 실행을 클릭하여 엔티티에 관한 세부정보가 포함된 대답을 받습니다.

엔티티에 관한 세부정보가 포함된 200 응답

  1. API 키 체크박스를 선택 해제한 다음 실행을 다시 클릭합니다.

이번에 쿼리를 실행하면 API를 실행하는 데 사용자 인증 정보가 필요하므로 다음과 같은 오류가 발생합니다.

사용자 인증 정보가 누락된 요청에 대한 403 응답입니다.

  1. Google OAuth 2.0 체크박스를 선택한 다음 실행을 다시 클릭합니다.

OAuth 2.0은 계정의 API 권한을 제공하고 경고를 표시합니다.

Google API 탐색기가 Google 계정에 액세스하려고 한다는 OAuth 2.0 경고

액세스를 허용하면 API 키를 사용했을 때와 동일한 응답이 표시됩니다. 앱에서 API를 사용하고 사용자 인증 정보를 아는 개인에게 액세스 권한을 부여해야 하는 경우 OAuth 2.0을 사용해야 합니다. 앱이 사용자를 위해 API에 액세스하는 것으로 충분한 경우 API 키를 대신 사용할 수 있습니다.

3. 측정항목 탐색기로 API 측정항목 보기

Cloud Console에서 API 액세스의 6단계에 표시된 대로 API 개요 페이지에서 단일 API의 호출 기록을 확인할 수 있습니다. 하지만 모든 API 사용량에 대한 측정항목을 더 많이 보려면 측정항목 탐색기를 사용하세요.

  1. f6b6844bf5688982.png 탐색 메뉴작업 섹션에서 모니터링 > 측정항목 탐색기를 클릭합니다.

탐색 메뉴의 작업 섹션에서 모니터링 및 측정항목 탐색기 옵션이 선택되어 있습니다.

  1. 리소스 유형 메뉴에서 측정항목 유형으로 사용된 API를 선택합니다. (표시되지 않으면 활성만 표시 체크박스를 선택 해제하세요.)

ca850c4295ef4ec9.png

  1. 측정항목 메뉴에서 요청 수와 같은 API의 개별 측정항목 중 하나를 선택하여 지정된 기간에 호출된 API 수를 확인할 수 있습니다.

요청 수의 사용된 API 측정항목을 보여주는 측정항목 탐색기

  1. 출력을 추가로 맞춤설정하려면 집계기를 설정하고 기간을 조정하세요. 집계기와 기간이 지정된 요청 수의 사용된 API 측정항목을 보여주는 측정항목 탐색기

4. OAuth 2.0 Playground를 사용하여 API 사용해 보기

OAuth 2.0 Playground를 사용하여 Google API를 사용해 볼 수도 있습니다. OAuth 2.0 Playground를 사용하면 API를 선택하고 승인한 다음 요청을 보내고 OAuth 2.0 Playground의 콘솔 창에서 응답을 확인할 수 있습니다.

  1. OAuth 2.0 Playground를 엽니다.

사용해 볼 수 있는 API 목록이 표시된 OAuth 2.0 Playground

  1. Cloud Natural Language API > https://www.googleapis.com/auth/cloud-language > https://www.googleapis.com/auth/cloud-platform > API 승인을 클릭합니다.

Cloud Natural Language API가 선택된 OAuth 2.0 Playground

  1. 필요한 경우 Google 계정에 로그인한 다음 허용을 클릭하여 승인 코드를 받습니다.
  2. 승인 코드를 토큰으로 교환을 클릭합니다.

'승인 코드를 토큰으로 교환'을 클릭할 수 있는 '승인 코드를 토큰으로 교환' 창

이제 API를 요청할 수 있습니다.

  1. 가능한 작업 나열을 클릭하여 가능한 모든 API 호출을 검사합니다.

이전에 Natural Language API analyzeEntities 문서의 정보 페이지를 열었으므로 HTTP 요청의 URL이 다음과 같음을 확인할 수 있습니다.

https://language.googleapis.com/v1beta2/documents:analyzeEntities

POST 요청입니다.

API 요청 구성 창에서 HTTP 메서드를 선택하고, 요청 URI를 등록하고, 요청 본문을 입력하고, 요청을 보낼 수 있습니다.

  1. 요청 URI 정보를 입력하고 요청 본문을 추가합니다.

API 탐색기에서 사용한 것과 동일한 본문을 사용할 수 있습니다.

요청 본문 창입니다.

  1. 닫기 > 요청 보내기를 클릭합니다.

다음 이미지와 비슷한 결과가 표시됩니다.

요청을 게시한 후의 OAuth 2.0 요청/응답 창

OAuth 2.0 Playground에서 다른 API를 자유롭게 실험해 보세요.

5. 삭제

프로젝트에 제한되지 않은 API 키를 사용하는 것은 좋지 않습니다. 이 키에 액세스할 수 있는 사용자는 추가 인증 없이 이 키를 사용할 수 있습니다.

이 API 키를 삭제하려면 다음 단계를 따르세요.

  1. f6b6844bf5688982.png 탐색 메뉴 > API 및 서비스 > 사용자 인증 정보를 클릭합니다.
  2. API 키에서 삭제할 키를 선택한 후 247adf2e1d1eae4b.png를 클릭합니다.
  3. 마찬가지로 서비스 계정 비공개 키가 보호되지 않는 것에 대해 걱정하는 대신 서비스 계정에서 삭제할 서비스 계정을 선택한 다음 247adf2e1d1eae4b.png를 클릭합니다.

6. 축하합니다

축하합니다. Google API를 검색하고 선택하는 방법과 측정항목을 보는 방법을 배웠습니다.