概要

WalkMe Mobile SDKバージョン1.6.0以降、WalkMe Mobile SDKでキャンペーンコールバックがサポートされます。

コールバックは、アプリがWalkMeキャンペーンイベントに登録するためのプログラム的な方法です。 キャンペーンコールバックインターフェースを実装することで、アプリはコールバックオブジェクトを通して転送されたデータ（キャンペーン情報やユーザー情報を含む）を使用し、アプリの目的に利用できます。例えば、WalkMeとは関係のないアナリティクスやCRMシステムに情報を渡したり、ユーザーのキャンペーンに対するインタラクションに応じて、アプリやユーザー設定を更新したりできます。

ユースケース

キャンペーンコールバックは、以下などに使用できます。

• あらゆるアナリティクスシステムからユーザーのオンボーディングを追跡する
• 「無料デモに興味がありますか？ はい / いいえ」などのWalkMeシャウトアウトで、ユーザーエンゲージメントに基づいてCRM内で機会を生成する
• 既存のサポートシステムと統合して、WalkThruの使用状況/完了状況とトップのサポートチケットトピックを追跡し比較する

以下に、キャンペーンコールバックを実装するために必要なすべてのステップを説明します。

キャンペーンコールバックを実装する手順

キャンペーンのコールバックに登録するには、まずこのインターフェイスを実装します：

/**
 * キャンペーンアクションで呼び出すコールバックのインターフェイス定義。
 */
public interface WMCampaignInfoListener {
 /**
 * キャンペーンが終了した後に呼び出されます。
 *
 * @param campaignInfo 閉じられたキャンペーン情報。
 */
 void onCampaignDismissed(WMCampaignInfo campaignInfo);
}

インターフェイスを実装したら、メソッドを使用してキャンペーンコールバックイベントに登録します：

/**
 * キャンペーンイベントにリスナーを登録します。
 *
 *@param campaignInfoListener リスナー
 *
 */
public static void setCampaignInfoListener(WMCampaignInfoListener campaignInfoListener)

コールバックリターンオブジェクトはクラスになります。これには以下の情報が含まれます。

これはオブジェクトの構造です：

 public class WMCampaignInfo {

 public String getCampaignCta()

 public String getCampaignId（）

 public String getCampaignCtaId()

 public WMUserData getUserData()

 public Map<文字列、オブジェクト> getCampaignData()
}

上記のように、にはオブジェクトが含まれています。この説明は次の通りです：

これはオブジェクトの構造です：

public class WMUserData {

 /**
 * 現在のセッションのユーザー属性。
 */
 public Map<文字列、オブジェクト> getUserAttributesMap()


 /**
 * 現在のセッションのプライベートユーザー属性。
 */
 public Map<文字列、オブジェクト> getPrivateUserAttributes()

 /**
 * このユーザーのユーザー作成タイムスタンプを返します。
 *
 * @return long Timestamp.
 */
 public long getUserCreationTimestamp()

 /**
 * ユーザーセッション期間を秒単位で返します。
 *
 * @return double second.
 */
 public double getSessionDuration()

 /**
 * デバイスのAndroidバージョンを返します。
 *
 * @return 文字列のバージョン番号。
 */
 public String getDeviceVersion（）

 /**
 * デバイス固有IDを返します。
 *
 * @return String id.
 */
 public String getDeviceId（）

 /**
 * デバイスブランドのモデルを返します。
 *
 * @return String Model.
 */
 public String getDeviceModel（）

 /**
 * デバイスの向きPRT_REG / LSLを返します。
 *
 * @return String Orientation.
 */
 public String getDeviceOrientation（）
 /**
 * アプリケーションバージョンを返します。
 *
 * @return String version.
 */
 public String getAppVersion（）

 /**
 * アプリケーション名を返します。
 *
 * @return String Name.
 */
 public String getAppName（）

 /**
 * Java仮想マシンのこのインスタンスのロケール言語を返します。
 *
 * @return String Name.
 */
 public String getLocale（）

 /**
 * walkme sdkのバージョンを返します。
 *
 * @return String version.
 */
 public String getSdkVer（）

 /**
 * セッション固有のIDを返します。
 *
 * @return String id.
 */
 public String getSessionId（）

 /**
 * ユーザーがアプリを初めて使用するかどうかを返します。
 *
 * @return String boolean.
 */
 public String getIsNewUser（）

 /**
 * ユーザーにプッシュ通知が承認された場合に返されます。
 *
 * @return String boolean.
 */
 public String getIsPushEnabled()

 /**
 * ユーザーデバイスのタイムゾーンを返します。
 *
 * @return String タイムゾーン。
 */
 public String getTimezone（）

 /**
 * ユーザーの現在のネットワーク（WIFI / 3G）を返します
 *
 * @return String network.
 */
 public String getNetwork（）

 /**
 * 利用可能な場合、ユーザーの現在の場所の緯度を返します。
 *
 * @return String latitude.
 */
 public String getLocationLat（）

 /**
 * 利用可能な場合、ユーザーの現在の場所の経度を返します。
 *
 * @return 文字列の経度。
 */
 public String getLocationLong（）

 /**
 * ユーザーのシステム名（Android）を返します。
 *
 * @return String Android.
 */
 public String getSystemName()

 /**
 * このユーザーの現在のタイムスタンプを返します。
 *
 * @return String Timestamp.
 */
 public String getTimestamp()
}