レポートを埋め込む
先端
Power BI Embedded Analytics Playgroundの「API の詳細」セクションで、レポートを埋め込んだり、クライアント API を試してみてください。
この記事では、アプリケーションに Power BI レポートを埋め込む手順について説明します。 Power BIの
レポートを埋め込む方法
Power BI コンテンツをアプリに埋め込む場合は、構成オブジェクトを使用して埋め込むコンテンツを定義し、コンテンツの設定を指定します。 次に、そのオブジェクトを API に渡します。 詳細については、「レポート設定 の構成」を参照してください。
既存のレポートを埋め込む
既に存在するレポートを埋め込む場合は、IReportLoadConfiguration
interface IReportLoadConfiguration {
accessToken: string;
bookmark?: models.IApplyBookmarkRequest;
contrastMode?: models.ContrastMode;
datasetBinding?: models.IDatasetBinding;
embedUrl?: string;
filters?: models.ReportLevelFilters[];
id: string;
pageName?: string;
permissions?: models.Permissions;
settings?: models.IEmbedSettings;
slicers?: models.ISlicer[];
theme?: models.IReportTheme;
tokenType?: models.TokenType;
type: string;
viewMode?: models.ViewMode;
}
このインターフェイスには、次のプロパティが含まれています。
accessToken
- 埋め込む Power BI データへのアクセスを許可するトークン。 アクセス トークンの詳細については、「 さまざまな埋め込みソリューションについて理解する」を参照してください。datasetBinding
- 埋め込みレポートで使用されるデータ スキーマを定義するデータセット。 データセットの詳細については、「データセットをレポート に動的にバインドする」を参照してください。embedUrl
- 埋め込むレポートの URL。 この URL は、埋め込みレポートを含む HTMLiframe
要素のソースになります。 具体的には、API によって、iframe
のsrc
属性に URL が割り当てられます。 Report API を使用して、この URL を取得できます。 2 つの例を次に示します。- レポート - グループ でレポートを取得する
- レポート - グループ でレポートを取得する
id
- 埋め込む Power BI レポートの ID。permissions
- 埋め込みレポートのユーザーに付与する操作。 次の値を使用できます。-
Read
- ユーザーはレポートを表示できます。 -
ReadWrite
- ユーザーはレポートを表示、編集、保存できます。 -
Copy
- ユーザーは、[名前を付けて保存] を使用してレポートのコピーを保存できます。 -
Create
- ユーザーは新しいレポートを作成できます。 -
All
- ユーザーはレポートのコピーを作成、表示、編集、保存、保存できます。
-
tokenType
- 埋め込む Power BI データへのアクセスを提供するトークンの種類。- 組織用に埋め込む場合 (ユーザーがデータを所有している) 場合は、
models.TokenType.Aad
を使用します。 - 顧客用に埋め込む場合 (アプリがデータを所有している) 場合は、
models.TokenType.Embed
を使用します。
詳細については、「さまざまな埋め込みソリューション を理解する」を参照してください。
- 組織用に埋め込む場合 (ユーザーがデータを所有している) 場合は、
type
- 埋め込むコンテンツの種類。 Power BI レポートに'report'
を使用します。
IReportLoadConfiguration
インターフェイスには、他のプロパティも含まれています。 これらのプロパティの詳細については、「レポート設定 の構成」を参照してください。
bookmark
contrastMode
filters
pageName
settings
slicers
theme
viewMode
新しいレポートを埋め込む
データセットから作成した新しいレポートを埋め込む場合は、IReportCreateConfiguration
型の構成オブジェクトを使用します。
interface IReportCreateConfiguration {
accessToken: string;
datasetId: string;
embedUrl?: string;
settings?: models.IEmbedSettings;
theme?: IReportTheme;
tokenType?: models.TokenType;
type: string;
}
このインターフェイスのプロパティは、IReportLoadConfiguration
インターフェイスのプロパティに似ていますが、次の例外があります。
datasetId
- 新しいレポートで使用されるデータ スキーマを定義するデータセットの ID。embedUrl
- 新しいレポートで使用されるデータ スキーマを定義するデータセットの URL。 この URL は、埋め込みレポートを含む HTMLiframe
要素のソースになります。 具体的には、API によって、iframe
のsrc
属性に URL が割り当てられます。 Datasets API を使用して、この URL を取得できます。 2 つの例を次に示します。- データセット - グループ でデータセットを取得する
- データセット - グループ でデータセットを取得する
レポートの編集と作成については、「埋め込みレポート の作成、編集、保存」を参照してください。
例
次の例は、レポートを埋め込む方法を示しています。
// Set up the configuration object that determines what to embed and how to embed it.
let embedConfiguration = {
accessToken: anAccessToken,
embedUrl: anEmbedUrl,
id: aReportId,
permissions: somePermissions,
tokenType: aTokenType,
type: 'report'
};
// Get a reference to the HTML element that contains the embedded report.
let embedContainer = $('#embedContainer')[0];
// Embed the report.
let report = powerbi.embed(embedContainer, embedConfiguration);
関連コンテンツ
- レポート ビジュアル を埋め込む
- レポート設定の構成
- レポート を作成、編集、保存する
- ブートストラップを使用してパフォーマンスを向上