Как настроить Places API (новый)

Разработчики из Европейской экономической зоны (ЕЭЗ)

Если ваш платежный адрес находится в Европейской экономической зоне, то с 8 июля 2025 года на использование вами Сервисов будут распространяться Условия использования платформы Google Карт для ЕЭЗ. Функции зависят от региона. Подробнее…

В этом документе описаны шаги, которые необходимо выполнить, чтобы начать использовать Places API (New).

Требования

В этом разделе рассказывается, как настроить аккаунт Google Cloud и облачный проект с включенными платежными функциями. Вы также должны знать, как взимается плата за использование Places API (New).

1. Ознакомьтесь с информацией о выставлении счетов и стоимости использования в статье Статистика использования и оплата Places API (новый).

2. Убедитесь, что у вас есть аккаунт Google Cloud.

   Войдите в консоль Google Cloud.
   Примечание. Если вы новый пользователь и у вас нет аккаунта Google Cloud, то есть вы не можете войти в консоль, прочитайте статью Начало работы с платформой Google Карт.

3. Убедитесь, что у вас есть проект Google Cloud с включенными платежными функциями.

   Перейти на страницу "Оплата"
   Примечание. Если вы новый пользователь и у вас нет облачного проекта Google Cloud, ознакомьтесь со статьей Начало работы с платформой Google Карт.
1. Выберите проект, чтобы открыть страницу Billing (Оплата).

2. На странице Оплата:

   • Если для выбранного проекта уже включена оплата и у вас только один платежный аккаунт, откроется страница Оплата.
   • Если у вас несколько платежных аккаунтов, нажмите Открыть этот аккаунт. Появится страница с информацией о платежном аккаунте, связанном с проектом.
   • Если у вас есть платежный аккаунт, но он не связан с проектом, вам будет предложено связать их.
   • Если у вас нет платежного аккаунта или вы хотите создать новый, выберите Manage Billing Accounts (Управление платежными аккаунтами). Подробнее о том, как создать платежный аккаунт Cloud для самостоятельного использования…

Включение API

Чтобы использовать Places API (новая версия), включите его в облачном проекте Google Cloud в консоли Google Cloud или с помощью команды gcloud.

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

Чтобы включить API, выполните следующие действия:

Консоль

1. Откройте страницу продукта в консоли Google Cloud:

   Включить Places API (новую версию)

2. Нажмите Включить.

   Примечание. Если API уже включен, вместо кнопки Включить вы увидите кнопку Управление.

gcloud

gcloud services enable \
    --project "PROJECT" \
    "places.googleapis.com"

Прочитайте статьи о Google Cloud SDK, установке Cloud SDK и следующих командах:

• gcloud services enable
• gcloud services disable

Получите ключ API для использования с Places API (новая версия)

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

Продукты платформы Google Карт защищены от несанкционированного использования, поскольку принимают только те вызовы API, которые содержат ключ API или токен OAuth. Сначала нужно получить ключ API. Если вы хотите использовать токен OAuth, ознакомьтесь с разделом Как создать токен OAuth.

Ключ API – это уникальная буквенно-цифровая строка, которая связывает ваш платежный аккаунт Cloud и облачный проект Google Cloud с запросом, который ваше приложение отправляет в API или SDK платформы Google Карт. Чтобы создать ключ или добавить API или SDK к существующему ключу, следуйте инструкциям ниже.

Консоль

1. Откройте страницу Google Maps Platform > Keys & Credentials (Платформа Google Карт > Ключи и учетные данные).

   Перейти на страницу "Ключи и учетные данные"

2. Если появится запрос, выберите проект.

3. Выполните одно из следующих действий:

   • Создайте ключ.

     1. Нажмите Создать учетные данные > Ключ API.
     2. На панели Create API key (Создать ключ API) откройте список Select API restrictions (Выбрать ограничения API).
     3. Очистите все API, которые не нужны этому ключу, и убедитесь, что Places API (New) по-прежнему выбран.
     4. Нажмите Создать. На панели появится новый ключ API.

   • Использовать существующий ключ:

     1. Нажмите на название ключа.
     2. В списке Select API restrictions (Выбрать ограничения API) выберите Places API (New) (Places API (новый)).
     3. Нажмите Сохранить.

   Выбор API не означает его включение. Убедитесь, что Places API (New) включен на странице библиотеки API.

