Aller au contenu principal

Ajouter un placement

Le SDK Rokt pour Flutter peut être utilisé pour afficher le placement en superposition au-dessus du contenu de votre application.

Avant de commencer​

Assurez-vous que le SDK Flutter de Rokt a déjà été intégré dans votre application.

Placements en superposition​

Importer le SDK​

Importez le SDK dans le fichier dart de votre application :

import 'package:rokt_sdk/rokt_sdk.dart';

Exécuter le SDK​

Exécutez le SDK au point désiré en ajoutant les attributs client appropriés. Le placement Rokt s'affichera ensuite après un court délai qui peut être configuré via la plateforme Rokt.

Vous pouvez dicter quels attributs client sont inclus dans votre intégration Rokt. Plus d'informations sur les champs de données disponibles sont disponibles sur la page des attributs. Si vous souhaitez intégrer plus d'attributs, vous pouvez ajouter des lignes de code supplémentaires pour chaque nouvel attribut aux exemples ci-dessous.

void executeRokt() {
    // Remplacez RoktExperience par votre viewName
    RoktSdk.execute(
                    viewName: "RoktExperience",
                    attributes: {"email": "j.smith@example.com",
                        "firstname": "Jenny",
                        "lastname": "Smith",
                        "mobile": "(555)867-5309",
                        "postcode": "90210",
                        "country": "US"},
                    onLoad: () {
                        // Callback optionnel pour lorsque le placement Rokt charge
                    },
                    onUnLoad: () {
                        // Callback optionnel pour lorsque le placement Rokt décharge
                    },
                    onShouldShowLoadingIndicator: () {
                        // Callback optionnel pour montrer un indicateur de chargement
                    },
                    onShouldHideLoadingIndicator: () {
                        // Callback optionnel pour cacher un indicateur de chargement
                    });
}
remarque

Le ViewName (“RoktExperience”) peut être modifié lors de l'exécution du SDK à plusieurs endroits pour afficher une expérience différente selon le contexte de l'exécution du SDK dans l'application. Si vous modifiez le ViewName, travaillez avec l'équipe Rokt pour vous assurer que des ajustements correspondants sont effectués au sein du système Rokt.

Emplacements intégrés​

Importer le SDK​

Importer le SDK Rokt dans le fichier JavaScript :

import 'package:rokt_sdk/rokt_sdk.dart';

Ajouter RoktWidget à votre vue​

Ajoutez RoktWidget dans la fonction build de votre vue. Le widget Rokt sera injecté dans cet espace réservé lorsque la méthode execute sera appelée :

const RoktWidget(placeholderName: "RoktEmbedded1")

Veuillez vous assurer que la vue est créée dans la zone visible de l'écran, puis appelez showWidget. RoktWidget a un rappel pour notifier lorsque le widget est créé, ce qui pourrait être utilisé.

RoktWidget(placeholderName: "RoktEmbedded1", onWidgetCreated: () { showWidget() })

Exécuter le SDK Flutter de Rokt​

Exécutez le SDK au point souhaité en envoyant les attributs clients appropriés. Le placement Rokt s'affiche alors après un court délai configurable via la plateforme Rokt.

Vous pouvez dicter quels attributs clients sont inclus dans votre intégration Rokt. Plus d'informations sur les champs de données disponibles peuvent être trouvées sur la page attributes. Si vous souhaitez intégrer plus d'attributs, vous pouvez ajouter des lignes de code supplémentaires pour chaque nouvel attribut aux exemples ci-dessous.

void executeRokt() {
    // Remplacez RoktExperience par votre viewName
    RoktSdk.execute(
                    viewName: "RoktEmbeddedExperience",
                    attributes: {"email": "j.smith@example.com",
                        "firstname": "Jenny",
                        "lastname": "Smith",
                        "mobile": "(555)867-5309",
                        "postcode": "90210",
                        "country": "US"},
                    onLoad: () {
                        // Rappel optionnel pour lorsque le placement Rokt se charge
                    },
                    onUnLoad: () {
                        // Rappel optionnel pour lorsque le placement Rokt se décharge
                    },
                    onShouldShowLoadingIndicator: () {
                        // Rappel optionnel pour afficher un indicateur de chargement
                    },
                    onShouldHideLoadingIndicator: () {
                        // Rappel optionnel pour cacher un indicateur de chargement
                    });
}
remarque

Le ViewName (“RoktEmbeddedExperience”) peut être modifié lors de l'exécution du SDK à plusieurs emplacements. Cette configuration vous permet d'afficher une expérience différente selon le contexte de l'endroit où le SDK est exécuté dans l'application. Si vous modifiez le ViewName ou placeholderName ("RoktEmbedded1"), veuillez travailler avec l'équipe Rokt pour garantir que les ajustements correspondants sont effectués dans le système Rokt.

Événements​

