PHP SDKの初期化

お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

PageSenseClientクラスは、PageSense PHP SDKが提供する主要なインターフェイスで、ユーザー向けのフルスタックA/Bテストを実行するために使用します。バリエーションを提供したり、目標をトラッキングしたりする前に、お使いのプロジェクト固有の設定である「プロジェクトの設定」を使用してクライアントを初期化する必要があります。

プロジェクトの設定には、プロジェクト内のすべての有効なテストに関するメタデータが収められています。これには、すべてのバリエーションの詳細、ターゲティング条件、目標、環境キーが含まれます。SDKを初期化すると、PHPアプリケーションで最新のテスト定義を使用し、テストを正しく実行できるようになります。

初期化の概要

PageSense PHP SDKの初期化は、次の2つの手順で行います。

PageSenseサーバーからプロジェクトの設定を取得します。
取得した設定を使用してPageSenseClientインスタンスを作成します。

1. プロジェクトの設定の取得

プロジェクトの設定には、プロジェクト内で有効（実行中、一時停止中、スケジュール設定済み）なすべてのA/Bテストの詳細が含まれます。これには、設定、バリエーション、目標、ターゲティングルールが含まれます。プロジェクトの設定は、getProjectSettings()メソッドを使用して、PageSenseサーバーから直接取得できます。

メソッドの呼び出し

PageSenseアカウントのプロジェクトの設定ファイルを取得するには、次のコードをアプリケーションに追加します。

useZoho\PageSense\PageSenseClientBuilder;
// プロジェクトの設定を取得
$projectSettings= PageSenseClientBuilder::getProjectSettings('accountId-DC','sdkKey', 'projectName' );

メソッドのパラメーター

パラメーター	種類	説明
accountId	文字列	データセンターコードを含む、PageSenseアカウント固有のID。
sdkKey	文字列	SDK環境に対応する一意のキー。Full Stackプロジェクトの設定にある［環境］タブで確認できます。
projectName	文字列	Full Stackプロジェクトの名前。

メモ：プロジェクトの設定が存在する場合、この関数は文字列化されたJSON形式で返します。プロジェクトの設定がない場合、この関数はnullを返します。

2. PageSenseClientインスタンスの作成

プロジェクトの設定を取得したら、PageSenseClientを初期化できます。クライアントはこれらの設定を使用して、各ユーザーセッションに適用するテストとバリエーションを判断します。

メソッドの呼び出し

// PageSenseClientインスタンスを作成
$pageSenseClient = PageSenseClientBuilder::getBuilder($projectSettings)->buildClient();

初期化後

PageSenseClientインスタンスで、次の操作を実行できるようになります。

テストを有効にする
バリエーション名を取得する
目標とコンバージョンを追跡する
プロジェクト単位の設定を管理する

アプリケーションの起動時にPageSenseClientのインスタンスを1つ作成し、アプリケーションのすべてのユーザーに対して使用できます。これにより、A/Bテストの実行、バリエーションの提供、目標コンバージョンの追跡、PageSenseへのトラッキング情報の送信を行えます。

メモ：PageSenseClientの初期化に失敗し、nullインスタンスになる場合にも安全に対応できるよう、堅牢なエラー処理を実装してください。予期しない実行時エラーを防ぐため、アプリケーション側でこの条件を適切に処理する必要があります。