ウェブエージェントAPI統合によるトラフィック制御

エージェントの統合が完了したら、APIコードをコントロールターゲットに追加し、トラフィックコントロールを有効にします。

基本コントロール

Functions

NFStart

• Location : ページ上に表示されるボタンやアクションなどのアイテムのHTMLコードに適用します。
• Feature : トラフィックを制御したいWebページでVWRを有効にします。
• Terminate point : 関数のコールバック関数が呼ばれたら終了する。
• この時、待機終了(NFStop)関数を使用し、エントリー対象のページがロードされた時に、訪問者に提供されたキーを返します。
• パラメータ コード内には、NetFUNNELコンソールで作成した各セグメントに関連するAPIパラメータを入力します。
  • projectKey : トラフィック制御のためにNetFUNNELに登録したプロジェクトのユニークキー。
    • NetFUNNEL コンソールのサイドバーから取得する。
  • segmentKey : トラフィック制御用 NetFUNNEL に登録されているセグメントの固有キー。
    • NetFUNNEL コンソールの基本コントロールメニューから取得します。
• サンプルコード

/*
* @param {object} projectKey, segmentKey
* @param {Function} success callback
*/
NFStart({
projectKey: '{Project Key}',
segmentKey: '{Segment Key}'
}, function(response){
// TODO : Implement page navigation logic.
// Example : window.location.href = '{Enter URL after basic control Wait}';
});

NFStop

• Location ：エントリー後、サービスページがロードされた時に適用されます。
• Feature ：トラフィックコントロール対象への入場時に、待ち時間にNFStart機能で提供したキーの返却を受ける。
• パラメータ : N/A
• サンプルコード

/*
* @param {object} empty
* @param {Function} success callback
*/
NFStop({}, function(response) {
// No additional logic or implementation is required in this callback function.
});

区間コントロール

Functions

NFStartSection

• 場所 : 区間コントロールの開始URLへのエントリポイント
• 特徴 : 開始ページ(HTML)で、ページの区間(開始ページから終了ページまで)に留まるトラフィックの待ちを強制したい場合に、VWRを有効にする。
• 終了ポイント : 区間コントロール停止機能(NFStopSection)を使ってキーを返すページで終了する。
• Paremeters : NetFUNNELコンソールで作成した各セグメントに関連するAPIパラメータをコード内に入力する。
  • projectKey : NetFUNNEL にトラフィック制御用に登録したプロジェクトのユニークキー。
    • NetFUNNEL コンソールのサイドバーから取得する。
  • segmentKey : トラフィックコントロール用NetFUNNELに登録されているセグメントのユニークキー。
    • NetFUNNELコンソールの区間コントロールメニューから取得します。
• サンプルコード

/* 
* @param {object} projectKey, segmentKey 
* @param {Function} success callback 
*/
NFStartSection({ 
projectKey: '{Project key}', 
segmentKey: '{Segment key}' 
}, function(response){ 
// TODO : Implement logic to navigate to the start page of a path control.
// Example : window.location.href = '{Enter URL after path control Wait}';
});

NFStopSection

• Location : 区間コントロールの終了ページに入るときに適用されます。
• Feature : 区間コントロールのエンドページに入った後、キーを返すときに使用する。
• Paremeters : NetFUNNELコンソールで作成した各セグメントに関連するAPIパラメータをコード内に入力します。
  • projectKey : NetFUNNELにトラフィックコントロールを登録したプロジェクトのユニークキー。
    • NetFUNNEL コンソールのサイドバーから取得する。
  • segmentKey : トラフィックコントロール用NetFUNNELに登録されているセグメントのユニークキー。
    • NetFUNNELコンソールの区間コントロールメニューから取得します。
• サンプルコード

/*
* @param {object} projectKey, segmentKey
* @param {Function} success callback
*/
NFStopSection({
projectKey: '{{Project key}',
segmentKey: '{Segment key}'
}, function(response){
// No additional logic or implementation is required in this callback function.
});

適用テスト

NetFUNNEL Web Agentが正常に適用されていることを確認するには、以下の手順に従ってください。

1. 基本/区間コントロールセグメントの流入制限を「0」に設定する。
2. ウェブページ内でエントリーをリクエストする。
3. 画面に待合室が表示されるか確認する。(VWRチェック)
4. NetFUNNEL コンソールの基本制御メニューの該当セグメントで数値の変化があるか確認する。
   1. Classic Viewモードでの閲覧を推奨します。