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

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

概要

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

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

Webhook

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

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

システム側では、PageSenseからのWebhook呼び出しを受信できるように準備し、受信後すぐにgetAndUpdateProjectSettings APIを実行する必要があります。これにより、APIが最新のプロジェクトの設定の詳細を遅延なく更新します。

Webhookの再試行

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

ポーリング

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

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

サーバー構成上、Webhookを利用できない場合や実装が困難な場合、ポーリングは信頼性の高い代替手段となります。

APIの使用方法

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

パラメーターの詳細

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

サンプルコード

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

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