Shopliveプレーヤーを実行する際に、ログインしているユーザーのIDと名前を手動で入力する方法です。クライアントとサーバー間のJWT認証の実装が困難な場合や、Shopliveプレーヤーの迅速な統合が必要な場合に利用されます。
プロパティ | 説明 | サンプル | コメント |
---|
userId (必須) | ユーザーID | shoplive | ログインしたユーザーの一意性を保証する値 |
userName | ユーザー名 (チャットウィンドウで使用) | ユーザー名 | 名前を指定しない場合は、チャットでユーザー入力を強制するか、キャンペーンのチャット設定に従ってランダムに作成することができます。 |
gender | ユーザーの性別 | 空 (指定なし)、m (男性)、f (女性) | 合計/ログイン視聴者のデータを性別ごとに確認できます。 |
age | ユーザーの年齢 | 25 | 合計/ログイン視聴者のデータを年齢ごとに確認できます。 |
custom | カスタムデータ | カスタムデータ | 任意のデータを1KBまで設定できます。 合計/ログイン視聴者のデータを、カスタムデータの区分ごとに確認できます。 |
userScore | ユーザー評価 | 10 | ユーザーレーティングを設定すると、レーティングに応じて入場イベントや抽選イベントをパーソナライズするための基準として使用できます。 整数は -100 から 100 まで使用できます。 |
userType | ユーザーの種類 | VIP | エントリ制限(エントリタイプ)を設定してブロードキャストに入る場合、この値を参照して、特定のユーザー(VIP)専用のアクセスを設定できます。 |
profile | ユーザー プロフィール画像の URL | https://image.shoplive.cloud/sample_profile.png | ライブ配信のチャット一覧にプロフィール画像を表示する場合、画像のパスを直接設定できます。 推奨される画像サイズは 64px X 64px です。画像ファイルのサイズを過度に大きくしないようご注意ください。 |
以下のサンプルコードを参照してください。
<script type="text/javascript" src="https://static.shoplive.cloud/shoplive.js"></script>
<script>
const userObject =
{
userId: "{userID_here}", // required
userName: "{userName_here}", // optional
gender: "m", // optional
age: 25, // optional
custom: "custom data", // optional
userScore: 10, // optional
userType: "VIP", // optional
profile: "https://image.shoplive.cloud/sample_profile.png" // optional
}
);
//send with init
cloud.shoplive.init({ accessKey: 'YOUR ACCESS KEY HERE', userObject});</script>
<!-- OR -->
<script type="text/javascript" src="https://static.shoplive.cloud/shoplive.js"></script>
<script>
const userObject =
{
userId: "{userID_here}", // required
userName: "{userName_here}", // optional
gender: "m", // optional
age: 25, // optional
custom: "custom data", // optional
userScore: 10, // optional
userType: "VIP", // optional
profile: "https://image.shoplive.cloud/sample_profile.png" // optional
}
);
cloud.shoplive.init({ accessKey: 'YOUR ACCESS KEY HERE' });
//send with setUserObject()
cloud.shoplive.setUserObject(userObject);
</script>