Step5. クーポン

    Step5. クーポン


    記事の要約

    Shoplive Player SDKにクーポンポップアップ機能を連動するためのガイドです。


    LINK / LINK (新しいウィンドウ)

    クーポンクリックイベントをLINKまたはLINK(新しいウィンドウ)に設定した場合のクーポン連携方法です。

    handleNavigation

    クーポンをクリックしたときに呼び出されるコールバック関数。url を受け取り、お客様のアプリのロジックに合わせて実装できます。

    パラメータ

    説明

    url

    String

    定義されたリンクURL。

    サンプルコード

    override fun handleNavigation(context: Context, url: String) {
      // リンク移動
      val intent = Intent(this@YourActivity, WebViewActivity::class.java)
      intent.putExtra("url", url)
      startActivity(intent)
    }


    Download coupon

    クーポンクリックイベントをダウンロードクーポンとして選択した場合のクーポン連携方法です。

    handleDownloadCoupon

    クーポンをクリックしたときに呼び出されるコールバック関数。クーポンIDを受け取ることで、お客様のアプリのロジックに合わせて実装できます。

    パラメータ

    説明

    couponId

    String

    クーポンID

    callback

    ShopLiveHanderCallback

    ユーザーにクーポン発行後、クーポン発行結果を Shoplive に渡すためのオブジェクト

    サンプルコード

    override fun handleDownloadCoupon(
            context: Context,
            couponId: String,
            callback: ShopLiveHandlerCallback
    ) {
        // couponResultのパラメータは下記のAPI Referenceリンクから確認することができます。
        callback.couponResult(
            isDownloadSuccess = true,
            message = "Coupon download success!",
            couponStatus = ShopLive.CouponPopupStatus.HIDE,
            alertType = ShopLive.CouponPopupResultAlertType.ALERT
        )
    }


    User define

    クーポンクリックイベントをユーザー定義として選択した場合のクーポン連携方法です。顧客が必要とする情報をJSON形式で定義してPayloadオブジェクトに追加できます。

    handleCustomAction

    クーポンをクリックしたときに呼び出されるコールバック関数。定義された情報を受け取り、顧客のアプリのロジックに合わせて実装できます。

    パラメータ

    説明

    id

    String

    ポップアップの一意の番号です。

    type

    String

    ポップアップの種類です。(COUPON、BANNER、NOTICE)

    payload

    String

    ユーザー定義の payload data。

    callback

    ShopLiveHanderCallback

    ユーザーにクーポン発行後、クーポン発行結果を Shoplive に渡すためのオブジェクト

    サンプルコード

    override fun handleCustomAction(
            context: Context,
            id: String,
            type: String,
            payload: String,
            callback: ShopLiveHandlerCallback) {
    
        // customActionResultのパラメータは下記のAPI Referenceリンクから確認することができます。
        callback.customActionResult(
            isSuccess = true,
            message = "success!",
            couponStatus = ShopLive.CouponPopupStatus.HIDE,
            alertType = ShopLive.CouponPopupResultAlertType.ALERT
        )
    }