WordPress、Shopify、Magento といったプラットフォーム用の Google Maps Platform プラグインを開発している方向けに、プラグインのユーザーを Google Maps Platform に素早くオンボーディングし、API キーを生成する方法を解説します。
プラグインは、Google Maps Platform へのリクエストを行うたびに API キーを送信する必要があります。API キーはユーザーの Google アカウントおよびお支払い情報と紐付けられており、プラグインを通して地図作成機能にアクセスするために必要です。
プラグインのユーザーが 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 Maps Platform の各 API を有効化します。
- API キーを生成し、ユーザーにプラグイン設定へコピー&ペーストしてもらいます。
プラグインのユーザーが Google アカウントおよびプロジェクトをすでに持っている場合、Google Cloud コンソールの [認証情報] ページが表示され、ユーザーはそこで既存の API キーを取得するか、新しいキーを作成することができます。
プラグインのユーザー向けの詳細情報としては、クイック スタート ウィジェットについてを案内してください。
よくある質問
クイック スタート ウィジェットを使用するのに料金はかかりますか?
いいえ。クイック スタート ウィジェットは無料で、Google Maps Platform のオンボーディングを簡素化するためにどなたでもご利用いただけます。
クイック スタート ウィジェットを使用できるのは WordPress と Shopify だけですか?
クイック スタート ウィジェットは、ウェブサイト作成ツールや e コマースサイトに限らず、あらゆるサードパーティ ウェブサイトでご利用いただけます。
ユーザーが入力したお支払い情報をサードパーティ プラットフォーム側が参照することはできますか?
Google での認証後、お支払い情報やその他の情報を参照できるのはユーザー本人のみです。サードパーティのプラットフォームやプラグインのデベロッパーが情報を参照することはできません。
既存のプロジェクトと API キーを使用することはできますか?
すでに Google Maps Platform のアカウントをお持ちの場合、クイック スタート ウィジェットを起動すると Google Cloud コンソールが表示され、そこで既存の API キーを取得するか、新しいキーを作成することができます。
プラグイン ユーザーは API キーのセキュリティ面でどういった点に注意すべきですか?
API キーのセキュリティ確保については、API の保護に関するベスト プラクティスをご覧ください。また、クイック スタート ウィジェットを使用したユーザーには、API キーのセキュリティ確保のための案内と Google Cloud コンソールへのリンクが記載されたメールが届きます。