Web SDK統合ガイド
このドキュメントは、MA Web SDKの標準統合ガイドです。
統合前の準備
- EngageLab MAサービスを利用するには、まずWebPushモジュールを統合する必要があります。
- アクセス可能なHTTPSウェブサービスのドメイン名を準備してください。統合後、このドメイン名の下でページをテストおよびデバッグする必要があります。WebオフラインプッシュはローカルデバッグやHTTPをサポートしていません。
- EngageLab WebPushにアクセスし、[統合設定] - [ウェブサイトドメイン名]ページで、HTTPSウェブサービスのドメイン名を入力してください。
製品説明
EngageLab Web SDKのMAモジュールは、データ収集および報告機能を提供し、EUID生成、ユーザー属性設定、イベント報告などのシナリオで使用されます。
主なシナリオ:
さまざまな種類の属性を設定し、さまざまな種類のイベントを報告します。
アプリケーション情報の取得
WebPushコンソールでアプリケーションを作成する必要があります。作成に成功すると、このアプリケーションを識別するためのAppKeyが自動的に生成されます。詳細については、アプリケーション設定ドキュメントを参照してください。
SDKアクセス
コンソールにアクセスし、SDKをダウンロードして各ページでJavaScriptを使用します：
<script type="text/javascript" src="./webPushSdk.min.3.0.0.js"></script>
<script type="text/javascript" src="./webPushSdk.min.3.0.0.js"></script>
このコードブロックはフローティングウィンドウ内に表示されます
ヒント
このJavaScriptをインポートした後、maOpenプロパティにtrueの値を渡してMA構成を有効にすると、MAの関連APIや機能を使用できるようになります。
SDK初期化
// 初期化（MAを有効化）
MTpushInterface.init({
appkey: "", // 必須。アプリケーション情報の取得セクションを参照してください。
user_str: "adminDemo", // 必須。ユーザーを識別するためのユーザー識別子。
swUrl: '', // デフォルトは"/sw.min." + sdkEnv.version + ".js"です。この設定項目はサーバーワーカーファイルのアドレスです。ドメイン名は現在のドメイン名である必要があり、パスはサーバーワーカーのスコープを決定します。
maOpen: true, // スイッチをオンにしてMA機能を有効にします。
debugMode: boolean; // デバッグモードを有効にするかどうかを設定します。trueの場合、より多くのログ情報が出力されます。falseに設定すると、レベルwとeのログのみが出力されます。
channel: string; // チャンネル名。デフォルト値は：default-channelです。
appName: string; // 報告用にウェブサイト名を設定するために使用されます。
});
// 初期化（MAを有効化）
MTpushInterface.init({
appkey: "", // 必須。アプリケーション情報の取得セクションを参照してください。
user_str: "adminDemo", // 必須。ユーザーを識別するためのユーザー識別子。
swUrl: '', // デフォルトは"/sw.min." + sdkEnv.version + ".js"です。この設定項目はサーバーワーカーファイルのアドレスです。ドメイン名は現在のドメイン名である必要があり、パスはサーバーワーカーのスコープを決定します。
maOpen: true, // スイッチをオンにしてMA機能を有効にします。
debugMode: boolean; // デバッグモードを有効にするかどうかを設定します。trueの場合、より多くのログ情報が出力されます。falseに設定すると、レベルwとeのログのみが出力されます。
channel: string; // チャンネル名。デフォルト値は：default-channelです。
appName: string; // 報告用にウェブサイト名を設定するために使用されます。
});
このコードブロックはフローティングウィンドウ内に表示されます
その他のAPI
他のAPIの使用方法については、インターフェースドキュメント：Web SDK APIを参照してください。
