---
sourceDocument: オーストラリア API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/api-reference

 Release :

    - australia

ft:locale :

    - ja-JP

ft:publication_title :

    - オーストラリア API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# ガイド付きツアー :クライアント

# ガイド付きツアー :クライアント {#ariaid-title1}

* リリースバージョン: Australia
* 
* 更新日 2026年03月12日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：11分

ガイド付きツアー API は、ガイド付きツアーを開始および停止するためのメソッドを提供します。

この API には [、ガイド付きツアーデザイナー](https://servicenow-prod.fluidtopics.net/fEqu40pQBO6GMEml1~X28g "インスタンスに送信された REST メッセージは、特定の HTTP 応答コードを返します。")で使用されるメソッドが含まれています。

## ガイド付きツアー:applyListFilter(関数filter_func) {#ariaid-title2}

`getAllTours()` メソッドが呼び出されたときに、フィルタリングされたツアー結果を取得する関数を設定します。
完全な署名には `上が含まれます。` メソッド名の前に NOW.guided_tours.api を追加します。
{#GT-applyListFilter_F__table_pqn_dbs_xhb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| filter_func | 関数 | `getAllTours()` メソッドから返された `tours[]` 配列から単一の`ツアー`オブジェクトを取得するフィルター関数。 |
[表 : 1. パラメーター]

{#GT-applyListFilter_F__table_pqn_dbs_xhb} {#GT-applyListFilter_F__table_qqn_dbs_xhb__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 2. 返される内容]

{#GT-applyListFilter_F__table_qqn_dbs_xhb}  
次の例は、基本的な API の使用方法を示しています。

    //create a filter function
    var filtFunction = function(tour) {
       //only return those tours whose name starts with 'my'
       return tour.name.indexOf('my') === 0);
    }

    //apply the filter 
    top.NOW.guided_tours.api.applyListFilter (filtFunction);

    //call the getAllTours method to observe the filtered tours
    top.NOW.guided_tours.api.getAllTours (function(er, tours) {
      if(!er) {
        console.log('The filtered tours are: ');
        console.log(tours);
      }
    });

次の例は、ツアーオブジェクトの `オプション` フィールドを使用して、 `filter_func()` 関数内でツアーを読み取ってフィルタリングするためのカスタムツアー識別子を持つ JSON を追加する方法を示しています。

    top.NOW.guided_tours.api.applyListFilter(function(tour) {
           var options = (tour.options)? JSON.parse(tour.options): null;
           return (options && options.my_param) ? (options.my_param == my_value) : false;
    });

## ガイド付きツアー:endTour() {#ariaid-title3}

現在再生中のツアーを停止します。このメソッドは、ツアーが再生されていない場合にサイレント終了します。
完全な署名には `上が含まれます。` メソッド名の前に NOW.guided_tours.api を追加します。
{#GT-endTour__table_g5n_3cs_xhb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 3. パラメーター]

{#GT-endTour__table_g5n_3cs_xhb} {#GT-endTour__table_h5n_3cs_xhb__entry__2}

| タイプ | 説明 |
|-|-|
| Null |   |
[表 : 4. 返される内容]

{#GT-endTour__table_h5n_3cs_xhb}  

    //create a callback function to end the tour if it starts correctly
    var cbFunction = function(err) {
    	if (err) {
       console.log('Error Occurred');
    }
    	else {
    	   // tour has started so we can call endTour
    	   top.NOW.guided_tours.api.endTour();
    }
    }

    //calling the startTour method so that we can end the tour as soon as it starts
    top.NOW.guided_tours.api.startTour('a297e04b732313007077edcc5ef6a780', 2, cbFunction);

## ガイド付きツアー:events.off(String event_name, Function listener_function) {#ariaid-title4}

既存のイベントリスナーを削除します。
完全な署名には `上が含まれます。` メソッド名の前に NOW.guided_tours.api を追加します。
{#GT-events.off_S_F__table_iwb_kbs_xhb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| event_name | 文字列 | リスナーから削除されるイベント名。 有効なイベント名: * ツアー開始済み * ツアー終了 * ツアー完了 * ツアー失敗 * ツアー放棄 * ツアー却下 * ステップ開始済み {#GT-events.off_S_F__ul_tn1_x4t_yhb} |
| listener_function | 関数 | オプション。指定した場合、指定されたリスナー関数は、そのイベントに添付されている残りのイベントリスナーから削除されます。指定しない場合、そのイベントに接続されているすべてのリスナー関数が削除されます。 |
[表 : 5. パラメーター]

{#GT-events.off_S_F__table_iwb_kbs_xhb} {#GT-events.off_S_F__table_jwb_kbs_xhb__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 6. 返される内容]

{#GT-events.off_S_F__table_jwb_kbs_xhb}  

    //create a callback function to handle the result of the api call
    var eventListenerTourStarted = function() {
       console.log('The tour has started'); 
    }
    var eventListenerTourEnded = function() {
       console.log('The tour has ended'); 
    }

    //attaching event listeners for tourStarted and tourEnded Events
    top.NOW.guided_tours.events.on('tourStarted',eventListenerTourStarted);
    top.NOW.guided_tours.events.on('tourEnded', eventListenerTourEnded);

    ...
    //start a tour
    top.NOW.guided_tours.api.startTour ('a297e04b732313007077edcc5ef6a780', 2, cbFunction);
    //As soon as the tour starts the eventListenerTourStarted gets fired
    ...
    top.NOW.guided_tours.api.endTour();
    // eventListenerTourEnded gets fired

    ....

    //removing the event listeners top.NOW.guided_tours.events.off('tourStarted',eventListenerTourStarted);
    top.NOW.guided_tours.events.off('tourEnded', eventListenerTourEnded);

## ガイド付きツアー:events.on(String event_name, Function listener_function) {#ariaid-title5}

イベントリスナーをガイド付きツアーイベントに添付します。
完全な署名には `上が含まれます。` メソッド名の前に NOW.guided_tours.api を追加します。
{#GT-events.on_S_F__table_iwb_kbs_xhb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| event_name | 文字列 | リスナーに添付されるイベント名。 有効なイベント名: * ステップ開始済み * ツアー開始済み * ツアー終了 * ツアー完了 * ツアー失敗 * ツアー放棄 * ツアー却下 {#GT-events.on_S_F__ul_tn1_x4t_yhb} |
| listener_function | 関数 | 追加するリスナー。 注: 目的を解決した後、イベントリスナーをクリアします。 |
| listener_function.obj | オブジェクト | 各イベントによって次の形式で `listener_function()` に渡されます。 * stepStarted イベントの場合: {tour: '<tour_sys_id>', step: step_num} * 他のすべてのイベントの場合: {tour: '<tour_sys_id>'} {#GT-events.on_S_F__ul_wsr_khs_g3b} JSON パラメーター: * tour_sys_id:文字列。ガイド付きツアー \[sys_embedded_tour_guide\] テーブルのガイド付きツアー ID * step_num:番号。0 (最初のステップ) と `n` (最後のステップ) の間の値 {#GT-events.on_S_F__ul_qfx_nhs_g3b} |
[表 : 7. パラメーター]

{#GT-events.on_S_F__table_iwb_kbs_xhb}  
次の例は、基本的な API の使用方法を示しています。

    //create a callback function to handle the result of the api call
    var eventListenerTourStarted = function() {
       console.log('The tour has started'); 
    }
    var eventListenerTourEnded = function() {
       console.log('The tour has ended'); 
    }

    //attaching event listeners for tourStarted and tourEnded Events
    top.NOW.guided_tours.events.on('tourStarted',eventListenerTourStarted);
    top.NOW.guided_tours.events.on('tourEnded', eventListenerTourEnded);

    ...
    //start a tour
    top.NOW.guided_tours.api.startTour ('a297e04b732313007077edcc5ef6a780', 2, cbFunction);
    //As soon as the tour starts the eventListenerTourStarted gets fired
    ...
    top.NOW.guided_tours.api.endTour();
    // eventListenerTourEnded gets fired

    ....

    //removing the event listeners top.NOW.guided_tours.events.off('tourStarted',eventListenerTourStarted);
    top.NOW.guided_tours.events.off('tourEnded', eventListenerTourEnded);

次の例は、`obj` を引数として `listener_function` パラメーターを使用する方法を示しています。

    top.NOW.guided_tours.events.on("tourStarted", function (obj){console.log(obj);});

## ガイド付きツアー:getAllTours(機能cb_function) {#ariaid-title6}

このメソッドの呼び出し元の現在のページ上のツアーのリストを取得します。このメソッドは非同期であるため、操作の成功を判断し、ツアーのリストを取得するには、コールバック関数を渡す必要があります。
完全な署名には `上が含まれます。` メソッド名の前に NOW.guided_tours.api を追加します。
{#GT-getAllTours_F__table_nrj_bbs_xhb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| cb_function | 関数 | `getAllTours()` メソッドが呼び出された現在のページのすべてのツアーをフェッチしようとした後、`getAllTours()` によって呼び出されたコールバック関数。 |
| cb_function.err | オブジェクト | 操作中にエラーが発生した場合は、そのオブジェクトを指します。 `err = { success: false, message: 'エラーオブジェクトを含む文字列' }` それ以外の場合は null です。 |
| cb_function.tours | アレイ | ページで利用可能なツアーのリスト。 ページにツアーが存在しない場合、 `cb_function.tours` は undefined を返します。 `if(!tours) console.log('ツアーはありません')` |
[表 : 8. パラメーター]

{#GT-getAllTours_F__table_nrj_bbs_xhb} {#GT-getAllTours_F__table_orj_bbs_xhb__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 9. 返される内容]

{#GT-getAllTours_F__table_orj_bbs_xhb}  

    //create a callback function to handle the result of the API call
    var cbFunction = function(err, tours) {
    	if (err) {
       console.log('Error Occurred');
    }
    	else {
    	    if(!tours) console.log('No tour present')
       else {
          tours.forEach(function(t) {
                   console.log(t);
                 });
              }
    }
    }
    //calling the getTours method
    top.NOW.guided_tours.api.getAllTours(cbFunction);

## ガイド付きツアー:loadPlayer() {#ariaid-title7}

ガイド付きツアープレーヤーがデフォルトで存在しないページにガイド付きツアープレーヤーをロードします。
署名の完了:

    NOW.guided_tours.api.loadPlayer()

{#GT-loadPlayer__table_g5n_3cs_xhb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 10. パラメーター]

{#GT-loadPlayer__table_g5n_3cs_xhb} {#GT-loadPlayer__table_h5n_3cs_xhb__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 11. 返される内容]

{#GT-loadPlayer__table_h5n_3cs_xhb}

## ガイド付きツアー:startTour(String tour_id, Number step_number, Function cb_function) {#ariaid-title8}

ツアーを開始します。このメソッドは非同期であるため、操作の成功を判断するにはコールバック関数を渡す必要があります。
完全な署名には `上が含まれます。` メソッド名の前に NOW.guided_tours.api を追加します。
{#GT-startTour_S_N_F__table_wh5_w1s_xhb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| tour_id | 文字列 | ガイド付きツアー \[sys_embedded_tour_guide\] テーブルのツアーの Sys ID。 |
| step_number | 番号 | オプション。ツアーを開始するステップ。指定しない場合 (またはステップ番号が 0 の場合)、ツアーは最初から開始されます。 |
| cb_function | 関数 | オプション。ツアーの起動後に `startTour()` メソッドによって呼び出されたコールバック関数。 |
| cb_function.err | オブジェクト | 操作中にエラーが発生した場合は、そのオブジェクトを指します。 `err = { success: false, message: 'エラーオブジェクトを含む文字列' }` それ以外の場合は null です。 |
[表 : 12. パラメーター]

{#GT-startTour_S_N_F__table_wh5_w1s_xhb} {#GT-startTour_S_N_F__table_xh5_w1s_xhb__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 13. 返される内容]

{#GT-startTour_S_N_F__table_xh5_w1s_xhb}  

    //create a callback function to handle the result of the API call
    var cbFunction = function(err) {
    	if (err) {
       console.log('Error Occurred');
    }
    	else {
       console.log('The tour with tourid=%s was successfully launched', tourId);
    }
    }

    //calling the startTour method
    top.NOW.guided_tours.api.startTour('a297e04b732313007077edcc5ef6a780', 2, cbFunction);