React Native開発者向けAPI資料(iOS & Android)

この資料では、Pendo React Native SDKの公開APIについて説明します。

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)

提供された訪問者情報とアカウント情報でモバイルセッションを開始します。セッションがすでに進行中の場合、セッションは終了し、新しいセッションが開始されます。

匿名の訪問者を生成するには、visitorIdとしてnullを渡します。

このAPIは、将来のバージョンで非推奨になるswitchVisitorの代わりに使用する必要があります。

SDKが初期化された後に呼び出される必要があります。

endSession()

アクティブなセッションを終了し、アナリティクスの収集やユーザーへのガイドの表示を停止します。詳細はこちらをご覧ください。

SDKが初期化された後に呼び出される必要があります。

clearVisitor()

アクティブなセッションを終了して、匿名の訪問者との新しいセッションを開始します。

SDKが初期化された後に呼び出される必要があります。

setVisitorData(visitorData: object)

訪問者のメタデータを更新します。

SDKが初期化された後に呼び出される必要があります。

setAccountData(accountData: object)

アカウントのメタデータを更新します。

SDKが初期化された後に呼び出される必要があります。

async getVisitorId(): Promise<string | null>

アクティブなセッションに参加している訪問者IDを返します。

 

async getAccountId(): Promise<string | null>

 

アクティブなセッションに参加しているアカウントIDを返します。

 

setAccountId(accountId: string)

アクティブなセッションのアカウントのIDを設定します。

track(name: string, params: object)

指定したプロパティを持つトラックイベントを送信します。

SDKが初期化された後に呼び出される必要があります。

dismissVisibleGuides()

ガイドの表示をすべて解除します。

pauseGuides(dismissGuides:boolean)

アクティブなセッションで表示されているガイドを一時停止します。dismissGuidesがtrueの場合、表示されているガイドはすべて解除されます。

SDKが初期化された後に呼び出される必要があります。

resumeGuides()

アクティブなセッションでガイドの表示を再開します。pauseGuidesの後でのみ使用できます。

SDKが初期化された後に呼び出される必要があります。

async getDeviceId(): Promise<string | null>

Pendoが生成したデバイス固有のIDを返します。デバイスIDは、Pendoが匿名の各訪問者に対して一意のIDを生成するために使用されます。このIDは、アプリケーションごとに固有です。

 

withPendoRN()

React Navigationライブラリを使用するアプリに限ります。この関数は、ナビゲーションコンテナをラップして、ナビゲーション状態を追跡します。

 

Pendoクラスで非推奨の公開API - SDKバージョン2.9以前

公開APIメソッド

説明

initSdk(appKey: string, initParams: PendoParams, navigationOptions: NavigationOptions)

指定されたアプリキー、訪問者とアカウントのメタデータ、ナビゲーションライブラリのオプションを使用して、Pendo SDKを初期化します。

initSdkWithoutVisitor(appKey: string, navigationOptions: NavigationOptions)

指定されたアプリキーとナビゲーションライブラリのオプションを使用して、訪問者とアカウントのメタデータなしでPendo SDKを初期化します。

switchVisitor(visitorId: string, accountId: string, visitorData: object, accountData: object)

アクティブなセッションがある場合は、現在のセッションを終了し、新しい訪問者とアカウント情報を含む新しいセッションを開始します。

visitorIdにnullを渡すと、匿名の訪問者IDが生成されます。

SDKが初期化された後に呼び出される必要があります。

switchVisitor(visitorParams: PendoParams)

アクティブなセッションがある場合は、現在のセッションを終了し、新しい訪問者とアカウント情報を含む新しいセッションを開始します。

visitorIdにnullを渡すと、匿名の訪問者IDが生成されます。

SDKが初期化された後に呼び出される必要があります。

withPendo()

RNプラグインバージョン2.12以前のReact Navigationライブラリを使用するアプリに限ります。この関数は、ナビゲーションコンテナをラップして、ナビゲーション状態を追跡します。

RNプラグインバージョン2.12.1以降では、withPendoRN()を使用してください。

 

Pendoの初期化ガイドライン

  1. setupは、アプリケーションのライフサイクル中に一度のみ呼び出す必要があります。
  2. ネットワーク接続によっては、startSessionの完了までに時間がかかる場合があります。Pendo SDKの初期化が完了したときに通知を受け取るには、CallbackInterfaceを使用する必要があります。
  3. startSessionは、visitorIDやAccountIDを設定するために使用されます。訪問者IDとアカウントIDが変更されない場合、アクションは実行されません。
  4. endSessionは、ユーザーがアプリケーションからログアウトしたときに訪問者セッションを終了するために使用します。

React Navigationライブラリを使用したアプリのインテグレーション

注:このセクションは、React Navigationライブラリを使用するアプリにのみ関連します。このライブラリを使用しないアプリの場合、このセクションは無視してください。

 

RNプラグイン2.12.1以降のリリースの場合:

1. withPendo関数の代わりに新しいwithPendoRN関数を使用します。

2. NavigationContainer(RootNavigatorなど)を作成し、withPendoRNを使用してラップされたNavigationContainerを返すメソッドに次のコードを追加します。

onReady ={()=>{ const state = navigationRef.current.getRootState()props.onStateChange(state);}}>

 

詳細については、次のコード例に従うか、Pendoアプリのアプリインストール手順を参照してください。

```javascript import {withPendoRN} from 'rn-pendo-sdk' import {useRef} from 'react';
function RootNavigator(props) { const navigationRef = useRef(); return ( <NavigationContainer ref={navigationRef} onStateChange={()=> { const state = navigationRef.current.getRootState()props.onStateChange(state);}} onReady ={()=>{ const state = navigationRef.current.getRootState()props.onStateChange(state);}}> {MainStackScreen()} </NavigationContainer > ) }; export default withPendoRN(RootNavigator);