

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

# Filtrage des données au moment de l'exécution pour les tableaux de bord et visuels intégrés à Amazon Quick Sight
<a name="embedding-runtime-filtering"></a>

Vous pouvez utiliser des méthodes de filtrage dans le SDK d'intégration d'Amazon Quick Sight pour tirer parti de la puissance des filtres Amazon Quick Sight au sein de votre application logicielle en tant que service (SaaS) lors de l'exécution. Les filtres d'exécution permettent aux propriétaires d'entreprise d'intégrer leur application à leurs tableaux de bord et visuels Amazon Quick Sight intégrés. Pour ce faire, créez des contrôles de filtre personnalisés dans votre application et appliquez des préréglages de filtre en fonction des données de votre application. Les développeurs peuvent ensuite personnaliser les configurations de filtre pour les utilisateurs finaux lors de l’exécution.

Les développeurs peuvent créer, interroger, mettre à jour et supprimer des filtres Amazon Quick Sight sur un tableau de bord intégré ou un visuel depuis leur application grâce au SDK d'intégration Amazon Quick Sight. Créez des objets de filtre Amazon Quick Sight dans votre application à l'aide du modèle de [FilterGroup](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_FilterGroup.html)données et appliquez-les aux tableaux de bord et aux visuels intégrés à l'aide des méthodes de filtrage. Pour plus d'informations sur l'utilisation du SDK Amazon Quick Sight Embedding, consultez le [amazon-quicksight-embedding-sdk](https://github.com/awslabs/amazon-quicksight-embedding-sdk) GitHub

**Conditions préalables**

Avant de commencer, assurez-vous d'utiliser le SDK Amazon Quick Sight Embedding version 2.5.0 ou ultérieure.

## Terminologie et concepts
<a name="runtime-filtering-terminology"></a>

La terminologie suivante peut être utile lorsque vous utilisez un filtrage d’exécution intégré.
+ *FilterGroup (Groupe de filtres)* : groupe de filtres individuels. Les filtres situés à l’intérieur d’un `FilterGroup` sont couplés en OR les uns avec les autres. Les filtres contenus dans a [FilterGroup](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_FilterGroup.html)sont appliqués aux mêmes feuilles ou visuels.
+ *Filtre* : filtre unique. Le filtre peut être de type catégorie, numérique ou datetime. Pour plus d’informations sur les filtres, consultez [Filtres](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_Filter.html).

## Configuration
<a name="runtime-filtering-setup"></a>

Avant de commencer, assurez-vous d’avoir préparé les éléments et informations suivants.
+ L’ID de la feuille à laquelle vous souhaitez étendre la portée `FilterGroup`. Cela peut être obtenu à l’aide de la méthode `getSheets` du SDK d’intégration.
+ Le jeu de données et l’identifiant de colonne de le jeu de données que vous souhaitez filtrer. Cela peut être obtenu par le biais de l'opération [DescribeDashboardDefinition](https://docs.aws.amazon.com/APIReference/API_DescribeDashboardDefinition.html)API.

  Selon le type de colonne que vous utilisez, les types de filtres pouvant être ajoutés à une ressource incorporée peuvent être soumis à des restrictions. Pour plus d’informations sur les restrictions de filtres, consultez [Filtres](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_Filter.html).
+ ID visuel du visuel auquel vous souhaitez étendre le champ d’application `FilterGroup`, le cas échéant. Cela peut être obtenu en utilisant la méthode `getSheetVisuals` du SDK d’intégration.

  Outre la méthode `getSheetVisuals`, le `FilterGroup` que vous ajoutez ne peut être étendu qu’à la feuille actuellement sélectionnée.

Pour utiliser cette fonctionnalité, vous devez déjà avoir intégré un tableau de bord ou un visuel à votre application via le SDK Amazon Quick Sight Embedding. Pour plus d'informations sur l'utilisation du SDK Amazon Quick Sight Embedding, consultez le [amazon-quicksight-embedding-sdk](https://github.com/awslabs/amazon-quicksight-embedding-sdk) GitHub

## Interface de méthode SDK
<a name="runtime-filtering-sdk-interface"></a>

**Méthodes getter d’intégration du tableau de bord**

Le tableau suivant décrit les différentes méthodes d’accès incorporant des tableaux de bord que les développeurs peuvent utiliser.


| Method | Description | 
| --- | --- | 
|  `getFilterGroupsForSheet(sheetId: string) `  |  Renvoie tout FilterGroups ce qui est actuellement limité à la feuille fournie dans le paramètre.  | 
|  `getFilterGroupsForVisual(sheetId: string, visualId: string)`  |  Renvoie tout `FilterGroups` ce qui est limité au visuel fourni dans le paramètre.  | 

Si la feuille fournie dans le paramètre n’est pas la feuille actuellement sélectionnée du tableau de bord intégré, les méthodes ci-dessus renvoient une erreur.

**Méthodes getter d’intégration visuelle**

Le tableau suivant décrit les différentes méthodes getter d’intégration visuelle que les développeurs peuvent utiliser.


| Method | Description | 
| --- | --- | 
|  `getFilterGroups()`  |  Renvoie tout `FilterGroups` actuellement limité au visuel intégré.  | 

**Méthodes Setter**

Le tableau suivant décrit les différentes méthodes de réglage que les développeurs peuvent utiliser pour le tableau de bord ou l’intégration visuelle.


| Method | Description | 
| --- | --- | 
|  `addFilterGroups(filterGroups: FilterGroup[])`  |  Ajoute et applique le contenu fourni **FilterGroups**au tableau de bord ou au visuel intégré. Un `ResponseMessage` qui indique si l’ajout a été effectué avec succès est renvoyé.  | 
|  `updateFilterGroups(filterGroups: FilterGroup[])`  |  Met à jour `FilterGroups` sur l’expérience intégrée qui contient la même chose `FilterGroupId` que `FilterGroup` celle fournie dans le paramètre. Un `ResponseMessage` qui indique si la mise à jour a réussi est renvoyée.  | 
|  `removeFilterGroups(filterGroupsOrIds: FilterGroup[] \| string[])`  |  Supprime le contenu fourni FilterGroups du tableau de bord et renvoie un `ResponseMessage` indiquant si la tentative de suppression est réussie.  | 

Le `FilterGroup` contenu fourni doit être limité à la feuille incorporée ou au visuel actuellement sélectionné.