一部の Business Profile API は、複数のバージョンとリリース チャンネルで利用できます。バージョンは、リクエスト URL のホスト名に続くセグメント（v1 や v1alpha など）です。このページでは、バージョンの番号付け方法、各リリース チャンネルの安定性、アルファ チャンネルの呼び出し方法について説明します。
バージョン番号
各 API バージョンには、メジャー バージョン番号とオプションのチャンネル サフィックスがあります。
- メジャー バージョン（
v1、v2など）: 安定した一般提供バージョン。メジャー バージョンでは、新しいメソッド、新しいフィールド、新しい列挙値など、下位互換性のある変更のみが適用されます。下位互換性のない変更は、新しいメジャー バージョンでリリースされます。 - アルファ チャンネル（
v1alpha、v2alpha、...）: メジャー バージョンのプレリリース チャンネル。このバージョンには、そのメジャー バージョンのすべての機能に加えて、まだ一般提供されていない機能が含まれています。
リリース チャンネル
| チャネル | 安定性 | 目次 |
|---|---|---|
一般提供（v1） |
安定版。メジャー バージョン内の変更には下位互換性があります。メジャー バージョンが非推奨になった場合、非推奨のお知らせから少なくとも 12 か月間は利用できます。サポート終了と廃止日は、サポート終了スケジュール ページに掲載されています。 | 一般提供機能。 |
アルファ版（v1alpha） |
プレリリース版。安定性の保証はなく、有効期間も定義されていません。アルファ版の機能は、少なくとも 30 日前に通知したうえで変更または廃止される場合があります。本番環境の統合ではアルファ版機能を使用しないでください。 | v1 のすべての機能に加えて、まだ一般提供されていない機能。 |
チャンネル間で機能が移動する仕組み
機能が v1alpha から v1 に移行しても、v1alpha では引き続き利用可能です。
v1alpha でのみ利用可能な機能のガイドとリファレンス ページは、アルファ版としてマークされています。新しいアルファ版機能と一般提供機能、アルファ版機能の変更または削除は、最新の更新と各 API の変更ログで発表されます。
アルファ版チャンネルを使用する
アルファ チャンネルを呼び出すには、リクエスト URL の v1 を v1alpha に置き換えます。次に例を示します。
GET https://mybusinessbusinessinformation.googleapis.com/v1alpha/locations/{locationId}?readMask={readMask}
どちらのチャネルも同じ API に属しているため、次のものが共有されます。
- Google Cloud コンソールでの API の有効化。
- OAuth 2.0 スコープとアクセス要件。
- リソース名（
locations/{locationId}など）。 - 割り当て。
v1とv1alphaへのリクエストは、同じプロジェクトごとの割り当てにカウントされます。詳細については、割り当て上限をご覧ください。 - 基盤となるビジネスデータ。
v1alphaで行った変更はv1で確認できます。その逆も同様です。
クライアント ライブラリと公開 API ディレクトリには v1 のみが含まれます。v1alpha を呼び出すには、REST リクエストを直接送信します。
ベスト プラクティス
- 本番環境の統合には、
v1などの安定版を使用します。 v1alphaなどのアルファ版チャンネルを使用して、一般提供前に新機能を導入します。フィードバックを送信するには、サポートをご覧ください。- 認識できないフィールドと列挙値をクライアントが許容できるようにします。
- アルファ版の機能に基づいてビルドする前に、ガイドと変更ログで既知の制限事項を確認してください。