Edit in GitHubLog an issue

Adobe Experience Platform Location Service

Places is the Adobe Experience Platform Mobile SDK extension that enables actions based on user location. It serves as the interface to the Location Service Web Services APIs.

Places listens for events that contain GPS coordinates and geofence region events, then dispatches new events processed by the Rules Engine. It retrieves and delivers a list of the nearest points of interest (POI) based on app data obtained from the APIs. The regions returned by the APIs are stored in cache and persistence, allowing limited offline processing.

Configure the Places extension in Data Collection UI

  1. In the Data Collection UI, from your mobile property, select the Extensions tab.
  2. On the Catalog tab, locate or search for the Places extension, and select Install.
  3. Select the POI Library (or libraries) you wish to use in the app.
  4. Select Save.
  5. Follow the publishing process to update SDK configuration.

Places extension configuration

Add the AEP Places extension to your app

Download and import the Places extension

  1. Add the Mobile Core and Places extensions to your project using the app's Gradle file.

Kotlin

Copied to your clipboard
implementation(platform("com.adobe.marketing.mobile:sdk-bom:3.+"))
implementation("com.adobe.marketing.mobile:core")
implementation("com.adobe.marketing.mobile:places")

Groovy

Copied to your clipboard
implementation platform('com.adobe.marketing.mobile:sdk-bom:3.+')
implementation 'com.adobe.marketing.mobile:core'
implementation 'com.adobe.marketing.mobile:places'
  1. Import the Mobile Core and Places extensions in your Application class.
Copied to your clipboard
import com.adobe.marketing.mobile.MobileCore;
import com.adobe.marketing.mobile.Places;

Register the Places extension with Mobile Core

Java

Copied to your clipboard
public class MainApp extends Application {
    private static final String APP_ID = "YOUR_APP_ID";


    @Override
    public void onCreate() {
        super.onCreate();


        MobileCore.setApplication(this);
        MobileCore.configureWithAppID(APP_ID);


        List<Class<? extends Extension>> extensions = new ArrayList<>();
        extensions.add(Places.EXTENSION);
        MobileCore.registerExtensions(extensions, o -> {
            Log.d(LOG_TAG, "AEP Mobile SDK is initialized");
        });
    }


}

Kotlin

Copied to your clipboard
class MyApp : Application() {


    override fun onCreate() {
        super.onCreate()
        MobileCore.setApplication(this)
        MobileCore.configureWithAppID("YOUR_APP_ID")


        val extensions = listOf(Places.EXTENSION)
        MobileCore.registerExtensions(extensions) {
            Log.d(LOG_TAG, "AEP Mobile SDK is initialized")
        }
    }


}

Configuration keys

To update SDK configuration programmatically, use the following information to modify Places configuration values. For additional details, refer to the Configuration API reference.

KeyRequiredDescriptionData Type
places.endpoint
Yes
Defines the endpoint used by the Places extension to retrieve POI data. The default value is "query.places.adobe.com".
String
places.libraries
Yes
Defines the Places libraries that supply POI data. The default value is configured through the Data Collection tags mobile property settings for the Places extension. Example format: [{"id": "123e4567-e89b-12d3-a456-426614174000"}]
Array of objects
places.membershipttl
No
Specifies the duration, in seconds, that POI states remain valid. The default value is one hour (3600).
Double

Additional Location Service resources

For more information about implementing and using Adobe Experience Platform Location Service, refer to the following documentation links:

Was this helpful?