PageSense Node.js SDK の初期化

PageSense Node.js SDK の初期化

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

はじめに  

PageSenseClientは、実験を実行するための中核となるインターフェースです。実験の有効化、ゴールの追跡、バリエーションの評価など、すべての処理がこのクライアントを通じて行われます。これらの機能を使用する前に、一度初期化する必要があります。
初期化は非同期で、1つの手順で行われます。SDKがPageSenseサーバーを呼び出してプロジェクト設定を取得し、クライアントをセットアップします。プロジェクト設定には、次の情報が含まれます。
  • プロジェクトに設定されているすべてのFullStack実験。
  • 各実験の現在のステータス。
  • トラフィックの割り当てとオーディエンスのターゲティングルール。

メソッド  

  1. const pageSenseClient = await PageSenseClientBuilder.createNewPageSenseClient(
  2. accountId,
  3. sdkKey,
  4. projectName,
  5. sdkOptions
  6. );

パラメーター  

パラメーター
型
説明
accountId
文字列
PageSenseアカウントの識別子。
sdkKey
文字列
環境のSDKキー。FullStackプロジェクトの設定ページにある［SDK設定］で確認できます。
projectName
文字列
実験が保存されているPageSenseプロジェクト。
sdkOptions
オブジェクト
任意。ログ、ポーリング、リクエストの動作をこちらで設定します。

内部で行われる処理  

関数「createNewPageSenseClient()」を実行すると、次の処理が行われます。
  1. SDKがPageSenseサーバーにプロジェクト設定を要求します。
  2. 実験の設定、ターゲティングルール、トラフィックの割り当てを解析します。
  3. PageSenseClientインスタンスを初期化して返します。
これで、クライアントで実験を評価し、イベントを追跡できるようになります。
認証情報の誤り、ネットワークの問題、設定の欠落などにより初期化に失敗した場合、SDKはnullを返すか、エラーをスローします。

使用例  

  1. const { PageSenseClientBuilder } = require('@zoho/pagesense-node-sdk');
  2. async function initializeSDK() {
  3. const accountId = 'YOUR_ACCOUNT_ID';
  4. const sdkKey = 'YOUR_SDK_KEY';
  5. const projectName = 'YOUR_PROJECT_NAME';
  6. const sdkOptions = {};
  7. const pageSenseClient = await PageSenseClientBuilder.createNewPageSenseClient(
  8. accountId,
  9. sdkKey,
  10. projectName,
  11. sdkOptions
  12. );
  13. if (!pageSenseClient) {
  14. console.error('PageSense SDK initialization failed.');
  15. return;
  16. }
  17. console.log('PageSense SDK initialized successfully.');
  18. }
  19. initializeSDK();

注意事項  

  • createNewPageSenseClient()は非同期です。必ずawaitを使用するか、Promiseチェーンを使用してください。
  • クライアントの準備が完了する前に、実験APIや追跡APIを呼び出さないでください。
  • 失敗時の処理を実装してください。nullが返された場合は、初期化中に問題が発生しています。





このドキュメントは、各手順をわかりやすく進められるように作成されています。さらにサポートが必要な場合やご不明な点がある場合は、support@zohopagesense.com - までお気軽にお問い合わせください。いつでもこちらでサポートいたします！