Skip to content
Permalink
master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

mobile-services/docs/android/location/beacon.md

Go to file
 
 
Cannot retrieve contributors at this time
Beacon tracking Track beacons Send additional data
67 lines (46 sloc) 2.2 KB
Raw Blame
Open in GitHub Desktop

Beacon tracking

Beacon tracking allows you to measure and target micro locations by using iBeacon and Bluetooth Low Energy.

The following beacon data is sent to Analytics and Target when trackBeacon is called:

  • a.beacon.uuid - ProximityUUID of the beacon
  • a.beacon.major - Major number of the beacon (such as store number)
  • a.beacon.minor - Minor number of the beacon (such as a unique number within a store)
  • a.beacon.prox - Values of 0-3 represent how close the user is to the beacon.

Here is what these values mean:

  • 0 = unknown
  • 1 = immediate
  • 2 = near
  • 3 = far

This beacon data is captured in mobile solution variables.

Track beacons

  1. Add the library to your project and implement lifecycle.

    For more information, see Add the SDK and Config File to your IntelliJ IDEA or Eclipse Project in Core implementation and lifecycle.

  2. Import the library:

    import com.adobe.mobile.*;

  3. Gather beacon location.

    Multiple third-party libraries are available to scan Bluetooth LE beacons, depending on the manufacturer of the beacon.

  4. After the beacon information has been obtained, use the following call to track the location:

    // assumed that the following variables will have been retrieved by the 3rd party beacon library 
String beaconUUID; 
String major; 
String minor; 
Analytics.BEACON_PROXIMITY proximity;  
// BEACON_PROXIMITY is an enum available in the SDK. Number 0-3 representing how close the 
// user is to the beacon. 0 unknown, 1 immediate, 2 near, 3 far.  
Analytics.trackBeacon(beaconUUID, major, minor, proximity, null);

  5. When the user leaves the beacon's proximity, clear the current beacon:

    Analytics.clearBeacon();

Send additional data

In addition to the beacon data, you can send additional context data with each trackBeacon call:

HashMap cdata = new HashMap<String, Object>(); 
cdata.put("myapp.ImageLiked", imageName); 
Analytics.trackBeacon(beaconUUID, major, minor, proximity, cdata);

Context data values must be mapped to custom variables in the Adobe Mobile services: