Power BI 埋め込み分析クライアント API とは

先端

独自のレポートまたはサンプルレポートを使用して API をリアルタイムで試すには、Power BI 埋め込み分析のプレイグラウンドにアクセス

Power BI クライアント API は、JavaScript または TypeScript を使用して、埋め込み Power BI コンテンツをプログラムで制御できるクライアント側ライブラリです。

クライアント API を使用して、Power BI 項目 (レポートやダッシュボードなど) とアプリケーションコードの間で通信します。これにより、設計に応じてエンドユーザーエクスペリエンスを柔軟に構築できます。

クライアントライブラリのしくみ

クライアント API は、レポートやダッシュボードなどの埋め込み Power BI アイテムと通信します。 iframe は、ホスティングアプリと Power BI 項目の間に分離を作成し、データがセキュリティで保護されていることを確認します。

Power BI に関連する Power BI JavaScript API を示す図。

クライアントアプリケーションの - スクリーンショット全体がクライアントアプリケーションの例です。
埋め込みレポート - アプリケーションに現在表示されている埋め込みレポート。
iFrame 境界 - 埋め込みレポートは iFrame 内でホストされます。この図は、その境界の概要を示しています。
クライアント API - クライアント API を使用して、Web アプリケーションと埋め込みコンポーネントの間で通信します。たとえば、レポート report.setPage(…) 呼び出すと、レポートのアクティブなページが変更されます。ページが変更されると、pageChanged イベントがレポートによって生成され、イベントハンドラーにコードを追加できます。詳細については、ページナビゲーション参照してください。

このドキュメントセットでは、次のコンポーネントの API の一覧を示します。

powerbi-client - powerbi-report-authoringを除くすべての Power BI クライアント API を含むメインの Power BI クライアントライブラリ。このライブラリでは、埋め込み可能なさまざまな Power BI 項目のクラスを定義します。 powerbi-client ライブラリを使用すると、埋め込むコンテンツを制御できます。
powerbi-models - Power BI クライアント API のオブジェクトモデルが含まれています。各モデルには、TypeScript インターフェイス、JSON スキーマ定義、および特定のオブジェクトが有効なモデルであることを確認するための検証関数があります。
powerbi-report-authoring - クライアントライブラリの拡張機能。これらの API は、ビジュアルの作成とレポートの読み込み後の作成に役立ちます。 powerbi-report-authoring ライブラリを使用すると、埋め込みレポートをプログラムで編集できます。

ドキュメントセットには、コード例と共に API の使用方法を説明する記事も含まれています。記事は、次のセクションに分かれています。

概要 - Power BI 埋め込み分析に関する追加情報。
Playground ショーケース - Power BI 埋め込み分析プレイグラウンドを使用して、アプリで埋め込み分析をすばやく使用する方法について説明します。
の埋め込みを開始する - レポートやダッシュボードなどの各 Power BI 項目を埋め込む方法について説明します。
基本的な概念 - すべての開発者が理解しておく必要がある概念について説明します。
レポート埋め込み - レポートにのみ適用できる追加の埋め込みの概念。
レポート操作 - 埋め込みレポートを調整して、顧客に優れたユーザーエクスペリエンスを提供できるようにします。
組織のレポートを埋め込む - 組織のソリューションの埋め込みを使用して埋め込むときに、より優れた埋め込みレポートを作成します。
レポート作成 - powerbi-report-authoring API 専用の記事を使用すると、レポートの読み込み後に視覚化を作成およびカスタマイズできます。

リソース エントリには、Power BI 開発者に役立つリソースが含まれています。

手記

Power BI 埋め込み分析プレイグラウンドを試しながら、これらの記事を確認することをお勧めします。