傳遞使用者端資訊（裝置、連線和應用程式） pass-client-info
NOTE
此頁面上的內容僅供參考。 使用此API需要Adobe的目前授權。 不允許未經授權的使用。
範圍 pass-client-info-scope
本檔案會彙總詳細資料和逐步指南，以便從程式設計人員應用程式傳遞使用者端資訊（裝置、連線和應用程式）至Adobe Pass驗證REST API或SDK。
提供使用者端資訊的好處包括：
- 在某些裝置型別和可支援HBA的MVPD的情況下，能夠正確啟用Home Base Authentication (HBA)。
- 在部分裝置型別的情況下正確套用TTL的功能（例如，為電視連線裝置上的驗證工作階段設定較長的TTL）。
- 能夠使用軟體權利檔案服務監控(ESM)在各種裝置型別中，正確彙總劃分報表中的商業量度。
- 解除封鎖正確套用各種商業規則的能力(例如 降級)。
概觀 pass-client-info-overview
使用者端資訊包含：
- 裝置 使用者嘗試使用程式設計師內容之裝置的軟硬體屬性資訊。
- 連線 使用者連線至Adobe Pass Authentication Services和/或程式設計師服務（例如伺服器對伺服器實作）之裝置連線屬性的相關資訊。
- 應用程式 使用者嘗試使用程式設計師內容之註冊應用程式的資訊。
使用者端資訊是使用下表呈現的金鑰建置的JSON物件。
NOTE
下列 金鑰 是使用者端資訊JSON物件中要傳送的 必要： 模型，osName。
下列金鑰有 限制的 值：
primaryHardwareType、osName、osFamily、browserName、browserVendor、connectionSecure。索引鍵
受限制
說明
可能的值
primaryHardwaretype
#是
裝置的主要硬體型別。
#值受到限制： 相機 DataCollectionTerminal 案頭 嵌入式網路模組 電子閱讀器 遊戲主控台 GeolocationTracker 眼鏡 MediaPlayer 行動電話 支付終端機 PluginModem SetTopBox TV 平板電腦 WirelessHotspot 手錶 未知
#mandatory
模型
否
裝置的型號名稱。
例如iPhone、SM-G930V、AppleTV等。
版本
否
裝置的版本。
例如2.0.1等。
製造商
否
裝置的製造公司/組織。
例如三星、LG、ZTE、華為、摩托羅拉、Apple等。
廠商
否
裝置的銷售公司/組織。
例如Apple、Samsung、LG、Google等。
#mandatory
osName
#是
裝置的作業系統(OS)名稱。
#值受到限制： Android Chrome作業系統 Linux Mac作業系統 OS X OpenBSD Roku OS Windows iOS tvOS webOS
osFamily
是
裝置的作業系統(OS)群組名稱。
#值受到限制： Android BSD Linux PlayStation作業系統 Roku OS Symbian Tizen Windows iOS macOS tvOS webOS
osVendor
否
裝置的作業系統(OS)供應商。
Amazon Apple Google LG Microsoft Mozilla 任天堂 Nokia Roku Samsung Sony Tizen專案
osVersion
否
裝置的作業系統(OS)版本。
例如10.2、9.0.1等。
browserName
#是
瀏覽器的名稱。
#值受到限制： Android瀏覽器 Chrome Edge Firefox Internet Explorer Opera Safari SeaMonke Symbian Browser
browserVendor
#是
瀏覽器的建置公司/組織。
#值受到限制： Amazon Apple Google Microsoft 摩托羅拉 Mozilla Netscape 任天堂 Nokia Samsung Sony Ericsson
browserVersion
否
裝置的瀏覽器版本。
例如60.0.3112
userAgent
否
裝置的使用者代理。
例如Mozilla/5.0 (Macintosh；Intel Mac OS X 10_12_3) AppleWebKit/602.4.8 （KHTML，如Gecko）版本/10.0.3 Safari/602.4.8
displaywidth
否
裝置的實體熒幕寬度。
displayheight
否
裝置的實體熒幕高度。
displayPpi
否
裝置的實體熒幕畫素密度。
例如294
diagonalScreenSize
否
裝置的實體熒幕對角線尺寸（英吋）。
例如5.5、10.1
connectionIp
否
用於傳送HTTP要求的裝置IP。
例如8.8.4.4
connectionPort
否
用於傳送HTTP要求的裝置連線埠。
例如53124
connectionType
否
網路連線型別。
例如WiFi、LAN、3G、4G、5G
connectionSecure
#是
網路連線安全性狀態。
#值受到限制： true — 在安全網路的情況下 false — 在公開熱點的情況下
applicationId
否
應用程式的唯一識別碼。
例如CNN
API參考 api-ref
本節介紹負責在使用Adobe Pass驗證REST API或SDK時處理使用者端資訊的API。
REST API rest-api
Adobe Pass驗證服務支援以下列方式接收使用者端資訊：
- 作為 標頭： "X-Device-Info"
- 作為 查詢引數： "device_info"
- 作為 貼文引數： "device_info"
IMPORTANT
在這三種情況中，標頭或引數的承載必須是 Base64編碼和URL編碼。
SDK
JAVASCRIPT SDK js-sdk
AccessEnabler JavaScript SDK預設會建置使用者端資訊JSON物件，除非覆寫，否則會傳遞至Adobe Pass驗證服務。
AccessEnabler JavaScript SDK僅支援 透過setRequestor的 applicationId 選項引數，覆寫使用者端資訊JSON物件中的"applicationId"金鑰。
CAUTION
applicationId引數值必須是純文字字串值。如果程式設計師應用程式決定傳遞applicationId，則其餘的使用者端資訊金鑰仍會由AccessEnabler JavaScript SDK計算。
iOS/tvOS SDK ios-tvos-sdk
AccessEnabler iOS/tvOS SDK預設會建置使用者端資訊JSON物件，除非覆寫，否則會傳遞至Adobe Pass驗證服務。
AccessEnabler iOS/tvOS SDK支援 透過setOptions的device_info引數覆寫整個 使用者端資訊JSON物件。
CAUTION
device_info 引數值必須是 Base64編碼 NSString 值。
如果程式設計師應用程式決定傳遞 device_info，則會覆寫AccessEnabler iOS/tvOS SDK所計算的所有使用者端資訊金鑰。 因此，計算並傳遞儘可能多的索引鍵值非常重要。 如需實作的詳細資訊，請參閱總覽表格和iOS/tvOS逐步指南。
Android/FireOS SDK and-fire-os-sdk
AccessEnabler Android/FireOS SDK預設會建置使用者端資訊JSON物件，除非覆寫，否則會傳遞至Adobe Pass驗證服務。
AccessEnabler Android/FireOS SDK支援 透過setOptions的/setOptions的device_info引數覆寫整個 使用者端資訊JSON物件。
NOTE
device_info引數值必須是 Base64編碼 字串值。逐步指南 cookbooks
本節提供在不同裝置型別的情況下建置使用者端資訊JSON物件的逐步指南。
IMPORTANT
以 標籤的金鑰！ 為強制傳送。
Android android
裝置資訊的建構方式如下：
索引鍵
Source
值（範例）
！
模型
Build.MODEL
GT-I9505
廠商
Build.BRAND
samsung
製造商
Build.MANUFACTURER
samsung
！
版本
Build.DEVICE
jflte
displaywidth
DisplayMetrics.widthPixels
600
displayheight
DisplayMetrics.heightPixels
800
！
osName
硬式編碼
Android
！
osVersion
Build.VERSION.RELEASE
5.0.1
連線資訊的建構方式如下：
索引鍵
Source
值（範例）
！
connectionType
<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"connectionSecure
應用程式資訊的建構方式如下：
索引鍵
Source
值（範例）
applicationId
硬式編碼
CNN
IMPORTANT
必須將裝置、連線和應用程式資訊新增至相同的JSON物件。 之後，產生的物件必須是 Base64編碼。 此外，若是Adobe Pass驗證REST API，該值必須為 URL編碼。
範常式式碼
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
裝置資訊的建構方式如下：
索引鍵
Source
值（例如）
！
模型
Build.MODEL
AFTM
廠商
Build.BRAND
Amazon
製造商
Build.MANUFACTURER
Amazon
！
版本
Build.DEVICE
montoya
displaywidth
DisplayMetrics.widthPixels
displayheight
DisplayMetrics.heightPixels
！
osName
硬式編碼
Android
！
osVersion
Build.VERSION.RELEASE
5.1.1
連線資訊的建構方式如下：
索引鍵
Source
值（範例）
！
connectionType
connectionSecure
應用程式資訊的建構方式如下：
索引鍵
Source
值（範例）
applicationId
硬式編碼
CNN
IMPORTANT
必須將裝置、連線和應用程式資訊新增至相同的JSON物件。 之後，產生的物件必須是 Base64編碼。 此外，若是Adobe Pass驗證REST API，該值必須為 URL編碼。
iOS/tvOS ios-tvos
裝置資訊的建構方式如下：
索引鍵
Source
值（範例）
！
模型
uname.machine
iPhone
廠商
硬式編碼
Apple
製造商
硬式編碼
Apple
！
版本
uname.machine
8,1
displaywidth
UIScreen.mainScreen
320
displayheight
UIScreen.mainScreen
568
！
osName
UIDevice.systemName
iOS
！
osVersion
UIDevice.systemVersion
10.2
連線資訊的建構方式如下：
索引鍵
Source
值（範例）
！
connectionType
[連線能力currentReachableStatus]
connectionSecure
應用程式資訊的建構方式如下：
索引鍵
Source
值（範例）
applicationId
硬式編碼
CNN
IMPORTANT
必須將裝置、連線和應用程式資訊新增至相同的JSON物件。 之後，產生的物件必須經過Base64編碼。 此外，在使用Adobe Pass驗證REST API時，值必須經過URL編碼。
範常式式碼
+ (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
裝置資訊的建構方式如下：
索引鍵
Source
值（範例）
！
模型
硬式編碼
"Roku"
廠商
ifDeviceInfo.GetModelDetails().VendorName
"Sharp"、"Roku"
製造商
ifDeviceInfo.GetModelDetails().VendorName
"Sharp"、"Roku"
！
版本
ifDeviceInfo.GetModelDetails().ModelNumber
「5303X」
displaywidth
ifDeviceInfo.GetDisplaySize().w
1920
displayheight
ifDeviceInfo.GetDisplaySize().h
1080
！
osName
硬式編碼
"Roku"
！
osVersion
ifDeviceInfo.getVersion()
連線資訊的建構方式如下：
索引鍵
Source
值（範例）
！
connectionType
ifDeviceInfo.GetConnectionType()
「WifiConnection」、「WiredConnection」
connectionSecure
硬式編碼
如果連線有線，則為true
應用程式資訊的建構方式如下：
索引鍵
Source
值（範例）
applicationId
硬式編碼
CNN
IMPORTANT
必須將裝置、連線和應用程式資訊新增至相同的JSON物件。 之後，產生的物件必須是 Base64編碼。 此外，在使用Adobe Pass驗證REST API時，值必須經過URL編碼。
NOTE
如需詳細資訊，請參閱ifDeviceInfo
XBOX 1/360 xbox
裝置資訊的建構方式如下：
索引鍵
Source
值（範例）
！
模型
EasClientDeviceInformation.SystemProductName
廠商
硬式編碼
Microsoft
製造商
硬式編碼
Microsoft
！
版本
EasClientDeviceInformation.SystemHardwareVersion
displaywidth
DisplayInformation.ScreenWidthInRawPixels
1920
displayheight
DisplayInformation.ScreenHeightInRawPixels
1080
！
osName
EasClientDeviceInformation.OperatingSystem
！
osVersion
EasClientDeviceInformation.SystemFirmwareVersion
連線資訊的建構方式如下：
索引鍵
Source
範例
！
connectionType
connectionSecure
網路驗證型別
「無」、「Wpa」等
應用程式資訊的建構方式如下：
索引鍵
Source
值（範例）
applicationId
硬式編碼
CNN
IMPORTANT
必須將裝置、連線和應用程式資訊新增至相同的JSON物件。 之後，產生的物件必須是 Base64編碼。 此外，若是Adobe Pass驗證REST API，該值必須為 URL編碼。
資源
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b