---
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


---

# CatalogJS - スコープ対象

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

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

CatalogJS API は、カタログ固有のプロパティをチェックおよび取得するためのメソッドを提供します。

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

## CatalogJS - カタログ (GlideRecord now_GR) {#ariaid-title2}

指定された Glide レコードオブジェクトのカタログクラスのインスタンスを作成します。
{#CJS-Catalog_G__table_og2_g1c_5bb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| now_GR | オブジェクト | sc_catalogテーブルを指す Glide レコード。 |
[表 : 1. パラメーター]

{#CJS-Catalog_G__table_og2_g1c_5bb}  
この例は、カタログクラスの新しいインスタンスを作成する方法を示しています。

    var now_GR = new GlideRecord('sc_catalog');
     now_GR.addQuery('sys_id','e0d08b13c3330100c8b837659bba8fb4');
     now_GR.query();
     var catalog = new sn_sc.Catalog(now_GR);

## CatalogJS - カタログ (文字列 sys_id) {#ariaid-title3}

指定されたsys_idでカタログクラスのインスタンスを作成します。
{#CJS-Catalog_S__table_tf1_gbc_5bb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| sys_id | 文字列 | カタログのSys_id。 |
[表 : 2. パラメーター]

{#CJS-Catalog_S__table_tf1_gbc_5bb}  
この例では、指定されたsyst_idで Catalog クラスのインスタンスを作成する方法を示します。

    new sn_sc.Catalog(catalog_sys_id);
    var catalog = new sn_sc.Catalog("31bea3d53790200044e0bfc8bcbe5dec");

## CatalogJS - canView(ブール、mobile、文字列 userId) {#ariaid-title4}

ユーザーがモバイルデバイスまたはデスクトップで現在のカテゴリを表示できるかどうかを決定します。
{#CJS-canView_B__table_mnl_2lz_sbb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| mobile | ブーリアン | ユーザーが現在のカタログをモバイルビューまたはデスクトップビューで表示できるかどうかを確認するかどうかを示すフラグ。 有効な値： * true:モバイルビュー * false:デスクトップビュー {#CJS-canView_B__ul_qfp_cb4_kpb} |
| userId | 文字列 | オプション。カタログを表示できるかどうかを確認するユーザーのSys_id。 デフォルト:現在のユーザー |
[表 : 3. パラメーター]

{#CJS-canView_B__table_mnl_2lz_sbb} {#CJS-canView_B__table_nnl_2lz_sbb__entry__2}

| タイプ | 説明 |
|-|-|
| ブーリアン | カタログをユーザーが表示できるかどうかを示すフラグ。 有効な値： * true:カタログはユーザーが表示できます。 * false:カタログはユーザーは表示できません。 {#CJS-canView_B__ul_wbn_mb4_kpb} |
[表 : 4. 返される内容]

{#CJS-canView_B__table_nnl_2lz_sbb}  
例：

    var catalog = new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
    gs.info(catalog.canView(true));

出力：

    true

## CatalogJS - getAvailableCatalog() {#ariaid-title5}

利用可能なアクティブなカタログを返します。
アクティブなカタログが 1 つしか存在しない場合、メソッドはそのカタログを返します。それ以外の場合は、ユーザーが表示できるカタログのリストから作成された最も古いカタログが返されます。カタログが利用できない場合、このメソッドは null を返します。
{#CJS-getAvailableCatalog__table_m31_rmz_sbb__entry__3}

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

{#CJS-getAvailableCatalog__table_m31_rmz_sbb} {#CJS-getAvailableCatalog__table_n31_rmz_sbb__entry__2}

| タイプ | 説明 |
|-|-|
| オブジェクト | ユーザーが表示できる最も古いカタログを指すオブジェクト。利用可能なカタログがない場合は null。 |
[表 : 6. 返される内容]

{#CJS-getAvailableCatalog__table_n31_rmz_sbb}  
この例では、現在のユーザーが使用できるカタログを返します。

    var catalog = sn_sc.Catalog.getAvailableCatalog()

## CatalogJS - getBackgroundColor() {#ariaid-title6}

カタログの背景色を返します。
{#CJS-getBackgroundColor__table_etj_mrz_sbb__entry__3}

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

{#CJS-getBackgroundColor__table_etj_mrz_sbb} {#CJS-getBackgroundColor__table_ftj_mrz_sbb__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | カタログの背景色。 |
[表 : 8. 返される内容]

{#CJS-getBackgroundColor__table_ftj_mrz_sbb}  
この例では、関連するカタログの背景色を返します。

    var catalog = new sn_sc.Catalog("0f910a2ac3112200b12d9f2974d3ae3c");
    gs.info("Catalog background: " + catalog.getBackgroundColor());

出力：

    Catalog background: white

## CatalogJS - getCatalogCount() {#ariaid-title7}

カタログテーブルでアクティブなカタログの数を返します。
{#CJS-getCatalogCount__table_ez1_znz_sbb__entry__3}

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

{#CJS-getCatalogCount__table_ez1_znz_sbb} {#CJS-getCatalogCount__table_fz1_znz_sbb__entry__2}

| タイプ | 説明 |
|-|-|
| 整数 | カタログテーブルで使用可能なカタログの数。 |
[表 : 10. 返される内容]

{#CJS-getCatalogCount__table_fz1_znz_sbb}  
例：

    console.log(sn_sc.Catalog.getCatalogCount());

出力：

    3

## CatalogJS - getCategories() {#ariaid-title8}

現在のカタログのカテゴリを返します。
{#CJS-getCategories__table_nwt_l4z_sbb__entry__3}

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

{#CJS-getCategories__table_nwt_l4z_sbb} {#CJS-getCategories__table_owt_l4z_sbb__entry__2}

| タイプ | 説明 |
|-|-|
| ArrayList | 現在のカタログのカテゴリを返します。 |
[表 : 12. 返される内容]

{#CJS-getCategories__table_owt_l4z_sbb}  
この例では、現在のカタログオブジェクトで使用可能なカテゴリを返します。

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
    console.log(catalog.getCategories());

出力：

    0 : {header_image: "", sys_id: "e15706fc0a0a0aa7007fc21e1ab70c2f", description: "Your IT gateway. Report issues and submit requests.", title: "Can We Help You?"} 
    1 : {header_image: "", sys_id: "95fc11615f1211001c9b2572f2b477c6", description: "Services offered by different departments in the organization", title: "Departmental Services"} 
    2 : {header_image: "", sys_id: "900682363731300054b6a3549dbe5d5f", description: "Desktop computers for your work area.", title: "Desktops"} 
    3 : {header_image: "", sys_id: "d2f716fcc611227a015a142fa0b262c1", description: "Order new furniture, and fixtures, or request for cubicle modifications can also be ordered here.", title: "Furniture and Decor"} 
    4 : {header_image: "", sys_id: "d258b953c611227a0146101fb1be7c31", description: "Order from a variety of hardware to meet your business needs, including phones, tablets and laptops.", title: "Hardware"} 

## CatalogJS - getCategoryIds() {#ariaid-title9}

現在のカタログ内のカテゴリのsys_idsを指定します。
{#CJS-getCategoryIds__table_ivv_3pz_sbb__entry__3}

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

{#CJS-getCategoryIds__table_ivv_3pz_sbb} {#CJS-getCategoryIds__table_jvv_3pz_sbb__entry__2}

| タイプ | 説明 |
|-|-|
| ArrayList | 現在のカタログ内のカテゴリのsys_idsを返します。 |
[表 : 14. 返される内容]

{#CJS-getCategoryIds__table_jvv_3pz_sbb}  
この例では、現在のカタログで使用可能なカテゴリのsys_idsを返します。

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
    console.log(catalog.getCategoryIds());

出力：

    0:"e15706fc0a0a0aa7007fc21e1ab70c2f"
    1 : "95fc11615f1211001c9b2572f2b477c6"
    2 : "900682363731300054b6a3549dbe5d5f"
    3 : "d2f716fcc611227a015a142fa0b262c1"

## CatalogJS - getDescription() {#ariaid-title10}

現在のカタログの説明を返します。
{#CJS-getDescription__table_g5q_3qz_sbb__entry__3}

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

{#CJS-getDescription__table_g5q_3qz_sbb} {#CJS-getDescription__table_h5q_3qz_sbb__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | カタログの説明。 |
[表 : 16. 返される内容]

{#CJS-getDescription__table_h5q_3qz_sbb}  
この例では、現在のカタログの名前を返します。

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
    console.log(catalog.getDescription());

出力：

    Service Catalog - IT Now

## CatalogJS - getDesktopImageSRC() {#ariaid-title11}

カタログデスクトップ画像ファイル名を返します。
{#CJS-getDesktopImageSRC__table_zdf_csz_sbb__entry__3}

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

{#CJS-getDesktopImageSRC__table_zdf_csz_sbb} {#CJS-getDesktopImageSRC__table_a2f_csz_sbb__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | カタログデスクトップ画像ファイル名。 |
[表 : 18. 返される内容]

{#CJS-getDesktopImageSRC__table_a2f_csz_sbb}  
この例では、現在のカタログデスクトップイメージファイル名を返します。

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
    console.log(catalog.getDesktopImageSRC());

出力：

    adbcc271475211002ee987e8dee49001.iix

## CatalogJS - getGr() {#ariaid-title12}

現在のカタログの GlideRecord を返します。
{#CJS-getGr__table_vdd_rqz_sbb__entry__3}

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

{#CJS-getGr__table_vdd_rqz_sbb} {#CJS-getGr__table_wdd_rqz_sbb__entry__2}

| タイプ | 説明 |
|-|-|
| GlideRecord | 現在のカタログの GlideRecord。 |
[表 : 20. 返される内容]

{#CJS-getGr__table_wdd_rqz_sbb}  
この例では、指定されたカタログの GlideRecord を返します。

    var catalog = new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
    data.history = catalog.getGr();

## CatalogJS - getHeaderIconSRC() {#ariaid-title13}

現在のカタログのヘッダーアイコンを返します。
{#CJS-getHeaderIconSRC__table_xsg_5rz_sbb__entry__3}

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

{#CJS-getHeaderIconSRC__table_xsg_5rz_sbb} {#CJS-getHeaderIconSRC__table_ysg_5rz_sbb__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | カタログヘッダーアイコン。 |
[表 : 22. 返される内容]

{#CJS-getHeaderIconSRC__table_ysg_5rz_sbb}  
この例では、カタログヘッダーアイコンの名前を取得する方法を示しています。

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
    gs.info(catalog.getHeaderIconSRC());

出力：

    service_catalog_header.png

## CatalogJS - getID() {#ariaid-title14}

現在のカタログのsys_idを返します。
{#CJS-getID__table_xqx_xpz_sbb__entry__3}

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

{#CJS-getID__table_xqx_xpz_sbb} {#CJS-getID__table_yqx_xpz_sbb__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | 現在のカタログのSys_id。 |
[表 : 24. 返される内容]

{#CJS-getID__table_yqx_xpz_sbb}  
この例では、現在のカタログのsys_idを返します。

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
    console.log(catalog.getId());

出力：

    e0d08b13c3330100c8b837659bba8fb4

## CatalogJS - getTitle() {#ariaid-title15}

現在のカタログのタイトルを返します。
{#CJS-getTitle__table_fxp_mxz_sbb__entry__3}

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

{#CJS-getTitle__table_fxp_mxz_sbb} {#CJS-getTitle__table_gxp_mxz_sbb__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | 現在のカタログのタイトル。 |
[表 : 26. 返される内容]

{#CJS-getTitle__table_gxp_mxz_sbb}  
この例では、現在のカタログのタイトルを返します。

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
    gs.info(catalog.getTitle());

出力：

    Service Catalog

## CatalogJS - hasCategories() {#ariaid-title16}

現在のカタログにカテゴリがあるかどうかを指定します。
{#CJS-hasCategories__table_kwh_lsz_sbb__entry__3}

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

{#CJS-hasCategories__table_kwh_lsz_sbb} {#CJS-hasCategories__table_lwh_lsz_sbb__entry__2}

| タイプ | 説明 |
|-|-|
| ブーリアン | 現在のカタログにカテゴリがあるかどうかを示すフラグ。 有効な値： * true:カタログにはカテゴリがあります。 * false:カタログにカテゴリがありません。 {#CJS-hasCategories__ul_l1q_qn4_kpb} |
[表 : 28. 返される内容]

{#CJS-hasCategories__table_lwh_lsz_sbb}  
この例は、現在のカタログにカテゴリが含まれているかどうかを判断する方法を示しています。

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
    gs.info(catalog.hasCategories());

出力：

    false

## CatalogJS - hasItems() {#ariaid-title17}

現在のカタログにカタログアイテムがあるかどうかを指定します。
{#CJS-hasItems__table_abg_5wz_sbb__entry__3}

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

{#CJS-hasItems__table_abg_5wz_sbb} {#CJS-hasItems__table_bbg_5wz_sbb__entry__2}

| タイプ | 説明 |
|-|-|
| ブーリアン | 現在のカタログにカタログアイテムがあるかどうかを示すフラグ。 有効な値： * true:カタログにカタログアイテムがあります。 * false:カタログにカタログアイテムがありません。 {#CJS-hasItems__ul_l1q_qn4_kpb} |
[表 : 30. 返される内容]

{#CJS-hasItems__table_bbg_5wz_sbb}  
例：

    var catalog=new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
    gs.info(catalog.hasItems());

出力：

    true

## CatalogJS - isWishlistEnabled() {#ariaid-title18}

現在のカタログでウィッシュリストが有効かどうかを指定します。
{#CJS-isWishlistEnabled__table_emb_xk2_sbb__entry__3}

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

{#CJS-isWishlistEnabled__table_emb_xk2_sbb} {#CJS-isWishlistEnabled__table_fmb_xk2_sbb__entry__2}

| タイプ | 説明 |
|-|-|
| ブーリアン | 現在のカタログがウィッシュリストをサポートしているかどうかを示すフラグ。 有効な値： * true:カタログはウィッシュリストをサポートします。 * false:カタログはウィッシュリストをサポートしていません。 {#CJS-isWishlistEnabled__ul_l1q_qn4_kpb} |
[表 : 32. 返される内容]

{#CJS-isWishlistEnabled__table_fmb_xk2_sbb}  
この例では、現在のカタログでウィッシュリストが有効になっているかどうかを確認する方法を示します。

    var catalog = new sn_sc.Catalog("e0d08b13c3330100c8b837659bba8fb4");
    gs.info(catalog.isWishlistEnabled());

出力：

    true