ÃÛ¶¹ÊÓƵ

DocumentationCampaignCampaign v8 Documentation

[Limited Availability]{class="badge informative"}

Revised push notification configuration push-notifications-config

Last update: Fri Jan 12 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Intermediate
  • Developer

Campaign v8.5 is introducing our latest Push notification service, powered by a robust framework built on a modern cutting-edge technology. This service is designed to unlock new levels of scalability, ensuring that your notifications can reach a larger audience with seamless efficiency. With our enhanced infrastructure and optimized processes, you can expect higher scale and reliability, empowering you to engage and connect with your Mobile App users like never before.

AVAILABILITY
This feature is exclusively accessible to new customers starting from Campaign v8.5 and progressively rolled out to a set of selected customers. If your environment was provisioned prior to June 2023, this page does not apply to you, and you must follow the procedures detailed in this page.

In the context of this updated implementation, to send push notifications in ÃÛ¶¹ÊÓƵ Campaign, follow these steps:

  1. Create an App surface in ÃÛ¶¹ÊÓƵ Experience Platform Data Collection

  2. Configure your application settings in ÃÛ¶¹ÊÓƵ Campaign

  3. Create and configure a mobile property in ÃÛ¶¹ÊÓƵ Experience Platform Data Collection

  4. (recommended)

  5. Add Campaign Classic to your mobile application

  6. Create a delivery for both iOS and Android

NOTE
Legacy FCM and APNS p12 are not supported with Data Collection.

Create an App surface in ÃÛ¶¹ÊÓƵ Experience Platform Data Collection create-app-surface

You need to add your mobile application push credentials in ÃÛ¶¹ÊÓƵ Experience Platform Data Collection.

The mobile app push credential registration is required to authorize ÃÛ¶¹ÊÓƵ to send push notifications on your behalf. Refer to the steps detailed below:

  1. From ÃÛ¶¹ÊÓƵ Experience Platform Data Collection, select the App Surfaces tab in the left-hand panel.

  2. Click Create App Surface to create a new configuration.

  3. Enter a Name for the configuration.

  4. From Mobile Application Configuration, select the Operational system:

    • For iOS

      1. Enter the mobile app Bundle Id in the App ID (iOS Bundle ID) field.

        The app Bundle ID can be found in the General tab of the primary target in XCode of your Apple developer account.

      2. Switch on Push Credentials to add your credentials.

      3. Drag and drop your .p8 Apple Push Notification Authentication Key file.

        This key can be acquired from the Certificates, Identifiers and Profiles page of your Apple developer account.

      4. Provide the Key ID. This is a 10 character string assigned during the creation of p8 auth key.

        It can be found under Keys tab in Certificates, Identifiers and Profiles pag of your Apple developer account.

      5. Provide the Team ID. This is a string value which can be found under the Membership tab.

    • For Android

      1. Provide the App ID (Android package name). Usually the package name is the app id in your build.gradle file.

      2. Switch Push Credentials to add your credentials.

      3. Drag and drop the FCM push credentials. For more details on how to get the push credentials refer to .

  5. Click Save to create your app configuration.

Configure your application settings in ÃÛ¶¹ÊÓƵ Campaign push-config-campaign

Create a service create-service

Before sending push notifications, you must define your iOS and Android apps settings in ÃÛ¶¹ÊÓƵ 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.

Create a mobile application create-sapp

After creating your service, you now need to define the mobile applications that will use this service.

iOS

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

  1. From you Service, click Add then select Create an iOS application. Click Next.

  2. From the Launch app configurations list window, select the App surface previously created in this section. Click Next.

  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.

  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 and will be used when configuring Campaign extension.

    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. Click Next to start configuring the production application and follow the same steps as detailed above. Note that you cannot use the same Integration key for the development version (sandbox) and the production version of the application.

  10. 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. From you Service, click Add then select Create an Android application. Click Next.

  2. From the Launch app configurations list window, select the App surface created in this section and click Next.

  3. The integration key is specific to each application. It links the mobile application to ÃÛ¶¹ÊÓƵ Campaign and will be used when configuring Campaign extension.

    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. (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.

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

  7. 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:

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 a mobile property in ÃÛ¶¹ÊÓƵ Experience Platform Data Collection create-mobile-property

  1. From Data Collection homepage, access the Tags menu.

  2. Click New Property.

  3. Type a name for the property and select Mobile as the platform.

  4. Click Save to create the mobile property.

  5. Access your newly created mobile property.

  6. From your mobile property dashboard, access the Extensions menu then the Catalog tab.

  7. Install the ÃÛ¶¹ÊÓƵ Campaign Classic extension.

  8. Fill in your instance details:

    • Registration endpoint or Tracking endpoint URLs can be found in the Tools > Advanced > Deployment wizard menu in Campaign.
    • Integration keys can be found in the mobile app configured in this section.

  9. Click Save.

  10. You now need to publish the configuration from the Publishing flow menu.

Your mobile property will now be automatically sync with the ÃÛ¶¹ÊÓƵ Experience Platform Data Collection technical workflow. Learn more

Add Campaign Classic to your mobile application campaign-mobile-app

The ÃÛ¶¹ÊÓƵ Experience Platform Mobile SDK helps power ÃÛ¶¹ÊÓƵ’s Experience Cloud solutions and services in your mobile apps. SDKs configuration is managed through the Data Collection UI for flexible configuration and extensible, rules-based integrations.

.

Create your push notification push-create

Once you have successfully configured your mobile application in Data Collection, you can now create and send push notifications in ÃÛ¶¹ÊÓƵ Campaign.

Refer to this page for the detailed elements specific to the delivery of iOS and Android notifications.

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