Прежде чем начинать работу, проверьте, выполнены ли все инструкции из статьи Требования и одобрен ли доступ к Business Profile API для вашего проекта.
Включение API
В настоящее время с сервисом "Профиль компании" связаны следующие API, которые необходимо включить в Google API Console:
- Google My Business API;
- My Business Account Management API;
- My Business Lodging API;
- My Business Place Actions API;
- My Business Notifications API.
- My Business Verifications API
- My Business Business Information API;
- My Business Q&A API.
Как включить API
Вы выполнили все инструкции из статьи Требования и получили доступ к API, но ссылка не работает? Тогда активируйте API вручную.
Чтобы включить API для своего проекта, выполните следующие действия:
- Откройте библиотеку API в Google API Console. Если появится меню выбора проекта, укажите существующий проект или создайте новый. В библиотеке API появится список всех доступных API, упорядоченный по семействам продуктов и популярности.
- Если нужный API не отображается в списке, попробуйте его найти с помощью поиска.
- Выберите нужный API и нажмите кнопку Включить.
- Если будет предложено задать платежные настройки, сделайте это.
- Если появятся условия использования API, примите их.
Если вы пользователь Google Workspace, убедитесь, что профиль компании в Google включен для вашего аккаунта в организации Google Workspace. В противном случае при использовании GBP API появится сообщение "Ошибка 403 – ДОСТУП ЗАПРЕЩЕН".
Как запросить идентификатор клиента OAuth 2.0
Поскольку ваше приложение обращается к защищенным данным, которых нет в открытом доступе, необходим идентификатор клиента OAuth 2.0. С его помощью приложение сможет запрашивать от имени своих пользователей доступ к данным об адресах вашей организации.
Ваше приложение должно добавлять токен OAuth 2.0 во все запросы Business Profile API, обращающиеся к закрытым данным пользователей.
Если вы не сделали это ранее, перейдите в раздел "Учетные данные" в Google API Console и нажмите Создать учетные данные > Идентификатор клиента OAuth. Если вы уже создали учетные данные, то на странице Учетные данные должен отображаться ваш идентификатор клиента. Нажмите на идентификатор клиента, чтобы просмотреть подробные сведения, такие как секретный код клиента, URI перенаправления, исходный адрес JavaScript и адрес электронной почты.
Основы REST
Совершать вызовы API можно двумя способами:
- Отправлять HTTP-запросы и обрабатывать ответы.
- Использовать клиентские библиотеки.
Если вы не хотите использовать клиентские библиотеки, вам нужно владеть основами работы с REST.
REST – это стиль архитектуры ПО, обеспечивающий единообразие и удобство формирования операций по запрашиванию и изменению данных.
REST – это сокращение от Representational State Transfer (передача состояния представления). В контексте Google API термин REST относится к использованию HTTP-команд для получения или изменения представлений данных, хранящихся в сервисах Google.
В RESTful-системах ресурсы хранятся в хранилище данных. Клиент отправляет серверу запрос на выполнение определенного действия, например на создание, получение, обновление или удаление ресурса, а сервер выполняет это действие и отправляет ответ. Обычно ответ является представлением указанного ресурса.
При работе с RESTful API-интерфейсами, используемыми Google, клиент указывает нужное действие с помощью HTTP-команды, например GET, POST, PUT или DELETE. Клиент указывает ресурс с помощью глобального уникального идентификатора ресурсов (URI) в следующей форме:
https://apiName.googleapis.com/apiVersion/resourcePath?parameters
Поскольку у всех ресурсов API есть уникальные URI с HTTP-доступом, стиль REST обеспечивает кеширование данных. Он оптимизирован для работы с распределенной веб-инфраструктурой.
Определения методов в документации стандартов HTTP 1.1 могут пригодиться вам при разработке. Они содержат спецификации запросов GET, POST, PUT и DELETE.
REST в Business Profile API
Операции Business Profile API полностью соответствуют HTTP-командам REST.
Конкретный формат, используемый интерфейсом Business Profile API, характеризуется следующим URI:
https://apiName.googleapis.com/apiVersion/resourcePath?parameters
Полный список URI для всех поддерживаемых операций API доступен в справочной документации по Business Profile API.
Путь к ресурсу зависит от конечной точки.
Пример пути к ресурсу, представляющему аккаунт:
accounts/accountId
Пример пути к ресурсу, представляющему адрес:
locations/locationId
Основы JSON
Business Profile API возвращает данные в формате JSON.
JSON (JavaScript Object Notation) – это популярный формат данных, независимый от языков программирования. Он позволяет представлять произвольные структуры данных в виде простого текста. Более подробная информация доступна на сайте json.org.
Создание простого HTTP-запроса
Инструмент OAuth 2.0 Playground позволяет экспериментировать с запросами Business Profile API. Поскольку интерфейсы Business Profile API не являются публичными, вам нужно будет выполнить некоторые действия, чтобы получить доступ к OAuth 2.0 Playground. Вам понадобится идентификатор клиента для веб-приложения.
- Перейдите в Google API Console и откройте свой проект. Если у вас нет идентификатора клиента OAuth для веб-приложений, создайте его согласно этим инструкциям:
- В раскрывающемся меню Создать учетные данные выберите пункт Идентификатор клиента OAuth.
- В пункте Тип приложения выберите Веб-приложение.
В качестве URI перенаправления укажите следующую строку:
https://developers.google.com/oauthplayground
- Нажмите Создать.
- Скопируйте идентификатор клиента в буфер обмена.
- Перейдите в OAuth 2.0 Playground.
- Нажмите на значок настроек и внесите следующие изменения в конфигурацию:
- В пункте OAuth flow (Процесс OAuth) выберите значение Client-side (На стороне клиента).
- Выберите вариант Use your own OAuth credentials (Использовать собственные учетные данные OAuth).
- Вставьте свой идентификатор клиента OAuth из буфера обмена.
- Закройте окно настроек.
В пункте "Step 1 – Select & authorize APIs" (Шаг 1 – Выберите и авторизуйте API) найдите поле Input your own scopes (Указать область действия самостоятельно) и скопируйте в него следующую строку, обозначающую область действия Business Profile API:
https://www.googleapis.com/auth/business.manage
- Нажмите Authorize APIs (Авторизовать API).
- Когда появится запрос, нажмите Accept (Принять).
-
В пункте "Step 2 – Configure request to API" (Шаг 2 – Настройте запрос к API) найдите поле Request URI (URI запроса) и скопируйте в него следующий URI:
https://mybusinessaccountmanagement.googleapis.com/v1/accounts
- Нажмите Send the request (Отправить запрос). В ответе должен быть указан статус
200 OK.
Подробнее об отправке запросов разных типов читайте в справочной документации по Business Profile API.
Клиентские библиотеки
Клиентские библиотеки Business Profile API используются для работы с Business Profile API. Они поддерживают функции, стандартные для всех Google API, например HTTP-передачу, обработку ошибок, аутентификацию, обработку данных в формате JSON.
Скачать клиентские библиотеки можно здесь.