セッションリプレイ iOS プラグイン

この記事では、iOS プラグインを使用して セッションリプレイ をインストールする方法について説明します。 アプリがすでにAmplitude iOS Swift SDKまたはレガシーAmplitude iOS SDKを使用している場合は、このオプションを使用してください。

Analytics-Swift SDKとAmplitude（アクション）の送信先経由でセグメントを使用する場合は、セグメントプラグインを選択してください。

製品内アナリティクスにAmplitude以外のプロバイダーを使用している場合は、スタンドアロンの実装を選択してください。

セッションリプレイは、メインビューとそのすべての子ビューを含む、アプリケーションのビューツリーへの変更を再帰的にキャプチャします。その後、 セッションリプレイ はこれらの変更を再生して、ビデオのような再生を構築します。セッションの開始時に、 セッションリプレイ はアプリケーションのビューツリーの完全なスナップショットをキャプチャします。ユーザーがアプリとやり取りするときに、セッションリプレイはビューの変更をそれぞれdiffとしてキャプチャします。セッションのリプレイを視聴するとき、セッションリプレイは各差分を順番に元のビューツリーに適用し、リプレイを構築します。セッションリプレイには最大長はありません。

始める前に

使用する方法は、使用しているAmplitude iOS SDKのバージョンによって異なります。

対応しているiOSバージョン

セッションリプレイがサポートするiOSの最小ターゲットバージョンはiOS 13です。

クイックスタート

プラグインの最新バージョンをプロジェクトの依存関係に追加します。

dependencies: [
    .package(url: "https://github.com/amplitude/AmplitudeSessionReplay-iOS", from: "0.17.0")
]

.product(name: "AmplitudeSwiftSessionReplayPlugin", package: "AmplitudeSessionReplay")

pod 'AmplitudeSessionReplay', :git => 'https://github.com/amplitude/AmplitudeSessionReplay-iOS.git', :tag => 'v0.17.0'
pod 'AmplitudeSwiftSessionReplayPlugin', :git => 'https://github.com/amplitude/AmplitudeSessionReplay-iOS.git', :tag => 'v0.17.0'

import AmplitudeSwift
import AmplitudeSwiftSessionReplayPlugin
// Initialize Amplitude Analytics SDK instance
let amplitude = Amplitude(configuration: Configuration(apiKey: API_KEY))
// Create and Install Session Replay Plugin
// Recording will be handled automatically
amplitude.add(plugin: AmplitudeSwiftSessionReplayPlugin(sampleRate: 1.0))

設定

セッションリプレイプラグインを初期化する際には、次のオプションを渡します。

カスタムセッションID

iOSバージョン0.11.2以降のセッションリプレイでは、customSessionIdプロパティを通じて文字列セッションID（UUIDなど）をサポートしています。プロジェクトでAmplitude session_idの代わりにカスタムイベントプロパティを使用してセッションを定義している場合は、カスタムセッションIDを使用してください。

customSessionIdを設定した場合、この値がプラグインがAmplitude SDKから同期するセッションIDよりも優先されます。AmplitudeセッションIDの使用を再開するには、プロパティをnilに設定します。

// Keep a reference to the plugin to set the custom session ID
let sessionReplayPlugin = AmplitudeSwiftSessionReplayPlugin(sampleRate: 1.0)
sessionReplayPlugin.customSessionId = "ef197fc7-a46f-4e6c-a77f-8d90c17065c0"
amplitude.add(plugin: sessionReplayPlugin)
// Whenever your custom session changes
sessionReplayPlugin.customSessionId = NEW_CUSTOM_SESSION_ID

セッションリプレイがカスタムセッションと確実に一致するためには、カスタムセッションIDは次の制約に従う必要があります。

• この値に/を含めることはできません。セッションリプレイは/をセッションリプレイIDの区切り文字として使用します。このIDの形式は<deviceId>/<sessionId>です。
• この値に使用できるのは、文字a-z A-Z 0-9 _ - . | @ : =のみです。
• 値は、イベント時にAmplitudeに送信するセッション定義プロパティと一致している必要があります。 詳細については、セッションの照合を参照してください。

実行時にマスキングを変更します

アプリの実行中に自動マスキングレベルを変更するには、プラグインprivacyConfigに設定してください。プラグインをAmplitudeに追加する前または後に設定してください。

sessionReplayPlugin.privacyConfig = PrivacyConfig(maskLevel: .conservative)

リモート設定がマスクレベルを指定している場合、そのレベルが優先されます。 このプラグインはローカルprivacyConfig値を保持し、リモート設定がマスキングレベルを提供していない場合やリモート設定を無効にした場合に適用します。

リモート設定

Amplitude でサンプルレートとマスクレベルを設定するには、リモート設定を有効にしてください。

画面上のデータをブロックする

セッションリプレイは、機密性の高い画面上のデータをブロックするために3つの方法をサポートしています。 WebViewのマスキング設定は、WebViewのサポートセクションにあります。

マスクレベル

