ÃÛ¶¹ÊÓƵ

DocumentationCampaignCampaign v8 Documentation

Configure push notification channel push-notification-configuration

Last update: Mon Mar 18 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Intermediate
  • Admin
  • Developer

To send push notifications with ÃÛ¶¹ÊÓƵ Campaign, you must first configure your environment and app as detailed in this page. In ÃÛ¶¹ÊÓƵ Campaign, the channel for sending push notitications is the mobile app channel.

CAUTION
Some important changes to the Android Firebase Cloud Messaging (FCM) service will be released in 2024, and may impact your ÃÛ¶¹ÊÓƵ Campaign implementation. Your subscription services configuration for Android push messages may need to be updated to support this change. You can already check and take action. Learn more.

Before beginning to send push notifications with ÃÛ¶¹ÊÓƵ Campaign, you need to ensure configurations and integrations are in place on the mobile app and for tags in ÃÛ¶¹ÊÓƵ Experience Platform. ÃÛ¶¹ÊÓƵ Experience Platform Mobile SDK provides client-side integration APIs for your mobiles via Android and iOS compatible SDKs.

To set up your app with ÃÛ¶¹ÊÓƵ Experience Platform Mobile SDKs, follow these steps:

  1. Check prerequisites.
  2. Set up a mobile tag property in ÃÛ¶¹ÊÓƵ Experience Platform Data Collection.
  3. Get the ÃÛ¶¹ÊÓƵ Experience Platform Mobile SDK as detailed .
  4. (optional) Enable logging and lifecycle metrics, as detailed .
  5. (optional) Add to validate your implementation. Learn how to implement ÃÛ¶¹ÊÓƵ Experience Platform Assurance extension .
  6. Configure your iOS and Android mobile services in ÃÛ¶¹ÊÓƵ Campaign as detailed in this page.
  7. Install and configure ÃÛ¶¹ÊÓƵ Campaign Extension in your mobile property.
  8. Follow to get setup with ÃÛ¶¹ÊÓƵ Experience Platform Mobile SDKs in your app.

Prerequisites before-starting

Set up permissions setup-permissions

Before creating a mobile application, you first need to make sure that you have or assign the correct user permissions for tags in ÃÛ¶¹ÊÓƵ Experience Platform. User permissions for tags in ÃÛ¶¹ÊÓƵ Experience Platform are assigned to users through ÃÛ¶¹ÊÓƵ Admin Console. Learn more in Tags documentation.

CAUTION
Push configuration must be performed by an expert user. Depending on your implementation model and personas involved in this implementation, you might need to assign the full set of permissions to a single product profile or share permissions between the app developer and the ÃÛ¶¹ÊÓƵ Campaign administrator.

To assign Property and Company rights, follow the steps below:

  1. Access the Admin Console.

  2. From the Products tab, select the ÃÛ¶¹ÊÓƵ Experience Platform Data Collection card.

  3. Select an existing Product Profile or create a new one with the New profile button. Learn how to create a new New profile in the Admin console documentation.

  4. From the Permissions tab, select Property Rights.

  5. Click Add all. This will add the following right to your product profile:

    • Approve
    • Develop
    • Edit Property
    • Manage Environments
    • Manage Extensions
    • Publish

    These permissions are required to install and publish the ÃÛ¶¹ÊÓƵ Campaign extension, and publish the app property in ÃÛ¶¹ÊÓƵ Experience Platform Mobile SDK.

  6. Then, select Company rights in the left-hand menu.

  7. Add the following rights:

    • Manage App Configurations
    • Manage Properties

    These permissions are required for the mobile app developer to set up push credentials in ÃÛ¶¹ÊÓƵ Experience Platform Data Collection.

  8. Click Save.

To assign this Product profile to users, follow the steps below:

  1. Access the Admin Console.

  2. From the Products tab, select the ÃÛ¶¹ÊÓƵ Experience Platform Data Collection card.

  3. Select your previously configured Product profile.

  4. From the Users tab, click Add user.

  5. Type in your user’s name or email address and select the user. Then, click Save.

    note note
    NOTE
    If the user was not previously created in the Admin console, refer to the .

Configure your app configure-app

The technical setup involves close collaboration between the app developer and business administrator. Before starting sending push notifications with ÃÛ¶¹ÊÓƵ Campaign, you need to define settings in ÃÛ¶¹ÊÓƵ Experience Platform Data Collection and integrate your mobile app with ÃÛ¶¹ÊÓƵ Experience Platform Mobile SDKs.

Follow implementation steps detailed in the links below:

  • For Apple iOS: Learn how to register your app with APNs in
  • For Google Android: Learn how to setup up a Firebase Cloud Messaging client app on Android in

Set up a mobile tag property in ÃÛ¶¹ÊÓƵ Experience Platform Data Collection launch-property

Setting up a mobile property allows the mobile app developer or marketer to configure the mobile SDKs. You will typically create a mobile property for each mobile application you want to manage. Learn how to create and configure a mobile property in .

Learn more about ÃÛ¶¹ÊÓƵ Experience Platform Data Collection tags in ÃÛ¶¹ÊÓƵ Experience Platform documentation.

Once created, open the new tag property and create a library. To do this:

  1. Browse to Publishing Flow in the left navigation and select Add Library.
  2. Enter the name of the library and select the environment.
  3. Select Add All Changed Resources, and Save and Build to development.
  4. Finally, set this library as your working library from the Select a working library button.

Configure your mobile services in Campaign push-service

Once your mobile app has been set up in in ÃÛ¶¹ÊÓƵ Experience Platform Data Collection, you need to create two services (one for iOS devices, one for Android devices) to be able to send push notifications from ÃÛ¶¹ÊÓƵ Campaign.

