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

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

О практической работе

subjectПоследнее обновление: мар. 1, 2022
account_circleАвторы: Peter Jacobsen, Laurie White

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

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

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

  • Возможность навигации по Google Cloud Console.

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

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

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

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

Меню навигации в Cloud Console показывает

  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 с кнопками ВКЛЮЧИТЬ и ПОПРОБУЙТЕ ЭТОТ API.

Когда вы включаете API, отображается страница обзора API. Вы можете просмотреть показатели использования этого API, в которых очень мало информации, поскольку вы недавно включили API.

Страница обзора выбранного API, на которой показаны метрики API.

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

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

Страница обзора API Cloud Natural Language.

  1. Чтобы попробовать API (даже до того, как вы его включите), нажмите ПОПРОБУЙТЕ ЭТОТ API .

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

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

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

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

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

Вы также можете использовать OAuth 2.0 Playground, чтобы опробовать API Google. С помощью OAuth 2.0 Playground вы можете выбрать API, авторизовать его, а затем отправлять запросы и просматривать ответы в окне консоли OAuth 2.0 Playground.

  1. Откройте игровую площадку OAuth 2.0 .

Площадка OAuth 2.0 со списком API, которые вы можете попробовать.

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

Площадка OAuth 2.0, показывающая выбранные API Cloud Natural Language.

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

Панель «Код авторизации Exchange для токенов», на которой вы можете нажать «Код авторизации Exchange для токенов».

Теперь вы можете сделать запрос 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 после публикации запроса.

Не стесняйтесь экспериментировать с другими API на игровой площадке OAuth 2.0.

5. Очистить

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

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

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

6. Поздравления

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

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

О практической работе

subjectПоследнее обновление: мар. 1, 2022
account_circleАвторы: Peter Jacobsen, Laurie White

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

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

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

  • Возможность навигации по Google Cloud Console.

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

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

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

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

Меню навигации в Cloud Console показывает

  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 с кнопками ВКЛЮЧИТЬ и ПОПРОБУЙТЕ ЭТОТ API.

Когда вы включаете API, отображается страница обзора API. Вы можете просмотреть показатели использования этого API, в которых очень мало информации, поскольку вы недавно включили API.

Страница обзора выбранного API, на которой показаны метрики API.

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

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

Страница обзора API Cloud Natural Language.

  1. Чтобы попробовать API (даже до того, как вы его включите), нажмите ПОПРОБУЙТЕ ЭТОТ API .

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

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

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

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

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

Вы также можете использовать OAuth 2.0 Playground, чтобы опробовать API Google. С помощью OAuth 2.0 Playground вы можете выбрать API, авторизовать его, а затем отправлять запросы и просматривать ответы в окне консоли OAuth 2.0 Playground.

  1. Откройте игровую площадку OAuth 2.0 .

Площадка OAuth 2.0 со списком API, которые вы можете попробовать.

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

Площадка OAuth 2.0, показывающая выбранные API Cloud Natural Language.

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

Панель «Код авторизации Exchange для токенов», на которой вы можете нажать «Код авторизации Exchange для токенов».

Теперь вы можете сделать запрос 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 после публикации запроса.

Не стесняйтесь экспериментировать с другими API на игровой площадке OAuth 2.0.

5. Очистить

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

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

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

6. Поздравления

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