初期化設定

このドキュメントでは、Netfunnel.initialize()で使用可能なすべての初期化設定について説明します。

---

必須パラメータ

初期化設定にはclientIdとsecretKeyパラメータが必要です。

Client IDとSecret Keyの取得

Client IDとSecret Keyの取得方法と初期化例については、クイックスタートドキュメントを参照してください。

---

基本初期化

必須パラメータのみ使用

import { Netfunnel } from 'netfunnel-node-agent';

Netfunnel.initialize({
  clientId: '{{CLIENT_ID}}',
  secretKey: '{{SECRET_KEY}}'
});

---

初期化設定パラメータ

フィールド	型	デフォルト	説明	エージェントバージョン
clientId	string	N/A	コンソールで発行されたクライアントIDを入力します。	4.0.1以上
secretKey	string	N/A	コンソールで発行された暗号化キーを入力します。	4.0.1以上
serverUrl	string	N/A	NetFUNNELサーバーのURLです。CNAMEを使用せず、clientIdベースのURL組み合わせではない別のURLでサーバーにアクセスする際に使用します。 (既存方式との互換性のためにサポートされています。)	4.0.1以上
settingUrl	string	N/A	NetFUNNEL環境設定ファイルのURLです。CNAMEを使用せず、clientIdベースのURL組み合わせではない別のURLで設定ファイルを読み込む際に使用します。 (既存方式との互換性のためにサポートされています。)	4.0.1以上
vwrPageUrl	string	N/A	NetFUNNEL VWR PageのURLです。CNAMEを使用せず、clientIdベースのURL組み合わせではない別のURLで待機室ページに進入する必要がある場合に指定します。	4.0.1以上
returnKey	boolean	true	ユーザーが待機列を通過してページに進入すると、次のユーザーがすぐに入場できます。オプションを無効にすると、ユーザーがページに進入した後も一定時間、次のユーザーが待機します。 (タイムアウト設定はコンソールのセグメント設定 > 詳細設定で可能です。)	4.0.1以上
printLog	boolean	false	デバッグログ出力の有無を設定します。	4.0.1以上
goodBots	string[]	N/A	善意のボット(検索エンジンなど)がNetFUNNEL進入リクエストから除外されるように設定します。文字列の配列で値を受け取ります。例: ["Googlebot", "Bingbot"]	4.0.1以上
userId	string	N/A	この値を入力すると、ホワイトリストおよび永続ブロックユーザーの区別にIDが使用されます。コンソールの反復リクエストブロック > ユーザー設定 > アクセサー管理で設定したIDが適用されます。	4.0.1以上
vwrPageDomain	string	N/A	CNAMEドメインのみでVWR Page URLを構成する際に使用します。例: https://vwr.example.com	4.0.1以上
cookieDomain	string	N/A	発行されるNetFUNNELクッキーのドメイン(Domain)値を直接指定できます。	4.0.2以上

---

設定例

基本設定

import { Netfunnel } from 'netfunnel-node-agent';

Netfunnel.initialize({
  clientId: '{{CLIENT_ID}}',
  secretKey: '{{SECRET_KEY}}'
});

デバッグログ有効化

import { Netfunnel } from 'netfunnel-node-agent';

Netfunnel.initialize({
  clientId: '{{CLIENT_ID}}',
  secretKey: '{{SECRET_KEY}}',
  printLog: true
});

Good Bot例外処理

import { Netfunnel } from 'netfunnel-node-agent';

Netfunnel.initialize({
  clientId: '{{CLIENT_ID}}',
  secretKey: '{{SECRET_KEY}}',
  goodBots: ['Googlebot', 'Bingbot', 'Slurp', 'Applebot', 'facebookexternalhit']
});

ユーザー識別設定

import { Netfunnel } from 'netfunnel-node-agent';

Netfunnel.initialize({
  clientId: '{{CLIENT_ID}}',
  secretKey: '{{SECRET_KEY}}',
  userId: '{{USER_ID}}'
});

進入キー自動返却無効化

import { Netfunnel } from 'netfunnel-node-agent';

Netfunnel.initialize({
  clientId: '{{CLIENT_ID}}',
  secretKey: '{{SECRET_KEY}}',
  returnKey: false
});

待機室ドメイン変更

import { Netfunnel } from 'netfunnel-node-agent';

Netfunnel.initialize({
  clientId: '{{CLIENT_ID}}',
  secretKey: '{{SECRET_KEY}}',
  vwrPageDomain: 'https://wait.example.com'
});

クッキードメイン設定

import { Netfunnel } from 'netfunnel-node-agent';

Netfunnel.initialize({
  clientId: '{{CLIENT_ID}}',
  secretKey: '{{SECRET_KEY}}',
  cookieDomain: '.example.com'
});

完全な構成例

import { Netfunnel } from 'netfunnel-node-agent';

Netfunnel.initialize({
  // 必須
  clientId: '{{CLIENT_ID}}',
  secretKey: '{{SECRET_KEY}}',
  
  // サーバー構成 (オプション)
  serverUrl: 'https://custom-server.example.com',
  settingUrl: 'https://custom-setting.example.com',
  vwrPageUrl: 'https://custom-vwr.example.com',
  
  // 待機室設定
  vwrPageDomain: 'https://wait.example.com',
  cookieDomain: '.example.com',
  
  // キー管理
  returnKey: true,
  
  // ロギング
  printLog: false,
  
  // ボット例外処理
  goodBots: ['Googlebot', 'Bingbot'],
  
  // ユーザー識別
  userId: '{{USER_ID}}'
});

---

パラメータ有効性検証

clientId

• 必須
• 型: string
• 有効性検証: 空文字列不可
• ソース: NetFUNNELコンソール → プロフィールアイコン → 統合資格情報 (Integration Credentials)

secretKey

• 必須
• 型: string
• 有効性検証: 空文字列不可
• ソース: NetFUNNELコンソール → プロフィールアイコン → 統合資格情報 (Integration Credentials)

printLog

• オプション
• 型: boolean
• デフォルト: false
• 動作: trueの場合、デバッグログをコンソールに出力

goodBots

• オプション
• 型: string[]
• デフォルト: undefined
• 例: ['Googlebot', 'Bingbot']

returnKey

• オプション
• 型: boolean
• デフォルト: true
• 動作: trueの場合即座にキー返却、falseの場合タイムアウト設定に従って返却

---

関連ドキュメント

• インストールと初期化: 初期化例を含む設定ガイド
• APIリファレンス: 関数仕様と使用方法
• トラブルシューティング: 一般的な問題と解決方法