メインコンテンツまでスキップ

プレースメントを追加する

Roktパートナー向けに、Android SDKを使用して、あなたのAndroidアプリにオーバーレイまたは埋め込みプレースメントを表示することができます。

始める前に​

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

オーバーレイプレースメント​

SDKを希望するアクティビティ/フラグメントで実行し、適切な顧客属性とプレースメントマッピングを追加します。例のコードは、onCreateメソッドを使用してプレースメントを起動します。

Roktウィジェットビューは短い遅延の後に表示され、これはRoktプラットフォームを介して設定可能です。SDKは、ビューがロードおよびアンロードされるときのオプションのコールバックイベントを提供します。

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

import com.rokt.roktsdk.Rokt;

class ConfirmationActivity : Activity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        ...

        Map<String,String> attributes = new HashMap<String, String>();

        attributes.put("email", "j.smith@example.com");
        attributes.put("firstname", "Jenny");
        attributes.put("lastname", "Smith");
        attributes.put("mobile", "(323) 867-5309");
        attributes.put("postcode", "90210");
        attributes.put("country", "US");

        Rokt.INSTANCE.execute("RoktExperience",
            attributes,
            new Rokt.RoktCallback() {
                @Override
                public void onLoad() {
                }
                @Override
                public void onUnload(Rokt.UnloadReasons unloadReasons) {
                }
                @Override
                public void onShouldHideLoadingIndicator() {
                }
                @Override
                public void onShouldShowLoadingIndicator() {
                }
            }
        )
        ...
    }
}

オプション機能​

関数目的
Rokt.close()オーバーレイプレースメントを自動的に閉じるために使用されます。

埋め込みプレースメント​

レイアウトXMLファイルの更新​

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".MainActivity">

    <com.rokt.roktsdk.Widget
        android:id="@+id/roktWidget"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toTopOf="parent" />

</androidx.constraintlayout.widget.ConstraintLayout>
注記

Roktの埋め込みプレースメントは、コード内で作成し、動的にレイアウトに含めることもできます。

SDKの実行​

SDKを希望するアクティビティ/フラグメントで実行し、適切な顧客属性とプレースメントマッピングを追加します。以下のサンプルコードでは、onCreateメソッドを使用してプレースメントを起動します。

Roktプレースメントは、Roktプラットフォームを介して設定可能な短い遅延の後に表示されます。

プレースメントの高さを動的に設定できるように、プレースメントの高さをwrap_contentに設定することをお勧めします。

SDKは、ビューがロードおよびアンロードされるときのオプションのコールバックイベントを提供します。

Rokt統合に含める顧客属性を選択できます。利用可能なデータフィールドの詳細については、attributesページをご覧ください。追加の属性を追加したい場合は、以下のサンプルに新しい属性ごとに追加のコード行を追加できます。

import com.rokt.roktsdk.Widget;
import com.rokt.roktsdk.Rokt;

class ConfirmationActivity : Activity() {

    private Rokt.RoktCallback roktCallback = new Rokt.RoktCallback() {
        @Override
        public void onLoad() {
        }

        @Override
        public void onShouldShowLoadingIndicator() {
        }

        @Override
        public void onShouldHideLoadingIndicator() {
        }

        @Override
        public void onUnload(@NotNull Rokt.UnloadReasons unloadReasons) {
        }
    };

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        ...

        Map<String, String> attributes = new HashMap<String, String>();

        attributes.put("email", "j.smith@example.com");
        attributes.put("firstname", "Jenny");
        attributes.put("lastname", "Smith");
        attributes.put("mobile", "(323) 867-5309");
        attributes.put("postcode", "90210");
        attributes.put("country", "US");

        // Widget placeholder mapping the placeholder view with placement location configuration
        Widget widget = findViewById(R.id.roktWidget);
        Map<String, WeakReference<Widget>> placeHolders = new HashMap<>();
        placeHolders.put("RoktEmbedded1", new WeakReference<>(widget));

        Rokt.INSTANCE.execute("RoktExperience",
                attributes,
                roktCallback,
                placeHolders);
        ...
    }
}
注記

ビュー名 RoktExperience またはプレースホルダー名 RoktEmbedded1 を別の値に更新したい場合は、Roktのアカウントマネージャーに連絡して、Roktの配置が一貫して構成されていることを確認してください。

Jetpack Compose コンポーネント​

Rokt Android SDK のメジャーバージョン 4 から、RoktLayout コンポーザブルを使用して Rokt レイアウトを追加できます。これにより、Rokt.execute を呼び出す必要がなくなり、Compose を使用したよりモダンな宣言型統合がサポートされます。

コンポーネントの追加​

import com.rokt.roktsdk.RoktLayout

