PHP SDKの初期設定

PHP SDKの初期設定

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

PageSenseClient クラスは、PageSense PHP SDKがユーザー向けにフルスタック A/B テストの実験を実行するために提供するメインインターフェイスです。バリエーションを配信したりコンバージョン目標を計測したりする前に、クライアントをプロジェクト設定として知られるプロジェクトの設定情報で初期化する必要があります。

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

Initialization 概要  

PageSense PHP SDK の初期化は、次の 2 ステップで行います。

  1. PageSense サーバーからプロジェクト設定を取得する。

  2. 取得した設定を使用して PageSenseClient インスタンスを作成する。

1. プロジェクト設定を取得する  

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

メソッドの呼び出し

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

 

  1. use Zoho\PageSense\PageSenseClientBuilder;
  2. // プロジェクト設定を取得する
  3. $projectSettings= PageSenseClientBuilder::getProjectSettings('accountId-DC','sdkKey', 'projectName' );
メソッドのパラメーター

Parameter

種類

説明

accountId

string

データセンターコードを含む、固有の PageSense アカウント ID。

sdkKey

string

SDK 環境に対応する一意のキー。Full Stack プロジェクト設定の Environment タブで確認できます。

projectName

string

Full Stack プロジェクトの名前。

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

2. PageSenseClient インスタンスを作成する  

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

メソッドの呼び出し

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

初期化後  

PageSenseClient インスタンスでは、次の操作が可能になります。

  • 実験のアクティブ化

  • バリエーション名の取得

  • 目標およびコンバージョンのトラッキング

  • プロジェクトレベルの設定の管理

アプリケーションの起動時に PageSenseClient のインスタンスを 1 つ作成し、アプリケーションのすべてのユーザーに対して A/B テストの実行、バリエーションの配信、目標コンバージョンのトラッキング、およびトラッキング情報の PageSense への送信に利用できます。
Notesメモ:PageSenseClient の初期化に失敗してインスタンスが null になるケースを安全に処理できるよう、堅牢なエラー処理を実装してください。アプリケーションはこの状態を適切に扱い、予期しない実行時エラーを回避する必要があります。