Looker API Explorer は、Looker 拡張フレームワークを使用して開発され、Looker Marketplace を通じてデプロイされる拡張機能（Looker コンポーネントを使用してビルドされるウェブ アプリケーション）です。
API Explorer には、以下のアセットが用意されています。
- すべての Looker API のメソッドとタイプに関するドキュメント
- サポートされているすべての SDK 言語のメソッドとタイプの宣言
- API メソッドを使用する SDK 関数の例へのリンク
- 参照されるメソッドとタイプに関する API Explorer ページへのリンク
- Run It 関数。API 呼び出しを直接実行し、API 呼び出し、API レスポンス、SDK 関数のコードを提供します。
- Looker API のバージョンの違いを示す比較ツール
API Explorer は API リクエストにアクティブ ユーザーのアカウントを使用するため、ユーザーが API Explorer の拡張機能バージョンにログインする必要はありません。これにより、ユーザーは権限のある API 呼び出しのみを行うことができ、API 認証情報を提供する必要もなくなります。
Looker の sudo as another user 機能を使用して別のユーザーとして API リクエストを行い、アクセスの問題を診断することもできます。
API Explorer のインストール
API Explorer は Looker Marketplace で利用できます。
Marketplace から API Explorer をインストールする前に、Looker 管理者は拡張フレームワーク機能を有効にする必要があります。
API Explorer の拡張機能などのアプリケーションを Marketplace からインストールするには、develop、manage_models、deploy の権限が必要です。API Explorer をインストールすると、extension_api_explorer モデルに対する access_data 権限以上を持つすべてのユーザーが API Explorer を使用できます。各ユーザーは API Explorer ですべての API エンドポイントを表示できますが、実行できるのはそれぞれの権限で許可されたエンドポイントのみです。
Looker 管理者が Looker の [Admin] メニューの [Platform] セクションにある [Marketplace] ページで Auto Install オプションを有効にしている場合は、API Explorer がインスタンスに自動的にインストールされます。また、利用可能な更新がある場合は自動的に更新が適用され、インスタンスの API Explorer のバージョンが最新になります。
Looker 管理者が [Auto Install] オプションを有効にしていない場合は、Looker Marketplace から API Explorer をインストールする必要があります。
Looker Marketplace から拡張機能をインストールする手順については、Looker Marketplace の利用に関するドキュメント ページをご覧ください。Looker Marketplace に移動して [管理] を選択し、拡張機能の横にある [更新] ボタンを選択すると、常に API Explorer を最新のバージョンに保つことができます。
API Explorer の起動
API Explorer をインストールしたら、左側のサイドバーの [アプリケーション] セクションに移動します。
API Explorer でのナビゲーション
API Explorer のホームページでは、次のタスクを行うことができます。
SDK 言語セレクタのプルダウンを使用して、API Explorer で API メソッドとタイプの宣言、コード結果を表示するプログラミング言語を選択します。初期読み込み時は、セレクタはデフォルトで Python に設定されます。言語セレクタで [All] を選択すると、API Explorer にサポートされる各言語がタブ付きビューで表示されます。
バージョンのプルダウンを使用して、API のバージョンを選択します。
- 4.0 - 現在
[仕様を比較] ボタンを選択して、API バージョンの比較ページを開きます。
[Search] フィールドに検索キーワードを入力し、一覧表示される [Methods] と [Types] を、検索キーワードに一致するテキストを含むものだけに制限します。
検索によって返されたメソッドまたはタイプを選択すると、メソッドまたはタイプの概要で検索キーワードがハイライト表示されます。
[Methods] タブを選択して、API メソッドのカテゴリを表示します。メソッド カテゴリを展開または縮小して、カテゴリ内の個々のメソッドを表示できます。
[Types] タブを選択して、API のタイプを表示します。タイプは分類されず、アルファベット順に表示されます。
[Main Menu] ボタンを選択して、API Explorer のナビゲーション パネルの表示と非表示を切り替えます。
API メソッドとタイプに関するドキュメントの表示
[Method] タブでメソッド カテゴリを選択すると、メソッドのカテゴリが開かれ、そのカテゴリに含まれるすべてのメソッドが表示されます。
そのカテゴリにあるすべてのメソッドがメインパネルに表示されます。カテゴリ内のすべてのメソッドを表示するか、特定のメソッドタイプのタブを選択してそのメソッドタイプのみにリストをフィルタすることができます。
特定のメソッドのドキュメントを表示するには、ナビゲーション パネルでメソッド名を選択するか、メインパネルでメソッドを選択します。
特定のメソッドを選択すると、API Explorer にそのメソッドのドキュメントが表示されます。
[Type] タブからタイプを選択すると、そのタイプに関するドキュメントがメインパネルに表示されます。
メソッドとタイプの宣言
API Explorer では、SDK 言語セレクタ プルダウンで選択された SDK 言語で SDK のメソッドとタイプの宣言がレンダリングされます。SDK 言語セレクタを [All] に設定すると、メソッドとタイプの宣言が、サポートされているすべての SDK 言語でタブ区切りで表示されます。
SDK の例
Looker sdk-codegen リポジトリには、Looker SDK の例を含むフォルダがあります。sdk-codegen リポジトリにメソッドの例がある場合、そのメソッドの API Explorer ページに、その例へのリンクが記載された [SDK Examples] セクションが表示されます。
特定の SDK 言語を選択すると、その言語の例が最初に表示されます。
SDK 言語ではありませんが、Ruby や Java の例も表示される場合があります。
リファレンス
各メソッドとタイプの References セクションには、元のメソッドまたはタイプによって参照される各メソッドまたはタイプの API Explorer ページへのリンクが含まれています。
Run It を使用した API 呼び出しのリクエストと表示
API Explorer には [Run It] ボタンがあります。このボタンからパネルを開いて API 呼び出しをリクエストすることや、サポートされているさまざまな形式でレスポンスを表示することができます。
[Run It] ボタンをクリックすると、API Explorer に [Request] タブが表示され、API メソッドへの入力を指定できます。
目的の入力を記入し、[Run] を選択して API 呼び出しを実行します。
API メソッドでデータを変更できる場合（
POST、PATCH、UPDATE、DELETEの REST 呼び出しの場合）は、データ変更の確認チェックボックスが表示され、リクエストを実行する前にチェックボックスをオンにする必要があります。
リクエストが実行されると、[レスポンス] タブに結果が表示されます。
また、[Code] タブには、言語セレクタのプルダウンで選択した SDK の SDK 呼び出し構文が表示されます。SDK 言語セレクタが [すべて] に設定されている場合、SDK 呼び出し構文が、サポートされているすべての SDK 言語でタブ区切りで表示されます。
レスポンスの表示タイプ
API Explorer のレスポンスには、結果の表示方法を決定するために使用される MIME タイプが含まれています。
CSV と他の表形式データ
CSV データと JSON データの場合、Looker は形状テストを実行して、データがテーブルの条件を満たすかどうかを判断します。Looker によりペイロード データが表形式であると判断された場合、レスポンスのデフォルトの表示はデータグリッドになります。
[Raw] タブを選択して、未変換のデータを表示します。
JSON
JSON ペイロードは表形式にでき、この場合、グリッドに表示されます。LookML クエリの列ヘッダーは、フィールドのラベルではなく、<view_name>.<field_name> の形式で表示されます。
複雑な JSON ペイロードはグリッド表示が省略され、未加工 JSON のみが表示されます。
PNG と JPEG
PNG 形式と JPEG 形式では、クエリに対して選択された可視化が表示され、適用された可視化設定がすべて含まれます。次のサンプルは、前に示したものと同じクエリの PNG 出力です。ただし、テーブルの可視化を使用しています。JPEG も同様に処理されます。
SVG
一部の Looker エンドポイントは SVG を返しますが、それも直接サポートされています。次に、ダッシュボードの抽象化されたサムネイル画像を返す SVG 形式の content_thumbnail エンドポイントの例を示します。
HTML
HTML ソースコードを返すリクエストの場合、[レスポンス] タブにソース HTML が表示されます。
テキスト
書式なしテキストとして MIME タイプの SQL などのフォーマットを返すリクエストの場合、[レスポンス] タブに書式なしテキストとして表示されます。
API バージョンの比較
API Explorer には、異なるバージョンの Looker API を比較し、バージョン間での変更点を確認できるページがあります。ページの右上にある三角形の [仕様の比較] ボタンを選択して、API Explorer の比較ページを開きます。
API の基本バージョンと、基本バージョンと比較する API のバージョンを選択します。
比較に含める API オプションを選択して、選択したオプションが一致しないもののみが含まれるようにメソッドをフィルタリングします。次のオプションがあります。
- Missing - API の 1 つのバージョンに存在し、他のバージョンにはないすべてのメソッドを表示します。
- Status - メソッドのステータスが変更されたすべてのメソッドを表示します。たとえば、ステータスが
betaからstableに変更されたメソッドなどです。 - Parameters - 1 つ以上のメソッド パラメータが変更されたすべてのメソッドを表示します。
- Type - プロパティの新規作成、削除、変更を行ったタイプを表示します。
- Body - 本文パラメータの変更を表示します。
- Response - メソッドのレスポンスに変更があったすべてのメソッドを表示します。
比較ページには、差異のあるメソッドの数と、差異のあるメソッドのリストが表示されます。
メソッドを選択して展開すると、バージョン間のメソッドの変化を示す差分が比較ページに表示されます。