概要

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

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

ユースケース

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

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

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

キャンペーンコールバックの使用

キャンペーンのコールバックに登録するには、まずこのプロトコルを実装します。

/**
 * キャンペーンアクションで呼び出すコールバックのインターフェイス定義。
 */
@protocol WMCampaignInfoDelegate <NSObject>

/**
 * キャンペーンが終了した後に呼び出されます。
 *
 * @param campaignInfo 閉じられたキャンペーン情報。
 */
- (void)campaignDidDismiss:(WMCampaignInfo *)campaignInfo;

@end

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

/**
 * キャンペーンイベントにデリゲートを登録する
 *
 *@param delegate デリゲート
 *
 */
+ (void)setCampaignInfoDelegate:(id<WMCampaignInfoDelegate>)delegate;

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

@interface WMCampaignInfo ： NSObject

@property (nonatomic,strong) NSString* campaginCta;
@property (nonatomic,strong) NSString* campaignCtaId;
@property (nonatomic,strong) NSString* campaignId;
@property (nonatomic,strong) WMUserData* userData;
@property (nonatomic,strong) NSDictionary* campaignData;

@end

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

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

@interface WMUserData ： NSObject

/** 
* 現在のセッションのユーザー属性。
*/
@property (nonatomic,strong) NSDictionary *userAttributes;

/**
* 現在のセッションのプライベートユーザー属性。
*/
@property (nonatomic,strong) NSDictionary *privateUserAttributes;

/**
 * 秒単位でのユーザーセッション期間。
 */
@property (nonatomic,strong) NSNumber* sessionDuration;

/**
 * ユーザーのiOSバージョン
 */
@property (nonatomic,strong) NSString* systemVersion;

/**
 デバイス固有ID
 */
@property (nonatomic,strong) NSString* deviceId;

/**
 * デバイスモデル。
 */
@property (nonatomic,strong) NSString* deviceModel;

/**
 * デバイスの向きPRT_REG / LSL。
 */
@property (nonatomic,strong) NSString* deviceOrientation;

/**
 * アプリケーションのバージョン。
 */
@property (nonatomic,strong) NSString* appVersion;

/**
 * アプリケーション名。
 */
@property (nonatomic,strong) NSString* appName;

/**
 * ユーザーデバイスのロケール言語。
 */
@property (nonatomic,strong) NSString* locale;

/**
 * WalkMe SDKバージョン。
 */
@property (nonatomic,strong) NSString* sdkVer;

/**
 * セッション固有ID。
 */
@property (nonatomic,strong) NSString* sessionId;

/**
 * ユーザーにプッシュ通知が承認された場合。
 */
@property (nonatomic,strong) NSString* isPushEnabled;

/**
 * ユーザーデバイスタイムゾーン。
 */
@property (nonatomic,strong) NSString* timezone;

/**
 * ユーザーの現在のネットワーク（WIFI / 3G）。
 */
@property (nonatomic,strong) NSString* network;

/**
 * ユーザーOSシステム名。
 */
@property (nonatomic,strong) NSString* systemName;

/**
 * このユーザーの現在のタイムスタンプ。
 */
@property (nonatomic,strong) NSString* timestamp;

@end