ステップ 3: ダッシュボード URL を埋め込む - Amazon QuickSight

ステップ 3: ダッシュボード URL を埋め込む

 適用先: Enterprise Edition 
   対象者: Amazon QuickSight デベロッパー 

次のセクションでは、ステップ 2 のダッシュボード URL をウェブサイトまたはアプリケーションページに埋め込むための QuickSight Embedding SDK (JavaScript) の使用方法について説明します。SDK を使用すると、次のことを実行できます。

  • ダッシュボードを HTML ページに配置します。

  • ダッシュボードにパラメータを渡します。

  • アプリケーションに合わせてカスタマイズされたメッセージでエラー状態を処理します。

GetDashboardEmbedUrl API オペレーションを呼び出して URL を生成し、アプリケーションに埋め込みます。この URL は 5 分間有効で、得られたセッションは 10 時間有効です。API オペレーションは、シングルサインオンセッションを有効にする auth_code の URL を提供します。

以下に、get-dashboard-embed-url からのレスポンスの例を示します。

//The URL returned is over 900 characters. For this example, we've shortened the string for //readability and added ellipsis to indicate that it's incomplete. { "Status": "200", "EmbedUrl": "https: //dashboards.example.com/embed/620bef10822743fab329fb3751187d2d...", "RequestId": "7bee030e-f191-45c4-97fe-d9faf0e03713" }

QuickSight Embedding SDK を使用して、または iframe にこの URL を追加することで、このダッシュボードをウェブページに埋め込めます。固定された高さと幅の数値 (ピクセル単位) を設定した場合、QuickSight はそれらを使用し、ウィンドウのサイズ変更に合わせたビジュアルの変更はしません。QuickSight が提供する高さと幅の相対的なパーセンテージを設定した場合、ウィンドウサイズの変更に応じて変更されるレスポンシブレイアウトが提供されます。QuickSight Embedding SDK を使用して、ユーザーはダッシュボード内でパラメータを制御したり、ページロードの完了やエラーに関するコールバックを受け取ることができます。

次の例は生成された URL の使用方法を示しています。このコードはアプリケーションサーバーにあります。

<!DOCTYPE html> <html> <head> <title>Basic Embed</title> <!-- You can download the latest QuickSight embedding SDK version from https://www.npmjs.com/package/amazon-quicksight-embedding-sdk --> <!-- Or you can do "npm install amazon-quicksight-embedding-sdk", if you use npm for javascript dependencies --> <script src="./quicksight-embedding-js-sdk.min.js"></script> <script type="text/javascript"> var dashboard; function embedDashboard() { var containerDiv = document.getElementById("embeddingContainer"); var options = { // replace this dummy url with the one generated via embedding API url: "https://us-east-1.quicksight.aws.amazon.com/sn/dashboards/dashboardId?isauthcode=true&identityprovider=quicksight&code=authcode", container: containerDiv, scrolling: "no", height: "700px", width: "1000px", footerPaddingEnabled: true }; dashboard = QuickSightEmbedding.embedDashboard(options); } </script> </head> <body onload="embedDashboard()"> <div id="embeddingContainer"></div> </body> </html>

この例を機能させるには、Amazon QuickSight Embedding SDK を使用して、JavaScript で埋め込みダッシュボードをウェブサイトにロードします。コピーを取得するには、次のいずれかを実行します。

  • GitHub から、Amazon QuickSight Embedding SDK をダウンロードします。このリポジトリは、QuickSight デベロッパーのグループによって管理されます。

  • https://www.npmjs.com/package/amazon-quicksight-embedding-sdk から最新の QuickSight embedding SDK バージョンをダウンロードします。

  • JavaScript の依存関係の npm を使用する場合、次のコマンドを実行してダウンロードし、インストールします。

    npm install amazon-quicksight-embedding-sdk