Looker 22.4 で Looker API 4.0 が一般提供されることを発表いたします。一般提供の API 4.0（API 4.0 GA）には、複数の破壊的変更と追加の変更があり、複数のエンドポイントがベータ版から安定版に昇格されています。API 3.1 と 3.0 は影響を受けません。 API 4.0 の仕様の詳細については、API リファレンスをご覧ください。Looker がサポートする SDK とコミュニティがサポートする SDK は、Looker API 4.0 GA エンドポイントに対応するように更新されました。詳しくは、API と SDK のサポート ポリシーおよび Google による API のバージョン管理の方法をご覧ください。この記事の以降の部分では、API 4.0 GA への移行により期待できる破壊的変更、緩和策、機能の概要を説明します。
この記事の対象者
このドキュメントは、Looker がサポートする SDK、コミュニティがサポートする SDK、または API 自体を通じて、Looker API を利用するユーザーを対象としています。現在ご利用の Looker API バージョンに対応する以下のセクションをご覧ください。
一般提供前の API 4.0 ユーザー
API 4.0 をご利用の場合は、このセクションをお読みください。Looker 22.4 で API 4.0 GA に移行する際の、破壊的変更とその緩和策について説明しています。
API 4.0 GA では、すべてのエンティティ ID フィールドが数値 integer 型から string 型に変更されます。たとえば、GET /groups/{group_id} エンドポイントは、int64 型ではなく、string 型として id を返します。
API 4.0 エンドポイントの使用に伴う影響と緩和策については、次の表を参照してください。
| 使用状況 | 発生する可能性のある影響 1 | 予防策 |
| Looker モバイルアプリ | 古くなった Looker モバイルアプリのインストールが動作しなくなる | 最新バージョンの Looker モバイルアプリに更新する |
| Looker がサポートする 2 SDK | ||
| Typescript SDK（4.0 API） | 影響なし | アクションは不要 |
| Python SDK（4.0 API） | 影響なし | アクションは不要 |
| Ruby SDK（4.0 API） | 影響なし | アクションは不要 |
| コミュニティがサポートする 2 SDK | ||
| Swift SDK | ランタイム例外 | SDK を v22.0 以降に更新し、結果の型エラーがあれば、解決します。 |
| Kotlin SDK | 影響なし | アクションは不要 |
| LookR SDK | 影響なし | アクションは不要 |
| C# SDK | 影響なし | アクションは不要 |
| Go SDK | ランタイム例外 | SDK を v22.0 以降に更新し、結果の型エラーがあれば、解決します。 |
| その他 | ||
| SDK なしで（または外部提供のライブラリとともに）4.0 API を使用する | 言語の型の機密性に応じて発生する可能性のあるランタイム エラー | 任意の ID フィールドの型に依存するコードを確認し、文字列型の ID フィールドのサポートを追加します。また、こちらのその他のガイダンスもご確認ください。 |
1: Looker の ID フィールドの使用を含む、一般的な使用パターンを前提としています。通常とは異なる使用パターン（数値操作の ID への適用など）はこの限りではありません。
2: Looker の API と SDK のサポート。コミュニティでサポートされているライブラリは、Looker では正式にはサポートされていません。
API 3.1 のユーザー
API 3.1 をご利用の場合は、このセクションをお読みください。API 4.0 で利用できる追加機能や変更点について説明します。Looker およびコミュニティでサポートされる SDK は、主に API 4.0 に対応しています。詳しくは、SDK と API のサポート ポリシーをご覧ください。
API 4.0 GA の追加機能
以下に、API 4.0 の主要で便利な追加の変更点についてご紹介します。
- ボード、ボードのアイテム、ボード セクションの作成と管理。ボードのドキュメントについては、こちらをご覧ください。
- データベース、スキー、カラム、テーブルなどのその他の接続情報の照会。追加の接続フィールドを設定して更新します。
- OAuth アプリとユーザーの作成と管理。OAuth のドキュメントはこちらをご覧ください。
- 階層とロールを持つグループの検索。
- ユーザー数を持つロールの検索。
- Looker インスタンス設定の取得と設定。設定に関するドキュメントはこちらをご覧ください。
- アラートの作成と管理。アラートのドキュメントはこちらをご覧ください。
- SSH トンネルと SSH サーバーの作成、管理、テスト。SSH のドキュメントはこちらをご覧ください。
- ダッシュボードの移動とコピー。
- 新しいダッシュボードの相対 URL の取得。
- Looksの移動とコピー。
- SSO および非 SSO 埋め込みのシークレット、URL、ユーザーの作成と管理。
- ログイン アクセス トークンを更新するための更新トークンの取得。
- すべての LookML モデルとすべてのユーザーの取得による結果の制限およびオフセット。
- ユーザーの検索による結果の制限およびオフセット。
- Swagger 2.x JSON で Looker インスタンス API の仕様を取得する。
API 4.0 GA の非推奨に関する変更
API 4.0 GA により、非推奨のいくつかの API 3.1 エンドポイントが、機能改善によって置き換えられます。対象のエンドポイントは次のとおりです。
- 非推奨のホームページ エンドポイントを削除しました。ホームページではなくボード エンドポイントを使用してください。ボード機能のドキュメントはこちらをご覧ください。
- 非推奨のスペース エンドポイントを削除しました。スペースではなくフォルダ エンドポイントを使用してください。フォルダ機能のドキュメントは、こちらをご覧ください。
API 3.0 のユーザー
API 3.0 をご利用の場合は、このセクションをお読みください。API 3.0 は、レガシー、非推奨であるとみなされ、使用は推奨されません。API 4.0 への移行をおすすめします。
- 開発を支援するために、Looker およびコミュニティがサポートしている SDK をすべてサポートしているのは、API 4.0 のみです。SDK リポジトリをご覧ください。
- API 4.0 には、前述したような複数の新機能と拡張機能が導入されています。
まとめ
API 4.0 に追加される新機能と追加の変更にご期待ください。最新の変更は、API リファレンスでいつでも確認できます。詳しくは、API と SDK のサポート ポリシーと、Google による API のバージョン管理をご覧ください。破壊的変更は理想的ではないことは承知しています。重大な問題が発生しない限り、一般提供の API 4.0 に破壊的変更は行いません。一般提供の Looker API 4.0 により、Looker プラットフォームでの開発がより生産的かつ簡単になれば幸いです。