オークション機能の実装

    オークション機能の実装


    記事の要約

    ShopLiveはリアルタイムオークション機能を提供しており、オークション機能には簡単な開発連携が必要です。

    オークションアイテムの作成方法とオークションの実行方法については、以下のガイドを参照してください。

    オークションを有効にするためのデータの追加

    オークションへの参加は、 ユーザー認証 ガイドに従って確認済みユーザー(ログインユーザー)のみが利用でき、canBidパラメータがtrueに設定されています。

    簡単な認証 ペイロード

    財産

    形容

    見本

    コメント

    ユーザー ID
    (必須)

    ユーザー名

    sample_user_id

    ログインしたユーザーの一意性を保証できる値

    ユーザー名

    お名前 *

    (チャットでの利用)

    ニックネーム

    名前を指定しない場合は、キャンペーンのチャット設定に応じて、チャットでの入力を強制するか、ランダムに生成するかを選択できます。

    ジェンダー

    ユーザーの性別

    空白 値(未指定)、m(男性)、f(女性)

    すべて/ログインした閲覧者データで確認できます。

    年齢

    ユーザーの年齢

    25

    すべて/ログインした閲覧者データで確認できます。

    習慣

    ユーザー・ランダム・データ

    カスタムデータ

    最大1KBまで任意のデータを設定できます。

    すべて/ログインした閲覧者データで確認できます。

    userScore(ユーザースコア)

    ユーザー評価

    10

    ユーザーレーティングを設定したら、レベルに基づいてエントリーを制限したり、イベントの抽選を制限したりするための基準として使用できます。

    -100 から 100 までの整数に設定できます。

    ユーザータイプ

    ユーザーの種類

    要人

    エントリタイプでブロードキャストに入る場合、値を参照して、特定のユーザー(VIP)のみにブロードキャストに入るように設定できます。

    プロフィール

    ユーザー プロフィール画像の URL

    https://image.shoplive.cloud/sample_profile.png

    ストリームのチャット一覧にプロフィール画像を表示する場合、画像パスを自分で設定できます。

    推奨される画像サイズは 64px x 64px です。画像ファイルのサイズを大きくしすぎないように注意してください。

    canBid(キャンビッド)

    オークション参加の可否

    この値はtrueまたはfalseであり、この値に応じて、オークション入札が可能かどうかが判断されます。

     JWT認証ペイロード

    財産

    形容

    見本

    コメント

    満了
    (必須)

    有効期限 (タイムスタンプ)

    1516239022

    トークンの有効期限

    ユーザー ID
    (必須)

    ユーザー名

    sample_user_id

    ログインしたユーザーの一意性を保証できる値

    名前

    お名前 *

    (チャットでの利用)

    ニックネーム

    名前を指定しない場合は、キャンペーンのチャット設定に応じて、チャットでの入力を強制するか、ランダムに生成するかを選択できます。

    ジェンダー

    ユーザーの性別

    空白 値(未指定)、m(男性)、f(女性)

    すべて/ログインした閲覧者データで確認できます。

    年齢

    ユーザーの年齢

    25

    すべて/ログインした閲覧者データで確認できます。

    習慣

    ユーザー・ランダム・データ

    カスタムデータ

    最大1KBまで任意のデータを設定できます。

    すべて/ログインした閲覧者データで確認できます。

    userScore(ユーザースコア)

    ユーザー評価

    10

    ユーザーレーティングを設定したら、レベルに基づいてエントリーを制限したり、イベントの抽選を制限したりするための基準として使用できます。

    -100 から 100 までの整数に設定できます。

    ユーザータイプ

    ユーザーの種類

    要人

    エントリタイプでブロードキャストに入る場合、値を参照して、特定のユーザー(VIP)のみにブロードキャストに入るように設定できます。

    プロフィール

    ユーザー プロフィール画像の URL

    https://image.shoplive.cloud/sample_profile.png

    ストリームのチャット一覧にプロフィール画像を表示する場合、画像パスを自分で設定できます。

    推奨される画像サイズは 64px x 64px です。画像ファイルのサイズを大きくしすぎないように注意してください。

    canBid(キャンビッド)

    オークションへの参加資格。

    この値はtrueまたはfalseであり、この値に応じて、オークション入札が可能かどうかが判断されます。

    落札者のページへのリンク

    オークションの落札者には、オークションの落札通知シートが表示されます。

    シートの「購入」ボタンをクリックすると、配信される ON_CLICK_BUY_BUTTON で目的のアクションを定義できます。

    サンプルコード

    <script
         type="text/javascript"
         src="https://static.shoplive.cloud/shoplive.js"></script>
    
    
    <script>
    Let messageCallback = {
    /* This is the event triggered when the user clicks the purchase button displayed at the end of the auction.
    For reference to the payload, I have redefined it to only console.log the payload without redirecting to a URL. */
    ON_CLICK_BUY_BUTTON:(payload)=> {
             console.log(payload)
             console.log(`winner ${payload.auction.winner.name}`)
             console.log(`winningPrice ${payload.auction.winningPrice.value}`)
           }
    }
    cloud.shoplive.init({
           accessKey: ACCESS_KEY,
           messageCallback: messageCallback,     
         });
    // Set the user userID and userName, and simultaneously pass canBid:true.
    cloud.shoplive.setUserObject({userId: “{userId}”, userName: “{userName}”, canBid:true,});
    </script>
    
    
    <div id="shoplive_div"></div>
    <script defer>
         cloud.shoplive.setPlayer("shoplive_div", {
           campaignKey: campaignKey,
           isFullScreen: true,
         });
       </script>