À partir de la version 4.3.0, le SDK Rokt expose un EventChannel pour les événements du SDK

final EventChannel roktEventChannel = EventChannel('RoktEvents');
//...
roktEventChannel.receiveBroadcastStream().listen((dynamic event) {
    debugPrint("Événement Rokt reçu $event");
    switch (event["event"]) {
    case "ShowLoadingIndicator":
        debugPrint("Événement ${event["viewName"]}");
        break;
    case "HideLoadingIndicator":
        debugPrint("Événement ${event["viewName"]}");
        break;
    case "OfferEngagement":
        debugPrint("Événement ${event["viewName"]}, ${event["placementId"]}");
        break;
    case "PositiveEngagement":
        debugPrint("Événement ${event["viewName"]}, ${event["placementId"]}");
        break;
    case "FirstPositiveEngagement":
        debugPrint("Événement ${event["viewName"]}, ${event["placementId"]}");
        break;
    case "PlacementInteractive":
        debugPrint("Événement ${event["viewName"]}, ${event["placementId"]}");
        break;
    case "PlacementReady":
        debugPrint("Événement ${event["viewName"]}, ${event["placementId"]}");
        break;
    case "PlacementClosed":
        debugPrint("Événement ${event["viewName"]}, ${event["placementId"]}");
        break;
    case "PlacementCompleted":
        debugPrint("Événement ${event["viewName"]}, ${event["placementId"]}");
        break;
    case "PlacementFailure":
        debugPrint("Événement ${event["viewName"]}, ${event["placementId"]}");
        break;
    default:
        break;
    }
});

Objets d'événements​

ÉvénementDescriptionAutres propriétés
ShowLoadingIndicatorDéclenché avant que le SDK n'appelle le backend de RoktviewName: String
HideLoadingIndicatorDéclenché lorsque le SDK reçoit un succès ou un échec du backend de RoktviewName: String
OfferEngagementDéclenché lorsque l'utilisateur s'engage avec l'offreviewName: String, placementId: String
PositiveEngagementDéclenché lorsque l'utilisateur s'engage positivement avec l'offreviewName: String, placementId: String
FirstPositiveEngagementDéclenché lorsque l'utilisateur s'engage positivement avec l'offre pour la première foisviewName: String, placementId: String
PlacementInteractiveDéclenché lorsqu'un emplacement a été rendu et est interactifviewName: String, placementId: String
PlacementReadyDéclenché lorsqu'un emplacement est prêt à être affiché mais n'a pas encore rendu de contenuviewName: String, placementId: String
PlacementClosedDéclenché lorsqu'un emplacement est fermé par l'utilisateurviewName: String, placementId: String
PlacementCompletedDéclenché lorsque la progression de l'offre atteint la fin et qu'il n'y a plus d'offres disponibles à afficher.
Également déclenché lorsque le cache est atteint mais que l'emplacement récupéré ne sera pas affiché car il a déjà été rejeté		viewName: String, placementId: String
PlacementFailureDéclenché lorsqu'un emplacement n'a pas pu être affiché en raison d'une défaillanceviewName: String, placementId: String (facultatif)

Callbacks​

Le SDK Rokt Flutter prend en charge les callbacks suivants qui sont passés dans execute:

onLoad​

Le callback onLoad sera appelé lorsque l'emplacement deviendra chargé et interactif. Ce callback ne fournit pas d'arguments et ne renvoie aucune valeur.

onShouldShowLoadingIndicator​

Le onShouldShowLoadingIndicator sera appelé lors d'un appel d'exécution réussi, juste avant que le SDK ne déclenche un appel au backend de Rokt. Il peut être utilisé pour afficher des vues de progression des indicateurs de chargement en attendant que l'emplacement soit chargé. Il ne nécessite aucun argument et ne renvoie aucune valeur.

remarque

Le comportement de ce callback a changé entre la version majeure 3 et la version majeure 4 du SDK Rokt Flutter. Il n'y a plus de délai d'une seconde avant que le callback ne soit exécuté. Si vous utilisez ces callbacks dans la version majeure 3 et passez à la version majeure 4, testez le comportement pour vous assurer que l'expérience utilisateur n'est pas affectée. Vous pouvez créer un comportement de délai adapté aux besoins de vos applications si nécessaire.

onShouldHideLoadingIndicator​

Le rappel onShouldHideLoadingIndicator sera appelé lorsque le SDK obtient une réponse de succès ou d'échec du backend de Rokt. Il peut être utilisé pour annuler les vues de progression ou les indicateurs de chargement. Il ne nécessite aucun argument et ne renvoie aucune valeur.

onUnload​

Le rappel onUnload sera appelé lorsque le SDK ferme le placement. Il sera également déclenché si l'appel d'exécution échoue. Il ne nécessite aucun argument et ne renvoie aucune valeur.

Cet article vous a-t-il été utile ?