セッションリプレイiOSセグメント連携

この記事では、セッションリプレイiOSセグメントプラグインを使用したセッションリプレイのインストールについて説明します。アプリがSegmentのAnalytics-SwiftライブラリとAmplitude（アクション）の送信先を使用している場合にこのオプションを使用します。

アプリがAmplitude iOS SDKを使用している場合は、セッションリプレイiOS SDKプラグインを使用してください。

セグメントを他のオプションと組み合わせて使用する場合は、スタンドアロンの実装を選択してください。

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

始める前に

セッションリプレイiOSセグメントプラグインには以下が必要です。

1. アプリケーションは iOS または iPadOS 上で実行されます。
2. 取り込みにはセグメントのAnalytics-Swiftライブラリを使用します。
3. SegmentのAmplitude（アクション）送信先を使用します。
4. SegmentのAmplitudeプラグインを使用しています。

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

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

クイックスタート

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

SegmentプラグインはSwiftパッケージマネージャーからのみ利用できます。セッションリプレイを Package.swift ファイルまたは Xcode のパッケージリストに依存関係として追加します。

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

Analytics-Swiftと統合するには、AmplitudeSegmentSessionReplayPluginターゲットを使用します。

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

アプリケーションコードを設定します。

import AmplitudeSegmentSessionReplayPlugin
import Segment
import SegmentAmplitude
// Initialize Segment
let analytics = Analytics(configuration: config)
// Ensure Segment's AmplitudeSession plugin is added before AmplitudeSegmentSessionReplayPlugin
analytics.add(plugin: AmplitudeSession())
// Initialize AmplitudeSegmentSessionReplayPlugin with your Amplitude API key
analytics.add(plugin: AmplitudeSegmentSessionReplayPlugin(amplitudeApiKey: API_KEY,
                                                              sampleRate: 0.1))

設定

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

リモート設定

Amplitudeでサンプルレートとマスキングレベルを設定するには、リモート設定を有効にします。

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

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

マスクレベル

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

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

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

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

import AmplitudeSessionReplay

SwiftUIのプライバシー修飾子

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

import AmplitudeSessionReplay

ユーザーのオプトアウト

ユーザーがセッションリプレイをオプトアウトしたことを示すために、プラグインでoptOutを設定します。

// Pass a boolean value to indicate a users opt-out status
amplitudeSegmentSessionReplayPlugin.optOut = true

EUデータレジデンシー

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

// Set serverZone on the AmplitudeSegmentSessionReplayPlugin
let plugin = AmplitudeSegmentSessionReplayPlugin(amplitudeApiKey: API_KEY,
                                                     sampleRate: 0.1,
                                                     serverZone: .EU)

サンプリングレート

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

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

// This configuration samples 1% of all sessions
analytics.add(plugin: AmplitudeSegmentSessionReplayPlugin(amplitudeApiKey: API_KEY,
                                                              sampleRate: 0.01))

録画品質

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

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

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

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

analytics.add(plugin: AmplitudeSegmentSessionReplayPlugin(amplitudeApiKey: API_KEY,
                                                              sampleRate: 0.1,
                                                              uploadConfig: UploadConfig(disableMeteredUploads: true)))

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

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

• ユーザーがアプリを離れる。
• amplitudeSegmentSessionReplayPlugin.stop()呼び出します。
• analytics.remove(plugin: amplitudeSegmentSessionReplayPlugin)を使用して、セグメントからこのプラグインを削除します。

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

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

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

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

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

import AmplitudeSegmentSessionReplayPlugin
import Segment
import SegmentAmplitude
// Your existing initialization logic with Segment
let analytics = Analytics(configuration: config)
analytics.add(plugin: AmplitudeSession())
if (nonEUCountryFlagEnabled) {
  // Create and Install Session Replay Plugin
  let amplitudeSegmentSessionReplayPlugin = AmplitudeSegmentSessionReplayPlugin(amplitudeApiKey: API_KEY, sampleRate: 0.1)
  analytics.add(plugin: amplitudeSegmentSessionReplayPlugin)
}

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を使用するビュー