バージョニング

Google Maps JavaScript API チームは定期的に API に新機能を追加し、不具合修正やパフォーマンス改善を行っています。このページでは、テスト環境または実稼働環境のアプリケーションに利用可能な API のバージョンを説明します。API のバージョンには、次の名前が付いています。

  • エクスペリメンタル
  • リリース
  • フローズン

また、このページではアプリケーションのタイプまたは目的に応じてバージョニング方法を選択するためのベストプラクティスを提供します。

バージョンのロールオーバーとバージョン タイプ

Google では、四半期ごとに新しい番号のバージョンを作成し、エクスペリメンタル バージョンとして一般ユーザー向けにリリースします。同時に、前のエクスペリメンタル バージョンがリリース バージョンになり、前のリリース バージョンがフローズン バージョンになります。このプロセスは、バージョン ロールオーバーと呼ばれます。

四半期を通して、Google では継続して不具合修正をエクスペリメンタル バージョンとリリース バージョンに追加します。これらのアップデートは、Google Maps JavaScript API リリースノートに記載されます。

アプリケーションにロードする API バージョンは、Google Maps JavaScript API ブートストラップ リクエストの v パラメータを使って指定できます。次のオプションがサポートされています。

  • エクスペリメンタル バージョン。v=3.exp で指定します。
  • リリース バージョン。v=3 で指定します。
  • 具体的なバージョン番号。v=3.20 または v=3.21 など。

バージョンを明示的に指定しない場合、デフォルトでエクスペリメンタル バージョンを受信します。クライアント ID を指定した Google Maps APIs Premium Plan ユーザーは、デフォルトでリリース バージョンを受信します。

エクスペリメンタル バージョン

エクスペリメンタル バージョン(現在は 3.22)には、公開可能になった最新の機能とバグ修正が逐次含まれます。エクスペリメンタル バージョンに行う変更では、機能の安定性は保証されません。エクスペリメンタル バージョンを使用してアプリケーションを定期的にテストすることをお勧めします。これを行うには、API のロード時に v=3.22 を追加します。最新状態を保ちたい場合、v=3.exp を追加すると、最新の機能が含まれた最新のエクスペリメンタル バージョンを常に受信できます。

次のブートストラップを使用して、エクスペリメンタル バージョンを指定できます。

<script async defer
    src="https://maps.googleapis.com/maps/api/js?v=3.exp
        &key=YOUR_API_KEY&callback=initMap">

リリース バージョン

Google では、機能セットの安定性を確保しながら、リリース バージョンに継続的にバグ修正を適用しています。修正事項は、リリースノートに記載されます。

現在のリリース バージョンは 3.21 です。次のいずれかのブートストラップを使用して、リリース バージョンをリクエストできます。

<script async defer
    src="https://maps.googleapis.com/maps/api/js?v=3
        &key=YOUR_API_KEY&callback=initMap">

<script async defer
    src="https://maps.googleapis.com/maps/api/js?v=3.21
        &key=YOUR_API_KEY&callback=initMap">

フローズン バージョン

Google では、新しい番号のバージョンをリリースすると、前のリリース バージョンを凍結します。これは、これ以上定期的なバグ修正でアップデートしないことを意味します。ただし、たとえば法的な理由で変更が必要な場合などは、変更を行うこともあります。

新しいフローズン バージョンが導入されるごとに、前のフローズン バージョンは廃止されます。廃止されたバージョンを指定すると(v=3.0 など)、常に現在のフローズン バージョンが返されます。

現在のフローズン バージョンは 3.20 です。次のブートストラップを使用して、フローズン バージョンをリクエストできます。

<script async defer
    src="https://maps.googleapis.com/maps/api/js?v=3.20
        &key=YOUR_API_KEY&callback=initMap">

ベストプラクティス

Google Maps JavaScript API チームは、異なるバージョンの API 間の互換性を維持するためにあらゆる取り組みを行っています。しかし、最新のサービスを提供するために、また運用上の理由で、既存の機能に影響する可能性がある変更を行う場合があります。このような場合、特に高度なアプリケーションでは、コードが継続して期待通りに動作するように、Google Maps JavaScript API を使用しているコードの調節が必要となる場合があります。以下に、いくつかの一般的なシナリオ向けに、バージョンの使用についての推奨ベストプラクティスを示します。

高可用性/高トラフィック アプリケーション

安定性と可用性を確保するための追加作業が負担にならない場合

バージョン ロールオーバーにより問題が一切発生しないようにするには、API の現行リリース バージョンの番号を、ブートストラップで明示的に指定することをお勧めします。たとえば、v=3.21 のように指定します。時間の経過に伴ってフローズン バージョンの API に移行することを避けるために、Google Maps JS API v3 の通知と発表のグループで、Google からのバージョン ロールオーバーの通知を購読することが重要です。

バージョン ロールオーバーの実施後は(四半期ごと)、本稼働システムはフローズン バージョンの API をリクエストすることになります。このときに、新しいリリースバージョンの API を使用してアプリケーションをテストするためのステージング環境または開発環境のセットアップをお勧めします。何らかの問題が発生したら、コードで必要な調整を行うことができます。新しいリリース バージョンの API でアプリケーションが順調に動作することが確認できたら、必要な修正(存在する場合)を推し進めることができ、同時に新しいリリース バージョンに対応するバージョン番号をリクエストするようにアプリケーションをアップデートできます。

一般的なアプリケーション

ブートストラップ リクエストで v=3 を指定することをお勧めします。これは、大量のトラフィックに対応済みで、必要なバグ修正が適用済みである、現行のリリース バージョンの Google Maps JavaScript API を常に取得することを意味します。多くの場合、バージョンがロールオーバーしても対処の必要がないことが期待されます。ただし、アプリケーションが継続して順調に機能するように、Google Maps JS API v3 の通知と発表のグループで、Google からのバージョン ロールオーバーの通知を購読することをお勧めします。

ロールオーバーの実施後は、アプリケーションは新しいバージョンの Google Maps JavaScript API を使用します。また、リリースノートを精査して、影響を受ける可能性がある変更点について把握しておくことをお勧めします。アプリケーションの一部が正常に動作していないことに気付いたら、コードで必要な調整を行っている間に、現行のフローズン バージョンの番号をブートストラップ リクエスト内で明示的に指定して、古いバージョンに切り替えることができます。

最先端のアプリケーション

最新の機能に早期にアクセスしたい場合

安定した可用性がそれほど重要ではないアプリケーションでは、エクスペリメンタル バージョン(v=3.exp)の Google Maps JavaScript API をリクエストして、最新のすべての機能を入手することをお勧めします。エクスペリメンタル バージョンは、毎週 Google によりリリース前に完全にテストされており、一般にかなり安定しています。ただし、リリース サイクルが毎週であるということは、アプリケーションの期待どおりの動作を確実に続行するには、少し高いレベルの警戒が必要あることを意味します。

各 API バージョンのドキュメント

デベロッパー ガイドでは、常にエクスペリメンタル バージョンについて説明しています。

さらに、各バージョン用に個別に整備されている次のリファレンスがあります。

フィードバックを送信...

Google Maps JavaScript API
Google Maps JavaScript API
ご不明な点がありましたら、Google のサポートページをご覧ください。