Flutter開発者向けAPIドキュメント

概要

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

Pendoクラスの公開API - SDKバージョン2.12以降

戻り型

公開APIメソッド - Dart

説明

static PendoFlutterPlugin

PendoFlutterPlugin

PendoFlutterPluginの共有インスタンスを返却します。

Future<void>

setup(String appKey, [Map<String, dynamic>?appParams])

Pendo SDKを初期化します。アプリケーションのメインファイル(lib/main.dart)で当該APIを呼び出します。

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

Future<void>

startSession(String visitorId, String accountId, Map<String, dynamic>?visitorData, Map<String, dynamic>?accountData)

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

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

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

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

Future<void>

endSession()

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

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

Future<void>

clearVisitor()

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

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

Future<void>

setVisitorData(Map<String, dynamic> visitorData)

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

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

Future<void>

setAccountData(Map<String, dynamic> accountData)

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

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

Future<String?>

getVisitorId()

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

 

Future<String?>

getAccountId()

 

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

 

Future<void>

setAccountId(String accountId)

プロパティ:アクティブなセッションに参加しているアカウントIDを設定します。

Future<void>

track(String event, Map<String, dynamic> properties)

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

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

Future<void>

dismissVisibleGuides()

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

Future<void>

pauseGuides(bool dismissGuides)

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

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

Future<void>

resumeGuides()

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

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

Future<String?>

getDeviceId()

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

 

Pendoの初期化ガイドライン

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

SDKの初期化

setupアプリケーションのメインファイル(lib/main.dart)に配置してください。

SDKを設定する

import 'package:pendo_sdk/pendo_sdk.dart';

次のコードをinitStateメソッドに追加します。

final String key = [YOUR_APP_KEY];
PendoFlutterPlugin.setup(key);

 

モバイルセッションを開始する

訪問者(識別済みまたは匿名)のセッションを開始する場合はstartSessionを呼び出します匿名訪問者を生成するには、visitorIdとしてnullを渡します。

import 'package:pendo_sdk/pendo_sdk.dart';

訪問者を認識しているアプリケーションに次のコードを追加します。

認識された訪問者

final String visitorId = 'John Smith';
final String accountId = 'Acme Inc';

// Set visitor metadata
final dynamic visitorData = {'Age': '27', 'Country': 'USA', 'Gender': 'Male'};

// Set account metadata
final dynamic accountData = {'Tier': '1', 'Size': 'Enterprise'};

 

匿名の訪問者:

final String visitorId = null;
final String accountId = null;
final dynamic visitorData = null;
final dynamic accountData = null;

startSession()メソッドの呼び出し - このコードは、モバイルセッションを開始し、提供された情報に基づいてすべてのガイドを取得します。

PendoFlutterPlugin.startSession(visitorId, accountId, visitorData, accountData);

トラックイベントフロー

この方法で、Pendo SDKを使ってトラックイベントの情報を渡すことができます。

final dynamic eventProperties = {'property1': 'value1', 'property2': 'value2'};
PendoFlutterPlugin.track("customEvent1",eventProperties);