О практической работе
1. Прежде чем начать
В этой лаборатории кода показано, как искать и выбирать API Google, а также просматривать метрики API.
Предварительные условия
- Возможность навигации по Google Cloud Console.
Что вы узнаете
- Как искать и выбирать API с помощью библиотеки Google Cloud API и игровой площадки OAuth 2.0 .
- Как просмотреть метрики API с помощью обозревателя метрик и облачных API и сервисов.
Что вам понадобится
- Учетная запись Google, например учетная запись Gmail или учетная запись Google Workspace .
- Доступ к платежному аккаунту Cloud или кредитной карте для использования бесплатной пробной версии .
2. Доступ к API из облачной консоли
- В облачной консоли выберите
Меню навигации > API и службы > Включенные API и службы .
- На панели управления API и сервисы нажмите + ВКЛЮЧИТЬ API И СЕРВИСЫ, чтобы просмотреть доступные API.
На странице API и сервисы вы можете найти API несколькими способами. Если вы знаете имя API, вы можете ввести его в поле «Поиск API и сервисов» вверху страницы. Вы также можете фильтровать API по категориям с помощью фильтров сбоку страницы.
- В меню КАТЕГОРИЯ выберите «Машинное обучение» , чтобы отображались только API-интерфейсы машинного обучения.
- В разделе API машинного обучения выберите Cloud Natural Language API, чтобы просмотреть подробную информацию об этом API.
- Нажмите ВКЛЮЧИТЬ , чтобы включить этот API в соответствующем проекте.
Когда вы включаете API, отображается страница обзора API. Вы можете просмотреть показатели использования этого API, в которых очень мало информации, поскольку вы недавно включили API.
В будущей лаборатории вы узнаете больше о том, как создавать учетные данные, но если вам интересно сейчас, нажмите «СОЗДАТЬ УЧЕТНЫЕ ДАННЫЕ» , а затем ответьте на представленные вопросы.
- Нажмите «УПРАВЛЕНИЕ» , чтобы вернуться к обзору на предыдущем шаге.
- Чтобы попробовать API (даже до того, как вы его включите), нажмите ПОПРОБУЙТЕ ЭТОТ API .
Обычно это приводит вас на страницу документации API. Однако для некоторых API нет возможности немедленно опробовать API, поскольку у него много разных методов. Именно так обстоит дело с Cloud Natural Language API.
- Выберите метод
analyzeEntitites
.
Вы должны увидеть веб-страницу с подробной информацией о методах API и панель «Попробуйте этот API» .
- Чтобы попробовать образец запроса, добавьте объект
document
в поле «Тело запроса» с этими параметрами. Щелкните значок + , чтобы развернуть параметры поля. - В поле
content:
» введите текст для анализа.
В этом примере используется Michelangelo Caravaggio, Italian painter, is known for 'The Calling of Saint Matthew'.
- В поле
type:
выберитеPLAIN_TEXT
.
Тело запроса должно выглядеть следующим образом:
Более подробную информацию о каждом параметре можно найти в документации.
- Снимите флажок Google OAuth 2.0 и нажмите «Выполнить», чтобы получить ответ с подробной информацией об объектах.
- Снимите флажок «Ключ API» и снова нажмите «Выполнить» .
Когда вы выполните запрос на этот раз, вы получите подобную этой ошибке, поскольку для запуска API требуются учетные данные.
- Установите флажок Google OAuth 2.0 и снова нажмите «Выполнить» .
OAuth 2.0 предоставляет разрешения API для вашей учетной записи и отображает предупреждение.
Если вы разрешите доступ, вы получите тот же ответ, что и при использовании ключей API. Если вы используете API в приложении и вам необходимо предоставить доступ лицам, знающим их учетные данные, вам необходимо использовать OAuth 2.0. Если приложению достаточно доступа к API для пользователя, вместо этого вы можете использовать ключи API.
3. Просматривайте метрики API с помощью обозревателя метрик.
Вы можете просмотреть историю вызовов для любого отдельного API на странице обзора API, как показано на шаге 6 раздела API доступа из облачной консоли. Однако, чтобы увидеть больше метрик для всего использования API, используйте Обозреватель метрик.
- В разделе «Операции »
В меню навигации выберите Мониторинг > Обозреватель метрик .
- В меню «Тип ресурса» выберите «Потребляемый API» в качестве типа метрики. (Если вы его не видите, снимите флажок «Показывать только активный» .)
- В меню «Метрика» выберите одну из отдельных метрик для API, например «Количество запросов» , чтобы узнать, сколько API было вызвано за определенный период.
- Для дальнейшей настройки вывода установите агрегатор и настройте период времени.
4. Используйте площадку OAuth 2.0, чтобы попробовать API
Вы также можете использовать OAuth 2.0 Playground, чтобы опробовать API Google. С помощью OAuth 2.0 Playground вы можете выбрать API, авторизовать его, а затем отправлять запросы и просматривать ответы в окне консоли OAuth 2.0 Playground.
- Откройте игровую площадку OAuth 2.0 .
- Нажмите Cloud Natural Language API > https://www.googleapis.com/auth/cloud-language > https://www.googleapis.com/auth/cloud-platform > Авторизовать API .
- При необходимости войдите в свою учетную запись Google и нажмите «Разрешить» , чтобы получить код авторизации.
- Нажмите «Код авторизации Exchange для токенов» .
Теперь вы можете сделать запрос API.
- Нажмите «Список возможных операций», чтобы просмотреть все возможные вызовы API.
Ранее вы открыли информационную страницу для документа analyzeEntities
API естественного языка и видите, что URL-адрес HTTP-запроса:
https://language.googleapis.com/v1beta2/documents:analyzeEntities
Это POST-запрос.
- Введите информацию URI запроса и добавьте тело запроса.
Вы можете использовать то же тело, которое вы использовали в API Explorer.
- Нажмите «Закрыть» > «Отправить запрос» .
Вы должны получить результаты, похожие на это изображение:
Не стесняйтесь экспериментировать с другими API на игровой площадке OAuth 2.0.
5. Очистить
Иметь неограниченный ключ API для проектов — плохая практика . Если кто-то получит к нему доступ, этот человек сможет использовать его без дополнительной аутентификации.
Чтобы удалить этот ключ API:
- Нажмите
Меню навигации > API и услуги > Учетные данные .
- В разделе «Ключи API» выберите ключ, который нужно удалить, и нажмите кнопку
.
- Аналогичным образом, вместо того, чтобы беспокоиться о том, что закрытый ключ вашей учетной записи службы незащищен, в разделе «Учетные записи служб » выберите учетную запись службы, которую нужно удалить, а затем нажмите
.
6. Поздравления
Поздравляем! Вы узнали, как искать и выбирать API Google, а также просматривать их показатели.
О практической работе
1. Прежде чем начать
В этой лаборатории кода показано, как искать и выбирать API Google, а также просматривать метрики API.
Предварительные условия
- Возможность навигации по Google Cloud Console.
Что вы узнаете
- Как искать и выбирать API с помощью библиотеки Google Cloud API и игровой площадки OAuth 2.0 .
- Как просмотреть метрики API с помощью обозревателя метрик и облачных API и сервисов.
Что вам понадобится
- Учетная запись Google, например учетная запись Gmail или учетная запись Google Workspace .
- Доступ к платежному аккаунту Cloud или кредитной карте для использования бесплатной пробной версии .
2. Доступ к API из облачной консоли
- В облачной консоли выберите
Меню навигации > API и службы > Включенные API и службы .
- На панели управления API и сервисы нажмите + ВКЛЮЧИТЬ API И СЕРВИСЫ, чтобы просмотреть доступные API.
На странице API и сервисы вы можете найти API несколькими способами. Если вы знаете имя API, вы можете ввести его в поле «Поиск API и сервисов» вверху страницы. Вы также можете фильтровать API по категориям с помощью фильтров сбоку страницы.
- В меню КАТЕГОРИЯ выберите «Машинное обучение» , чтобы отображались только API-интерфейсы машинного обучения.
- В разделе API машинного обучения выберите Cloud Natural Language API, чтобы просмотреть подробную информацию об этом API.
- Нажмите ВКЛЮЧИТЬ , чтобы включить этот API в соответствующем проекте.
Когда вы включаете API, отображается страница обзора API. Вы можете просмотреть показатели использования этого API, в которых очень мало информации, поскольку вы недавно включили API.
В будущей лаборатории вы узнаете больше о том, как создавать учетные данные, но если вам интересно сейчас, нажмите «СОЗДАТЬ УЧЕТНЫЕ ДАННЫЕ» , а затем ответьте на представленные вопросы.
- Нажмите «УПРАВЛЕНИЕ» , чтобы вернуться к обзору на предыдущем шаге.
- Чтобы попробовать API (даже до того, как вы его включите), нажмите ПОПРОБУЙТЕ ЭТОТ API .
Обычно это приводит вас на страницу документации API. Однако для некоторых API нет возможности немедленно опробовать API, поскольку у него много разных методов. Именно так обстоит дело с Cloud Natural Language API.
- Выберите метод
analyzeEntitites
.
Вы должны увидеть веб-страницу с подробной информацией о методах API и панель «Попробуйте этот API» .
- Чтобы попробовать образец запроса, добавьте объект
document
в поле «Тело запроса» с этими параметрами. Щелкните значок + , чтобы развернуть параметры поля. - В поле
content:
» введите текст для анализа.
В этом примере используется Michelangelo Caravaggio, Italian painter, is known for 'The Calling of Saint Matthew'.
- В поле
type:
выберитеPLAIN_TEXT
.
Тело запроса должно выглядеть следующим образом:
Более подробную информацию о каждом параметре можно найти в документации.
- Снимите флажок Google OAuth 2.0 и нажмите «Выполнить», чтобы получить ответ с подробной информацией об объектах.
- Снимите флажок «Ключ API» и снова нажмите «Выполнить» .
Когда вы выполните запрос на этот раз, вы получите подобную этой ошибке, поскольку для запуска API требуются учетные данные.
- Установите флажок Google OAuth 2.0 и снова нажмите «Выполнить» .
OAuth 2.0 предоставляет разрешения API для вашей учетной записи и отображает предупреждение.
Если вы разрешите доступ, вы получите тот же ответ, что и при использовании ключей API. Если вы используете API в приложении и вам необходимо предоставить доступ лицам, знающим их учетные данные, вам необходимо использовать OAuth 2.0. Если приложению достаточно доступа к API для пользователя, вместо этого вы можете использовать ключи API.
3. Просматривайте метрики API с помощью обозревателя метрик.
Вы можете просмотреть историю вызовов для любого отдельного API на странице обзора API, как показано на шаге 6 раздела API доступа из облачной консоли. Однако, чтобы увидеть больше метрик для всего использования API, используйте Обозреватель метрик.
- В разделе «Операции »
В меню навигации выберите Мониторинг > Обозреватель метрик .
- В меню «Тип ресурса» выберите «Потребляемый API» в качестве типа метрики. (Если вы его не видите, снимите флажок «Показывать только активный» .)
- В меню «Метрика» выберите одну из отдельных метрик для API, например «Количество запросов» , чтобы узнать, сколько API было вызвано за определенный период.
- Для дальнейшей настройки вывода установите агрегатор и настройте период времени.
4. Используйте площадку OAuth 2.0, чтобы попробовать API
Вы также можете использовать OAuth 2.0 Playground, чтобы опробовать API Google. С помощью OAuth 2.0 Playground вы можете выбрать API, авторизовать его, а затем отправлять запросы и просматривать ответы в окне консоли OAuth 2.0 Playground.
- Откройте игровую площадку OAuth 2.0 .
- Нажмите Cloud Natural Language API > https://www.googleapis.com/auth/cloud-language > https://www.googleapis.com/auth/cloud-platform > Авторизовать API .
- При необходимости войдите в свою учетную запись Google и нажмите «Разрешить» , чтобы получить код авторизации.
- Нажмите «Код авторизации Exchange для токенов» .
Теперь вы можете сделать запрос API.
- Нажмите «Список возможных операций», чтобы просмотреть все возможные вызовы API.
Ранее вы открыли информационную страницу для документа analyzeEntities
API естественного языка и видите, что URL-адрес HTTP-запроса:
https://language.googleapis.com/v1beta2/documents:analyzeEntities
Это POST-запрос.
- Введите информацию URI запроса и добавьте тело запроса.
Вы можете использовать то же тело, которое вы использовали в API Explorer.
- Нажмите «Закрыть» > «Отправить запрос» .
Вы должны получить результаты, похожие на это изображение:
Не стесняйтесь экспериментировать с другими API на игровой площадке OAuth 2.0.
5. Очистить
Иметь неограниченный ключ API для проектов — плохая практика . Если кто-то получит к нему доступ, этот человек сможет использовать его без дополнительной аутентификации.
Чтобы удалить этот ключ API:
- Нажмите
Меню навигации > API и услуги > Учетные данные .
- В разделе «Ключи API» выберите ключ, который нужно удалить, и нажмите кнопку
.
- Аналогичным образом, вместо того, чтобы беспокоиться о том, что закрытый ключ вашей учетной записи службы незащищен, в разделе «Учетные записи служб » выберите учетную запись службы, которую нужно удалить, а затем нажмите
.
6. Поздравления
Поздравляем! Вы узнали, как искать и выбирать API Google, а также просматривать их показатели.