プロジェクト設定の取得と更新
お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。
getAndUpdateProjectSettings API は、PageSenseサーバーから最新のプロジェクト設定情報を取得し、SDKを更新するために使用されます。これにより、PageSenseアプリケーションで行われた実験、バリエーション、ターゲティング条件、その他のプロジェクトレベルの設定の変更が、アプリケーションに確実に同期されます。このAPIは、Webhookまたはポーリングの2つの方法で呼び出すことができます。
- Webhook連携:PageSenseからのイベントトリガーに基づき、プロジェクト設定を非同期で更新します。
- ポーリング連携:SDK内の専用ポーリングスレッドを使い、あらかじめ設定した時間間隔でプロジェクト設定を同期的に更新します。
Webhook
PageSenseでFullStack A/B実験のバリエーション編集、ターゲティング条件の変更、ゴールの修正などを行う際は、通常、実験を一時停止し、必要な変更を適用した後、[Launch]ボタンをクリックして再開します。
PageSenseプロジェクトの環境設定でWebhookが設定されている場合、実験が再開されるたびに、PageSenseは指定されたWebhookエンドポイントに自動的にWebhookコールを送信します。
システムはPageSenseからのWebhookコールを受信できるよう準備し、Webhook受信後すぐにgetAndUpdateProjectSettings APIをトリガーしてください。これにより、APIが遅延なく最新のプロジェクト設定情報に更新します。
Webhook再試行
初回のWebhookコールがネットワーク障害やサーバーダウンタイムにより失敗した場合、PageSenseは自動的に再試行を30秒ごとに最大15分間行います。指定された時間内にコールが正常に処理されない場合、再試行は停止します。ただし、追加の更新が行われて実験が再度再開された場合、Webhookコールは再び試行されます。
ポーリング
Webhook連携がご利用環境で難しい場合は、SDKのポーリング機構を利用してプロジェクト設定情報を最新の状態に保つことができます。ポーリングが有効な場合、SDKは設定した間隔（任意で設定可能）で自動的にgetAndUpdateProjectSettings APIを呼び出し、PageSenseの更新を確認します。
ポーリング用に設定された間隔に従い、SDK内でバックグラウンドスレッドが起動します。各間隔ごとにgetAndUpdateProjectSettings APIを呼び出し、PageSenseプロジェクト設定の更新を確認します。変更が検出された場合、APIはSDKの内部状態を最新のプロジェクト設定情報で更新します。変更がない場合は、次回のポーリングまで既存のプロジェクト設定で動作します。
Webhookサポートが利用できない、またはサーバーアーキテクチャ上適さない場合の信頼性の高い代替手段です。
APIの利用方法
- pageSenseClient。getAndUpdateProjectSettings('accountName', 'sdkKey', 'projectName');
パラメーター詳細:
|
パラメーター |
種類 |
必須 |
説明 |
|
accountName |
String |
はい |
PageSenseアカウントの固有の識別子。 |
|
sdkKey |
String |
はい |
環境用のセキュアキー。PageSenseアプリケーションのEnvironmentセクションから利用可能です。 |
|
projectName |
String |
はい |
PageSenseアカウントで定義されたプロジェクトの名前です。 |
例 コード
- pageSenseClient。getAndUpdateProjectSettings('ZylkerUser1', 'xyz123abdscd', 'ZylkerFullStackProject');
このドキュメントが作業の円滑化にお役立ていただければ幸いです。ご不明な点や追加の説明が必要な場合は、いつでもサポート窓口までメールでご連絡ください。サポート@zohopagesense.com