---
sourceDocument: Xanadu API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - ja-JP

ft:publication_title :

    - Xanadu API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# OrderGuide - スコープ対象

# OrderGuide - スコープ対象 {#ariaid-title1}

* リリースバージョン: Xanadu
* 
* 更新日 2024年08月01日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：5分

OrderGuide API を使用すると、注文ガイドの詳細を初期化して表示できます。

スコープ対象のアプリケーションでこのクラスを使用するには、`sn_sc` 名前空間識別子を使用します。デフォルトで有効になっているサービスカタログスコープ API プラグイン (com.glideapp.servicecatalog.scoped.api) は、OrderGuide API にアクセスするために必要です。

## OrderGuide - OrderGuide(文字列 sys_id) {#ariaid-title2}

指定された sys_id を使用して OrderGuide クラスのインスタンスを作成します。
{#OG-OrderGuide_S__table_bbt_ccc_5bb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| sys_id | 文字列 | OrderGuide の sys_id。 |
[表 : 1. パラメーター]

{#OG-OrderGuide_S__table_bbt_ccc_5bb}  
例：

    var cart=new sn_sc.OrderGuide("6690750f4f7b4200086eeed18110c761");

## OrderGuide - getID() {#ariaid-title3}

注文ガイドの sys_id を返します。
{#OG-getID__table_o2r_tyz_sbb__entry__3}

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

{#OG-getID__table_o2r_tyz_sbb} {#OG-getID__table_p2r_tyz_sbb__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | 注文ガイドの sys_id。 |
[表 : 3. 返される内容]

{#OG-getID__table_p2r_tyz_sbb}  
例：

    var cart=new sn_sc.OrderGuide("6690750f4f7b4200086eeed18110c761");	
    	console.log(cart.getID());

出力：

    6690750f4f7b4200086eeed18110c761

## OrderGuide - init(マップ request) {#ariaid-title4}

指定されたカタログアイテムと変数で注文ガイドを初期化し、その注文ガイドを返します。
{#OG-init_M__table_ym2_4zz_sbb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| request | マップ | カタログアイテムと変数の詳細を含む JSON オブジェクト。 |
[表 : 4. パラメーター]

{#OG-init_M__table_ym2_4zz_sbb} {#OG-init_M__table_zm2_4zz_sbb__entry__2}

| タイプ | 説明 |
|-|-|
| マップ | 初期化された注文ガイドの詳細を含む JSON オブジェクト。 |
[表 : 5. 返される内容]

{#OG-init_M__table_zm2_4zz_sbb}  
例：

    var guide = new sn_sc.OrderGuide('6690750f4f7b4200086eeed18110c761');
     
    var map = {};
    map.variables = {};
    //map.sysparm_id = '6690750f4f7b4200086eeed18110c761';
    map.variables['IOce433d0f4f7b4200086eeed18110c74d'] = '221f3db5c6112284009f4becd3039cc9'; //Here ce433d0f4f7b4200086eeed18110c74d is the sys_id of the variable and 221f3db5c6112284009f4becd3039cc9 is its value
    var includedItems = guide.init(map)

出力：

    {
    "cascade_variable_map":{
    },
    "items":[
    {
    "order":"-1",
    "quantity":"1",
    "show_quantity":false,
    "sys_id":"a4022d7b87c20300e3010cf888cb0bb2"
    },
    {
    "order":"300",
    "quantity":"1",
    "show_quantity":false,
    "sys_id":"186d917a6fab7980575967ddbb3ee4f2"
    },
    {
    "order":"600",
    "quantity":"1",
    "show_quantity":false,
    "sys_id":"8b3ae7fedc1be1004ece5c08239e522b"
    }
    ],
    "variable_assignments":{
    }
    }

## OrderGuide - isIncludeItems() {#ariaid-title5}

指定された注文ガイドの \[含めるかどうかの切り替えを表示\] (include_items) チェックボックスがオンになっているかどうかを指定します。
注:  
\[含めるかどうかの切り替えを表示\] フィールドは、デフォルトでは \[注文ガイド\] フォームに表示されません。 {#OG-isIncludeItems__table_ewn_tsd_sbb__entry__3}

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

{#OG-isIncludeItems__table_ewn_tsd_sbb} {#OG-isIncludeItems__table_fwn_tsd_sbb__entry__2}

| タイプ | 説明 |
|-|-|
| ブーリアン | 指定された注文ガイドの \[含めるかどうかの切り替えを表示\] チェックボックスがオンの場合は true を返します。無効な場合は false を返します。 |
[表 : 7. 返される内容]

{#OG-isIncludeItems__table_fwn_tsd_sbb}  

    var orderGuide=new sn_sc.OrderGuide("6690750f4f7b4200086eeed18110c761");	
    	console.log(orderGuide.isIncludeItems());

出力:

    true

## OrderGuide - isTwoStep() {#ariaid-title6}

2 ステップチェックアウトが有効かどうかを指定します。
{#OG-isTwoStep__table_zjf_3yz_sbb__entry__3}

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

{#OG-isTwoStep__table_zjf_3yz_sbb} {#OG-isTwoStep__table_akf_3yz_sbb__entry__2}

| タイプ | 説明 |
|-|-|
| ブーリアン | 2 ステップチェックアウトが有効であれば true を返します。無効な場合は false を返します。 |
[表 : 9. 返される内容]

{#OG-isTwoStep__table_akf_3yz_sbb}  
例：

    var orderGuide=new sn_sc.OrderGuide("6690750f4f7b4200086eeed18110c761");	
    	console.log(orderGuide.isTwoStep());

出力：

    false

## OrderGuide - isUseCustomCart() {#ariaid-title7}

2 ステップの注文ガイドで別個の買い物かご (カタログアイテム用のものとは異なる) の使用を有効にするかどうかを指定します。
{#OG-isUseCustomCart__table_xtd_vsd_sbb__entry__3}

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

{#OG-isUseCustomCart__table_xtd_vsd_sbb} {#OG-isUseCustomCart__table_ytd_vsd_sbb__entry__2}

| タイプ | 説明 |
|-|-|
| ブーリアン | 2 ステップの注文ガイドで別個の買い物かごの使用が有効な場合は true を返します。無効な場合は false を返します。 |
[表 : 11. 返される内容]

{#OG-isUseCustomCart__table_ytd_vsd_sbb}  
例：

    var orderGuide=new sn_sc.OrderGuide("6690750f4f7b4200086eeed18110c761");	
    	console.log (orderGuide.isUseCustomCart());

出力：

    false

## OrderGuide - navigateFromMap(マップ itemDetails) {#ariaid-title8}

注文ガイドのカタログアイテムに移動します。
{#OG-navigateFromMap_M__table_xtm_czz_sbb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| itemDetails | マップ | 注文ガイドのカタログアイテムの詳細を含む JSON オブジェクト。 |
[表 : 12. パラメーター]

{#OG-navigateFromMap_M__table_xtm_czz_sbb} {#OG-navigateFromMap_M__table_ytm_czz_sbb__entry__2}

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

{#OG-navigateFromMap_M__table_ytm_czz_sbb}  
例：

    var orderGuide=new sn_sc.OrderGuide.navigateFromMap(itemdetails);