Looker API 4.0 の一般提供開始

[LookerExperts]

この投稿は、Looker API 4.0 Generally Available英語版に投稿されたものの翻訳です。

Looker API 4.0 の一般提供開始

Looker API 4.0 が Looker 22.4 で一般提供が開始されることをお知らせいたします。一般提供の API 4.0（API 4.0 Generally Available）には、大きな変更がいくつか行われ、複数のエンドポイントがベータ版(Beta)から製品版(Stable)に昇格されます。API 3.1 と 3.0 は影響を受けません。Looker API 4.0 GA エンドポイントに対応するように、Looker がサポートする SDK とコミュニティがサポートする SDK を更新します。詳しくは、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 以降に更新し、TypeErrorが発生した場合は解決する
Kotlin SDK	影響なし	不要
LookR SDK	影響なし	不要
C# SDK	影響なし	不要
Go SDK	ランタイム例外	SDK を v22.0 以降に更新し、TypeErrorが発生した場合は解決する
その他
SDK なしで（または外部提供のライブラリとともに）4.0 API を使用する	言語の型の機密性に応じて発生する可能性のあるランタイム エラー	任意の ID フィールドの型に依存するコードを確認し、文字列型の ID フィールドのサポートを追加します。また、こちらのガイダンスもご確認ください。

1: 一般的な使用パターンとして、Looker の ID フィールドの使用を含むものの、通常とは異なる使用パターン（数値操作の ID への適用など）を前提としています。

2: Looker API と SDK のサポート。コミュニティでサポートされているライブラリは、Looker では正式にはサポートされていません。

API 3.1 のユーザー

API 3.1 を使用する場合は、このセクションをお読みください。API 4.0 で利用できる追加機能や変更点について説明します。API3.1とAPI4.0のエンドポイントの変更については、こちらで説明しています。Looker およびコミュニティでサポートされる SDK は、主に API 4.0 に対応しています。詳しくは SDK と API のサポート ポリシーをご覧ください。

API 4.0 GA の追加機能

API 4.0 の主な新機能については下記の通りです。

• ボード、ボードのアイテム、ボード セクションの作成と管理。ボードのドキュメントについては、こちらをご覧ください。

• データベース、スキーマ、カラム、テーブルなどのその他の接続情報の照会。コネクションフィールドの設定・更新

• OAuth アプリとユーザーの作成と管理。OAuth のドキュメントはこちらをご覧ください。

• 階層とロールを持つグループの検索。

• ユーザー数を持つロールの検索。

• Looker インスタンス設定の取得と設定。設定に関するドキュメントはこちらをご覧ください。

• アラートの作成と管理。アラートのドキュメントはこちらをご覧ください。

• SSH トンネルと SSH サーバーの作成、管理、テスト。SSH のドキュメントはこちらをご覧ください。

• ダッシュボードの移動とコピー。

•  新しいダッシュボード作成するエンドポイント (POST/dashboards)

• Looks の移動とコピー。

• 「SSO ・非 SSO 埋め込みのシークレット」・「URL」・「ユーザー」の作成と管理。

• ログイン アクセス トークンを更新するための更新トークンの取得。

• すべての「 LookML モデル」およびすべての「ユーザー」GETの結果の制限およびオフセット。

• 「 ユーザー検索」GETの結果の制限およびオフセット。

• Swagger 2.x JSON で Looker インスタンス API の仕様を取得する。

API 4.0 GA の非推奨エンドポイントに関する変更

API 4.0 GA により、非推奨エンドポイントが改善されました。対象のエンドポイントは次のとおりです。

• ホームページのエンドポイントを削除しました。ホームページではなくボード エンドポイントを使用してください。ボード機能のドキュメントはこちらをご覧ください。

• スペース エンドポイントを削除しました。スペースではなくフォルダ エンドポイントを使用してください。フォルダ機能のドキュメントは、こちらをご覧ください。

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 と SDK のサポート ポリシーと、Google による API のバージョン管理をご覧ください。重大な問題が発生しない限り、API4.0に大きな変更を加える予定はございません。一般提供の Looker API 4.0 により、Looker プラットフォームでの開発がより生産的かつスムーズになれば幸いです。