初期化設定

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

---

必須パラメータ

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

Client IDとSecret Keyの取得

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

---

基本初期化

必須パラメータのみ使用

NetFunnelInitialize config = NetFunnelInitialize.Companion.builder()
    .clientId("{{CLIENT_ID}}")
    .secretKey("{{SECRET_KEY}}")
    .build();

---

初期化設定パラメータ

フィールド	型	デフォルト	説明	エージェントバージョン
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以上
logLevel	Level	Level.OFF	ch.qos.logback.classic.Levelに基づいてログレベルを設定するため、該当依存関係の追加が必要です。使用可能レベル: ERROR、WARN、INFO、DEBUG、TRACE、OFF	4.0.1以上
goodBots	Array<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.1以上

---

設定例

基本設定

NetFunnelInitialize config = NetFunnelInitialize.Companion.builder()
    .clientId("{{CLIENT_ID}}")
    .secretKey("{{SECRET_KEY}}")
    .build();

ログレベル設定

import ch.qos.logback.classic.Level;

NetFunnelInitialize config = NetFunnelInitialize.Companion.builder()
    .clientId("{{CLIENT_ID}}")
    .secretKey("{{SECRET_KEY}}")
    .logLevel(Level.INFO)
    .build();

Good Bot例外処理

NetFunnelInitialize config = NetFunnelInitialize.Companion.builder()
    .clientId("{{CLIENT_ID}}")
    .secretKey("{{SECRET_KEY}}")
    .goodBots(new String[]{"Googlebot", "Bingbot", "Slurp", "Applebot", "facebookexternalhit"})
    .build();

ユーザー識別設定

NetFunnelInitialize config = NetFunnelInitialize.Companion.builder()
    .clientId("{{CLIENT_ID}}")
    .secretKey("{{SECRET_KEY}}")
    .userId("{{USER_ID}}")
    .build();

進入キー自動返却無効化

NetFunnelInitialize config = NetFunnelInitialize.Companion.builder()
    .clientId("{{CLIENT_ID}}")
    .secretKey("{{SECRET_KEY}}")
    .returnKey(false)
    .build();

待機室ドメイン変更

NetFunnelInitialize config = NetFunnelInitialize.Companion.builder()
    .clientId("{{CLIENT_ID}}")
    .secretKey("{{SECRET_KEY}}")
    .vwrPageDomain("https://wait.example.com")
    .build();

クッキードメイン設定

NetFunnelInitialize config = NetFunnelInitialize.Companion.builder()
    .clientId("{{CLIENT_ID}}")
    .secretKey("{{SECRET_KEY}}")
    .cookieDomain(".example.com")
    .build();

完全な構成例

import ch.qos.logback.classic.Level;

NetFunnelInitialize config = NetFunnelInitialize.Companion.builder()
    // 必須
    .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)
    
    // ロギング
    .logLevel(Level.INFO)
    
    // ボット例外処理
    .goodBots(new String[]{"Googlebot", "Bingbot"})
    
    // ユーザー識別
    .userId("{{USER_ID}}")
    .build();

---

パラメータ有効性検証

clientId

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

secretKey

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

logLevel

• オプション
• 型: ch.qos.logback.classic.Level
• デフォルト: Level.OFF
• 使用可能レベル: ERROR、WARN、INFO、DEBUG、TRACE、OFF
• 依存関係: logback-classic必要

goodBots

• オプション
• 型: String[]
• デフォルト: null
• 例: new String[]{"Googlebot", "Bingbot"}

returnKey

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

---

関連ドキュメント

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