Location attributes are key-value pairs, such as City: Boston, that describe characteristics of sites and zones. Location attributes are configured in Device Location Awareness (DLA) and get mapped to location universal behavior event attributes. They are used to build mobile app message queries and programs.
For example, a marketer can build a program that targets mobile device users in Boston. They specify the locationCity event attribute as criteria for the universal behavior event: Location
- Entered a Geofence. To target mobile device users at sites in Boston, the marketer adds the locationCity is equal to Boston universal behavior event to the program. The location attribute and value that correspond to locationCity are defined in DLA when the location administrator sets up sites and specifies Boston as the site's city.
DLA provides a set of default location attributes that are based on site and zone definitions in the DLA UI and the Acoustic Mobile App Messaging SDK. The following table shows the default location attributes and the corresponding location universal behavior event attributes.
To expand or narrow the focus of a query or program, you can specify various combinations of location attributes.
| Default location attribute in sites and zones | Location universal behavior event attribute in queries and programs |
|---|---|
| Site name or Zone name | siteId |
| City | locationCity |
| State/Prefecture/Province | locationState |
| Postal code | postalCode |
| Country | locationCountry |
| Region | locationRegion |
| Radius (on the SDK) | locationRadius |
| locationAttributeIds (custom attributes that you create). | |
| appKey (on the SDK) | appKey |
| channelId (on the SDK) | channelId |
Customize location attributes
Location administrators can create custom location attributes to define site characteristics that are not described by default location attributes, e.g. related to climate. When you create a custom location attribute, it is automatically mapped to location universal behavior events.
Zones, geofences, and beacons inherit location attributes
You can add custom location attributes to sites and zones. The DLA site hierarchy supports multiple layers of zones and child zones, and zones inherit location attributes from the site and parent zones. You cannot add location attributes to geofences and beacons directly, only to a site or zone that contains a geofence or beacon.
The following scenarios describe how to use location attributes to send mobile app messages based on a mobile user's real-time behavior and past behavior.
Scenario 1: real-time behavior
For real-time behavior, let's use an example: Send mobile app messages to mobile users who drive within 2 km of a store.
- Create the custom location attribute, Distance: far.
- Add a geofence with a 2 km radius to a zone that surrounds your store and add the Distance: far custom location attribute to the zone.
- Configure a program that sends a mobile app message when the following location universal behavior event occurs:
- When Location - Entered a geofence
- locationAttributeIds contains Distance: far
Scenario 2: past behavior
For past behavior, let's use an example: Send mobile app messages to mobile users who entered the CityCoolEast store within the past 30 days. Using the mobile app message database as the contact source, create a query with the following criteria:
- Behavior Location - Entered a geofence.
- Target siteID is equal to CityCoolEast.
- Timeframe within the last 30 Days.
Next, configure a mobile app message that specifies the query as the contact source and then send or schedule the mobile app message.
Create custom location attributes and attribute values
- Create or edit a site or zone for your organization. Click the Add attribute drop-down and then click Add Attribute.
- Provide a name and attribute type and then save the definition.
- Define values for string and number attributes. To define attribute values, click Add Value in the Attribute value drop-down, enter a value, and then save the definition.
- Add the attribute to sites and zones across your organization.
Add custom location attributes and attribute values to a site or zone
After you create custom location attributes and attribute values, you can add them to sites and zones.
- Adding or edit a site or zone in the DLA UI.
- Click the Add attribute drop-down, click the attribute that you want, and then click Add.
- Click the Attribute value drop-down and click the attribute value that you want.
If you want to update attribute values in multiple sites, you can use site import/export feature in Device Location Awareness (DLA).
View a list of custom location attributes for an organization
You have several options for viewing a list of custom location attributes for your organization. You can use the Location attributes window, or you can use the DLA import/export feature to generate a CSV file that shows your organization's custom location attributes.
To get a list of custom location attributes by using the Location attributes window, start by creating or editing a site or zone for your organization and then click Manage all. The Location attributes window opens, and the Attribute names column displays a list of attributes for your organization. To view a list of attribute values that correspond to an attribute, click the attribute and then view the corresponding attribute values in the Attribute values column.