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

Python 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. Import settings from the 51Degrees settings file

    dataFile = settings.V3_WRAPPER_DATABASE
    properties = settings.PROPERTIES
    cacheSize = settings.CACHE_SIZE
    poolSize = settings.POOL_SIZE
    

  2. Instantiate the 51Degrees device detection provider with these properties

    provider = fiftyone_degrees_mobile_detector_v3_wrapper.Provider(dataFile,
    	properties,
    	cacheSize,
    	poolSize)
    

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

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

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

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

This example can be run in any directory, but assumes your settings file contains a valid dataFile location and has the IsMobile property selected.
Full Source File
from FiftyOneDegrees import fiftyone_degrees_mobile_detector_v3_wrapper
from fiftyone_degrees.mobile_detector.conf import settings
import sys

'''
Imports settings from the settings file. The Default settings file, and
details on how to change it can be output by running the command
<p><pre class="prettyprint lang-py">
51degrees-mobile-detector settings
</p></pre>
'''
dataFile = settings.V3_WRAPPER_DATABASE
properties = settings.PROPERTIES
cacheSize = settings.CACHE_SIZE
poolSize = settings.POOL_SIZE

'''
Initialises the device detection provider with settings from the settings
file. By default this will use the included Lite data file For more info
see:
<a href="https://51degrees.com/compare-data-options">compare data options
</a>
'''
provider = fiftyone_degrees_mobile_detector_v3_wrapper.Provider(dataFile,
    properties,
    cacheSize,
    poolSize)

def main():
    print "Starting Find Profiles Example.\n"

    # Retrive all the mobile profiles from the data set.
    profiles = provider.findProfiles("IsMobile", "True")
    print "There are %d mobile profiles in the %s data file." % (profiles.getCount(), provider.getDataSetName())
    profiles = provider.findProfiles("ScreenPixelsWidth", "1080", profiles)
    print "%d of them have a screen width of 1080 pixels." % profiles.getCount()

    # Retrieve all the non-mobile profiles from the data set.
    profiles = provider.findProfiles("IsMobile", "False")
    print "There are %d non-mobile profiles in the %s data file." % (profiles.getCount(), provider.getDataSetName())
    profiles = provider.findProfiles("ScreenPixelsWidth", "1080", profiles)
    print "%d of them have a screen width of 1080 pixels." % profiles.getCount()

if __name__ == '__main__':
    main()

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.