iOS向けセッションリプレイは、maskLevelオプションで設定可能な3つのレベルのマスキングをサポートしています。

このオプションは、セッションリプレイ設定で使用します。

UIKit のプライバシーメソッド

セッションリプレイは、プライバシーを管理するための UIView 拡張機能を提供します。セッションリプレイライブラリをインポートしてアクセスできるようにします。

import AmplitudeSessionReplay

SwiftUIのプライバシー修飾子

セッションリプレイでは、プライバシーを管理するためにViewの拡張機能を提供しています。セッションリプレイライブラリをインポートしてアクセスします。

import AmplitudeSessionReplay

ユーザーのオプトアウト

セッションリプレイプラグインはAmplitude-Swift SDKのoptOut設定に従っており、単独ではユーザーによるオプトアウトをサポートしていません。

// Set optOut on the Amplitude SDK
let amplitude = Amplitude(configuration: Configuration(apiKey: API_KEY,
                                                           optOut: true,
                                                           /* other configuration */))
amplitude.add(plugin: AmplitudeSwiftSessionReplayPlugin(/* session replay options */))

EUデータレジデンシー

セッションリプレイは、EUのデータセンターを使用するAmplitudeのお客様が利用できます。 初期化時に serverZone 設定オプションを EU に設定します。例：

// Set serverZone on the Amplitude SDK
let amplitude = Amplitude(configuration: Configuration(apiKey: API_KEY,
                                                           serverZone: .EU,
                                                           /* other configuration */))
amplitude.add(plugin: AmplitudeSwiftSessionReplayPlugin(/* session replay options */))

サンプリングレート

デフォルトでは、セッションリプレイで記録されるセッションの割合は0%です。 お使いのSDKのsampleRateキャプチャするセッションの割合を設定するための設定オプション。

手動および動的サンプリング、クォータ計画、クォータ管理については、セッションリプレイのサンプリングを設定するを参照してください。

// This configuration samples 1% of all sessions
amplitude.add(plugin: AmplitudeSwiftSessionReplayPlugin(sampleRate: 0.01))

録画品質

再生の忠実度と、パフォーマンスおよびストレージのバランスを調整するには、品質プロファイルを選択します。プロファイルが小さいほど、キャプチャフレームレートが低くなり、画像解像度も低くなります。プロファイルが高いほど、フレームレートと解像度が高くなります。SDKがデバイスに基づいてプロファイルを選択できるようにする場合は、QualityProfile.automaticを使用します（例：新しいデバイスでは高く、古いデバイスでは低くするなど）。

// Use automatic profile selection based on device
amplitude.add(plugin: AmplitudeSwiftSessionReplayPlugin(
    sampleRate: 0.1,
    quality: .automatic
))
// Or set a fixed profile (low, medium, or high)
amplitude.add(plugin: AmplitudeSwiftSessionReplayPlugin(
    sampleRate: 0.1,
    quality: .medium
))

従量課金制ネットワークでのアップロードを無効にする

デバイスが従量課金制ネットワークに接続されている間は、セッションリプレイのアップロードを一時停止し、ユーザーのモバイルデータの使用を避けてください。セッションリプレイは引き続きデータをローカルに記録します。デバイスがWi-Fi、またはその他の従量制ではない接続に再接続されると、アップロードが再開されます。

// Set uploadConfig through the plugin's Config initializer
let config = AmplitudeSwiftSessionReplayPlugin.Config(
    sampleRate: 0.1,
    uploadConfig: UploadConfig(disableMeteredUploads: true)
)
amplitude.add(plugin: AmplitudeSwiftSessionReplayPlugin(config: config))

リプレイ収集を無効にする

セッションリプレイを有効にした後は、次のいずれかの条件までアプリ上で実行されます。

• ユーザーがアプリを離れる。
• sessionReplayPlugin.stop()呼び出します。
• このプラグインはamplitude.remove(plugin: sessionReplayPlugin)を使用してSDKから削除できます。

ユーザーがアプリの制限付きエリアに移動する前にsessionReplayPlugin.stop()を呼び出して、ユーザーがそのエリアにいる間のリプレイ収集を無効にします。

ユーザーがアプリの制限のないエリアに戻ったときに、sessionReplayPlugin.start()を呼び出してリプレイ収集を再度有効にします。

特定の画面のみをキャプチャするには、起動時に起動しないようにautoStart: falseでプラグインを初期化し、ユーザーがこれらの画面に出入りするときに、start()およびstop()を呼び出します。

// Add the plugin once, without starting capture
let sessionReplayPlugin = AmplitudeSwiftSessionReplayPlugin(sampleRate: 1.0, autoStart: false)
amplitude.add(plugin: sessionReplayPlugin)
// Start capture when the user enters a screen you want to record
sessionReplayPlugin.start()
// Stop capture when the user leaves that screen
sessionReplayPlugin.stop()

また、Amplitude Experimentなどのフィーチャーフラグプロダクトを使用して、場所などの基準に基づいてリプレイ収集を有効または無効にするロジックを作成することもできます。たとえば、特定のユーザーグループを対象とした機能フラグを作成し、それを初期化ロジックに追加できます。

