Looker API のスタートガイド

Looker API は Looker インスタンスを管理するための安全で「RESTful」なアプリケーションプログラミングインターフェースで、Looker データプラットフォームを通じてデータをフェッチします。Looker API では、新しい Looker ユーザー アカウントのプロビジョニング、クエリの実行、データ配信のスケジュール設定などを行うアプリケーションまたは自動化スクリプトを記述できます。Looker API を介して Looker アプリケーションで実行できることがすべて実行可能です。

Looker API のパスとポート

Looker インスタンスの API に、API の URL を介してアクセスします。

Looker 管理者は、[Admin] > [API] ページの [API Host URL] フィールドに次のいずれかの形式で入力することで、API パスを指定できます。

https://<instance_name>.cloud.looker.com

Looker 管理者は、API ホスト URL フィールドを使用して、Looker サーバーマシン名とは異なる API パスを割り当てることもできます。これは、たとえば Looker のインストールがロードバランサの背後にある場合に頻繁に発生します。その場合は、API パスについて Looker 管理者に連絡してください。

Looker 管理者が [API ホスト URL] フィールドを指定していない場合、Looker はデフォルトの API パスを使用します。Google Cloud、Microsoft Azure でホストされている Amazon インスタンス、Amazon Web Service(AWS)でホストされているインスタンス(2020 年 7 月 7 日以降に作成されたもの)の場合、デフォルトの Looker API パスはポート 443 を使用します。2020 年 7 月 7 日より前に作成された AWS でホストされている Looker インスタンスの場合、デフォルトの Looker API パスはポート 19999 を使用します。デフォルトの API URL の形式は次のとおりです。

https://<instance_name>.cloud.looker.com:<port>

クライアント SDK

Looker API は、HTTPS リクエストの送信と JSON レスポンスを処理できる任意のプログラミング言語またはアプリケーション環境で使用できます。Looker API HTTPS リクエストを手動で作成するには、curl(または同等のツール)を使用するか、Looker Ruby SDK を使用するか、任意の言語のクライアント SDK ライブラリを生成します。SDK を使用することをおすすめします。これによって、認証と HTTPS リクエストの詳細が処理されるため、単純な関数呼び出しを使用して Looker API を呼び出すことができます。

SDK の詳細については、Looker API SDK のドキュメント ページをご覧ください。

認証

Looker は、リクエストの HTTP 認可ヘッダーで OAuth 2.0 ベアラー アクセス トークンを使用して、API リクエストを認証します。すべての Looker API エンドポイントでは、アクセス トークンが転送中に保護されるように、安全な HTTPS 接続が必要です。

この実行手順は、SDK を使用しているかどうかによって異なります。詳細な手順については、Looker API の認証のドキュメント ページをご覧ください。

インタラクティブな API ドキュメント

API リファレンス ドキュメントについては、Looker Marketplace から API Explorer 拡張機能を入手できます。詳細については、API Explorer の使用のドキュメント ページをご覧ください。Looker 管理者は、Looker の API 管理ページにある [Use API Explorer] をクリックして API Explorer にアクセスすることもできます。

バージョニング

アプリケーションを構築する際は、API の安定性を考慮することが重要です。今後変更される場合のあるエンドポイントと、安定したままであるエンドポイントを把握できるように、特定のエンドポイントはベータ版としてマークされています。詳細については、Looker API のバージョニングのドキュメント ページをご覧ください。