（従来の）JavaScript SDK API リファレンス javascript-sdk-api-reference

Last update: Sat Dec 14 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

トピック：
認証

NOTE

このページのコンテンツは情報提供のみを目的としています。この API を使用するには、Adobeから現在のライセンスが必要です。無許可の使用は許可されていません。

IMPORTANT

製品のお知らせページに集約された最新のAdobe Pass認証製品のお知らせや廃止予定タイムラインについて、常に情報を提供するようにします。

API リファレンス api-reference

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

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

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

説明： リクエストの発信元のサイトを識別します。通信セッションの他の API 呼び出しより前に、この呼び出しを行う必要があります。

パラメーター：

inRequestorID - Adobeが登録時に元のサイトに割り当てた一意の ID。
endpoints – このパラメーターはオプションです。次のいずれかの値を指定できます。
- Adobeが提供する認証および承認サービスのエンドポイントを指定できる配列（デバッグ目的で別のインスタンスが使用される場合があります）。複数の URL が指定されている場合、MVPDリストはすべてのサービスプロバイダーのエンドポイントで構成されます。各MVPDは、最速のサービスプロバイダー（最初に応答し、そのMVPDをサポートするプロバイダー）に関連付けられます。デフォルトでは（値を指定しない場合）、Adobe サービスプロバイダーが使用されます（http://sp.auth.adobe.com/）。
例：
- setRequestor("IFC", ["http://sp.auth-dev.adobe.com/adobe-services"])
options - アプリケーション ID 値、訪問者 ID 値の更新なしの設定（バックグラウンドログインログアウト）およびMVPD設定（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 を幅=500、高さ=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 （resources） 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 （providers） 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