Найдите и выберите API Google

1. Прежде чем начать

В этом практическом занятии показано, как искать и выбирать API Google, а также просматривать метрики API.

Предварительные требования

  • Умение ориентироваться в консоли Google Cloud.

Что вы узнаете

Что вам понадобится

2. Доступ к API из облачной консоли

  1. В консоли облака выберите 5854836f11d5d97b.png Меню навигации > API и сервисы > Включенные API и сервисы .

В облачной консоли отображается меню навигации.

  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 в соответствующем проекте.

На панели Cloud Natural Language API отображаются кнопки ENABLE и TRY THIS API.

После включения API отображается страница «Обзор API». Там вы можете увидеть метрики использования этого API, которые, однако, содержат очень мало информации, поскольку API был включен совсем недавно.

На странице обзора выбранного API отображаются метрики для этого API.

В одном из следующих практических занятий вы узнаете больше о том, как создавать учетные данные, но если вам интересно прямо сейчас, нажмите «СОЗДАТЬ УЧЕТНЫЕ ДАННЫЕ» , а затем ответьте на представленные вопросы.

  1. Нажмите кнопку «УПРАВЛЕНИЕ» , чтобы вернуться к обзору предыдущего шага.

Обзорная страница API Cloud Natural Language.

  1. Чтобы протестировать API (даже до его активации), нажмите «ПОПРОБОВАТЬ ЭТОТ API» .

Обычно это приводит вас на страницу документации к API. Однако для некоторых API нет возможности сразу же попробовать их в действии, поскольку у них много разных методов. Так обстоит дело с Cloud Natural Language API.

Справочная страница Cloud Natural Language API.

  1. Выберите метод analyzeEntitites .

Вы должны увидеть веб-страницу с подробной информацией о методах API и панелью «Попробовать этот API» .

Страница, посвященная методу analyzeEntitites, с подробным описанием метода и панелью «Попробовать этот 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 и отображает предупреждение.

Предупреждение OAuth 2.0 о том, что Google API Explorer запрашивает доступ к вашей учетной записи Google.

Если вы разрешите доступ, вы получите тот же ответ, что и при использовании ключей API. Если вы используете API в приложении и вам необходимо предоставить доступ отдельным лицам, имеющим доступ к их учетным данным, вам следует использовать OAuth 2.0. Если же приложению достаточно доступа к API для пользователя, вы можете использовать вместо этого ключи API.

3. Просматривайте метрики вашего API с помощью обозревателя метрик.

Историю вызовов для любого отдельного API можно просмотреть на странице «Обзор API», как показано на шаге 6 раздела «Доступ к 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 для тестирования API Google. С помощью OAuth 2.0 Playground вы можете выбрать API, авторизовать его, а затем отправлять запросы и видеть ответы в окне консоли OAuth 2.0 Playground.

  1. Откройте среду разработки OAuth 2.0 Playground .

В демонстрационном разделе OAuth 2.0 Playground представлен список API, которые вы можете попробовать.

  1. Нажмите Cloud Natural Language API > https://www.googleapis.com/auth/cloud-language > https://www.googleapis.com/auth/cloud-platform > Авторизовать API .

В демонстрационном режиме OAuth 2.0 Playground показаны выбранные API Cloud Natural Language.

  1. При необходимости войдите в свой аккаунт Google и нажмите «Разрешить» , чтобы получить код авторизации.
  2. Нажмите «Код авторизации биржи для получения токенов» .

В панели «Обмен кода авторизации на токены» вы можете нажать «Обмен кода авторизации на токены».

Теперь вы можете отправить запрос к API.

  1. Нажмите «Список возможных операций» , чтобы просмотреть все возможные вызовы API.

Вы ранее открывали информационную страницу документа analyzeEntities для API обработки естественного языка, поэтому можете видеть, что URL-адрес для HTTP-запроса выглядит следующим образом:

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

Это POST-запрос.

В панели «Настройка запросов к API» вы можете выбрать метод HTTP, зарегистрировать URI запроса, ввести тело запроса и отправить запрос.

  1. Введите информацию об URI запроса и добавьте тело запроса.

Вы можете использовать тот же текст, что и в API Explorer.

Запросить основную панель.

  1. Нажмите «Закрыть» > «Отправить запрос» .

В результате вы должны получить изображение, похожее на это:

Панель запроса/ответа OAuth 2.0 после отправки запроса.

В тестовой среде OAuth 2.0 Playground вы можете смело экспериментировать с другими API.

5. Уборка

Использование неограниченного API-ключа для проектов — плохая практика . Если кто-то получит к нему доступ, он сможет использовать его без дополнительной аутентификации.

Чтобы удалить этот ключ API:

  1. Нажмите f6b6844bf5688982.png Меню навигации > API и сервисы > Учетные данные .
  2. В разделе «Ключи API» выберите ключ для удаления, а затем нажмите кнопку. 247adf2e1d1eae4b.png .
  3. Аналогично, вместо того чтобы беспокоиться о незащищенности закрытого ключа вашей служебной учетной записи, в разделе «Служебные учетные записи » выберите служебную учетную запись для удаления, а затем нажмите кнопку. 247adf2e1d1eae4b.png .

6. Поздравляем!

Поздравляем! Вы научились искать и выбирать API Google, а также просматривать их показатели.