@Composable
fun MainScreen(modifier: Modifier = Modifier) {
    Column(
        modifier = modifier
            .background(Color.LightGray)
            .padding(8.dp),
    ) {
        RoktLayout(
            sdkTriggered = true,
            viewName = "RoktExperience",
            attributes = hashMapOf(
                Pair("email", "j.smith@example.com"),
                Pair("firstname", "Jenny"),
                Pair("lastname", "Smith"),
                Pair("mobile", "(323) 867-5309"),
                Pair("postcode", "90210"),
                Pair("country", "US")
            ),
            location = "RoktEmbedded1", // 埋め込みレイアウトを使用する場合
            onLoad = {},
            onUnload = {},
            onShouldShowLoadingIndicator = {},
            onShouldHideLoadingIndicator = {},
        )
    }
}
注記

RoktLayout コンポーザブルは、埋め込みレイアウトとオーバーレイレイアウトの両方に使用できます。

イベント​

SDKは、各ページのイベントをRokt.events APIを通じてストリームとして提供します。SDKユーザーは、Kotlin Flowメカニズムを活用してSDKが生成するイベントを消費することができます。

// owner: LifecycleOwner
owner.lifecycleScope.launch {
    owner.lifecycle.repeatOnLifecycle(Lifecycle.State.CREATED) {
        Rokt.events("viewName").collect { roktEvent ->
            Log.d("RoktEvent", "Event received $roktEvent")
        }
    }
}

イベントオブジェクト​

イベント説明パラメータ
ShowLoadingIndicatorSDKがRoktバックエンドを呼び出す前にトリガーされます
HideLoadingIndicatorSDKがRoktバックエンドから成功または失敗を受け取ったときにトリガーされます
OfferEngagementユーザーがオファーにエンゲージしたときにトリガーされますplacementId: String
PositiveEngagementユーザーがオファーにポジティブにエンゲージしたときにトリガーされますplacementId: String
FirstPositiveEngagementユーザーが初めてオファーにポジティブにエンゲージしたときにトリガーされますplacementId: String, fulfillmentAttributes: FulfillmentAttributes
PlacementInteractiveプレースメントがレンダリングされ、インタラクティブになったときにトリガーされますplacementId: String
PlacementReadyプレースメントが表示準備ができたが、まだコンテンツがレンダリングされていないときにトリガーされますplacementId: String
PlacementClosedユーザーがプレースメントを閉じたときにトリガーされますplacementId: String
PlacementCompletedオファーの進行が終了し、表示するオファーがもうないときにトリガーされますplacementId: String
PlacementFailure何らかの失敗によりプレースメントを表示できなかったときにトリガーされますplacementId: String (オプション)

コールバック​

Rokt Android SDKは、executeにRokt.RoktCallbackオブジェクトとして渡される以下のコールバックをサポートしています:

onLoad​

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

onShouldShowLoadingIndicator​

onShouldShowLoadingIndicatorは、成功したexecute呼び出しの直後、SDKがRoktバックエンドへの呼び出しをトリガーする直前に呼び出されます。プレースメントが読み込まれるのを待っている間、読み込みインジケーターの進行状況ビューを表示するために使用できます。引数を必要とせず、値を返しません。

注記

このコールバックの動作は、Rokt Android SDKのメジャーバージョン3とメジャーバージョン4の間で変更されました。コールバックが実行される前に1秒の遅延はなくなりました。メジャーバージョン3でこれらのコールバックを使用していて、メジャーバージョン4にアップグレードする場合、ユーザーエクスペリエンスに影響がないことを確認するために動作をテストしてください。必要に応じて、アプリケーションのニーズに合った遅延動作を作成できます。

onShouldHideLoadingIndicator​

onShouldHideLoadingIndicator コールバックは、SDK が Rokt バックエンドから成功または失敗のレスポンスを取得したときに呼び出されます。これを使用して、進行状況ビューやローディングインジケーターをキャンセルすることができます。引数は必要なく、値も返しません。

onUnload​

onUnload コールバックは、SDK がプレースメントを閉じたときに呼び出されます。また、execute 呼び出しが失敗した場合にもトリガーされます。引数として Rokt.UnloadReasons を受け取りますが、値は返しません。アンロードの理由は以下の通りです:

値理由
NO_OFFERS表示する適格なオファーがありません
FINISHEDレンダリングされたプレースメントまたはレイアウトが閉じられました
TIMEOUTバックエンドからのレスポンス要求がタイムアウトしました
NETWORK_ERRORネットワークエラーが発生しました
NO_WIDGET返されたプレースメントまたはレイアウトが無効または空です
INIT_FAILEDexecute が呼び出される前に初期化リクエストが失敗しました
UNKNOWN_PLACEHOLDERプレースホルダー文字列の不一致 (4.x.x から利用可能)
UNKNOWNキャッチオール理由
この記事は役に立ちましたか？