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

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

概要

getAndUpdateProjectSettings APIは、PageSenseサーバーから最新のプロジェクト設定の詳細を取得し、それに応じてSDKを更新するために使用します。これにより、テスト、バリエーション、ターゲティング条件、その他のプロジェクトレベルの設定に対する変更を含め、PageSenseアプリで行われたすべての更新がアプリケーションに反映され、完全に同期された状態を維持できます。このAPIは、ウェブフックまたはポーリングの2通りの方法で呼び出せます。

ウェブフックベースの連携：PageSenseのイベントトリガーに基づいて、プロジェクトの設定を非同期で更新します。
ポーリングベースの連携：SDK内の専用ポーリングスレッドを使用し、事前に設定した時間間隔でプロジェクトの設定を同期的に更新します。

ウェブフック

ユーザーがPageSenseのフルスタックA／Bテストで、バリエーションの編集、ターゲティング条件の変更、目標の修正などを行う場合、通常はテストを一時停止し、必要な変更を適用してから、［実行する］ボタンをクリックしてテストを再実行します。

PageSenseプロジェクトの［環境設定］でウェブフックが設定されている場合、テストが再実行されるたびに、指定したウェブフックエンドポイントへのウェブフック呼び出しがPageSenseによって自動的に実行されます。

システム側では、PageSenseからのウェブフック呼び出しを受信できるようにしておく必要があります。ウェブフックを受信したらすぐにトリガー処理としてgetAndUpdateProjectSettings APIを実行し、最新のプロジェクト設定の詳細が遅延なく更新されるようにしてください。

ウェブフックの再試行

ネットワークの問題やサーバーの停止により最初のウェブフック呼び出しが失敗した場合、PageSenseは30秒ごとに最長15分間、ウェブフック呼び出しを自動的に再試行します。その時間内に呼び出しが正常に処理されなかった場合、再試行は停止します。ただし、その後さらに更新が行われ、テストが再実行されると、ウェブフック呼び出しが再度試行されます。

ポーリング

お使いの環境でウェブフック連携ができない場合は、SDKのポーリング機能を使用して、プロジェクト設定の詳細を最新の状態に維持できます。ポーリングを有効にすると、SDKは設定された一定の間隔でgetAndUpdateProjectSettings APIを自動的に呼び出し、PageSenseに更新があるかどうかを確認します。

設定されたポーリング間隔に基づいて、SDK内でポーリング用のバックグラウンドスレッドが開始されます。間隔ごとにgetAndUpdateProjectSettings APIを呼び出し、PageSenseのプロジェクトの設定に更新があるかどうかを確認します。変更が検出されると、APIはSDKの内部状態を最新のプロジェクト設定の詳細で更新します。変更がない場合、SDKは次のポーリングサイクルまで既存のプロジェクトの設定で動作します。

サーバーのアーキテクチャでウェブフックを利用できない場合や実用的でない場合、ポーリングは信頼性の高い代替手段となります。

APIの使用方法

pageSenseClient.getAndUpdateProjectSettings('accountName', 'sdkKey', 'projectName');

パラメーターの詳細。

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

サンプルコード

pageSenseClient.getAndUpdateProjectSettings('ZylkerUser1', 'xyz123abdscd', 'ZylkerFullStackProject');

このドキュメントが、作業を円滑に進めるうえでお役に立てば幸いです。詳しい説明が必要な場合やご質問がある場合は、メールアドレスsupport@zohopagesense.comまでいつでもお問い合わせください。