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: "url", // デフォルト: "/sw.min." + sdkEnv.version + ".js"。この設定はサーバーワーカーファイルのアドレスで、ドメインは現在のドメインである必要があり、パスによってサーバーワーカーのスコープが決まります。
debugMode: true,// デバッグモードの有効化/無効化を設定。true の場合は詳細なログを出力、false の場合は w レベルと e レベルのログのみ出力。
channel: "default-channel",// チャネル名、デフォルト値: default-channel
appName: "string",// ウェブサイト名を設定し、報告に使用
maOpen: true, // スイッチをオンにして MA 機能を有効化
userIdentity: { userId: "1234567890", anonymousId: "anonymous123" },// MA初期化時にユーザー識別子を設定。バージョン3.3.4から対応、ログイン会員向けのみMAサービスを提供する企業に適用
maCompletion: (code, msg) => {// MA初期化コールバック
if (code === 0) {
console.log("✅MA SDK 初期化成功！");
} else {
console.error("❌MA SDK 初期化失敗：", msg);
}
}
});
// 初期化（MAを有効化）
MTpushInterface.init({
appkey: "", // 必須項目、上記のアプリケーション情報の取得を参照
user_str: "adminDemo", // 必須項目、ユーザーを識別するための識別子
swUrl: "url", // デフォルト: "/sw.min." + sdkEnv.version + ".js"。この設定はサーバーワーカーファイルのアドレスで、ドメインは現在のドメインである必要があり、パスによってサーバーワーカーのスコープが決まります。
debugMode: true,// デバッグモードの有効化/無効化を設定。true の場合は詳細なログを出力、false の場合は w レベルと e レベルのログのみ出力。
channel: "default-channel",// チャネル名、デフォルト値: default-channel
appName: "string",// ウェブサイト名を設定し、報告に使用
maOpen: true, // スイッチをオンにして MA 機能を有効化
userIdentity: { userId: "1234567890", anonymousId: "anonymous123" },// MA初期化時にユーザー識別子を設定。バージョン3.3.4から対応、ログイン会員向けのみMAサービスを提供する企業に適用
maCompletion: (code, msg) => {// MA初期化コールバック
if (code === 0) {
console.log("✅MA SDK 初期化成功！");
} else {
console.error("❌MA SDK 初期化失敗：", msg);
}
}
});
このコードブロックはフローティングウィンドウ内に表示されます
その他のAPI
他のAPIの使用方法については、インターフェースドキュメント：Web SDK APIを参照してください。
