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

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

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

このAPIは、次のいずれかの方法で実行できます。

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

どちらの方法も、SDKをPageSenseと同期するという目的は同じですが、更新が開始される方法とタイミングが異なります。

Webhookによる更新

バリエーションの編集、条件の更新、目標の調整など、PageSenseでテストに変更を加える場合、通常はテストを一時停止して更新し、再実行します。PageSenseプロジェクトの環境設定でWebhookエンドポイントを設定している場合、テストが再実行されるたびに、PageSenseからサーバーにWebhook要求が送信されます。

サーバーで次の処理を行えるようにします。

PageSenseからWebhook要求を受信すること。
API「getAndUpdateProjectSettings」を通知の受信後すぐに呼び出すこと。

これにより、次のポーリング周期を待たずにSDKの設定が更新され、更新されたロジックがユーザーにほぼ即時に適用されます。

Webhookの再試行動作

ネットワークの問題、ダウンタイム、エンドポイントに接続できないなどの理由でPageSenseがWebhookを正常に配信できない場合、システムは30秒ごとに、最長15分間、自動的に配信をもう一度試します。

再試行期間内に配信に成功しなかった場合、試行は停止します。ただし、その後プロジェクトが更新されて再実行されると、新たなWebhook送信が実行されます。

ポーリングによる更新

Webhook連携がインフラに適していない場合、SDKでは代替手段としてポーリング機能を利用できます。ポーリングを使用すると、初期化時に指定した間隔で、SDKがPageSenseの設定に更新がないか定期的に確認できます。

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

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

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

メソッドの呼び出し

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

パラメーターの詳細。

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

Webhookとポーリングの選択

方法	適した用途	特徴
Webhook	リアルタイム更新	設定を最も速く同期できます。動的なテストや頻繁に更新されるテストに適しています。
ポーリング	Webhookを利用できない環境	SDKがスケジュールに従って更新を確認します。Webhookを利用できない場合の信頼性の高い代替手段です。

このドキュメントが、操作を円滑に進めるための一助となれば幸いです。詳しい説明が必要な場合やご質問がある場合は、いつでもsupport@zohopagesense.comまでメールでお気軽にお問い合わせください。