Channel Developers

このドキュメントでは、JavaScript SDK(以下「SDK」)の初期設定について説明します。

SDKは、Webサービスにチャネルボタンを簡単に設置できるようにします。

以下の2つの方法からいずれかを選択して設置してください。

Webサービスが複数のページで構成されており、各ページをリクエストするたびに新しい静的リソースをロードする場合は、以下のガイドを参照してください。

上記のような方式で動作するWebサービスは、一般的にMPAと呼ばれます。

詳細はMPA(Multi-Page Application)をご参照ください。

HTMLファイルの<body>タグ内に以下のスクリプトを挿入します。

HTML

boot方法を使用してSDKを初期化します。渡された引数オブジェクトにmemberIdフィールドがあるかどうかによってユーザータイプが決定されます。

匿名ユーザー向けにbootを実行するには、以下のコードをご参照ください。

JavaScript

メンバーユーザーのためにbootを実行するには、以下のコードをご参照ください。

JavaScript

Webサービスとチャネルトークのユーザー情報を統合するには、bootオプションにいくつかの追加情報を渡す必要があります。詳細はmemberIdとprofileをご参照ください。

セキュリティのため、メンバーハッシュの使用を推奨します。

IDやメールアドレスなどの予測可能な値でmemberIdを設定した場合、認証されていない第三者がmemberIdを推測する可能性があります。この場合、第三者が顧客の個人情報やチャット履歴を盗むなど、セキュリティ上の脅威に晒される恐れがあります。セキュリティのため、メンバーハッシュの設定を推奨します。

同一人物と判定されるユーザーは統合される場合があります。

同一人物と判定されるユーザーは統合される場合があります

匿名ユーザー状態からメンバーユーザーへ移行する場合、チャネルトークが同一ユーザーと判断できる合理的な根拠がある場合、チャットリストなどのユーザー情報を統合できます。詳細は「顧客情報の統合」をご参照ください。

boot APIの詳細な説明については、bootとboot optionをご参照ください。SDKが提供する様々な方法については、ChannelIOをご参照ください。

WebサービスがSingle Page Application(SPA)で構成されている場合、またはJavaScriptのクラスでSDKを使用している場合、以下のサンプルコードをご参照ください。

SDKはクライアントサイド(client-side)でのみ使用する必要があります。

SDKはサーバーサイド(server-side)で事前に実行することはできません。

JavaScript
TypeScript

ステップ1で追加したサービスを通じてSDKをインストールできます。

JavaScript

boot方法を使用してSDKを初期化します。渡された引数オブジェクトにmemberIdフィールドがあるかどうかによってユーザータイプが決定されます。

匿名ユーザー向けにbootを実行するには、以下のコードを参照します。

JavaScript

メンバーユーザーのためにbootを実行するには、以下のコードを参照します。

JavaScript

Webサービスとチャネルトークのユーザー情報を統合するには、bootオプションにいくつかの追加情報を渡す必要があります。詳細はmemberIdとprofileを参照してください。

セキュリティのため、メンバーハッシュの使用を推奨します。

IDやメールアドレスなどの予測可能な値でmemberIdを設定した場合、認証されていない第三者がmemberIdを推測する可能性があります。この場合、第三者が顧客の個人情報やチャット履歴を盗むなど、セキュリティ上の脅威に晒される恐れがあります。セキュリティのため、メンバーハッシュの設定を推奨します。

同一人物と判定されるユーザーは統合される場合があります。

同一人物と判定されるユーザーは統合される場合があります

匿名ユーザー状態からメンバーユーザーへ移行する場合、チャネルトークが同一ユーザーと判断できる合理的な根拠がある場合、チャットリストなどのユーザー情報を統合できます。詳細は「顧客情報の統合」をご参照ください。

SPA環境でワークフローとマーケティング機能を使用するには、setPageとtrack方法が必要です。

SPA環境でURLが変更された場合、SDKとチャネルトークサーバーは自動的にこれを認識しません。詳細は「SPA環境でワークフローとマーケティング機能を活用する方法」をご参照ください。

boot APIの詳細な説明については、bootおよびbootオプション、SDKが提供する各種方法についてはChannelIOをご参照ください。

以下のコマンドを実行して@channel.io/channel-web-sdk-loaderをインストールします。

Plaintext
npm install @channel.io/channel-web-sdk-loader
Plaintext
yarn add @channel.io/channel-web-sdk-loader
Plaintext
pnpm i @channel.io/channel-web-sdk-loader

ステップ1で追加したモジュールを通じてSDKをインストールできます。

JavaScript

boot方法を使用してSDKを初期化します。渡された引数オブジェクトにmemberIdフィールドがあるかどうかによってユーザータイプが決定されます。

匿名ユーザー向けにbootを実行するには、以下のコードを参照します。

JavaScript

メンバーユーザー向けにbootを実行するには、以下のコードを参照します。

JavaScript

Webサービスとチャネルトークのユーザー情報を統合するには、bootオプションにいくつかの追加情報を渡す必要があります。詳細はmemberIdとprofileを参照してください。

セキュリティのため、メンバーハッシュの使用を推奨します。

IDやメールアドレスなどの予測可能な値でmemberIdを設定した場合、認証されていない第三者がmemberIdを推測する可能性があります。この場合、第三者が顧客の個人情報やチャット履歴を盗むなど、セキュリティ上の脅威に晒される恐れがあります。セキュリティのため、メンバーハッシュの設定を推奨します。

同一人物と判定されるユーザーは統合される場合があります。

同一人物と判定されるユーザーは統合される場合があります

匿名ユーザー状態からメンバーユーザーへ移行する場合、チャネルトークが同一ユーザーと判断できる合理的な根拠がある場合、チャットリストなどのユーザー情報を統合できます。詳細は「顧客情報の統合」をご参照ください。

NPMモジュールに関するより詳細な説明はGitHubnpmで、NPMモジュールが提供するAPIドキュメントはTypeDocをご参照ください。