Как помочь пользователям плагина платформы Google Карт быстро начать работу

Окно с сообщением об успешной работе виджета

Эта статья предназначена для разработчиков плагинов платформы Google Карт для WordPress, Shopify, Magento и других платформ. В ней описано, как помочь пользователям плагина быстро адаптироваться к платформе Google Карт и создать ключ API.

Ключ API, который ваш плагин должен отправлять с каждым запросом в платформу Google Карт, связан с аккаунтом Google пользователя и платежными данными. Он открывает доступ к функциям создания карт в плагине.

Чтобы помочь пользователям плагина быстро создать ключ API, предоставьте ссылку или кнопку, с помощью которой можно запустить Quick Start Widget – удобное всплывающее окно с пошаговыми инструкциями. Пользователь, работающий с Quick Start Widget, остается на вашей платформе. Ему не нужно переходить в консоль Google Cloud и выполнять задачи в нескольких окнах.

Как запустить Quick Start Widget

Quick Start Widget – это просто веб-страница, размер окна которой можно изменить с помощью вызова JavaScript window.open. Пример:

<script>
  function openPopupWindow() {
    var winWidth=570;
    var winHeight=700;
    var left = (screen.width-winWidth)/2;
    var top = (screen.height-winHeight)/2;

    window.open('https://console.cloud.google.com/google/maps-hosted', 'Quick Start Widget',
    'resizable=yes,width='+winWidth+',height='+winHeight+',left='+left+',top='+top);
      return false;
  }
</script>

<!-- CTA to generate Google Maps API Key -->
<button type="button" onClick="openPopupWindow()" style="color: white; background-color: #1a73e8" href="#">
    Get an API Key
</button>

Посмотрите, как это работает:

Когда пользователь нажимает эту кнопку, Quick Start Widget открывается во всплывающем окне и по мере работы пользователя с ним:

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

Если у пользователя плагина уже есть аккаунт Google и проект, виджет откроет страницу "Учетные данные" в консоли Google Cloud, где можно получить существующий ключ API или создать новый.

Вы можете предоставить пользователям плагина ссылку на статью о Quick Start Widget с подробной информацией.

Часто задаваемые вопросы

Нужно ли платить за использование Quick Start Widget?

Нет. Quick Start Widget предоставляется бесплатно всем разработчикам, чтобы упростить адаптацию новых пользователей платформы Google Карт.

Quick Start Widget можно использовать только для WordPress и Shopify?

Quick Start Widget можно использовать для любого стороннего сайта – не только для интернет-магазинов и конструкторов сайтов.

Доступны ли сторонней платформе платежные данные, указанные пользователем?

После аутентификации в Google платежные и другие данные пользователя остаются доступными только ему. У сторонних платформ и разработчиков плагинов нет доступа к этой информации.

Можно ли использовать имеющийся проект и ключ API?

Если у вас уже есть аккаунт платформы Google Карт, Quick Start Widget направит вас в консоль Google Cloud, где можно использовать существующий ключ API или создать новый.

Как пользователи плагина защищают свои ключи API?

Сведения о защите ключа API можно найти в статье с рекомендациями по обеспечению безопасности доступа к API. Кроме того, после использования Quick Start Widget пользователи получают электронное письмо с инструкциями по защите ключа API и ссылкой на консоль Google Cloud.