Documentation Campaign Campaign Standard Documentation

Configuring Campaign-Points of Interest data integration

Last update: December 8, 2023

Topics:
Audiences

CREATED FOR:

Intermediate
Developer

Configuring Campaign-Points of Interest data integration with Adobe Experience Platform SDKs

NOTE

Your mobile application should already be configured in Adobe Campaign Standard using Adobe Experience Platform SDK. For the detailed steps, refer to this page.

The mobile applications used to collect location data must be configured by an administrator in the Adobe Campaign interface.

To be able to use Adobe Experience Platform Location Services with mobile applications configured with Adobe Experience Platform SDK, you need to:

Add the Places extension to your mobile app configuration in the Data Collection UI. Set up your mobile application in Adobe Campaign. See Install the Places extension.
Once your extensions are set up, create data elements within the Data Collection UI to retrieve data from these extensions. Refer to this page to create your data elements.
Then, in the Data Collection UI, you need to create rules to support mobile use cases between Point of Interests and Adobe Campaign.
This rule will be triggered when a user enters a geo-fenced Point of Interest. Refer to this page to create your rule.
Define your Points of Interest in Places. See Create a Point of Interest.
Make sure you access the mobile application and the collected location data in Adobe Campaign. See Accessing mobile apps used to collect location data and Accessing collected location data.

Configuring Campaign-Points of Interest data integration using SDK V4

The mobile applications used to collect location data must be configured by an administrator in the Adobe Campaign interface.

To use the Point of Interest data feature with mobile applications configured with SDK V4, you need to:

Have access to Adobe Analytics for Mobile. Check your license agreement or contact your Adobe Account executive for more information.
Set up your mobile application in Adobe Campaign. See Setting up a mobile app in Campaign.
Set up your mobile application in the Adobe Mobile Services interface. This enables you to ensure that data collected by Adobe Mobile Services is sent to Adobe Campaign. See Configuring a mobile app in Adobe Mobile Services.
Perform the mobile application’s specific setup:
- Package the configuration file downloaded from the Adobe Mobile Services interface with the mobile application.
- Integrate the Experience Cloud Mobile SDK into your mobile application. See Integrating the SDK into a mobile application.
Define Points of Interest in the Adobe Mobile Services interface. See Defining Points of Interest in Adobe Mobile Services.
Define the data that you want to collect from your mobile application’s subscribers. See Collecting subscribers’ Points of interest data.
Make sure you access the mobile application and the collected location data in Adobe Campaign. See Accessing mobile apps used to collect location data and Accessing collected location data.

Setting up a mobile app in Adobe Campaign using SDK V4

To be able to collect Points of interest data with Adobe Campaign, you must configure the mobile application which Adobe Campaign will be receiving data from.

Click the Adobe logo, in the top-left corner, then select Administration > Channels > Mobile app.
Click Create to set up an application.
Enter a name in the Application name field and click Create.

Do not fill in the Device-specific settings section. This only applies to configuring applications that receive push notifications.

In the Mobile application properties section, two URLs are listed: Collect PII endpoint and Location Services endpoint. They will be used in the Adobe Mobile Services interface. See Configuring a mobile app in Adobe Mobile Services.

The Collect PII endpoint URL is used to collect the users’ Experience Cloud IDs and registration tokens from the mobile application when it is launched. When a user logs into the application using credentials such as email, first name, last name etc., this data is also collected and used to reconcile the user’s registration token with an Adobe Campaign profile.
The Location Services endpoint URL is used to collect location data such as a user’s latitude, longitude and radius from a Point of Interest.

You can now use these values in Adobe Mobile Services to finish the configuration, as explained in the Configuring a mobile app in Adobe Mobile Services section.

Configuring a V4 mobile app in Adobe Mobile Services

To send the data collected by Adobe Mobile Services to Adobe Campaign, you must configure postbacks in the Mobile Services interface.

You will need specific information that you can find in the mobile application parameters set in Adobe Campaign (see Setting up a mobile app in Campaign):

