デバイスへのアクセスの確認
Before being able to grant access to consume your content, you must first ensure they have the relevant Entitlements that can be gained from a subscription purchase flow. You have the ability to also restrict customers to a set number of devices that they are able to consume content on.
概要
APIメソッドの UserEntitlementCheckByDevice は、顧客が閲覧のリクエストをした特定のコンテンツにアクセスできるかどうか、又アクセスできる期間や多くのデバイスによるコンテンツ表示のアクセス権限を判断するために使用されます。
情報この方法は、メータリング及びエンタイトルメントのモジュールでは使用されません。
リクエスト
using (var client = new eDeveloperClient())
{
var request = new UserEntitlementCheckByDeviceRequest
{
clientId = 999,
apiPassword = "password123",
clientUserId = "123456",
entitlementIdentity = "eSuite.DigitalEdition",
deviceID = "iPad",
incrementUsageCount = true
};
var result = client.UserEntitlementCheckByDevice(request);
}
[/csharp]
リクエストパラメータ
次の表は、UserEntitlementCheckByDeviceに渡す必要がある引数や各設定の目的と効果を示しています。更に必須の引数も表示しています。
| 名称 | データータイプ | 説明 | 必須か？ | 値の例 |
|---|---|---|---|---|
| clientID | 整数 | eSuiteとのインテグレーションを識別するためにMPP Globalによって提供された一意の識別子 | Yes | 433 |
| password | 文字列 | MPPから発行された固有のパスワード。 | Yes | sN?67oS=cE |
| clientUserId | 文字列 | サードパーティのIDMソリューションとして使用される識別子 | Yes* | sN?67oS=cE |
| guid | 文字列 | 認証でのコールから得られたセッションID | Yes* | sN?67oS=cE |
| entitlementIdentity | 文字列 | 顧客が閲覧をリクエストしているコンテンツへ識別する一意の文字列 | Yes | sN?67oS=cE |
| deviceId | 文字列 | このオプションのパラメータは、顧客がコンテンツを表示しようとしているデバイスを示します。 | No | iPad |
| incrementCount | bool | このオプションのパラメーターは、エンタイトルメントのカウントを使用するときに、エンタイトルメントに対してリクエストのカウントするかどうかを決定します。 | No | true |
* clientUserIdまたはguidのどちらか一方のみが必要です。
戻り値
UserEntitlementCheckByDeviceのコールではUserEntitlementCheckByDeviceResultのオブジェクトを返します。要素の詳細については以下の表にございます。 eSuiteプラットフォームから他のレスポンスと同様に、UserEntitlementCheckByDeviceResultにErrorNumber値が含まれています。プラットフォームへの呼び出しが成功した場合、0が含まれ、関連性も表示されます。
| 名称 | データータイプ | 説明 | 値の例 |
|---|---|---|---|
| ErrorMessage | 文字列 | APIコールの結果としてプラットフォーム内で発生したエラーのエラーメッセージ。エラーが発生しなかった場合、これはNULLになります。 | "Invalid Web service credentials" |
| ErrorNumber | 整数 | この表に記載されている値からの一意のエラー番号 | 1005 |
| EntitlementConcurrencyLimitReached | Boolean | さまざまなデバイスで制限に達したかどうかを示します | true |
| TimeRemaining | 整数 | この値は、顧客がこのエンタイトルメントを保持している残りの秒数を示します。 | 3600 |
| HasEntitlement | Boolean | 顧客がアクセス権を持っているかどうかについて、eSuiteにより判断される | true |