Ajouter un emplacement (ancien)

Le SDK Rokt .NET MAUI peut être utilisé par les partenaires Rokt pour afficher des emplacements superposés et intégrés, ou par les annonceurs Rokt pour enregistrer des conversions pour des campagnes.

Avant de commencer

Assurez-vous que le SDK Rokt .NET MAUI a été intégré dans votre application.

Emplacements superposés

Exécuter le SDK

Exécutez le SDK au moment souhaité en ajoutant les attributs client appropriés. L'emplacement Rokt s'affichera alors.

Vous pouvez dicter quels attributs client sont inclus dans votre intégration Rokt. Plus d'informations sur les champs de données disponibles peuvent être trouvées 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.

using Rokt.Maui.Sdk;
// Remplacez RoktExperience par votre viewName
Rokt.Maui.Sdk.Rokt.Execute(
    viewName: "RoktExperience", 
    attributes: new Dictionary<string, string>()
    {
        {"email", "j.smith@example.com"},
        {"firstname", "Jenny"},
        {"lastname", "Smith"},
        {"mobile", "(555)867-5309"},
        {"postcode", "90210"},
        {"country", "US"}
    },
    onLoad: () => {
        // Callback optionnel pour lorsque l'emplacement Rokt se charge
    },
    onUnload: () => {
        // Callback optionnel pour lorsque l'emplacement Rokt se décharge
    },
    onShouldShowLoadingIndicator: () => {
        // Callback optionnel pour afficher un indicateur de chargement
    },
    onShouldHideLoadingIndicator: () => {
        // Callback optionnel pour masquer 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 où le SDK est exécuté dans l'application. Si vous modifiez le viewName, travaillez avec l'équipe Rokt pour vous assurer que les ajustements correspondants sont effectués dans le système Rokt.

Placements intégrés

Configurer le RoktEmbeddedViewHandler

Vous devez d'abord configurer le RoktEmbeddedView et son gestionnaire dans votre MauiAppBuilder.

using Rokt.Maui.Sdk;

public static class MauiProgram
{
    public static MauiApp CreateMauiApp()
    {
        var builder = MauiApp.CreateBuilder();
        builder
            .UseMauiApp<App>()
            .ConfigureMauiHandlers(handlers =>
            {
                handlers.AddHandler(typeof(RoktEmbeddedView), typeof(RoktEmbeddedViewHandler));
            });
        return builder.Build();
    }
}

Ajouter le RoktEmbeddedViewHandler

Ajoutez le RoktEmbeddedView à la XAML de votre page.

<?xml version="1.0" encoding="utf-8" ?>
<ContentPage xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
             xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
             xmlns:sdk="clr-namespace:Rokt.Maui.Sdk;assembly=Rokt.Maui.Sdk"
             x:Class="SampleApp.MainPage">

    <ScrollView>
        <VerticalStackLayout
            Padding="30,0"
            Spacing="25">
            
            <sdk:RoktEmbeddedView
                x:Name="RoktEmbedded1"/>

        </VerticalStackLayout>
    </ScrollView>

</ContentPage>

Exécuter le SDK Rokt .NET MAUI

Exécutez le SDK au moment souhaité en envoyant 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 déterminer quels attributs client sont inclus dans votre intégration Rokt. Plus d'informations sur les champs de données disponibles peuvent être trouvées sur la page 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.

using Rokt.Maui.Sdk;
// Remplacez RoktEmbeddedExperience par votre viewName
Rokt.Maui.Sdk.Rokt.Execute(
    viewName: "RoktEmbeddedExperience", 
    attributes: new Dictionary<string, string>()
    {
        {"email", "j.smith@example.com"},
        {"firstname", "Jenny"},
        {"lastname", "Smith"},
        {"mobile", "(555)867-5309"},
        {"postcode", "90210"},
        {"country", "US"}
    },
    placeholders: new Dictionary<string, RoktEmbeddedView>()
    {
        {"RoktEmbedded1", RoktEmbedded1}
    },
    onLoad: () => {
        // Callback optionnel pour lorsque le placement Rokt se charge
    },
    onUnload: () => {
        // Callback optionnel pour lorsque le placement Rokt se décharge
    },
    onShouldShowLoadingIndicator: () => {
        // Callback optionnel pour afficher un indicateur de chargement
    },
    onShouldHideLoadingIndicator: () => {
        // Callback optionnel pour masquer 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 où le SDK est exécuté dans l'application. Si vous modifiez le viewName ou le placeholderName ("RoktEmbedded1"), veuillez travailler avec l'équipe Rokt pour vous assurer que les ajustements correspondants sont effectués dans le système Rokt.

Événements

Le SDK Rokt .NET MAUI expose un flux asynchrone via l'interface IAsyncEnumerable pour les événements du SDK. Par exemple, pour écouter et réagir aux événements, vous pouvez itérer sur RoktEvents() sur la page où vous appelez Rokt.

public partial class MainPage : ContentPage
{
    public MainPage()
    {
        InitializeComponent();
        // Commencez à écouter lorsque la page se charge
        Loaded += OnPageLoaded;
    }

    private async void OnPageLoaded(object? sender, System.EventArgs e)
    {
        await foreach(var roktEvent in Rokt.Maui.Sdk.Rokt.RoktEvents())
        {
            Console.Out.Writeline(roktEvent);
        }
    }
}

Objets d'événement

Événement	Description	Autres propriétés
ShowLoadingIndicator	Déclenché avant que le SDK appelle le backend Rokt	ViewName: string
HideLoadingIndicator	Déclenché lorsque le SDK reçoit un succès ou un échec du backend Rokt	ViewName: string
OfferEngagement	Déclenché lorsque l'utilisateur interagit avec l'offre	ViewName: string, PlacementId: string
PositiveEngagement	Déclenché lorsque l'utilisateur interagit positivement avec l'offre	ViewName: string, PlacementId: string
PlacementInteractive	Déclenché lorsqu'un emplacement a été rendu et est interactif	ViewName: string, PlacementId: string
PlacementReady	Déclenché lorsqu'un emplacement est prêt à être affiché mais n'a pas encore rendu de contenu	ViewName: string, PlacementId: string
PlacementClosed	Déclenché lorsqu'un emplacement est fermé par l'utilisateur	ViewName: string, PlacementId: string
PlacementCompleted	Déclenché lorsque la progression de l'offre atteint la fin et qu'il n'y a plus d'offres à afficher	ViewName: string, PlacementId: string
PlacementFailure	Déclenché lorsqu'un emplacement n'a pas pu être affiché en raison d'un échec ou lorsqu'aucun emplacement n'est disponible pour être affiché	ViewName: string, PlacementId: string (optionnel)

Callbacks

Le SDK Rokt .NET MAUI prend en charge les callbacks (rappels) suivants qui sont passés dans execute :

onLoad

Le callback onLoad sera appelé lorsque le placement sera chargé et interactif. Ce callback ne fournit aucun argument et ne retourne aucune valeur.

onShouldShowLoadingIndicator

Le onShouldShowLoadingIndicator sera appelé après un appel execute réussi, juste avant que le SDK ne déclenche un appel vers le backend Rokt. Il peut être utilisé pour afficher des vues de progression des indicateurs de chargement en attendant que le placement soit chargé. Il ne nécessite aucun argument et ne retourne aucune valeur.

onShouldHideLoadingIndicator

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

onUnload

Le callback onUnload sera appelé lorsque le SDK ferme le placement. Il sera également déclenché si l'appel execute échoue. Il ne nécessite aucun argument et ne retourne aucune valeur.