Google 地圖平台外掛程式使用者快速上手指南

成功設定的小工具視窗

如果您要開發 WordPress、Shopify 和 Magento 等平台的 Google 地圖平台外掛程式,建議參考這個主題,瞭解如何協助這項外掛程式的使用者快速上手,以及產生 API 金鑰。

API 金鑰會與使用者的 Google 帳戶和帳單資訊相連結,且可讓使用者存取外掛程式中的地圖建構功能。外掛程式每次向 Google 地圖平台提出要求時,必須一併傳送這組 API 金鑰。

為協助外掛程式使用者快速產生 API 金鑰,請提供可啟動快速入門小工具的連結或按鈕。小工具會在彈出式視窗中顯示,引導使用者完成幾個簡單步驟,非常方便。此外,快速入門小工具也不會將外掛程式使用者連到 Google Cloud 控制台,而是讓他們留在原本的平台上,透過多個視窗執行工作。

啟動快速入門小工具

快速入門小工具是一個網頁,透過 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>

實際運作情況:

使用者點選按鈕後,快速入門小工具會在彈出式視窗中開啟,並在使用者完成所有步驟時,執行下列動作:

  • 建立 Google 帳戶和專案 (如果還沒有)。
  • 啟用 Google 地圖平台 API。
  • 產生 API 金鑰,使用者可複製並貼進外掛程式的設定。

如果外掛程式使用者已有 Google 帳戶和專案,小工具會導向 Google Cloud 控制台的「憑證」頁面,使用者可在該處取得現有的 API 金鑰,或建立新金鑰。

您可以將外掛程式使用者引導至「關於快速入門小工具」主題,讓他們進一步瞭解相關資訊。

常見問題

使用快速入門小工具需要付費嗎?

不用。所有開發人員都能免費使用快速入門小工具,讓 Google 地圖平台的新手上路流程變得更加簡單。

快速入門小工具只能用於 WordPress 和 Shopify 嗎?

快速入門小工具適用於任何第三方網站,不侷限於網站製作工具或電子商務網站。

第三方平台可以查看使用者輸入的帳單資訊嗎?

使用者向 Google 完成驗證後,帳單及其他相關資訊只有本人才能存取,第三方平台和外掛程式開發人員沒有存取權限。

我可以使用現有的專案和 API 金鑰嗎?

如果已有 Google 地圖平台帳戶,快速入門小工具會將您重新導向至 Google Cloud 控制台,讓您使用現有的 API 金鑰或產生新金鑰。

外掛程式使用者如何保護 API 金鑰?

我們在「API 安全性最佳做法」主題中,提供有關保護 API 金鑰的指引。啟用快速入門小工具後,使用者還會收到電子郵件,其中包含相關說明和前往 Google Cloud 控制台的連結,以便使用者保護自己的 API 金鑰。