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


---

# CSBScratchpadUtil - スコープ指定

# CSBScratchpadUtil - スコープ指定 {#ariaid-title1}

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

CSBScratchpadUtil API を使用すると、コンシューマーは、他の サービスエクスチェンジ サービスの外部にある「追加」情報をプロバイダーと共有できます。

この情報は、スクラッチパッド \[sn_sb_scratchpad\] テーブルに名前と値のペアとして格納されます。共有情報は、プロバイダータスクまたはリモートタスクの 2 つのタイプのいずれかのタスクに関連付けられている必要があります。

関連するタスクがアクティブな場合、更新されたスクラッチパッド情報がコンシューマーインスタンスに同期されます。タスクが非アクティブ化または削除された場合、スクラッチパッド内の情報も指定された日数後に削除されます。デフォルトでは 3 つ。このデフォルトは、sn_sb.scratchpad.autodelete.days プロパティで定義されています。

プロバイダーとコンシューマーの両方が、スクラッチパッドテーブルに対して情報を追加、更新、および削除できます。プロデューサーは、 [PSBScratchpadUtil - スコープ指定](https://servicenow-prod.fluidtopics.net/sXcY_5Hm09IIA~3~GoX~lQ#PSBScratchpadUtilScopedAPI "PSBScratchpadUtil API は、プロバイダーが他の サービスエクスチェンジ サービスの外部にある「追加」情報をコンシューマーと共有できるようにするメソッドを提供します。") API を使用してこの情報を更新します。

この API にアクセスするには、コンシューマー向け サービスエクスチェンジ アプリケーションをインストールする必要があります。この API は `sn_sb_con` 名前空間で実行されます。

## CSBScratchpadUtil - get(GlideRecord taskGR, 文字列名) {#ariaid-title2}

指定されたスクラッチパッドプロパティの値を返します。
{#CSBScrUtil-get_GR_S__table_sm3_fpg_czb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| taskGR | GlideRecord | 指定されたスクラッチパッドプロパティに関連付けられたアクティブなリモートタスクまたはプロバイダータスクの GlideRecord。 テーブル:リモートタスク \[sn_sb_con_remote_task\] およびプロバイダータスク \[sn_sb_con_provider_task\]。 |
| name | 文字列 | 値を取得するスクラッチパッドプロパティの名前。 テーブル:スクラッチパッド \[sn_sb_scratchpad\] |
[表 : 1. パラメーター]

{#CSBScrUtil-get_GR_S__table_sm3_fpg_czb} {#CSBScrUtil-get_GR_S__table_tm3_fpg_czb__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列または null | 要求されたスクラッチパッドプロパティの値。プロパティが見つからない場合は null。 |
[表 : 2. 返される内容]

{#CSBScrUtil-get_GR_S__table_tm3_fpg_czb}  
次のコード例は、このメソッドを呼び出す方法を示しています。

    var rtGR = new GlideRecord("sn_sb_con_remote_task");
    rtGR.setLimit(1); 
    rtGR.query();  
    rtGR.next() 
    if (rtGR.isValidRecord()) { 
      var util = new sn_sb_con.CSBScratchpadUtil();
      util.update(rtGR, "name1", "value1"); 
      gs.info(util.get(rtGR, "name1"));
    }

出力：

    "value1"

## CSBScratchpadUtil - getAll(GlideRecord taskGR) {#ariaid-title3}

指定されたタスクに関連付けられているすべてのスクラッチパッドプロパティのプロパティ名と値 (名前と値のペア) を返します。
{#CSBScrUtil-getAll_GR__table_ism_vpg_czb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| taskGR | GlideRecord | 関連するスクラッチパッドプロパティを返すアクティブなリモートタスクまたはプロバイダータスクの GlideRecord。 テーブル:リモートタスク \[sn_sb_con_remote_task\] テーブルとプロバイダータスク \[sn_sb_con_provider_task\] テーブル。 |
[表 : 3. パラメーター]

{#CSBScrUtil-getAll_GR__table_ism_vpg_czb} {#CSBScrUtil-getAll_GR__table_jsm_vpg_czb__entry__2}

| タイプ | 説明 |
|-|-|
| オブジェクト | 指定されたタスクに含まれるすべてのプロパティ名と値。 例： `{ name1: value1, name2: value2, ... }` |
[表 : 4. 返される内容]

{#CSBScrUtil-getAll_GR__table_jsm_vpg_czb}  
次のコード例は、このメソッドを呼び出す方法を示しています。

    var rtGR = new GlideRecord("sn_sb_con_remote_task");
    rtGR.setLimit(1);
    rtGR.query();  
    rtGR.next() 
    if (rtGR.isValidRecord()) {  
      var util = new sn_sb_con.CSBScratchpadUtil();
      util.update(rtGR, "name1", "value1"); 
      gs.info(JSON.stringify(util.getAll(rtGR))); 
    }

出力：

    { "name1": "value1" }

## CSBScratchpadUtil - getNames(GlideRecord taskGR) {#ariaid-title4}

指定されたタスクレコードに関連付けられているすべてのスクラッチパッドプロパティの名前のリストを返します。
{#CSBScrUtil-getNames_GR__table_r5k_dqg_czb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| taskGR | GlideRecord | 関連付けられているすべてのスクラッチパッドプロパティの名前のリストを返すアクティブなリモートタスクまたはプロバイダータスクの GlideRecord。 テーブル:リモートタスク \[sn_sb_con_remote_task\] とプロバイダータスク \[sn_sb_con_provider_task\] |
[表 : 5. パラメーター]

{#CSBScrUtil-getNames_GR__table_r5k_dqg_czb} {#CSBScrUtil-getNames_GR__table_s5k_dqg_czb__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列アレイ | 指定されたタスクレコードに関連付けられているスクラッチパッドプロパティの名前のリスト。 |
[表 : 6. 返される内容]

{#CSBScrUtil-getNames_GR__table_s5k_dqg_czb}  
次のコード例は、このメソッドを呼び出す方法を示しています。

    var rtGR = new GlideRecord("sn_sb_con_remote_task");
    rtGR.setLimit(1); 
    rtGR.query();  
    rtGR.next() 
    if (rtGR.isValidRecord()) {
      var util = new sn_sb_con.CSBScratchpadUtil();
      util.update(rtGR, "name1", "value1"); 
      gs.info(JSON.stringify(util.getNames(rtGR))); 
    }

出力：

    [ "name1" ]

## CSBScratchpadUtil - populateClientScratchpadBR(GlideRecord taskGR) {#ariaid-title5}

指定されたリモートタスクまたはプロバイダータスクに関連付けられたスクラッチパッドプロパティをクライアントg_scratchpadに配置します。
このメソッドは、UI 表示ビジネスルールから呼び出すことができます。
{#CSBScrUtil-popClientScratch_GR__table_ikg_qdb_fzb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| taskGR | GlideRecord | 関連するスクラッチパッドエントリをクライアントg_scratchpadに配置する必要があるアクティブなリモートタスクまたはプロバイダータスクの GlideRecord。 テーブル:リモートタスク \[sn_sb_con_remote_task\] およびプロバイダータスク \[sn_sb_con_provider_task\] |
[表 : 7. パラメーター]

{#CSBScrUtil-popClientScratch_GR__table_ikg_qdb_fzb} {#CSBScrUtil-popClientScratch_GR__table_jkg_qdb_fzb__entry__2}

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

{#CSBScrUtil-popClientScratch_GR__table_jkg_qdb_fzb}  
次のコード例は、このメソッドを呼び出す方法を示しています。

    new sn_sb_con.CSBScratchpadUtil().populateClientScratchpadBR(current);

## CSBScratchpadUtil - remove(GlideRecord taskGR, 文字列名) {#ariaid-title6}

指定されたスクラッチパッドプロパティをスクラッチパッド \[sn_sb_scratchpad\] テーブルから削除します。
注:  
削除は他の ServiceNow インスタンスに同期されません。スクラッチパッドのプロパティは、関連するタスクレコードが非アクティブ化または削除されてから、指定された日数が経過すると自動的に削除されます。
{#CSBScrUtil-remove_GR_S__table_x3b_nqg_czb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| taskGR | GlideRecord | 指定されたスクラッチパッドプロパティに関連付けられたアクティブなリモートタスクまたはプロバイダータスクの GlideRecord。 テーブル:リモートタスク \[sn_sb_con_remote_task\] およびプロバイダータスク \[sn_sb_con_provider_task\]。 |
| name | 文字列 | スクラッチパッド \[sn_sb_scratchpad\] テーブルから削除するスクラッチパッドプロパティの名前。 |
[表 : 9. パラメーター]

{#CSBScrUtil-remove_GR_S__table_x3b_nqg_czb} {#CSBScrUtil-remove_GR_S__table_y3b_nqg_czb__entry__2}

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

{#CSBScrUtil-remove_GR_S__table_y3b_nqg_czb}  
次のコード例は、このメソッドを呼び出す方法を示しています。

    var rtGR = new GlideRecord("sn_sb_con_remote_task");
    rtGR.setLimit(1); 
    rtGR.query();  
    rtGR.next() 
    if (rtGR.isValidRecord()) {
      var util = new sn_sb_con.CSBScratchpadUtil();
      util.update(rtGR, "name1", "value1"); 
      util.remove(rtGR, "name1");
      gs.info(util.get(rtGR, "name1")); 
    }

出力：

    undefined

## CSBScratchpadUtil - update(GlideRecord taskGR, 文字列名, 文字列値, ブール client_side_accessible) {#ariaid-title7}

スクラッチパッド \[sn_sb_scratchpad\] テーブルにプロパティを挿入するか、プロパティの値を更新します。
注:  
1 回の呼び出しで更新できるプロパティの最大数は 50 です。
{#CSBScrUtil-update_GR_S_S_B__table_z4p_4kg_czb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| taskGR | GlideRecord | 指定されたスクラッチパッドプロパティに関連付けられたアクティブなリモートタスクまたはプロバイダータスクの GlideRecord。 テーブル:リモートタスク \[sn_sb_con_remote_task\] およびプロバイダータスク \[sn_sb_con_provider_task\] |
| name | 文字列 | 新規または既存のスクラッチパッドプロパティの名前。この名前は、すべてのスクラッチパッドプロパティで一意である必要があります。 |
| value | 文字列 | スクラッチパッドプロパティの値。 最大:4,000 文字。 |
| client_side_accessible | ブール | オプション。表示ビジネスルールから populateClientScratchpadBR が呼び出されたときに、このプロパティをクライアント側g_scratchpadで使用できるかどうかを示すフラグ。 有効な値： * true:プロパティが利用可能です。 * false:プロパティは利用できません。 デフォルト値：false |
[表 : 11. パラメーター]

{#CSBScrUtil-update_GR_S_S_B__table_z4p_4kg_czb} {#CSBScrUtil-update_GR_S_S_B__table_app_4kg_czb__entry__2}

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

{#CSBScrUtil-update_GR_S_S_B__table_app_4kg_czb}  
次のコード例は、このメソッドを呼び出す方法を示しています。

    var rtGR = new GlideRecord("sn_sb_con_remote_task");
    rtGR.setLimit(1); 
    rtGR.query();
    rtGR.next()
    if (rtGR.isValidRecord()) {
      var util = new sn_sb_con.CSBScratchpadUtil();
      util.update(rtGR, "name1", "value2");
      gs.info(util.get(rtGR, "name1")); 
    } 

出力：

    "value2"