埋め込みダッシュボードおよびビジュアルについての実行時のデータのフィルタリング - Amazon QuickSight
用語と概念設定SDK メソッドインターフェイス

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

埋め込みダッシュボードおよびビジュアルについての実行時のデータのフィルタリング

Amazon QuickSight 埋め込みのフィルターメソッドを使用してSDK、実行時に Software as a Service (SaaS) アプリケーション内の QuickSight フィルターの機能を活用できます。ランタイムフィルターを使用すると、ビジネスオーナーはアプリケーションを埋め込み QuickSight ダッシュボードやビジュアルと統合できます。これを実現するには、アプリケーションでカスタマイズされたフィルターコントロールを作成し、アプリケーションからのデータに基づいてフィルタープリセットを適用します。その後、デベロッパーは実行時に、エンドユーザーのためにフィルター設定をパーソナライズできます。

開発者は、 QuickSight 埋め込み を使用して、埋め込みダッシュボードまたはビジュアルでフィルターを作成、クエリ、更新、およびアプリケーションから削除できますSDK。FilterGroup データモデルを使用してアプリケーションに QuickSight フィルターオブジェクトを作成し、フィルターメソッドを使用して埋め込みダッシュボードやビジュアルに適用します。 QuickSight 埋め込み の使用の詳細についてはSDK、「」のamazon-quicksight-embedding-sdk「」を参照してください GitHub。

前提条件

開始する前に、埋め込みSDKバージョン QuickSight 2.5.0 以降を使用していることを確認してください。

用語と概念

次の用語は、実行時の組み込みフィルタリングを使用する場合に役立ちます。

  • フィルターグループ – 個々のフィルターのグループ。FilterGroup 内にあるフィルターは相互に OR 演算されます。内のフィルターFilterGroupは、同じシートまたはビジュアルに適用されます。

  • フィルター– 単一のフィルター。フィルターは、カテゴリ、数値、または日時のフィルタータイプにすることができます。フィルターの詳細については、「フィルター」を参照してください。

設定

開始する前に、次のアセットと情報が準備されていることを確認してください。

  • FilterGroup の範囲を設定するシートのシート ID。これは、埋め込み の getSheetsメソッドで取得できますSDK。

  • フィルタリングするデータセットと、そのデータセットの列識別子。これは、 DescribeDashboardDefinitionAPIオペレーションを通じて取得できます。

    使用する列の種類によっては、埋め込みアセットに追加できるフィルターのタイプに制限がある場合があります。フィルター制限の詳細については、「フィルター」を参照してください。

  • FilterGroup の範囲を設定するビジュアルのビジュアル ID (該当する場合)。これは、埋め込み の getSheetVisualsメソッドを使用して取得できますSDK。

    getSheetVisuals メソッドに加えて、追加する FilterGroup の範囲は、現在選択されているシートにのみ設定できます。

この機能を使用するには、 QuickSight 埋め込み を通じてダッシュボードまたはビジュアルがアプリケーションに既に埋め込まれている必要がありますSDK。 QuickSight 埋め込み の使用の詳細についてはSDK、「[Quip のリンクが間違っています〕」を参照してください。

SDK メソッドインターフェイス

ダッシュボード埋め込みゲッターメソッド

次の表には、デベロッパーが使用できるさまざまなダッシュボード埋め込みゲッターメソッドの説明が記載されています。

[メソッド] 説明

getFilterGroupsForSheet(sheetId: string)

パラメータで指定されたシートに FilterGroups 現在スコープされているすべての を返します。

getFilterGroupsForVisual(sheetId: string, visualId: string)

パラメータで指定されたビジュアルに範囲設定されているすべての FilterGroups を返します。

パラメータで指定されたシートが、埋め込みダッシュボードの現在選択されているシートではない場合、上記のメソッドはエラーを返します。

ビジュアル埋め込みゲッターメソッド

次の表には、デベロッパーが使用できるさまざまなビジュアル埋め込みゲッターメソッドの説明が記載されています。

[メソッド] 説明

getFilterGroups()

埋め込みビジュアルに現在範囲設定されているすべての FilterGroups を返します。

設定メソッド

次の表には、デベロッパーがダッシュボードまたはビジュアル埋め込みに使用できるさまざまなセッターメソッドの説明が記載されています。

[メソッド] 説明

addFilterGroups(filterGroups: FilterGroup[])

提供された FilterGroupsを埋め込みダッシュボードまたはビジュアルに追加して適用します。追加が成功したかどうかを示す ResponseMessage が返されます。

updateFilterGroups(filterGroups: FilterGroup[])

パラメータで指定された FilterGroup と同じ FilterGroupId を含む、埋め込みエクスペリエンスの FilterGroups を更新します。更新が成功したかどうかを示す ResponseMessage が返されます。

removeFilterGroups(filterGroupsOrIds: FilterGroup[] | string[])

ダッシュボード FilterGroups から提供された を削除し、削除が成功したかどうかResponseMessageを示す を返します。

指定される FilterGroup は、現在選択されている埋め込みシートまたはビジュアルに範囲設定される必要があります。