SPSEOUtilsSNC :グローバル

SPSEOUtilsSNC スクリプトインクルードは、トランザクション要求に基づいて、特定のページまたは現在のページの人間が判読できる URL を返すユーティリティメソッドを提供します。

さらに、この API は、人間が判読できる他の URL メソッドを呼び出すために必要な情報を取得するために使用できる他のユーティリティメソッドを提供します。

SPSEOUtilsSNC - getHumanReadableUrl(GlideRecord pageGR, String queryString)

ページ [sp_page ] テーブル内の指定されたレコードの人間が判読可能な URL を返します。渡されたクエリパラメーターを使用して、URL に必要な動的ページ変数を解決します。

表 : 1. パラメーター

名前	タイプ	説明
ページ GR	GlideRecord	人間が判読できる URL を返す、ページ [sp_page] テーブル内のレコードの GlideRecord オブジェクト。 SPSEOUtilsSNC - getPageRecordWithPageRoute(GlideRecord pageId, String portalId, Boolean preventReRoute)メソッドを使用して、目的の sp_page GlideRecord を取得します。
queryString	文字列	URL で渡す必要があるパラメーターを解決するために使用するクエリ文字列。 例: ?id=kb_article&sys_id=471ee81eff6002009b20ffffffffff34

表 : 2. 戻り値

タイプ	説明
文字列	指定された サービスポータル レコードに対する分かりやすい URL。URL 変数は、渡された queryString パラメーターの内容を使用して解決されます。

次のコード例は、このメソッドを呼び出して人間が判読できる URL を取得する方法を示しています。

function() { 
  var util = new global.SPSEOUtilsSNC();
  var portalId = util.getPortalId();
  var pageGR = util.getPageRecordWithPageRoute(
    'kb_article', portalId, false); 
  var queryString = "?id=kb_article&sys_id=471ee81eff6002009b20ffffffffff34"; 
  var hrUrl = util.getHumanReadableUrl(pageGR, queryString);

出力:

"getting-around-in-windows"

SPSEOUtilsSNC - getHumanReadableUrlForCurrentRequest()

現在の サービスポータル レコードの人間が判読可能な URL を返します。

このメソッドは、この人間が判読できる URL を作成するときに、 id パラメーターやクエリパラメーターなど、現在のページの暗号 URL のパラメーターを複製します。

表 : 3. パラメーター

名前	タイプ	説明
なし

表 : 4. 返される内容

タイプ	説明
文字列	現在の サービスポータル レコードに対する、分かりやすい URL。

次のコード例は、このメソッドを呼び出す方法を示しています。この例では、現在の サービスポータル レコードは、 <instance-url>/sp?id=kb_article&sys_id=471ee81eff6002009b20ffffffff34 の暗号 URL を使用し、Windows でのナビゲーションについて説明した KB 記事の簡単な説明を表示するように構成されています。この不可解な URL に対して返される人間が判読できる URL は "getting-around-in-windows" です。

// In a script include
function() {
  var util = new global.SPSEOUtilsSNC()
  var hrUrl = util.getHumanReadableUrlForCurrentRequest();
}

出力:

getting-around-in-windows

SPSEOUtilsSNC - getPageRecordWithPageRoute(GlideRecord pageId, String portalId, Boolean preventReRoute)

渡された ID パラメーター (pageId) と ID フィールドが一致するページ [sp_page] テーブルの GlideRecord を返します。getHumanReadableUrl() メソッドを呼び出す前にこのメソッドを呼び出して、目的の sp_pages GlideRecord を取得します。

また、渡されたサービスポータルページ ID に関連付けられた最終サービスポータルページの GlideRecord を返すために、メソッドがページルートマップ情報を使用するように要求することもできます。ページ ルート マップの詳細については、「 参照をページ ID にリダイレクトする」を参照してください。

表 : 5. パラメーター

名前	タイプ	説明
pageId	文字列	返すページ [sp_page] レコードの ID。 テーブル:ページ [sp_page] テーブルの id フィールド。
ポータル ID	文字列	関連するサービスポータル [sp_portal] レコードのSys_id。渡された pageId パラメーターに関連付けられたレコードにアクセスできないか利用できない場合に、適切なログインまたは 404 ページを返すために必要です。 SPSEOUtilsSNC - getPortalId()メソッドを使用して、目的の サービスポータル ID を取得します。
再ルーティングを防止	ブール	ページルートマップを使用して、一致するsp_pageレコードではなく、渡されたページ ID が解決される最後のsp_pageの GlideRecord を返すかどうかを示すフラグ。 可能な値： true:ページルートマップを使用して、渡されたページ ID が解決される最後のsp_pageレコードを返します。 false:渡されたページ ID が一致するsp_pageレコードを返します。

表 : 6. 戻り値

タイプ	説明
GlideRecord	sp_pageレコードのクエリ要求に一致するレコード。

次のコード例は、 getHumanReadableUrl() メソッドを呼び出す前にこのメソッドを呼び出す方法を示しています。

function() { 
  var util = new global.SPSEOUtilsSNC();
  var portalId = util.getPortalId();
  var pageGR = util.getPageRecordWithPageRoute(
    'kb_article', portalId, false); 
  var queryString = "?id=kb_article&sys_id=471ee81eff6002009b20ffffffffff34"; 
  var hrUrl = util.getHumanReadableUrl(pageGR, queryString);

SPSEOUtilsSNC - getPortalId()

要求 URL のポータルサフィックスに基づいて、ロードされるポータルのsys_idを返します。getPageRecordWithPageRoute() メソッドを呼び出す前に、このメソッドを呼び出して目的のサービスポータル sys_idを取得します。

表 : 7. パラメーター

名前	タイプ	説明
なし

表 : 8. 返される内容

タイプ	説明
文字列	要求 URL のポータルサフィックスに基づく要求された サービスポータル のSys_id。

次のコード例は、 <instance-url>/sp?id=index などの URL に対してこのメソッドを呼び出す方法を示しています。

function() { 
  var util = new global.SPSEOUtilsSNC();
  var portalId = util.getPortalId();
  var pageGR = util.getPageRecordWithPageRoute(
    'kb_article', portalId, false); 
  var queryString = "?id=kb_article&sys_id=471ee81eff6002009b20ffffffffff34"; 
  var hrUrl = util.getHumanReadableUrl(pageGR, queryString);

出力:

81b75d3147032100ba13a5554ee4902b