IMS Organization ID
Collect PII Endpoint
Location Services endpoint

You must have access to Adobe Analytics to do the following configuration. If you are not an Adobe Analytics user, contact your Adobe Campaign administrator.

Log into mobilemarketing.adobe.com.
Create the application or select an existing one.
Go to the Manage App Settings page.
In the Visitor ID Service section, check Enable and select your organization from the drop-down list. Click Save.

CAUTION
This organization must be the same as the one you use on the Adobe Campaign instance.
Click Manage Postbacks.
Create a postback.
- Select PII as the Postback Type.
- In the URL field, copy the Collect PII Endpoint URL from the mobile application that you configured in the Adobe Campaign interface, preceded by the server name. See Setting up a mobile app in Campaign.
- Fill in the Post Body field as follows:
  
  For iOS:
  { "userKey": "{userKey}", "pushPlatform":"apns", "marketingCloudId":"{%mcid%}", "cusEmail":"{email}", "cusFirstName":"{firstName}", "cusLastName":"{lastName}" }
  For Android:
  { "userKey": "{userKey}", "pushPlatform":"gcm", "marketingCloudId":"{%mcid%}", "cusEmail":"{email}", "cusFirstName":"{firstName}", "cusLastName":"{lastName}" }
- Set Content Type as application/json.
- In the Which Data Tags Trigger the Postback?, select any event, typically Launched and exists.
- Click Save & Activate.
Create a second postback.
- Select Postback as the Postback Type.
- In the URL field, copy the Location Services Endpoint URL from the mobile application that you configured in the Adobe Campaign interface, preceded by the server name. See Setting up a mobile app in Campaign.
- Fill in the Post Body field as follows:
  { "locationData":{ "distances":"{a.loc.dist}", "poiLabel":"{a.loc.poi}", "latitude.a":"{a.loc.lat.a}", "latitude.b":"{a.loc.lat.b}", "latitude.c":"{a.loc.lat.c}", "longitude.a":"{a.loc.lon.a}", "longitude.b":"{a.loc.lon.b}", "longitude.c":"{a.loc.lon.c}", "appId":"{a.appid}", "marketingCloudId":"{mid}" } }
- Set Content Type as application/json.
- In the Which Data Tags Trigger the Postback?, select campaign.test and exists.
- Click Save & Activate.

NOTE

For detailed information on configuring postbacks, refer to the Adobe Mobile Services documentation.

Integrating the SDK into a mobile application

The Mobile core service’s software development kit (SDK) facilitates the integration of a mobile application into Adobe Campaign.

This step is described in this page.

Defining Points of Interest in Adobe Mobile Services

To define the Points of Interest that are used to collect location data:

Go to the Adobe Mobile Services interface.
Add your application.

For more information on managing applications in Mobile Services, refer to the Adobe Mobile Services documentation.
Define the Points of Interest.

For more information on managing Points of Interest, refer to the Adobe Mobile Services documentation.

Collecting subscribers’ Points of interest data

A specific custom resource enables you to define the data that you want to collect from your applications’ subscribers.

This step is described in the Configuring a mobile application using SDK V4 page.

Accessing mobile apps used to collect location data

To access the successfully created applications in Adobe Campaign:

Click the Adobe logo, in the top-left corner.
Select Administration > Channels > Mobile app (SDK v4) or Mobile app (AEP SDK) depending on the SDK.
Select a mobile application from the list to display its properties.

A list of the application’s subscribers is also displayed in the Mobile application subscribers tab. The subscribers are all of the users who have installed the application on their mobile device. The Adobe Campaign database profiles are identified with a registration token.

Accessing collected location data

Once the setup is done, the collected Points of Interest data is listed in the Places tab of each profile. To access the list:

Select a profile.
Click the Edit profile properties button on the right.
Select the Places tab.

The collected Points of Interest data for the current profile are listed. Location data are stored in the Adobe Campaign database for six months.

For more information on accessing and editing profiles, see Profiles.

recommendation-more-help