4. Чтобы посмотреть строку ключа позже, перейдите на страницу Ключи и учетные данные и нажмите Показать ключ.

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

gcloud

В следующих командах замените PROJECT_ID идентификатором своего проекта.

• Создайте новый ключ. Выполните следующую команду, заменив DISPLAY_NAME на название ключа.

  gcloud services api-keys create \
      --project="PROJECT_ID" \
      --display-name="DISPLAY_NAME" \
      --api-target=service=places.googleapis.com

  Прочитайте статьи о Google Cloud SDK, установке Cloud SDK и следующих командах:

  • gcloud services api-keys create

• Использовать существующий ключ. Выполните следующую команду, заменив KEY_ID идентификатором ключа. Флаг --append сохраняет API, которые уже разрешены ключом. Если его не указать, команда заменит их.

  gcloud services api-keys update KEY_ID \
      --project="PROJECT_ID" \
      --append \
      --api-target=service=places.googleapis.com

  Прочитайте статьи о Google Cloud SDK, установке Cloud SDK и следующих командах:

  • gcloud services api-keys update
  • gcloud services api-keys list

  Идентификатор ключа – это не строка ключа и не отображаемое название. Чтобы найти его, выполните команду gcloud services api-keys list --project="PROJECT_ID". Идентификатор – это последняя часть поля name: projects/PROJECT_NUMBER/locations/global/keys/KEY_ID.

Чтобы посмотреть строку ключа, выполните команду gcloud services api-keys get-key-string KEY_ID --project="PROJECT_ID".

Как отправить запрос к API

Выполните запрос к Places API (New), чтобы получить ответ в формате JSON для текстового поиска по строке "Spicy Vegetarian Food in Sydney, Australia". Вы должны включать буквенно-цифровую строку ключа API в каждый запрос и использовать HTTPS для запросов, содержащих ключ API.

1. Нажмите API_KEY в коде ниже, чтобы вставить буквенно-цифровую строку ключа:

   curl -X POST -d '{
     "textQuery" : "Spicy Vegetarian Food in Sydney, Australia"
   }' \
   -H 'Content-Type: application/json' -H 'X-Goog-Api-Key: API_KEY' \
   -H 'X-Goog-FieldMask: places.displayName,places.formattedAddress,places.priceLevel' \
   'https://places.googleapis.com/v1/places:searchText'

2. Нажмите на значок копирования в примере кода , чтобы скопировать команду curl.
3. Вставьте команду в окно терминала и запустите ее.

Вы получите объект JSON следующего вида:

