帮助 Google Maps Platform 插件用户快速入门

表示操作成功的 widget 窗口

如果您要为 WordPress、Shopify、Magento 等平台开发 Google Maps Platform 插件,请参阅本主题,了解如何帮助插件用户快速上手使用 Google Maps Platform 和生成 API 密钥。

插件在向 Google Maps Platform 发送每个请求时都需要将 API 密钥与请求一同发送;API 密钥与用户的 Google 账号和结算信息相关联,可以解锁插件中的地图构建功能。

为了帮助插件用户快速生成 API 密钥,请提供用于启动快速入门 widget 的链接或按钮。该 widget 是一个便捷的弹出式窗口,可引导用户完成一些简单的步骤。通过快速入门 widget,插件用户在您的平台内便可执行相关任务,您不必将他们引导至 Google Cloud 控制台,因此无需打开多个窗口。

启动快速入门 widget

快速入门 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>

查看实际运作方式:

用户点击该按钮后,快速入门 widget 会在一个弹出式窗口中打开,并随着用户在该 widget 中的进度执行以下操作:

  • 如果用户没有 Google 账号和项目,则会创建账号和项目。
  • 启用 Google Maps Platform API。
  • 生成 API 密钥,供用户复制并粘贴到插件配置中。

如果插件用户已有 Google 账号和项目,该 widget 会将用户转到 Google Cloud 控制台中的“凭据”页面,在这里他们可以获取现有 API 密钥或创建新密钥。

您可以引导插件用户参阅快速入门 widget 简介主题来了解更多信息。

常见问题解答

使用快速入门 widget 需要付费吗?

不需要。快速入门 widget 可供所有开发者免费使用,帮助简化 Google Maps Platform 入门流程。

快速入门 widget 只能在 WordPress 和 Shopify 平台上使用吗?

快速入门 widget 可在任何第三方网站上使用,而不仅限于网站开发工具或电子商务网站。

第三方平台能否查看用户输入的结算信息?

用户经过 Google 身份验证后,只有他们自己才能访问自己的结算信息和其他信息。第三方平台和插件开发者无法访问这些信息。

我可以使用现有的项目和 API 密钥吗?

如果您已有 Google Maps Platform 账号,快速入门 widget 会将您重定向到 Google Cloud 控制台,在这里您可以使用现有的 API 密钥或生成新的 API 密钥。

插件用户如何保护自己的 API 密钥?

API 安全性最佳实践主题提供了有关保护 API 密钥的指南。使用快速入门 widget 后,用户还会收到一封电子邮件,其中包含相关说明和指向 Google Cloud 控制台的链接,以便用户保护自己的 API 密钥。