Push notifications are sent to your app users through a dedicated service. When users install your app, they subscribe to this service: ÃÛ¶¹ÊÓƵ Campaign relies on this service to target only the subscribers of your app. In this service, you need to add your iOS and Android apps to send on iOS and Android devices.

To create a service to send push notifications, follow the steps below:

  1. Browse to Profiles and Targets > Services and Subscriptions tab, and click Create.

    {width="800"}

  2. Enter a Label and an Internal name, and select a Mobile application type.

    note note
    NOTE
    The default Subscriber applications (nms:appSubscriptionRcp) target mapping is linked to the recipients table. If you want to use a different target mapping, you need to create a new target mapping and enter it in the Target mapping field of the service. Learn more about target mappings in this page.

  3. Then use the Add icon on the right to define the mobile applications that use this service.

iOS

To create an app for iOS devices, follow these steps:

  1. Select Create an iOS application and click Next.

    {width="600"}

  2. Enter the name of your app in the Label field.

  3. (optional) You can enrich a push message content with some Application variables. These are fully customizable and a part of the message payload sent to the mobile device.

    In the example below, the mediaURl and mediaExt variables are added to create rich push notification and then provides the application with the image to display within the notification.

    {width="600"}

  4. Browse to the Subscription parameters tab to define the mapping with an extension of the Subscriber applications (nms:appsubscriptionRcp) schema.

  5. Browse to the Sounds tab to define a sound to play. Click Add and fill Internal name field which must contain the name of the file embedded in the application or the name of the system sound.

  6. Click Next to start configuring the development application.

  7. The integration key is specific to each application. It links the mobile application to ÃÛ¶¹ÊÓƵ Campaign.

    Make sure that the same Integration key is defined in ÃÛ¶¹ÊÓƵ Campaign and in the application code via the SDK.

    Learn more in

    note note
    NOTE
    The Integration key is fully customizable with string value but needs to be exactly the same as the one specified in the SDK.
    You cannot use the same certificate for the development version (sandbox) and the production version of the application.

  8. Select the icon from the Application icon field to personalize mobile application in your service.

  9. Select the Authentication mode. Two modes are available:

    • (Recommended) Token-based authentication: Fill in the APNs connection settings Key Id, Team Id and Bundle Id then select your p8 certificate by clicking Enter the private key…. For more on Token-based authentication, refer to .

    • Certificate-based authentication: Click Enter the certificate… then select your p12 key and enter the password that was provided by the mobile application developer. Note that this certificate comes with an expiration date and must be renewed on a yearly basis. To avoid a disruption in service for your users, update your certificates before they expire. Certificates are valid for a year and you must update them to continue communicating with APNs.

  10. Use the Test the connection button to validate your configuration.

  11. Click Next to start configuring the production application and follow the same steps as detailed above.

  12. Click Finish.

Your iOS application is now ready to be used in Campaign.

Android

To create an app for Android devices, follow these steps:

  1. Select Create an Android application and click Next.

    {width="600"}

  2. Enter the name of your app in the Label field.

  3. The integration key is specific to each application. It links the mobile application to ÃÛ¶¹ÊÓƵ Campaign.

    Make sure that the same Integration key is defined in ÃÛ¶¹ÊÓƵ Campaign and in the application code via the SDK.

    Learn more in

    note note
    NOTE
    The Integration key is fully customizable with string value but needs to be exactly the same as the one specified in the SDK.

  4. Select the icon from the Application icon field to personalize mobile application in your service.

  5. Select HTTP v1 in API version drop-down list.

  6. Click Load project json file to extract project details… link to load your JSON key file. For more information on how to extract your JSON file, refer to .

    You can also enter manually the following details:

    • Project Id
    • Private Key
    • Client Email

  7. Use the Test the connection button to validate your configuration.

    note caution
    CAUTION
    The Test connection button does not check if the MID server has access to the FCM server.

  8. (optional) You can enrich a push message content with some Application variables if needed. These are fully customizable and a part of the message payload sent to the mobile device.

  9. Click Finish then Save. Your Android application is now ready to be used in Campaign.

Below are the FCM payload names to further personalize your push notification:

table 0-row-3 1-row-3 2-row-3 1-align-center 2-align-center 3-align-center 5-align-center 6-align-center 7-align-center 9-align-center 10-align-center 11-align-center
Message type Configurable message element (FCM payload name) Configurable options (FCM payload name)
data message N/A validate_only
notification message title, body, android_channel_id, icon, sound, tag, color, click_action, image, ticker, sticky, visibility, notification_priority, notification_count validate_only

Configure ÃÛ¶¹ÊÓƵ Campaign Extension in your mobile property configure-extension

The ÃÛ¶¹ÊÓƵ Campaign Classic extension for ÃÛ¶¹ÊÓƵ Experience Platform Mobile SDKs powers push notifications for your mobile apps and helps you collects user push tokens and manages interaction measurement with ÃÛ¶¹ÊÓƵ Experience Platform services.

This extension, which applies to both Campaign Classic v7 and Campaign v8, is pre-installed on your environment and must be configured. To configure the extension for your mobile tag property, follow these steps:

  1. Open the tag property you created before.
  2. From the left navigation, browse to Extensions, and open the Catalog tab. Use the search field to find the ÃÛ¶¹ÊÓƵ Campaign Classic extension.
  3. From the Campaign Classic card, click the Install button.
  4. Enter settings as described in .

You can now add Campaign to your app, as detailed in .

recommendation-more-help
35662671-8e3d-4f04-a092-029a056c566b