import AmplitudeSwift
import AmplitudeSwiftSessionReplayPlugin
// Your existing initialization logic with Amplitude-Swift SDK
let amplitude = Amplitude(configuration: Configuration(apiKey: API_KEY,
                                                           /* other configuration */))
if (nonEUCountryFlagEnabled) {
  // Create and Install Session Replay Plugin
  let sessionReplayPlugin = AmplitudeSwiftSessionReplayPlugin(sampleRate: 0.1)
  amplitude.add(plugin: sessionReplayPlugin)
}

Web View のサポート（ベータ版）

デフォルトでは、セッションリプレイはキャプチャ時に WebView をブロックします。すべてのWebViewコンポーネントのキャプチャを有効にするには、セッションリプレイ設定でcaptureWebViewsをtrueに設定します。

特定の WebView コンポーネントをマスクするには、画面上のデータをブロックする で説明されているプライバシーメソッドを使用してください。

// UIKit
webView.amp_isBlocked = false

マップビューのサポート（アルファ版）

セッションリプレイは、iOS アプリでのマップビューのキャプチャに対応しています。マップビューのキャプチャを有効にするには、実装でマップビューのマスクを解除してください。

// UIKit
mapView.amp_isBlocked = false
// SwiftUI
Map().amp_setBlocked(false)

ログの記録

import AmplitudeSessionReplay
let sessionReplay = SessionReplay(
    apiKey: API_KEY,
    recordLogOptions: .init(logCountThreshold: 2000, maxMessageLength: 4000)
)
sessionReplay.recordLog(level: .error, message: "This is an error log")

class AmplitudeLogRecordLogger: DDAbstractLogger {
    private weak var plugin: SessionReplayPlugin?
    init(_ plugin: SessionReplayPlugin) {
        self.plugin = plugin
    }
    override func log(message logMessage: DDLogMessage) {
        let recordLevel: RecordLogLevel
        switch logMessage.flag {
        case .error:
            recordLevel = .error
        case .warning:
            recordLevel = .warn
        case .info:
            recordLevel = .log
        default:
            return
        }
        plugin?.recordLog(level: recordLevel,
                          message: logMessage.message,
                          date: logMessage.timestamp)
    }
}
let sessionReplayPlugin = AmplitudeSwiftSessionReplayPlugin()
amplitude.add(plugin: sessionReplayPlugin)
DDLog.add(AmplitudeLogRecordLogger(sessionReplayPlugin))

RCTAddLogFunction { level, source, fileName, lineNumber, message in
  let recordLevel: RecordLogLevel
  switch level {
  case .error:
    recordLevel = .error
  case .warning:
    recordLevel = .warn
  case .info:
    recordLevel = .log
  case .fatal:
    recordLevel = .error
  case .trace:
    recordLevel = .init("trace")
  default:
    return
  }
  self.sessionReplayPlugin.recordLog(level: recordLevel, message: message)
}

データのリテンション、削除、プライバシー

キャプチャを実装する際には、同意に関するガイダンスを確認してください。

データ保持期間

ネイティブSDKおよびFlutter SDKのデータ保持に関するガイダンスと変更の適用日については、セッションリプレイのデータライフサイクルに関するリファレンスをご覧ください。

DSAR API

DSAR API によって返されるリプレイのメタデータについては、セッションリプレイの DSAR メタデータをご覧ください。

データ削除

ユーザーおよびプロジェクトの削除時の動作については、セッションリプレイのデータ削除を参照してください。

ボットフィルター

ボットのフィルタリングおよびプロパティフィルターの制限については、セッションリプレイのボットフィルタリングへ移動してください。

セッションリプレイのストレージ

ユーザーがアプリ内でのトラッキングをオプトアウトした場合は、optOut設定オプションを使用して、そのユーザーのリプレイデータの収集を無効にします。

セッションリプレイは、リプレイデータをアップロードする前に、ファイルシステムに一時的に保存します。初期化のたびに、最も古いリプレイデータが削除され、ディスク使用量が上限以下に抑えられます。

既知の制限事項

セッションリプレイを実装する際は、以下の制限事項に留意してください。

• セッションリプレイは、複数のプロジェクトにわたる単一ユーザーのリプレイを統合しません。例：

  • 複数のアプリをそれぞれ別のAmplitudeプロジェクトとして計測し、各プロジェクトでセッションリプレイを有効にします。
  • 既知のユーザーが一方のアプリを利用し始め、その後、別のアプリに切り替えます。
  • Amplitudeは両方のセッションをキャプチャします。
  • 各セッションのリプレイは、対応するホストプロジェクトで表示できます。

• 組織でカスタムセッション定義を使用している場合、ユーザーセッションチャートにはセッションリプレイが表示されません。

• セッションリプレイでは、以下のiOSビューをキャプチャできません：

  • SFSafariViewControllerなどのプロセス外で動作するiOSビュー
  • AVPlayerLayerを使用するビュー