Looker 22.16 のドキュメントを表示しています。最新のドキュメントはこちらをご覧ください。

API Explorer の使用

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 する機能を使用して、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 管理者が [Admin] メニューの [Platform] セクションの [Marketplace] で [Auto Install] オプションを有効にしている場合、API Explorer は自動的にインスタンスにインストールされます。また、更新が利用可能になると、その更新が自動的に適用され、インスタンスの API Explorer のバージョンが最新になります。

Looker 管理者が [Auto Install] オプションを有効にしていない場合は、Looker Marketplace から API Explorer をインストールする必要があります。

Looker Marketplace から拡張機能をインストールする手順については、Looker Marketplace の使用ページをご覧ください。Looker Marketplace に移動し、[Manage] をクリックして、拡張機能の横にある [Update] ボタンをクリックすると、常に最新バージョンの API Explorer を使用できます。

API Explorer の起動

API Explorer をインストールすると、以下の方法で移動できます。

[参照] メニューのインストール済みのアプリケーションや拡張機能のリストを使用する
[アプリケーションとツール] ページで、[参照] メニューと左側のサイドバーからアクセスできます。
Looker 管理者は、Looker の [API] 管理ページで [API Explorer を使用する] リンクをクリックして、API Explorer にアクセスすることもできます。

API Explorer でのナビゲーション

API Explorer のホームページから、次のタスクを実行できます。

[SDK language language] プルダウンを使用して、API Explorer が API メソッドと型宣言とコード結果を表示するプログラミング言語を選択します。セレクタは、初期ロード時にデフォルトで Python に設定されます。言語セレクタから [All] を選択すると、API Explorer はサポートされている各言語のタブビューを表示します。
[バージョン] プルダウンで、API のバージョンを選択します。

- 4.0 - 現在

Looker 22.4 以降、Looker API 4.0 の一般提供が開始されました。今回のリリースでは、API 3.1 が非推奨になり、API Explorer から削除されました。そのため、API Explorer で表示できる唯一のバージョンは API 4.0 になっています。API Explorer の比較ページは今後のリリースでも引き続き使用できますが、利用可能なバージョンは API 4.0 のみのため、現時点では機能しません。

[検索] フィールドに検索キーワードを入力して、[メソッド] と [種類] を検索キーワードに一致するテキストを含むもののみに制限します。

検索によって返されたメソッドやタイプを選択すると、そのメソッドやタイプの概要で検索キーワードがハイライト表示されます。
[メソッド] タブを選択して、API メソッドカテゴリを表示します。メソッドカテゴリを拡張または縮小して、そのカテゴリの個々のメソッドを表示できます。
[タイプ] タブを選択して、API タイプを表示します。タイプは分類されず、アルファベット順に表示されます。
3 本線のアイコンをクリックすると、API Explorer のナビゲーションパネルの表示と非表示を切り替えることができます。

API メソッドとタイプのドキュメントの表示

[Method] タブでメソッドカテゴリを選択すると、メソッドカテゴリが展開され、そのカテゴリのすべてのメソッドが表示されます。

メインパネルには、そのカテゴリのメソッドがすべて表示されます。カテゴリ内のすべてのメソッドを表示することも、特定のメソッドタイプのタブをクリックすると、そのメソッドタイプのみにリストをフィルタできます。
特定のメソッドのドキュメントを表示するには、ナビゲーションパネルでメソッド名を選択するか、メインパネルでメソッドをクリックします。

特定のメソッドを選択すると、そのメソッドのドキュメントが API Explorer に表示されます。

[Type] タブでタイプを選択すると、そのタイプのドキュメントがメインパネルに表示されます。

メソッドと型の宣言

API Explorer は、SDK メソッドとタイプの宣言を、SDK 言語セレクタのプルダウンで選択した SDK 言語でレンダリングします。SDK 言語セレクタが [すべて] に設定されている場合、メソッドと型宣言は、サポートされているすべての SDK 言語で、タブ区切りで表示されます。

SDK の例

Looker sdk-codegen リポジトリには、Looker SDK の例を含むフォルダがあります。sdk-codegen リポジトリにメソッドのサンプルがある場合は、メソッドの [API Explorer] ページに [SDK Examples] セクションにサンプルへのリンクが表示されます。

特定の SDK 言語を選択した場合は、その言語の例が最初に表示されます。たとえば、次の SDK の例の表では、Swift が選択されている言語として表示されます。

Ruby と Java のサンプルも示されていますが、これらは SDK 言語ではありません。

リファレンス

各メソッドと型の参照セクションには、元のメソッドまたは型によって参照されている各メソッドまたは型の API Explorer ページへのリンクが含まれています。

Run It を使用して API 呼び出しのリクエストと表示を行う

API Explorer には [実行] ボタンがあります。このパネルで、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 では、シンプルな「図形」テストが実行され、データが表のように見えるかどうかが判定されます。ペイロードデータがテーブルのように見える場合、レスポンスのデフォルト表示はデータグリッドです。

[Raw] タブを使用すると、変換されなかったデータを表示できます。

JSON

JSON ペイロードは「表形式」にすることができます。その場合、グリッドで表示されます。LookML クエリの列見出しは、CSV 形式と JSON 形式で異なります。

複雑な JSON ペイロードはグリッド表示を省略し、未加工の JSON のみを表示します。

PNG と JPEG

以下は、上記と同じクエリを PNG 形式で表示した例です。JPEG は次のように処理されます。

SVG

一部の Looker エンドポイントは SVG を返します。SVG も直接サポートされています。SVG 形式の content_thumbnail エンドポイントの例を次に示します。

HTML

HTML ソースコードは [レスポンス] タブでハイライト表示されます。

テキスト

SQL と、書式なしテキストとして MIME タイプのレスポンスは、次のように表示されます。

API バージョンの比較