Last updated

配置を追加する

Rokt .NET MAUI SDKは、Roktのパートナーがオーバーレイおよび埋め込み配置を表示するため、またはRoktの広告主がキャンペーンのコンバージョンを記録するために使用できます。

始める前に

Rokt .NET MAUI SDKがあなたのアプリケーションに統合されていることを確認してください。

オーバーレイ配置

SDKを実行する

必要なポイントで適切な顧客属性を追加してSDKを実行してください。その後、Rokt配置が表示されます。

あなたのRokt統合に含まれる顧客属性を指定できます。利用可能なデータフィールドの詳細は、属性ページで確認できます。さらに多くの属性を統合したい場合は、新しい属性ごとに以下のサンプルに追加のコード行を追加することができます。

using Rokt.Maui.Sdk;
// RoktExperienceをあなたの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: () => {
        // Rokt配置がロードされたときのオプションのコールバック
    },
    onUnload: () => {
        // Rokt配置がアンロードされたときのオプションのコールバック
    },
    onShouldShowLoadingIndicator: () => {
        // ローディングインジケータを表示するためのオプションのコールバック
    },
    onShouldHideLoadingIndicator: () => {
        // ローディングインジケータを非表示にするためのオプションのコールバック
    }
);

注記

viewName （“RoktExperience”）は、アプリの中の異なるコンテキストに応じて異なる体験を表示するために、SDKを複数の場所で実行する際に変更することができます。viewNameを変更する場合は、Roktシステム内で一致する調整が行われるようにRoktチームと協力してください。

埋め込みプレースメント

RoktEmbeddedViewHandlerの設定

まず、MauiAppBuilderでRoktEmbeddedViewとそのハンドラーを設定する必要があります。

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();
    }
}

RoktEmbeddedViewHandlerの追加

ページのXAMLにRoktEmbeddedViewを追加します。

<?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>

Rokt .NET MAUI SDK の実行

適切な顧客属性を送信して、目的のポイントでSDKを実行します。Rokt配置は、Roktプラットフォームを介して設定可能な短い遅延の後に表示されます。

Rokt統合に含める顧客属性を指定できます。利用可能なデータフィールドの詳細は、attributesページで確認できます。より多くの属性を統合したい場合は、以下のサンプルに新しい属性ごとに追加のコード行を追加できます。

using Rokt.Maui.Sdk;
// RoktEmbeddedExperience を 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: () => {
        // Rokt配置がロードされたときのオプションのコールバック
    },
    onUnload: () => {
        // Rokt配置がアンロードされたときのオプションのコールバック
    },
    onShouldShowLoadingIndicator: () => {
        // ローディングインジケーターを表示するオプションのコールバック
    },
    onShouldHideLoadingIndicator: () => {
        // ローディングインジケーターを非表示にするオプションのコールバック
    }
);

注記

viewName (“RoktEmbeddedExperience”)は、SDKを複数の場所で実行する際に修正できます。この設定により、SDKがアプリ内のどこで実行されるかに応じて異なる体験を表示することができます。viewNameやplaceholderName("RoktEmbedded1")を変更する場合は、Roktシステム内で一致する調整が行われるようにRoktチームと協力してください。

イベント

Rokt .NET MAUI SDKは、SDKイベントのためにIAsyncEnumerableインターフェースを介して非同期ストリームを公開しています。たとえば、Roktを呼び出すページでRoktEvents()を反復してイベントをリッスンし反応することができます。

public partial class MainPage : ContentPage
{
    public MainPage()
    {
        InitializeComponent();
        // ページが読み込まれたときにリッスンを開始
        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);
        }
    }
}

イベントオブジェクト

イベント	説明	その他のプロパティ
ShowLoadingIndicator	SDKがRoktバックエンドを呼び出す前にトリガされます	ViewName: string
HideLoadingIndicator	SDKがRoktバックエンドから成功または失敗を受け取ったときにトリガされます	ViewName: string
OfferEngagement	ユーザーがオファーに関与したときにトリガされます	ViewName: string, PlacementId: string
PositiveEngagement	ユーザーがオファーに積極的に関与したときにトリガされます	ViewName: string, PlacementId: string
PlacementInteractive	プレースメントがレンダリングされ、インタラクト可能になったときにトリガされます	ViewName: string, PlacementId: string
PlacementReady	プレースメントが表示する準備ができているが、まだコンテンツをレンダリングしていないときにトリガされます	ViewName: string, PlacementId: string
PlacementClosed	ユーザーによってプレースメントが閉じられたときにトリガされます	ViewName: string, PlacementId: string
PlacementCompleted	オファーの進行が終了し、表示するオファーがもうないときにトリガされます	ViewName: string, PlacementId: string
PlacementFailure	何らかの失敗によりプレースメントが表示できなかったときにトリガされます	ViewName: string, PlacementId: string (optional)

コールバック

Rokt .NET MAUI SDK は、execute に渡される次のコールバックをサポートしています。

onLoad

onLoad コールバックは、配置が読み込まれインタラクティブになったときに呼び出されます。このコールバックは引数を提供せず、値を返しません。

onShouldShowLoadingIndicator

onShouldShowLoadingIndicator は、SDK が Rokt バックエンドへの呼び出しをトリガーする直前に、成功した実行呼び出しの際に呼び出されます。これは、配置が読み込まれるのを待つ間、ローディングインジケーターの進捗ビューを表示するために使用できます。引数を必要とせず、値を返しません。

onShouldHideLoadingIndicator

onShouldHideLoadingIndicator コールバックは、SDK が Rokt バックエンドからの成功または失敗の応答を受け取ったときに呼び出されます。これは、進捗ビューやローディングインジケーターをキャンセルするために使用できます。引数を必要とせず、値を返しません。

onUnload

onUnload コールバックは、SDK が配置を閉じたときに呼び出されます。実行呼び出しが失敗した場合にもトリガーされます。引数を必要とせず、値を返しません。