この資料では、Pendo React Native SDKの公開APIについて説明します。
Pendoクラスの公開API - SDKバージョン2.22以降
| 公開APIメソッド | 説明 |
| screenContentChanged() | Pendoがアプリ内の特定のコンポーネント（遅延要素、状態変化のあるコンポーネントなど）にタグ付けできない場合に使用されます。 APIについては、コンポーネントが表示されるとき、または状態が変化するときに、開発者が呼び出す必要があります。 この呼び出しは、SDKが初期化された後に実施される必要があります。 |
Pendoクラスの公開API - SDKバージョン2.21以降
| 公開APIメソッド | 説明 |
| WithPendoReactNavigation(NavigationContainer) | React Navigationライブラリを使用するアプリに限ります。この関数は、ナビゲーションコンテナをラップして、ナビゲーション状態を追跡します。 |
Pendoクラスの公開API - SDKバージョン2.10以降
| 公開APIメソッド | 説明 |
| setup(appKey: string, navigationOptions: NavigationOptions, pendoOptions?: PendoOptions) | Pendo SDKを初期化します。PendoOptionsは常にnullにする必要があります。 このAPIは、将来のバージョンで非推奨になるinitSDKおよびinitSDKWithoutVisitorの代わりに使用する必要があります。 |
| startSession(visitorId: string, accountId: string, visitorData: object, accountData: object) |
提供された訪問者情報とアカウント情報でモバイルセッションを開始します。セッションがすでに進行中の場合、セッションは終了し、新しいセッションが開始されます。 |
| endSession() |
アクティブなセッションを終了し、アナリティクスの収集やユーザーへのガイドの表示を停止します。詳細については、特定のユーザーでPendoモバイルを除外するを参照してください。 この呼び出しは、SDKが初期化された後に実施される必要があります。 |
| clearVisitor() |
アクティブなセッションを終了して、匿名の訪問者との新しいセッションを開始します。 この呼び出しは、SDKが初期化された後に実施される必要があります。 |
| setVisitorData(visitorData: object) |
訪問者のメタデータを更新します。 この呼び出しは、SDKが初期化された後に実施される必要があります。 |
| setAccountData(accountData: object) |
アカウントのメタデータを更新します。 この呼び出しは、SDKが初期化された後に実施される必要があります。 |
| async getVisitorId(): Promise<string | null> | アクティブなセッションに参加している訪問者IDを返します。 |
| async getAccountId(): Promise<string | null> | アクティブなセッションに参加しているアカウントIDを設定します。 |
|
track(name: string, params: object)
|
指定したプロパティを持つトラックイベントを送信します。 この呼び出しは、SDKが初期化された後に実施される必要があります。 |
|
dismissVisibleGuides() |
ガイドの表示をすべて閉じます。 |
|
pauseGuides(dismissGuides:boolean) |
アクティブなセッションで表示されているガイドを一時停止します。dismissGuidesがtrueの場合、表示されているガイドはすべて解除されます。 この呼び出しは、SDKが初期化された後に実施される必要があります。 |
|
resumeGuides() |
アクティブなセッションでガイドの表示を再開します。これは、pauseGuidesの後でのみ使用できます。 |
|
async getDeviceId(): Promise<string | null>
|
Pendoが生成したデバイス固有のIDを返します。デバイスIDは、Pendoが匿名の各訪問者に対して一意のIDを生成するために使用されます。このIDは、アプリケーションごとに固有です。 |
| withPendoRN() | React Navigationライブラリを使用するアプリに限ります。この関数は、ナビゲーションコンテナをラップして、ナビゲーション状態を追跡します。 |
Pendoの初期化ガイドライン
-
setupは、アプリケーションのライフサイクル中に一度のみ呼び出す必要があります。 -
ネットワーク接続によっては、
startSessionの完了までに時間がかかる場合があります。Pendo SDKの初期化が完了したときに通知を受け取るには、CallbackInterfaceを使用する必要があります。 startSessionは、visitorIDやAccountIDを設定するために使用されます。訪問者IDとアカウントIDが変更されない場合、アクションは実行されません。endSessionは、ユーザーがアプリケーションからログアウトしたときに訪問者セッションを終了するために使用します。