Last updated 2024年7月16日

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

Rokt Cordova SDK は、Rokt パートナーがオーバーレイプレースメントを表示するため、または Rokt 広告主がキャンペーンのコンバージョンを記録するために使用できます。

始める前に

Rokt Cordova SDK がアプリケーションに統合されていることを確認してください。

Rokt Cordova SDK を実行する

プレースメントを表示するために Rokt Cordova SDK を execute します。successCallback は、SDK イベントを追跡するためのメッセージパラメータを返します。

RoktSDK.execute(
    "RoktExperience",
    {
        "email" : "j.smith@example.com",
        "firstname": "Ginger",
        "lastname": "Smith",
        "mobile": "(555)867-5309",
        "postcode": "90210",
        "country": "US"
    },
    function(msg) {
        console.log(msg);
        
        // msg can be any of these
        // 1. onLoad - your placement loads
        // 2. onUnload - your placement unloads
        // 3. onShouldHideLoadingIndicator - hook to show a loading indicator
        // 4. onShouldShowLoadingIndicator - hook to hide a loading indicator
    },
    function(err) {
        console.log(err);
    }
);

コールバック

Rokt Cordova SDKは、Cordovaプラグインの結果を通じてコールバックをサポートしています。execute関数に渡された関数内でコールバック値をリッスンすることができます:

RoktSDK.execute(
    "RoktExperience",
    {
        "email" : "j.smith@example.com",
        "firstname": "Ginger",
        "lastname": "Smith",
        "mobile": "(555)867-5309",
        "postcode": "90210",
        "country": "US"
    },
    function(callbackValue) {
        switch (callbackValue) {
            case "onLoad":
            // onLoad
            case "onUnLoad":
            // onUnLoad
            case "onShouldShowLoadingIndicator":
            // onShouldShowLoadingIndicator
            case "onShouldHideLoadingIndicator":
            // onShouldHideLoadingIndicator
            default:
            // default
        }
    },
    function(err) {
        console.log(err);
    }
);

コールバックタイプ

onLoad

onLoad コールバックは、プレースメントが読み込まれてインタラクティブになったときに呼び出されます。

onShouldShowLoadingIndicator

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

onShouldHideLoadingIndicator

onShouldHideLoadingIndicator コールバックは、SDK が Rokt バックエンドから成功または失敗の応答を取得したときに呼び出されます。進行ビューや読み込みインジケーターをキャンセルするために使用できます。

onUnload

onUnload コールバックは、SDK がプレースメントを閉じるときに呼び出されます。execute 呼び出しが失敗した場合にもトリガーされます。

アプリケーション設定の使用

アプリケーションは、独自のアプリケーション環境から設定を送信できるようになりました。これにより、Rokt SDK はシステムのデフォルトに依存するのではなく、アプリケーションのカスタム設定を使用できるようになります。

// アプリケーションがライトモードのみをサポートしている場合。
const roktConfig = new RoktSDK.RoktConfigBuilder()
    .withColorMode(RoktSDK.COLOR_MODE.LIGHT)
    .build();
RoktSdk.executeWithConfig(
    // 他のパラメータ,
    roktConfig,
)

ColorMode オブジェクト

値	説明
LIGHT	アプリケーションはライトモードです
DARK	アプリケーションはダークモードです
SYSTEM	アプリケーションはシステムのカラーモードをデフォルトにします