プロジェクト設定の取得と更新

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

getAndUpdateProjectSettings() API は、PageSense サーバーから最新のプロジェクト設定を取得し、SDK の内部状態を更新します。これにより、アプリケーションは常に、PageSense ダッシュボードで定義された最新の実験ルール、バリエーションの詳細、ターゲティング条件、その他のプロジェクトレベルの更新内容を使用できます。

この API は、次のいずれかの仕組みで実行できます。

Webhook ベースの更新 – PageSense から Webhook 通知が送信されると、自動的にプロジェクト設定が更新されます。
ポーリングベースの更新 – SDK がバックグラウンドスレッドで定期的にスケジュール実行され、設定変更を確認します。

どちらの仕組みも、SDK と PageSense の設定を同期させるという目的は同じですが、更新がどのように、いつ開始されるかが異なります。

Webhook ベースの更新

PageSense で実験に対して、バリエーションの編集、条件の更新、目標の調整などの変更を行うと、通常は実験を一時停止し、更新してから再公開します。PageSense プロジェクトの［Environment 設定］で Webhook エンドポイントを設定している場合、実験が再公開されるたびに、PageSense からお客様のサーバーへ Webhook リクエストが送信されます。

サーバー側では、次の処理ができるようにしておく必要があります。

PageSense からの Webhook リクエストを受信すること
通知を受信したらすぐに getAndUpdateProjectSettings API を呼び出すこと。

これにより、次回のポーリングまで待つことなく SDK の設定を更新でき、ユーザーはほぼリアルタイムで更新後のロジックを利用できます。

Webhook の再試行動作

ネットワーク障害、ダウンタイム、エンドポイントに到達できないなどの理由で PageSense が Webhook を正常に配信できない場合、システムは自動的に 30 秒間隔で、最長 15 分まで配信を再試行します。

再試行の有効期間が完了しても成功しなかった場合、それ以上の試行は停止されます。ただし、その後にプロジェクトが更新されて再公開されると、新たな Webhook 配信が再度試行されます。

ポーリングによる更新

Webhook 連携がインフラストラクチャに適さない場合、代替手段として SDK でポーリング方式を利用できます。ポーリングを有効にすると、SDK は初期化時に指定した間隔で PageSense に対して構成の更新を定期的に確認します。

ポーリングを有効にすると、次の処理が行われます。

SDK がバックグラウンドでポーリング用スレッドを開始します。
各間隔ごとに、SDK は getAndUpdateProjectSettings を呼び出します。
更新が検出された場合、SDK は内部のプロジェクト状態を更新します。
更新が見つからない場合、SDK は次のチェックまで既存の構成を引き続き使用します。

ポーリングは、プロジェクト設定を常に最新の状態に保つための、予測可能で信頼性の高い方法です。特に、ファイアウォール制限、ネットワークポリシー、サーバーの制約などにより Webhook を受信できない環境で有効です。

メソッドの呼び出し

$pageSenseClient->getAndUpdateProjectSettings($accountName, $sdkKey, $projectName);

パラメーターの詳細:

パラメーター	種類	必須	説明
accountName	String	はい	PageSense アカウントの一意の識別子。
sdkKey	String	はい	環境用のセキュアキー。PageSense アプリケーションの［Environment］セクションで確認できます。
projectName	String	はい	PageSense アカウントで定義されているプロジェクト名。

Webhook とポーリングの選択

方法	最適な用途	特長
Webhook	リアルタイム更新	設定を同期する最速の方法。動的または頻繁に更新される実験に最適です。
Polling	Webhook 機能を利用できない環境	SDK がスケジュールに従って更新を確認します。Webhook が利用できない場合の信頼性の高いフォールバック手段です。