moengage を使用してアクセスできる一連の API が含まれています。ほとんどの API は Android と iOS の両方で動作します。以下の表の プラットフォーム 列には、各 API が実装されているプラットフォームが記載されています。両方のプラットフォームに配信するテンプレートで API を使用する前に、この列を確認してください。
以下の表に JS Bridge のすべてのメソッドを示します。後続のセクションで、各 API について詳しく説明します。
後続のセクションでは、各 API の使用方法について詳しく説明します。提供されている JS メソッドは、アクション用の JS メソッドとデータトラッキング用の JS メソッドの 2 つのカテゴリに分類されます。
アクション
以下のセクションでは、アクション用の JS メソッドについて詳しく説明します。アクション用の JS メソッドアクション用の JS メソッドを HTML テンプレートに統合すると、メッセージを閉じる、画面や Web ページへのリダイレクトなどのナビゲーションアクション、その他 In-App キャンペーンでサポートされているアクションなどのクリック時アクションを実行できます。
In-App メッセージを閉じる
In-App メッセージを閉じるには、moengage.dismissMessage() API を使用します。
moengage.dismissMessage() API を使用している場合は、他の API を使用しないでください。ナビゲーションアクション
画面への遷移
moengage.navigateToScreen(<screen-name>, <optional-data-json>) を使用して画面を開くことができます。
ディープリンク URL を開く
ディープリンク URL を開くには、moengage.openDeepLink(<deeplink-url>, <optional-data-json>) を使用します。
Richlanding 画面を開く
Richlanding 画面を開くには、moengage.openRichLanding(<richlanding-url>, <data-json>) を使用します。
Web URL を開く
Web ブラウザで URL を開くには、moengage.openWebURL(<web-url>, <optional-data-json>) を使用します。
テキストをクリップボードにコピー
テキストをクリップボードにコピーするには、moengage.copyText(<text-to-copy>, <message>) API を使用します。
通話
通話アクションを実行するには、moengage.call(<mobile-number> API を使用します。
SMS
SMS を送信するには、moengage.sms(<mobile-number>, <message>) API を使用します。
共有
文字列コンテンツを共有するには、moengage.share(<share-text>) API を使用します。
カスタムアクション
カスタムアクションを実行するには、moengage.customAction(<data-json>) API を使用してデータを設定します。
プッシュ通知の許可
これらのメソッドを使用して、ユーザーにプッシュ通知を有効にするよう促したり、すでに通知を無効にしているユーザーを通知設定画面に誘導したりします。通知の許可をリクエストする
通知の許可をリクエストするには、moengage.requestNotificationPermission() API を使用します。このメソッドは Android と iOS の両方で動作するため、両方のプラットフォームに配信する 1 つのテンプレートで使用できます。
通知設定に遷移する
許可を先にリクエストせずに、ユーザーをアプリの通知設定画面に直接遷移させるには、moengage.navigateToNotificationSettings() API を使用します。このメソッドは Android と iOS の両方で動作します。
これは、アプリのプッシュがすでに無効になっていて、許可のプロンプトが表示されない場合に使用します。たとえば、通知がオフになっていることをユーザーに伝え、再度オンにするための CTA を表示するアプリ内メッセージなどです。
アプリ内メッセージではなくアプリのコードから通知の許可を処理するには、通知のランタイム権限 を参照してください。
プッシュのオプトインプロンプトを表示する
iOS で通知の許可を求めるには、moengage.showPushOptIn() API を使用します。現在の通知ステータスに基づいて、SDK は通知許可のプロンプトを表示するか、通知ステータスを更新できる設定画面にユーザーを遷移させます。
デバイスの設定に遷移する
デバイスの設定画面を開くには、moengage.navigateToSettings() API を使用します。
データトラッキング
以下のセクションでは、データトラッキング用の JS メソッドについて詳しく説明します。データトラッキング用の JS メソッド以下のユースケースでは、データトラッキング用の JS メソッドをテンプレートに統合する必要があります。
- 統計のトラッキング(クリック、閉じる)
- イベントのトラッキング(アンケート、評価、リード獲得向け)
- ユーザー属性のトラッキング(リード獲得、サインアップなど向け)
イベントのトラッキング
イベントをトラッキングするには、moengage.trackEvent(eventName, generalAttrJson, locationAttrJson, dateAttrJson, isNonInteractive, shouldAttachCampaignMeta) API を使用します。
trackEvent() は最大 6 つのパラメータを受け取ります。
- eventName:String
- generalAttrJson:一般属性の JSON オブジェクト。使用可能なデータ型は string、float、boolean、int、JSON オブジェクトです。
- locationAttrJson:位置情報属性の JSON オブジェクト。属性名と緯度・経度を受け取ります
- dateAttrJson:日時属性の JSON オブジェクト。ISO-8601 形式の日付のみを受け付けます
- isNonInteractive:イベントを非インタラクティブにする場合は true、それ以外の場合は false。
- shouldAttachCampaignMeta:キャンペーンのメタデータをイベントに添付する場合は true、それ以外の場合は false。
eventName パラメータ以外のパラメータは必須ではなく、{} を渡すことができます。パラメータを渡す順序を維持することが重要です。つまり、位置情報属性のみを渡したい場合は、一般属性として
{} を渡す必要があります。一般的なケースでは、イベント名とイベント属性の JSON のみを渡し、その他のパラメータは省略できます。{} を渡す方法を示しています。
クリックイベントのトラッキング
ウィジェットのクリックイベントをトラッキングするには、moengage.trackClick(widgetId) API を使用します。<widgetId> は int または string である必要があり、それ以外の場合、クリックイベントはトラッキングされません。
閉じる操作のトラッキング
In-App を閉じるイベントをトラッキングするには、moengage.trackDismiss(widgetId) API を使用します。<widgetId> は int または string を指定できます。渡されない場合、イベントは <widgetId> なしでトラッキングされます。
非推奨: ウィジェット ID を指定しない trackDismiss()
非推奨: ウィジェット ID を指定しない trackDismiss()
引数なしで
moengage.trackDismiss() を呼び出す方法は非推奨です。閉じる操作は引き続きトラッキングされますが、<widgetId> がないとクリック分布テーブルにデータが入力されません。代わりに、上記のように <widgetId> を渡してください。ユーザーの識別
ワークスペースで設定された一意の識別子でユーザーを識別するには、moengage.identifyUser(<value>) API を使用します。リード獲得、サインアップ、ログインのテンプレートからこのメソッドを使用して、セッションを既知のユーザーに関連付けます。
このメソッドを呼び出す前に、MoEngage で識別子を設定してください。識別子が 1 つのユーザープロファイルに解決される仕組みの詳細については、Unified Identity と Identity Resolution を参照してください。
デフォルトユーザー属性のトラッキング
デフォルトのユーザー属性をトラッキングするために、以下の JavaScript メソッドを使用できます。
例:
カスタムユーザー属性のトラッキング
カスタムユーザー属性をトラッキングするために、以下の JavaScript メソッドを使用できます。
例: