• About Us
  • Blog
  • Basket
  • Account
  • Sign In
  •  

Node.js API

What's Covered

This tutorial illustrates how to use the findProfiles function to return a list of matching profiles for a given property value pair. The following steps are covered:

  • How to find all the mobile device profiles.
  • Find all the mobile profiles with a screen size of 1080 pixels.
  • Do the same for non-mobile devices, and display how many have that screen size.

Code and Explanation

Find profiles example of using 51Degrees device detection. The example shows how to:
  1. Set the configuration using a json object

    var config = {"dataFile" : require("fiftyonedegreeslitepattern"),
                  "properties" : "IsMobile",
                  "cacheSize" : 10000,
                  "poolSize" : 4
    };
    

  2. Instantiate the 51Degrees device detection provider with this connfiguration

    var provider = new fiftyonedegrees.provider(config);
    

  3. Retrieve all profiles from the data set which match the specified property value pair

    var profiles = provider.findProfiles("IsMobile", "True");
    

  4. Search with a list of profiles for another property value pair.

    profiles = provider.findProfiles("ScreenPixelsWidth", "1080", profiles)
    

Full Source File
// Include 51Degrees.
var fiftyonedegrees = require("fiftyonedegreescore");

// Set the config.
var config = {"dataFile" : require("fiftyonedegreeslitepattern"),
              "properties" : "IsMobile",
              "cacheSize" : 10000,
              "poolSize" : 4,
             };

console.log("Starting Find Profiles Example.\n");

/*
Initialises the device detection provider with settings from the config.
By default this will use the packaged Lite data file. For more info see:
<a href="https://51degrees.com/compare-data-options">compare data options
</a>
*/
var provider = new fiftyonedegrees.provider(config);

// Retrieve all the mobile profiles in the data set.
var profiles = provider.findProfiles("IsMobile", "True");
console.log("There are " + profiles.count + " mobile profiles in the " + provider.getDataSetName() + " data file.");
profiles = provider.findProfiles("ScreenPixelsWidth", "1080", profiles);
console.log(profiles.count +
            " of them have a screen width of 1080 pixels.");

// Retrieve all the non-mobile profiles in the data set.
profiles = provider.findProfiles("IsMobile", "False");
console.log("There are " + profiles.count +
            " non-mobile profiles in the " + provider.getDataSetName() + 
            " data set.");
profiles = provider.findProfiles("ScreenPixelsWidth", "1080", profiles);
console.log(profiles.count +
            " of them have a screen width of 1080 pixels.");

Full Source File

Summary

This tutorial covered how to work with the 51Degrees device Data Model to obtain a subset of device profiles that meet several conditions. Each condition in this case is a specific value for a chosen property. The result should be read as follows: this is a subset of device profiles where property1 has value1 and property2 has value2 and property3 has value3 and so on.

One real world application for this is building a set of interlinked menus where each choice will narrow down the available options for subsequent choices. This can be useful when part of the API is exposed to the end user:

  • An ad agency could benefit from allowing their clients to target specific devices based on pre-defined criteria, such as DeviceType, ScreenInchesWidth or even PriceBand.
  • A program that uses a 51Degrees API to generate/augment reports could be enhanced to allow the user to choose the report parameters. By providing a finite set of choices and avoiding arbitrary input the chance of errors occurring is reduced and user experience improved.

The Lite data file contains considerably fewer properties and values than the Premium or Enterprise files, making the usefulness of this tutorial slightly harder to appreciate. With Premium and Enterprise data files there are many more possibilities for creating subsets of device profiles. For example: using Premium device data you can generate a subset of all 'Samsung' 'Smartphone' devices. Or get all the properties of a specific HTC model.