Sélection
Aperçu
Objet représentant une sélection Rokt disponible en tant que résultat de IntegrationLauncher.selectPlacements.
Méthodes
close
▸ close(): Promise<void>
Ferme tous les emplacements de la sélection. Selon que le processus de sélection de Rokt est toujours en cours, la méthode :
- supprime les emplacements déjà ajoutés sur une page
- empêche les emplacements d'être ajoutés en premier lieu
Renvoie : Promise<void>
getPlacements
▸ getPlacements(): Promise<Array<Placement>>
Obtient tous les emplacements renvoyés pour la sélection. La méthode renvoie dès que le processus de sélection de Rokt a conclu qu'il existe des emplacements disponibles à afficher sur une page, mais avant que les emplacements ne soient chargés sur la page.
Si aucun emplacement n'est disponible pour la page, la méthode se résout avec un tableau vide. Si, pour une raison quelconque, le processus de sélection échoue, la méthode rejette la promesse avec une erreur.
Renvoie: Promise<void>
on
▸ on<T>(event: string): Subscriber<SelectionEvent<T>>
Permet de s'abonner à des événements portant un nom spécifique provenant de n'importe quel emplacement de la sélection. La méthode s'abonne effectivement à Placement.on invoqué pour chacun des emplacements.
Paramètres :
| Nom | Type | Description |
|---|---|---|
event | string | Nom de l'événement auquel s'abonner |
Renvoie : Subscriber<T>
ready
▸ ready(): Promise<T>
Permet d'attendre que chaque emplacement soit prêt. C'est essentiellement la même chose que d'attendre que chaque Placement prêt dans la sélection soit résolu.
Si l'un des emplacements de la sélection ne parvient pas à se charger pour une raison quelconque, la promesse sera rejetée avec une erreur.
Renvoie: Promise<void>
send
▸ send<T>(name: string, data?: T): Promise<void>
Permet d'envoyer un événement à chaque emplacement. C'est essentiellement la même chose que d'appeler Placement.send pour chaque emplacement de la sélection.
La promesse renvoyée sera résolue une fois que tous les emplacements auront traité le message.
Paramètres:
| Nom | Type | Description |
|---|---|---|
name | string | Nom de l'événement |
data | T | Charge utile attendue pour un événement donné |
Renvoie: Promise<void>
setAttributes
▸ setAttributes(): Promise<void>
Permet de définir des attributs supplémentaires pour la sélection.
Pour des raisons de pertinence, tous les attributs doivent être envoyés lors de la sélection. Cette méthode permet de divulguer des valeurs non hachées si les attributs hachés ont été initialement envoyés avec la sélection dans l'intégration de données en deux étapes.
Renvoie: Promise<void>
Propriétés
context
• contexte : SelectionContexte
Contexte de la sélection effectuée par Rokt.