(レガシー)クライアント情報(デバイス、接続、アプリケーション)の受け渡し pass-client-info
対象範囲 pass-client-info-scope
このドキュメントでは、クライアント情報(デバイス、接続、アプリケーション)をプログラマーアプリケーションからAdobe Pass認証の REST API または SDK に渡すための詳細とクックブックを集約します。
クライアント情報を提供する利点は次のとおりです。
- 一部のデバイス・タイプや HBA をサポートする MVPD の場合に、HBA (Home Base Authentication)を適切に有効化する機能。
- 一部のデバイスタイプの場合に TTL を適切に適用する機能(例えば、テレビに接続されたデバイスの認証セッション用に長い TTL を設定するなど)。
- ESM (Entitlement Service Monitoring)を使用して、複数のデバイスタイプにわたる分類レポートでビジネス指標を適切に集計する機能。
- 様々なビジネスルールを適切に適用する機能のブロックを解除します(例: (特定のデバイスタイプで低下)。
概要 pass-client-info-overview
クライアント情報は、以下で構成されます。
- デバイス ユーザーがプログラマーのコンテンツを使用しようとしているデバイスのハードウェア属性とソフトウェア属性に関する情報。
- 接続 ユーザーがAdobe Pass Authentication Services やプログラマーサービスに接続する元となるデバイスの接続属性に関する情報(サーバー間実装など)。
- アプリケーション ユーザーがプログラマーコンテンツを使用しようとする登録済みアプリケーションに関する情報。
クライアント情報は、次の表に示すキーで作成された JSON オブジェクトです。
primaryHardwareType
、osName
、osFamily
、browserName
、browserVendor
、connectionSecure
。API リファレンス api-ref
この節では、Adobe Pass認証 REST API または SDK を使用する際にクライアント情報を処理する API について説明します。
REST API rest-api
Adobe Pass認証サービスは、次の方法でクライアント情報の受け取りをサポートしています。
- ヘッダー:「X-Device-Info」 として
- クエリパラメーター:"device_info"として
- post パラメーターとして:"device_info"
SDK
JavaScriptSDK js-sdk
AccessEnabler JavaScript SDKは、デフォルトでクライアント情報 JSON オブジェクトを構築します。このオブジェクトは、上書きされない限り、Adobe Pass Authentication サービスに渡されます。
AccessEnabler JavaScript SDKでは setRequestor の applicationId オプション パラメータを使用して、クライアント情報 JSON オブジェクトの applicationId キーをサポートします上書きのみ)。
applicationId
パラメーター値は、プレーンテキストの文字列値である必要があります。プログラマーアプリケーションが applicationId を渡すことにした場合、残りのクライアント情報キーは引き続き AccessEnabler JavaScript SDKによって計算されます。
iOS/tvOS SDK ios-tvos-sdk
AccessEnabler iOS/tvOS SDKは、デフォルトでクライアント情報の JSON オブジェクトを作成します。このオブジェクトは、上書きされない限り、Adobe Pass Authentication サービスに渡されます。
AccessEnabler iOS/tvOS SDKでは、setOptions の device_info パラメータを使用して クライアント情報の JSON オブジェクトをオーバーライドできます。
Android/FireOS SDK and-fire-os-sdk
AccessEnabler
Android/FireOS SDKは、デフォルトでクライアント情報 JSON オブジェクトを作成し、上書きされない限り、これをAdobe Pass認証サービスに渡します。
AccessEnabler
Android/FireOS SDKは、setOptions🔗 の/setOptions の device_info
パラメーターを使用して クライアント情報の JSON オブジェクトを上書き サポートしています。
device_info
パラメーター値は、Base64 エンコード 文字列値である必要があります。クックブック cookbooks
この節では、デバイスタイプが異なる場合にクライアント情報 JSON オブジェクトを作成するためのクックブックを示します。
Android android
デバイス情報は、次のように構成できます。
接続情報は、次のように作成できます。
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
getSystemService(Context.CONNECTIVITY_SERVICE).getActiveNetworkInfo().getType()
"WIFI","BLUETOOTH","MOBILE","ETHERNET","VPN","DUMMY","MOBILE_DUN","WIMAX","notAccessible"
アプリケーション情報は、次の方法で作成できます。
サンプルコード
private JSONObject computeClientInformation() {
String LOGGING_TAG = "DefineClass.class";
JSONObject clientInformation = new JSONObject();
String connectionType;
try {
ConnectivityManager cm = (ConnectivityManager) getContext().getSystemService(CONNECTIVITY_SERVICE);
NetworkInfo activeNetwork = cm.getActiveNetworkInfo();
if (activeNetwork != null && activeNetwork.isConnectedOrConnecting()) {
switch (activeNetwork.getType()) {
case ConnectivityManager.TYPE_WIFI: {
connectionType = "WIFI";
break;
}
case ConnectivityManager.TYPE_BLUETOOTH: {
connectionType = "BLUETOOTH";
break;
}
case ConnectivityManager.TYPE_MOBILE: {
connectionType = "MOBILE";
break;
}
case ConnectivityManager.TYPE_ETHERNET: {
connectionType = "ETHERNET";
break;
}
case ConnectivityManager.TYPE_VPN: {
connectionType = "VPN";
break;
}
case ConnectivityManager.TYPE_DUMMY: {
connectionType = "DUMMY";
break;
}
case ConnectivityManager.TYPE_MOBILE_DUN: {
connectionType = "MOBILE_DUN";
break;
}
case ConnectivityManager.TYPE_WIMAX: {
connectionType = "WIMAX";
break;
}
default:
connectionType = ConnectivityManager.EXTRA_OTHER_NETWORK_INFO;
}
} else {
connectionType = ConnectivityManager.EXTRA_NO_CONNECTIVITY;
}
} catch (Exception e) {
connectionType = "notAccessible";
}
try {
clientInformation.put("model",Build.MODEL);
clientInformation.put("vendor", Build.BRAND);
clientInformation.put("manufacturer",Build.MANUFACTURER);
clientInformation.put("version",Build.DEVICE);
clientInformation.put("osName","Android");
clientInformation.put("osVersion",Build.VERSION.RELEASE);
clientInformation.put("connectionType",connectionType);
clientInformation.put("applicationId","CNN");
} catch (JSONException e) {
Log.e(LOGGING_TAG, e.getMessage());
}
return Base64.encodeToString(clientInformation.toString().getBytes(), Base64.NO_WRAP);
}
FireTV fire-tv
デバイス情報は、次のように構成できます。
接続情報は、次のように作成できます。
アプリケーション情報は、次の方法で作成できます。
iOS/tvOS ios-tvos
デバイス情報は、次のように構成できます。
接続情報は、次のように作成できます。
アプリケーション情報は、次の方法で作成できます。
サンプルコード
+ (NSString *)computeClientInformation {
struct utsname u;
uname(&u);
NSString *hardware = [NSString stringWithCString:u.machine encoding:NSUTF8StringEncoding];
UIDevice *device = [UIDevice currentDevice];
NSString *deviceType;
switch (UI_USER_INTERFACE_IDIOM()) {
case UIUserInterfaceIdiomPhone:
deviceType = @"MobilePhone";
break;
case UIUserInterfaceIdiomPad:
deviceType = @"Tablet";
break;
case UIUserInterfaceIdiomTV:
deviceType = @"TV";
break;
default:
deviceType = @"Unknown";
}
CGRect screenRect = [[UIScreen mainScreen] bounds];
NSNumber *screenWidth = @((float) screenRect.size.width);
NSNumber *screenHeight = @((float) screenRect.size.height);
Reachability *reachability = [Reachability reachabilityForInternetConnection];
[reachability startNotifier];
NetworkStatus status = [reachability currentReachabilityStatus];
NSString *connectionType;
if (status == NotReachable) {
connectionType = @"notConnected";
} else if (status == ReachableViaWiFi) {
connectionType = @"WiFi";
} else if (status == ReachableViaWWAN) {
connectionType = @"cellular";
}
NSMutableDictionary *clientInformation = [@{
@"type": deviceType,
@"model": device.model,
@"vendor": @"Apple",
@"manufacturer": @"Apple",
@"version": [hardware stringByReplacingOccurrencesOfString:device.model withString:@""],
@"osName": device.systemName,
@"osVersion": device.systemVersion,
@"displayWidth": screenWidth,
@"displayHeight": screenHeight,
@"connectionType": connectionType,
@"applicationId": @"CNN"
} mutableCopy];
NSError *error;
NSData *jsonData = [NSJSONSerialization dataWithJSONObject:clientInformation options:NSJSONWritingPrettyPrinted error:&error];
NSString *base64Encoded = [jsonData base64EncodedStringWithOptions:0];
return base64Encoded;
}
Roku roku
デバイス情報は、次のように構成できます。
接続情報は、次のように作成できます。
アプリケーション情報は、次の方法で作成できます。
XBOX 1/360 xbox
デバイス情報は、次のように構成できます。
接続情報は、次のように作成できます。
アプリケーション情報は、次の方法で作成できます。
リソース