{
  "places": [
    {
      "name": "places/ChIJs5ydyTiuEmsR0fRSlU0C7k0",
      "id": "ChIJs5ydyTiuEmsR0fRSlU0C7k0",
      "types": [
        "vegan_restaurant",
        "vegetarian_restaurant",
        "meal_takeaway",
        "restaurant",
        "food",
        "point_of_interest",
        "establishment"
      ],
      "nationalPhoneNumber": "0433 479 794",
      "internationalPhoneNumber": "[phone]",
      "formattedAddress": "29 King St, Sydney NSW 2000, Australia",
      "addressComponents": [
        {
          "longText": "29",
          "shortText": "29",
          "types": [
            "street_number"
          ],
          "languageCode": "en-US"
        },
  ...
}

Как применить ограничения для ключа API

Внимание! Ключ API без ограничений можно использовать для отправки запросов к любому сервису платформы Google Карт, включая Places API (New). Вы несете финансовую ответственность за расходы, вызванные злоупотреблением ключами API без ограничений.

Мы настоятельно рекомендуем ограничивать использование ключей API только теми API и приложениями, которым они необходимы. Ограничение ключей API повышает безопасность вашего приложения, защищая его от нежелательных запросов. Для ключей API поддерживаются два типа ограничений:

• Ограничения API определяют, какие SDK и API можно вызывать с помощью ключа API. При создании ключа в консоли или gcloud CLI необходимо задать хотя бы одно ограничение API.
• Ограничения для приложений определяют, какие сайты, IP-адреса или приложения могут использовать ключ API.

Подробнее о том, как ограничить использование ключей API…

Как создать токен OAuth

Places API (New) поддерживает аутентификацию OAuth 2.0. Google поддерживает распространенные сценарии OAuth 2.0, например для веб-сервера.

В этом документе описывается, как передать токен OAuth в вызов Places API (New) в среде разработки. Дополнительную информацию об использовании OAuth в рабочей среде можно найти в статье Способы аутентификации в Google.

Вы можете вызывать Google Maps API напрямую, отправляя запросы к API на сервер, или использовать клиентские библиотеки, чтобы упростить код. Google Карты предоставляют клиентские библиотеки для Go, Java, Node.js и Python. Подробнее о клиентских библиотеках Places API (New)…

Общая информация о протоколе OAuth

Создавать токены доступа и управлять ими с помощью OAuth можно несколькими способами в зависимости от среды развертывания.

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

Вы также можете интегрировать Places API (New) в мобильное приложение для Android или iOS. Подробную информацию об использовании OAuth и управлении токенами доступа для разных сред развертывания можно найти в статье Использование OAuth 2.0 для доступа к API Google.

Области действия OAuth

Чтобы использовать OAuth с Places API (новая версия), необходимо назначить токену OAuth следующую область действия:

https://www.googleapis.com/auth/cloud-platform

Пример. Попробуйте вызовы REST API в локальной среде разработки

Если у вас нет среды, которая генерирует токены, и вы хотите попробовать Places API (New) с токеном OAuth, следуйте инструкциям в этом разделе.

В этом примере показано, как использовать токен OAuth, предоставленный Application Default Credentials (ADC), для выполнения вызова. Подробнее о том, как выполнить аутентификацию с помощью клиентских библиотек с использованием ADC для вызова API Google…

Приведенную ниже процедуру REST следует использовать только для разработки или тестирования, но не для рабочей среды.

Требования

Прежде чем отправлять REST-запрос с помощью ADC, предоставьте ADC учетные данные, используя CLI gcloud:

1. Установите и инициализируйте интерфейс командной строки gcloud. Подробнее о том, как установить gcloud CLI…

2. Выполните аутентификацию с помощью интерфейса командной строки gcloud:

   gcloud auth application-default login

3. Завершите процесс входа, чтобы сохранить учетные данные в локальном файле учетных данных, используемом ADC.

Подробнее о том, как настроить ADC для локальной среды разработки…

Как выполнить REST-запрос

В этом примере вы передаете два заголовка запроса:

• Передайте токен OAuth в заголовке Authorization, используя следующую команду для создания токена:

  gcloud auth application-default print-access-token

  Возвращенный токен имеет область действия https://www.googleapis.com/auth/cloud-platform.

• Передайте идентификатор или название проекта Google Cloud, для которого включена оплата, в заголовке X-Goog-User-Project.

Чтобы вызвать Places API (New) с помощью токена OAuth, выполните следующие действия:

1. В следующем примере кода замените PROJECT_ID на идентификатор проекта Google Cloud:

   curl -X POST -d '{
   "textQuery" : "Spicy Vegetarian Food in Sydney, Australia"
   }' \
   -H "Content-Type: application/json" \
   -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
   -H "X-Goog-User-Project: PROJECT_ID" \
   -H "X-Goog-FieldMask: places.displayName,places.formattedAddress" \
   "https://places.googleapis.com/v1/places:searchText"

2. Чтобы скопировать команду curl, нажмите Копировать в примере кода.

3. Вставьте команду в окно терминала и запустите ее.

Вы получите объект JSON:

{
  "places": [
    {
      "name": "places/ChIJs5ydyTiuEmsR0fRSlU0C7k0",
      "id": "ChIJs5ydyTiuEmsR0fRSlU0C7k0",
      "types": [
        "vegan_restaurant",
        "vegetarian_restaurant",
        "meal_takeaway",
        "restaurant",
        "food",
        "point_of_interest",
        "establishment"
      ],
      "nationalPhoneNumber": "0433 479 794",
      "internationalPhoneNumber": "[phone]",
      "formattedAddress": "29 King St, Sydney NSW 2000, Australia",
      "addressComponents": [
        {
          "longText": "29",
          "shortText": "29",
          "types": [
            "street_number"
          ],
          "languageCode": "en-US"
        },
  ...
}

Устранение неполадок

Если в ответ на запрос вы получаете сообщение об ошибке о том, что API не поддерживает учетные данные конечных пользователей, ознакомьтесь с разделом Устранение неполадок с настройкой ADC.

Дальнейшие действия

Теперь, когда вы включили Places API (New) и настроили ключ API, прочитайте статью О Places API (New), чтобы узнать больше о том, как использовать Places API (New).