info()
Obtain information about the user or device which is launching the X1 App.
Signature:
$badger.info()
Parameters:
None.
Return Values:
| Return Value | Description | Example | Restricted* |
|---|---|---|---|
| data.zipcode | Zipcode where the X1 Device is physically located | 12345 | Yes |
| data.timezone | Time offset from UTC for the X1 Device | -8:00 | No |
| data.timeZone | String representation of the timezone for the X1 Device | America/Los_Angeles | No |
| data.receiverId | Hashed version of the receiverId. Useful only as a unique identifier for the X1 Device. | 123fkjsdfsd323sdasd | Yes |
| data.deviceHash | Unique hashed version of the identifier of the X1 Device, containing only characters in [a-zA-Z0-9] | THSS68gopST2tWSFObl9LPGftwgvLQaUuvof8gZF9kmsie | No |
| data.deviceCapabilities | Array of strings indicating various capabilities of the X1 Device | See deviceCapabilities | No |
| data.householdId | Unique identifier for the household (aka account) | 987654sadwefvjasdasdasdasd | Yes |
| data.privacySettings^ | Array of strings indicating whether the user is opted-out of receiving personalized advertising and activities subject to Cal. Civ. Code §1798.135: Do Not Sell My Personal Information | lmt: "0", us_privacy: "1-N-" |
No |
| data.partnerId | App distribution partner Id | Comcast Xfinity = "comcast" SmartTV Device = "xglobal" Cox = "cox" Cox Trial = "cox-dev" Rogers = "rogers" Rogers Trial = "rogers-dev" Shaw = "shaw" Shaw Trial = "shaw-dev" Videotron = "videotron" Videotron Trial = "videotron-dev" |
No |
*Restricted fields are only available to select partners and demonstration of operational need. Please contact your partner manager for more information.
^ The values are derived from the IAB Identifier For Advertising (IFA) for Over-the-Top Devices, and the IAB CCPA Compliance Framework. These values are subject to change, as described in the linked documentation.
Usage Example:
When an X1 App calls the method below, the success callback will contain all the information the requesting domain is approved for.
$badger.info()
.success(function(data){
...
}).failure(function(){
...
});