（レガシー） JavaScript SDK API リファレンス javascript-sdk-api-reference

Last update: Fri Apr 10 2026 00:00:00 GMT+0000 (Coordinated Universal Time)

トピック：
認証

NOTE

IMPORTANT

製品のお知らせページに集計されている最新のAdobe Pass認証製品のお知らせと廃止予定について、常に情報を得てください。

API リファレンス api-reference

これらの関数は、MVPDとのインタラクションのリクエストを開始します。すべての呼び出しは非同期です。応答を処理するには、コールバックを実装する必要があります。

setRequestor （）
getAuthorization （）
getAuthentication （）
checkAuthentication （）
checkAuthorization （）
checkPreauthorizedResources （）
getMetadata （）
setSelectedProvider （）
logout （）

setRequestor （inRequestorID、エンドポイント、オプション） setrequestor(inRequestorID,endpoints,options)

説明：要求の元となるサイトを特定します。通信セッションでは、他のAPI呼び出しの前にこの呼び出しを行う必要があります。

パラメーター：

inRequestorID – 登録時にAdobeが元のサイトに割り当てた一意のID。
エンドポイント – このパラメーターはオプションです。次のいずれかの値を指定できます。
- Adobeが提供する認証サービスと認証サービスのエンドポイントを指定できる配列（デバッグ目的で様々なインスタンスを使用する場合があります）。複数のURLが指定されている場合、MVPD リストは、すべてのサービスプロバイダーのエンドポイントで構成されます。各MVPDは、最速のサービスプロバイダー、つまり最初に応答し、そのMVPDをサポートするプロバイダーに関連付けられます。デフォルトでは（値が指定されていない場合）、Adobe サービスプロバイダーが使用されます（http://sp.auth.adobe.com/）。
例：
- setRequestor("IFC", ["http://sp.auth-dev.adobe.com/adobe-services"])
options - Application ID値、Visitor ID値、refresh-less settings （background login logout）およびMVPD settings （iFrame）を含むJSON オブジェクト。値はすべてオプションです。
1. 指定した場合、Experience Cloud visitorIDは、ライブラリによって実行されたすべてのネットワーク呼び出しに対してレポートされます。この値は、後で高度な分析レポートに使用できます。
2. アプリケーションの一意の識別子が指定されている場合 – applicationId – 値は、X-Device-Info HTTP ヘッダーの一部としてアプリケーションによって行われたその後のすべての呼び出しに追加されます。この値は、後で適切なクエリを使用してESM レポートから取得できます。
メモ：すべてのJSON キーでは、大文字と小文字が区別されます。

例：

   setRequestor("IFC", {
      "visitorID": "THE_ECID_VALUE",
      "applicationId": "APP_ID_VALUE"
  })

プログラマーは、ログインにiFrameが必要かどうか（iFrameRequired キー）、iFrame ディメンション（iFrameWidthおよびiFrameHeight キー）を指定することで、Adobe Pass Authenticationで設定されているMVPD設定を上書きできます。 JSON オブジェクトには、次のテンプレートがあります。

    {
       "visitorID": <string>,
       "backgroundLogin": <boolean>,
       "backgroundLogout": <boolean>,
       "mvpdConfig":{
          "MVPD_ID_1":{
             "iFrameRequired": <boolean>,
             "iFrameWidth": <integer>,
             "iFrameHeight": <integer>
          },
          ...
          "MVPD_ID_N":{
             "iFrameRequired": <boolean>,
             "iFrameWidth": <integer>,
             "iFrameHeight": <integer>
          }
       }
    }

上記のテンプレートのすべての最上位キーはオプションで、デフォルト値（backgroundLogin、backgroundLogutはデフォルトでfalse、mvpdConfigはnullです。つまり、MVPDの設定は上書きされません）を持ちます。

注意：上記のパラメーターに無効な値や型を指定すると、動作が未定義になります。

次のシナリオの設定例を示します。更新なしのログインとログアウトを有効にし、MVPD1をフルページリダイレクトログイン（iFrame以外）に、MVPD2をwidth=500、height=300のiFrame ログインに変更します。

    {
       "backgroundLogin": true,
       "backgroundLogout": true,
       "mvpdConfig":{
          "MVPD1":{
             "iFrameRequired": false
          },
          "MVPD2":{
             "iFrameRequired": true,
             "iFrameWidth": 500,
             "iFrameHeight": 300
          }
       }
    }

コールバックがトリガーされました： setConfig （）

（レガシー） JavaScript SDK API リファレンス javascript-sdk-api-reference

API リファレンス api-reference

setRequestor （inRequestorID、エンドポイント、オプション） setrequestor(inRequestorID,endpoints,options)

getAuthorization （inResourceID, redirect_url） getauthorization(inresourceid,redirect_url)

getAuthentication （redirect_url） getauthentication(redirect_url

checkAuthN checkauthn

checkAuthorization （inResourceID） checkauthorization(inresourceid)

checkPreauthorizedResources （リソース） checkPreauthorizedResources(resources)

checkPreauthorizedResources （resources-cache=true） checkPreauthorizedResources(resources-cache=true)

getMetadata （Key） getMetadata

setSelectedProvider （providerid） setSelectedProvider

getSelectedProvider （） getSelectedProvider

ログアウト logout

コールバック定義 calllback-definitions

entitlementLoaded （） entitlementLoaded

setConfig （configXML） setconfig(configXML)

displayProviderDialog （プロバイダ） displayproviderdialog(providers)

createIFrame （inWidth, inHeight） createIFrame(inWidth,inHeight)

setAuthenticationStatus （isAuthenticated, errorCode） set-authn-status-isauthn-error

sendTrackingData （trackingEventType, trackingData） sendTrackingData(trackingEventType,trackingData)

setToken （inRequestedResourceID, inToken） setToken(inRequestedResourceID,inToken)

tokenRequestFailed （inRequestedResourceID, inRequestErrorCode, inRequestDetailedErrorMessage） token-request-failed-error-msg

preauthorizedResources （authorizedResources） preauthorizedResources(authorizedResources)

setMetadataStatus （key, encrypted, data） setMetadataStatus(key,encrypted,data)

selectedProvider （result） selectedProvider(result)

コールバックエラーコード callback-error-codes