モバイル：Android Campaign Callbacksとその使用方法

概要

WalkMe Mobile SDKバージョン1.6.0以降、WalkMe Mobile SDKはCampaign Callbacksをサポートしています。

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

ユースケース

キャンペーンのコールバックは、以下のように使用できます：

• 任意の分析システムからオンボーディングを追跡
• WalkMeシャウトアウトとのユーザーエンゲージメントに基づいて、CRMで機会を生成 - 例えば「無料のデモに興味がありますか？ はい／いいえ」
• サポートチケットのトピックとワークスルーの使用状況／完了を追跡して比較するために既存のサポートシステムと統合

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

Campaign Callbacksを実装する手順

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

/**
 * Interface definition for a callback to be invoked in Campaign actions.
 */
public interface WMCampaignInfoListener {
    /**
     * Called after campaign was dismissed.
     *
     * @param campaignInfo The dismissed campaign info.
     */
    void onCampaignDismissed(WMCampaignInfo campaignInfo);
}

インターフェースを実装した後、Campaign Callbackイベントに登録するためにsetCampaignInfoListener方法を使用してください：

/**
 * Register a listener to campaign events
 *
 *@param campaignInfoListener The listener
 *
 */
public static void setCampaignInfoListener(WMCampaignInfoListener campaignInfoListener)

コールバックの戻り値オブジェクトはWMCampaignInfoクラスになります。これには次の情報が含まれています：

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

 public class WMCampaignInfo {

    public String getCampaignCta()

    public String getCampaignId()

    public String getCampaignCtaId()

    public WMUserData getUserData()

    public Map<String, Object> getCampaignData()
}

上記のように、WMCampaignInfoは下記に説明されているオブジェクトWMUserDataが含まれています：

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

public class WMUserData {

    /**
     * User Attributes in current session.
     */
    public Map<String, Object> getUserAttributesMap()


    /**
     * Private User Attributes in current session.
     */
    public Map<String, Object> getPrivateUserAttributes()

    /**
     * Returns the User Creation Timestamp for this User.
     *
     * @return long Timestamp.
     */
    public long getUserCreationTimestamp()

    /**
     * Returns the User Session Duration in second.
     *
     * @return double second.
     */
    public double getSessionDuration()

    /**
     * Returns the Device Android version.
     *
     * @return String version number.
     */
    public String getDeviceVersion()

    /**
     * Returns the Device unique id.
     *
     * @return String id.
     */
    public String getDeviceId()

    /**
     * Returns the Device brand Model.
     *
     * @return String Model.
     */
    public String getDeviceModel()

    /**
     * Returns the Device Orientation PRT_REG / LSL.
     *
     * @return String Orientation.
     */
    public String getDeviceOrientation()
    /**
     * Returns the application version.
     *
     * @return String version.
     */
    public String getAppVersion()

    /**
     * Returns the application Name.
     *
     * @return String Name.
     */
    public String getAppName()

    /**
     * Returns the locale language for this instance of the Java Virtual Machine.
     *
     * @return String Name.
     */
    public String getLocale()

    /**
     * Returns the walkme sdk version.
     *
     * @return String version.
     */
    public String getSdkVer()

    /**
     * Returns the Session unique id.
     *
     * @return String id.
     */
    public String getSessionId()

    /**
     * Returns if the user use the app for the first time.
     *
     * @return String boolean.
     */
    public String getIsNewUser()

    /**
     * Returns if Push notification approved for user.
     *
     * @return String boolean.
     */
    public String getIsPushEnabled()

    /**
     * Returns user device timezone.
     *
     * @return String timezone.
     */
    public String getTimezone()

    /**
     * Returns user current network ( WIFI / 3G )
     *
     * @return String network.
     */
    public String getNetwork()

    /**
     * Returns user current location latitude if available
     *
     * @return String latitude.
     */
    public String getLocationLat()

    /**
     * Returns user current location longitude if available
     *
     * @return String longitude.
     */
    public String getLocationLong()

    /**
     * Returns user System Name (Android).
     *
     * @return String Android.
     */
    public String getSystemName()

    /**
     * Returns the Current Timestamp for this User.
     *
     * @return String Timestamp.
     */
    public String getTimestamp()
}