モバイル画面ID API

Last Updated 11月 29, 2022

Download as PDF

概要

WalkMe Mobile SDKは、セグメンテーションとルールベースのゴールで利用可能な変数として画面を使用できます。 また、エレメントをキャプチャしたコンテキストの一部として画面を使用し、後で識別します。

SDKバージョン1.18.0から開始し、アプリの動作とユースケースに基づいて、setScreenID APIを使用して、WalkMeの最も正確なコンテキストを設定できます。

画面を識別するためにAPIを使用している場合、WalkMeは変更する際の通常のアルゴリズムにより画面を識別しないため、画面IDが正常に設定されていることを確認し、画面が変更されたときにリセットするのは開発者の責任です。 画面IDがリセットされていない場合、アプリ全体で設定された最新の画面IDを使用し続けるため、WalkMeの動作に中断を招く可能性があります。

そのため、固有のニーズを特定した場合にのみ、setScreenID APIを使用することをお勧めします。

画面ID APIの実装方法

Androidアプリ

画面IDを設定するには、onResum()で一意のIDを持つsetScreenId APIを呼び出し、onPause()でnull値で再度呼び出します。

/**
*  Set ID for a specific screen.
*  When used, this should be called every time the screen shows
*
*   @param screenID the ID to set for a specific screen
*
**/

public static void setScreenID(String screenID)

iOSアプリ

画面IDを設定するには、viewWillAppearに一意のIDを持つsetScreenId APIを呼び出して、画面が変更する際に値をリセットするために、viewWillDisappear内のnil値で再度呼び出します。

/**
* Set ID for a specific screen.
*/
+ (void)setScreenID:(NSString *)screenID;

iOS使用例：

[ABBI setScreenID:@"my_unique_screen_id"];

ABBI.setScreenID("my_unique_screen_id")